ultracart_api 3.4.7 → 3.4.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -4
  3. data/docs/PaymentsConfiguration.md +5 -3
  4. data/docs/PaymentsConfigurationAffirm.md +7 -7
  5. data/docs/PaymentsConfigurationAmazon.md +7 -7
  6. data/docs/PaymentsConfigurationCOD.md +5 -5
  7. data/docs/PaymentsConfigurationCash.md +1 -1
  8. data/docs/PaymentsConfigurationCheck.md +12 -17
  9. data/docs/PaymentsConfigurationCreditCard.md +11 -8
  10. data/docs/PaymentsConfigurationCreditCardType.md +17 -0
  11. data/docs/PaymentsConfigurationEcheck.md +11 -0
  12. data/docs/PaymentsConfigurationLoanHero.md +4 -4
  13. data/docs/PaymentsConfigurationMoneyOrder.md +11 -0
  14. data/docs/PaymentsConfigurationPayPal.md +28 -28
  15. data/docs/PaymentsConfigurationPurchaseOrder.md +3 -3
  16. data/docs/PaymentsConfigurationQuoteRequest.md +2 -2
  17. data/docs/PaymentsConfigurationRestrictions.md +14 -12
  18. data/docs/PaymentsConfigurationRestrictionsTheme.md +10 -0
  19. data/docs/PaymentsConfigurationSezzle.md +8 -7
  20. data/docs/PaymentsConfigurationTestMethod.md +18 -0
  21. data/docs/PaymentsConfigurationWePay.md +26 -26
  22. data/docs/PaymentsConfigurationWireTransfer.md +10 -10
  23. data/lib/ultracart_api.rb +5 -0
  24. data/lib/ultracart_api/models/payments_configuration.rb +50 -31
  25. data/lib/ultracart_api/models/payments_configuration_affirm.rb +81 -40
  26. data/lib/ultracart_api/models/payments_configuration_amazon.rb +51 -44
  27. data/lib/ultracart_api/models/payments_configuration_cash.rb +4 -3
  28. data/lib/ultracart_api/models/payments_configuration_check.rb +72 -103
  29. data/lib/ultracart_api/models/payments_configuration_cod.rb +39 -34
  30. data/lib/ultracart_api/models/payments_configuration_credit_card.rb +78 -34
  31. data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb +309 -0
  32. data/lib/ultracart_api/models/payments_configuration_echeck.rb +214 -0
  33. data/lib/ultracart_api/models/payments_configuration_loan_hero.rb +23 -19
  34. data/lib/ultracart_api/models/payments_configuration_money_order.rb +214 -0
  35. data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +270 -172
  36. data/lib/ultracart_api/models/payments_configuration_purchase_order.rb +19 -16
  37. data/lib/ultracart_api/models/payments_configuration_quote_request.rb +12 -10
  38. data/lib/ultracart_api/models/payments_configuration_restrictions.rb +75 -41
  39. data/lib/ultracart_api/models/payments_configuration_restrictions_theme.rb +202 -0
  40. data/lib/ultracart_api/models/payments_configuration_sezzle.rb +99 -46
  41. data/lib/ultracart_api/models/payments_configuration_test_method.rb +319 -0
  42. data/lib/ultracart_api/models/payments_configuration_we_pay.rb +186 -160
  43. data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +71 -61
  44. data/lib/ultracart_api/version.rb +1 -1
  45. metadata +12 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6d32ebd5e5e349c6349a42f8ca2d21db241e7a6a10caeeea5d0ea2b475b93802
4
- data.tar.gz: d104fa317a4fd655526dfefac7a7ea16ee1ab1a0809bdcf3e0b0029d569d6c45
3
+ metadata.gz: 4245e873129516de30be38429ec9b9be35c51980741b172ae00e772d36ff69f3
4
+ data.tar.gz: e58e9e32bca389b1cadafff9e4089df77aaba05766aa65e9e185156f96fcfe1e
5
5
  SHA512:
6
- metadata.gz: a3bc3f7707db8b4f13f2e6716ee70b12ffa6e4105f2e94ebd0d5e414b631e0ff1865d255d8f121d0a0dc5a33abad88ec9b0d6c329e95398b4a42049dcc5ee3b2
7
- data.tar.gz: b49103cb03613a3f0a33ded21fcbc185a6021a6ea00d4ca81c90471578206b4e2bd845007b8a12164e99c5694fcdb6a8a7242358c4acf0ae216980f250af705b
6
+ metadata.gz: baa5e4e73a5922c38c3ade92ff47d0ea9268a5bbb6ca2a6b108248fc9c71011552184f3de33b17a6f8314c6930224b01897ae185d9a4317f52e538f954251be5
7
+ data.tar.gz: '0483a291cf2029c4011f1f7ecf69f2a89bf83c9c1ad06cfa20ee645b03198416a8222575eef61efbb757c6a959991f612f805cbd02a6fd45184a286fc3043298'
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.4.7
10
+ - Package version: 3.4.11
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.4.7.gem
27
+ gem install ./ultracart_api-3.4.11.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.4.7.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.4.11.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.4.7'
35
+ gem 'ultracart_api', '~> 3.4.11'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -899,13 +899,18 @@ Class | Method | HTTP request | Description
899
899
  - [UltracartClient::PaymentsConfigurationCash](docs/PaymentsConfigurationCash.md)
900
900
  - [UltracartClient::PaymentsConfigurationCheck](docs/PaymentsConfigurationCheck.md)
901
901
  - [UltracartClient::PaymentsConfigurationCreditCard](docs/PaymentsConfigurationCreditCard.md)
902
+ - [UltracartClient::PaymentsConfigurationCreditCardType](docs/PaymentsConfigurationCreditCardType.md)
903
+ - [UltracartClient::PaymentsConfigurationEcheck](docs/PaymentsConfigurationEcheck.md)
902
904
  - [UltracartClient::PaymentsConfigurationLoanHero](docs/PaymentsConfigurationLoanHero.md)
905
+ - [UltracartClient::PaymentsConfigurationMoneyOrder](docs/PaymentsConfigurationMoneyOrder.md)
903
906
  - [UltracartClient::PaymentsConfigurationPayPal](docs/PaymentsConfigurationPayPal.md)
904
907
  - [UltracartClient::PaymentsConfigurationPurchaseOrder](docs/PaymentsConfigurationPurchaseOrder.md)
905
908
  - [UltracartClient::PaymentsConfigurationQuoteRequest](docs/PaymentsConfigurationQuoteRequest.md)
906
909
  - [UltracartClient::PaymentsConfigurationResponse](docs/PaymentsConfigurationResponse.md)
907
910
  - [UltracartClient::PaymentsConfigurationRestrictions](docs/PaymentsConfigurationRestrictions.md)
911
+ - [UltracartClient::PaymentsConfigurationRestrictionsTheme](docs/PaymentsConfigurationRestrictionsTheme.md)
908
912
  - [UltracartClient::PaymentsConfigurationSezzle](docs/PaymentsConfigurationSezzle.md)
913
+ - [UltracartClient::PaymentsConfigurationTestMethod](docs/PaymentsConfigurationTestMethod.md)
909
914
  - [UltracartClient::PaymentsConfigurationWePay](docs/PaymentsConfigurationWePay.md)
910
915
  - [UltracartClient::PaymentsConfigurationWireTransfer](docs/PaymentsConfigurationWireTransfer.md)
911
916
  - [UltracartClient::PaymentsThemeTransactionType](docs/PaymentsThemeTransactionType.md)
@@ -1107,6 +1112,8 @@ Not every change is committed to every SDK.
1107
1112
 
1108
1113
  | Version | Date | Comments |
1109
1114
  | --: | :-: | --- |
1115
+ | 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names |
1116
+ | 3.4.8 | 08/04/2021 | configuration api - payments config refactoring |
1110
1117
  | 3.4.7 | 08/04/2021 | esp folders for lists/segments |
1111
1118
  | 3.4.5 | 08/03/2021 | configuration api bug fix for a bad response object on updateRotatingTransactionGateway |
1112
1119
  | 3.4.3 | 08/03/2021 | package tracking - add event_iso_date and event_timezone_id |
data/docs/PaymentsConfiguration.md CHANGED
@@ -9,15 +9,17 @@ Name | Type | Description | Notes
9
9
  **check** | [**PaymentsConfigurationCheck**](PaymentsConfigurationCheck.md) | | [optional]
10
10
  **cod** | [**PaymentsConfigurationCOD**](PaymentsConfigurationCOD.md) | | [optional]
11
11
  **credit_card** | [**PaymentsConfigurationCreditCard**](PaymentsConfigurationCreditCard.md) | | [optional]
12
+ **echeck** | [**PaymentsConfigurationEcheck**](PaymentsConfigurationEcheck.md) | | [optional]
12
13
  **loan_hero** | [**PaymentsConfigurationLoanHero**](PaymentsConfigurationLoanHero.md) | | [optional]
13
- **pay_pal** | [**PaymentsConfigurationPayPal**](PaymentsConfigurationPayPal.md) | | [optional]
14
+ **money_order** | [**PaymentsConfigurationMoneyOrder**](PaymentsConfigurationMoneyOrder.md) | | [optional]
15
+ **paypal** | [**PaymentsConfigurationPayPal**](PaymentsConfigurationPayPal.md) | | [optional]
14
16
  **purchase_order** | [**PaymentsConfigurationPurchaseOrder**](PaymentsConfigurationPurchaseOrder.md) | | [optional]
15
17
  **quote_request** | [**PaymentsConfigurationQuoteRequest**](PaymentsConfigurationQuoteRequest.md) | | [optional]
16
18
  **sezzle** | [**PaymentsConfigurationSezzle**](PaymentsConfigurationSezzle.md) | | [optional]
17
- **show_accounting_code** | **BOOLEAN** | | [optional]
19
+ **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]
18
20
  **switch_to_sub_tab** | **String** | | [optional]
19
21
  **switch_to_tab** | **String** | | [optional]
20
- **we_pay** | [**PaymentsConfigurationWePay**](PaymentsConfigurationWePay.md) | | [optional]
22
+ **ultracart_payments_wepay** | [**PaymentsConfigurationWePay**](PaymentsConfigurationWePay.md) | | [optional]
21
23
  **wire_transfer** | [**PaymentsConfigurationWireTransfer**](PaymentsConfigurationWireTransfer.md) | | [optional]
22
24
 
23
25
 
data/docs/PaymentsConfigurationAffirm.md CHANGED
@@ -3,13 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_affirm** | **BOOLEAN** | | [optional]
7
- **affirm_accounting_code** | **String** | | [optional]
8
- **affirm_deposit_to_account** | **String** | | [optional]
9
- **affirm_environment** | **String** | | [optional]
10
- **affirm_financial_product_key** | **String** | | [optional]
11
- **affirm_private_api_key** | **String** | | [optional]
12
- **affirm_public_api_key** | **String** | | [optional]
6
+ **accept_affirm** | **BOOLEAN** | Master flag indicating this merchant accepts Affirm payments | [optional]
7
+ **accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional]
8
+ **deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional]
9
+ **environment** | **String** | Environment | [optional]
10
+ **financial_product_key** | **String** | Financial product key | [optional]
11
+ **private_api_key** | **String** | Private API key | [optional]
12
+ **public_api_key** | **String** | Public API key | [optional]
13
13
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
14
14
 
15
15
 
data/docs/PaymentsConfigurationAmazon.md CHANGED
@@ -3,13 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_amazon** | **BOOLEAN** | | [optional]
7
- **amazon_access_key_id** | **String** | | [optional]
8
- **amazon_accounting_code** | **String** | | [optional]
9
- **amazon_deposit_to_account** | **String** | | [optional]
10
- **amazon_merchant_id** | **String** | | [optional]
11
- **amazon_sandbox** | **BOOLEAN** | | [optional]
12
- **amazon_secret_access_key** | **String** | | [optional]
6
+ **accept_amazon** | **BOOLEAN** | Master flag to determine if this merchant accepts Pay by Amazon | [optional]
7
+ **access_key_id** | **String** | Amazon access key ID | [optional]
8
+ **accounting_code** | **String** | Optional accounting code for use with Quickbooks integrations | [optional]
9
+ **amazon_merchant_id** | **String** | Amazon merchant ID | [optional]
10
+ **deposit_to_account** | **String** | Optional deposit to account field for use with Quickbooks integrations | [optional]
13
11
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
12
+ **sandbox** | **BOOLEAN** | True if transactions should run against the Amazon sandbox. Useful for testing not configurations | [optional]
13
+ **secret_access_key** | **String** | Amazon secret access key | [optional]
14
14
 
15
15
 
data/docs/PaymentsConfigurationCOD.md CHANGED
@@ -3,11 +3,11 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_cod** | **BOOLEAN** | | [optional]
7
- **cod_approved_customers_only** | **BOOLEAN** | | [optional]
8
- **cod_surcharge_accounting_code** | **String** | | [optional]
9
- **cod_surcharge_fee** | **String** | | [optional]
10
- **cod_surcharge_perc** | **String** | | [optional]
6
+ **accept_cod** | **BOOLEAN** | Master flag indicating this merchant accepts COD | [optional]
7
+ **approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with COD | [optional]
11
8
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
9
+ **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]
10
+ **surcharge_fee** | **String** | Additional cost for using COD | [optional]
11
+ **surcharge_percentage** | **String** | Additional percentage cost for using COD | [optional]
12
12
 
13
13
 
data/docs/PaymentsConfigurationCash.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_cash** | **BOOLEAN** | | [optional]
6
+ **accept_cash** | **BOOLEAN** | Master flag indicating this merchant accepts cash | [optional]
7
7
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
8
8
 
9
9
 
data/docs/PaymentsConfigurationCheck.md CHANGED
@@ -3,23 +3,18 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_check_orders** | **BOOLEAN** | | [optional]
7
- **accept_e_check** | **BOOLEAN** | | [optional]
8
- **accept_money_orders** | **BOOLEAN** | | [optional]
9
- **check_accounting_code** | **String** | | [optional]
10
- **check_deposit_to_account** | **String** | | [optional]
11
- **checks_payable_to** | **String** | | [optional]
12
- **e_check_accounting_code** | **String** | | [optional]
13
- **e_check_deposit_to_account** | **String** | | [optional]
14
- **mail_to_address1** | **String** | | [optional]
15
- **mail_to_address2** | **String** | | [optional]
16
- **mail_to_city** | **String** | | [optional]
17
- **mail_to_country** | **String** | | [optional]
18
- **mail_to_name** | **String** | | [optional]
19
- **mail_to_state** | **String** | | [optional]
20
- **mail_to_zip** | **String** | | [optional]
21
- **money_order_accounting_code** | **String** | | [optional]
22
- **money_order_deposit_to_account** | **String** | | [optional]
6
+ **accept_check_orders** | **BOOLEAN** | Master flag indicating this merchant accepts paper checks | [optional]
7
+ **accounting_code** | **String** | Optional Quickbooks accounting code | [optional]
8
+ **checks_payable_to** | **String** | This is who the customer makes the check out to | [optional]
9
+ **deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional]
10
+ **mail_to_address1** | **String** | MailTo address line 1 | [optional]
11
+ **mail_to_address2** | **String** | MailTo address line 2 | [optional]
12
+ **mail_to_city** | **String** | MailTo city | [optional]
13
+ **mail_to_country** | **String** | MailTo country | [optional]
14
+ **mail_to_name** | **String** | MailTo name | [optional]
15
+ **mail_to_postal_code** | **String** | MailTo postal code | [optional]
16
+ **mail_to_store** | **String** | MailTo store | [optional]
23
17
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
18
+ **test_methods** | [**Array<PaymentsConfigurationTestMethod>**](PaymentsConfigurationTestMethod.md) | Test methods for this payment method | [optional]
24
19
 
25
20
 
data/docs/PaymentsConfigurationCreditCard.md CHANGED
@@ -3,13 +3,16 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_credit_cards** | **BOOLEAN** | | [optional]
7
- **billed_by** | **String** | | [optional]
8
- **charge_during_checkout** | **BOOLEAN** | | [optional]
9
- **collect_cvv2** | **BOOLEAN** | | [optional]
10
- **configured_gateways_details** | **String** | | [optional]
11
- **failed_attempts** | **String** | | [optional]
12
- **hide_connect_single_gateway** | **BOOLEAN** | | [optional]
13
- **send_customer_billing_update_on_decline** | **BOOLEAN** | | [optional]
6
+ **accept_credit_card** | **BOOLEAN** | Master flag indicating whether this merchant accepts credit card payments | [optional]
7
+ **billed_by** | **String** | Description that appears on customer statements | [optional]
8
+ **charge_during_checkout** | **BOOLEAN** | If false, order will be accepted and placed into Accounts Receivable without charging card first | [optional]
9
+ **collect_cvv2** | **BOOLEAN** | UltraCart will require customer to enter cvv if this is true | [optional]
10
+ **configured_gateway_details** | **String** | Human readable description of the credit card gateway currently configured | [optional]
11
+ **failed_attempts** | **Integer** | The number of failed attempts before the order is placed into Accounts Receivable for manual intervention | [optional]
12
+ **hide_connect_single_gateway** | **BOOLEAN** | This internal flag aids the UI in determining which buttons to show. | [optional]
13
+ **restrictions** | [**Array<PaymentsConfigurationRestrictions>**](PaymentsConfigurationRestrictions.md) | Restrictions for this payment method | [optional]
14
+ **send_customer_billing_update_on_decline** | **BOOLEAN** | UltraCart will send customers emails to update their credit card if the card is declined | [optional]
15
+ **supported_cards** | [**Array<PaymentsConfigurationCreditCardType>**](PaymentsConfigurationCreditCardType.md) | A list of credit cards the merchant wishes to accept. | [optional]
16
+ **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]
14
17
 
15
18
 
data/docs/PaymentsConfigurationCreditCardType.md ADDED
@@ -0,0 +1,17 @@
1
+ # UltracartClient::PaymentsConfigurationCreditCardType
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **accounting_code** | **String** | Optional field used for Quickbooks integrations to match this credit card with the corresponding payment type in Quickbooks | [optional]
7
+ **card_type_icon** | **String** | Internally used icon information for this card type | [optional]
8
+ **credit_card** | **String** | Credit card type | [optional]
9
+ **deposit_to_account** | **String** | The name of the account to deposit funds | [optional]
10
+ **enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional]
11
+ **processing_fee** | **String** | Optional additional fee applied to order for this card | [optional]
12
+ **processing_percentage** | **String** | Optional additional fee applied to order for this card | [optional]
13
+ **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]
14
+ **transaction_fee** | **String** | An optional additional fee to charge the customer for using this card. | [optional]
15
+ **transaction_percentage** | **String** | An optional transaction percentage to charge the customer for using this card | [optional]
16
+
17
+
data/docs/PaymentsConfigurationEcheck.md ADDED
@@ -0,0 +1,11 @@
1
+ # UltracartClient::PaymentsConfigurationEcheck
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **accept_echeck** | **BOOLEAN** | Master flag indicating this merchant accepts eChecks | [optional]
7
+ **accounting_code** | **String** | Optional Quickbooks accounting code | [optional]
8
+ **deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional]
9
+ **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
10
+
11
+
data/docs/PaymentsConfigurationLoanHero.md CHANGED
@@ -3,10 +3,10 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_loan_hero** | **BOOLEAN** | | [optional]
7
- **loan_hero_accounting_code** | **String** | | [optional]
8
- **loan_hero_deposit_to_account** | **String** | | [optional]
6
+ **accept_loan_hero** | **BOOLEAN** | Master flag indicating this merchant accepts Loan Hero | [optional]
7
+ **accounting_code** | **String** | Optional Quickbooks accounting code | [optional]
8
+ **deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional]
9
9
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
10
- **show_loan_hero** | **BOOLEAN** | | [optional]
10
+ **show_loan_hero** | **BOOLEAN** | Internal field to aid UI | [optional]
11
11
 
12
12
 
data/docs/PaymentsConfigurationMoneyOrder.md ADDED
@@ -0,0 +1,11 @@
1
+ # UltracartClient::PaymentsConfigurationMoneyOrder
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **accept_money_orders** | **BOOLEAN** | Master flag for this merchant accepting money orders | [optional]
7
+ **accounting_code** | **String** | Optional Quickbooks accounting code | [optional]
8
+ **deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional]
9
+ **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
10
+
11
+
data/docs/PaymentsConfigurationPayPal.md CHANGED
@@ -3,34 +3,34 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_pay_pal** | **BOOLEAN** | | [optional]
7
- **paypal_accounting_code** | **String** | | [optional]
8
- **paypal_api_password** | **String** | | [optional]
9
- **paypal_api_user_name** | **String** | | [optional]
10
- **paypal_certificate_on_file** | **BOOLEAN** | | [optional]
11
- **paypal_deposit_to_account** | **String** | | [optional]
12
- **paypal_email** | **String** | | [optional]
13
- **paypal_environment** | **String** | | [optional]
14
- **paypal_header_image_url** | **String** | | [optional]
15
- **paypal_hide_bill_me_later** | **BOOLEAN** | | [optional]
16
- **paypal_hide_express_checkout_on_view_cart** | **BOOLEAN** | | [optional]
17
- **paypal_hide_for_unshipped_orders** | **BOOLEAN** | | [optional]
18
- **paypal_hold_in_ar** | **BOOLEAN** | | [optional]
19
- **paypal_landing_page** | **String** | | [optional]
20
- **paypal_mode** | **String** | | [optional]
21
- **paypal_private_key_password** | **String** | | [optional]
22
- **paypal_processing_fee** | **String** | | [optional]
23
- **paypal_processing_perc** | **String** | | [optional]
24
- **paypal_send_recurring** | **String** | | [optional]
25
- **paypal_show_card_logos_not_directly_supported** | **BOOLEAN** | | [optional]
26
- **paypal_show_signature** | **BOOLEAN** | | [optional]
27
- **paypal_signature** | **String** | | [optional]
28
- **paypal_solution_type** | **String** | | [optional]
29
- **paypal_summary_email** | **String** | | [optional]
30
- **paypal_summary_mode** | **String** | | [optional]
31
- **paypal_zero_dollar_penny** | **BOOLEAN** | | [optional]
32
- **push_pay_pal** | **BOOLEAN** | | [optional]
6
+ **accept_paypal** | **BOOLEAN** | Master flag that determine if PayPal is an active payment for this account | [optional]
7
+ **accounting_code** | **String** | Optional accounting code that is set to Quickbooks when an order uses this payment method. | [optional]
8
+ **api_password** | **String** | PayPal API password | [optional]
9
+ **api_username** | **String** | PayPal API username | [optional]
10
+ **certificate_on_file** | **BOOLEAN** | (Legacy) true if there is a PayPal certificate already on file. Used to manage the internal UI | [optional]
11
+ **deposit_to_account** | **String** | The account to deposit funds | [optional]
12
+ **email** | **String** | The main PayPal email address | [optional]
13
+ **environment** | **String** | PayPal configuration, live or sandbox | [optional]
14
+ **header_image_url** | **String** | The URL for the PayPal header | [optional]
15
+ **hide_bill_me_later** | **BOOLEAN** | True if the Bill Me Later button should be hidden during checkout | [optional]
16
+ **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]
17
+ **hide_for_unshipped_orders** | **BOOLEAN** | True if PayPal should be hidden for orders with no shippable product, such as digital orders | [optional]
18
+ **hold_in_ar** | **BOOLEAN** | If true, PayPal orders are held in Accounts Receivable for review | [optional]
19
+ **landing_page** | **String** | PayPal landing page | [optional]
20
+ **mode** | **String** | The PayPal mode | [optional]
21
+ **private_key_password** | **String** | PayPal API private key password | [optional]
22
+ **processing_fee** | **String** | Optional additional fee to charge if PayPal is used. It is rare for this to be used. | [optional]
23
+ **processing_percentage** | **String** | The processing percentage charged by PayPal | [optional]
24
+ **push_paypal** | **BOOLEAN** | True if the internal UI should recommend opening a PayPal account | [optional]
33
25
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
34
- **short_pay_pal_marketing_text** | **BOOLEAN** | | [optional]
26
+ **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]
27
+ **short_paypal_marketing_text** | **BOOLEAN** | Short marketing text | [optional]
28
+ **show_card_logos_not_directly_supported** | **BOOLEAN** | internal ui flag | [optional]
29
+ **show_signature** | **BOOLEAN** | Internal flag used to manage UI | [optional]
30
+ **signature** | **String** | PayPal signature | [optional]
31
+ **solution_type** | **String** | PayPal solution type | [optional]
32
+ **summary_email** | **String** | The email where PayPal summaries should be sent | [optional]
33
+ **summary_mode** | **String** | Description of what mode PayPal is operating | [optional]
34
+ **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]
35
35
 
36
36
 
data/docs/PaymentsConfigurationPurchaseOrder.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_purchase_orders** | **BOOLEAN** | | [optional]
7
- **purchase_order_approved_customers_only** | **BOOLEAN** | | [optional]
8
- **purchase_order_prevent_duplicate_number** | **BOOLEAN** | | [optional]
6
+ **accept_purchase_orders** | **BOOLEAN** | Master flag indicating this merchant accepts purchase orders | [optional]
7
+ **approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with a purchase order | [optional]
8
+ **prevent_duplicate_number** | **BOOLEAN** | If true, customers may not use duplicate PO numbers for any order | [optional]
9
9
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
10
10
 
11
11
 
data/docs/PaymentsConfigurationQuoteRequest.md CHANGED
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_quote_requests** | **BOOLEAN** | | [optional]
7
- **quote_request_approved_customers_only** | **BOOLEAN** | | [optional]
6
+ **accept_quote_requests** | **BOOLEAN** | Master flag indicating this merchant accepts quote requests | [optional]
7
+ **approved_customers_only** | **BOOLEAN** | If true, only approved customers may use quote requests | [optional]
8
8
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
9
9
 
10
10
 
data/docs/PaymentsConfigurationRestrictions.md CHANGED
@@ -3,17 +3,19 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **maximum_subtotal** | **String** | | [optional]
7
- **minimum_subtotal** | **String** | | [optional]
8
- **payment_method** | **String** | | [optional]
9
- **restriction_alaska_hawaii** | **String** | | [optional]
10
- **restriction_apo_fpo** | **String** | | [optional]
11
- **restriction_canada** | **String** | | [optional]
12
- **restriction_continental_us** | **String** | | [optional]
13
- **restriction_domestic_only** | **String** | | [optional]
14
- **restriction_international_only** | **String** | | [optional]
15
- **restriction_po_box** | **String** | | [optional]
16
- **restriction_puerto_rico** | **String** | | [optional]
17
- **restriction_us_territories** | **String** | | [optional]
6
+ **descriptions** | **Array<String>** | | [optional]
7
+ **maximum_subtotal** | **Float** | Maximum subtotal | [optional]
8
+ **minimum_subtotal** | **Float** | Minimum subtotal | [optional]
9
+ **payment_method** | **String** | Payment method | [optional]
10
+ **restriction_alaska_hawaii** | **String** | Alaska and Hawaii restriction | [optional]
11
+ **restriction_apo_fpo** | **String** | APO/FPO restriction | [optional]
12
+ **restriction_canada** | **String** | Canada restriction | [optional]
13
+ **restriction_continental_us** | **String** | Continental US restriction | [optional]
14
+ **restriction_domestic_only** | **String** | Domestic only restriction | [optional]
15
+ **restriction_international_only** | **String** | International only restriction | [optional]
16
+ **restriction_po_box** | **String** | PO Box restriction | [optional]
17
+ **restriction_puerto_rico** | **String** | Puerto Rico restriction | [optional]
18
+ **restriction_us_territories** | **String** | US Territories restriction | [optional]
19
+ **themes** | [**Array<PaymentsConfigurationRestrictionsTheme>**](PaymentsConfigurationRestrictionsTheme.md) | | [optional]
18
20
 
19
21
 
data/docs/PaymentsConfigurationRestrictionsTheme.md ADDED
@@ -0,0 +1,10 @@
1
+ # UltracartClient::PaymentsConfigurationRestrictionsTheme
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | | [optional]
7
+ **restriction** | **String** | | [optional]
8
+ **store_front_host_name** | **String** | | [optional]
9
+
10
+
data/docs/PaymentsConfigurationSezzle.md CHANGED
@@ -3,13 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accept_sezzle** | **BOOLEAN** | | [optional]
6
+ **accept_sezzle** | **BOOLEAN** | Master flag for this merchant accepting Sezzle payments | [optional]
7
+ **accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional]
8
+ **business_id** | **String** | Business ID | [optional]
9
+ **deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional]
10
+ **environment** | **String** | Sezzle environment | [optional]
11
+ **environments** | **Array<String>** | List of environments possible | [optional]
12
+ **private_api_key** | **String** | Private API key | [optional]
13
+ **public_api_key** | **String** | Public API key | [optional]
7
14
  **restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
8
- **sezzle_accounting_code** | **String** | | [optional]
9
- **sezzle_business_id** | **String** | | [optional]
10
- **sezzle_deposit_to_account** | **String** | | [optional]
11
- **sezzle_environment** | **String** | | [optional]
12
- **sezzle_private_api_key** | **String** | | [optional]
13
- **sezzle_public_api_key** | **String** | | [optional]
14
15
 
15
16
 
data/docs/PaymentsConfigurationTestMethod.md ADDED
@@ -0,0 +1,18 @@
1
+ # UltracartClient::PaymentsConfigurationTestMethod
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **bank_account_number** | **String** | Bank account number | [optional]
7
+ **bank_routing_number** | **String** | Bank routing number | [optional]
8
+ **credit_card_number** | **String** | Credit card number | [optional]
9
+ **credit_card_number_existing** | **String** | The existing credit card number | [optional]
10
+ **description** | **String** | Description | [optional]
11
+ **payment_action** | **String** | Payment action | [optional]
12
+ **payment_method** | **String** | Payment method | [optional]
13
+ **payment_method_test_oid** | **Integer** | Payment method test oid | [optional]
14
+ **skip_affiliate_transaction** | **BOOLEAN** | Skip affiliate transaction | [optional]
15
+ **skip_conversion_pixels** | **BOOLEAN** | If true, skips recording any conversion pixels to avoid sending test orders to your analysis sites | [optional]
16
+ **skip_fraud_filter** | **BOOLEAN** | Skip fraud filter | [optional]
17
+
18
+