C# Class CallfireApiClient.Api.Webhooks.WebhooksApi

Datei anzeigen Open project: CallFire/callfire-api-client-csharp

Public Methods

Method Description
Create ( Webhook webhook ) : ResourceId

Create a Webhook for notification in the CallFire system. Use the webhooks 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 webhook by id
Find ( FindWebhooksRequest request ) : Page

Find all webhooks for the user. Search for webhooks on name, resource, event, callback URL, or whether they are enabled.
FindWebhookResource ( ResourceType resource, string fields ) : WebhookResource

Find specific webhook resource
FindWebhookResources ( string fields ) : IList

Find webhook resources
Get ( long id, string fields = null ) : Webhook

Get webhook by id.
Update ( Webhook webhook ) : void

Update webhook

Private Methods

Method Description
WebhooksApi ( RestApiClient client ) : System.Collections.Generic

Method Details

Create() public method

Create a Webhook for notification in the CallFire system. Use the webhooks 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 ( Webhook webhook ) : ResourceId
webhook CallfireApiClient.Api.Webhooks.Model.Webhook webhook to create
return CallfireApiClient.Api.Common.Model.ResourceId

Delete() public method

Delete webhook 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 webhook
return void

Find() public method

Find all webhooks for the user. Search for webhooks on name, resource, event, callback URL, 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 ( FindWebhooksRequest request ) : Page
request FindWebhooksRequest request object with different fields to filter
return Page

FindWebhookResource() public method

Find specific webhook resource
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 FindWebhookResource ( ResourceType resource, string fields ) : WebhookResource
resource ResourceType resource type object
fields string
return CallfireApiClient.Api.Webhooks.Model.WebhookResource

FindWebhookResources() public method

Find webhook resources
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 FindWebhookResources ( string fields ) : IList
fields string limit fields returned. Example fields=id,name
return IList

Get() public method

Get webhook 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 ) : Webhook
id long id of webhook
fields string limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Webhooks.Model.Webhook

Update() public method

Update webhook
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 ( Webhook webhook ) : void
webhook CallfireApiClient.Api.Webhooks.Model.Webhook webhook to update
return void