ultracart_api 4.1.229 → 4.1.230

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/docs/SfvbApi.md CHANGED
@@ -7,6 +7,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
7
7
  | [**add_sfvb_page_blog_posts**](SfvbApi.md#add_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/add | Assign blog posts to a page |
8
8
  | [**add_sfvb_page_items**](SfvbApi.md#add_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/add | Assign items to a page |
9
9
  | [**archive_sfvb_campaign**](SfvbApi.md#archive_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/archive | Archive or unarchive a campaign |
10
+ | [**archive_sfvb_comms_list**](SfvbApi.md#archive_sfvb_comms_list) | **PUT** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/archive | Archive an email list |
11
+ | [**archive_sfvb_comms_segment**](SfvbApi.md#archive_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/archive | Archive a segment |
10
12
  | [**archive_sfvb_flow**](SfvbApi.md#archive_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/archive | Archive or unarchive a flow |
11
13
  | [**archive_sfvb_upsell_path**](SfvbApi.md#archive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/archive | Archive an upsell path |
12
14
  | [**attach_sfvb_blog_post_image**](SfvbApi.md#attach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/attach | Attach an image to a blog post |
@@ -23,6 +25,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
23
25
  | [**delete_sfvb_affiliate_network**](SfvbApi.md#delete_sfvb_affiliate_network) | **DELETE** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Delete an affiliate network |
24
26
  | [**delete_sfvb_approval**](SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request |
25
27
  | [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
28
+ | [**delete_sfvb_comms_folder**](SfvbApi.md#delete_sfvb_comms_folder) | **DELETE** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Delete a list and segment folder |
26
29
  | [**delete_sfvb_comms_sending_domain**](SfvbApi.md#delete_sfvb_comms_sending_domain) | **DELETE** /sfvb/comms/sending_domains/{domain} | Remove a sending domain |
27
30
  | [**delete_sfvb_comms_twilio_account**](SfvbApi.md#delete_sfvb_comms_twilio_account) | **DELETE** /sfvb/comms/twilio_account | Remove the Twilio account |
28
31
  | [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
@@ -67,6 +70,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
67
70
  | [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
68
71
  | [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
69
72
  | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
73
+ | [**get_sfvb_comms_folder**](SfvbApi.md#get_sfvb_comms_folder) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Read one list and segment folder |
74
+ | [**get_sfvb_comms_folders**](SfvbApi.md#get_sfvb_comms_folders) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders | List the list and segment folders |
75
+ | [**get_sfvb_comms_list**](SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list |
70
76
  | [**get_sfvb_comms_segment**](SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule |
71
77
  | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
72
78
  | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
@@ -141,6 +147,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
141
147
  | [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
142
148
  | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
143
149
  | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
150
+ | [**insert_sfvb_comms_folder**](SfvbApi.md#insert_sfvb_comms_folder) | **POST** /sfvb/storefronts/{storefront_oid}/list_segment_folders | Create a list and segment folder |
151
+ | [**insert_sfvb_comms_list**](SfvbApi.md#insert_sfvb_comms_list) | **POST** /sfvb/storefronts/{storefront_oid}/lists | Create an email list |
144
152
  | [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
145
153
  | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
146
154
  | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
@@ -227,6 +235,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
227
235
  | [**update_sfvb_affiliate_network**](SfvbApi.md#update_sfvb_affiliate_network) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Change an affiliate network |
228
236
  | [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
229
237
  | [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
238
+ | [**update_sfvb_comms_folder**](SfvbApi.md#update_sfvb_comms_folder) | **PUT** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Rename a list and segment folder |
239
+ | [**update_sfvb_comms_list**](SfvbApi.md#update_sfvb_comms_list) | **PUT** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Change an email list's name, folder or public settings |
230
240
  | [**update_sfvb_comms_segment**](SfvbApi.md#update_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Change a segment's name, rule or folder |
231
241
  | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
232
242
  | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
@@ -417,6 +427,116 @@ end
417
427
  - **Accept**: application/json
418
428
 
419
429
 
430
+ ## archive_sfvb_comms_list
431
+
432
+ > <SfvbCommsListResponse> archive_sfvb_comms_list(storefront_oid, list_uuid, if_match)
433
+
434
+ Archive an email list
435
+
436
+ Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren't live, which can no longer use it. Send the list's hash_sha256 as If-Match.
437
+
438
+
439
+ ### Examples
440
+
441
+
442
+ (No example for this operation).
443
+
444
+
445
+ #### Using the archive_sfvb_comms_list_with_http_info variant
446
+
447
+ This returns an Array which contains the response data, status code and headers.
448
+
449
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> archive_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match)
450
+
451
+ ```ruby
452
+ begin
453
+ # Archive an email list
454
+ data, status_code, headers = api_instance.archive_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match)
455
+ p status_code # => 2xx
456
+ p headers # => { ... }
457
+ p data # => <SfvbCommsListResponse>
458
+ rescue UltracartClient::ApiError => e
459
+ puts "Error when calling SfvbApi->archive_sfvb_comms_list_with_http_info: #{e}"
460
+ end
461
+ ```
462
+
463
+ ### Parameters
464
+
465
+ | Name | Type | Description | Notes |
466
+ | ---- | ---- | ----------- | ----- |
467
+ | **storefront_oid** | **Integer** | | |
468
+ | **list_uuid** | **String** | | |
469
+ | **if_match** | **String** | The list&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
470
+
471
+ ### Return type
472
+
473
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
474
+
475
+ ### Authorization
476
+
477
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: Not defined
482
+ - **Accept**: application/json
483
+
484
+
485
+ ## archive_sfvb_comms_segment
486
+
487
+ > <SfvbCommsSegmentResponse> archive_sfvb_comms_segment(storefront_oid, segment_uuid, if_match)
488
+
489
+ Archive a segment
490
+
491
+ Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren't live, which can no longer use it. Send the segment's hash_sha256 as If-Match.
492
+
493
+
494
+ ### Examples
495
+
496
+
497
+ (No example for this operation).
498
+
499
+
500
+ #### Using the archive_sfvb_comms_segment_with_http_info variant
501
+
502
+ This returns an Array which contains the response data, status code and headers.
503
+
504
+ > <Array(<SfvbCommsSegmentResponse>, Integer, Hash)> archive_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match)
505
+
506
+ ```ruby
507
+ begin
508
+ # Archive a segment
509
+ data, status_code, headers = api_instance.archive_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match)
510
+ p status_code # => 2xx
511
+ p headers # => { ... }
512
+ p data # => <SfvbCommsSegmentResponse>
513
+ rescue UltracartClient::ApiError => e
514
+ puts "Error when calling SfvbApi->archive_sfvb_comms_segment_with_http_info: #{e}"
515
+ end
516
+ ```
517
+
518
+ ### Parameters
519
+
520
+ | Name | Type | Description | Notes |
521
+ | ---- | ---- | ----------- | ----- |
522
+ | **storefront_oid** | **Integer** | | |
523
+ | **segment_uuid** | **String** | | |
524
+ | **if_match** | **String** | The segment&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
525
+
526
+ ### Return type
527
+
528
+ [**SfvbCommsSegmentResponse**](SfvbCommsSegmentResponse.md)
529
+
530
+ ### Authorization
531
+
532
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
533
+
534
+ ### HTTP request headers
535
+
536
+ - **Content-Type**: Not defined
537
+ - **Accept**: application/json
538
+
539
+
420
540
  ## archive_sfvb_flow
421
541
 
422
542
  > <SfvbFlow> archive_sfvb_flow(storefront_oid, flow_uuid, if_match, archive_request)
@@ -1285,6 +1405,61 @@ nil (empty response body)
1285
1405
  - **Accept**: application/json
1286
1406
 
1287
1407
 
1408
+ ## delete_sfvb_comms_folder
1409
+
1410
+ > <SfvbCommsFolderResponse> delete_sfvb_comms_folder(storefront_oid, folder_uuid, if_match)
1411
+
1412
+ Delete a list and segment folder
1413
+
1414
+ Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be deleted here.
1415
+
1416
+
1417
+ ### Examples
1418
+
1419
+
1420
+ (No example for this operation).
1421
+
1422
+
1423
+ #### Using the delete_sfvb_comms_folder_with_http_info variant
1424
+
1425
+ This returns an Array which contains the response data, status code and headers.
1426
+
1427
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> delete_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match)
1428
+
1429
+ ```ruby
1430
+ begin
1431
+ # Delete a list and segment folder
1432
+ data, status_code, headers = api_instance.delete_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match)
1433
+ p status_code # => 2xx
1434
+ p headers # => { ... }
1435
+ p data # => <SfvbCommsFolderResponse>
1436
+ rescue UltracartClient::ApiError => e
1437
+ puts "Error when calling SfvbApi->delete_sfvb_comms_folder_with_http_info: #{e}"
1438
+ end
1439
+ ```
1440
+
1441
+ ### Parameters
1442
+
1443
+ | Name | Type | Description | Notes |
1444
+ | ---- | ---- | ----------- | ----- |
1445
+ | **storefront_oid** | **Integer** | | |
1446
+ | **folder_uuid** | **String** | | |
1447
+ | **if_match** | **String** | The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
1448
+
1449
+ ### Return type
1450
+
1451
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
1452
+
1453
+ ### Authorization
1454
+
1455
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1456
+
1457
+ ### HTTP request headers
1458
+
1459
+ - **Content-Type**: Not defined
1460
+ - **Accept**: application/json
1461
+
1462
+
1288
1463
  ## delete_sfvb_comms_sending_domain
1289
1464
 
1290
1465
  > delete_sfvb_comms_sending_domain(domain, opts)
@@ -3680,6 +3855,167 @@ end
3680
3855
  - **Accept**: application/json
3681
3856
 
3682
3857
 
3858
+ ## get_sfvb_comms_folder
3859
+
3860
+ > <SfvbCommsFolderResponse> get_sfvb_comms_folder(storefront_oid, folder_uuid)
3861
+
3862
+ Read one list and segment folder
3863
+
3864
+ The folder, with the name and uuid of each list and segment filed in it.
3865
+
3866
+
3867
+ ### Examples
3868
+
3869
+
3870
+ (No example for this operation).
3871
+
3872
+
3873
+ #### Using the get_sfvb_comms_folder_with_http_info variant
3874
+
3875
+ This returns an Array which contains the response data, status code and headers.
3876
+
3877
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid)
3878
+
3879
+ ```ruby
3880
+ begin
3881
+ # Read one list and segment folder
3882
+ data, status_code, headers = api_instance.get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid)
3883
+ p status_code # => 2xx
3884
+ p headers # => { ... }
3885
+ p data # => <SfvbCommsFolderResponse>
3886
+ rescue UltracartClient::ApiError => e
3887
+ puts "Error when calling SfvbApi->get_sfvb_comms_folder_with_http_info: #{e}"
3888
+ end
3889
+ ```
3890
+
3891
+ ### Parameters
3892
+
3893
+ | Name | Type | Description | Notes |
3894
+ | ---- | ---- | ----------- | ----- |
3895
+ | **storefront_oid** | **Integer** | | |
3896
+ | **folder_uuid** | **String** | | |
3897
+
3898
+ ### Return type
3899
+
3900
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
3901
+
3902
+ ### Authorization
3903
+
3904
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3905
+
3906
+ ### HTTP request headers
3907
+
3908
+ - **Content-Type**: Not defined
3909
+ - **Accept**: application/json
3910
+
3911
+
3912
+ ## get_sfvb_comms_folders
3913
+
3914
+ > <SfvbCommsFoldersResponse> get_sfvb_comms_folders(storefront_oid)
3915
+
3916
+ List the list and segment folders
3917
+
3918
+ Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
3919
+
3920
+
3921
+ ### Examples
3922
+
3923
+
3924
+ (No example for this operation).
3925
+
3926
+
3927
+ #### Using the get_sfvb_comms_folders_with_http_info variant
3928
+
3929
+ This returns an Array which contains the response data, status code and headers.
3930
+
3931
+ > <Array(<SfvbCommsFoldersResponse>, Integer, Hash)> get_sfvb_comms_folders_with_http_info(storefront_oid)
3932
+
3933
+ ```ruby
3934
+ begin
3935
+ # List the list and segment folders
3936
+ data, status_code, headers = api_instance.get_sfvb_comms_folders_with_http_info(storefront_oid)
3937
+ p status_code # => 2xx
3938
+ p headers # => { ... }
3939
+ p data # => <SfvbCommsFoldersResponse>
3940
+ rescue UltracartClient::ApiError => e
3941
+ puts "Error when calling SfvbApi->get_sfvb_comms_folders_with_http_info: #{e}"
3942
+ end
3943
+ ```
3944
+
3945
+ ### Parameters
3946
+
3947
+ | Name | Type | Description | Notes |
3948
+ | ---- | ---- | ----------- | ----- |
3949
+ | **storefront_oid** | **Integer** | | |
3950
+
3951
+ ### Return type
3952
+
3953
+ [**SfvbCommsFoldersResponse**](SfvbCommsFoldersResponse.md)
3954
+
3955
+ ### Authorization
3956
+
3957
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3958
+
3959
+ ### HTTP request headers
3960
+
3961
+ - **Content-Type**: Not defined
3962
+ - **Accept**: application/json
3963
+
3964
+
3965
+ ## get_sfvb_comms_list
3966
+
3967
+ > <SfvbCommsListResponse> get_sfvb_comms_list(storefront_oid, list_uuid)
3968
+
3969
+ Read one email list
3970
+
3971
+ The list's name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
3972
+
3973
+
3974
+ ### Examples
3975
+
3976
+
3977
+ (No example for this operation).
3978
+
3979
+
3980
+ #### Using the get_sfvb_comms_list_with_http_info variant
3981
+
3982
+ This returns an Array which contains the response data, status code and headers.
3983
+
3984
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid)
3985
+
3986
+ ```ruby
3987
+ begin
3988
+ # Read one email list
3989
+ data, status_code, headers = api_instance.get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid)
3990
+ p status_code # => 2xx
3991
+ p headers # => { ... }
3992
+ p data # => <SfvbCommsListResponse>
3993
+ rescue UltracartClient::ApiError => e
3994
+ puts "Error when calling SfvbApi->get_sfvb_comms_list_with_http_info: #{e}"
3995
+ end
3996
+ ```
3997
+
3998
+ ### Parameters
3999
+
4000
+ | Name | Type | Description | Notes |
4001
+ | ---- | ---- | ----------- | ----- |
4002
+ | **storefront_oid** | **Integer** | | |
4003
+ | **list_uuid** | **String** | | |
4004
+
4005
+ ### Return type
4006
+
4007
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
4008
+
4009
+ ### Authorization
4010
+
4011
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4012
+
4013
+ ### HTTP request headers
4014
+
4015
+ - **Content-Type**: Not defined
4016
+ - **Accept**: application/json
4017
+
4018
+
3683
4019
  ## get_sfvb_comms_segment
3684
4020
 
3685
4021
  > <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
@@ -7680,6 +8016,114 @@ end
7680
8016
  - **Accept**: application/json
7681
8017
 
7682
8018
 
8019
+ ## insert_sfvb_comms_folder
8020
+
8021
+ > <SfvbCommsFolderResponse> insert_sfvb_comms_folder(storefront_oid, folder_write_request)
8022
+
8023
+ Create a list and segment folder
8024
+
8025
+ A new, empty folder. File a list or segment in it by setting its folder_uuid.
8026
+
8027
+
8028
+ ### Examples
8029
+
8030
+
8031
+ (No example for this operation).
8032
+
8033
+
8034
+ #### Using the insert_sfvb_comms_folder_with_http_info variant
8035
+
8036
+ This returns an Array which contains the response data, status code and headers.
8037
+
8038
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request)
8039
+
8040
+ ```ruby
8041
+ begin
8042
+ # Create a list and segment folder
8043
+ data, status_code, headers = api_instance.insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request)
8044
+ p status_code # => 2xx
8045
+ p headers # => { ... }
8046
+ p data # => <SfvbCommsFolderResponse>
8047
+ rescue UltracartClient::ApiError => e
8048
+ puts "Error when calling SfvbApi->insert_sfvb_comms_folder_with_http_info: #{e}"
8049
+ end
8050
+ ```
8051
+
8052
+ ### Parameters
8053
+
8054
+ | Name | Type | Description | Notes |
8055
+ | ---- | ---- | ----------- | ----- |
8056
+ | **storefront_oid** | **Integer** | | |
8057
+ | **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new folder&#39;s name | |
8058
+
8059
+ ### Return type
8060
+
8061
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
8062
+
8063
+ ### Authorization
8064
+
8065
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8066
+
8067
+ ### HTTP request headers
8068
+
8069
+ - **Content-Type**: application/json
8070
+ - **Accept**: application/json
8071
+
8072
+
8073
+ ## insert_sfvb_comms_list
8074
+
8075
+ > <SfvbCommsListResponse> insert_sfvb_comms_list(storefront_oid, list_write_request)
8076
+
8077
+ Create an email list
8078
+
8079
+ A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
8080
+
8081
+
8082
+ ### Examples
8083
+
8084
+
8085
+ (No example for this operation).
8086
+
8087
+
8088
+ #### Using the insert_sfvb_comms_list_with_http_info variant
8089
+
8090
+ This returns an Array which contains the response data, status code and headers.
8091
+
8092
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request)
8093
+
8094
+ ```ruby
8095
+ begin
8096
+ # Create an email list
8097
+ data, status_code, headers = api_instance.insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request)
8098
+ p status_code # => 2xx
8099
+ p headers # => { ... }
8100
+ p data # => <SfvbCommsListResponse>
8101
+ rescue UltracartClient::ApiError => e
8102
+ puts "Error when calling SfvbApi->insert_sfvb_comms_list_with_http_info: #{e}"
8103
+ end
8104
+ ```
8105
+
8106
+ ### Parameters
8107
+
8108
+ | Name | Type | Description | Notes |
8109
+ | ---- | ---- | ----------- | ----- |
8110
+ | **storefront_oid** | **Integer** | | |
8111
+ | **list_write_request** | [**SfvbCommsListWriteRequest**](SfvbCommsListWriteRequest.md) | The new list&#39;s name, folder and public settings | |
8112
+
8113
+ ### Return type
8114
+
8115
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
8116
+
8117
+ ### Authorization
8118
+
8119
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8120
+
8121
+ ### HTTP request headers
8122
+
8123
+ - **Content-Type**: application/json
8124
+ - **Accept**: application/json
8125
+
8126
+
7683
8127
  ## insert_sfvb_comms_segment
7684
8128
 
7685
8129
  > <SfvbCommsSegmentResponse> insert_sfvb_comms_segment(storefront_oid, segment_write_request)
@@ -12426,6 +12870,118 @@ end
12426
12870
  - **Accept**: application/json
12427
12871
 
12428
12872
 
12873
+ ## update_sfvb_comms_folder
12874
+
12875
+ > <SfvbCommsFolderResponse> update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
12876
+
12877
+ Rename a list and segment folder
12878
+
12879
+ Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
12880
+
12881
+
12882
+ ### Examples
12883
+
12884
+
12885
+ (No example for this operation).
12886
+
12887
+
12888
+ #### Using the update_sfvb_comms_folder_with_http_info variant
12889
+
12890
+ This returns an Array which contains the response data, status code and headers.
12891
+
12892
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
12893
+
12894
+ ```ruby
12895
+ begin
12896
+ # Rename a list and segment folder
12897
+ data, status_code, headers = api_instance.update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
12898
+ p status_code # => 2xx
12899
+ p headers # => { ... }
12900
+ p data # => <SfvbCommsFolderResponse>
12901
+ rescue UltracartClient::ApiError => e
12902
+ puts "Error when calling SfvbApi->update_sfvb_comms_folder_with_http_info: #{e}"
12903
+ end
12904
+ ```
12905
+
12906
+ ### Parameters
12907
+
12908
+ | Name | Type | Description | Notes |
12909
+ | ---- | ---- | ----------- | ----- |
12910
+ | **storefront_oid** | **Integer** | | |
12911
+ | **folder_uuid** | **String** | | |
12912
+ | **if_match** | **String** | The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
12913
+ | **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new name | |
12914
+
12915
+ ### Return type
12916
+
12917
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
12918
+
12919
+ ### Authorization
12920
+
12921
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12922
+
12923
+ ### HTTP request headers
12924
+
12925
+ - **Content-Type**: application/json
12926
+ - **Accept**: application/json
12927
+
12928
+
12929
+ ## update_sfvb_comms_list
12930
+
12931
+ > <SfvbCommsListResponse> update_sfvb_comms_list(storefront_oid, list_uuid, if_match, list_write_request)
12932
+
12933
+ Change an email list's name, folder or public settings
12934
+
12935
+ A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list's hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
12936
+
12937
+
12938
+ ### Examples
12939
+
12940
+
12941
+ (No example for this operation).
12942
+
12943
+
12944
+ #### Using the update_sfvb_comms_list_with_http_info variant
12945
+
12946
+ This returns an Array which contains the response data, status code and headers.
12947
+
12948
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request)
12949
+
12950
+ ```ruby
12951
+ begin
12952
+ # Change an email list's name, folder or public settings
12953
+ data, status_code, headers = api_instance.update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request)
12954
+ p status_code # => 2xx
12955
+ p headers # => { ... }
12956
+ p data # => <SfvbCommsListResponse>
12957
+ rescue UltracartClient::ApiError => e
12958
+ puts "Error when calling SfvbApi->update_sfvb_comms_list_with_http_info: #{e}"
12959
+ end
12960
+ ```
12961
+
12962
+ ### Parameters
12963
+
12964
+ | Name | Type | Description | Notes |
12965
+ | ---- | ---- | ----------- | ----- |
12966
+ | **storefront_oid** | **Integer** | | |
12967
+ | **list_uuid** | **String** | | |
12968
+ | **if_match** | **String** | The list&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
12969
+ | **list_write_request** | [**SfvbCommsListWriteRequest**](SfvbCommsListWriteRequest.md) | The fields to change | |
12970
+
12971
+ ### Return type
12972
+
12973
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
12974
+
12975
+ ### Authorization
12976
+
12977
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12978
+
12979
+ ### HTTP request headers
12980
+
12981
+ - **Content-Type**: application/json
12982
+ - **Accept**: application/json
12983
+
12984
+
12429
12985
  ## update_sfvb_comms_segment
12430
12986
 
12431
12987
  > <SfvbCommsSegmentResponse> update_sfvb_comms_segment(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
@@ -12652,7 +13208,7 @@ end
12652
13208
 
12653
13209
  Change a flow
12654
13210
 
12655
- A field left out keeps its value. The trigger and the status are never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
13211
+ A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
12656
13212
 
12657
13213
 
12658
13214
  ### Examples
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbCommsFolder
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **folder_uuid** | **String** | The folder uuid. | [optional] |
8
+ | **hash_sha256** | **String** | The hash of the name. Send it as If-Match to rename or delete the folder. | [optional] |
9
+ | **list_count** | **Integer** | How many lists are filed in it. | [optional] |
10
+ | **name** | **String** | The folder name. | [optional] |
11
+ | **segment_count** | **Integer** | How many segments are filed in it. | [optional] |
12
+ | **system_generated** | **Boolean** | True for a folder the admin manages, which can&#39;t be renamed or deleted here. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbCommsFolder.new(
20
+ folder_uuid: null,
21
+ hash_sha256: null,
22
+ list_count: null,
23
+ name: null,
24
+ segment_count: null,
25
+ system_generated: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbCommsFolderItem
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The list or segment name. | [optional] |
8
+ | **type** | **String** | list or segment. | [optional] |
9
+ | **uuid** | **String** | The list or segment uuid. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbCommsFolderItem.new(
17
+ name: null,
18
+ type: null,
19
+ uuid: null
20
+ )
21
+ ```
22
+