docs/AutoOrderApi.md in ultracart_api-3.0.76 vs docs/AutoOrderApi.md in ultracart_api-3.1.0
- old
+ new
@@ -23,22 +23,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
auto_order_oid = 56 # Integer | The auto order oid to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -84,22 +77,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
auto_order_code = 'auto_order_code_example' # String | The auto order oid to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -145,22 +131,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
reference_order_id = 'reference_order_id_example' # String | The auto order oid to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -206,22 +185,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
opts = {
auto_order_code: 'auto_order_code_example', # String | Auto order code
original_order_id: 'original_order_id_example', # String | Original order id
first_name: 'first_name_example', # String | First name
@@ -308,22 +280,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
auto_order_batch = UltracartClient::AutoOrderQueryBatch.new # AutoOrderQueryBatch | Auto order batch
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result.
@@ -369,22 +334,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
auto_order_query = UltracartClient::AutoOrderQuery.new # AutoOrderQuery | Auto order query
opts = {
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
@@ -436,22 +394,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto order to update
auto_order_oid = 56 # Integer | The auto order oid to update.
@@ -500,21 +451,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::AutoOrderApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::AutoOrderApi.new
auto_orders_request = UltracartClient::AutoOrdersRequest.new # AutoOrdersRequest | Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
opts = {
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples