endpoint results from the CPAN

endpoint

AgentPushKit-Client

view release on metacpan or search on metacpan


        package main;

        my $api = MyApp->new({ tokens => $tokens });

        my $pet = $api->get_pet_by_id(pet_id => $pet_id);


## Structure of the library

The library consists of a set of API classes, one for each endpoint. These APIs
implement the method calls available on each endpoint.

Additionally, there is a set of "object" classes, which represent the objects
returned by and sent to the methods on the endpoints.

An API factory class is provided, which builds instances of each endpoint API.

This Moose role flattens all the methods from the endpoint APIs onto the consuming
class. It also provides methods to retrieve the endpoint API objects, and the API
factory object, should you need it.

For documentation of all these methods, see AUTOMATIC DOCUMENTATION below.

## Configuring authentication

In the normal case, the OpenAPI Spec will describe what parameters are
required and where to put them. You just need to supply the tokens.

    my $tokens = {

README.md view on Meta::CPAN

## `api_factory`

Returns an API factory object. You probably won't need to call this directly.

        $self->api_factory('Pet'); # returns a AgentPushKit::Client::PetApi instance

        $self->pet_api;            # the same

# MISSING METHODS

Most of the methods on the API are delegated to individual endpoint API objects
(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
same method name (e.g. `new()`), these methods can't be delegated. So you need
to call `$api->pet_api->new()`.

In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's
unlikely in general that any methods will be undelegatable, except for:

        new()
        class_documentation()
        method_documentation()

README.md view on Meta::CPAN



The `-c` option allows you to load and inspect your own application. A dummy
namespace is used if you don't supply your own class.

# DOCUMENTATION FROM THE OpenAPI Spec

Additional documentation for each class and method may be provided by the OpenAPI
spec. If so, this is available via the `class_documentation()` and
`method_documentation()` methods on each generated object class, and the
`method_documentation()` method on the endpoint API classes:

        my $cmdoc = $api->pet_api->method_documentation->{$method_name};

        my $odoc = $api->get_pet_by_id->(pet_id => $pet_id)->class_documentation;
        my $omdoc = $api->get_pet_by_id->(pet_id => $pet_id)->method_documentation->{method_name};


Each of these calls returns a hashref with various useful pieces of information.

# Installation Prerequisites

docs/AcceptedResponse.md view on Meta::CPAN

## Load the model package
```perl
use AgentPushKit::Client::Object::AcceptedResponse;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accepted** | **boolean** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AccountApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->delete_current_account();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->delete_current_account: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**DeletedResponse**](DeletedResponse.md)

### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_current_account**
> CurrentAccount get_current_account()

Get the current user and customer accounts

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AccountApi;

docs/AccountApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->get_current_account();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountApi->get_current_account: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**CurrentAccount**](CurrentAccount.md)

### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/AddMemberInput.md view on Meta::CPAN

## Load the model package
```perl
use AgentPushKit::Client::Object::AddMemberInput;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**email** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AgentToken.md view on Meta::CPAN

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** |  | 
**name** | **string** |  | 
**key_prefix** | **string** |  | 
**last_four** | **string** |  | 
**created_at** | **DATE_TIME** |  | 
**last_used_at** | **DATE_TIME** |  | [optional] 
**revoked_at** | **DATE_TIME** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AgentTokenCreated.md view on Meta::CPAN

------------ | ------------- | ------------- | -------------
**id** | **string** |  | 
**name** | **string** |  | 
**key_prefix** | **string** |  | 
**last_four** | **string** |  | 
**created_at** | **DATE_TIME** |  | 
**last_used_at** | **DATE_TIME** |  | [optional] 
**revoked_at** | **DATE_TIME** |  | [optional] 
**token** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AgentTokensApi.md view on Meta::CPAN

[**create_agent_token**](AgentTokensApi.md#create_agent_token) | **POST** /agent-tokens | Create a named non-expiring agent token
[**list_agent_tokens**](AgentTokensApi.md#list_agent_tokens) | **GET** /agent-tokens | List agent access tokens without their secrets
[**revoke_agent_token**](AgentTokensApi.md#revoke_agent_token) | **DELETE** /agent-tokens/{tokenId} | Revoke one of the current user&#39;s agent tokens


# **call_mcp**
> call_mcp(request_body => $request_body)

Connect through stateless MCP Streamable HTTP

This endpoint accepts only an `apt_` agent access token.

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AgentTokensApi;
my $api_instance = AgentPushKit::Client::AgentTokensApi->new(

    # Configure bearer access token for authorization: AgentToken
    access_token => 'YOUR_BEARER_TOKEN',

docs/AgentTokensApi.md view on Meta::CPAN


### Authorization

[AgentToken](../README.md#AgentToken)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_agent_token**
> AgentTokenCreated create_agent_token(create_agent_token_input => $create_agent_token_input)

Create a named non-expiring agent token

The raw `apt_` token is shown once. Store it before dismissing the response.

### Example
```perl

docs/AgentTokensApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_agent_tokens**
> ARRAY[AgentToken] list_agent_tokens()

List agent access tokens without their secrets

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AgentTokensApi;

docs/AgentTokensApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->list_agent_tokens();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentTokensApi->list_agent_tokens: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ARRAY[AgentToken]**](AgentToken.md)

### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **revoke_agent_token**
> RevokedResponse revoke_agent_token(token_id => $token_id)

Revoke one of the current user's agent tokens

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AgentTokensApi;

docs/AgentTokensApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/ApiKeySummary.md view on Meta::CPAN

use AgentPushKit::Client::Object::ApiKeySummary;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key_prefix** | **string** |  | [optional] 
**last_four** | **string** |  | [optional] 
**updated_at** | **DATE_TIME** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AuthResponse.md view on Meta::CPAN

```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_token** | **string** |  | 
**user** | [**User**](User.md) |  | 
**organizations** | [**ARRAY[Organization]**](Organization.md) |  | 
**bootstrap_api_key** | **string** | Present only when a new customer account was created. | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/AuthenticationApi.md view on Meta::CPAN


### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **login_with_apple**
> AuthResponse login_with_apple(provider_login_input => $provider_login_input)

Log in or attach an account using a Sign in with Apple identity token

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AuthenticationApi;

docs/AuthenticationApi.md view on Meta::CPAN


### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **login_with_google**
> AuthResponse login_with_google(provider_login_input => $provider_login_input)

Log in or attach an account using a verified Google ID token

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AuthenticationApi;

docs/AuthenticationApi.md view on Meta::CPAN


### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **login_with_password**
> AuthResponse login_with_password(password_login_input => $password_login_input)

Log in with email and password

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AuthenticationApi;

docs/AuthenticationApi.md view on Meta::CPAN


### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **register**
> AuthResponse register(register_input => $register_input)

Create a user and first customer account

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AuthenticationApi;

docs/AuthenticationApi.md view on Meta::CPAN


### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **request_password_reset**
> AcceptedResponse request_password_reset(password_reset_request_input => $password_reset_request_input)

Email a single-use password reset token

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::AuthenticationApi;

docs/AuthenticationApi.md view on Meta::CPAN


### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/CreateAgentTokenInput.md view on Meta::CPAN

## Load the model package
```perl
use AgentPushKit::Client::Object::CreateAgentTokenInput;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CreateOrganizationInput.md view on Meta::CPAN

## Load the model package
```perl
use AgentPushKit::Client::Object::CreateOrganizationInput;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CurrentAccount.md view on Meta::CPAN

```perl
use AgentPushKit::Client::Object::CurrentAccount;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**user** | [**User**](User.md) |  | 
**organizations** | [**ARRAY[Organization]**](Organization.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CustomerAccountsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **create_organization**
> OrganizationCreated create_organization(create_organization_input => $create_organization_input)

Create another Agent Push Kit customer account

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::CustomerAccountsApi;

docs/CustomerAccountsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_organization_members**
> ARRAY[Membership] list_organization_members(organization_id => $organization_id)

List members of a customer account

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::CustomerAccountsApi;

docs/CustomerAccountsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_organizations**
> ARRAY[Organization] list_organizations()

List customer accounts available to the current user

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::CustomerAccountsApi;

docs/CustomerAccountsApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->list_organizations();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomerAccountsApi->list_organizations: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ARRAY[Organization]**](Organization.md)

### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **regenerate_organization_api_key**
> OrganizationApiKeyCreated regenerate_organization_api_key(organization_id => $organization_id)

Rotate the application event-ingestion key

The previous `apk_` key stops working immediately. The replacement is returned only in this response.

### Example
```perl

docs/CustomerAccountsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/DeletedResponse.md view on Meta::CPAN

## Load the model package
```perl
use AgentPushKit::Client::Object::DeletedResponse;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deleted** | **boolean** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/DeliverySummary.md view on Meta::CPAN

```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sent** | **int** |  | 
**failed** | **int** |  | 
**suppressed_users** | **int** |  | 
**eligible_devices** | **int** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/Device.md view on Meta::CPAN

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** |  | 
**installation_id** | **string** |  | 
**environment** | **string** |  | 
**app_version** | **string** |  | [optional] 
**enabled** | **boolean** |  | 
**last_seen_at** | **DATE_TIME** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/DevicesApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->get_web_push_configuration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->get_web_push_configuration: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**WebPushConfiguration**](WebPushConfiguration.md)

### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **register_device**
> Device register_device(register_device_input => $register_device_input)

Register or refresh an APNs device

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::DevicesApi;

docs/DevicesApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **register_web_push_subscription**
> WebPushSubscription register_web_push_subscription(register_web_push_subscription_input => $register_web_push_subscription_input)

Register or refresh a browser push subscription

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::DevicesApi;

docs/DevicesApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **remove_device**
> DisabledResponse remove_device(installation_id => $installation_id)

Disable push delivery to one installation

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::DevicesApi;

docs/DevicesApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **remove_web_push_subscription**
> DisabledResponse remove_web_push_subscription(subscription_id => $subscription_id)

Disable a browser push subscription

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::DevicesApi;

docs/DevicesApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/DisabledResponse.md view on Meta::CPAN

## Load the model package
```perl
use AgentPushKit::Client::Object::DisabledResponse;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**disabled** | **boolean** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ErrorResponse.md view on Meta::CPAN

use AgentPushKit::Client::Object::ErrorResponse;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status_code** | **int** |  | 
**message** | **string** |  | 
**error** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/EventDetail.md view on Meta::CPAN

**type** | **string** |  | 
**title** | **string** |  | 
**body** | **string** |  | 
**external_id** | **string** |  | [optional] 
**action_url** | **string** |  | [optional] 
**created_at** | **DATE_TIME** |  | 
**service** | [**ServiceSummary**](ServiceSummary.md) |  | 
**service_id** | **string** |  | 
**metadata** | **HASH[string,object]** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/EventFilter.md view on Meta::CPAN

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operator** | **string** |  | 
**children** | [**ARRAY[EventFilter]**](EventFilter.md) |  | 
**child** | [**EventFilter**](EventFilter.md) |  | 
**field** | **string** |  | 
**comparison** | **string** |  | 
**value** | **DATE_TIME** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/EventPage.md view on Meta::CPAN

```perl
use AgentPushKit::Client::Object::EventPage;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**events** | [**ARRAY[EventSummary]**](EventSummary.md) |  | 
**next_cursor** | **string** |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/EventSummary.md view on Meta::CPAN

------------ | ------------- | ------------- | -------------
**id** | **string** |  | 
**type** | **string** |  | 
**title** | **string** |  | 
**body** | **string** |  | 
**external_id** | **string** |  | [optional] 
**action_url** | **string** |  | [optional] 
**created_at** | **DATE_TIME** |  | 
**service** | [**ServiceSummary**](ServiceSummary.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/EventsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_events**
> EventPage list_events(organization_id => $organization_id, service => $service, type => $type, search => $search, cursor => $cursor, limit => $limit)

List a paginated inbox

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::EventsApi;

docs/EventsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_notification_types**
> ARRAY[string] list_notification_types(organization_id => $organization_id, service_id => $service_id)

List distinct notification types

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::EventsApi;

docs/EventsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_services**
> ARRAY[Service] list_services(organization_id => $organization_id)

List services discovered from ingested events

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::EventsApi;

docs/EventsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **search_events**
> EventPage search_events(organization_id => $organization_id, search_events_input => $search_events_input)

Search events with a validated Boolean filter tree

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::EventsApi;

docs/EventsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **send_event**
> IngestionResult send_event(send_event_input => $send_event_input)

Send an event using an application ingestion key

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::EventsApi;

docs/EventsApi.md view on Meta::CPAN


### Authorization

[OrganizationApiKey](../README.md#OrganizationApiKey)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **send_event_as_user**
> IngestionResult send_event_as_user(organization_id => $organization_id, send_event_input => $send_event_input)

Send an event as an authenticated user or agent

### Example
```perl
use Data::Dumper;
use AgentPushKit::Client::EventsApi;

docs/EventsApi.md view on Meta::CPAN


### Authorization

[UserOrAgent](../README.md#UserOrAgent)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/FilterGroup.md view on Meta::CPAN

```perl
use AgentPushKit::Client::Object::FilterGroup;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operator** | **string** |  | 
**children** | [**ARRAY[EventFilter]**](EventFilter.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/FilterNot.md view on Meta::CPAN

```perl
use AgentPushKit::Client::Object::FilterNot;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operator** | **string** |  | 
**child** | [**EventFilter**](EventFilter.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/HealthApi.md view on Meta::CPAN

eval {
    my $result = $api_instance->get_health();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HealthApi->get_health: $@\n";
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**HealthResponse**](HealthResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/HealthResponse.md view on Meta::CPAN

```perl
use AgentPushKit::Client::Object::HealthResponse;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **string** |  | 
**service** | **string** |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/IngestionResult.md view on Meta::CPAN

use AgentPushKit::Client::Object::IngestionResult;
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | [**EventDetail**](EventDetail.md) |  | 
**duplicate** | **boolean** |  | 
**delivery** | [**DeliverySummary**](DeliverySummary.md) |  | 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

( run in 2.299 seconds using v1.01-cache-2.11-cpan-364913b4093 )