AgentPushKit-Client

 view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

*CustomerAccountsApi* | [**regenerate_organization_api_key**](docs/CustomerAccountsApi.md#regenerate_organization_api_key) | **POST** /organizations/{organizationId}/api-key/regenerate | Rotate the application event-ingestion key
*DevicesApi* | [**get_web_push_configuration**](docs/DevicesApi.md#get_web_push_configuration) | **GET** /web-push/configuration | Get browser push availability and its public VAPID key
*DevicesApi* | [**register_device**](docs/DevicesApi.md#register_device) | **POST** /devices | Register or refresh an APNs device
*DevicesApi* | [**register_web_push_subscription**](docs/DevicesApi.md#register_web_push_subscription) | **POST** /web-push/subscriptions | Register or refresh a browser push subscription
*DevicesApi* | [**remove_device**](docs/DevicesApi.md#remove_device) | **DELETE** /devices/{installationId} | Disable push delivery to one installation
*DevicesApi* | [**remove_web_push_subscription**](docs/DevicesApi.md#remove_web_push_subscription) | **DELETE** /web-push/subscriptions/{subscriptionId} | Disable a browser push subscription
*EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /organizations/{organizationId}/events/{eventId} | Get one event including metadata
*EventsApi* | [**list_events**](docs/EventsApi.md#list_events) | **GET** /organizations/{organizationId}/events | List a paginated inbox
*EventsApi* | [**list_notification_types**](docs/EventsApi.md#list_notification_types) | **GET** /organizations/{organizationId}/types | List distinct notification types
*EventsApi* | [**list_services**](docs/EventsApi.md#list_services) | **GET** /organizations/{organizationId}/services | List services discovered from ingested events
*EventsApi* | [**search_events**](docs/EventsApi.md#search_events) | **POST** /organizations/{organizationId}/events/search | Search events with a validated Boolean filter tree
*EventsApi* | [**send_event**](docs/EventsApi.md#send_event) | **POST** /events | Send an event using an application ingestion key
*EventsApi* | [**send_event_as_user**](docs/EventsApi.md#send_event_as_user) | **POST** /organizations/{organizationId}/events | Send an event as an authenticated user or agent
*HealthApi* | [**get_health**](docs/HealthApi.md#get_health) | **GET** /health | Check Agent Push Kit API health
*PreferencesApi* | [**list_preferences**](docs/PreferencesApi.md#list_preferences) | **GET** /organizations/{organizationId}/preferences | List service defaults and exact-type overrides
*PreferencesApi* | [**remove_type_preference**](docs/PreferencesApi.md#remove_type_preference) | **DELETE** /services/{serviceId}/types/{type}/preference | Remove an exact-type override so it inherits the service default
*PreferencesApi* | [**set_service_preference**](docs/PreferencesApi.md#set_service_preference) | **PUT** /services/{serviceId}/preference | Enable or disable pushes for a service by default
*PreferencesApi* | [**set_type_preference**](docs/PreferencesApi.md#set_type_preference) | **PUT** /services/{serviceId}/types/{type}/preference | Override push delivery for one exact notification type


# DOCUMENTATION FOR MODELS

docs/EventsApi.md  view on Meta::CPAN

```

All URIs are relative to *https://api.chatdna.co/agent-push-kit/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_event**](EventsApi.md#get_event) | **GET** /organizations/{organizationId}/events/{eventId} | Get one event including metadata
[**list_events**](EventsApi.md#list_events) | **GET** /organizations/{organizationId}/events | List a paginated inbox
[**list_notification_types**](EventsApi.md#list_notification_types) | **GET** /organizations/{organizationId}/types | List distinct notification types
[**list_services**](EventsApi.md#list_services) | **GET** /organizations/{organizationId}/services | List services discovered from ingested events
[**search_events**](EventsApi.md#search_events) | **POST** /organizations/{organizationId}/events/search | Search events with a validated Boolean filter tree
[**send_event**](EventsApi.md#send_event) | **POST** /events | Send an event using an application ingestion key
[**send_event_as_user**](EventsApi.md#send_event_as_user) | **POST** /organizations/{organizationId}/events | Send an event as an authenticated user or agent


# **get_event**
> EventDetail get_event(organization_id => $organization_id, event_id => $event_id)

Get one event including metadata

### Example

docs/EventsApi.md  view on Meta::CPAN

### 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;
my $api_instance = AgentPushKit::Client::EventsApi->new(

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

lib/AgentPushKit/Client/EventsApi.pm  view on Meta::CPAN

    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('ARRAY[Service]', $response);
    return $_response_object;
}

#
# search_events
#
# Search events with a validated Boolean filter tree
#
# @param string $organization_id  (required)
# @param SearchEventsInput $search_events_input  (required)
{
    my $params = {
    'organization_id' => {
        data_type => 'string',
        description => '',
        required => '1',
    },
    'search_events_input' => {
        data_type => 'SearchEventsInput',
        description => '',
        required => '1',
    },
    };
    __PACKAGE__->method_documentation->{ 'search_events' } = {
        summary => 'Search events with a validated Boolean filter tree',
        params => $params,
        returns => 'EventPage',
        };
}
# @return EventPage
#
sub search_events {
    my ($self, %args) = @_;

    # verify the required parameter 'organization_id' is set