AccountsUriParameterBuilder
Summary
WithMatch sets the match parameter
WithHideOffers sets the _hideOffers field to the value of the hideOffers parameter
WithCollectionName is a function that takes a string as a parameter and returns an AccountsUriParameterBuilder object
This function sets the schema name for the query.
It sets the value of the templateId variable.
WithCollectionBlacklist is a function that takes an array of strings and returns an AccountsUriParameterBuilder object
WithCollectionWhitelist is a function that takes an array of strings and returns an AccountsUriParameterBuilder object
This function takes an array of strings and joins them together with a comma.
WithLowerBound sets the lower bound of the account_ids parameter
WithUpperBound sets the upper bound of the range of accounts to be returned
WithPage sets the _page variable to the value of the page parameter
WithLimit sets the _limit variable to the value of the limit parameter
This function sets the sort strategy for the query.
It builds a query string based on the parameters that have been set.
Members
WithMatch sets the match parameter
Parameters
matchThe match parameter is used to filter the results. The match parameter is a string that is matched against the account name.
Returns
The AccountsUriParameterBuilder object.
WithHideOffers sets the _hideOffers field to the value of the hideOffers parameter
Parameters
hideOffersIf true, the response will not include any offers.
Returns
The AccountsUriParameterBuilder object.
WithCollectionName is a function that takes a string as a parameter and returns an AccountsUriParameterBuilder object
Parameters
collectionNameThe name of the collection you want to query.
Returns
The AccountsUriParameterBuilder object.
This function sets the schema name for the query.
Parameters
schemaNameThe name of the schema to use.
Returns
The AccountsUriParameterBuilder object.
It sets the value of the templateId variable.
Parameters
templateIdThe ID of the template to use for the account.
Returns
The AccountsUriParameterBuilder object.
WithCollectionBlacklist is a function that takes an array of strings and returns an AccountsUriParameterBuilder object
Parameters
collectionBlacklistA list of collections to exclude from the results.
Returns
The AccountsUriParameterBuilder object.
WithCollectionWhitelist is a function that takes an array of strings and returns an AccountsUriParameterBuilder object
Parameters
collectionWhitelistA list of collections to include in the response.
Returns
The AccountsUriParameterBuilder object.
This function takes an array of strings and joins them together with a comma.
Parameters
idsA comma-separated list of account IDs.
Returns
A string
WithLowerBound sets the lower bound of the account_ids parameter
Parameters
lowerBoundThe lower bound of the accounts to retrieve.
Returns
The AccountsUriParameterBuilder object.
WithUpperBound sets the upper bound of the range of accounts to be returned
Parameters
upperBoundThe upper bound of the range to query.
Returns
The AccountsUriParameterBuilder object.
WithPage sets the _page variable to the value of the page parameter
Parameters
pageThe page number of the results to return.
Returns
The AccountsUriParameterBuilder object.
WithLimit sets the _limit variable to the value of the limit parameter
Parameters
limitThe number of results to return.
Returns
The AccountsUriParameterBuilder object.
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
It builds a query string based on the parameters that have been set.
Returns
A string that contains the parameters for the query.
Last updated