C# Class CallfireApiClient.Api.Keywords.KeywordLeasesApi

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

Public Methods

Method Description
Find ( CommonFindRequest request ) : Page

Find all owned keyword leases for a user. A keyword lease is the ownership information involving a keyword.
Get ( string keyword, string fields = null ) : KeywordLease

Get keyword lease by keyword
Update ( KeywordLease keywordLease ) : void

Update keyword lease

Private Methods

Method Description
KeywordLeasesApi ( RestApiClient client ) : CallfireApiClient.Api.Common.Model

Method Details

Find() public method

Find all owned keyword leases for a user. A keyword lease is the ownership information involving a keyword.
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 ( CommonFindRequest request ) : Page
request CommonFindRequest request payload
return Page

Get() public method

Get keyword lease by keyword
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 keyword, string fields = null ) : KeywordLease
keyword string leased keyword
fields string Limit fields returned. Example fields=id,name
return CallfireApiClient.Api.Keywords.Model.KeywordLease

Update() public method

Update keyword 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 ( KeywordLease keywordLease ) : void
keywordLease CallfireApiClient.Api.Keywords.Model.KeywordLease keyword lease payload
return void