Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
RecurlyClient.Operations.Create_shipping_address
Description
Contains the different functions to run the operation create_shipping_address
Synopsis
- create_shipping_address :: forall m. MonadHTTP m => Text -> ShippingAddressCreate -> ClientT m (Response Create_shipping_addressResponse)
- data Create_shipping_addressResponse
- create_shipping_addressWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> ShippingAddressCreate -> m (Response Create_shipping_addressResponse)
- create_shipping_addressRaw :: forall m. MonadHTTP m => Text -> ShippingAddressCreate -> ClientT m (Response ByteString)
- create_shipping_addressWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> ShippingAddressCreate -> m (Response ByteString)
Documentation
create_shipping_address Source #
Arguments
:: forall m. MonadHTTP m | |
=> Text | account_id: Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. |
-> ShippingAddressCreate | The request body to send |
-> ClientT m (Response Create_shipping_addressResponse) | Monadic computation which returns the result of the operation |
POST /accounts/{account_id}/shipping_addresses
Create a new shipping address for the account
data Create_shipping_addressResponse Source #
Represents a response of the operation create_shipping_address
.
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), Create_shipping_addressResponseError
is used.
Constructors
Create_shipping_addressResponseError String | Means either no matching case available or a parse error |
Create_shipping_addressResponse200 ShippingAddress | Returns the new shipping address. |
Create_shipping_addressResponse400 Error | Bad request; perhaps missing or invalid parameters. |
Create_shipping_addressResponse404 Error | Incorrect site or account ID. |
Create_shipping_addressResponse422 Error | A validation error. |
Instances
create_shipping_addressWithConfiguration Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> Text | account_id: Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. |
-> ShippingAddressCreate | The request body to send |
-> m (Response Create_shipping_addressResponse) | Monadic computation which returns the result of the operation |
POST /accounts/{account_id}/shipping_addresses
The same as create_shipping_address
but accepts an explicit configuration.
create_shipping_addressRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Text | account_id: Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. |
-> ShippingAddressCreate | The request body to send |
-> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /accounts/{account_id}/shipping_addresses
The same as create_shipping_address
but returns the raw ByteString
.
create_shipping_addressWithConfigurationRaw Source #
Arguments
:: forall m. MonadHTTP m | |
=> Configuration | The configuration to use in the request |
-> Text | account_id: Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`. |
-> ShippingAddressCreate | The request body to send |
-> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /accounts/{account_id}/shipping_addresses
The same as create_shipping_address
but accepts an explicit configuration and returns the raw ByteString
.