ultracart_api 3.4.6 → 3.4.7

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: abdcb875151f2365cc95ec8ee697e30cdf7e6e7802d18e6ca368ecdd8874d444
4
- data.tar.gz: 335ad17c98e9658f69723a3233f60fd892126666d2d401bdb8334931563e2720
3
+ metadata.gz: 6d32ebd5e5e349c6349a42f8ca2d21db241e7a6a10caeeea5d0ea2b475b93802
4
+ data.tar.gz: d104fa317a4fd655526dfefac7a7ea16ee1ab1a0809bdcf3e0b0029d569d6c45
5
5
  SHA512:
6
- metadata.gz: 0cdea5e196a653e18f44ffb53461d385b1ac5bec66da25651c9df5004a89ddca4e1d1fbe9a9c44ef424aefea4a08118a36e67874045b240ec6bb17e068857e90
7
- data.tar.gz: b9cbccdcc7b6a89bf99ab504985b89ff7f5ffc524546ab215db0fbb3add2e66b60da9926e9824f3a1f3b9e473151e24a5bfab2a61c682ed0ea13fae5e245a114
6
+ metadata.gz: a3bc3f7707db8b4f13f2e6716ee70b12ffa6e4105f2e94ebd0d5e414b631e0ff1865d255d8f121d0a0dc5a33abad88ec9b0d6c329e95398b4a42049dcc5ee3b2
7
+ data.tar.gz: b49103cb03613a3f0a33ded21fcbc185a6021a6ea00d4ca81c90471578206b4e2bd845007b8a12164e99c5694fcdb6a8a7242358c4acf0ae216980f250af705b
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.4.6
10
+ - Package version: 3.4.7
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.4.6.gem
27
+ gem install ./ultracart_api-3.4.7.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.4.6.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.4.7.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.4.6'
35
+ gem 'ultracart_api', '~> 3.4.7'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -228,6 +228,7 @@ Class | Method | HTTP request | Description
228
228
  *UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
229
229
  *UltracartClient::StorefrontApi* | [**delete_email_flow_folder**](docs/StorefrontApi.md#delete_email_flow_folder) | **DELETE** /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} | Delete email flowFolder
230
230
  *UltracartClient::StorefrontApi* | [**delete_email_list_customer**](docs/StorefrontApi.md#delete_email_list_customer) | **DELETE** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid} | Delete email list customer
231
+ *UltracartClient::StorefrontApi* | [**delete_email_list_segment_folder**](docs/StorefrontApi.md#delete_email_list_segment_folder) | **DELETE** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Delete email ListSegmentFolder
231
232
  *UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
232
233
  *UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
233
234
  *UltracartClient::StorefrontApi* | [**delete_experiment**](docs/StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
@@ -274,6 +275,8 @@ Class | Method | HTTP request | Description
274
275
  *UltracartClient::StorefrontApi* | [**get_email_list**](docs/StorefrontApi.md#get_email_list) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid} | Get email list
275
276
  *UltracartClient::StorefrontApi* | [**get_email_list_customer_editor_url**](docs/StorefrontApi.md#get_email_list_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url | Get email list customer editor url
276
277
  *UltracartClient::StorefrontApi* | [**get_email_list_customers**](docs/StorefrontApi.md#get_email_list_customers) | **GET** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers | Get email list customers
278
+ *UltracartClient::StorefrontApi* | [**get_email_list_segment_folder**](docs/StorefrontApi.md#get_email_list_segment_folder) | **GET** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Get email campaign folder
279
+ *UltracartClient::StorefrontApi* | [**get_email_list_segment_folders**](docs/StorefrontApi.md#get_email_list_segment_folders) | **GET** /storefront/{storefront_oid}/email/list_segment_folders | Get email campaign folders
277
280
  *UltracartClient::StorefrontApi* | [**get_email_lists**](docs/StorefrontApi.md#get_email_lists) | **GET** /storefront/{storefront_oid}/email/lists | Get email lists
278
281
  *UltracartClient::StorefrontApi* | [**get_email_performance**](docs/StorefrontApi.md#get_email_performance) | **GET** /storefront/{storefront_oid}/email/performance | Get email performance
279
282
  *UltracartClient::StorefrontApi* | [**get_email_plan**](docs/StorefrontApi.md#get_email_plan) | **GET** /storefront/{storefront_oid}/email/plan | Get email plan
@@ -321,6 +324,7 @@ Class | Method | HTTP request | Description
321
324
  *UltracartClient::StorefrontApi* | [**insert_email_flow**](docs/StorefrontApi.md#insert_email_flow) | **POST** /storefront/{storefront_oid}/email/flows | Insert email flow
322
325
  *UltracartClient::StorefrontApi* | [**insert_email_flow_folder**](docs/StorefrontApi.md#insert_email_flow_folder) | **POST** /storefront/{storefront_oid}/email/flow_folders | Insert email flow folder
323
326
  *UltracartClient::StorefrontApi* | [**insert_email_list**](docs/StorefrontApi.md#insert_email_list) | **POST** /storefront/{storefront_oid}/email/lists | Insert email list
327
+ *UltracartClient::StorefrontApi* | [**insert_email_list_segment_folder**](docs/StorefrontApi.md#insert_email_list_segment_folder) | **POST** /storefront/{storefront_oid}/email/list_segment_folders | Insert email campaign folder
324
328
  *UltracartClient::StorefrontApi* | [**insert_email_postcard**](docs/StorefrontApi.md#insert_email_postcard) | **POST** /storefront/{storefront_oid}/email/postcards | Insert email postcard
325
329
  *UltracartClient::StorefrontApi* | [**insert_email_segment**](docs/StorefrontApi.md#insert_email_segment) | **POST** /storefront/{storefront_oid}/email/segments | Insert email segment
326
330
  *UltracartClient::StorefrontApi* | [**insert_screen_recording_segment**](docs/StorefrontApi.md#insert_screen_recording_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments | Insert screen recording segment
@@ -351,6 +355,7 @@ Class | Method | HTTP request | Description
351
355
  *UltracartClient::StorefrontApi* | [**update_email_flow_folder**](docs/StorefrontApi.md#update_email_flow_folder) | **PUT** /storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid} | Update email flow folder
352
356
  *UltracartClient::StorefrontApi* | [**update_email_global_settings**](docs/StorefrontApi.md#update_email_global_settings) | **POST** /storefront/email/global_settings | Update email global settings
353
357
  *UltracartClient::StorefrontApi* | [**update_email_list**](docs/StorefrontApi.md#update_email_list) | **PUT** /storefront/{storefront_oid}/email/lists/{email_list_uuid} | Update email list
358
+ *UltracartClient::StorefrontApi* | [**update_email_list_segment_folder**](docs/StorefrontApi.md#update_email_list_segment_folder) | **PUT** /storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid} | Update email campaign folder
354
359
  *UltracartClient::StorefrontApi* | [**update_email_plan**](docs/StorefrontApi.md#update_email_plan) | **POST** /storefront/{storefront_oid}/email/plan | Update email plan
355
360
  *UltracartClient::StorefrontApi* | [**update_email_postcard**](docs/StorefrontApi.md#update_email_postcard) | **PUT** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Update email postcard
356
361
  *UltracartClient::StorefrontApi* | [**update_email_segment**](docs/StorefrontApi.md#update_email_segment) | **PUT** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Update email segment
@@ -662,6 +667,9 @@ Class | Method | HTTP request | Description
662
667
  - [UltracartClient::EmailListCustomer](docs/EmailListCustomer.md)
663
668
  - [UltracartClient::EmailListCustomersResponse](docs/EmailListCustomersResponse.md)
664
669
  - [UltracartClient::EmailListResponse](docs/EmailListResponse.md)
670
+ - [UltracartClient::EmailListSegmentFolder](docs/EmailListSegmentFolder.md)
671
+ - [UltracartClient::EmailListSegmentFolderResponse](docs/EmailListSegmentFolderResponse.md)
672
+ - [UltracartClient::EmailListSegmentFoldersResponse](docs/EmailListSegmentFoldersResponse.md)
665
673
  - [UltracartClient::EmailListSegmentMembership](docs/EmailListSegmentMembership.md)
666
674
  - [UltracartClient::EmailListSegmentUsedBy](docs/EmailListSegmentUsedBy.md)
667
675
  - [UltracartClient::EmailListSubscribeResponse](docs/EmailListSubscribeResponse.md)
@@ -1099,6 +1107,7 @@ Not every change is committed to every SDK.
1099
1107
 
1100
1108
  | Version | Date | Comments |
1101
1109
  | --: | :-: | --- |
1110
+ | 3.4.7 | 08/04/2021 | esp folders for lists/segments |
1102
1111
  | 3.4.5 | 08/03/2021 | configuration api bug fix for a bad response object on updateRotatingTransactionGateway |
1103
1112
  | 3.4.3 | 08/03/2021 | package tracking - add event_iso_date and event_timezone_id |
1104
1113
  | 3.4.2 | 07/29/2021 | bug fixes for new configuration api |
data/docs/EmailList.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **created_dts** | **String** | Created date | [optional]
8
8
  **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional]
9
9
  **email_list_uuid** | **String** | Email list UUID | [optional]
10
+ **esp_list_segment_folder_uuid** | **String** | List/Segment folder UUID | [optional]
10
11
  **member_count** | **Integer** | Count of members in this list | [optional]
11
12
  **merchant_id** | **String** | Merchant ID | [optional]
12
13
  **name** | **String** | Name of email list | [optional]
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailListSegmentFolder
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **esp_list_segment_folder_uuid** | **String** | Email list segment folder UUID | [optional]
7
+ **merchant_id** | **String** | Merchant ID | [optional]
8
+ **name** | **String** | Name of email campaign folder | [optional]
9
+ **storefront_oid** | **Integer** | Storefront oid | [optional]
10
+ **system_generated** | **BOOLEAN** | System generated folder | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailListSegmentFolderResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **list_segment_folder** | [**EmailListSegmentFolder**](EmailListSegmentFolder.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::EmailListSegmentFoldersResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **list_segment_folders** | [**Array<EmailListSegmentFolder>**](EmailListSegmentFolder.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
data/docs/EmailSegment.md CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **created_dts** | **String** | Created date | [optional]
9
9
  **deleted** | **BOOLEAN** | True if this campaign was deleted | [optional]
10
10
  **email_segment_uuid** | **String** | Email segment UUID | [optional]
11
+ **esp_list_segment_folder_uuid** | **String** | List/Segment folder UUID | [optional]
11
12
  **facebook_custom_audience** | **BOOLEAN** | True if you want to sync to a facebook custom audience | [optional]
12
13
  **filter_profile_equation_json** | **String** | File profile equation json | [optional]
13
14
  **member_count** | **Integer** | Count of members in this segment | [optional]
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
10
10
  **configured_gateways_details** | **String** | | [optional]
11
11
  **failed_attempts** | **String** | | [optional]
12
12
  **hide_connect_single_gateway** | **BOOLEAN** | | [optional]
13
- **immediate_finalize_domains** | **String** | | [optional]
14
13
  **send_customer_billing_update_on_decline** | **BOOLEAN** | | [optional]
15
14
 
16
15
 
@@ -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