ultracart_api 3.4.11 → 3.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/docs/EmailCommseqWebhookSendTestRequest.md +14 -0
- data/docs/EmailWebhookEditorValuesResponse.md +14 -0
- data/docs/OrderChannelPartner.md +1 -1
- data/docs/PaymentsConfigurationCOD.md +2 -2
- data/docs/PaymentsConfigurationCreditCardType.md +4 -4
- data/docs/PaymentsConfigurationPayPal.md +2 -2
- data/docs/PaymentsConfigurationWireTransfer.md +2 -2
- data/docs/StorefrontApi.md +104 -0
- data/lib/ultracart_api.rb +2 -0
- data/lib/ultracart_api/api/storefront_api.rb +118 -0
- data/lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb +240 -0
- data/lib/ultracart_api/models/email_webhook_editor_values_response.rb +243 -0
- data/lib/ultracart_api/models/order_channel_partner.rb +1 -1
- data/lib/ultracart_api/models/payments_configuration_cod.rb +2 -2
- data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb +4 -4
- data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +2 -2
- data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +2 -2
- data/lib/ultracart_api/version.rb +1 -1
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f6262d882ea4fe642d39f1e6e1f5a8b1429b0153d7eccd18bb3cfb36a2eb8c81
|
4
|
+
data.tar.gz: 6b8f0ef3ae1dccde014b2e3c95f9a73338762546def0aa120cd9c6e8f94a36e4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 382574e46088303307cf2b9848583a3abe57051b4145d78d876eecfcbdfb456fac79132a345aba40715d2a72630348ca564575c506a80427706da9217ba03dcd
|
7
|
+
data.tar.gz: 9a8ba86ad0f93ade42fe090d8c5621556dd3c7811e7db4a5cf7078f59e39a1d2b9413e36985e33a809f4237a69e41cf2f74625450a37c891e9896072c267c4af
|
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.1
|
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.1.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.5.1.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.1'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -254,6 +254,7 @@ Class | Method | HTTP request | Description
|
|
254
254
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
255
255
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
256
256
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
257
|
+
*UltracartClient::StorefrontApi* | [**get_email_commseq_webhook_editor_values**](docs/StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values
|
257
258
|
*UltracartClient::StorefrontApi* | [**get_email_commseqs**](docs/StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs
|
258
259
|
*UltracartClient::StorefrontApi* | [**get_email_customer_editor_url**](docs/StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL
|
259
260
|
*UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
|
@@ -343,6 +344,7 @@ Class | Method | HTTP request | Description
|
|
343
344
|
*UltracartClient::StorefrontApi* | [**search_shared_items**](docs/StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
|
344
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
|
345
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
|
346
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
|
347
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
|
348
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
|
@@ -639,6 +641,7 @@ Class | Method | HTTP request | Description
|
|
639
641
|
- [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
|
640
642
|
- [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
|
641
643
|
- [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
|
644
|
+
- [UltracartClient::EmailCommseqWebhookSendTestRequest](docs/EmailCommseqWebhookSendTestRequest.md)
|
642
645
|
- [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
|
643
646
|
- [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
|
644
647
|
- [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
|
@@ -716,6 +719,7 @@ Class | Method | HTTP request | Description
|
|
716
719
|
- [UltracartClient::EmailVerifyTokenResponse](docs/EmailVerifyTokenResponse.md)
|
717
720
|
- [UltracartClient::EmailVerifyTokenValidateRequest](docs/EmailVerifyTokenValidateRequest.md)
|
718
721
|
- [UltracartClient::EmailVerifyTokenValidateResponse](docs/EmailVerifyTokenValidateResponse.md)
|
722
|
+
- [UltracartClient::EmailWebhookEditorValuesResponse](docs/EmailWebhookEditorValuesResponse.md)
|
719
723
|
- [UltracartClient::Error](docs/Error.md)
|
720
724
|
- [UltracartClient::ErrorResponse](docs/ErrorResponse.md)
|
721
725
|
- [UltracartClient::Experiment](docs/Experiment.md)
|
@@ -1112,6 +1116,10 @@ Not every change is committed to every SDK.
|
|
1112
1116
|
|
1113
1117
|
| Version | Date | Comments |
|
1114
1118
|
| --: | :-: | --- |
|
1119
|
+
| 3.5.1 | 08/11/2021 | email webhook test method |
|
1120
|
+
| 3.5.0 | 08/11/2021 | RestOrderChannelPartner.store_completed was incorrectly defaulting to true |
|
1121
|
+
| 3.4.13 | 08/10/2021 | configuration api - changed some field types form string to number |
|
1122
|
+
| 3.4.12 | 08/10/2021 | email engine - added webhook editor values for internal ui |
|
1115
1123
|
| 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names |
|
1116
1124
|
| 3.4.8 | 08/04/2021 | configuration api - payments config refactoring |
|
1117
1125
|
| 3.4.7 | 08/04/2021 | esp folders for lists/segments |
|
@@ -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
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::EmailWebhookEditorValuesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**available_expansions** | **Array<String>** | | [optional]
|
7
|
+
**available_tokens** | **Array<String>** | | [optional]
|
8
|
+
**error** | [**Error**](Error.md) | | [optional]
|
9
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
10
|
+
**rest_object_type** | **String** | | [optional]
|
11
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
12
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
13
|
+
|
14
|
+
|
data/docs/OrderChannelPartner.md
CHANGED
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
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
|
|
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
|
|
8
8
|
**credit_card** | **String** | Credit card type | [optional]
|
9
9
|
**deposit_to_account** | **String** | The name of the account to deposit funds | [optional]
|
10
10
|
**enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional]
|
11
|
-
**processing_fee** | **
|
12
|
-
**processing_percentage** | **
|
11
|
+
**processing_fee** | **Float** | Optional additional fee applied to order for this card | [optional]
|
12
|
+
**processing_percentage** | **Float** | Optional additional fee applied to order for this card | [optional]
|
13
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** | **
|
15
|
-
**transaction_percentage** | **
|
14
|
+
**transaction_fee** | **Float** | An optional additional fee to charge the customer for using this card. | [optional]
|
15
|
+
**transaction_percentage** | **Float** | An optional transaction percentage to charge the customer for using this card | [optional]
|
16
16
|
|
17
17
|
|
@@ -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]
|
@@ -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
@@ -44,6 +44,7 @@ Method | HTTP request | Description
|
|
44
44
|
[**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
45
45
|
[**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
46
46
|
[**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
47
|
+
[**get_email_commseq_webhook_editor_values**](StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values
|
47
48
|
[**get_email_commseqs**](StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs
|
48
49
|
[**get_email_customer_editor_url**](StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL
|
49
50
|
[**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
|
@@ -133,6 +134,7 @@ Method | HTTP request | Description
|
|
133
134
|
[**search_shared_items**](StorefrontApi.md#search_shared_items) | **POST** /storefront/code_library/search_shared | Retrieve library items
|
134
135
|
[**send_email_test**](StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
|
135
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
|
136
138
|
[**start_email_campaign**](StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
|
137
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
|
138
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
|
@@ -2193,6 +2195,57 @@ Name | Type | Description | Notes
|
|
2193
2195
|
|
2194
2196
|
|
2195
2197
|
|
2198
|
+
# **get_email_commseq_webhook_editor_values**
|
2199
|
+
> EmailWebhookEditorValuesResponse get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid)
|
2200
|
+
|
2201
|
+
Get email webhook editor values
|
2202
|
+
|
2203
|
+
### Example
|
2204
|
+
```ruby
|
2205
|
+
# load the gem
|
2206
|
+
require 'ultracart_api'
|
2207
|
+
|
2208
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2209
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2210
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
2211
|
+
|
2212
|
+
|
2213
|
+
storefront_oid = 56 # Integer |
|
2214
|
+
|
2215
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
2216
|
+
|
2217
|
+
|
2218
|
+
begin
|
2219
|
+
#Get email webhook editor values
|
2220
|
+
result = api_instance.get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid)
|
2221
|
+
p result
|
2222
|
+
rescue UltracartClient::ApiError => e
|
2223
|
+
puts "Exception when calling StorefrontApi->get_email_commseq_webhook_editor_values: #{e}"
|
2224
|
+
end
|
2225
|
+
```
|
2226
|
+
|
2227
|
+
### Parameters
|
2228
|
+
|
2229
|
+
Name | Type | Description | Notes
|
2230
|
+
------------- | ------------- | ------------- | -------------
|
2231
|
+
**storefront_oid** | **Integer**| |
|
2232
|
+
**commseq_uuid** | **String**| |
|
2233
|
+
|
2234
|
+
### Return type
|
2235
|
+
|
2236
|
+
[**EmailWebhookEditorValuesResponse**](EmailWebhookEditorValuesResponse.md)
|
2237
|
+
|
2238
|
+
### Authorization
|
2239
|
+
|
2240
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2241
|
+
|
2242
|
+
### HTTP request headers
|
2243
|
+
|
2244
|
+
- **Content-Type**: application/json
|
2245
|
+
- **Accept**: application/json
|
2246
|
+
|
2247
|
+
|
2248
|
+
|
2196
2249
|
# **get_email_commseqs**
|
2197
2250
|
> EmailCommseqsResponse get_email_commseqs(storefront_oid)
|
2198
2251
|
|
@@ -6799,6 +6852,57 @@ Name | Type | Description | Notes
|
|
6799
6852
|
|
6800
6853
|
|
6801
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
|
+
|
6802
6906
|
# **start_email_campaign**
|
6803
6907
|
> BaseResponse start_email_campaign(storefront_oid, email_campaign_uuid)
|
6804
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'
|
@@ -315,6 +316,7 @@ require 'ultracart_api/models/email_verify_token_request'
|
|
315
316
|
require 'ultracart_api/models/email_verify_token_response'
|
316
317
|
require 'ultracart_api/models/email_verify_token_validate_request'
|
317
318
|
require 'ultracart_api/models/email_verify_token_validate_response'
|
319
|
+
require 'ultracart_api/models/email_webhook_editor_values_response'
|
318
320
|
require 'ultracart_api/models/error'
|
319
321
|
require 'ultracart_api/models/error_response'
|
320
322
|
require 'ultracart_api/models/experiment'
|
@@ -2369,6 +2369,65 @@ module UltracartClient
|
|
2369
2369
|
end
|
2370
2370
|
return data, status_code, headers
|
2371
2371
|
end
|
2372
|
+
# Get email webhook editor values
|
2373
|
+
# @param storefront_oid
|
2374
|
+
# @param commseq_uuid
|
2375
|
+
# @param [Hash] opts the optional parameters
|
2376
|
+
# @return [EmailWebhookEditorValuesResponse]
|
2377
|
+
def get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid, opts = {})
|
2378
|
+
data, _status_code, _headers = get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts)
|
2379
|
+
data
|
2380
|
+
end
|
2381
|
+
|
2382
|
+
# Get email webhook editor values
|
2383
|
+
# @param storefront_oid
|
2384
|
+
# @param commseq_uuid
|
2385
|
+
# @param [Hash] opts the optional parameters
|
2386
|
+
# @return [Array<(EmailWebhookEditorValuesResponse, Fixnum, Hash)>] EmailWebhookEditorValuesResponse data, response status code and response headers
|
2387
|
+
def get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts = {})
|
2388
|
+
if @api_client.config.debugging
|
2389
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_webhook_editor_values ...'
|
2390
|
+
end
|
2391
|
+
# verify the required parameter 'storefront_oid' is set
|
2392
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
2393
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
|
2394
|
+
end
|
2395
|
+
# verify the required parameter 'commseq_uuid' is set
|
2396
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
2397
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
|
2398
|
+
end
|
2399
|
+
# resource path
|
2400
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)
|
2401
|
+
|
2402
|
+
# query parameters
|
2403
|
+
query_params = {}
|
2404
|
+
|
2405
|
+
# header parameters
|
2406
|
+
header_params = {}
|
2407
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2408
|
+
# HTTP header 'Accept' (if needed)
|
2409
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2410
|
+
# HTTP header 'Content-Type'
|
2411
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2412
|
+
|
2413
|
+
# form parameters
|
2414
|
+
form_params = {}
|
2415
|
+
|
2416
|
+
# http body (model)
|
2417
|
+
post_body = nil
|
2418
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
2419
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2420
|
+
:header_params => header_params,
|
2421
|
+
:query_params => query_params,
|
2422
|
+
:form_params => form_params,
|
2423
|
+
:body => post_body,
|
2424
|
+
:auth_names => auth_names,
|
2425
|
+
:return_type => 'EmailWebhookEditorValuesResponse')
|
2426
|
+
if @api_client.config.debugging
|
2427
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_webhook_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2428
|
+
end
|
2429
|
+
return data, status_code, headers
|
2430
|
+
end
|
2372
2431
|
# Get email commseqs
|
2373
2432
|
# @param storefront_oid
|
2374
2433
|
# @param [Hash] opts the optional parameters
|
@@ -7602,6 +7661,65 @@ module UltracartClient
|
|
7602
7661
|
end
|
7603
7662
|
return data, status_code, headers
|
7604
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
|
7605
7723
|
# Start email campaign
|
7606
7724
|
# @param storefront_oid
|
7607
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
|
@@ -0,0 +1,243 @@
|
|
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 EmailWebhookEditorValuesResponse
|
17
|
+
attr_accessor :available_expansions
|
18
|
+
|
19
|
+
attr_accessor :available_tokens
|
20
|
+
|
21
|
+
attr_accessor :error
|
22
|
+
|
23
|
+
attr_accessor :metadata
|
24
|
+
|
25
|
+
attr_accessor :rest_object_type
|
26
|
+
|
27
|
+
# Indicates if API call was successful
|
28
|
+
attr_accessor :success
|
29
|
+
|
30
|
+
attr_accessor :warning
|
31
|
+
|
32
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
33
|
+
def self.attribute_map
|
34
|
+
{
|
35
|
+
:'available_expansions' => :'available_expansions',
|
36
|
+
:'available_tokens' => :'available_tokens',
|
37
|
+
:'error' => :'error',
|
38
|
+
:'metadata' => :'metadata',
|
39
|
+
:'rest_object_type' => :'rest_object_type',
|
40
|
+
:'success' => :'success',
|
41
|
+
:'warning' => :'warning'
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
# Attribute type mapping.
|
46
|
+
def self.swagger_types
|
47
|
+
{
|
48
|
+
:'available_expansions' => :'Array<String>',
|
49
|
+
:'available_tokens' => :'Array<String>',
|
50
|
+
:'error' => :'Error',
|
51
|
+
:'metadata' => :'ResponseMetadata',
|
52
|
+
:'rest_object_type' => :'String',
|
53
|
+
:'success' => :'BOOLEAN',
|
54
|
+
:'warning' => :'Warning'
|
55
|
+
}
|
56
|
+
end
|
57
|
+
|
58
|
+
# Initializes the object
|
59
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
60
|
+
def initialize(attributes = {})
|
61
|
+
return unless attributes.is_a?(Hash)
|
62
|
+
|
63
|
+
# convert string to symbol for hash key
|
64
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
65
|
+
|
66
|
+
if attributes.has_key?(:'available_expansions')
|
67
|
+
if (value = attributes[:'available_expansions']).is_a?(Array)
|
68
|
+
self.available_expansions = value
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.has_key?(:'available_tokens')
|
73
|
+
if (value = attributes[:'available_tokens']).is_a?(Array)
|
74
|
+
self.available_tokens = value
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
if attributes.has_key?(:'error')
|
79
|
+
self.error = attributes[:'error']
|
80
|
+
end
|
81
|
+
|
82
|
+
if attributes.has_key?(:'metadata')
|
83
|
+
self.metadata = attributes[:'metadata']
|
84
|
+
end
|
85
|
+
|
86
|
+
if attributes.has_key?(:'rest_object_type')
|
87
|
+
self.rest_object_type = attributes[:'rest_object_type']
|
88
|
+
end
|
89
|
+
|
90
|
+
if attributes.has_key?(:'success')
|
91
|
+
self.success = attributes[:'success']
|
92
|
+
end
|
93
|
+
|
94
|
+
if attributes.has_key?(:'warning')
|
95
|
+
self.warning = attributes[:'warning']
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
100
|
+
# @return Array for valid properties with the reasons
|
101
|
+
def list_invalid_properties
|
102
|
+
invalid_properties = Array.new
|
103
|
+
invalid_properties
|
104
|
+
end
|
105
|
+
|
106
|
+
# Check to see if the all the properties in the model are valid
|
107
|
+
# @return true if the model is valid
|
108
|
+
def valid?
|
109
|
+
true
|
110
|
+
end
|
111
|
+
|
112
|
+
# Checks equality by comparing each attribute.
|
113
|
+
# @param [Object] Object to be compared
|
114
|
+
def ==(o)
|
115
|
+
return true if self.equal?(o)
|
116
|
+
self.class == o.class &&
|
117
|
+
available_expansions == o.available_expansions &&
|
118
|
+
available_tokens == o.available_tokens &&
|
119
|
+
error == o.error &&
|
120
|
+
metadata == o.metadata &&
|
121
|
+
rest_object_type == o.rest_object_type &&
|
122
|
+
success == o.success &&
|
123
|
+
warning == o.warning
|
124
|
+
end
|
125
|
+
|
126
|
+
# @see the `==` method
|
127
|
+
# @param [Object] Object to be compared
|
128
|
+
def eql?(o)
|
129
|
+
self == o
|
130
|
+
end
|
131
|
+
|
132
|
+
# Calculates hash code according to all attributes.
|
133
|
+
# @return [Fixnum] Hash code
|
134
|
+
def hash
|
135
|
+
[available_expansions, available_tokens, error, metadata, rest_object_type, success, warning].hash
|
136
|
+
end
|
137
|
+
|
138
|
+
# Builds the object from hash
|
139
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
140
|
+
# @return [Object] Returns the model itself
|
141
|
+
def build_from_hash(attributes)
|
142
|
+
return nil unless attributes.is_a?(Hash)
|
143
|
+
self.class.swagger_types.each_pair do |key, type|
|
144
|
+
if type =~ /\AArray<(.*)>/i
|
145
|
+
# check to ensure the input is an array given that the attribute
|
146
|
+
# is documented as an array but the input is not
|
147
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
148
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
149
|
+
end
|
150
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
151
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
152
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
153
|
+
end
|
154
|
+
|
155
|
+
self
|
156
|
+
end
|
157
|
+
|
158
|
+
# Deserializes the data based on type
|
159
|
+
# @param string type Data type
|
160
|
+
# @param string value Value to be deserialized
|
161
|
+
# @return [Object] Deserialized data
|
162
|
+
def _deserialize(type, value)
|
163
|
+
case type.to_sym
|
164
|
+
when :DateTime
|
165
|
+
DateTime.parse(value)
|
166
|
+
when :Date
|
167
|
+
Date.parse(value)
|
168
|
+
when :String
|
169
|
+
value.to_s
|
170
|
+
when :Integer
|
171
|
+
value.to_i
|
172
|
+
when :Float
|
173
|
+
value.to_f
|
174
|
+
when :BOOLEAN
|
175
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
176
|
+
true
|
177
|
+
else
|
178
|
+
false
|
179
|
+
end
|
180
|
+
when :Object
|
181
|
+
# generic object (usually a Hash), return directly
|
182
|
+
value
|
183
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
184
|
+
inner_type = Regexp.last_match[:inner_type]
|
185
|
+
value.map { |v| _deserialize(inner_type, v) }
|
186
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
187
|
+
k_type = Regexp.last_match[:k_type]
|
188
|
+
v_type = Regexp.last_match[:v_type]
|
189
|
+
{}.tap do |hash|
|
190
|
+
value.each do |k, v|
|
191
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
192
|
+
end
|
193
|
+
end
|
194
|
+
else # model
|
195
|
+
temp_model = UltracartClient.const_get(type).new
|
196
|
+
temp_model.build_from_hash(value)
|
197
|
+
end
|
198
|
+
end
|
199
|
+
|
200
|
+
# Returns the string representation of the object
|
201
|
+
# @return [String] String presentation of the object
|
202
|
+
def to_s
|
203
|
+
to_hash.to_s
|
204
|
+
end
|
205
|
+
|
206
|
+
# to_body is an alias to to_hash (backward compatibility)
|
207
|
+
# @return [Hash] Returns the object in the form of hash
|
208
|
+
def to_body
|
209
|
+
to_hash
|
210
|
+
end
|
211
|
+
|
212
|
+
# Returns the object in the form of hash
|
213
|
+
# @return [Hash] Returns the object in the form of hash
|
214
|
+
def to_hash
|
215
|
+
hash = {}
|
216
|
+
self.class.attribute_map.each_pair do |attr, param|
|
217
|
+
value = self.send(attr)
|
218
|
+
next if value.nil?
|
219
|
+
hash[param] = _to_hash(value)
|
220
|
+
end
|
221
|
+
hash
|
222
|
+
end
|
223
|
+
|
224
|
+
# Outputs non-array value in the form of hash
|
225
|
+
# For object, use to_hash. Otherwise, just return the value
|
226
|
+
# @param [Object] value Any valid value
|
227
|
+
# @return [Hash] Returns the value in the form of hash
|
228
|
+
def _to_hash(value)
|
229
|
+
if value.is_a?(Array)
|
230
|
+
value.compact.map { |v| _to_hash(v) }
|
231
|
+
elsif value.is_a?(Hash)
|
232
|
+
{}.tap do |hash|
|
233
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
234
|
+
end
|
235
|
+
elsif value.respond_to? :to_hash
|
236
|
+
value.to_hash
|
237
|
+
else
|
238
|
+
value
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
end
|
243
|
+
end
|
@@ -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.
|
@@ -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
|
|
@@ -90,11 +90,11 @@ module UltracartClient
|
|
90
90
|
:'credit_card' => :'String',
|
91
91
|
:'deposit_to_account' => :'String',
|
92
92
|
:'enabled' => :'BOOLEAN',
|
93
|
-
:'processing_fee' => :'
|
94
|
-
:'processing_percentage' => :'
|
93
|
+
:'processing_fee' => :'Float',
|
94
|
+
:'processing_percentage' => :'Float',
|
95
95
|
:'surcharge_accounting_code' => :'String',
|
96
|
-
:'transaction_fee' => :'
|
97
|
-
:'transaction_percentage' => :'
|
96
|
+
:'transaction_fee' => :'Float',
|
97
|
+
:'transaction_percentage' => :'Float'
|
98
98
|
}
|
99
99
|
end
|
100
100
|
|
@@ -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',
|
@@ -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.1
|
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-11 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
|
@@ -506,6 +507,7 @@ files:
|
|
506
507
|
- docs/EmailVerifyTokenResponse.md
|
507
508
|
- docs/EmailVerifyTokenValidateRequest.md
|
508
509
|
- docs/EmailVerifyTokenValidateResponse.md
|
510
|
+
- docs/EmailWebhookEditorValuesResponse.md
|
509
511
|
- docs/Error.md
|
510
512
|
- docs/ErrorResponse.md
|
511
513
|
- docs/Experiment.md
|
@@ -1091,6 +1093,7 @@ files:
|
|
1091
1093
|
- lib/ultracart_api/models/email_commseq_step.rb
|
1092
1094
|
- lib/ultracart_api/models/email_commseq_step_log.rb
|
1093
1095
|
- lib/ultracart_api/models/email_commseq_step_logs_response.rb
|
1096
|
+
- lib/ultracart_api/models/email_commseq_webhook_send_test_request.rb
|
1094
1097
|
- lib/ultracart_api/models/email_commseqs_response.rb
|
1095
1098
|
- lib/ultracart_api/models/email_customer.rb
|
1096
1099
|
- lib/ultracart_api/models/email_customer_editor_url_response.rb
|
@@ -1168,6 +1171,7 @@ files:
|
|
1168
1171
|
- lib/ultracart_api/models/email_verify_token_response.rb
|
1169
1172
|
- lib/ultracart_api/models/email_verify_token_validate_request.rb
|
1170
1173
|
- lib/ultracart_api/models/email_verify_token_validate_response.rb
|
1174
|
+
- lib/ultracart_api/models/email_webhook_editor_values_response.rb
|
1171
1175
|
- lib/ultracart_api/models/error.rb
|
1172
1176
|
- lib/ultracart_api/models/error_response.rb
|
1173
1177
|
- lib/ultracart_api/models/experiment.rb
|