docs/OrderApi.md in ultracart_api-4.0.32.rc vs docs/OrderApi.md in ultracart_api-4.0.33.rc
- old
+ new
@@ -40,22 +40,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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
begin
# Adjusts an order total
@@ -116,22 +113,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to cancel.
begin
# Cancel an order
result = api_instance.cancel_order(order_id)
@@ -190,22 +184,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to delete.
begin
# Delete an order
api_instance.delete_order(order_id)
@@ -263,22 +254,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to duplicate.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
}
@@ -341,22 +329,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to format
format_options = UltracartClient::OrderFormat.new # OrderFormat | Format options
begin
# Format order
@@ -417,22 +402,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to generate a token for.
begin
# Generate an order token for a given order id
result = api_instance.generate_order_token(order_id)
@@ -491,22 +473,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | Order ID
begin
# Generate a packing slip for this order across all distribution centers.
result = api_instance.generate_packing_slip_all_dc(order_id)
@@ -565,22 +544,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
order_id = 'order_id_example' # String | Order ID
begin
# Generate a packing slip for this order for the given distribution center.
@@ -641,22 +617,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
begin
# Retrieve A/R Retry Configuration
result = api_instance.get_accounts_receivable_retry_config
p result
@@ -712,22 +685,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
from: 'from_example', # String |
to: 'to_example' # String |
}
@@ -790,22 +760,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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
}
@@ -868,22 +835,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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
}
@@ -946,22 +910,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
order_id: 'order_id_example', # String | Order Id
payment_method: 'payment_method_example', # String | Payment Method
company: 'company_example', # String | Company
first_name: 'first_name_example', # String | First Name
@@ -1082,22 +1043,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_batch = UltracartClient::OrderQueryBatch.new # OrderQueryBatch | Order batch
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result.
}
@@ -1160,22 +1118,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_query = UltracartClient::OrderQuery.new # OrderQuery | Order query
opts = {
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
_sort: '_sort_example', # String | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -1244,22 +1199,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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
}
@@ -1322,22 +1274,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to process payment on
process_payment_request = UltracartClient::OrderProcessPaymentRequest.new # OrderProcessPaymentRequest | Process payment parameters
begin
# Process payment
@@ -1398,22 +1347,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to refund.
order = UltracartClient::Order.new # Order | Order to refund
opts = {
reject_after_refund: true, # Boolean | Reject order after refund
skip_customer_notification: true, # Boolean | Skip customer email notification
@@ -1488,22 +1434,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to generate a replacement for.
replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details
begin
# Replacement order
@@ -1564,22 +1507,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to resend the receipt for.
begin
# Resend receipt
result = api_instance.resend_receipt(order_id)
@@ -1638,22 +1578,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
begin
# Resend shipment confirmation
result = api_instance.resend_shipment_confirmation(order_id)
@@ -1712,22 +1649,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
retry_config = UltracartClient::AccountsReceivableRetryConfig.new # AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object
begin
# Update A/R Retry Configuration
result = api_instance.update_accounts_receivable_retry_config(retry_config)
@@ -1786,21 +1720,18 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
-api_instance = UltracartClient::OrderApi.new
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
order_id = 'order_id_example' # String | The order id to update.
order = UltracartClient::Order.new # Order | Order to update
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
}