docs/OrderApi.md in ultracart_api-3.0.76 vs docs/OrderApi.md in ultracart_api-3.1.0

- old
+ new

@@ -35,22 +35,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to cancel. desired_total = 'desired_total_example' # String | The desired total with no formatting. example 123.45 @@ -95,22 +88,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to cancel. begin @@ -152,22 +138,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to delete. begin @@ -208,22 +187,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to format format_options = UltracartClient::OrderFormat.new # OrderFormat | Format options @@ -268,22 +240,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to generate a token for. begin @@ -325,23 +290,17 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new + begin #Retrieve A/R Retry Configuration result = api_instance.get_accounts_receivable_retry_config p result rescue UltracartClient::ApiError => e @@ -376,22 +335,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new opts = { from: 'from_example', # String | to: 'to_example' # String | } @@ -436,22 +388,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to retrieve. opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples @@ -497,22 +442,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_by_token_query = UltracartClient::OrderByTokenQuery.new # OrderByTokenQuery | Order by token query opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples @@ -558,22 +496,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new opts = { order_id: 'order_id_example', # String | Order Id payment_method: 'payment_method_example', # String | Payment Method company: 'company_example', # String | Company @@ -682,22 +613,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_batch = UltracartClient::OrderQueryBatch.new # OrderQueryBatch | Order batch opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. @@ -743,22 +667,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_query = UltracartClient::OrderQuery.new # OrderQuery | Order query opts = { _limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200) @@ -810,22 +727,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order = UltracartClient::Order.new # Order | Order to insert opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples @@ -871,22 +781,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to process payment on process_payment_request = UltracartClient::OrderProcessPaymentRequest.new # OrderProcessPaymentRequest | Process payment parameters @@ -931,22 +834,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order = UltracartClient::Order.new # Order | Order to refund order_id = 'order_id_example' # String | The order id to refund. @@ -1005,22 +901,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to generate a replacement for. replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details @@ -1065,22 +954,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to resend the receipt for. begin @@ -1122,22 +1004,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order_id = 'order_id_example' # String | The order id to resend the shipment notification for. begin @@ -1179,22 +1054,15 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new retry_config = UltracartClient::AccountsReceivableRetryConfig.new # AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object begin @@ -1236,21 +1104,14 @@ ### Example ```ruby # load the gem require 'ultracart_api' -# setup authorization -UltracartClient.configure do |config| - # Configure OAuth2 access token for authorization: ultraCartOauth - config.access_token = 'YOUR ACCESS TOKEN' - # Configure API key authorization: ultraCartSimpleApiKey - config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY' - # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) - #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer' -end +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false) -api_instance = UltracartClient::OrderApi.new order = UltracartClient::Order.new # Order | Order to update order_id = 'order_id_example' # String | The order id to update.