ultracart_api 3.4.13 → 3.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +9 -4
- data/docs/EmailCommseqWebhookSendTestRequest.md +14 -0
- data/docs/OrderChannelPartner.md +2 -2
- data/docs/PaymentsConfigurationCOD.md +2 -2
- data/docs/PaymentsConfigurationCreditCard.md +0 -1
- data/docs/PaymentsConfigurationCreditCardType.md +1 -0
- data/docs/PaymentsConfigurationPayPal.md +2 -2
- data/docs/PaymentsConfigurationWePay.md +1 -0
- data/docs/PaymentsConfigurationWireTransfer.md +2 -2
- data/docs/StorefrontApi.md +52 -0
- data/lib/ultracart_api.rb +1 -0
- data/lib/ultracart_api/api/storefront_api.rb +59 -0
- data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +240 -0
- data/lib/ultracart_api/models/order_channel_partner.rb +17 -2
- data/lib/ultracart_api/models/payments_configuration_cod.rb +2 -2
- data/lib/ultracart_api/models/payments_configuration_credit_card.rb +1 -13
- data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb +10 -1
- data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +2 -2
- data/lib/ultracart_api/models/payments_configuration_restrictions.rb +130 -0
- data/lib/ultracart_api/models/payments_configuration_we_pay.rb +11 -1
- data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +2 -2
- data/lib/ultracart_api/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5b6857c15baad34b698457d6431038f60544cfe4be78fd613e10bf74533d5c38
|
|
4
|
+
data.tar.gz: f2958544eaba078ead5d189afa5ea71936764bc3331f33289bb95825abbe67c5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a5c6a9166172316b29477aad32025142222063b9adf8f3c99fc326b6322b99d4611fe3420fc99bc28dcc9d9f021e9c7ca31fa6a3417a6adc7bdc3e6da7a8ea62
|
|
7
|
+
data.tar.gz: 03b9da4648e5ed9de2a9b5e50b1513cc6d6d2500f3295836c24d5de602e9b8d350c189ba274d3689289744640ae372f5eb43ae3dd32ab0a4d1d5ee04c332e7ce
|
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.
|
|
10
|
+
- Package version: 3.5.3
|
|
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.
|
|
27
|
+
gem install ./ultracart_api-3.5.3.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.5.3.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.
|
|
35
|
+
gem 'ultracart_api', '~> 3.5.3'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -344,6 +344,7 @@ Class | Method | HTTP request | Description
|
|
|
344
344
|
*UltracartClient::StorefrontApi* | [**search_shared_items**](docs/StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
|
|
345
345
|
*UltracartClient::StorefrontApi* | [**send_email_test**](docs/StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
|
|
346
346
|
*UltracartClient::StorefrontApi* | [**send_postcard_test**](docs/StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
|
|
347
|
+
*UltracartClient::StorefrontApi* | [**send_webhook_test**](docs/StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
|
|
347
348
|
*UltracartClient::StorefrontApi* | [**start_email_campaign**](docs/StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
|
|
348
349
|
*UltracartClient::StorefrontApi* | [**subscribe_to_email_list**](docs/StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
|
|
349
350
|
*UltracartClient::StorefrontApi* | [**unfavorite_screen_recording**](docs/StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
|
|
@@ -640,6 +641,7 @@ Class | Method | HTTP request | Description
|
|
|
640
641
|
- [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
|
|
641
642
|
- [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
|
|
642
643
|
- [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
|
|
644
|
+
- [UltracartClient::EmailCommseqWebhookSendTestRequest](docs/EmailCommseqWebhookSendTestRequest.md)
|
|
643
645
|
- [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
|
|
644
646
|
- [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
|
|
645
647
|
- [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
|
|
@@ -1114,6 +1116,9 @@ Not every change is committed to every SDK.
|
|
|
1114
1116
|
|
|
1115
1117
|
| Version | Date | Comments |
|
|
1116
1118
|
| --: | :-: | --- |
|
|
1119
|
+
| 3.5.3 | 08/18/2021 | configuration api - added credit card rate to UltraCart Payments object |
|
|
1120
|
+
| 3.5.1 | 08/11/2021 | email webhook test method |
|
|
1121
|
+
| 3.5.0 | 08/11/2021 | RestOrderChannelPartner.store_completed was incorrectly defaulting to true |
|
|
1117
1122
|
| 3.4.13 | 08/10/2021 | configuration api - changed some field types form string to number |
|
|
1118
1123
|
| 3.4.12 | 08/10/2021 | email engine - added webhook editor values for internal ui |
|
|
1119
1124
|
| 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names |
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# UltracartClient::EmailCommseqWebhookSendTestRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**cart_id** | **String** | | [optional]
|
|
7
|
+
**cart_item_ids** | **Array<String>** | | [optional]
|
|
8
|
+
**email** | **String** | | [optional]
|
|
9
|
+
**esp_commseq_step_uuid** | **String** | | [optional]
|
|
10
|
+
**esp_commseq_uuid** | **String** | | [optional]
|
|
11
|
+
**name** | **String** | | [optional]
|
|
12
|
+
**order_id** | **String** | | [optional]
|
|
13
|
+
|
|
14
|
+
|
data/docs/OrderChannelPartner.md
CHANGED
|
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**channel_partner_code** | **String** | The code of the channel partner | [optional]
|
|
8
8
|
**channel_partner_data** | **String** | Additional data provided by the channel partner, read-only | [optional]
|
|
9
9
|
**channel_partner_oid** | **Integer** | Channel partner object identifier, read-only and available on existing channel orders only. | [optional]
|
|
10
|
-
**channel_partner_order_id** | **String** | The order ID assigned by the channel partner for this order | [optional]
|
|
10
|
+
**channel_partner_order_id** | **String** | The order ID assigned by the channel partner for this order. | [optional]
|
|
11
11
|
**ignore_invalid_shipping_method** | **BOOLEAN** | Set to true to ignore invalid shipping method being specified. Only applicable on inserting orders. | [optional]
|
|
12
12
|
**no_realtime_payment_processing** | **BOOLEAN** | Indicates this order should be placed in Account Receivable for later payment processing | [optional]
|
|
13
13
|
**skip_payment_processing** | **BOOLEAN** | Indicates this order was already paid for via a channel purchase and no payment collection should be attempted | [optional]
|
|
14
|
-
**store_completed** | **BOOLEAN** | Instructs UltraCart to skip shipping department and mark this order as fully complete. Set this flag
|
|
14
|
+
**store_completed** | **BOOLEAN** | Instructs UltraCart to skip shipping department and mark this order as fully complete. This flag defaults to true. Set this flag to false to shipped product for this order. | [optional]
|
|
15
15
|
**store_if_payment_declines** | **BOOLEAN** | If true, any failed payment will place the order in Accounts Receivable rather than rejecting it. | [optional]
|
|
16
16
|
**treat_warnings_as_errors** | **BOOLEAN** | Any warnings are raised as errors and halt the import of the order | [optional]
|
|
17
17
|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**approved_customers_only** | **BOOLEAN** | If true, only approved customers may pay with COD | [optional]
|
|
8
8
|
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
|
9
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** | **
|
|
11
|
-
**surcharge_percentage** | **
|
|
10
|
+
**surcharge_fee** | **Float** | Additional cost for using COD | [optional]
|
|
11
|
+
**surcharge_percentage** | **Float** | Additional percentage cost for using COD | [optional]
|
|
12
12
|
|
|
13
13
|
|
|
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**configured_gateway_details** | **String** | Human readable description of the credit card gateway currently configured | [optional]
|
|
11
11
|
**failed_attempts** | **Integer** | The number of failed attempts before the order is placed into Accounts Receivable for manual intervention | [optional]
|
|
12
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
13
|
**send_customer_billing_update_on_decline** | **BOOLEAN** | UltraCart will send customers emails to update their credit card if the card is declined | [optional]
|
|
15
14
|
**supported_cards** | [**Array<PaymentsConfigurationCreditCardType>**](PaymentsConfigurationCreditCardType.md) | A list of credit cards the merchant wishes to accept. | [optional]
|
|
16
15
|
**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]
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional]
|
|
11
11
|
**processing_fee** | **Float** | Optional additional fee applied to order for this card | [optional]
|
|
12
12
|
**processing_percentage** | **Float** | Optional additional fee applied to order for this card | [optional]
|
|
13
|
+
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
|
13
14
|
**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
15
|
**transaction_fee** | **Float** | An optional additional fee to charge the customer for using this card. | [optional]
|
|
15
16
|
**transaction_percentage** | **Float** | An optional transaction percentage to charge the customer for using this card | [optional]
|
|
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**landing_page** | **String** | PayPal landing page | [optional]
|
|
20
20
|
**mode** | **String** | The PayPal mode | [optional]
|
|
21
21
|
**private_key_password** | **String** | PayPal API private key password | [optional]
|
|
22
|
-
**processing_fee** | **
|
|
23
|
-
**processing_percentage** | **
|
|
22
|
+
**processing_fee** | **Float** | Optional additional fee to charge if PayPal is used. It is rare for this to be used. | [optional]
|
|
23
|
+
**processing_percentage** | **Float** | The processing percentage charged by PayPal | [optional]
|
|
24
24
|
**push_paypal** | **BOOLEAN** | True if the internal UI should recommend opening a PayPal account | [optional]
|
|
25
25
|
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
|
26
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]
|
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**company_description** | **String** | Company description | [optional]
|
|
14
14
|
**console_hostname** | **String** | Console hostname | [optional]
|
|
15
15
|
**country** | **String** | Country | [optional]
|
|
16
|
+
**credit_card_rate** | **String** | WePay credit card rate | [optional]
|
|
16
17
|
**currency** | **String** | Base currency for transactions | [optional]
|
|
17
18
|
**expected_revenue** | **String** | Expected Revenue | [optional]
|
|
18
19
|
**hide_credit_card_non_ultracart_payments** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
|
13
13
|
**routing_number** | **String** | Routing number | [optional]
|
|
14
14
|
**surcharge_accounting_code** | **String** | If a surcharge is present and this merchant is integrated with Quickbooks, this is the accounting code for the surcharge amount | [optional]
|
|
15
|
-
**surcharge_fee** | **
|
|
16
|
-
**surcharge_percentage** | **
|
|
15
|
+
**surcharge_fee** | **Float** | surcharge_fee | [optional]
|
|
16
|
+
**surcharge_percentage** | **Float** | surcharge_percentage | [optional]
|
|
17
17
|
|
|
18
18
|
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -134,6 +134,7 @@ Method | HTTP request | Description
|
|
|
134
134
|
[**search_shared_items**](StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
|
|
135
135
|
[**send_email_test**](StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
|
|
136
136
|
[**send_postcard_test**](StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
|
|
137
|
+
[**send_webhook_test**](StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
|
|
137
138
|
[**start_email_campaign**](StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
|
|
138
139
|
[**subscribe_to_email_list**](StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
|
|
139
140
|
[**unfavorite_screen_recording**](StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
|
|
@@ -6851,6 +6852,57 @@ Name | Type | Description | Notes
|
|
|
6851
6852
|
|
|
6852
6853
|
|
|
6853
6854
|
|
|
6855
|
+
# **send_webhook_test**
|
|
6856
|
+
> EmailCommseqEmailSendTestResponse send_webhook_test(storefront_oid, email_commseq_webhook_test_request)
|
|
6857
|
+
|
|
6858
|
+
Send webhook test
|
|
6859
|
+
|
|
6860
|
+
### Example
|
|
6861
|
+
```ruby
|
|
6862
|
+
# load the gem
|
|
6863
|
+
require 'ultracart_api'
|
|
6864
|
+
|
|
6865
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
6866
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
6867
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
6868
|
+
|
|
6869
|
+
|
|
6870
|
+
storefront_oid = 56 # Integer |
|
|
6871
|
+
|
|
6872
|
+
email_commseq_webhook_test_request = UltracartClient::EmailCommseqWebhookSendTestRequest.new # EmailCommseqWebhookSendTestRequest | Email commseq webhook test request
|
|
6873
|
+
|
|
6874
|
+
|
|
6875
|
+
begin
|
|
6876
|
+
#Send webhook test
|
|
6877
|
+
result = api_instance.send_webhook_test(storefront_oid, email_commseq_webhook_test_request)
|
|
6878
|
+
p result
|
|
6879
|
+
rescue UltracartClient::ApiError => e
|
|
6880
|
+
puts "Exception when calling StorefrontApi->send_webhook_test: #{e}"
|
|
6881
|
+
end
|
|
6882
|
+
```
|
|
6883
|
+
|
|
6884
|
+
### Parameters
|
|
6885
|
+
|
|
6886
|
+
Name | Type | Description | Notes
|
|
6887
|
+
------------- | ------------- | ------------- | -------------
|
|
6888
|
+
**storefront_oid** | **Integer**| |
|
|
6889
|
+
**email_commseq_webhook_test_request** | [**EmailCommseqWebhookSendTestRequest**](EmailCommseqWebhookSendTestRequest.md)| Email commseq webhook test request |
|
|
6890
|
+
|
|
6891
|
+
### Return type
|
|
6892
|
+
|
|
6893
|
+
[**EmailCommseqEmailSendTestResponse**](EmailCommseqEmailSendTestResponse.md)
|
|
6894
|
+
|
|
6895
|
+
### Authorization
|
|
6896
|
+
|
|
6897
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6898
|
+
|
|
6899
|
+
### HTTP request headers
|
|
6900
|
+
|
|
6901
|
+
- **Content-Type**: application/json
|
|
6902
|
+
- **Accept**: application/json
|
|
6903
|
+
|
|
6904
|
+
|
|
6905
|
+
|
|
6854
6906
|
# **start_email_campaign**
|
|
6855
6907
|
> BaseResponse start_email_campaign(storefront_oid, email_campaign_uuid)
|
|
6856
6908
|
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -238,6 +238,7 @@ require 'ultracart_api/models/email_commseq_stat_response'
|
|
|
238
238
|
require 'ultracart_api/models/email_commseq_step'
|
|
239
239
|
require 'ultracart_api/models/email_commseq_step_log'
|
|
240
240
|
require 'ultracart_api/models/email_commseq_step_logs_response'
|
|
241
|
+
require 'ultracart_api/models/email_commseq_webhook_send_test_request'
|
|
241
242
|
require 'ultracart_api/models/email_commseqs_response'
|
|
242
243
|
require 'ultracart_api/models/email_customer'
|
|
243
244
|
require 'ultracart_api/models/email_customer_editor_url_response'
|
|
@@ -7661,6 +7661,65 @@ module UltracartClient
|
|
|
7661
7661
|
end
|
|
7662
7662
|
return data, status_code, headers
|
|
7663
7663
|
end
|
|
7664
|
+
# Send webhook test
|
|
7665
|
+
# @param storefront_oid
|
|
7666
|
+
# @param email_commseq_webhook_test_request Email commseq webhook test request
|
|
7667
|
+
# @param [Hash] opts the optional parameters
|
|
7668
|
+
# @return [EmailCommseqEmailSendTestResponse]
|
|
7669
|
+
def send_webhook_test(storefront_oid, email_commseq_webhook_test_request, opts = {})
|
|
7670
|
+
data, _status_code, _headers = send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts)
|
|
7671
|
+
data
|
|
7672
|
+
end
|
|
7673
|
+
|
|
7674
|
+
# Send webhook test
|
|
7675
|
+
# @param storefront_oid
|
|
7676
|
+
# @param email_commseq_webhook_test_request Email commseq webhook test request
|
|
7677
|
+
# @param [Hash] opts the optional parameters
|
|
7678
|
+
# @return [Array<(EmailCommseqEmailSendTestResponse, Fixnum, Hash)>] EmailCommseqEmailSendTestResponse data, response status code and response headers
|
|
7679
|
+
def send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts = {})
|
|
7680
|
+
if @api_client.config.debugging
|
|
7681
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.send_webhook_test ...'
|
|
7682
|
+
end
|
|
7683
|
+
# verify the required parameter 'storefront_oid' is set
|
|
7684
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
7685
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.send_webhook_test"
|
|
7686
|
+
end
|
|
7687
|
+
# verify the required parameter 'email_commseq_webhook_test_request' is set
|
|
7688
|
+
if @api_client.config.client_side_validation && email_commseq_webhook_test_request.nil?
|
|
7689
|
+
fail ArgumentError, "Missing the required parameter 'email_commseq_webhook_test_request' when calling StorefrontApi.send_webhook_test"
|
|
7690
|
+
end
|
|
7691
|
+
# resource path
|
|
7692
|
+
local_var_path = '/storefront/{storefront_oid}/email/webhooks/test'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s)
|
|
7693
|
+
|
|
7694
|
+
# query parameters
|
|
7695
|
+
query_params = {}
|
|
7696
|
+
|
|
7697
|
+
# header parameters
|
|
7698
|
+
header_params = {}
|
|
7699
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
7700
|
+
# HTTP header 'Accept' (if needed)
|
|
7701
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
7702
|
+
# HTTP header 'Content-Type'
|
|
7703
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
7704
|
+
|
|
7705
|
+
# form parameters
|
|
7706
|
+
form_params = {}
|
|
7707
|
+
|
|
7708
|
+
# http body (model)
|
|
7709
|
+
post_body = @api_client.object_to_http_body(email_commseq_webhook_test_request)
|
|
7710
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
7711
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
7712
|
+
:header_params => header_params,
|
|
7713
|
+
:query_params => query_params,
|
|
7714
|
+
:form_params => form_params,
|
|
7715
|
+
:body => post_body,
|
|
7716
|
+
:auth_names => auth_names,
|
|
7717
|
+
:return_type => 'EmailCommseqEmailSendTestResponse')
|
|
7718
|
+
if @api_client.config.debugging
|
|
7719
|
+
@api_client.config.logger.debug "API called: StorefrontApi#send_webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
7720
|
+
end
|
|
7721
|
+
return data, status_code, headers
|
|
7722
|
+
end
|
|
7664
7723
|
# Start email campaign
|
|
7665
7724
|
# @param storefront_oid
|
|
7666
7725
|
# @param email_campaign_uuid
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
|
|
15
|
+
module UltracartClient
|
|
16
|
+
class EmailCommseqWebhookSendTestRequest
|
|
17
|
+
attr_accessor :cart_id
|
|
18
|
+
|
|
19
|
+
attr_accessor :cart_item_ids
|
|
20
|
+
|
|
21
|
+
attr_accessor :email
|
|
22
|
+
|
|
23
|
+
attr_accessor :esp_commseq_step_uuid
|
|
24
|
+
|
|
25
|
+
attr_accessor :esp_commseq_uuid
|
|
26
|
+
|
|
27
|
+
attr_accessor :name
|
|
28
|
+
|
|
29
|
+
attr_accessor :order_id
|
|
30
|
+
|
|
31
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
32
|
+
def self.attribute_map
|
|
33
|
+
{
|
|
34
|
+
:'cart_id' => :'cart_id',
|
|
35
|
+
:'cart_item_ids' => :'cart_item_ids',
|
|
36
|
+
:'email' => :'email',
|
|
37
|
+
:'esp_commseq_step_uuid' => :'esp_commseq_step_uuid',
|
|
38
|
+
:'esp_commseq_uuid' => :'esp_commseq_uuid',
|
|
39
|
+
:'name' => :'name',
|
|
40
|
+
:'order_id' => :'order_id'
|
|
41
|
+
}
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Attribute type mapping.
|
|
45
|
+
def self.swagger_types
|
|
46
|
+
{
|
|
47
|
+
:'cart_id' => :'String',
|
|
48
|
+
:'cart_item_ids' => :'Array<String>',
|
|
49
|
+
:'email' => :'String',
|
|
50
|
+
:'esp_commseq_step_uuid' => :'String',
|
|
51
|
+
:'esp_commseq_uuid' => :'String',
|
|
52
|
+
:'name' => :'String',
|
|
53
|
+
:'order_id' => :'String'
|
|
54
|
+
}
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Initializes the object
|
|
58
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
59
|
+
def initialize(attributes = {})
|
|
60
|
+
return unless attributes.is_a?(Hash)
|
|
61
|
+
|
|
62
|
+
# convert string to symbol for hash key
|
|
63
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
64
|
+
|
|
65
|
+
if attributes.has_key?(:'cart_id')
|
|
66
|
+
self.cart_id = attributes[:'cart_id']
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if attributes.has_key?(:'cart_item_ids')
|
|
70
|
+
if (value = attributes[:'cart_item_ids']).is_a?(Array)
|
|
71
|
+
self.cart_item_ids = value
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
if attributes.has_key?(:'email')
|
|
76
|
+
self.email = attributes[:'email']
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
if attributes.has_key?(:'esp_commseq_step_uuid')
|
|
80
|
+
self.esp_commseq_step_uuid = attributes[:'esp_commseq_step_uuid']
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
if attributes.has_key?(:'esp_commseq_uuid')
|
|
84
|
+
self.esp_commseq_uuid = attributes[:'esp_commseq_uuid']
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
if attributes.has_key?(:'name')
|
|
88
|
+
self.name = attributes[:'name']
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
if attributes.has_key?(:'order_id')
|
|
92
|
+
self.order_id = attributes[:'order_id']
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
97
|
+
# @return Array for valid properties with the reasons
|
|
98
|
+
def list_invalid_properties
|
|
99
|
+
invalid_properties = Array.new
|
|
100
|
+
invalid_properties
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Check to see if the all the properties in the model are valid
|
|
104
|
+
# @return true if the model is valid
|
|
105
|
+
def valid?
|
|
106
|
+
true
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Checks equality by comparing each attribute.
|
|
110
|
+
# @param [Object] Object to be compared
|
|
111
|
+
def ==(o)
|
|
112
|
+
return true if self.equal?(o)
|
|
113
|
+
self.class == o.class &&
|
|
114
|
+
cart_id == o.cart_id &&
|
|
115
|
+
cart_item_ids == o.cart_item_ids &&
|
|
116
|
+
email == o.email &&
|
|
117
|
+
esp_commseq_step_uuid == o.esp_commseq_step_uuid &&
|
|
118
|
+
esp_commseq_uuid == o.esp_commseq_uuid &&
|
|
119
|
+
name == o.name &&
|
|
120
|
+
order_id == o.order_id
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# @see the `==` method
|
|
124
|
+
# @param [Object] Object to be compared
|
|
125
|
+
def eql?(o)
|
|
126
|
+
self == o
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# Calculates hash code according to all attributes.
|
|
130
|
+
# @return [Fixnum] Hash code
|
|
131
|
+
def hash
|
|
132
|
+
[cart_id, cart_item_ids, email, esp_commseq_step_uuid, esp_commseq_uuid, name, order_id].hash
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Builds the object from hash
|
|
136
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
137
|
+
# @return [Object] Returns the model itself
|
|
138
|
+
def build_from_hash(attributes)
|
|
139
|
+
return nil unless attributes.is_a?(Hash)
|
|
140
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
141
|
+
if type =~ /\AArray<(.*)>/i
|
|
142
|
+
# check to ensure the input is an array given that the attribute
|
|
143
|
+
# is documented as an array but the input is not
|
|
144
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
145
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
146
|
+
end
|
|
147
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
148
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
149
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
self
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Deserializes the data based on type
|
|
156
|
+
# @param string type Data type
|
|
157
|
+
# @param string value Value to be deserialized
|
|
158
|
+
# @return [Object] Deserialized data
|
|
159
|
+
def _deserialize(type, value)
|
|
160
|
+
case type.to_sym
|
|
161
|
+
when :DateTime
|
|
162
|
+
DateTime.parse(value)
|
|
163
|
+
when :Date
|
|
164
|
+
Date.parse(value)
|
|
165
|
+
when :String
|
|
166
|
+
value.to_s
|
|
167
|
+
when :Integer
|
|
168
|
+
value.to_i
|
|
169
|
+
when :Float
|
|
170
|
+
value.to_f
|
|
171
|
+
when :BOOLEAN
|
|
172
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
173
|
+
true
|
|
174
|
+
else
|
|
175
|
+
false
|
|
176
|
+
end
|
|
177
|
+
when :Object
|
|
178
|
+
# generic object (usually a Hash), return directly
|
|
179
|
+
value
|
|
180
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
181
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
182
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
183
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
184
|
+
k_type = Regexp.last_match[:k_type]
|
|
185
|
+
v_type = Regexp.last_match[:v_type]
|
|
186
|
+
{}.tap do |hash|
|
|
187
|
+
value.each do |k, v|
|
|
188
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
189
|
+
end
|
|
190
|
+
end
|
|
191
|
+
else # model
|
|
192
|
+
temp_model = UltracartClient.const_get(type).new
|
|
193
|
+
temp_model.build_from_hash(value)
|
|
194
|
+
end
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
# Returns the string representation of the object
|
|
198
|
+
# @return [String] String presentation of the object
|
|
199
|
+
def to_s
|
|
200
|
+
to_hash.to_s
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
204
|
+
# @return [Hash] Returns the object in the form of hash
|
|
205
|
+
def to_body
|
|
206
|
+
to_hash
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Returns the object in the form of hash
|
|
210
|
+
# @return [Hash] Returns the object in the form of hash
|
|
211
|
+
def to_hash
|
|
212
|
+
hash = {}
|
|
213
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
214
|
+
value = self.send(attr)
|
|
215
|
+
next if value.nil?
|
|
216
|
+
hash[param] = _to_hash(value)
|
|
217
|
+
end
|
|
218
|
+
hash
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# Outputs non-array value in the form of hash
|
|
222
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
223
|
+
# @param [Object] value Any valid value
|
|
224
|
+
# @return [Hash] Returns the value in the form of hash
|
|
225
|
+
def _to_hash(value)
|
|
226
|
+
if value.is_a?(Array)
|
|
227
|
+
value.compact.map { |v| _to_hash(v) }
|
|
228
|
+
elsif value.is_a?(Hash)
|
|
229
|
+
{}.tap do |hash|
|
|
230
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
231
|
+
end
|
|
232
|
+
elsif value.respond_to? :to_hash
|
|
233
|
+
value.to_hash
|
|
234
|
+
else
|
|
235
|
+
value
|
|
236
|
+
end
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
end
|
|
240
|
+
end
|
|
@@ -26,7 +26,7 @@ module UltracartClient
|
|
|
26
26
|
# Channel partner object identifier, read-only and available on existing channel orders only.
|
|
27
27
|
attr_accessor :channel_partner_oid
|
|
28
28
|
|
|
29
|
-
# The order ID assigned by the channel partner for this order
|
|
29
|
+
# The order ID assigned by the channel partner for this order.
|
|
30
30
|
attr_accessor :channel_partner_order_id
|
|
31
31
|
|
|
32
32
|
# Set to true to ignore invalid shipping method being specified. Only applicable on inserting orders.
|
|
@@ -38,7 +38,7 @@ module UltracartClient
|
|
|
38
38
|
# Indicates this order was already paid for via a channel purchase and no payment collection should be attempted
|
|
39
39
|
attr_accessor :skip_payment_processing
|
|
40
40
|
|
|
41
|
-
# Instructs UltraCart to skip shipping department and mark this order as fully complete. Set this flag
|
|
41
|
+
# Instructs UltraCart to skip shipping department and mark this order as fully complete. This flag defaults to true. Set this flag to false to shipped product for this order.
|
|
42
42
|
attr_accessor :store_completed
|
|
43
43
|
|
|
44
44
|
# If true, any failed payment will place the order in Accounts Receivable rather than rejecting it.
|
|
@@ -138,15 +138,30 @@ module UltracartClient
|
|
|
138
138
|
# @return Array for valid properties with the reasons
|
|
139
139
|
def list_invalid_properties
|
|
140
140
|
invalid_properties = Array.new
|
|
141
|
+
if !@channel_partner_order_id.nil? && @channel_partner_order_id.to_s.length > 50
|
|
142
|
+
invalid_properties.push('invalid value for "channel_partner_order_id", the character length must be smaller than or equal to 50.')
|
|
143
|
+
end
|
|
144
|
+
|
|
141
145
|
invalid_properties
|
|
142
146
|
end
|
|
143
147
|
|
|
144
148
|
# Check to see if the all the properties in the model are valid
|
|
145
149
|
# @return true if the model is valid
|
|
146
150
|
def valid?
|
|
151
|
+
return false if !@channel_partner_order_id.nil? && @channel_partner_order_id.to_s.length > 50
|
|
147
152
|
true
|
|
148
153
|
end
|
|
149
154
|
|
|
155
|
+
# Custom attribute writer method with validation
|
|
156
|
+
# @param [Object] channel_partner_order_id Value to be assigned
|
|
157
|
+
def channel_partner_order_id=(channel_partner_order_id)
|
|
158
|
+
if !channel_partner_order_id.nil? && channel_partner_order_id.to_s.length > 50
|
|
159
|
+
fail ArgumentError, 'invalid value for "channel_partner_order_id", the character length must be smaller than or equal to 50.'
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
@channel_partner_order_id = channel_partner_order_id
|
|
163
|
+
end
|
|
164
|
+
|
|
150
165
|
# Checks equality by comparing each attribute.
|
|
151
166
|
# @param [Object] Object to be compared
|
|
152
167
|
def ==(o)
|
|
@@ -50,8 +50,8 @@ module UltracartClient
|
|
|
50
50
|
:'approved_customers_only' => :'BOOLEAN',
|
|
51
51
|
:'restrictions' => :'PaymentsConfigurationRestrictions',
|
|
52
52
|
:'surcharge_accounting_code' => :'String',
|
|
53
|
-
:'surcharge_fee' => :'
|
|
54
|
-
:'surcharge_percentage' => :'
|
|
53
|
+
:'surcharge_fee' => :'Float',
|
|
54
|
+
:'surcharge_percentage' => :'Float'
|
|
55
55
|
}
|
|
56
56
|
end
|
|
57
57
|
|
|
@@ -35,9 +35,6 @@ module UltracartClient
|
|
|
35
35
|
# This internal flag aids the UI in determining which buttons to show.
|
|
36
36
|
attr_accessor :hide_connect_single_gateway
|
|
37
37
|
|
|
38
|
-
# Restrictions for this payment method
|
|
39
|
-
attr_accessor :restrictions
|
|
40
|
-
|
|
41
38
|
# UltraCart will send customers emails to update their credit card if the card is declined
|
|
42
39
|
attr_accessor :send_customer_billing_update_on_decline
|
|
43
40
|
|
|
@@ -57,7 +54,6 @@ module UltracartClient
|
|
|
57
54
|
:'configured_gateway_details' => :'configured_gateway_details',
|
|
58
55
|
:'failed_attempts' => :'failed_attempts',
|
|
59
56
|
:'hide_connect_single_gateway' => :'hide_connect_single_gateway',
|
|
60
|
-
:'restrictions' => :'restrictions',
|
|
61
57
|
:'send_customer_billing_update_on_decline' => :'send_customer_billing_update_on_decline',
|
|
62
58
|
:'supported_cards' => :'supported_cards',
|
|
63
59
|
:'test_methods' => :'test_methods'
|
|
@@ -74,7 +70,6 @@ module UltracartClient
|
|
|
74
70
|
:'configured_gateway_details' => :'String',
|
|
75
71
|
:'failed_attempts' => :'Integer',
|
|
76
72
|
:'hide_connect_single_gateway' => :'BOOLEAN',
|
|
77
|
-
:'restrictions' => :'Array<PaymentsConfigurationRestrictions>',
|
|
78
73
|
:'send_customer_billing_update_on_decline' => :'BOOLEAN',
|
|
79
74
|
:'supported_cards' => :'Array<PaymentsConfigurationCreditCardType>',
|
|
80
75
|
:'test_methods' => :'Array<PaymentsConfigurationTestMethod>'
|
|
@@ -117,12 +112,6 @@ module UltracartClient
|
|
|
117
112
|
self.hide_connect_single_gateway = attributes[:'hide_connect_single_gateway']
|
|
118
113
|
end
|
|
119
114
|
|
|
120
|
-
if attributes.has_key?(:'restrictions')
|
|
121
|
-
if (value = attributes[:'restrictions']).is_a?(Array)
|
|
122
|
-
self.restrictions = value
|
|
123
|
-
end
|
|
124
|
-
end
|
|
125
|
-
|
|
126
115
|
if attributes.has_key?(:'send_customer_billing_update_on_decline')
|
|
127
116
|
self.send_customer_billing_update_on_decline = attributes[:'send_customer_billing_update_on_decline']
|
|
128
117
|
end
|
|
@@ -165,7 +154,6 @@ module UltracartClient
|
|
|
165
154
|
configured_gateway_details == o.configured_gateway_details &&
|
|
166
155
|
failed_attempts == o.failed_attempts &&
|
|
167
156
|
hide_connect_single_gateway == o.hide_connect_single_gateway &&
|
|
168
|
-
restrictions == o.restrictions &&
|
|
169
157
|
send_customer_billing_update_on_decline == o.send_customer_billing_update_on_decline &&
|
|
170
158
|
supported_cards == o.supported_cards &&
|
|
171
159
|
test_methods == o.test_methods
|
|
@@ -180,7 +168,7 @@ module UltracartClient
|
|
|
180
168
|
# Calculates hash code according to all attributes.
|
|
181
169
|
# @return [Fixnum] Hash code
|
|
182
170
|
def hash
|
|
183
|
-
[accept_credit_card, billed_by, charge_during_checkout, collect_cvv2, configured_gateway_details, failed_attempts, hide_connect_single_gateway,
|
|
171
|
+
[accept_credit_card, billed_by, charge_during_checkout, collect_cvv2, configured_gateway_details, failed_attempts, hide_connect_single_gateway, send_customer_billing_update_on_decline, supported_cards, test_methods].hash
|
|
184
172
|
end
|
|
185
173
|
|
|
186
174
|
# Builds the object from hash
|
|
@@ -35,6 +35,8 @@ module UltracartClient
|
|
|
35
35
|
# Optional additional fee applied to order for this card
|
|
36
36
|
attr_accessor :processing_percentage
|
|
37
37
|
|
|
38
|
+
attr_accessor :restrictions
|
|
39
|
+
|
|
38
40
|
# Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders
|
|
39
41
|
attr_accessor :surcharge_accounting_code
|
|
40
42
|
|
|
@@ -76,6 +78,7 @@ module UltracartClient
|
|
|
76
78
|
:'enabled' => :'enabled',
|
|
77
79
|
:'processing_fee' => :'processing_fee',
|
|
78
80
|
:'processing_percentage' => :'processing_percentage',
|
|
81
|
+
:'restrictions' => :'restrictions',
|
|
79
82
|
:'surcharge_accounting_code' => :'surcharge_accounting_code',
|
|
80
83
|
:'transaction_fee' => :'transaction_fee',
|
|
81
84
|
:'transaction_percentage' => :'transaction_percentage'
|
|
@@ -92,6 +95,7 @@ module UltracartClient
|
|
|
92
95
|
:'enabled' => :'BOOLEAN',
|
|
93
96
|
:'processing_fee' => :'Float',
|
|
94
97
|
:'processing_percentage' => :'Float',
|
|
98
|
+
:'restrictions' => :'PaymentsConfigurationRestrictions',
|
|
95
99
|
:'surcharge_accounting_code' => :'String',
|
|
96
100
|
:'transaction_fee' => :'Float',
|
|
97
101
|
:'transaction_percentage' => :'Float'
|
|
@@ -134,6 +138,10 @@ module UltracartClient
|
|
|
134
138
|
self.processing_percentage = attributes[:'processing_percentage']
|
|
135
139
|
end
|
|
136
140
|
|
|
141
|
+
if attributes.has_key?(:'restrictions')
|
|
142
|
+
self.restrictions = attributes[:'restrictions']
|
|
143
|
+
end
|
|
144
|
+
|
|
137
145
|
if attributes.has_key?(:'surcharge_accounting_code')
|
|
138
146
|
self.surcharge_accounting_code = attributes[:'surcharge_accounting_code']
|
|
139
147
|
end
|
|
@@ -184,6 +192,7 @@ module UltracartClient
|
|
|
184
192
|
enabled == o.enabled &&
|
|
185
193
|
processing_fee == o.processing_fee &&
|
|
186
194
|
processing_percentage == o.processing_percentage &&
|
|
195
|
+
restrictions == o.restrictions &&
|
|
187
196
|
surcharge_accounting_code == o.surcharge_accounting_code &&
|
|
188
197
|
transaction_fee == o.transaction_fee &&
|
|
189
198
|
transaction_percentage == o.transaction_percentage
|
|
@@ -198,7 +207,7 @@ module UltracartClient
|
|
|
198
207
|
# Calculates hash code according to all attributes.
|
|
199
208
|
# @return [Fixnum] Hash code
|
|
200
209
|
def hash
|
|
201
|
-
[accounting_code, card_type_icon, credit_card, deposit_to_account, enabled, processing_fee, processing_percentage, surcharge_accounting_code, transaction_fee, transaction_percentage].hash
|
|
210
|
+
[accounting_code, card_type_icon, credit_card, deposit_to_account, enabled, processing_fee, processing_percentage, restrictions, surcharge_accounting_code, transaction_fee, transaction_percentage].hash
|
|
202
211
|
end
|
|
203
212
|
|
|
204
213
|
# Builds the object from hash
|
|
@@ -176,8 +176,8 @@ module UltracartClient
|
|
|
176
176
|
:'landing_page' => :'String',
|
|
177
177
|
:'mode' => :'String',
|
|
178
178
|
:'private_key_password' => :'String',
|
|
179
|
-
:'processing_fee' => :'
|
|
180
|
-
:'processing_percentage' => :'
|
|
179
|
+
:'processing_fee' => :'Float',
|
|
180
|
+
:'processing_percentage' => :'Float',
|
|
181
181
|
:'push_paypal' => :'BOOLEAN',
|
|
182
182
|
:'restrictions' => :'PaymentsConfigurationRestrictions',
|
|
183
183
|
:'send_recurring' => :'BOOLEAN',
|
|
@@ -54,6 +54,28 @@ module UltracartClient
|
|
|
54
54
|
|
|
55
55
|
attr_accessor :themes
|
|
56
56
|
|
|
57
|
+
class EnumAttributeValidator
|
|
58
|
+
attr_reader :datatype
|
|
59
|
+
attr_reader :allowable_values
|
|
60
|
+
|
|
61
|
+
def initialize(datatype, allowable_values)
|
|
62
|
+
@allowable_values = allowable_values.map do |value|
|
|
63
|
+
case datatype.to_s
|
|
64
|
+
when /Integer/i
|
|
65
|
+
value.to_i
|
|
66
|
+
when /Float/i
|
|
67
|
+
value.to_f
|
|
68
|
+
else
|
|
69
|
+
value
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
def valid?(value)
|
|
75
|
+
!value || allowable_values.include?(value)
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
|
|
57
79
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
58
80
|
def self.attribute_map
|
|
59
81
|
{
|
|
@@ -173,9 +195,117 @@ module UltracartClient
|
|
|
173
195
|
# Check to see if the all the properties in the model are valid
|
|
174
196
|
# @return true if the model is valid
|
|
175
197
|
def valid?
|
|
198
|
+
restriction_alaska_hawaii_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
199
|
+
return false unless restriction_alaska_hawaii_validator.valid?(@restriction_alaska_hawaii)
|
|
200
|
+
restriction_apo_fpo_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
201
|
+
return false unless restriction_apo_fpo_validator.valid?(@restriction_apo_fpo)
|
|
202
|
+
restriction_canada_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
203
|
+
return false unless restriction_canada_validator.valid?(@restriction_canada)
|
|
204
|
+
restriction_continental_us_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
205
|
+
return false unless restriction_continental_us_validator.valid?(@restriction_continental_us)
|
|
206
|
+
restriction_domestic_only_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
207
|
+
return false unless restriction_domestic_only_validator.valid?(@restriction_domestic_only)
|
|
208
|
+
restriction_international_only_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
209
|
+
return false unless restriction_international_only_validator.valid?(@restriction_international_only)
|
|
210
|
+
restriction_po_box_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
211
|
+
return false unless restriction_po_box_validator.valid?(@restriction_po_box)
|
|
212
|
+
restriction_puerto_rico_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
213
|
+
return false unless restriction_puerto_rico_validator.valid?(@restriction_puerto_rico)
|
|
214
|
+
restriction_us_territories_validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
215
|
+
return false unless restriction_us_territories_validator.valid?(@restriction_us_territories)
|
|
176
216
|
true
|
|
177
217
|
end
|
|
178
218
|
|
|
219
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
220
|
+
# @param [Object] restriction_alaska_hawaii Object to be assigned
|
|
221
|
+
def restriction_alaska_hawaii=(restriction_alaska_hawaii)
|
|
222
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
223
|
+
unless validator.valid?(restriction_alaska_hawaii)
|
|
224
|
+
fail ArgumentError, 'invalid value for "restriction_alaska_hawaii", must be one of #{validator.allowable_values}.'
|
|
225
|
+
end
|
|
226
|
+
@restriction_alaska_hawaii = restriction_alaska_hawaii
|
|
227
|
+
end
|
|
228
|
+
|
|
229
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
230
|
+
# @param [Object] restriction_apo_fpo Object to be assigned
|
|
231
|
+
def restriction_apo_fpo=(restriction_apo_fpo)
|
|
232
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
233
|
+
unless validator.valid?(restriction_apo_fpo)
|
|
234
|
+
fail ArgumentError, 'invalid value for "restriction_apo_fpo", must be one of #{validator.allowable_values}.'
|
|
235
|
+
end
|
|
236
|
+
@restriction_apo_fpo = restriction_apo_fpo
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
240
|
+
# @param [Object] restriction_canada Object to be assigned
|
|
241
|
+
def restriction_canada=(restriction_canada)
|
|
242
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
243
|
+
unless validator.valid?(restriction_canada)
|
|
244
|
+
fail ArgumentError, 'invalid value for "restriction_canada", must be one of #{validator.allowable_values}.'
|
|
245
|
+
end
|
|
246
|
+
@restriction_canada = restriction_canada
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
250
|
+
# @param [Object] restriction_continental_us Object to be assigned
|
|
251
|
+
def restriction_continental_us=(restriction_continental_us)
|
|
252
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
253
|
+
unless validator.valid?(restriction_continental_us)
|
|
254
|
+
fail ArgumentError, 'invalid value for "restriction_continental_us", must be one of #{validator.allowable_values}.'
|
|
255
|
+
end
|
|
256
|
+
@restriction_continental_us = restriction_continental_us
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
260
|
+
# @param [Object] restriction_domestic_only Object to be assigned
|
|
261
|
+
def restriction_domestic_only=(restriction_domestic_only)
|
|
262
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
263
|
+
unless validator.valid?(restriction_domestic_only)
|
|
264
|
+
fail ArgumentError, 'invalid value for "restriction_domestic_only", must be one of #{validator.allowable_values}.'
|
|
265
|
+
end
|
|
266
|
+
@restriction_domestic_only = restriction_domestic_only
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
270
|
+
# @param [Object] restriction_international_only Object to be assigned
|
|
271
|
+
def restriction_international_only=(restriction_international_only)
|
|
272
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
273
|
+
unless validator.valid?(restriction_international_only)
|
|
274
|
+
fail ArgumentError, 'invalid value for "restriction_international_only", must be one of #{validator.allowable_values}.'
|
|
275
|
+
end
|
|
276
|
+
@restriction_international_only = restriction_international_only
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
280
|
+
# @param [Object] restriction_po_box Object to be assigned
|
|
281
|
+
def restriction_po_box=(restriction_po_box)
|
|
282
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
283
|
+
unless validator.valid?(restriction_po_box)
|
|
284
|
+
fail ArgumentError, 'invalid value for "restriction_po_box", must be one of #{validator.allowable_values}.'
|
|
285
|
+
end
|
|
286
|
+
@restriction_po_box = restriction_po_box
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
290
|
+
# @param [Object] restriction_puerto_rico Object to be assigned
|
|
291
|
+
def restriction_puerto_rico=(restriction_puerto_rico)
|
|
292
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
293
|
+
unless validator.valid?(restriction_puerto_rico)
|
|
294
|
+
fail ArgumentError, 'invalid value for "restriction_puerto_rico", must be one of #{validator.allowable_values}.'
|
|
295
|
+
end
|
|
296
|
+
@restriction_puerto_rico = restriction_puerto_rico
|
|
297
|
+
end
|
|
298
|
+
|
|
299
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
300
|
+
# @param [Object] restriction_us_territories Object to be assigned
|
|
301
|
+
def restriction_us_territories=(restriction_us_territories)
|
|
302
|
+
validator = EnumAttributeValidator.new('String', ['invalid', 'invalidOnly', 'valid'])
|
|
303
|
+
unless validator.valid?(restriction_us_territories)
|
|
304
|
+
fail ArgumentError, 'invalid value for "restriction_us_territories", must be one of #{validator.allowable_values}.'
|
|
305
|
+
end
|
|
306
|
+
@restriction_us_territories = restriction_us_territories
|
|
307
|
+
end
|
|
308
|
+
|
|
179
309
|
# Checks equality by comparing each attribute.
|
|
180
310
|
# @param [Object] Object to be compared
|
|
181
311
|
def ==(o)
|
|
@@ -44,6 +44,9 @@ module UltracartClient
|
|
|
44
44
|
# Country
|
|
45
45
|
attr_accessor :country
|
|
46
46
|
|
|
47
|
+
# WePay credit card rate
|
|
48
|
+
attr_accessor :credit_card_rate
|
|
49
|
+
|
|
47
50
|
# Base currency for transactions
|
|
48
51
|
attr_accessor :currency
|
|
49
52
|
|
|
@@ -109,6 +112,7 @@ module UltracartClient
|
|
|
109
112
|
:'company_description' => :'company_description',
|
|
110
113
|
:'console_hostname' => :'console_hostname',
|
|
111
114
|
:'country' => :'country',
|
|
115
|
+
:'credit_card_rate' => :'credit_card_rate',
|
|
112
116
|
:'currency' => :'currency',
|
|
113
117
|
:'expected_revenue' => :'expected_revenue',
|
|
114
118
|
:'hide_credit_card_non_ultracart_payments' => :'hide_credit_card_non_ultracart_payments',
|
|
@@ -143,6 +147,7 @@ module UltracartClient
|
|
|
143
147
|
:'company_description' => :'String',
|
|
144
148
|
:'console_hostname' => :'String',
|
|
145
149
|
:'country' => :'String',
|
|
150
|
+
:'credit_card_rate' => :'String',
|
|
146
151
|
:'currency' => :'String',
|
|
147
152
|
:'expected_revenue' => :'String',
|
|
148
153
|
:'hide_credit_card_non_ultracart_payments' => :'BOOLEAN',
|
|
@@ -212,6 +217,10 @@ module UltracartClient
|
|
|
212
217
|
self.country = attributes[:'country']
|
|
213
218
|
end
|
|
214
219
|
|
|
220
|
+
if attributes.has_key?(:'credit_card_rate')
|
|
221
|
+
self.credit_card_rate = attributes[:'credit_card_rate']
|
|
222
|
+
end
|
|
223
|
+
|
|
215
224
|
if attributes.has_key?(:'currency')
|
|
216
225
|
self.currency = attributes[:'currency']
|
|
217
226
|
end
|
|
@@ -313,6 +322,7 @@ module UltracartClient
|
|
|
313
322
|
company_description == o.company_description &&
|
|
314
323
|
console_hostname == o.console_hostname &&
|
|
315
324
|
country == o.country &&
|
|
325
|
+
credit_card_rate == o.credit_card_rate &&
|
|
316
326
|
currency == o.currency &&
|
|
317
327
|
expected_revenue == o.expected_revenue &&
|
|
318
328
|
hide_credit_card_non_ultracart_payments == o.hide_credit_card_non_ultracart_payments &&
|
|
@@ -342,7 +352,7 @@ module UltracartClient
|
|
|
342
352
|
# Calculates hash code according to all attributes.
|
|
343
353
|
# @return [Fixnum] Hash code
|
|
344
354
|
def hash
|
|
345
|
-
[accept_wepay, account_update_uri, address1, address2, canada_accept_debit_cards, city, company, company_description, console_hostname, country, currency, expected_revenue, hide_credit_card_non_ultracart_payments, hide_surcharge_amount, industry, owner_email, owner_name, owner_phone, postal_code, remove_pay_pal_pro, restrictions, short_paypal_marketing_text, show_ultracart_payments_disabled, show_ultracart_payments_intro, show_ultracart_payments_verification, show_ultracart_payments_verified, state, website_url].hash
|
|
355
|
+
[accept_wepay, account_update_uri, address1, address2, canada_accept_debit_cards, city, company, company_description, console_hostname, country, credit_card_rate, currency, expected_revenue, hide_credit_card_non_ultracart_payments, hide_surcharge_amount, industry, owner_email, owner_name, owner_phone, postal_code, remove_pay_pal_pro, restrictions, short_paypal_marketing_text, show_ultracart_payments_disabled, show_ultracart_payments_intro, show_ultracart_payments_verification, show_ultracart_payments_verified, state, website_url].hash
|
|
346
356
|
end
|
|
347
357
|
|
|
348
358
|
# Builds the object from hash
|
|
@@ -75,8 +75,8 @@ module UltracartClient
|
|
|
75
75
|
:'restrictions' => :'PaymentsConfigurationRestrictions',
|
|
76
76
|
:'routing_number' => :'String',
|
|
77
77
|
:'surcharge_accounting_code' => :'String',
|
|
78
|
-
:'surcharge_fee' => :'
|
|
79
|
-
:'surcharge_percentage' => :'
|
|
78
|
+
:'surcharge_fee' => :'Float',
|
|
79
|
+
:'surcharge_percentage' => :'Float'
|
|
80
80
|
}
|
|
81
81
|
end
|
|
82
82
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.5.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-08-
|
|
11
|
+
date: 2021-08-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -429,6 +429,7 @@ files:
|
|
|
429
429
|
- docs/EmailCommseqStep.md
|
|
430
430
|
- docs/EmailCommseqStepLog.md
|
|
431
431
|
- docs/EmailCommseqStepLogsResponse.md
|
|
432
|
+
- docs/EmailCommseqWebhookSendTestRequest.md
|
|
432
433
|
- docs/EmailCommseqsResponse.md
|
|
433
434
|
- docs/EmailCustomer.md
|
|
434
435
|
- docs/EmailCustomerEditorUrlResponse.md
|
|
@@ -1092,6 +1093,7 @@ files:
|
|
|
1092
1093
|
- lib/ultracart_api/models/email_commseq_step.rb
|
|
1093
1094
|
- lib/ultracart_api/models/email_commseq_step_log.rb
|
|
1094
1095
|
- lib/ultracart_api/models/email_commseq_step_logs_response.rb
|
|
1096
|
+
- lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb
|
|
1095
1097
|
- lib/ultracart_api/models/email_commseqs_response.rb
|
|
1096
1098
|
- lib/ultracart_api/models/email_customer.rb
|
|
1097
1099
|
- lib/ultracart_api/models/email_customer_editor_url_response.rb
|