ultracart_api 3.2.15 → 3.4.0

data/docs/RtgThemeRestriction.md

@@ -0,0 +1,10 @@
+# UltracartClient::RtgThemeRestriction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**restriction** | **String** | Any restriction for this theme | [optional] 
+**storefront_host_name** | **String** | The server name for this theme.  This will not be populated for legacy (ancient) themes | [optional] 
+**theme_code** | **String** | Human friendly short code for this theme | [optional] 
+
+

data/docs/ScreenRecordingPageViewEvent.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **name** | **String** |  | [optional] 
 **params** | [**Array<ScreenRecordingPageViewEventParameter>**](ScreenRecordingPageViewEventParameter.md) |  | [optional] 
 **prior_page_view** | **BOOLEAN** |  | [optional] 
+**sub_text** | **String** |  | [optional] 
 **timestamp** | **String** | Timestamp of the event | [optional] 
 **ts** | **Integer** |  | [optional] 
 

data/docs/SingleSignOnAuthorizeRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnAuthorizeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_uri** | **String** | The URL that the customer should be redirected to after they have approved a single sign on session. | [optional] 
+**state** | **String** | An optional state variable that you provide.  It will be returned to you on the redirect.  You can inspect the state to validate the request is legitimate.  We recommend using this field. | [optional] 
+
+

data/docs/SingleSignOnAuthorizeResponse.md

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnAuthorizeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_dts** | **String** | Expiration date/time after which the single sign-on login operation will have timed out | [optional] 
+**login_url** | **String** | The URL that you should redirect the customer's browser to.  This URL will begin the login process. | [optional] 
+
+

data/docs/SingleSignOnTokenRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnTokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The code received on the redirect URI after the customer approved the single sign on request. | [optional] 
+**grant_type** | **String** | Grant type.  The value should be simple_key. | [optional] 
+
+

data/docs/SingleSignOnTokenResponse.md

@@ -0,0 +1,10 @@
+# UltracartClient::SingleSignOnTokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_dts** | **String** | Expiration date/time after which time the key is no longer valid | [optional] 
+**ip_address** | **String** | IP address of the user which we recommend you lock the simple key's usage to. | [optional] 
+**simple_key** | **String** | The simple key that can then be used to make SDK calls on the users behalf. | [optional] 
+
+

data/docs/SsoApi.md

@@ -0,0 +1,201 @@
+# UltracartClient::SsoApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sso_session_user**](SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
+[**sso_authorize**](SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
+[**sso_session_revoke**](SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
+[**sso_token**](SsoApi.md#sso_token) | **PUT** /sso/token | Exchange a single sign on code for a simple key token
+
+
+# **get_sso_session_user**
+> User get_sso_session_user
+
+Get single sign on session user
+
+This is the equivalent of logging out of the single sign on session 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get single sign on session user
+  result = api_instance.get_sso_session_user
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->get_sso_session_user: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **sso_authorize**
+> SingleSignOnAuthorizeResponse sso_authorize(authorization_request)
+
+Authorize a single sign on session
+
+Starts the process of authorizing a single sign on session. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+authorization_request = UltracartClient::SingleSignOnAuthorizeRequest.new # SingleSignOnAuthorizeRequest | Authorization request
+
+
+begin
+  #Authorize a single sign on session
+  result = api_instance.sso_authorize(authorization_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->sso_authorize: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization_request** | [**SingleSignOnAuthorizeRequest**](SingleSignOnAuthorizeRequest.md)| Authorization request | 
+
+### Return type
+
+[**SingleSignOnAuthorizeResponse**](SingleSignOnAuthorizeResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **sso_session_revoke**
+> sso_session_revoke
+
+Revoke single sign on session
+
+This is the equivalent of logging out of the single sign on session 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Revoke single sign on session
+  api_instance.sso_session_revoke
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->sso_session_revoke: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **sso_token**
+> SingleSignOnTokenResponse sso_token(token_request)
+
+Exchange a single sign on code for a simple key token
+
+Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+token_request = UltracartClient::SingleSignOnTokenRequest.new # SingleSignOnTokenRequest | Token request
+
+
+begin
+  #Exchange a single sign on code for a simple key token
+  result = api_instance.sso_token(token_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->sso_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **token_request** | [**SingleSignOnTokenRequest**](SingleSignOnTokenRequest.md)| Token request | 
+
+### Return type
+
+[**SingleSignOnTokenResponse**](SingleSignOnTokenResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+

data/docs/StripeConnectResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::StripeConnectResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connect_url** | **String** |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/TransactionGateway.md

@@ -0,0 +1,71 @@
+# UltracartClient::TransactionGateway
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**arbitrary_html** | **String** | Additional html to display for this transaction gateway.  This html will include instructions and connection links | [optional] 
+**comment** | **String** | Additional comments | [optional] 
+**credit_card_capable** | **BOOLEAN** | True if this gateway supports credit cards | [optional] 
+**echeck_capable** | **BOOLEAN** | True if this gateway supports eChecks | [optional] 
+**echeck_supported** | **String** | True if this gateway supports eChecks | [optional] 
+**enabled** | **BOOLEAN** | True if this transaction gateway is the currently active gateway. | [optional] 
+**gateway_cert_pem** | **String** | Cryptographic public certificate allowing UltraCart to communicate securely with this gateway. | [optional] 
+**gateway_cert_pem_label** | **String** | The label for the gateway certificate pem.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_email** | **String** | Gateway Email | [optional] 
+**gateway_email_label** | **String** | The label for the gateway email.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_environment** | **String** | Gateway Environment to indicate sandbox versus production environments | [optional] 
+**gateway_environment_label** | **String** | The label for the gateway environment.  The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_environments** | **Array<String>** | Used to populate drop down lists for the gateway environment.  Varies by gateway. | [optional] 
+**gateway_header_back_color** | **String** | Optional Look and feel setting for Verified-by-VISA.  Only needed if you are using 3DS | [optional] 
+**gateway_header_border_color** | **String** | Optional Look and feel setting for Verified-by-VISA.  Only needed if you are using 3DS | [optional] 
+**gateway_header_image_url** | **String** | Optional Look and feel setting for Verified-by-VISA.  Only needed if you are using 3DS | [optional] 
+**gateway_key** | **String** | Gateway Key | [optional] 
+**gateway_key_label** | **String** | The label for the gateway key.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_key_pem** | **String** | Cryptographic private key allowing UltraCart to communicate securely with this gateway. | [optional] 
+**gateway_key_pem_label** | **String** | The label for the gateway key pem.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_landing_page** | **String** | Optional Look and feel setting for Verified-by-VISA.  Only needed if you are using 3DS | [optional] 
+**gateway_merchant_id** | **String** | Gateway Merchant ID | [optional] 
+**gateway_merchant_id_label** | **String** | The label for the gateway merchant id.  The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_mode** | **String** | Gateway Mode | [optional] 
+**gateway_mode_label** | **String** | The label for the gateway mode.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_modes** | **Array<String>** | Used to populate drop down lists for gateway modes | [optional] 
+**gateway_page_style** | **String** | Gateway Page Style | [optional] 
+**gateway_page_style_label** | **String** | Gateway page style label | [optional] 
+**gateway_page_styles** | **Array<String>** | Used to populate drop down lists for gateway page style | [optional] 
+**gateway_partner** | **String** | Gateway Partner | [optional] 
+**gateway_partner_label** | **String** | The label for the gateway partner.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_password** | **String** | Gateway Password | [optional] 
+**gateway_password_label** | **String** | The label for the gateway password.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_payflow_color** | **String** | Optional Look and feel setting for Verified-by-VISA.  Only needed if you are using 3DS | [optional] 
+**gateway_private_key_password** | **String** | Gateway private key password | [optional] 
+**gateway_private_key_password_label** | **String** | The label for the gateway private key password.  The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_solution_type** | **String** | Optional Look and feel setting for Verified-by-VISA.  Only needed if you are using 3DS | [optional] 
+**gateway_solution_type_label** | **String** | The label for the gateway solution type.  The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_solution_types** | **Array<String>** | Used to populate drop down lists for gateway solution types | [optional] 
+**gateway_url** | **String** | Gateway URL | [optional] 
+**gateway_url_label** | **String** | The label for the gateway url.   The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**gateway_username** | **String** | Gateway Username | [optional] 
+**gateway_username_label** | **String** | The label for the gateway username.  The actual value stored may vary by gateway, so the label will vary too. | [optional] 
+**merchant_account_profile_amex** | **String** | If a merchant has multiple card processing accounts, this is the one to use for American Express cards. | [optional] 
+**merchant_account_profile_diners_club** | **String** | If a merchant has multiple card processing accounts, this is the one to use for Diners Club cards. | [optional] 
+**merchant_account_profile_discover** | **String** | If a merchant has multiple card processing accounts, this is the one to use for Discover cards. | [optional] 
+**merchant_account_profile_jcb** | **String** | If a merchant has multiple card processing accounts, this is the one to use for JCB cards. | [optional] 
+**merchant_account_profile_mastercard** | **String** | If a merchant has multiple card processing accounts, this is the one to use for MasterCard cards. | [optional] 
+**merchant_account_profile_visa** | **String** | If a merchant has multiple card processing accounts, this is the one to use for VISA cards. | [optional] 
+**merchant_id** | **String** | UltraCart Merchant ID | [optional] 
+**multi_currency_details** | **BOOLEAN** | True if this gateway provides details for multiple currency transactions | [optional] 
+**name** | **String** | Name of this transaction gateway | [optional] 
+**refund_supported** | **BOOLEAN** | True if this gateway supports refunds | [optional] 
+**require_echeck_tax_id_or_drivers_license** | **BOOLEAN** | If true, e-Check transaction will require either a Tax ID or a Driver License | [optional] 
+**support_vbv_3ds** | **BOOLEAN** | True if this gateway supported Verified-by-VISA 3D Secure | [optional] 
+**supports_amex** | **BOOLEAN** | If true, this gateway will attempt to process American Express transactions.  If false, the customer will not be allowed to use this type of Credit Card. | [optional] 
+**supports_diners_club** | **BOOLEAN** | If true, this gateway will attempt to process Diners Club transactions.  If false, the customer will not be allowed to use this type of Credit Card. | [optional] 
+**supports_discover** | **BOOLEAN** | If true, this gateway will attempt to process Discover transactions.  If false, the customer will not be allowed to use this type of Credit Card. | [optional] 
+**supports_echeck** | **BOOLEAN** | If true, this gateway will attempt to process e-Check transactions.  If false, the customer will not be allowed to use e-Checks. | [optional] 
+**supports_electronic_gift_card** | **BOOLEAN** | if true, this gateway will attempt to process electronic gift cards. | [optional] 
+**supports_jcb** | **BOOLEAN** | If true, this gateway will attempt to process JCB transactions.  If false, the customer will not be allowed to use this type of Credit Card. | [optional] 
+**supports_mastercard** | **BOOLEAN** | If true, this gateway will attempt to process MasterCard transactions.  If false, the customer will not be allowed to use this type of Credit Card. | [optional] 
+**supports_visa** | **BOOLEAN** | If true, this gateway will attempt to process VISA transactions.  If false, the customer will not be allowed to use this type of Credit Card. | [optional] 
+**third_party** | **BOOLEAN** | True if this gateway supports third parties | [optional] 
+
+

data/docs/TransactionGatewaysRequest.md

@@ -0,0 +1,10 @@
+# UltracartClient::TransactionGatewaysRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**default_credit_card_transaction_type** | **String** | The default transaction type for this merchant account | [optional] 
+**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) |  | [optional] 
+**theme_credit_card_transaction_types** | [**Array<PaymentsThemeTransactionType>**](PaymentsThemeTransactionType.md) | A list of the storefronts and themes for this merchant account and what type of transaction should be attempted | [optional] 
+
+

data/docs/TransactionGatewaysResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::TransactionGatewaysResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**gateways** | [**Array<TransactionGateway>**](TransactionGateway.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/lib/ultracart_api.rb

@@ -206,6 +206,7 @@ require 'ultracart_api/models/customer_tag'
 require 'ultracart_api/models/customer_tax_codes'
 require 'ultracart_api/models/customers_response'
 require 'ultracart_api/models/data_tables_server_side_response'
+require 'ultracart_api/models/delay_auto_orders_response'
 require 'ultracart_api/models/distance'
 require 'ultracart_api/models/distribution_center'
 require 'ultracart_api/models/distribution_centers_response'
@@ -484,6 +485,24 @@ require 'ultracart_api/models/order_token_response'
 require 'ultracart_api/models/order_tracking_number_detail'
 require 'ultracart_api/models/order_tracking_number_details'
 require 'ultracart_api/models/orders_response'
+require 'ultracart_api/models/payments_configuration'
+require 'ultracart_api/models/payments_configuration_affirm'
+require 'ultracart_api/models/payments_configuration_amazon'
+require 'ultracart_api/models/payments_configuration_cod'
+require 'ultracart_api/models/payments_configuration_cash'
+require 'ultracart_api/models/payments_configuration_check'
+require 'ultracart_api/models/payments_configuration_credit_card'
+require 'ultracart_api/models/payments_configuration_loan_hero'
+require 'ultracart_api/models/payments_configuration_pay_pal'
+require 'ultracart_api/models/payments_configuration_purchase_order'
+require 'ultracart_api/models/payments_configuration_quote_request'
+require 'ultracart_api/models/payments_configuration_response'
+require 'ultracart_api/models/payments_configuration_restrictions'
+require 'ultracart_api/models/payments_configuration_sezzle'
+require 'ultracart_api/models/payments_configuration_we_pay'
+require 'ultracart_api/models/payments_configuration_wire_transfer'
+require 'ultracart_api/models/payments_theme_transaction_type'
+require 'ultracart_api/models/payments_wepay_enroll'
 require 'ultracart_api/models/permission'
 require 'ultracart_api/models/pricing_tier'
 require 'ultracart_api/models/pricing_tier_notification'
@@ -494,6 +513,11 @@ require 'ultracart_api/models/register_affiliate_click_request'
 require 'ultracart_api/models/register_affiliate_click_response'
 require 'ultracart_api/models/response_metadata'
 require 'ultracart_api/models/result_set'
+require 'ultracart_api/models/rotating_transaction_gateway'
+require 'ultracart_api/models/rtg_currency'
+require 'ultracart_api/models/rtg_day_of_month_restriction'
+require 'ultracart_api/models/rtg_day_of_week_restriction'
+require 'ultracart_api/models/rtg_theme_restriction'
 require 'ultracart_api/models/screen_recording'
 require 'ultracart_api/models/screen_recording_ad_platform'
 require 'ultracart_api/models/screen_recording_filter'
@@ -545,9 +569,14 @@ require 'ultracart_api/models/screen_recording_user_property'
 require 'ultracart_api/models/screenshots_response'
 require 'ultracart_api/models/self_config'
 require 'ultracart_api/models/simple_value'
+require 'ultracart_api/models/single_sign_on_authorize_request'
+require 'ultracart_api/models/single_sign_on_authorize_response'
+require 'ultracart_api/models/single_sign_on_token_request'
+require 'ultracart_api/models/single_sign_on_token_response'
 require 'ultracart_api/models/sovos_config'
 require 'ultracart_api/models/state_province'
 require 'ultracart_api/models/step_waiting'
+require 'ultracart_api/models/stripe_connect_response'
 require 'ultracart_api/models/tax_city'
 require 'ultracart_api/models/tax_country'
 require 'ultracart_api/models/tax_country_code'
@@ -577,6 +606,9 @@ require 'ultracart_api/models/transaction_email'
 require 'ultracart_api/models/transaction_email_list_response'
 require 'ultracart_api/models/transaction_email_option'
 require 'ultracart_api/models/transaction_email_response'
+require 'ultracart_api/models/transaction_gateway'
+require 'ultracart_api/models/transaction_gateways_request'
+require 'ultracart_api/models/transaction_gateways_response'
 require 'ultracart_api/models/ultra_cart_config'
 require 'ultracart_api/models/upload_coupon_codes_request'
 require 'ultracart_api/models/upload_coupon_codes_response'
@@ -606,6 +638,7 @@ require 'ultracart_api/api/affiliate_api'
 require 'ultracart_api/api/auto_order_api'
 require 'ultracart_api/api/chargeback_api'
 require 'ultracart_api/api/checkout_api'
+require 'ultracart_api/api/configuration_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
 require 'ultracart_api/api/fulfillment_api'
@@ -613,6 +646,7 @@ require 'ultracart_api/api/integration_log_api'
 require 'ultracart_api/api/item_api'
 require 'ultracart_api/api/oauth_api'
 require 'ultracart_api/api/order_api'
+require 'ultracart_api/api/sso_api'
 require 'ultracart_api/api/storefront_api'
 require 'ultracart_api/api/tax_api'
 require 'ultracart_api/api/user_api'