AccountsApi
Summary
public AccountsDto Accounts()
It returns a list of accounts.
public AccountsDto Accounts( AccountsUriParameterBuilder accountsUriParameterBuilder)
It returns a list of accounts.
public AccountDto Account(string accountName)
This function will return an AccountDto object if the API call is successful, otherwise it will throw an exception.
public AccountCollectionDto Collection(string accountName, string collectionName)
This function will return an AccountCollectionDto object if the request is successful.
private readonly string _requestUriBase
private Uri AccountsUri()
It returns a URI for the accounts endpoint.
private Uri AccountsUri( AccountsUriParameterBuilder accountsUriParameterBuilder)
It takes an AccountsUriParameterBuilder object and returns a Uri object.
private Uri AccountUri(string accountName)
Given an account name, return a URI for the account.
private Uri AccountUri(string accountName, string collectionName)
It returns a URI for a given account name and collection name
Members
public AccountsDto Accounts()
It returns a list of accounts.
Returns
A list of accounts
public AccountsDto Accounts( AccountsUriParameterBuilder accountsUriParameterBuilder)
It returns a list of accounts.
Parameters
AccountsUriParameterBuilderThis is a class that contains all the parameters that can be passed to the Accounts endpoint.
Returns
A list of accounts.
public AccountDto Account(string accountName)
This function will return an AccountDto object if the API call is successful, otherwise it will throw an exception.
Parameters
accountNameThe name of the account you want to retrieve.
Returns
An AccountDto object
public AccountCollectionDto Collection(string accountName, string collectionName)
This function will return an AccountCollectionDto object if the request is successful.
Parameters
accountNameThe name of the account you want to retrieve.collectionNameThe name of the collection you want to retrieve.
Returns
An AccountCollectionDto object.
private readonly string _requestUriBase
private Uri AccountsUri()
It returns a URI for the accounts endpoint.
private Uri AccountsUri( AccountsUriParameterBuilder accountsUriParameterBuilder)
It takes an AccountsUriParameterBuilder object and returns a Uri object.
Parameters
AccountsUriParameterBuilderA class that builds the query string parameters for the accounts endpoint.
private Uri AccountUri(string accountName)
Given an account name, return a URI for the account.
Parameters
accountNameThe name of the account to be created.
private Uri AccountUri(string accountName, string collectionName)
It returns a URI for a given account name and collection name
Parameters
accountNameThe name of the account.collectionNameThe name of the collection you want to access.
Last updated