ultracart_api 3.4.6 → 3.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abdcb875151f2365cc95ec8ee697e30cdf7e6e7802d18e6ca368ecdd8874d444
-  data.tar.gz: 335ad17c98e9658f69723a3233f60fd892126666d2d401bdb8334931563e2720
+  metadata.gz: edc50e441a8a9c4ddb57f39f2b6f8970343550350ac36aa86f99ece3102c4d5e
+  data.tar.gz: f0c539b1461f08b33e5089149d33f6e83c119f59bf5934568a21a00c7ce3bb1f
 SHA512:
-  metadata.gz: 0cdea5e196a653e18f44ffb53461d385b1ac5bec66da25651c9df5004a89ddca4e1d1fbe9a9c44ef424aefea4a08118a36e67874045b240ec6bb17e068857e90
-  data.tar.gz: b9cbccdcc7b6a89bf99ab504985b89ff7f5ffc524546ab215db0fbb3add2e66b60da9926e9824f3a1f3b9e473151e24a5bfab2a61c682ed0ea13fae5e245a114
+  metadata.gz: 9dea24c39936bd03d12fc4703ddc3532d26237f6e8b5fdae4e201e83332f40f379328dece34320abeb8ddd54c5caca026a03d34b903f34ffeb03541171f4a6bc
+  data.tar.gz: eaed1a0ec6dacd177bea2a2bd2c8e89a78ece766f8f87dc631943c5f96199b2659481b80c7c9c5d9366c389b76af912585bfc56f886034ef2fcad26bf4fdbb74

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.4.6
+- Package version: 3.4.10
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.4.6.gem
+gem install ./ultracart_api-3.4.10.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.4.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.4.10.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.4.6'
+    gem 'ultracart_api', '~> 3.4.10'
 
 ### Install from Git
 
@@ -228,6 +228,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
 *UltracartClient::StorefrontApi* | [**delete_email_flow_folder**](docs/StorefrontApi.md#delete_email_flow_folder) | **DELETE** /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} | Delete email flowFolder
 *UltracartClient::StorefrontApi* | [**delete_email_list_customer**](docs/StorefrontApi.md#delete_email_list_customer) | **DELETE** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid} | Delete email list customer
+*UltracartClient::StorefrontApi* | [**delete_email_list_segment_folder**](docs/StorefrontApi.md#delete_email_list_segment_folder) | **DELETE** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Delete email ListSegmentFolder
 *UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
 *UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
 *UltracartClient::StorefrontApi* | [**delete_experiment**](docs/StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
@@ -274,6 +275,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_list**](docs/StorefrontApi.md#get_email_list) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid} | Get email list
 *UltracartClient::StorefrontApi* | [**get_email_list_customer_editor_url**](docs/StorefrontApi.md#get_email_list_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url | Get email list customer editor url
 *UltracartClient::StorefrontApi* | [**get_email_list_customers**](docs/StorefrontApi.md#get_email_list_customers) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers | Get email list customers
+*UltracartClient::StorefrontApi* | [**get_email_list_segment_folder**](docs/StorefrontApi.md#get_email_list_segment_folder) | **GET** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Get email campaign folder
+*UltracartClient::StorefrontApi* | [**get_email_list_segment_folders**](docs/StorefrontApi.md#get_email_list_segment_folders) | **GET** /storefront/{storefront_oid}/email/list_segment_folders | Get email campaign folders
 *UltracartClient::StorefrontApi* | [**get_email_lists**](docs/StorefrontApi.md#get_email_lists) | **GET** /storefront/{storefront_oid}/email/lists | Get email lists
 *UltracartClient::StorefrontApi* | [**get_email_performance**](docs/StorefrontApi.md#get_email_performance) | **GET** /storefront/{storefront_oid}/email/performance | Get email performance
 *UltracartClient::StorefrontApi* | [**get_email_plan**](docs/StorefrontApi.md#get_email_plan) | **GET** /storefront/{storefront_oid}/email/plan | Get email plan
@@ -321,6 +324,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**insert_email_flow**](docs/StorefrontApi.md#insert_email_flow) | **POST** /storefront/{storefront_oid}/email/flows | Insert email flow
 *UltracartClient::StorefrontApi* | [**insert_email_flow_folder**](docs/StorefrontApi.md#insert_email_flow_folder) | **POST** /storefront/{storefront_oid}/email/flow_folders | Insert email flow folder
 *UltracartClient::StorefrontApi* | [**insert_email_list**](docs/StorefrontApi.md#insert_email_list) | **POST** /storefront/{storefront_oid}/email/lists | Insert email list
+*UltracartClient::StorefrontApi* | [**insert_email_list_segment_folder**](docs/StorefrontApi.md#insert_email_list_segment_folder) | **POST** /storefront/{storefront_oid}/email/list_segment_folders | Insert email campaign folder
 *UltracartClient::StorefrontApi* | [**insert_email_postcard**](docs/StorefrontApi.md#insert_email_postcard) | **POST** /storefront/{storefront_oid}/email/postcards | Insert email postcard
 *UltracartClient::StorefrontApi* | [**insert_email_segment**](docs/StorefrontApi.md#insert_email_segment) | **POST** /storefront/{storefront_oid}/email/segments | Insert email segment
 *UltracartClient::StorefrontApi* | [**insert_screen_recording_segment**](docs/StorefrontApi.md#insert_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments | Insert screen recording segment
@@ -351,6 +355,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**update_email_flow_folder**](docs/StorefrontApi.md#update_email_flow_folder) | **PUT** /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} | Update email flow folder
 *UltracartClient::StorefrontApi* | [**update_email_global_settings**](docs/StorefrontApi.md#update_email_global_settings) | **POST** /storefront/email/global_settings | Update email global settings
 *UltracartClient::StorefrontApi* | [**update_email_list**](docs/StorefrontApi.md#update_email_list) | **PUT** /storefront/{storefront_oid}/email/lists/{email_list_uuid} | Update email list
+*UltracartClient::StorefrontApi* | [**update_email_list_segment_folder**](docs/StorefrontApi.md#update_email_list_segment_folder) | **PUT** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Update email campaign folder
 *UltracartClient::StorefrontApi* | [**update_email_plan**](docs/StorefrontApi.md#update_email_plan) | **POST** /storefront/{storefront_oid}/email/plan | Update email plan
 *UltracartClient::StorefrontApi* | [**update_email_postcard**](docs/StorefrontApi.md#update_email_postcard) | **PUT** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Update email postcard
 *UltracartClient::StorefrontApi* | [**update_email_segment**](docs/StorefrontApi.md#update_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Update email segment
@@ -662,6 +667,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailListCustomer](docs/EmailListCustomer.md)
  - [UltracartClient::EmailListCustomersResponse](docs/EmailListCustomersResponse.md)
  - [UltracartClient::EmailListResponse](docs/EmailListResponse.md)
+ - [UltracartClient::EmailListSegmentFolder](docs/EmailListSegmentFolder.md)
+ - [UltracartClient::EmailListSegmentFolderResponse](docs/EmailListSegmentFolderResponse.md)
+ - [UltracartClient::EmailListSegmentFoldersResponse](docs/EmailListSegmentFoldersResponse.md)
  - [UltracartClient::EmailListSegmentMembership](docs/EmailListSegmentMembership.md)
  - [UltracartClient::EmailListSegmentUsedBy](docs/EmailListSegmentUsedBy.md)
  - [UltracartClient::EmailListSubscribeResponse](docs/EmailListSubscribeResponse.md)
@@ -891,13 +899,18 @@ Class | Method | HTTP request | Description
  - [UltracartClient::PaymentsConfigurationCash](docs/PaymentsConfigurationCash.md)
  - [UltracartClient::PaymentsConfigurationCheck](docs/PaymentsConfigurationCheck.md)
  - [UltracartClient::PaymentsConfigurationCreditCard](docs/PaymentsConfigurationCreditCard.md)
+ - [UltracartClient::PaymentsConfigurationCreditCardType](docs/PaymentsConfigurationCreditCardType.md)
+ - [UltracartClient::PaymentsConfigurationEcheck](docs/PaymentsConfigurationEcheck.md)
  - [UltracartClient::PaymentsConfigurationLoanHero](docs/PaymentsConfigurationLoanHero.md)
+ - [UltracartClient::PaymentsConfigurationMoneyOrder](docs/PaymentsConfigurationMoneyOrder.md)
  - [UltracartClient::PaymentsConfigurationPayPal](docs/PaymentsConfigurationPayPal.md)
  - [UltracartClient::PaymentsConfigurationPurchaseOrder](docs/PaymentsConfigurationPurchaseOrder.md)
  - [UltracartClient::PaymentsConfigurationQuoteRequest](docs/PaymentsConfigurationQuoteRequest.md)
  - [UltracartClient::PaymentsConfigurationResponse](docs/PaymentsConfigurationResponse.md)
  - [UltracartClient::PaymentsConfigurationRestrictions](docs/PaymentsConfigurationRestrictions.md)
+ - [UltracartClient::PaymentsConfigurationRestrictionsTheme](docs/PaymentsConfigurationRestrictionsTheme.md)
  - [UltracartClient::PaymentsConfigurationSezzle](docs/PaymentsConfigurationSezzle.md)
+ - [UltracartClient::PaymentsConfigurationTestMethod](docs/PaymentsConfigurationTestMethod.md)
  - [UltracartClient::PaymentsConfigurationWePay](docs/PaymentsConfigurationWePay.md)
  - [UltracartClient::PaymentsConfigurationWireTransfer](docs/PaymentsConfigurationWireTransfer.md)
  - [UltracartClient::PaymentsThemeTransactionType](docs/PaymentsThemeTransactionType.md)
@@ -1099,6 +1112,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names | 
+| 3.4.8 | 08/04/2021 | configuration api - payments config refactoring | 
+| 3.4.7 | 08/04/2021 | esp folders for lists/segments | 
 | 3.4.5 | 08/03/2021 | configuration api bug fix for a bad response object on updateRotatingTransactionGateway | 
 | 3.4.3 | 08/03/2021 | package tracking - add event_iso_date and event_timezone_id | 
 | 3.4.2 | 07/29/2021 | bug fixes for new configuration api | 

data/docs/EmailList.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **created_dts** | **String** | Created date | [optional] 
 **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional] 
 **email_list_uuid** | **String** | Email list UUID | [optional] 
+**esp_list_segment_folder_uuid** | **String** | List/Segment folder UUID | [optional] 
 **member_count** | **Integer** | Count of members in this list | [optional] 
 **merchant_id** | **String** | Merchant ID | [optional] 
 **name** | **String** | Name of email list | [optional] 

data/docs/EmailListSegmentFolder.md

@@ -0,0 +1,12 @@
+# UltracartClient::EmailListSegmentFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**esp_list_segment_folder_uuid** | **String** | Email list segment folder UUID | [optional] 
+**merchant_id** | **String** | Merchant ID | [optional] 
+**name** | **String** | Name of email campaign folder | [optional] 
+**storefront_oid** | **Integer** | Storefront oid | [optional] 
+**system_generated** | **BOOLEAN** | System generated folder | [optional] 
+
+

data/docs/EmailListSegmentFolderResponse.md

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

data/docs/EmailListSegmentFoldersResponse.md

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

data/docs/EmailSegment.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **created_dts** | **String** | Created date | [optional] 
 **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional] 
 **email_segment_uuid** | **String** | Email segment UUID | [optional] 
+**esp_list_segment_folder_uuid** | **String** | List/Segment folder UUID | [optional] 
 **facebook_custom_audience** | **BOOLEAN** | True if you want to sync to a facebook custom audience | [optional] 
 **filter_profile_equation_json** | **String** | File profile equation json | [optional] 
 **member_count** | **Integer** | Count of members in this segment | [optional] 

data/docs/PaymentsConfiguration.md

@@ -9,15 +9,17 @@ Name | Type | Description | Notes
 **check** | [**PaymentsConfigurationCheck**](PaymentsConfigurationCheck.md) |  | [optional] 
 **cod** | [**PaymentsConfigurationCOD**](PaymentsConfigurationCOD.md) |  | [optional] 
 **credit_card** | [**PaymentsConfigurationCreditCard**](PaymentsConfigurationCreditCard.md) |  | [optional] 
+**echeck** | [**PaymentsConfigurationEcheck**](PaymentsConfigurationEcheck.md) |  | [optional] 
 **loan_hero** | [**PaymentsConfigurationLoanHero**](PaymentsConfigurationLoanHero.md) |  | [optional] 
-**pay_pal** | [**PaymentsConfigurationPayPal**](PaymentsConfigurationPayPal.md) |  | [optional] 
+**money_order** | [**PaymentsConfigurationMoneyOrder**](PaymentsConfigurationMoneyOrder.md) |  | [optional] 
+**paypal** | [**PaymentsConfigurationPayPal**](PaymentsConfigurationPayPal.md) |  | [optional] 
 **purchase_order** | [**PaymentsConfigurationPurchaseOrder**](PaymentsConfigurationPurchaseOrder.md) |  | [optional] 
 **quote_request** | [**PaymentsConfigurationQuoteRequest**](PaymentsConfigurationQuoteRequest.md) |  | [optional] 
 **sezzle** | [**PaymentsConfigurationSezzle**](PaymentsConfigurationSezzle.md) |  | [optional] 
-**show_accounting_code** | **BOOLEAN** |  | [optional] 
+**show_accounting_code** | **BOOLEAN** | Internal flag used to determine if accounting codes should be shown on the screen or not.  This flag is true if the merchant has a Quickbooks integration configured. | [optional] 
 **switch_to_sub_tab** | **String** |  | [optional] 
 **switch_to_tab** | **String** |  | [optional] 
-**we_pay** | [**PaymentsConfigurationWePay**](PaymentsConfigurationWePay.md) |  | [optional] 
+**ultracart_payments_wepay** | [**PaymentsConfigurationWePay**](PaymentsConfigurationWePay.md) |  | [optional] 
 **wire_transfer** | [**PaymentsConfigurationWireTransfer**](PaymentsConfigurationWireTransfer.md) |  | [optional] 
 
 

data/docs/PaymentsConfigurationAffirm.md

@@ -3,13 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_affirm** | **BOOLEAN** |  | [optional] 
-**affirm_accounting_code** | **String** |  | [optional] 
-**affirm_deposit_to_account** | **String** |  | [optional] 
-**affirm_environment** | **String** |  | [optional] 
-**affirm_financial_product_key** | **String** |  | [optional] 
-**affirm_private_api_key** | **String** |  | [optional] 
-**affirm_public_api_key** | **String** |  | [optional] 
+**accept_affirm** | **BOOLEAN** | Master flag indicating this merchant accepts Affirm payments | [optional] 
+**accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional] 
+**environment** | **String** | Environment | [optional] 
+**financial_product_key** | **String** | Financial product key | [optional] 
+**private_api_key** | **String** | Private API key | [optional] 
+**public_api_key** | **String** | Public API key | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
 
 

data/docs/PaymentsConfigurationAmazon.md

@@ -3,13 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_amazon** | **BOOLEAN** |  | [optional] 
-**amazon_access_key_id** | **String** |  | [optional] 
-**amazon_accounting_code** | **String** |  | [optional] 
-**amazon_deposit_to_account** | **String** |  | [optional] 
-**amazon_merchant_id** | **String** |  | [optional] 
-**amazon_sandbox** | **BOOLEAN** |  | [optional] 
-**amazon_secret_access_key** | **String** |  | [optional] 
+**accept_amazon** | **BOOLEAN** | Master flag to determine if this merchant accepts Pay by Amazon | [optional] 
+**access_key_id** | **String** | Amazon access key ID | [optional] 
+**accounting_code** | **String** | Optional accounting code for use with Quickbooks integrations | [optional] 
+**amazon_merchant_id** | **String** | Amazon merchant ID | [optional] 
+**deposit_to_account** | **String** | Optional deposit to account field for use with Quickbooks integrations | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
+**sandbox** | **BOOLEAN** | True if transactions should run against the Amazon sandbox.  Useful for testing not configurations | [optional] 
+**secret_access_key** | **String** | Amazon secret access key | [optional] 
 
 

data/docs/PaymentsConfigurationCOD.md

@@ -3,11 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_cod** | **BOOLEAN** |  | [optional] 
-**cod_approved_customers_only** | **BOOLEAN** |  | [optional] 
-**cod_surcharge_accounting_code** | **String** |  | [optional] 
-**cod_surcharge_fee** | **String** |  | [optional] 
-**cod_surcharge_perc** | **String** |  | [optional] 
+**accept_cod** | **BOOLEAN** | Master flag indicating this merchant accepts COD | [optional] 
+**approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with COD | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
+**surcharge_accounting_code** | **String** | Optional field, if surcharge is set, this is the accounting code the surcharge is tagged with when sent to Quickbooks | [optional] 
+**surcharge_fee** | **String** | Additional cost for using COD | [optional] 
+**surcharge_percentage** | **String** | Additional percentage cost for using COD | [optional] 
 
 

data/docs/PaymentsConfigurationCash.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_cash** | **BOOLEAN** |  | [optional] 
+**accept_cash** | **BOOLEAN** | Master flag indicating this merchant accepts cash | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
 
 

data/docs/PaymentsConfigurationCheck.md

@@ -3,23 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_check_orders** | **BOOLEAN** |  | [optional] 
-**accept_e_check** | **BOOLEAN** |  | [optional] 
-**accept_money_orders** | **BOOLEAN** |  | [optional] 
-**check_accounting_code** | **String** |  | [optional] 
-**check_deposit_to_account** | **String** |  | [optional] 
-**checks_payable_to** | **String** |  | [optional] 
-**e_check_accounting_code** | **String** |  | [optional] 
-**e_check_deposit_to_account** | **String** |  | [optional] 
-**mail_to_address1** | **String** |  | [optional] 
-**mail_to_address2** | **String** |  | [optional] 
-**mail_to_city** | **String** |  | [optional] 
-**mail_to_country** | **String** |  | [optional] 
-**mail_to_name** | **String** |  | [optional] 
-**mail_to_state** | **String** |  | [optional] 
-**mail_to_zip** | **String** |  | [optional] 
-**money_order_accounting_code** | **String** |  | [optional] 
-**money_order_deposit_to_account** | **String** |  | [optional] 
+**accept_check_orders** | **BOOLEAN** | Master flag indicating this merchant accepts paper checks | [optional] 
+**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
+**checks_payable_to** | **String** | This is who the customer makes the check out to | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
+**mail_to_address1** | **String** | MailTo address line 1 | [optional] 
+**mail_to_address2** | **String** | MailTo address line 2 | [optional] 
+**mail_to_city** | **String** | MailTo city | [optional] 
+**mail_to_country** | **String** | MailTo country | [optional] 
+**mail_to_name** | **String** | MailTo name | [optional] 
+**mail_to_postal_code** | **String** | MailTo postal code | [optional] 
+**mail_to_store** | **String** | MailTo store | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
+**test_methods** | [**Array<PaymentsConfigurationTestMethod>**](PaymentsConfigurationTestMethod.md) | Test methods for this payment method | [optional] 
 
 

data/docs/PaymentsConfigurationCreditCard.md

@@ -3,14 +3,16 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_credit_cards** | **BOOLEAN** |  | [optional] 
-**billed_by** | **String** |  | [optional] 
-**charge_during_checkout** | **BOOLEAN** |  | [optional] 
-**collect_cvv2** | **BOOLEAN** |  | [optional] 
-**configured_gateways_details** | **String** |  | [optional] 
-**failed_attempts** | **String** |  | [optional] 
-**hide_connect_single_gateway** | **BOOLEAN** |  | [optional] 
-**immediate_finalize_domains** | **String** |  | [optional] 
-**send_customer_billing_update_on_decline** | **BOOLEAN** |  | [optional] 
+**accept_credit_card** | **BOOLEAN** | Master flag indicating whether this merchant accepts credit card payments | [optional] 
+**billed_by** | **String** | Description that appears on customer statements | [optional] 
+**charge_during_checkout** | **BOOLEAN** | If false, order will be accepted and placed into Accounts Receivable without charging card first | [optional] 
+**collect_cvv2** | **BOOLEAN** | UltraCart will require customer to enter cvv if this is true | [optional] 
+**configured_gateway_details** | **String** | Human readable description of the credit card gateway currently configured | [optional] 
+**failed_attempts** | **String** | The number of failed attempts before the order is placed into Accounts Receivable for manual intervention | [optional] 
+**hide_connect_single_gateway** | **BOOLEAN** | This internal flag aids the UI in determining which buttons to show. | [optional] 
+**restrictions** | [**Array<PaymentsConfigurationRestrictions>**](PaymentsConfigurationRestrictions.md) | Restrictions for this payment method | [optional] 
+**send_customer_billing_update_on_decline** | **BOOLEAN** | UltraCart will send customers emails to update their credit card if the card is declined | [optional] 
+**supported_cards** | [**Array<PaymentsConfigurationCreditCardType>**](PaymentsConfigurationCreditCardType.md) | A list of credit cards the merchant wishes to accept. | [optional] 
+**test_methods** | [**Array<PaymentsConfigurationTestMethod>**](PaymentsConfigurationTestMethod.md) | An array of test methods for placing test orders.  The cards defined here may be real or fake, but any order placed with them will be marked as Test orders | [optional] 
 
 

data/docs/PaymentsConfigurationCreditCardType.md

@@ -0,0 +1,17 @@
+# UltracartClient::PaymentsConfigurationCreditCardType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accounting_code** | **String** | Optional field used for Quickbooks integrations to match this credit card with the corresponding payment type in Quickbooks | [optional] 
+**card_type_icon** | **String** | Internally used icon information for this card type | [optional] 
+**credit_card** | **String** | Credit card type | [optional] 
+**deposit_to_account** | **String** | The name of the account to deposit funds | [optional] 
+**enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional] 
+**processing_fee** | **String** | Optional additional fee applied to order for this card | [optional] 
+**processing_percentage** | **String** | Optional additional fee applied to order for this card | [optional] 
+**surcharge_accounting_code** | **String** | Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders | [optional] 
+**transaction_fee** | **String** | An optional additional fee to charge the customer for using this card. | [optional] 
+**transaction_percentage** | **String** | An optional transaction percentage to charge the customer for using this card | [optional] 
+
+

data/docs/PaymentsConfigurationEcheck.md

@@ -0,0 +1,11 @@
+# UltracartClient::PaymentsConfigurationEcheck
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accept_echeck** | **BOOLEAN** | Master flag indicating this merchant accepts eChecks | [optional] 
+**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
+**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
+
+

data/docs/PaymentsConfigurationLoanHero.md

@@ -3,10 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_loan_hero** | **BOOLEAN** |  | [optional] 
-**loan_hero_accounting_code** | **String** |  | [optional] 
-**loan_hero_deposit_to_account** | **String** |  | [optional] 
+**accept_loan_hero** | **BOOLEAN** | Master flag indicating this merchant accepts Loan Hero | [optional] 
+**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**show_loan_hero** | **BOOLEAN** |  | [optional] 
+**show_loan_hero** | **BOOLEAN** | Internal field to aid UI | [optional] 
 
 

data/docs/PaymentsConfigurationMoneyOrder.md

@@ -0,0 +1,11 @@
+# UltracartClient::PaymentsConfigurationMoneyOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accept_money_orders** | **BOOLEAN** | Master flag for this merchant accepting money orders | [optional] 
+**accounting_code** | **String** | Optional Quickbooks accounting code | [optional] 
+**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional] 
+**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
+
+

data/docs/PaymentsConfigurationPayPal.md

@@ -3,34 +3,34 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accept_pay_pal** | **BOOLEAN** |  | [optional] 
-**paypal_accounting_code** | **String** |  | [optional] 
-**paypal_api_password** | **String** |  | [optional] 
-**paypal_api_user_name** | **String** |  | [optional] 
-**paypal_certificate_on_file** | **BOOLEAN** |  | [optional] 
-**paypal_deposit_to_account** | **String** |  | [optional] 
-**paypal_email** | **String** |  | [optional] 
-**paypal_environment** | **String** |  | [optional] 
-**paypal_header_image_url** | **String** |  | [optional] 
-**paypal_hide_bill_me_later** | **BOOLEAN** |  | [optional] 
-**paypal_hide_express_checkout_on_view_cart** | **BOOLEAN** |  | [optional] 
-**paypal_hide_for_unshipped_orders** | **BOOLEAN** |  | [optional] 
-**paypal_hold_in_ar** | **BOOLEAN** |  | [optional] 
-**paypal_landing_page** | **String** |  | [optional] 
-**paypal_mode** | **String** |  | [optional] 
-**paypal_private_key_password** | **String** |  | [optional] 
-**paypal_processing_fee** | **String** |  | [optional] 
-**paypal_processing_perc** | **String** |  | [optional] 
-**paypal_send_recurring** | **String** |  | [optional] 
-**paypal_show_card_logos_not_directly_supported** | **BOOLEAN** |  | [optional] 
-**paypal_show_signature** | **BOOLEAN** |  | [optional] 
-**paypal_signature** | **String** |  | [optional] 
-**paypal_solution_type** | **String** |  | [optional] 
-**paypal_summary_email** | **String** |  | [optional] 
-**paypal_summary_mode** | **String** |  | [optional] 
-**paypal_zero_dollar_penny** | **BOOLEAN** |  | [optional] 
-**push_pay_pal** | **BOOLEAN** |  | [optional] 
+**accept_paypal** | **BOOLEAN** | Master flag that determine if PayPal is an active payment for this account | [optional] 
+**accounting_code** | **String** | Optional accounting code that is set to Quickbooks when an order uses this payment method. | [optional] 
+**api_password** | **String** | PayPal API password | [optional] 
+**api_username** | **String** | PayPal API username | [optional] 
+**certificate_on_file** | **BOOLEAN** | (Legacy) true if there is a PayPal certificate already on file. Used to manage the internal UI | [optional] 
+**deposit_to_account** | **String** | The account to deposit funds | [optional] 
+**email** | **String** | The main PayPal email address | [optional] 
+**environment** | **String** | PayPal configuration, live or sandbox | [optional] 
+**header_image_url** | **String** | The URL for the PayPal header | [optional] 
+**hide_bill_me_later** | **BOOLEAN** | True if the Bill Me Later button should be hidden during checkout | [optional] 
+**hide_express_checkout_on_view_cart** | **BOOLEAN** | True if the PayPal express checkout button should be hidden on the view cart page.  This will force the customer to enter address information before being able to checkout with PayPal | [optional] 
+**hide_for_unshipped_orders** | **BOOLEAN** | True if PayPal should be hidden for orders with no shippable product, such as digital orders | [optional] 
+**hold_in_ar** | **BOOLEAN** | If true, PayPal orders are held in Accounts Receivable for review | [optional] 
+**landing_page** | **String** | PayPal landing page | [optional] 
+**mode** | **String** | The PayPal mode | [optional] 
+**private_key_password** | **String** | PayPal API private key password | [optional] 
+**processing_fee** | **String** | Optional additional fee to charge if PayPal is used.  It is rare for this to be used. | [optional] 
+**processing_percentage** | **String** | The processing percentage charged by PayPal | [optional] 
+**push_paypal** | **BOOLEAN** | True if the internal UI should recommend opening a PayPal account | [optional] 
 **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) |  | [optional] 
-**short_pay_pal_marketing_text** | **BOOLEAN** |  | [optional] 
+**send_recurring** | **BOOLEAN** | True if UltraCart should send recurring orders to PayPal.  There are restrictions to what PayPal will accept for recurring orders.  Be careful. | [optional] 
+**short_paypal_marketing_text** | **BOOLEAN** | Short marketing text | [optional] 
+**show_card_logos_not_directly_supported** | **BOOLEAN** | internal ui flag | [optional] 
+**show_signature** | **BOOLEAN** | Internal flag used to manage UI | [optional] 
+**signature** | **String** | PayPal signature | [optional] 
+**solution_type** | **String** | PayPal solution type | [optional] 
+**summary_email** | **String** | The email where PayPal summaries should be sent | [optional] 
+**summary_mode** | **String** | Description of what mode PayPal is operating | [optional] 
+**zero_dollar_penny** | **BOOLEAN** | Send free items to PayPal as one cent items and subtract this penny from shipping.  PayPal does not allow the sale of free items. | [optional]