AccountsUriParameterBuilder

Summary

Members

public AccountsUriParameterBuilder WithMatch(string match)

WithMatch sets the match parameter

Parameters

  • match The 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.

public AccountsUriParameterBuilder WithHideOffers(bool hideOffers)

WithHideOffers sets the _hideOffers field to the value of the hideOffers parameter

Parameters

  • hideOffers If true, the response will not include any offers.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithCollectionName(string collectionName)

WithCollectionName is a function that takes a string as a parameter and returns an AccountsUriParameterBuilder object

Parameters

  • collectionName The name of the collection you want to query.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

Parameters

  • schemaName The name of the schema to use.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithTemplateId(string templateId)

It sets the value of the templateId variable.

Parameters

  • templateId The ID of the template to use for the account.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

WithCollectionBlacklist is a function that takes an array of strings and returns an AccountsUriParameterBuilder object

Parameters

  • collectionBlacklist A list of collections to exclude from the results.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

WithCollectionWhitelist is a function that takes an array of strings and returns an AccountsUriParameterBuilder object

Parameters

  • collectionWhitelist A list of collections to include in the response.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithIds(string[] ids)

This function takes an array of strings and joins them together with a comma.

Parameters

  • ids A comma-separated list of account IDs.

Returns

A string

public AccountsUriParameterBuilder WithLowerBound(string lowerBound)

WithLowerBound sets the lower bound of the account_ids parameter

Parameters

  • lowerBound The lower bound of the accounts to retrieve.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithUpperBound(string upperBound)

WithUpperBound sets the upper bound of the range of accounts to be returned

Parameters

  • upperBound The upper bound of the range to query.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithPage(int page)

WithPage sets the _page variable to the value of the page parameter

Parameters

  • page The page number of the results to return.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithLimit(int limit)

WithLimit sets the _limit variable to the value of the limit parameter

Parameters

  • limit The number of results to return.

Returns

The AccountsUriParameterBuilder object.

public AccountsUriParameterBuilder WithOrder( SortStrategy sorting)

This function sets the sort strategy for the query.

Parameters

  • SortStrategy

Returns

The builder object itself.

public string Build()

It builds a query string based on the parameters that have been set.

Returns

A string that contains the parameters for the query.

private string _match

private string _collectionName

private string _schemaName

private string _templateId

private bool? _hideOffers

private string _collectionBlacklist

private string _collectionWhitelist

private string _ids

private string _lowerBound

private string _upperBound

private int? _page

private int? _limit

private SortStrategy? _sortStrategy

Last updated