docs/CustomerApi.md in ultracart_api-4.0.32.rc vs docs/CustomerApi.md in ultracart_api-4.0.33.rc
- old
+ new
@@ -34,22 +34,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_profile_oid = 56 # Integer | The customer oid to credit.
store_credit_request = UltracartClient::CustomerStoreCreditAddRequest.new # CustomerStoreCreditAddRequest | Store credit to add
begin
# Adds store credit to a customer
@@ -110,22 +107,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_profile_oid = 56 # Integer | The customer profile oid
adjust_internal_certificate_request = UltracartClient::AdjustInternalCertificateRequest.new # AdjustInternalCertificateRequest | adjustInternalCertificateRequest
begin
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -186,22 +180,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_profile_oid = 56 # Integer | The customer_profile_oid to delete.
begin
# Delete a customer
api_instance.delete_customer(customer_profile_oid)
@@ -259,22 +250,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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
}
@@ -337,22 +325,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
email = 'email_example' # String | The email address of the customer to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
}
@@ -415,22 +400,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
begin
# Retrieve values needed for a customer profile editor
result = api_instance.get_customer_editor_values
p result
@@ -486,22 +468,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
begin
# Retrieve all email lists across all storefronts
result = api_instance.get_customer_email_lists
p result
@@ -557,22 +536,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
begin
# Retrieve the customer store credit accumulated through loyalty programs
result = api_instance.get_customer_store_credit(customer_profile_oid)
@@ -631,22 +607,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
email: 'email_example', # String | Email
qb_class: 'qb_class_example', # String | Quickbooks class
quickbooks_code: 'quickbooks_code_example', # String | Quickbooks code
last_modified_dts_start: 'last_modified_dts_start_example', # String | Last modified date start
@@ -769,22 +742,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_query = UltracartClient::CustomerQuery.new # CustomerQuery | Customer query
opts = {
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
_offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
_since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
@@ -855,22 +825,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
}
begin
@@ -931,22 +898,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
token_request = UltracartClient::EmailVerifyTokenRequest.new # EmailVerifyTokenRequest | Token request
begin
# Create a token that can be used to verify a customer email address
result = api_instance.get_email_verification_token(token_request)
@@ -1005,22 +969,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
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
}
@@ -1081,27 +1042,19 @@
### Examples
```ruby
require 'time'
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure API key authorization: ultraCartBrowserApiKey
- config.api_key['ultraCartBrowserApiKey'] = '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['ultraCartBrowserApiKey'] = 'Bearer'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
+# 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.
- # 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
-
-api_instance = UltracartClient::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
lookup_request = UltracartClient::LookupRequest.new # LookupRequest | LookupRequest
begin
# Searches for all matching values (using POST)
result = api_instance.search_customer_profile_values(lookup_request)
@@ -1160,22 +1113,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
customer = UltracartClient::Customer.new # Customer | Customer to update
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
}
@@ -1240,22 +1190,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
customer_profile_oid = 56 # Integer | The customer profile oid
list_changes = UltracartClient::CustomerEmailListChanges.new # CustomerEmailListChanges | List changes
begin
# Update email list subscriptions for a customer
@@ -1316,21 +1263,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::CustomerApi.new
+api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
validation_request = UltracartClient::EmailVerifyTokenValidateRequest.new # EmailVerifyTokenValidateRequest | Token validation request
begin
# Validate a token that can be used to verify a customer email address
result = api_instance.validate_email_verification_token(validation_request)