ultracart_api 4.1.229 → 4.1.231

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.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +38 -2
  3. data/docs/ItemAutoOrder.md +6 -0
  4. data/docs/SfvbApi.md +846 -3
  5. data/docs/SfvbApprovalCreateRequest.md +3 -1
  6. data/docs/SfvbCampaign.md +2 -0
  7. data/docs/SfvbCommsFolder.md +28 -0
  8. data/docs/SfvbCommsFolderItem.md +22 -0
  9. data/docs/SfvbCommsFolderResponse.md +22 -0
  10. data/docs/SfvbCommsFolderWriteRequest.md +18 -0
  11. data/docs/SfvbCommsFoldersResponse.md +18 -0
  12. data/docs/SfvbCommsListDetail.md +34 -0
  13. data/docs/SfvbCommsListResponse.md +20 -0
  14. data/docs/SfvbCommsListWriteRequest.md +24 -0
  15. data/docs/SfvbCommsMember.md +22 -0
  16. data/docs/SfvbCommsMembersResponse.md +36 -0
  17. data/docs/SfvbFlow.md +2 -0
  18. data/docs/SfvbFlowWriteRequest.md +2 -2
  19. data/docs/SfvbPostcardAddress.md +28 -0
  20. data/docs/SfvbPostcardCard.md +40 -0
  21. data/docs/SfvbPostcardTrackingResponse.md +34 -0
  22. data/docs/SfvbSequenceStep.md +1 -1
  23. data/docs/SfvbStepCounts.md +1 -1
  24. data/docs/SfvbTransactionalChange.md +24 -0
  25. data/docs/SfvbTransactionalDeliveryOption.md +22 -0
  26. data/docs/SfvbTransactionalEmailDetail.md +30 -0
  27. data/docs/SfvbTransactionalEmailResponse.md +24 -0
  28. data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
  29. data/docs/SfvbTransactionalSender.md +24 -0
  30. data/lib/ultracart_api/api/sfvb_api.rb +1220 -61
  31. data/lib/ultracart_api/models/item_auto_order.rb +35 -1
  32. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +15 -6
  33. data/lib/ultracart_api/models/sfvb_campaign.rb +11 -1
  34. data/lib/ultracart_api/models/sfvb_comms_folder.rb +270 -0
  35. data/lib/ultracart_api/models/sfvb_comms_folder_item.rb +240 -0
  36. data/lib/ultracart_api/models/sfvb_comms_folder_response.rb +243 -0
  37. data/lib/ultracart_api/models/sfvb_comms_folder_write_request.rb +220 -0
  38. data/lib/ultracart_api/models/sfvb_comms_folders_response.rb +222 -0
  39. data/lib/ultracart_api/models/sfvb_comms_list_detail.rb +302 -0
  40. data/lib/ultracart_api/models/sfvb_comms_list_response.rb +231 -0
  41. data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb +250 -0
  42. data/lib/ultracart_api/models/sfvb_comms_member.rb +240 -0
  43. data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
  44. data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
  45. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
  46. data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
  47. data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
  48. data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
  49. data/lib/ultracart_api/models/sfvb_sequence_step.rb +1 -1
  50. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  51. data/lib/ultracart_api/models/sfvb_transactional_change.rb +250 -0
  52. data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
  53. data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
  54. data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
  55. data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
  56. data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
  57. data/lib/ultracart_api/version.rb +1 -1
  58. data/lib/ultracart_api.rb +19 -0
  59. metadata +40 -2
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,7 +70,12 @@ 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 |
76
+ | [**get_sfvb_comms_list_members**](SfvbApi.md#get_sfvb_comms_list_members) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members | Read one page of a list's members |
70
77
  | [**get_sfvb_comms_segment**](SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule |
78
+ | [**get_sfvb_comms_segment_members**](SfvbApi.md#get_sfvb_comms_segment_members) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members | Read one page of a segment's members |
71
79
  | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
72
80
  | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
73
81
  | [**get_sfvb_comms_twilio_account**](SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account |
@@ -104,6 +112,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
104
112
  | [**get_sfvb_page_blog_posts**](SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page |
105
113
  | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
106
114
  | [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
115
+ | [**get_sfvb_postcard_tracking**](SfvbApi.md#get_sfvb_postcard_tracking) | **GET** /sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking | Read one page of the cards mailed for a postcard |
107
116
  | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
108
117
  | [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
109
118
  | [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events |
@@ -129,6 +138,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
129
138
  | [**get_sfvb_tracking_provider**](SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider |
130
139
  | [**get_sfvb_tracking_providers**](SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers |
131
140
  | [**get_sfvb_tracking_settings**](SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings |
141
+ | [**get_sfvb_transactional_email**](SfvbApi.md#get_sfvb_transactional_email) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Read a transactional email's subject, delivery options and sender |
132
142
  | [**get_sfvb_transactional_emails**](SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends |
133
143
  | [**get_sfvb_upsell_offer**](SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer |
134
144
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
@@ -141,6 +151,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
141
151
  | [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
142
152
  | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
143
153
  | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
154
+ | [**insert_sfvb_comms_folder**](SfvbApi.md#insert_sfvb_comms_folder) | **POST** /sfvb/storefronts/{storefront_oid}/list_segment_folders | Create a list and segment folder |
155
+ | [**insert_sfvb_comms_list**](SfvbApi.md#insert_sfvb_comms_list) | **POST** /sfvb/storefronts/{storefront_oid}/lists | Create an email list |
144
156
  | [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
145
157
  | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
146
158
  | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
@@ -227,6 +239,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
227
239
  | [**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
240
  | [**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
241
  | [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
242
+ | [**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 |
243
+ | [**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
244
  | [**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
245
  | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
232
246
  | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
@@ -243,6 +257,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
243
257
  | [**update_sfvb_tracking_html**](SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot |
244
258
  | [**update_sfvb_tracking_privacy**](SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules |
245
259
  | [**update_sfvb_tracking_provider**](SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider |
260
+ | [**update_sfvb_transactional_email**](SfvbApi.md#update_sfvb_transactional_email) | **PUT** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Change a transactional email's subject, delivery options or sender |
246
261
  | [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
247
262
  | [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
248
263
  | [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
@@ -417,6 +432,116 @@ end
417
432
  - **Accept**: application/json
418
433
 
419
434
 
435
+ ## archive_sfvb_comms_list
436
+
437
+ > <SfvbCommsListResponse> archive_sfvb_comms_list(storefront_oid, list_uuid, if_match)
438
+
439
+ Archive an email list
440
+
441
+ 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.
442
+
443
+
444
+ ### Examples
445
+
446
+
447
+ (No example for this operation).
448
+
449
+
450
+ #### Using the archive_sfvb_comms_list_with_http_info variant
451
+
452
+ This returns an Array which contains the response data, status code and headers.
453
+
454
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> archive_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match)
455
+
456
+ ```ruby
457
+ begin
458
+ # Archive an email list
459
+ data, status_code, headers = api_instance.archive_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match)
460
+ p status_code # => 2xx
461
+ p headers # => { ... }
462
+ p data # => <SfvbCommsListResponse>
463
+ rescue UltracartClient::ApiError => e
464
+ puts "Error when calling SfvbApi->archive_sfvb_comms_list_with_http_info: #{e}"
465
+ end
466
+ ```
467
+
468
+ ### Parameters
469
+
470
+ | Name | Type | Description | Notes |
471
+ | ---- | ---- | ----------- | ----- |
472
+ | **storefront_oid** | **Integer** | | |
473
+ | **list_uuid** | **String** | | |
474
+ | **if_match** | **String** | The list&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
475
+
476
+ ### Return type
477
+
478
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
479
+
480
+ ### Authorization
481
+
482
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: Not defined
487
+ - **Accept**: application/json
488
+
489
+
490
+ ## archive_sfvb_comms_segment
491
+
492
+ > <SfvbCommsSegmentResponse> archive_sfvb_comms_segment(storefront_oid, segment_uuid, if_match)
493
+
494
+ Archive a segment
495
+
496
+ 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.
497
+
498
+
499
+ ### Examples
500
+
501
+
502
+ (No example for this operation).
503
+
504
+
505
+ #### Using the archive_sfvb_comms_segment_with_http_info variant
506
+
507
+ This returns an Array which contains the response data, status code and headers.
508
+
509
+ > <Array(<SfvbCommsSegmentResponse>, Integer, Hash)> archive_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match)
510
+
511
+ ```ruby
512
+ begin
513
+ # Archive a segment
514
+ data, status_code, headers = api_instance.archive_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match)
515
+ p status_code # => 2xx
516
+ p headers # => { ... }
517
+ p data # => <SfvbCommsSegmentResponse>
518
+ rescue UltracartClient::ApiError => e
519
+ puts "Error when calling SfvbApi->archive_sfvb_comms_segment_with_http_info: #{e}"
520
+ end
521
+ ```
522
+
523
+ ### Parameters
524
+
525
+ | Name | Type | Description | Notes |
526
+ | ---- | ---- | ----------- | ----- |
527
+ | **storefront_oid** | **Integer** | | |
528
+ | **segment_uuid** | **String** | | |
529
+ | **if_match** | **String** | The segment&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
530
+
531
+ ### Return type
532
+
533
+ [**SfvbCommsSegmentResponse**](SfvbCommsSegmentResponse.md)
534
+
535
+ ### Authorization
536
+
537
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
538
+
539
+ ### HTTP request headers
540
+
541
+ - **Content-Type**: Not defined
542
+ - **Accept**: application/json
543
+
544
+
420
545
  ## archive_sfvb_flow
421
546
 
422
547
  > <SfvbFlow> archive_sfvb_flow(storefront_oid, flow_uuid, if_match, archive_request)
@@ -1285,6 +1410,61 @@ nil (empty response body)
1285
1410
  - **Accept**: application/json
1286
1411
 
1287
1412
 
1413
+ ## delete_sfvb_comms_folder
1414
+
1415
+ > <SfvbCommsFolderResponse> delete_sfvb_comms_folder(storefront_oid, folder_uuid, if_match)
1416
+
1417
+ Delete a list and segment folder
1418
+
1419
+ 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.
1420
+
1421
+
1422
+ ### Examples
1423
+
1424
+
1425
+ (No example for this operation).
1426
+
1427
+
1428
+ #### Using the delete_sfvb_comms_folder_with_http_info variant
1429
+
1430
+ This returns an Array which contains the response data, status code and headers.
1431
+
1432
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> delete_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match)
1433
+
1434
+ ```ruby
1435
+ begin
1436
+ # Delete a list and segment folder
1437
+ data, status_code, headers = api_instance.delete_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match)
1438
+ p status_code # => 2xx
1439
+ p headers # => { ... }
1440
+ p data # => <SfvbCommsFolderResponse>
1441
+ rescue UltracartClient::ApiError => e
1442
+ puts "Error when calling SfvbApi->delete_sfvb_comms_folder_with_http_info: #{e}"
1443
+ end
1444
+ ```
1445
+
1446
+ ### Parameters
1447
+
1448
+ | Name | Type | Description | Notes |
1449
+ | ---- | ---- | ----------- | ----- |
1450
+ | **storefront_oid** | **Integer** | | |
1451
+ | **folder_uuid** | **String** | | |
1452
+ | **if_match** | **String** | The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
1453
+
1454
+ ### Return type
1455
+
1456
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
1457
+
1458
+ ### Authorization
1459
+
1460
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1461
+
1462
+ ### HTTP request headers
1463
+
1464
+ - **Content-Type**: Not defined
1465
+ - **Accept**: application/json
1466
+
1467
+
1288
1468
  ## delete_sfvb_comms_sending_domain
1289
1469
 
1290
1470
  > delete_sfvb_comms_sending_domain(domain, opts)
@@ -3680,6 +3860,224 @@ end
3680
3860
  - **Accept**: application/json
3681
3861
 
3682
3862
 
3863
+ ## get_sfvb_comms_folder
3864
+
3865
+ > <SfvbCommsFolderResponse> get_sfvb_comms_folder(storefront_oid, folder_uuid)
3866
+
3867
+ Read one list and segment folder
3868
+
3869
+ The folder, with the name and uuid of each list and segment filed in it.
3870
+
3871
+
3872
+ ### Examples
3873
+
3874
+
3875
+ (No example for this operation).
3876
+
3877
+
3878
+ #### Using the get_sfvb_comms_folder_with_http_info variant
3879
+
3880
+ This returns an Array which contains the response data, status code and headers.
3881
+
3882
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid)
3883
+
3884
+ ```ruby
3885
+ begin
3886
+ # Read one list and segment folder
3887
+ data, status_code, headers = api_instance.get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid)
3888
+ p status_code # => 2xx
3889
+ p headers # => { ... }
3890
+ p data # => <SfvbCommsFolderResponse>
3891
+ rescue UltracartClient::ApiError => e
3892
+ puts "Error when calling SfvbApi->get_sfvb_comms_folder_with_http_info: #{e}"
3893
+ end
3894
+ ```
3895
+
3896
+ ### Parameters
3897
+
3898
+ | Name | Type | Description | Notes |
3899
+ | ---- | ---- | ----------- | ----- |
3900
+ | **storefront_oid** | **Integer** | | |
3901
+ | **folder_uuid** | **String** | | |
3902
+
3903
+ ### Return type
3904
+
3905
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
3906
+
3907
+ ### Authorization
3908
+
3909
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3910
+
3911
+ ### HTTP request headers
3912
+
3913
+ - **Content-Type**: Not defined
3914
+ - **Accept**: application/json
3915
+
3916
+
3917
+ ## get_sfvb_comms_folders
3918
+
3919
+ > <SfvbCommsFoldersResponse> get_sfvb_comms_folders(storefront_oid)
3920
+
3921
+ List the list and segment folders
3922
+
3923
+ Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
3924
+
3925
+
3926
+ ### Examples
3927
+
3928
+
3929
+ (No example for this operation).
3930
+
3931
+
3932
+ #### Using the get_sfvb_comms_folders_with_http_info variant
3933
+
3934
+ This returns an Array which contains the response data, status code and headers.
3935
+
3936
+ > <Array(<SfvbCommsFoldersResponse>, Integer, Hash)> get_sfvb_comms_folders_with_http_info(storefront_oid)
3937
+
3938
+ ```ruby
3939
+ begin
3940
+ # List the list and segment folders
3941
+ data, status_code, headers = api_instance.get_sfvb_comms_folders_with_http_info(storefront_oid)
3942
+ p status_code # => 2xx
3943
+ p headers # => { ... }
3944
+ p data # => <SfvbCommsFoldersResponse>
3945
+ rescue UltracartClient::ApiError => e
3946
+ puts "Error when calling SfvbApi->get_sfvb_comms_folders_with_http_info: #{e}"
3947
+ end
3948
+ ```
3949
+
3950
+ ### Parameters
3951
+
3952
+ | Name | Type | Description | Notes |
3953
+ | ---- | ---- | ----------- | ----- |
3954
+ | **storefront_oid** | **Integer** | | |
3955
+
3956
+ ### Return type
3957
+
3958
+ [**SfvbCommsFoldersResponse**](SfvbCommsFoldersResponse.md)
3959
+
3960
+ ### Authorization
3961
+
3962
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3963
+
3964
+ ### HTTP request headers
3965
+
3966
+ - **Content-Type**: Not defined
3967
+ - **Accept**: application/json
3968
+
3969
+
3970
+ ## get_sfvb_comms_list
3971
+
3972
+ > <SfvbCommsListResponse> get_sfvb_comms_list(storefront_oid, list_uuid)
3973
+
3974
+ Read one email list
3975
+
3976
+ 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.
3977
+
3978
+
3979
+ ### Examples
3980
+
3981
+
3982
+ (No example for this operation).
3983
+
3984
+
3985
+ #### Using the get_sfvb_comms_list_with_http_info variant
3986
+
3987
+ This returns an Array which contains the response data, status code and headers.
3988
+
3989
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid)
3990
+
3991
+ ```ruby
3992
+ begin
3993
+ # Read one email list
3994
+ data, status_code, headers = api_instance.get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid)
3995
+ p status_code # => 2xx
3996
+ p headers # => { ... }
3997
+ p data # => <SfvbCommsListResponse>
3998
+ rescue UltracartClient::ApiError => e
3999
+ puts "Error when calling SfvbApi->get_sfvb_comms_list_with_http_info: #{e}"
4000
+ end
4001
+ ```
4002
+
4003
+ ### Parameters
4004
+
4005
+ | Name | Type | Description | Notes |
4006
+ | ---- | ---- | ----------- | ----- |
4007
+ | **storefront_oid** | **Integer** | | |
4008
+ | **list_uuid** | **String** | | |
4009
+
4010
+ ### Return type
4011
+
4012
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
4013
+
4014
+ ### Authorization
4015
+
4016
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4017
+
4018
+ ### HTTP request headers
4019
+
4020
+ - **Content-Type**: Not defined
4021
+ - **Accept**: application/json
4022
+
4023
+
4024
+ ## get_sfvb_comms_list_members
4025
+
4026
+ > <SfvbCommsMembersResponse> get_sfvb_comms_list_members(storefront_oid, list_uuid, opts)
4027
+
4028
+ Read one page of a list's members
4029
+
4030
+ Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
4031
+
4032
+
4033
+ ### Examples
4034
+
4035
+
4036
+ (No example for this operation).
4037
+
4038
+
4039
+ #### Using the get_sfvb_comms_list_members_with_http_info variant
4040
+
4041
+ This returns an Array which contains the response data, status code and headers.
4042
+
4043
+ > <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
4044
+
4045
+ ```ruby
4046
+ begin
4047
+ # Read one page of a list's members
4048
+ data, status_code, headers = api_instance.get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
4049
+ p status_code # => 2xx
4050
+ p headers # => { ... }
4051
+ p data # => <SfvbCommsMembersResponse>
4052
+ rescue UltracartClient::ApiError => e
4053
+ puts "Error when calling SfvbApi->get_sfvb_comms_list_members_with_http_info: #{e}"
4054
+ end
4055
+ ```
4056
+
4057
+ ### Parameters
4058
+
4059
+ | Name | Type | Description | Notes |
4060
+ | ---- | ---- | ----------- | ----- |
4061
+ | **storefront_oid** | **Integer** | | |
4062
+ | **list_uuid** | **String** | | |
4063
+ | **page** | **Integer** | The page, from 1 | [optional] |
4064
+ | **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
4065
+ | **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
4066
+
4067
+ ### Return type
4068
+
4069
+ [**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
4070
+
4071
+ ### Authorization
4072
+
4073
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4074
+
4075
+ ### HTTP request headers
4076
+
4077
+ - **Content-Type**: Not defined
4078
+ - **Accept**: application/json
4079
+
4080
+
3683
4081
  ## get_sfvb_comms_segment
3684
4082
 
3685
4083
  > <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
@@ -3734,6 +4132,63 @@ end
3734
4132
  - **Accept**: application/json
3735
4133
 
3736
4134
 
4135
+ ## get_sfvb_comms_segment_members
4136
+
4137
+ > <SfvbCommsMembersResponse> get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts)
4138
+
4139
+ Read one page of a segment's members
4140
+
4141
+ Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
4142
+
4143
+
4144
+ ### Examples
4145
+
4146
+
4147
+ (No example for this operation).
4148
+
4149
+
4150
+ #### Using the get_sfvb_comms_segment_members_with_http_info variant
4151
+
4152
+ This returns an Array which contains the response data, status code and headers.
4153
+
4154
+ > <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
4155
+
4156
+ ```ruby
4157
+ begin
4158
+ # Read one page of a segment's members
4159
+ data, status_code, headers = api_instance.get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
4160
+ p status_code # => 2xx
4161
+ p headers # => { ... }
4162
+ p data # => <SfvbCommsMembersResponse>
4163
+ rescue UltracartClient::ApiError => e
4164
+ puts "Error when calling SfvbApi->get_sfvb_comms_segment_members_with_http_info: #{e}"
4165
+ end
4166
+ ```
4167
+
4168
+ ### Parameters
4169
+
4170
+ | Name | Type | Description | Notes |
4171
+ | ---- | ---- | ----------- | ----- |
4172
+ | **storefront_oid** | **Integer** | | |
4173
+ | **segment_uuid** | **String** | | |
4174
+ | **page** | **Integer** | The page, from 1 | [optional] |
4175
+ | **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
4176
+ | **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
4177
+
4178
+ ### Return type
4179
+
4180
+ [**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
4181
+
4182
+ ### Authorization
4183
+
4184
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4185
+
4186
+ ### HTTP request headers
4187
+
4188
+ - **Content-Type**: Not defined
4189
+ - **Accept**: application/json
4190
+
4191
+
3737
4192
  ## get_sfvb_comms_sending_domain
3738
4193
 
3739
4194
  > <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
@@ -5668,11 +6123,68 @@ end
5668
6123
  | Name | Type | Description | Notes |
5669
6124
  | ---- | ---- | ----------- | ----- |
5670
6125
  | **storefront_oid** | **Integer** | | |
5671
- | **path** | **String** | Page path, for example /lp/spring-sale/ | |
6126
+ | **path** | **String** | Page path, for example /lp/spring-sale/ | |
6127
+
6128
+ ### Return type
6129
+
6130
+ [**SfvbPageSelectors**](SfvbPageSelectors.md)
6131
+
6132
+ ### Authorization
6133
+
6134
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6135
+
6136
+ ### HTTP request headers
6137
+
6138
+ - **Content-Type**: Not defined
6139
+ - **Accept**: application/json
6140
+
6141
+
6142
+ ## get_sfvb_postcard_tracking
6143
+
6144
+ > <SfvbPostcardTrackingResponse> get_sfvb_postcard_tracking(storefront_oid, postcard_uuid, opts)
6145
+
6146
+ Read one page of the cards mailed for a postcard
6147
+
6148
+ Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
6149
+
6150
+
6151
+ ### Examples
6152
+
6153
+
6154
+ (No example for this operation).
6155
+
6156
+
6157
+ #### Using the get_sfvb_postcard_tracking_with_http_info variant
6158
+
6159
+ This returns an Array which contains the response data, status code and headers.
6160
+
6161
+ > <Array(<SfvbPostcardTrackingResponse>, Integer, Hash)> get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
6162
+
6163
+ ```ruby
6164
+ begin
6165
+ # Read one page of the cards mailed for a postcard
6166
+ data, status_code, headers = api_instance.get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
6167
+ p status_code # => 2xx
6168
+ p headers # => { ... }
6169
+ p data # => <SfvbPostcardTrackingResponse>
6170
+ rescue UltracartClient::ApiError => e
6171
+ puts "Error when calling SfvbApi->get_sfvb_postcard_tracking_with_http_info: #{e}"
6172
+ end
6173
+ ```
6174
+
6175
+ ### Parameters
6176
+
6177
+ | Name | Type | Description | Notes |
6178
+ | ---- | ---- | ----------- | ----- |
6179
+ | **storefront_oid** | **Integer** | | |
6180
+ | **postcard_uuid** | **String** | | |
6181
+ | **page** | **Integer** | The page, from 1 | [optional] |
6182
+ | **page_size** | **Integer** | Cards per page, 1 to 100 (default 50) | [optional] |
6183
+ | **show_customer_data** | **Boolean** | True to return the recipients&#39; real names and street addresses | [optional] |
5672
6184
 
5673
6185
  ### Return type
5674
6186
 
5675
- [**SfvbPageSelectors**](SfvbPageSelectors.md)
6187
+ [**SfvbPostcardTrackingResponse**](SfvbPostcardTrackingResponse.md)
5676
6188
 
5677
6189
  ### Authorization
5678
6190
 
@@ -7030,6 +7542,60 @@ end
7030
7542
  - **Accept**: application/json
7031
7543
 
7032
7544
 
7545
+ ## get_sfvb_transactional_email
7546
+
7547
+ > <SfvbTransactionalEmailResponse> get_sfvb_transactional_email(storefront_oid, file_name)
7548
+
7549
+ Read a transactional email's subject, delivery options and sender
7550
+
7551
+ file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
7552
+
7553
+
7554
+ ### Examples
7555
+
7556
+
7557
+ (No example for this operation).
7558
+
7559
+
7560
+ #### Using the get_sfvb_transactional_email_with_http_info variant
7561
+
7562
+ This returns an Array which contains the response data, status code and headers.
7563
+
7564
+ > <Array(<SfvbTransactionalEmailResponse>, Integer, Hash)> get_sfvb_transactional_email_with_http_info(storefront_oid, file_name)
7565
+
7566
+ ```ruby
7567
+ begin
7568
+ # Read a transactional email's subject, delivery options and sender
7569
+ data, status_code, headers = api_instance.get_sfvb_transactional_email_with_http_info(storefront_oid, file_name)
7570
+ p status_code # => 2xx
7571
+ p headers # => { ... }
7572
+ p data # => <SfvbTransactionalEmailResponse>
7573
+ rescue UltracartClient::ApiError => e
7574
+ puts "Error when calling SfvbApi->get_sfvb_transactional_email_with_http_info: #{e}"
7575
+ end
7576
+ ```
7577
+
7578
+ ### Parameters
7579
+
7580
+ | Name | Type | Description | Notes |
7581
+ | ---- | ---- | ----------- | ----- |
7582
+ | **storefront_oid** | **Integer** | | |
7583
+ | **file_name** | **String** | | |
7584
+
7585
+ ### Return type
7586
+
7587
+ [**SfvbTransactionalEmailResponse**](SfvbTransactionalEmailResponse.md)
7588
+
7589
+ ### Authorization
7590
+
7591
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7592
+
7593
+ ### HTTP request headers
7594
+
7595
+ - **Content-Type**: Not defined
7596
+ - **Accept**: application/json
7597
+
7598
+
7033
7599
  ## get_sfvb_transactional_emails
7034
7600
 
7035
7601
  > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
@@ -7680,6 +8246,114 @@ end
7680
8246
  - **Accept**: application/json
7681
8247
 
7682
8248
 
8249
+ ## insert_sfvb_comms_folder
8250
+
8251
+ > <SfvbCommsFolderResponse> insert_sfvb_comms_folder(storefront_oid, folder_write_request)
8252
+
8253
+ Create a list and segment folder
8254
+
8255
+ A new, empty folder. File a list or segment in it by setting its folder_uuid.
8256
+
8257
+
8258
+ ### Examples
8259
+
8260
+
8261
+ (No example for this operation).
8262
+
8263
+
8264
+ #### Using the insert_sfvb_comms_folder_with_http_info variant
8265
+
8266
+ This returns an Array which contains the response data, status code and headers.
8267
+
8268
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request)
8269
+
8270
+ ```ruby
8271
+ begin
8272
+ # Create a list and segment folder
8273
+ data, status_code, headers = api_instance.insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request)
8274
+ p status_code # => 2xx
8275
+ p headers # => { ... }
8276
+ p data # => <SfvbCommsFolderResponse>
8277
+ rescue UltracartClient::ApiError => e
8278
+ puts "Error when calling SfvbApi->insert_sfvb_comms_folder_with_http_info: #{e}"
8279
+ end
8280
+ ```
8281
+
8282
+ ### Parameters
8283
+
8284
+ | Name | Type | Description | Notes |
8285
+ | ---- | ---- | ----------- | ----- |
8286
+ | **storefront_oid** | **Integer** | | |
8287
+ | **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new folder&#39;s name | |
8288
+
8289
+ ### Return type
8290
+
8291
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
8292
+
8293
+ ### Authorization
8294
+
8295
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8296
+
8297
+ ### HTTP request headers
8298
+
8299
+ - **Content-Type**: application/json
8300
+ - **Accept**: application/json
8301
+
8302
+
8303
+ ## insert_sfvb_comms_list
8304
+
8305
+ > <SfvbCommsListResponse> insert_sfvb_comms_list(storefront_oid, list_write_request)
8306
+
8307
+ Create an email list
8308
+
8309
+ 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.
8310
+
8311
+
8312
+ ### Examples
8313
+
8314
+
8315
+ (No example for this operation).
8316
+
8317
+
8318
+ #### Using the insert_sfvb_comms_list_with_http_info variant
8319
+
8320
+ This returns an Array which contains the response data, status code and headers.
8321
+
8322
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request)
8323
+
8324
+ ```ruby
8325
+ begin
8326
+ # Create an email list
8327
+ data, status_code, headers = api_instance.insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request)
8328
+ p status_code # => 2xx
8329
+ p headers # => { ... }
8330
+ p data # => <SfvbCommsListResponse>
8331
+ rescue UltracartClient::ApiError => e
8332
+ puts "Error when calling SfvbApi->insert_sfvb_comms_list_with_http_info: #{e}"
8333
+ end
8334
+ ```
8335
+
8336
+ ### Parameters
8337
+
8338
+ | Name | Type | Description | Notes |
8339
+ | ---- | ---- | ----------- | ----- |
8340
+ | **storefront_oid** | **Integer** | | |
8341
+ | **list_write_request** | [**SfvbCommsListWriteRequest**](SfvbCommsListWriteRequest.md) | The new list&#39;s name, folder and public settings | |
8342
+
8343
+ ### Return type
8344
+
8345
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
8346
+
8347
+ ### Authorization
8348
+
8349
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8350
+
8351
+ ### HTTP request headers
8352
+
8353
+ - **Content-Type**: application/json
8354
+ - **Accept**: application/json
8355
+
8356
+
7683
8357
  ## insert_sfvb_comms_segment
7684
8358
 
7685
8359
  > <SfvbCommsSegmentResponse> insert_sfvb_comms_segment(storefront_oid, segment_write_request)
@@ -12426,6 +13100,118 @@ end
12426
13100
  - **Accept**: application/json
12427
13101
 
12428
13102
 
13103
+ ## update_sfvb_comms_folder
13104
+
13105
+ > <SfvbCommsFolderResponse> update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
13106
+
13107
+ Rename a list and segment folder
13108
+
13109
+ Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
13110
+
13111
+
13112
+ ### Examples
13113
+
13114
+
13115
+ (No example for this operation).
13116
+
13117
+
13118
+ #### Using the update_sfvb_comms_folder_with_http_info variant
13119
+
13120
+ This returns an Array which contains the response data, status code and headers.
13121
+
13122
+ > <Array(<SfvbCommsFolderResponse>, Integer, Hash)> update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
13123
+
13124
+ ```ruby
13125
+ begin
13126
+ # Rename a list and segment folder
13127
+ data, status_code, headers = api_instance.update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
13128
+ p status_code # => 2xx
13129
+ p headers # => { ... }
13130
+ p data # => <SfvbCommsFolderResponse>
13131
+ rescue UltracartClient::ApiError => e
13132
+ puts "Error when calling SfvbApi->update_sfvb_comms_folder_with_http_info: #{e}"
13133
+ end
13134
+ ```
13135
+
13136
+ ### Parameters
13137
+
13138
+ | Name | Type | Description | Notes |
13139
+ | ---- | ---- | ----------- | ----- |
13140
+ | **storefront_oid** | **Integer** | | |
13141
+ | **folder_uuid** | **String** | | |
13142
+ | **if_match** | **String** | The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
13143
+ | **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new name | |
13144
+
13145
+ ### Return type
13146
+
13147
+ [**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
13148
+
13149
+ ### Authorization
13150
+
13151
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
13152
+
13153
+ ### HTTP request headers
13154
+
13155
+ - **Content-Type**: application/json
13156
+ - **Accept**: application/json
13157
+
13158
+
13159
+ ## update_sfvb_comms_list
13160
+
13161
+ > <SfvbCommsListResponse> update_sfvb_comms_list(storefront_oid, list_uuid, if_match, list_write_request)
13162
+
13163
+ Change an email list's name, folder or public settings
13164
+
13165
+ 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.
13166
+
13167
+
13168
+ ### Examples
13169
+
13170
+
13171
+ (No example for this operation).
13172
+
13173
+
13174
+ #### Using the update_sfvb_comms_list_with_http_info variant
13175
+
13176
+ This returns an Array which contains the response data, status code and headers.
13177
+
13178
+ > <Array(<SfvbCommsListResponse>, Integer, Hash)> update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request)
13179
+
13180
+ ```ruby
13181
+ begin
13182
+ # Change an email list's name, folder or public settings
13183
+ data, status_code, headers = api_instance.update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request)
13184
+ p status_code # => 2xx
13185
+ p headers # => { ... }
13186
+ p data # => <SfvbCommsListResponse>
13187
+ rescue UltracartClient::ApiError => e
13188
+ puts "Error when calling SfvbApi->update_sfvb_comms_list_with_http_info: #{e}"
13189
+ end
13190
+ ```
13191
+
13192
+ ### Parameters
13193
+
13194
+ | Name | Type | Description | Notes |
13195
+ | ---- | ---- | ----------- | ----- |
13196
+ | **storefront_oid** | **Integer** | | |
13197
+ | **list_uuid** | **String** | | |
13198
+ | **if_match** | **String** | The list&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
13199
+ | **list_write_request** | [**SfvbCommsListWriteRequest**](SfvbCommsListWriteRequest.md) | The fields to change | |
13200
+
13201
+ ### Return type
13202
+
13203
+ [**SfvbCommsListResponse**](SfvbCommsListResponse.md)
13204
+
13205
+ ### Authorization
13206
+
13207
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
13208
+
13209
+ ### HTTP request headers
13210
+
13211
+ - **Content-Type**: application/json
13212
+ - **Accept**: application/json
13213
+
13214
+
12429
13215
  ## update_sfvb_comms_segment
12430
13216
 
12431
13217
  > <SfvbCommsSegmentResponse> update_sfvb_comms_segment(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
@@ -12652,7 +13438,7 @@ end
12652
13438
 
12653
13439
  Change a flow
12654
13440
 
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.
13441
+ 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
13442
 
12657
13443
 
12658
13444
  ### Examples
@@ -13319,6 +14105,63 @@ end
13319
14105
  - **Accept**: application/json
13320
14106
 
13321
14107
 
14108
+ ## update_sfvb_transactional_email
14109
+
14110
+ > <SfvbTransactionalEmailResponse> update_sfvb_transactional_email(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14111
+
14112
+ Change a transactional email's subject, delivery options or sender
14113
+
14114
+ A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
14115
+
14116
+
14117
+ ### Examples
14118
+
14119
+
14120
+ (No example for this operation).
14121
+
14122
+
14123
+ #### Using the update_sfvb_transactional_email_with_http_info variant
14124
+
14125
+ This returns an Array which contains the response data, status code and headers.
14126
+
14127
+ > <Array(<SfvbTransactionalEmailResponse>, Integer, Hash)> update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14128
+
14129
+ ```ruby
14130
+ begin
14131
+ # Change a transactional email's subject, delivery options or sender
14132
+ data, status_code, headers = api_instance.update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14133
+ p status_code # => 2xx
14134
+ p headers # => { ... }
14135
+ p data # => <SfvbTransactionalEmailResponse>
14136
+ rescue UltracartClient::ApiError => e
14137
+ puts "Error when calling SfvbApi->update_sfvb_transactional_email_with_http_info: #{e}"
14138
+ end
14139
+ ```
14140
+
14141
+ ### Parameters
14142
+
14143
+ | Name | Type | Description | Notes |
14144
+ | ---- | ---- | ----------- | ----- |
14145
+ | **storefront_oid** | **Integer** | | |
14146
+ | **file_name** | **String** | | |
14147
+ | **if_match** | **String** | The email&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
14148
+ | **transactional_email_update_request** | [**SfvbTransactionalEmailUpdateRequest**](SfvbTransactionalEmailUpdateRequest.md) | The fields to change | |
14149
+ | **approval_id** | **String** | The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals. | [optional] |
14150
+
14151
+ ### Return type
14152
+
14153
+ [**SfvbTransactionalEmailResponse**](SfvbTransactionalEmailResponse.md)
14154
+
14155
+ ### Authorization
14156
+
14157
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
14158
+
14159
+ ### HTTP request headers
14160
+
14161
+ - **Content-Type**: application/json
14162
+ - **Accept**: application/json
14163
+
14164
+
13322
14165
  ## update_sfvb_upsell_offer
13323
14166
 
13324
14167
  > <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)