RecurlyClient.Operations.List_shipping_addresses

Contains the different functions to run the operation list_shipping_addresses

Documentation

list_shipping_addresses

Arguments

:: forall m. MonadHTTP m

=> List_shipping_addressesParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response List_shipping_addressesResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/shipping_addresses

See the Pagination Guide to learn how to use pagination in the API and Client Libraries.

data List_shipping_addressesParameters

Defines the object schema located at paths./accounts/{account_id}/shipping_addresses.GET.parameters in the specification.

Constructors

List_shipping_addressesParameters

Fields

• list_shipping_addressesParametersPathAccount_id :: Text

  pathAccount_id: Represents the parameter named 'account_id'

  Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

• list_shipping_addressesParametersQueryBegin_time :: Maybe JsonDateTime

  queryBegin_time: Represents the parameter named 'begin_time'

  Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_shipping_addressesParametersQueryEnd_time :: Maybe JsonDateTime

  queryEnd_time: Represents the parameter named 'end_time'

  Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

• list_shipping_addressesParametersQueryIds :: Maybe [Text]

  queryIds: Represents the parameter named 'ids'

  Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.

  • *Important notes:**
  • The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
  • Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request.
  • Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.
• list_shipping_addressesParametersQueryLimit :: Maybe Int

  queryLimit: Represents the parameter named 'limit'

  Limit number of records 1-200.

  Constraints:

  • Maxium of 200.0
  • Minimum of 1.0
• list_shipping_addressesParametersQueryOrder :: Maybe List_shipping_addressesParametersQueryOrder

  queryOrder: Represents the parameter named 'order'

  Sort order.

• list_shipping_addressesParametersQuerySort :: Maybe List_shipping_addressesParametersQuerySort

  querySort: Represents the parameter named 'sort'

  Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Instances

FromJSON List_shipping_addressesParameters

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

parseJSON :: Value -> Parser List_shipping_addressesParameters

parseJSONList :: Value -> Parser [List_shipping_addressesParameters]

ToJSON List_shipping_addressesParameters

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

toJSON :: List_shipping_addressesParameters -> Value

toEncoding :: List_shipping_addressesParameters -> Encoding

toJSONList :: [List_shipping_addressesParameters] -> Value

toEncodingList :: [List_shipping_addressesParameters] -> Encoding

Show List_shipping_addressesParameters

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

showsPrec :: Int -> List_shipping_addressesParameters -> ShowS

show :: List_shipping_addressesParameters -> String

showList :: [List_shipping_addressesParameters] -> ShowS

Eq List_shipping_addressesParameters

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

(==) :: List_shipping_addressesParameters -> List_shipping_addressesParameters -> Bool

(/=) :: List_shipping_addressesParameters -> List_shipping_addressesParameters -> Bool

mkList_shipping_addressesParameters

Arguments

:: Text

list_shipping_addressesParametersPathAccount_id

-> List_shipping_addressesParameters

Create a new List_shipping_addressesParameters with all required fields.

data List_shipping_addressesParametersQueryOrder

Defines the enum schema located at paths./accounts/{account_id}/shipping_addresses.GET.parameters.properties.queryOrder in the specification.

Represents the parameter named 'order'

Sort order.

Constructors

List_shipping_addressesParametersQueryOrderOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_shipping_addressesParametersQueryOrderTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_shipping_addressesParametersQueryOrderEnumAsc

Represents the JSON value "asc"

List_shipping_addressesParametersQueryOrderEnumDesc

Represents the JSON value "desc"

Instances

FromJSON List_shipping_addressesParametersQueryOrder

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

parseJSON :: Value -> Parser List_shipping_addressesParametersQueryOrder

parseJSONList :: Value -> Parser [List_shipping_addressesParametersQueryOrder]

ToJSON List_shipping_addressesParametersQueryOrder

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

toJSON :: List_shipping_addressesParametersQueryOrder -> Value

toEncoding :: List_shipping_addressesParametersQueryOrder -> Encoding

toJSONList :: [List_shipping_addressesParametersQueryOrder] -> Value

toEncodingList :: [List_shipping_addressesParametersQueryOrder] -> Encoding

Show List_shipping_addressesParametersQueryOrder

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

showsPrec :: Int -> List_shipping_addressesParametersQueryOrder -> ShowS

show :: List_shipping_addressesParametersQueryOrder -> String

showList :: [List_shipping_addressesParametersQueryOrder] -> ShowS

Eq List_shipping_addressesParametersQueryOrder

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

(==) :: List_shipping_addressesParametersQueryOrder -> List_shipping_addressesParametersQueryOrder -> Bool

(/=) :: List_shipping_addressesParametersQueryOrder -> List_shipping_addressesParametersQueryOrder -> Bool

data List_shipping_addressesParametersQuerySort

Defines the enum schema located at paths./accounts/{account_id}/shipping_addresses.GET.parameters.properties.querySort in the specification.

Represents the parameter named 'sort'

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

Constructors

List_shipping_addressesParametersQuerySortOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

List_shipping_addressesParametersQuerySortTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

List_shipping_addressesParametersQuerySortEnumCreated_at

Represents the JSON value "created_at"

List_shipping_addressesParametersQuerySortEnumUpdated_at

Represents the JSON value "updated_at"

Instances

FromJSON List_shipping_addressesParametersQuerySort

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

parseJSON :: Value -> Parser List_shipping_addressesParametersQuerySort

parseJSONList :: Value -> Parser [List_shipping_addressesParametersQuerySort]

ToJSON List_shipping_addressesParametersQuerySort

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

toJSON :: List_shipping_addressesParametersQuerySort -> Value

toEncoding :: List_shipping_addressesParametersQuerySort -> Encoding

toJSONList :: [List_shipping_addressesParametersQuerySort] -> Value

toEncodingList :: [List_shipping_addressesParametersQuerySort] -> Encoding

Show List_shipping_addressesParametersQuerySort

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

showsPrec :: Int -> List_shipping_addressesParametersQuerySort -> ShowS

show :: List_shipping_addressesParametersQuerySort -> String

showList :: [List_shipping_addressesParametersQuerySort] -> ShowS

Eq List_shipping_addressesParametersQuerySort

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

(==) :: List_shipping_addressesParametersQuerySort -> List_shipping_addressesParametersQuerySort -> Bool

(/=) :: List_shipping_addressesParametersQuerySort -> List_shipping_addressesParametersQuerySort -> Bool

data List_shipping_addressesResponse

Represents a response of the operation list_shipping_addresses.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), List_shipping_addressesResponseError is used.

Constructors

List_shipping_addressesResponseError String

Means either no matching case available or a parse error

List_shipping_addressesResponse200 ShippingAddressList

A list of an account's shipping addresses.

List_shipping_addressesResponse404 Error

Incorrect site or account ID.

List_shipping_addressesResponseDefault Error

Unexpected error.

Instances

Show List_shipping_addressesResponse

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

showsPrec :: Int -> List_shipping_addressesResponse -> ShowS

show :: List_shipping_addressesResponse -> String

showList :: [List_shipping_addressesResponse] -> ShowS

Eq List_shipping_addressesResponse

Defined in RecurlyClient.Operations.List_shipping_addresses

Methods

(==) :: List_shipping_addressesResponse -> List_shipping_addressesResponse -> Bool

(/=) :: List_shipping_addressesResponse -> List_shipping_addressesResponse -> Bool

list_shipping_addressesWithConfiguration

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_shipping_addressesParameters

Contains all available parameters of this operation (query and path parameters)

-> m (Response List_shipping_addressesResponse)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/shipping_addresses

The same as list_shipping_addresses but accepts an explicit configuration.

list_shipping_addressesRaw

Arguments

:: forall m. MonadHTTP m

=> List_shipping_addressesParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response ByteString)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/shipping_addresses

The same as list_shipping_addresses but returns the raw ByteString.

list_shipping_addressesWithConfigurationRaw

Arguments

:: forall m. MonadHTTP m

=> Configuration

The configuration to use in the request

-> List_shipping_addressesParameters

Contains all available parameters of this operation (query and path parameters)

-> m (Response ByteString)

Monadic computation which returns the result of the operation

GET /accounts/{account_id}/shipping_addresses

The same as list_shipping_addresses but accepts an explicit configuration and returns the raw ByteString.