ultracart_api 3.4.5 → 3.4.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +17 -4
- data/docs/EmailList.md +1 -0
- data/docs/EmailListSegmentFolder.md +12 -0
- data/docs/EmailListSegmentFolderResponse.md +12 -0
- data/docs/EmailListSegmentFoldersResponse.md +12 -0
- data/docs/EmailSegment.md +1 -0
- data/docs/PaymentsConfiguration.md +5 -3
- data/docs/PaymentsConfigurationAffirm.md +7 -7
- data/docs/PaymentsConfigurationAmazon.md +7 -7
- data/docs/PaymentsConfigurationCOD.md +5 -5
- data/docs/PaymentsConfigurationCash.md +1 -1
- data/docs/PaymentsConfigurationCheck.md +12 -17
- data/docs/PaymentsConfigurationCreditCard.md +11 -9
- data/docs/PaymentsConfigurationEcheck.md +11 -0
- data/docs/PaymentsConfigurationLoanHero.md +4 -4
- data/docs/PaymentsConfigurationMoneyOrder.md +11 -0
- data/docs/PaymentsConfigurationPayPal.md +28 -28
- data/docs/PaymentsConfigurationPurchaseOrder.md +3 -3
- data/docs/PaymentsConfigurationQuoteRequest.md +2 -2
- data/docs/PaymentsConfigurationRestrictions.md +12 -12
- data/docs/PaymentsConfigurationSezzle.md +8 -7
- data/docs/PaymentsConfigurationWePay.md +26 -26
- data/docs/PaymentsConfigurationWireTransfer.md +10 -10
- data/docs/RotatingTransactionGateway.md +4 -3
- data/docs/StorefrontApi.md +260 -0
- data/lib/ultracart_api.rb +5 -0
- data/lib/ultracart_api/api/storefront_api.rb +295 -0
- data/lib/ultracart_api/models/email_list.rb +11 -1
- data/lib/ultracart_api/models/email_list_segment_folder.rb +240 -0
- data/lib/ultracart_api/models/email_list_segment_folder_response.rb +221 -0
- data/lib/ultracart_api/models/email_list_segment_folders_response.rb +223 -0
- data/lib/ultracart_api/models/email_segment.rb +11 -1
- data/lib/ultracart_api/models/payments_configuration.rb +50 -31
- data/lib/ultracart_api/models/payments_configuration_affirm.rb +81 -40
- data/lib/ultracart_api/models/payments_configuration_amazon.rb +51 -44
- data/lib/ultracart_api/models/payments_configuration_cash.rb +4 -3
- data/lib/ultracart_api/models/payments_configuration_check.rb +70 -103
- data/lib/ultracart_api/models/payments_configuration_cod.rb +39 -34
- data/lib/ultracart_api/models/payments_configuration_credit_card.rb +68 -39
- data/lib/ultracart_api/models/payments_configuration_echeck.rb +214 -0
- data/lib/ultracart_api/models/payments_configuration_loan_hero.rb +23 -19
- data/lib/ultracart_api/models/payments_configuration_money_order.rb +214 -0
- data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +270 -172
- data/lib/ultracart_api/models/payments_configuration_purchase_order.rb +19 -16
- data/lib/ultracart_api/models/payments_configuration_quote_request.rb +12 -10
- data/lib/ultracart_api/models/payments_configuration_restrictions.rb +48 -36
- data/lib/ultracart_api/models/payments_configuration_sezzle.rb +97 -46
- data/lib/ultracart_api/models/payments_configuration_we_pay.rb +186 -160
- data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +71 -61
- data/lib/ultracart_api/models/rotating_transaction_gateway.rb +13 -3
- data/lib/ultracart_api/version.rb +1 -1
- metadata +12 -2
@@ -3,17 +3,17 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**maximum_subtotal** | **String** |
|
7
|
-
**minimum_subtotal** | **String** |
|
8
|
-
**payment_method** | **String** |
|
9
|
-
**restriction_alaska_hawaii** | **String** |
|
10
|
-
**restriction_apo_fpo** | **String** |
|
11
|
-
**restriction_canada** | **String** |
|
12
|
-
**restriction_continental_us** | **String** |
|
13
|
-
**restriction_domestic_only** | **String** |
|
14
|
-
**restriction_international_only** | **String** |
|
15
|
-
**restriction_po_box** | **String** |
|
16
|
-
**restriction_puerto_rico** | **String** |
|
17
|
-
**restriction_us_territories** | **String** |
|
6
|
+
**maximum_subtotal** | **String** | Maximum subtotal | [optional]
|
7
|
+
**minimum_subtotal** | **String** | Minimum subtotal | [optional]
|
8
|
+
**payment_method** | **String** | Payment method | [optional]
|
9
|
+
**restriction_alaska_hawaii** | **String** | Alaska and Hawaii restriction | [optional]
|
10
|
+
**restriction_apo_fpo** | **String** | APO/FPO restriction | [optional]
|
11
|
+
**restriction_canada** | **String** | Canada restriction | [optional]
|
12
|
+
**restriction_continental_us** | **String** | Continental US restriction | [optional]
|
13
|
+
**restriction_domestic_only** | **String** | Domestic only restriction | [optional]
|
14
|
+
**restriction_international_only** | **String** | International only restriction | [optional]
|
15
|
+
**restriction_po_box** | **String** | PO Box restriction | [optional]
|
16
|
+
**restriction_puerto_rico** | **String** | Puerto Rico restriction | [optional]
|
17
|
+
**restriction_us_territories** | **String** | US Territories restriction | [optional]
|
18
18
|
|
19
19
|
|
@@ -3,13 +3,14 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**accept_sezzle** | **BOOLEAN** |
|
6
|
+
**accept_sezzle** | **BOOLEAN** | Master flag for this merchant accepting Sezzle payments | [optional]
|
7
|
+
**accounting_code** | **String** | Optional Quickbooks code for this payment method | [optional]
|
8
|
+
**business_id** | **String** | Business ID | [optional]
|
9
|
+
**deposit_to_account** | **String** | Optional Quickbooks Deposit to Account value | [optional]
|
10
|
+
**environment** | **String** | Sezzle environment | [optional]
|
11
|
+
**environments** | **Object** | List of environments possible | [optional]
|
12
|
+
**private_api_key** | **String** | Private API key | [optional]
|
13
|
+
**public_api_key** | **String** | Public API key | [optional]
|
7
14
|
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
8
|
-
**sezzle_accounting_code** | **String** | | [optional]
|
9
|
-
**sezzle_business_id** | **String** | | [optional]
|
10
|
-
**sezzle_deposit_to_account** | **String** | | [optional]
|
11
|
-
**sezzle_environment** | **String** | | [optional]
|
12
|
-
**sezzle_private_api_key** | **String** | | [optional]
|
13
|
-
**sezzle_public_api_key** | **String** | | [optional]
|
14
15
|
|
15
16
|
|
@@ -3,33 +3,33 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**accept_wepay** | **BOOLEAN** |
|
7
|
-
**
|
8
|
-
**
|
6
|
+
**accept_wepay** | **BOOLEAN** | Master flag indicating this merchant accepts UltraCart Payments WePay | [optional]
|
7
|
+
**account_update_uri** | **String** | URI for updating the WePay account | [optional]
|
8
|
+
**address1** | **String** | Address line 1 | [optional]
|
9
|
+
**address2** | **String** | Address line 2 | [optional]
|
10
|
+
**canada_accept_debit_cards** | **BOOLEAN** | For Canadian merchants, true if they wish to accept debit cards | [optional]
|
11
|
+
**city** | **String** | City | [optional]
|
12
|
+
**company** | **String** | Company | [optional]
|
13
|
+
**company_description** | **String** | Company description | [optional]
|
14
|
+
**console_hostname** | **String** | Console hostname | [optional]
|
15
|
+
**country** | **String** | Country | [optional]
|
16
|
+
**currency** | **String** | Base currency for transactions | [optional]
|
17
|
+
**expected_revenue** | **String** | Expected Revenue | [optional]
|
18
|
+
**hide_credit_card_non_ultracart_payments** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
19
|
+
**hide_surcharge_amount** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
20
|
+
**industry** | **String** | Industry | [optional]
|
21
|
+
**owner_email** | **String** | Owner email | [optional]
|
22
|
+
**owner_name** | **String** | Owner name | [optional]
|
23
|
+
**owner_phone** | **String** | Owner phone | [optional]
|
24
|
+
**postal_code** | **String** | Postal code | [optional]
|
9
25
|
**remove_pay_pal_pro** | **BOOLEAN** | | [optional]
|
10
26
|
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**wepay_address2** | **String** | | [optional]
|
19
|
-
**wepay_canada_accept_debit_cards** | **BOOLEAN** | | [optional]
|
20
|
-
**wepay_city** | **String** | | [optional]
|
21
|
-
**wepay_company** | **String** | | [optional]
|
22
|
-
**wepay_company_description** | **String** | | [optional]
|
23
|
-
**wepay_console_hostname** | **String** | | [optional]
|
24
|
-
**wepay_country** | **String** | | [optional]
|
25
|
-
**wepay_currency** | **String** | | [optional]
|
26
|
-
**wepay_expected_revenue** | **String** | | [optional]
|
27
|
-
**wepay_industry** | **String** | | [optional]
|
28
|
-
**wepay_owner_email** | **String** | | [optional]
|
29
|
-
**wepay_owner_name** | **String** | | [optional]
|
30
|
-
**wepay_owner_phone** | **String** | | [optional]
|
31
|
-
**wepay_state** | **String** | | [optional]
|
32
|
-
**wepay_website_url** | **String** | | [optional]
|
33
|
-
**wepay_zip** | **String** | | [optional]
|
27
|
+
**short_paypal_marketing_text** | **BOOLEAN** | Internal UI aid | [optional]
|
28
|
+
**show_ultracart_payments_disabled** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
29
|
+
**show_ultracart_payments_intro** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
30
|
+
**show_ultracart_payments_verification** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
31
|
+
**show_ultracart_payments_verified** | **BOOLEAN** | Internal flag to aid UI | [optional]
|
32
|
+
**state** | **String** | State | [optional]
|
33
|
+
**website_url** | **String** | Website URL | [optional]
|
34
34
|
|
35
35
|
|
@@ -3,16 +3,16 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**accept_wire_transfer** | **BOOLEAN** |
|
6
|
+
**accept_wire_transfer** | **BOOLEAN** | Master flag indicating this merchant accepts wire transfers | [optional]
|
7
|
+
**account_number** | **String** | account_number | [optional]
|
8
|
+
**accounting_code** | **String** | Optional Quickbooks accounting code | [optional]
|
9
|
+
**bank_address** | **String** | Bank address | [optional]
|
10
|
+
**deposit_to_account** | **String** | Optional Quickbooks deposit to account | [optional]
|
11
|
+
**intermediate_routing_number** | **String** | Intermediate routing number | [optional]
|
7
12
|
**restrictions** | [**PaymentsConfigurationRestrictions**](PaymentsConfigurationRestrictions.md) | | [optional]
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**wire_transfer_intermediate_routing_number** | **String** | | [optional]
|
13
|
-
**wire_transfer_routing_number** | **String** | | [optional]
|
14
|
-
**wire_transfer_surcharge_accounting_code** | **String** | | [optional]
|
15
|
-
**wire_transfer_surcharge_fee** | **String** | | [optional]
|
16
|
-
**wire_transfer_surcharge_perc** | **String** | | [optional]
|
13
|
+
**routing_number** | **String** | Routing number | [optional]
|
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** | **String** | surcharge_fee | [optional]
|
16
|
+
**surcharge_percentage** | **String** | surcharge_percentage | [optional]
|
17
17
|
|
18
18
|
|
@@ -43,8 +43,9 @@ Name | Type | Description | Notes
|
|
43
43
|
**status** | **String** | A field used to take a gateway offline without removing/deleting the configuration. Inactive marks the gateway as completely unusable. Standby takes the gateway offline and will not be used unless all other active gateways fail. | [optional]
|
44
44
|
**theme_restrictions** | [**Array<RtgThemeRestriction>**](RtgThemeRestriction.md) | Optional restrictions by theme/storefront | [optional]
|
45
45
|
**traffic_percentage** | **Float** | Required field between 0 and 1 that dictates the percentage of traffic that should flow through this gateway | [optional]
|
46
|
-
**trial_daily_amount** | **Integer** | If specified, limits the total daily
|
47
|
-
**trial_daily_limit** | **Integer** | If specified, limits the total
|
48
|
-
**
|
46
|
+
**trial_daily_amount** | **Integer** | If specified, limits the total daily count of trial orders | [optional]
|
47
|
+
**trial_daily_limit** | **Integer** | If specified, limits the total daily dollar amount of trial orders | [optional]
|
48
|
+
**trial_monthly_amount** | **Integer** | If specified, limits the total month dollar amount of trial orders | [optional]
|
49
|
+
**trial_monthly_limit** | **Integer** | If specified, limits the total month count of trial orders | [optional]
|
49
50
|
|
50
51
|
|
data/docs/StorefrontApi.md
CHANGED
@@ -18,6 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
[**delete_email_email**](StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
19
19
|
[**delete_email_flow_folder**](StorefrontApi.md#delete_email_flow_folder) | **DELETE** /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} | Delete email flowFolder
|
20
20
|
[**delete_email_list_customer**](StorefrontApi.md#delete_email_list_customer) | **DELETE** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid} | Delete email list customer
|
21
|
+
[**delete_email_list_segment_folder**](StorefrontApi.md#delete_email_list_segment_folder) | **DELETE** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Delete email ListSegmentFolder
|
21
22
|
[**delete_email_postcard**](StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
|
22
23
|
[**delete_email_sending_domain**](StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
|
23
24
|
[**delete_experiment**](StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
|
@@ -64,6 +65,8 @@ Method | HTTP request | Description
|
|
64
65
|
[**get_email_list**](StorefrontApi.md#get_email_list) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid} | Get email list
|
65
66
|
[**get_email_list_customer_editor_url**](StorefrontApi.md#get_email_list_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url | Get email list customer editor url
|
66
67
|
[**get_email_list_customers**](StorefrontApi.md#get_email_list_customers) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers | Get email list customers
|
68
|
+
[**get_email_list_segment_folder**](StorefrontApi.md#get_email_list_segment_folder) | **GET** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Get email campaign folder
|
69
|
+
[**get_email_list_segment_folders**](StorefrontApi.md#get_email_list_segment_folders) | **GET** /storefront/{storefront_oid}/email/list_segment_folders | Get email campaign folders
|
67
70
|
[**get_email_lists**](StorefrontApi.md#get_email_lists) | **GET** /storefront/{storefront_oid}/email/lists | Get email lists
|
68
71
|
[**get_email_performance**](StorefrontApi.md#get_email_performance) | **GET** /storefront/{storefront_oid}/email/performance | Get email performance
|
69
72
|
[**get_email_plan**](StorefrontApi.md#get_email_plan) | **GET** /storefront/{storefront_oid}/email/plan | Get email plan
|
@@ -111,6 +114,7 @@ Method | HTTP request | Description
|
|
111
114
|
[**insert_email_flow**](StorefrontApi.md#insert_email_flow) | **POST** /storefront/{storefront_oid}/email/flows | Insert email flow
|
112
115
|
[**insert_email_flow_folder**](StorefrontApi.md#insert_email_flow_folder) | **POST** /storefront/{storefront_oid}/email/flow_folders | Insert email flow folder
|
113
116
|
[**insert_email_list**](StorefrontApi.md#insert_email_list) | **POST** /storefront/{storefront_oid}/email/lists | Insert email list
|
117
|
+
[**insert_email_list_segment_folder**](StorefrontApi.md#insert_email_list_segment_folder) | **POST** /storefront/{storefront_oid}/email/list_segment_folders | Insert email campaign folder
|
114
118
|
[**insert_email_postcard**](StorefrontApi.md#insert_email_postcard) | **POST** /storefront/{storefront_oid}/email/postcards | Insert email postcard
|
115
119
|
[**insert_email_segment**](StorefrontApi.md#insert_email_segment) | **POST** /storefront/{storefront_oid}/email/segments | Insert email segment
|
116
120
|
[**insert_screen_recording_segment**](StorefrontApi.md#insert_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments | Insert screen recording segment
|
@@ -141,6 +145,7 @@ Method | HTTP request | Description
|
|
141
145
|
[**update_email_flow_folder**](StorefrontApi.md#update_email_flow_folder) | **PUT** /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} | Update email flow folder
|
142
146
|
[**update_email_global_settings**](StorefrontApi.md#update_email_global_settings) | **POST** /storefront/email/global_settings | Update email global settings
|
143
147
|
[**update_email_list**](StorefrontApi.md#update_email_list) | **PUT** /storefront/{storefront_oid}/email/lists/{email_list_uuid} | Update email list
|
148
|
+
[**update_email_list_segment_folder**](StorefrontApi.md#update_email_list_segment_folder) | **PUT** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Update email campaign folder
|
144
149
|
[**update_email_plan**](StorefrontApi.md#update_email_plan) | **POST** /storefront/{storefront_oid}/email/plan | Update email plan
|
145
150
|
[**update_email_postcard**](StorefrontApi.md#update_email_postcard) | **PUT** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Update email postcard
|
146
151
|
[**update_email_segment**](StorefrontApi.md#update_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Update email segment
|
@@ -875,6 +880,57 @@ Name | Type | Description | Notes
|
|
875
880
|
|
876
881
|
|
877
882
|
|
883
|
+
# **delete_email_list_segment_folder**
|
884
|
+
> BaseResponse delete_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid)
|
885
|
+
|
886
|
+
Delete email ListSegmentFolder
|
887
|
+
|
888
|
+
### Example
|
889
|
+
```ruby
|
890
|
+
# load the gem
|
891
|
+
require 'ultracart_api'
|
892
|
+
|
893
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
894
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
895
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
896
|
+
|
897
|
+
|
898
|
+
storefront_oid = 56 # Integer |
|
899
|
+
|
900
|
+
email_list_segment_folder_uuid = 'email_list_segment_folder_uuid_example' # String |
|
901
|
+
|
902
|
+
|
903
|
+
begin
|
904
|
+
#Delete email ListSegmentFolder
|
905
|
+
result = api_instance.delete_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid)
|
906
|
+
p result
|
907
|
+
rescue UltracartClient::ApiError => e
|
908
|
+
puts "Exception when calling StorefrontApi->delete_email_list_segment_folder: #{e}"
|
909
|
+
end
|
910
|
+
```
|
911
|
+
|
912
|
+
### Parameters
|
913
|
+
|
914
|
+
Name | Type | Description | Notes
|
915
|
+
------------- | ------------- | ------------- | -------------
|
916
|
+
**storefront_oid** | **Integer**| |
|
917
|
+
**email_list_segment_folder_uuid** | **String**| |
|
918
|
+
|
919
|
+
### Return type
|
920
|
+
|
921
|
+
[**BaseResponse**](BaseResponse.md)
|
922
|
+
|
923
|
+
### Authorization
|
924
|
+
|
925
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
926
|
+
|
927
|
+
### HTTP request headers
|
928
|
+
|
929
|
+
- **Content-Type**: application/json
|
930
|
+
- **Accept**: application/json
|
931
|
+
|
932
|
+
|
933
|
+
|
878
934
|
# **delete_email_postcard**
|
879
935
|
> BaseResponse delete_email_postcard(storefront_oid, commseq_postcard_uuid)
|
880
936
|
|
@@ -3230,6 +3286,105 @@ Name | Type | Description | Notes
|
|
3230
3286
|
|
3231
3287
|
|
3232
3288
|
|
3289
|
+
# **get_email_list_segment_folder**
|
3290
|
+
> EmailListSegmentFolderResponse get_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid)
|
3291
|
+
|
3292
|
+
Get email campaign folder
|
3293
|
+
|
3294
|
+
### Example
|
3295
|
+
```ruby
|
3296
|
+
# load the gem
|
3297
|
+
require 'ultracart_api'
|
3298
|
+
|
3299
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
3300
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
3301
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
3302
|
+
|
3303
|
+
|
3304
|
+
storefront_oid = 56 # Integer |
|
3305
|
+
|
3306
|
+
email_list_segment_folder_uuid = 'email_list_segment_folder_uuid_example' # String |
|
3307
|
+
|
3308
|
+
|
3309
|
+
begin
|
3310
|
+
#Get email campaign folder
|
3311
|
+
result = api_instance.get_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid)
|
3312
|
+
p result
|
3313
|
+
rescue UltracartClient::ApiError => e
|
3314
|
+
puts "Exception when calling StorefrontApi->get_email_list_segment_folder: #{e}"
|
3315
|
+
end
|
3316
|
+
```
|
3317
|
+
|
3318
|
+
### Parameters
|
3319
|
+
|
3320
|
+
Name | Type | Description | Notes
|
3321
|
+
------------- | ------------- | ------------- | -------------
|
3322
|
+
**storefront_oid** | **Integer**| |
|
3323
|
+
**email_list_segment_folder_uuid** | **String**| |
|
3324
|
+
|
3325
|
+
### Return type
|
3326
|
+
|
3327
|
+
[**EmailListSegmentFolderResponse**](EmailListSegmentFolderResponse.md)
|
3328
|
+
|
3329
|
+
### Authorization
|
3330
|
+
|
3331
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3332
|
+
|
3333
|
+
### HTTP request headers
|
3334
|
+
|
3335
|
+
- **Content-Type**: application/json
|
3336
|
+
- **Accept**: application/json
|
3337
|
+
|
3338
|
+
|
3339
|
+
|
3340
|
+
# **get_email_list_segment_folders**
|
3341
|
+
> EmailListSegmentFoldersResponse get_email_list_segment_folders(storefront_oid)
|
3342
|
+
|
3343
|
+
Get email campaign folders
|
3344
|
+
|
3345
|
+
### Example
|
3346
|
+
```ruby
|
3347
|
+
# load the gem
|
3348
|
+
require 'ultracart_api'
|
3349
|
+
|
3350
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
3351
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
3352
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
3353
|
+
|
3354
|
+
|
3355
|
+
storefront_oid = 56 # Integer |
|
3356
|
+
|
3357
|
+
|
3358
|
+
begin
|
3359
|
+
#Get email campaign folders
|
3360
|
+
result = api_instance.get_email_list_segment_folders(storefront_oid)
|
3361
|
+
p result
|
3362
|
+
rescue UltracartClient::ApiError => e
|
3363
|
+
puts "Exception when calling StorefrontApi->get_email_list_segment_folders: #{e}"
|
3364
|
+
end
|
3365
|
+
```
|
3366
|
+
|
3367
|
+
### Parameters
|
3368
|
+
|
3369
|
+
Name | Type | Description | Notes
|
3370
|
+
------------- | ------------- | ------------- | -------------
|
3371
|
+
**storefront_oid** | **Integer**| |
|
3372
|
+
|
3373
|
+
### Return type
|
3374
|
+
|
3375
|
+
[**EmailListSegmentFoldersResponse**](EmailListSegmentFoldersResponse.md)
|
3376
|
+
|
3377
|
+
### Authorization
|
3378
|
+
|
3379
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3380
|
+
|
3381
|
+
### HTTP request headers
|
3382
|
+
|
3383
|
+
- **Content-Type**: application/json
|
3384
|
+
- **Accept**: application/json
|
3385
|
+
|
3386
|
+
|
3387
|
+
|
3233
3388
|
# **get_email_lists**
|
3234
3389
|
> EmailListsResponse get_email_lists(storefront_oid)
|
3235
3390
|
|
@@ -5624,6 +5779,57 @@ Name | Type | Description | Notes
|
|
5624
5779
|
|
5625
5780
|
|
5626
5781
|
|
5782
|
+
# **insert_email_list_segment_folder**
|
5783
|
+
> EmailListSegmentFolderResponse insert_email_list_segment_folder(storefront_oid, email_list_segment_folder)
|
5784
|
+
|
5785
|
+
Insert email campaign folder
|
5786
|
+
|
5787
|
+
### Example
|
5788
|
+
```ruby
|
5789
|
+
# load the gem
|
5790
|
+
require 'ultracart_api'
|
5791
|
+
|
5792
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
5793
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
5794
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
5795
|
+
|
5796
|
+
|
5797
|
+
storefront_oid = 56 # Integer |
|
5798
|
+
|
5799
|
+
email_list_segment_folder = UltracartClient::EmailListSegmentFolder.new # EmailListSegmentFolder | Email campaign folder
|
5800
|
+
|
5801
|
+
|
5802
|
+
begin
|
5803
|
+
#Insert email campaign folder
|
5804
|
+
result = api_instance.insert_email_list_segment_folder(storefront_oid, email_list_segment_folder)
|
5805
|
+
p result
|
5806
|
+
rescue UltracartClient::ApiError => e
|
5807
|
+
puts "Exception when calling StorefrontApi->insert_email_list_segment_folder: #{e}"
|
5808
|
+
end
|
5809
|
+
```
|
5810
|
+
|
5811
|
+
### Parameters
|
5812
|
+
|
5813
|
+
Name | Type | Description | Notes
|
5814
|
+
------------- | ------------- | ------------- | -------------
|
5815
|
+
**storefront_oid** | **Integer**| |
|
5816
|
+
**email_list_segment_folder** | [**EmailListSegmentFolder**](EmailListSegmentFolder.md)| Email campaign folder |
|
5817
|
+
|
5818
|
+
### Return type
|
5819
|
+
|
5820
|
+
[**EmailListSegmentFolderResponse**](EmailListSegmentFolderResponse.md)
|
5821
|
+
|
5822
|
+
### Authorization
|
5823
|
+
|
5824
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
5825
|
+
|
5826
|
+
### HTTP request headers
|
5827
|
+
|
5828
|
+
- **Content-Type**: application/json
|
5829
|
+
- **Accept**: application/json
|
5830
|
+
|
5831
|
+
|
5832
|
+
|
5627
5833
|
# **insert_email_postcard**
|
5628
5834
|
> EmailCommseqPostcardResponse insert_email_postcard(storefront_oid, email_commseq_postcard)
|
5629
5835
|
|
@@ -7229,6 +7435,60 @@ Name | Type | Description | Notes
|
|
7229
7435
|
|
7230
7436
|
|
7231
7437
|
|
7438
|
+
# **update_email_list_segment_folder**
|
7439
|
+
> EmailListSegmentFolderResponse update_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder)
|
7440
|
+
|
7441
|
+
Update email campaign folder
|
7442
|
+
|
7443
|
+
### Example
|
7444
|
+
```ruby
|
7445
|
+
# load the gem
|
7446
|
+
require 'ultracart_api'
|
7447
|
+
|
7448
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
7449
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
7450
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
7451
|
+
|
7452
|
+
|
7453
|
+
storefront_oid = 56 # Integer |
|
7454
|
+
|
7455
|
+
email_list_segment_folder_uuid = 'email_list_segment_folder_uuid_example' # String |
|
7456
|
+
|
7457
|
+
email_list_segment_folder = UltracartClient::EmailListSegmentFolder.new # EmailListSegmentFolder | Email campaign folder
|
7458
|
+
|
7459
|
+
|
7460
|
+
begin
|
7461
|
+
#Update email campaign folder
|
7462
|
+
result = api_instance.update_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder)
|
7463
|
+
p result
|
7464
|
+
rescue UltracartClient::ApiError => e
|
7465
|
+
puts "Exception when calling StorefrontApi->update_email_list_segment_folder: #{e}"
|
7466
|
+
end
|
7467
|
+
```
|
7468
|
+
|
7469
|
+
### Parameters
|
7470
|
+
|
7471
|
+
Name | Type | Description | Notes
|
7472
|
+
------------- | ------------- | ------------- | -------------
|
7473
|
+
**storefront_oid** | **Integer**| |
|
7474
|
+
**email_list_segment_folder_uuid** | **String**| |
|
7475
|
+
**email_list_segment_folder** | [**EmailListSegmentFolder**](EmailListSegmentFolder.md)| Email campaign folder |
|
7476
|
+
|
7477
|
+
### Return type
|
7478
|
+
|
7479
|
+
[**EmailListSegmentFolderResponse**](EmailListSegmentFolderResponse.md)
|
7480
|
+
|
7481
|
+
### Authorization
|
7482
|
+
|
7483
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
7484
|
+
|
7485
|
+
### HTTP request headers
|
7486
|
+
|
7487
|
+
- **Content-Type**: application/json
|
7488
|
+
- **Accept**: application/json
|
7489
|
+
|
7490
|
+
|
7491
|
+
|
7232
7492
|
# **update_email_plan**
|
7233
7493
|
> EmailPlanResponse update_email_plan(storefront_oid, settings)
|
7234
7494
|
|