C# Class CallfireApiClient.Api.Webhooks.SubscriptionsApi

Mostra file Open project: CallFire/callfire-api-client-csharp

Public Methods

Method Description
Create ( Subscription subscription ) : ResourceId

Create a Subscription for notification in the CallFire system. Use the subscriptions API to receive notifications of important CallFire events. Select the resource to listen to, and then choose the events for that resource to receive notifications on. When an event triggers, a POST will be made to the callback URL with a payload of notification information.
Delete ( long id ) : void

Delete subscription by id
Find ( FindSubscriptionsRequest request ) : Page

Find all subscriptions for the user. Search for subscriptions on campaign id, resource, event, from number, to number, or whether they are enabled.
Get ( long id, string fields = null ) : Subscription

Get subscription by id.
Update ( Subscription subscription ) : void

Update subscription

Private Methods

Method Description
SubscriptionsApi ( RestApiClient client ) : System

Method Details

Create() public method

Create a Subscription for notification in the CallFire system. Use the subscriptions API to receive notifications of important CallFire events. Select the resource to listen to, and then choose the events for that resource to receive notifications on. When an event triggers, a POST will be made to the callback URL with a payload of notification information.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Create ( Subscription subscription ) : ResourceId
subscription CallfireApiClient.Api.Webhooks.Model.Subscription subscription to create
return CallfireApiClient.Api.Common.Model.ResourceId

Delete() public method

Delete subscription by id
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Delete ( long id ) : void
id long id of subscription
return void

Find() public method

Find all subscriptions for the user. Search for subscriptions on campaign id, resource, event, from number, to number, or whether they are enabled.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Find ( FindSubscriptionsRequest request ) : Page
request CallfireApiClient.Api.Webhooks.Model.Request.FindSubscriptionsRequest request object with different fields to filter
return Page

Get() public method

Get subscription by id.
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Get ( long id, string fields = null ) : Subscription
id long id of subscription
fields string limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Webhooks.Model.Subscription

Update() public method

Update subscription
in case HTTP response code is 400 - Bad request, the request was formatted improperly. in case HTTP response code is 401 - Unauthorized, API Key missing or invalid. in case HTTP response code is 403 - Forbidden, insufficient permissions. in case HTTP response code is 404 - NOT FOUND, the resource requested does not exist. in case HTTP response code is 500 - Internal Server Error. in case HTTP response code is something different from codes listed above. in case error has occurred in client.
public Update ( Subscription subscription ) : void
subscription CallfireApiClient.Api.Webhooks.Model.Subscription subscription to update
return void