docs/CustomerApi.md in ultracart_api-3.0.76 vs docs/CustomerApi.md in ultracart_api-3.1.0
- old
+ new
@@ -25,22 +25,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
customer_profile_oid = 56 # Integer | The customer_profile_oid to delete.
begin
@@ -82,22 +75,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -143,22 +129,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
opts = {
email: 'email_example', # String | Email
qb_class: 'qb_class_example', # String | Quickbooks class
quickbooks_code: 'quickbooks_code_example', # String | Quickbooks code
@@ -263,22 +242,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
customer_query = UltracartClient::CustomerQuery.new # CustomerQuery | Customer query
opts = {
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
@@ -332,22 +304,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
}
@@ -390,23 +355,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
+
begin
#Retrieve values needed for a customer profile editor
result = api_instance.get_editor_values
p result
rescue UltracartClient::ApiError => e
@@ -441,23 +400,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
+
begin
#Retrieve all email lists across all storefronts
result = api_instance.get_email_lists
p result
rescue UltracartClient::ApiError => e
@@ -492,22 +445,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
customer = UltracartClient::Customer.new # Customer | Customer to insert
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -553,22 +499,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
customer = UltracartClient::Customer.new # Customer | Customer to update
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
@@ -617,21 +556,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::CustomerApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CustomerApi.new
customer_profile_oid = 56 # Integer | The customer profile oid
list_changes = UltracartClient::CustomerEmailListChanges.new # CustomerEmailListChanges | List changes