C# Class CallfireApiClient.Api.Account.OrdersApi

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

Public Methods

Method Description
GetOrder ( long id, string fields = null ) : NumberOrder

Get order for keyword and/or number orders GET /me/account
OrderKeywords ( KeywordPurchaseRequest request ) : ResourceId

Purchase keywords. Send a list of available keywords into this API to purchase them using CallFire credits. Be sure the account has credits before trying to purchase. GET /me/account
OrderNumbers ( NumberPurchaseRequest request ) : ResourceId

Purchase numbers. There are many ways to purchase a number. Set either tollFreeCount or localCount along with some querying fields to purchase numbers by bulk query. Set the list of numbers to purchase by list. Available numbers will be purchased using CallFire credits owned by the user. Be sure the account has credits before trying to purchase. GET /me/account

Private Methods

Method Description
OrdersApi ( RestApiClient client ) : System

Method Details

GetOrder() public method

Get order for keyword and/or number orders GET /me/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 GetOrder ( long id, string fields = null ) : NumberOrder
id long id of order
fields string limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Account.Model.NumberOrder

OrderKeywords() public method

Purchase keywords. Send a list of available keywords into this API to purchase them using CallFire credits. Be sure the account has credits before trying to purchase. GET /me/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 OrderKeywords ( KeywordPurchaseRequest request ) : ResourceId
request CallfireApiClient.Api.Keywords.Model.Request.KeywordPurchaseRequest request payload
return CallfireApiClient.Api.Common.Model.ResourceId

OrderNumbers() public method

Purchase numbers. There are many ways to purchase a number. Set either tollFreeCount or localCount along with some querying fields to purchase numbers by bulk query. Set the list of numbers to purchase by list. Available numbers will be purchased using CallFire credits owned by the user. Be sure the account has credits before trying to purchase. GET /me/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 OrderNumbers ( NumberPurchaseRequest request ) : ResourceId
request CallfireApiClient.Api.Numbers.Model.Request.NumberPurchaseRequest request payload
return CallfireApiClient.Api.Common.Model.ResourceId