C# 클래스 CallfireApiClient.Api.Webhooks.WebhooksApi

파일 보기 프로젝트 열기: CallFire/callfire-api-client-csharp

공개 메소드들

메소드 설명
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

비공개 메소드들

메소드 설명
WebhooksApi ( RestApiClient client ) : System.Collections.Generic

메소드 상세

Create() 공개 메소드

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
리턴 CallfireApiClient.Api.Common.Model.ResourceId

Delete() 공개 메소드

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
리턴 void

Find() 공개 메소드

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
리턴 Page

FindWebhookResource() 공개 메소드

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
리턴 CallfireApiClient.Api.Webhooks.Model.WebhookResource

FindWebhookResources() 공개 메소드

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
리턴 IList

Get() 공개 메소드

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
리턴 CallfireApiClient.Api.Webhooks.Model.Webhook

Update() 공개 메소드

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
리턴 void