docs/CheckoutApi.md in ultracart_api-4.0.32.rc vs docs/CheckoutApi.md in ultracart_api-4.0.33.rc

- old
+ new

@@ -36,27 +36,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) cart = UltracartClient::Cart.new # Cart | Cart begin # City/State for Zip result = api_instance.city_state(cart) @@ -115,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) finalize_request = UltracartClient::CartFinalizeOrderRequest.new # CartFinalizeOrderRequest | Finalize request begin # Finalize Order result = api_instance.finalize_order(finalize_request) @@ -189,27 +178,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) cart_id = 'cart_id_example' # String | Cart ID to retrieve begin # Get affirm checkout (by cart id) result = api_instance.get_affirm_checkout(cart_id) @@ -268,28 +249,20 @@ ### 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 = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) -api_instance = UltracartClient::CheckoutApi.new - begin # Allowed countries result = api_instance.get_allowed_countries p result rescue UltracartClient::ApiError => e @@ -344,27 +317,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.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 @@ -425,27 +390,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) cart_id = 'cart_id_example' # String | Cart ID to retrieve opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -508,27 +465,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) return_code = 'return_code_example' # String | Return code to lookup cart ID by opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -591,27 +540,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) opts = { return_token: 'return_token_example', # String | Return token provided by StoreFront Communications _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -674,27 +615,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) country_code = 'country_code_example' # String | Two letter ISO country code begin # Get state/province list for a country code result = api_instance.get_state_provinces_for_country(country_code) @@ -753,27 +686,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) handoff_request = UltracartClient::CheckoutHandoffRequest.new # CheckoutHandoffRequest | Handoff request opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -836,27 +761,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) login_request = UltracartClient::CartProfileLoginRequest.new # CartProfileLoginRequest | Login request opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -919,27 +836,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) cart = UltracartClient::Cart.new # Cart | Cart opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -1002,27 +911,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) register_request = UltracartClient::CartProfileRegisterRequest.new # CartProfileRegisterRequest | Register request opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -1085,27 +986,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) register_affiliate_click_request = UltracartClient::RegisterAffiliateClickRequest.new # RegisterAffiliateClickRequest | Register affiliate click request opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -1168,27 +1061,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) cart = UltracartClient::Cart.new # Cart | Cart opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See item resource documentation for examples } @@ -1251,27 +1136,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) item_id = 'item_id_example' # String | Item ID to retrieve related items for cart = UltracartClient::Cart.new # Cart | Cart opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See item resource documentation for examples } @@ -1336,22 +1213,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) browser_key_request = UltracartClient::CheckoutSetupBrowserKeyRequest.new # CheckoutSetupBrowserKeyRequest | Setup browser key request begin # Setup Browser Application result = api_instance.setup_browser_key(browser_key_request) @@ -1410,27 +1284,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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) cart = UltracartClient::Cart.new # Cart | Cart opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } @@ -1493,26 +1359,18 @@ ### 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::CheckoutApi.new +api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE) validation_request = UltracartClient::CartValidationRequest.new # CartValidationRequest | Validation request opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples }