Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Update_shipping_address

Description

Contains the different functions to run the operation update_shipping_address

Synopsis

update_shipping_address :: forall m. MonadHTTP m => Update_shipping_addressParameters -> ShippingAddressUpdate -> ClientT m (Response Update_shipping_addressResponse)
data Update_shipping_addressParameters = Update_shipping_addressParameters {
- update_shipping_addressParametersPathAccount_id :: Text
- update_shipping_addressParametersPathShipping_address_id :: Text
}
mkUpdate_shipping_addressParameters :: Text -> Text -> Update_shipping_addressParameters
data Update_shipping_addressResponse
update_shipping_addressWithConfiguration :: forall m. MonadHTTP m => Configuration -> Update_shipping_addressParameters -> ShippingAddressUpdate -> m (Response Update_shipping_addressResponse)
update_shipping_addressRaw :: forall m. MonadHTTP m => Update_shipping_addressParameters -> ShippingAddressUpdate -> ClientT m (Response ByteString)
update_shipping_addressWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Update_shipping_addressParameters -> ShippingAddressUpdate -> m (Response ByteString)

Documentation

update_shipping_address Source #

Arguments

:: forall m. MonadHTTP m
=> Update_shipping_addressParameters	Contains all available parameters of this operation (query and path parameters)
-> ShippingAddressUpdate	The request body to send
-> ClientT m (Response Update_shipping_addressResponse)	Monadic computation which returns the result of the operation

PUT /accounts/{account_id}/shipping_addresses/{shipping_address_id}

Update an account's shipping address

data Update_shipping_addressParameters Source #

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

Constructors

Update_shipping_addressParameters
Fields update_shipping_addressParametersPathAccount_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`. update_shipping_addressParametersPathShipping_address_id :: Text pathShipping_address_id: Represents the parameter named 'shipping_address_id' Shipping Address ID.

Instances

Instances details

FromJSON Update_shipping_addressParameters Source #
Instance details Defined in RecurlyClient.Operations.Update_shipping_address Methods parseJSON :: Value -> Parser Update_shipping_addressParameters # parseJSONList :: Value -> Parser [Update_shipping_addressParameters] #
ToJSON Update_shipping_addressParameters Source #
Instance details Defined in RecurlyClient.Operations.Update_shipping_address Methods toJSON :: Update_shipping_addressParameters -> Value # toEncoding :: Update_shipping_addressParameters -> Encoding # toJSONList :: [Update_shipping_addressParameters] -> Value # toEncodingList :: [Update_shipping_addressParameters] -> Encoding #
Show Update_shipping_addressParameters Source #
Instance details Defined in RecurlyClient.Operations.Update_shipping_address Methods showsPrec :: Int -> Update_shipping_addressParameters -> ShowS # show :: Update_shipping_addressParameters -> String # showList :: [Update_shipping_addressParameters] -> ShowS #
Eq Update_shipping_addressParameters Source #
Instance details Defined in RecurlyClient.Operations.Update_shipping_address Methods (==) :: Update_shipping_addressParameters -> Update_shipping_addressParameters -> Bool # (/=) :: Update_shipping_addressParameters -> Update_shipping_addressParameters -> Bool #

mkUpdate_shipping_addressParameters Source #

Arguments

:: Text	`update_shipping_addressParametersPathAccount_id`
-> Text	`update_shipping_addressParametersPathShipping_address_id`
-> Update_shipping_addressParameters

Create a new Update_shipping_addressParameters with all required fields.

data Update_shipping_addressResponse Source #

Represents a response of the operation update_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), Update_shipping_addressResponseError is used.

Constructors

Update_shipping_addressResponseError String	Means either no matching case available or a parse error
Update_shipping_addressResponse200 ShippingAddress	The updated shipping address.
Update_shipping_addressResponse400 Error	Bad request, perhaps invalid JSON?
Update_shipping_addressResponse404 Error	Incorrect site, account, or shipping address ID.
Update_shipping_addressResponse422 Error	Invalid request parameters
Update_shipping_addressResponseDefault Error	Unexpected error.

Instances

Instances details

Show Update_shipping_addressResponse Source #
Instance details Defined in RecurlyClient.Operations.Update_shipping_address Methods showsPrec :: Int -> Update_shipping_addressResponse -> ShowS # show :: Update_shipping_addressResponse -> String # showList :: [Update_shipping_addressResponse] -> ShowS #
Eq Update_shipping_addressResponse Source #
Instance details Defined in RecurlyClient.Operations.Update_shipping_address Methods (==) :: Update_shipping_addressResponse -> Update_shipping_addressResponse -> Bool # (/=) :: Update_shipping_addressResponse -> Update_shipping_addressResponse -> Bool #

update_shipping_addressWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Update_shipping_addressParameters	Contains all available parameters of this operation (query and path parameters)
-> ShippingAddressUpdate	The request body to send
-> m (Response Update_shipping_addressResponse)	Monadic computation which returns the result of the operation

PUT /accounts/{account_id}/shipping_addresses/{shipping_address_id}

The same as update_shipping_address but accepts an explicit configuration.

update_shipping_addressRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Update_shipping_addressParameters	Contains all available parameters of this operation (query and path parameters)
-> ShippingAddressUpdate	The request body to send
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /accounts/{account_id}/shipping_addresses/{shipping_address_id}

The same as update_shipping_address but returns the raw ByteString.

update_shipping_addressWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Update_shipping_addressParameters	Contains all available parameters of this operation (query and path parameters)
-> ShippingAddressUpdate	The request body to send
-> m (Response ByteString)	Monadic computation which returns the result of the operation

PUT /accounts/{account_id}/shipping_addresses/{shipping_address_id}

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