ultracart_api 4.1.228 → 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.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -2
  3. data/docs/ItemAutoOrder.md +6 -0
  4. data/docs/SfvbApi.md +946 -4
  5. data/docs/SfvbApprovalCreateRequest.md +2 -0
  6. data/docs/SfvbCommsFolder.md +28 -0
  7. data/docs/SfvbCommsFolderItem.md +22 -0
  8. data/docs/SfvbCommsFolderResponse.md +22 -0
  9. data/docs/SfvbCommsFolderWriteRequest.md +18 -0
  10. data/docs/SfvbCommsFoldersResponse.md +18 -0
  11. data/docs/SfvbCommsListDetail.md +34 -0
  12. data/docs/SfvbCommsListResponse.md +20 -0
  13. data/docs/SfvbCommsListWriteRequest.md +24 -0
  14. data/docs/SfvbFlowWriteRequest.md +2 -2
  15. data/docs/SfvbNotFoundEntry.md +2 -0
  16. data/docs/SfvbNotFoundSummary.md +28 -0
  17. data/docs/SfvbRedirectImportRow.md +2 -0
  18. data/docs/SfvbRedirectRequest.md +2 -0
  19. data/docs/SfvbRedirectResolveBatchRequest.md +18 -0
  20. data/docs/SfvbRedirectResolveBatchResponse.md +24 -0
  21. data/docs/SfvbSequenceStep.md +1 -1
  22. data/docs/SfvbSiteSeo.md +40 -0
  23. data/docs/SfvbSiteSeoChange.md +26 -0
  24. data/docs/SfvbSiteSeoRequest.md +24 -0
  25. data/docs/SfvbStepCounts.md +1 -1
  26. data/lib/ultracart_api/api/sfvb_api.rb +1306 -47
  27. data/lib/ultracart_api/models/item_auto_order.rb +35 -1
  28. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
  29. data/lib/ultracart_api/models/sfvb_comms_folder.rb +270 -0
  30. data/lib/ultracart_api/models/sfvb_comms_folder_item.rb +240 -0
  31. data/lib/ultracart_api/models/sfvb_comms_folder_response.rb +243 -0
  32. data/lib/ultracart_api/models/sfvb_comms_folder_write_request.rb +220 -0
  33. data/lib/ultracart_api/models/sfvb_comms_folders_response.rb +222 -0
  34. data/lib/ultracart_api/models/sfvb_comms_list_detail.rb +302 -0
  35. data/lib/ultracart_api/models/sfvb_comms_list_response.rb +231 -0
  36. data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb +250 -0
  37. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
  38. data/lib/ultracart_api/models/sfvb_not_found_entry.rb +11 -1
  39. data/lib/ultracart_api/models/sfvb_not_found_summary.rb +280 -0
  40. data/lib/ultracart_api/models/sfvb_redirect_import_row.rb +11 -1
  41. data/lib/ultracart_api/models/sfvb_redirect_request.rb +11 -1
  42. data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_request.rb +222 -0
  43. data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_response.rb +252 -0
  44. data/lib/ultracart_api/models/sfvb_sequence_step.rb +1 -1
  45. data/lib/ultracart_api/models/sfvb_site_seo.rb +334 -0
  46. data/lib/ultracart_api/models/sfvb_site_seo_change.rb +260 -0
  47. data/lib/ultracart_api/models/sfvb_site_seo_request.rb +250 -0
  48. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  49. data/lib/ultracart_api/version.rb +1 -1
  50. data/lib/ultracart_api.rb +14 -0
  51. metadata +30 -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,12 +25,14 @@ 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 |
29
32
  | [**delete_sfvb_item_attribute**](SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item |
30
33
  | [**delete_sfvb_item_multimedia**](SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item |
31
34
  | [**delete_sfvb_library_entry**](SfvbApi.md#delete_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Delete or retire a library entry |
35
+ | [**delete_sfvb_not_found_entry**](SfvbApi.md#delete_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id} | Remove a 404 path from the log |
32
36
  | [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
33
37
  | [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
34
38
  | [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
@@ -56,7 +60,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
56
60
  | [**enable_sfvb_upsell_offer**](SfvbApi.md#enable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/enable | Enable an upsell offer |
57
61
  | [**enable_sfvb_upsell_path**](SfvbApi.md#enable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/enable | Enable an upsell path |
58
62
  | [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
63
+ | [**export_sfvb_not_found**](SfvbApi.md#export_sfvb_not_found) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/export | Export the open 404 paths |
59
64
  | [**favorite_sfvb_library_entry**](SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry |
65
+ | [**fix_sfvb_not_found_entry**](SfvbApi.md#fix_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/fixed | Mark a 404 path fixed |
60
66
  | [**get_sfvb_affiliate_network**](SfvbApi.md#get_sfvb_affiliate_network) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Read one affiliate network |
61
67
  | [**get_sfvb_affiliate_networks**](SfvbApi.md#get_sfvb_affiliate_networks) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | List a storefront's affiliate networks |
62
68
  | [**get_sfvb_approval**](SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request |
@@ -64,6 +70,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
64
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 |
65
71
  | [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
66
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 |
67
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 |
68
77
  | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
69
78
  | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
@@ -96,6 +105,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
96
105
  | [**get_sfvb_not_found**](SfvbApi.md#get_sfvb_not_found) | **GET** /sfvb/storefronts/{storefront_oid}/not_found | List the paths that answered 404 |
97
106
  | [**get_sfvb_not_found_entry**](SfvbApi.md#get_sfvb_not_found_entry) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id} | Read one 404 path with its recent hits |
98
107
  | [**get_sfvb_not_found_page**](SfvbApi.md#get_sfvb_not_found_page) | **GET** /sfvb/storefronts/{storefront_oid}/not_found_page | What renders the storefront's 404 page |
108
+ | [**get_sfvb_not_found_summary**](SfvbApi.md#get_sfvb_not_found_summary) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/summary | The 404 log's trend |
99
109
  | [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
100
110
  | [**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 |
101
111
  | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
@@ -113,6 +123,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
113
123
  | [**get_sfvb_sequence_step_dispatch_logs**](SfvbApi.md#get_sfvb_sequence_step_dispatch_logs) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs | Read a flow or campaign step's dispatch log and counts |
114
124
  | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
115
125
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
126
+ | [**get_sfvb_site_seo**](SfvbApi.md#get_sfvb_site_seo) | **GET** /sfvb/storefronts/{storefront_oid}/seo | Read a storefront's search engine settings |
116
127
  | [**get_sfvb_sitemaps**](SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt |
117
128
  | [**get_sfvb_smart_attribution**](SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration |
118
129
  | [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
@@ -136,6 +147,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
136
147
  | [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
137
148
  | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
138
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 |
139
152
  | [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
140
153
  | [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
141
154
  | [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
@@ -203,6 +216,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
203
216
  | [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
204
217
  | [**reset_sfvb_i18n_message**](SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message |
205
218
  | [**resolve_sfvb_redirect**](SfvbApi.md#resolve_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/resolve | What a shopper gets for a path |
219
+ | [**resolve_sfvb_redirect_batch**](SfvbApi.md#resolve_sfvb_redirect_batch) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/resolve_batch | What a shopper gets for each of many paths |
206
220
  | [**resolve_sfvb_template**](SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders |
207
221
  | [**revert_sfvb_container**](SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system |
208
222
  | [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
@@ -221,6 +235,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
221
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 |
222
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 |
223
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 |
224
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 |
225
241
  | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
226
242
  | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
@@ -231,6 +247,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
231
247
  | [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
232
248
  | [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
233
249
  | [**update_sfvb_sequence_step**](SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter |
250
+ | [**update_sfvb_site_seo**](SfvbApi.md#update_sfvb_site_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/seo | Change a storefront's search engine settings |
234
251
  | [**update_sfvb_smart_attribution**](SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration |
235
252
  | [**update_sfvb_tracking_advanced**](SfvbApi.md#update_sfvb_tracking_advanced) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/advanced | Change a storefront's advanced conversion settings |
236
253
  | [**update_sfvb_tracking_html**](SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot |
@@ -410,6 +427,116 @@ end
410
427
  - **Accept**: application/json
411
428
 
412
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
+
413
540
  ## archive_sfvb_flow
414
541
 
415
542
  > <SfvbFlow> archive_sfvb_flow(storefront_oid, flow_uuid, if_match, archive_request)
@@ -1278,6 +1405,61 @@ nil (empty response body)
1278
1405
  - **Accept**: application/json
1279
1406
 
1280
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
+
1281
1463
  ## delete_sfvb_comms_sending_domain
1282
1464
 
1283
1465
  > delete_sfvb_comms_sending_domain(domain, opts)
@@ -1609,6 +1791,60 @@ end
1609
1791
  - **Accept**: application/json
1610
1792
 
1611
1793
 
1794
+ ## delete_sfvb_not_found_entry
1795
+
1796
+ > delete_sfvb_not_found_entry(storefront_oid, not_found_id)
1797
+
1798
+ Remove a 404 path from the log
1799
+
1800
+ The admin's Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
1801
+
1802
+
1803
+ ### Examples
1804
+
1805
+
1806
+ (No example for this operation).
1807
+
1808
+
1809
+ #### Using the delete_sfvb_not_found_entry_with_http_info variant
1810
+
1811
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1812
+
1813
+ > <Array(nil, Integer, Hash)> delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
1814
+
1815
+ ```ruby
1816
+ begin
1817
+ # Remove a 404 path from the log
1818
+ data, status_code, headers = api_instance.delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
1819
+ p status_code # => 2xx
1820
+ p headers # => { ... }
1821
+ p data # => nil
1822
+ rescue UltracartClient::ApiError => e
1823
+ puts "Error when calling SfvbApi->delete_sfvb_not_found_entry_with_http_info: #{e}"
1824
+ end
1825
+ ```
1826
+
1827
+ ### Parameters
1828
+
1829
+ | Name | Type | Description | Notes |
1830
+ | ---- | ---- | ----------- | ----- |
1831
+ | **storefront_oid** | **Integer** | | |
1832
+ | **not_found_id** | **String** | | |
1833
+
1834
+ ### Return type
1835
+
1836
+ nil (empty response body)
1837
+
1838
+ ### Authorization
1839
+
1840
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1841
+
1842
+ ### HTTP request headers
1843
+
1844
+ - **Content-Type**: Not defined
1845
+ - **Accept**: application/json
1846
+
1847
+
1612
1848
  ## delete_sfvb_page_multimedia
1613
1849
 
1614
1850
  > <SfvbPageResponse> delete_sfvb_page_multimedia(storefront_oid, path, opts)
@@ -3086,6 +3322,61 @@ end
3086
3322
  - **Accept**: application/json
3087
3323
 
3088
3324
 
3325
+ ## export_sfvb_not_found
3326
+
3327
+ > <SfvbNotFoundResponse> export_sfvb_not_found(storefront_oid, opts)
3328
+
3329
+ Export the open 404 paths
3330
+
3331
+ Up to 5,000 open paths, most hits first, as the admin's mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
3332
+
3333
+
3334
+ ### Examples
3335
+
3336
+
3337
+ (No example for this operation).
3338
+
3339
+
3340
+ #### Using the export_sfvb_not_found_with_http_info variant
3341
+
3342
+ This returns an Array which contains the response data, status code and headers.
3343
+
3344
+ > <Array(<SfvbNotFoundResponse>, Integer, Hash)> export_sfvb_not_found_with_http_info(storefront_oid, opts)
3345
+
3346
+ ```ruby
3347
+ begin
3348
+ # Export the open 404 paths
3349
+ data, status_code, headers = api_instance.export_sfvb_not_found_with_http_info(storefront_oid, opts)
3350
+ p status_code # => 2xx
3351
+ p headers # => { ... }
3352
+ p data # => <SfvbNotFoundResponse>
3353
+ rescue UltracartClient::ApiError => e
3354
+ puts "Error when calling SfvbApi->export_sfvb_not_found_with_http_info: #{e}"
3355
+ end
3356
+ ```
3357
+
3358
+ ### Parameters
3359
+
3360
+ | Name | Type | Description | Notes |
3361
+ | ---- | ---- | ----------- | ----- |
3362
+ | **storefront_oid** | **Integer** | | |
3363
+ | **include_bots** | **Boolean** | | [optional] |
3364
+ | **include_tokens** | **Boolean** | | [optional] |
3365
+
3366
+ ### Return type
3367
+
3368
+ [**SfvbNotFoundResponse**](SfvbNotFoundResponse.md)
3369
+
3370
+ ### Authorization
3371
+
3372
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3373
+
3374
+ ### HTTP request headers
3375
+
3376
+ - **Content-Type**: Not defined
3377
+ - **Accept**: application/json
3378
+
3379
+
3089
3380
  ## favorite_sfvb_library_entry
3090
3381
 
3091
3382
  > favorite_sfvb_library_entry(storefront_oid, library_oid)
@@ -3140,6 +3431,60 @@ nil (empty response body)
3140
3431
  - **Accept**: application/json
3141
3432
 
3142
3433
 
3434
+ ## fix_sfvb_not_found_entry
3435
+
3436
+ > <SfvbNotFoundEntry> fix_sfvb_not_found_entry(storefront_oid, not_found_id)
3437
+
3438
+ Mark a 404 path fixed
3439
+
3440
+ For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin's Mark Fixed.
3441
+
3442
+
3443
+ ### Examples
3444
+
3445
+
3446
+ (No example for this operation).
3447
+
3448
+
3449
+ #### Using the fix_sfvb_not_found_entry_with_http_info variant
3450
+
3451
+ This returns an Array which contains the response data, status code and headers.
3452
+
3453
+ > <Array(<SfvbNotFoundEntry>, Integer, Hash)> fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
3454
+
3455
+ ```ruby
3456
+ begin
3457
+ # Mark a 404 path fixed
3458
+ data, status_code, headers = api_instance.fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
3459
+ p status_code # => 2xx
3460
+ p headers # => { ... }
3461
+ p data # => <SfvbNotFoundEntry>
3462
+ rescue UltracartClient::ApiError => e
3463
+ puts "Error when calling SfvbApi->fix_sfvb_not_found_entry_with_http_info: #{e}"
3464
+ end
3465
+ ```
3466
+
3467
+ ### Parameters
3468
+
3469
+ | Name | Type | Description | Notes |
3470
+ | ---- | ---- | ----------- | ----- |
3471
+ | **storefront_oid** | **Integer** | | |
3472
+ | **not_found_id** | **String** | | |
3473
+
3474
+ ### Return type
3475
+
3476
+ [**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
3477
+
3478
+ ### Authorization
3479
+
3480
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3481
+
3482
+ ### HTTP request headers
3483
+
3484
+ - **Content-Type**: Not defined
3485
+ - **Accept**: application/json
3486
+
3487
+
3143
3488
  ## get_sfvb_affiliate_network
3144
3489
 
3145
3490
  > <SfvbAffiliateNetwork> get_sfvb_affiliate_network(storefront_oid, affiliate_network_oid)
@@ -3510,6 +3855,167 @@ end
3510
3855
  - **Accept**: application/json
3511
3856
 
3512
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
+
3513
4019
  ## get_sfvb_comms_segment
3514
4020
 
3515
4021
  > <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
@@ -5245,6 +5751,59 @@ end
5245
5751
  - **Accept**: application/json
5246
5752
 
5247
5753
 
5754
+ ## get_sfvb_not_found_summary
5755
+
5756
+ > <SfvbNotFoundSummary> get_sfvb_not_found_summary(storefront_oid)
5757
+
5758
+ The 404 log's trend
5759
+
5760
+ The admin's 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
5761
+
5762
+
5763
+ ### Examples
5764
+
5765
+
5766
+ (No example for this operation).
5767
+
5768
+
5769
+ #### Using the get_sfvb_not_found_summary_with_http_info variant
5770
+
5771
+ This returns an Array which contains the response data, status code and headers.
5772
+
5773
+ > <Array(<SfvbNotFoundSummary>, Integer, Hash)> get_sfvb_not_found_summary_with_http_info(storefront_oid)
5774
+
5775
+ ```ruby
5776
+ begin
5777
+ # The 404 log's trend
5778
+ data, status_code, headers = api_instance.get_sfvb_not_found_summary_with_http_info(storefront_oid)
5779
+ p status_code # => 2xx
5780
+ p headers # => { ... }
5781
+ p data # => <SfvbNotFoundSummary>
5782
+ rescue UltracartClient::ApiError => e
5783
+ puts "Error when calling SfvbApi->get_sfvb_not_found_summary_with_http_info: #{e}"
5784
+ end
5785
+ ```
5786
+
5787
+ ### Parameters
5788
+
5789
+ | Name | Type | Description | Notes |
5790
+ | ---- | ---- | ----------- | ----- |
5791
+ | **storefront_oid** | **Integer** | | |
5792
+
5793
+ ### Return type
5794
+
5795
+ [**SfvbNotFoundSummary**](SfvbNotFoundSummary.md)
5796
+
5797
+ ### Authorization
5798
+
5799
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5800
+
5801
+ ### HTTP request headers
5802
+
5803
+ - **Content-Type**: Not defined
5804
+ - **Accept**: application/json
5805
+
5806
+
5248
5807
  ## get_sfvb_page
5249
5808
 
5250
5809
  > <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
@@ -6138,9 +6697,62 @@ begin
6138
6697
  data, status_code, headers = api_instance.get_sfvb_site_attributes_with_http_info(storefront_oid)
6139
6698
  p status_code # => 2xx
6140
6699
  p headers # => { ... }
6141
- p data # => <SfvbSiteAttributesResponse>
6700
+ p data # => <SfvbSiteAttributesResponse>
6701
+ rescue UltracartClient::ApiError => e
6702
+ puts "Error when calling SfvbApi->get_sfvb_site_attributes_with_http_info: #{e}"
6703
+ end
6704
+ ```
6705
+
6706
+ ### Parameters
6707
+
6708
+ | Name | Type | Description | Notes |
6709
+ | ---- | ---- | ----------- | ----- |
6710
+ | **storefront_oid** | **Integer** | | |
6711
+
6712
+ ### Return type
6713
+
6714
+ [**SfvbSiteAttributesResponse**](SfvbSiteAttributesResponse.md)
6715
+
6716
+ ### Authorization
6717
+
6718
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6719
+
6720
+ ### HTTP request headers
6721
+
6722
+ - **Content-Type**: Not defined
6723
+ - **Accept**: application/json
6724
+
6725
+
6726
+ ## get_sfvb_site_seo
6727
+
6728
+ > <SfvbSiteSeo> get_sfvb_site_seo(storefront_oid)
6729
+
6730
+ Read a storefront's search engine settings
6731
+
6732
+ Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
6733
+
6734
+
6735
+ ### Examples
6736
+
6737
+
6738
+ (No example for this operation).
6739
+
6740
+
6741
+ #### Using the get_sfvb_site_seo_with_http_info variant
6742
+
6743
+ This returns an Array which contains the response data, status code and headers.
6744
+
6745
+ > <Array(<SfvbSiteSeo>, Integer, Hash)> get_sfvb_site_seo_with_http_info(storefront_oid)
6746
+
6747
+ ```ruby
6748
+ begin
6749
+ # Read a storefront's search engine settings
6750
+ data, status_code, headers = api_instance.get_sfvb_site_seo_with_http_info(storefront_oid)
6751
+ p status_code # => 2xx
6752
+ p headers # => { ... }
6753
+ p data # => <SfvbSiteSeo>
6142
6754
  rescue UltracartClient::ApiError => e
6143
- puts "Error when calling SfvbApi->get_sfvb_site_attributes_with_http_info: #{e}"
6755
+ puts "Error when calling SfvbApi->get_sfvb_site_seo_with_http_info: #{e}"
6144
6756
  end
6145
6757
  ```
6146
6758
 
@@ -6152,7 +6764,7 @@ end
6152
6764
 
6153
6765
  ### Return type
6154
6766
 
6155
- [**SfvbSiteAttributesResponse**](SfvbSiteAttributesResponse.md)
6767
+ [**SfvbSiteSeo**](SfvbSiteSeo.md)
6156
6768
 
6157
6769
  ### Authorization
6158
6770
 
@@ -7404,6 +8016,114 @@ end
7404
8016
  - **Accept**: application/json
7405
8017
 
7406
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
+
7407
8127
  ## insert_sfvb_comms_segment
7408
8128
 
7409
8129
  > <SfvbCommsSegmentResponse> insert_sfvb_comms_segment(storefront_oid, segment_write_request)
@@ -11102,6 +11822,60 @@ end
11102
11822
  - **Accept**: application/json
11103
11823
 
11104
11824
 
11825
+ ## resolve_sfvb_redirect_batch
11826
+
11827
+ > <SfvbRedirectResolveBatchResponse> resolve_sfvb_redirect_batch(storefront_oid, redirect_resolve_batch_request)
11828
+
11829
+ What a shopper gets for each of many paths
11830
+
11831
+ Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
11832
+
11833
+
11834
+ ### Examples
11835
+
11836
+
11837
+ (No example for this operation).
11838
+
11839
+
11840
+ #### Using the resolve_sfvb_redirect_batch_with_http_info variant
11841
+
11842
+ This returns an Array which contains the response data, status code and headers.
11843
+
11844
+ > <Array(<SfvbRedirectResolveBatchResponse>, Integer, Hash)> resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request)
11845
+
11846
+ ```ruby
11847
+ begin
11848
+ # What a shopper gets for each of many paths
11849
+ data, status_code, headers = api_instance.resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request)
11850
+ p status_code # => 2xx
11851
+ p headers # => { ... }
11852
+ p data # => <SfvbRedirectResolveBatchResponse>
11853
+ rescue UltracartClient::ApiError => e
11854
+ puts "Error when calling SfvbApi->resolve_sfvb_redirect_batch_with_http_info: #{e}"
11855
+ end
11856
+ ```
11857
+
11858
+ ### Parameters
11859
+
11860
+ | Name | Type | Description | Notes |
11861
+ | ---- | ---- | ----------- | ----- |
11862
+ | **storefront_oid** | **Integer** | | |
11863
+ | **redirect_resolve_batch_request** | [**SfvbRedirectResolveBatchRequest**](SfvbRedirectResolveBatchRequest.md) | The paths | |
11864
+
11865
+ ### Return type
11866
+
11867
+ [**SfvbRedirectResolveBatchResponse**](SfvbRedirectResolveBatchResponse.md)
11868
+
11869
+ ### Authorization
11870
+
11871
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
11872
+
11873
+ ### HTTP request headers
11874
+
11875
+ - **Content-Type**: application/json; charset=UTF-8
11876
+ - **Accept**: application/json
11877
+
11878
+
11105
11879
  ## resolve_sfvb_template
11106
11880
 
11107
11881
  > <SfvbTemplateResolveResponse> resolve_sfvb_template(storefront_oid, name, opts)
@@ -12096,6 +12870,118 @@ end
12096
12870
  - **Accept**: application/json
12097
12871
 
12098
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
+
12099
12985
  ## update_sfvb_comms_segment
12100
12986
 
12101
12987
  > <SfvbCommsSegmentResponse> update_sfvb_comms_segment(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
@@ -12322,7 +13208,7 @@ end
12322
13208
 
12323
13209
  Change a flow
12324
13210
 
12325
- 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.
12326
13212
 
12327
13213
 
12328
13214
  ### Examples
@@ -12653,6 +13539,62 @@ end
12653
13539
  - **Accept**: application/json
12654
13540
 
12655
13541
 
13542
+ ## update_sfvb_site_seo
13543
+
13544
+ > <SfvbSiteSeo> update_sfvb_site_seo(storefront_oid, if_match, site_seo_request, opts)
13545
+
13546
+ Change a storefront's search engine settings
13547
+
13548
+ A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
13549
+
13550
+
13551
+ ### Examples
13552
+
13553
+
13554
+ (No example for this operation).
13555
+
13556
+
13557
+ #### Using the update_sfvb_site_seo_with_http_info variant
13558
+
13559
+ This returns an Array which contains the response data, status code and headers.
13560
+
13561
+ > <Array(<SfvbSiteSeo>, Integer, Hash)> update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts)
13562
+
13563
+ ```ruby
13564
+ begin
13565
+ # Change a storefront's search engine settings
13566
+ data, status_code, headers = api_instance.update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts)
13567
+ p status_code # => 2xx
13568
+ p headers # => { ... }
13569
+ p data # => <SfvbSiteSeo>
13570
+ rescue UltracartClient::ApiError => e
13571
+ puts "Error when calling SfvbApi->update_sfvb_site_seo_with_http_info: #{e}"
13572
+ end
13573
+ ```
13574
+
13575
+ ### Parameters
13576
+
13577
+ | Name | Type | Description | Notes |
13578
+ | ---- | ---- | ----------- | ----- |
13579
+ | **storefront_oid** | **Integer** | | |
13580
+ | **if_match** | **String** | The hash_sha256 from the last read. 428 when absent, 412 when stale. | |
13581
+ | **site_seo_request** | [**SfvbSiteSeoRequest**](SfvbSiteSeoRequest.md) | The switches to change | |
13582
+ | **approval_id** | **String** | When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals. | [optional] |
13583
+
13584
+ ### Return type
13585
+
13586
+ [**SfvbSiteSeo**](SfvbSiteSeo.md)
13587
+
13588
+ ### Authorization
13589
+
13590
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
13591
+
13592
+ ### HTTP request headers
13593
+
13594
+ - **Content-Type**: application/json; charset=UTF-8
13595
+ - **Accept**: application/json
13596
+
13597
+
12656
13598
  ## update_sfvb_smart_attribution
12657
13599
 
12658
13600
  > <SfvbSmartAttribution> update_sfvb_smart_attribution(storefront_oid, if_match, smart_attribution_request, opts)