C# Class CallfireApiClient.Api.Numbers.NumberLeasesApi

ファイルを表示 Open project: CallFire/callfire-api-client-csharp

Public Methods

Method Description
Find ( FindNumberLeasesRequest request ) : Page

Find number leases by prefix, zipcode, etc... This API is useful for finding all numbers currently owned by an account.
FindConfigs ( FindNumberLeaseConfigsRequest request ) : Page

Find all number lease configs for the user.
Get ( string number, string fields = null ) : NumberLease

Get number lease by number
GetConfig ( string number, string fields = null ) : NumberConfig

Get number lease config
Update ( NumberLease lease ) : void

Update number lease
UpdateConfig ( NumberConfig config ) : void

Update number lease config

Private Methods

Method Description
NumberLeasesApi ( RestApiClient client ) : System

Method Details

Find() public method

Find number leases by prefix, zipcode, etc... This API is useful for finding all numbers currently owned by an account.
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 ( FindNumberLeasesRequest request ) : Page
request CallfireApiClient.Api.Numbers.Model.Request.FindNumberLeasesRequest request object with different fields to filter
return Page

FindConfigs() public method

Find all number lease configs for the user.
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 FindConfigs ( FindNumberLeaseConfigsRequest request ) : Page
request CallfireApiClient.Api.Numbers.Model.Request.FindNumberLeaseConfigsRequest request to filter
return Page

Get() public method

Get number lease by number
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 ( string number, string fields = null ) : NumberLease
number string leased phone number
fields string Limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Numbers.Model.NumberLease

GetConfig() public method

Get number lease config
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 GetConfig ( string number, string fields = null ) : NumberConfig
number string leased phone number
fields string Limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Numbers.Model.NumberConfig

Update() public method

Update number lease
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 ( NumberLease lease ) : void
lease CallfireApiClient.Api.Numbers.Model.NumberLease lease to update
return void

UpdateConfig() public method

Update number lease config
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 UpdateConfig ( NumberConfig config ) : void
config CallfireApiClient.Api.Numbers.Model.NumberConfig config to update
return void