ultracart_api 4.1.231 → 4.1.233
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.
- checksums.yaml +4 -4
- data/README.md +72 -2
- data/docs/ItemContentMultimedia.md +2 -0
- data/docs/SfvbApi.md +1660 -162
- data/docs/SfvbApprovalCreateRequest.md +8 -0
- data/docs/SfvbCampaign.md +4 -0
- data/docs/SfvbCampaignWriteRequest.md +2 -0
- data/docs/SfvbCommsBranchStat.md +20 -0
- data/docs/SfvbCommsChange.md +22 -0
- data/docs/SfvbCommsClick.md +20 -0
- data/docs/SfvbCommsClicksResponse.md +26 -0
- data/docs/SfvbCommsDailyStat.md +30 -0
- data/docs/SfvbCommsDashboardResponse.md +24 -0
- data/docs/SfvbCommsDashboardRow.md +28 -0
- data/docs/SfvbCommsLookupOwner.md +26 -0
- data/docs/SfvbCommsLookupResponse.md +34 -0
- data/docs/SfvbCommsPlan.md +66 -0
- data/docs/SfvbCommsPlanResponse.md +20 -0
- data/docs/SfvbCommsProvider.md +28 -0
- data/docs/SfvbCommsProviderImportRequest.md +22 -0
- data/docs/SfvbCommsProviderImportResponse.md +26 -0
- data/docs/SfvbCommsProviderList.md +20 -0
- data/docs/SfvbCommsProvidersResponse.md +22 -0
- data/docs/SfvbCommsRulerValidateRequest.md +18 -0
- data/docs/SfvbCommsRulerValidateResponse.md +22 -0
- data/docs/SfvbCommsSender.md +24 -0
- data/docs/SfvbCommsSenderUpdate.md +22 -0
- data/docs/SfvbCommsSequenceFolder.md +28 -0
- data/docs/SfvbCommsSequenceFolderResponse.md +22 -0
- data/docs/SfvbCommsSequenceFoldersResponse.md +18 -0
- data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
- data/docs/SfvbCommsSettings.md +34 -0
- data/docs/SfvbCommsSettingsResponse.md +24 -0
- data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
- data/docs/SfvbCommsStat.md +54 -0
- data/docs/SfvbCommsStepStat.md +34 -0
- data/docs/SfvbCommsTemplate.md +30 -0
- data/docs/SfvbCommsTemplateResponse.md +30 -0
- data/docs/SfvbCommsTemplatesResponse.md +20 -0
- data/docs/SfvbCommsTestEmailRequest.md +24 -0
- data/docs/SfvbCommsTestPostcardRequest.md +36 -0
- data/docs/SfvbCommsTestSendResponse.md +32 -0
- data/docs/SfvbCommsTestSmsRequest.md +18 -0
- data/docs/SfvbCommsUnreferencedEmail.md +30 -0
- data/docs/SfvbCommsUnreferencedPostcard.md +24 -0
- data/docs/SfvbCommsUnreferencedResponse.md +32 -0
- data/docs/SfvbEmail.md +8 -0
- data/docs/SfvbFlow.md +4 -0
- data/docs/SfvbFlowBackfillRequest.md +24 -0
- data/docs/SfvbFlowBackfillResponse.md +38 -0
- data/docs/SfvbFlowWriteRequest.md +2 -0
- data/docs/SfvbStepCounts.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +2356 -348
- data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +39 -3
- data/lib/ultracart_api/models/sfvb_campaign.rb +21 -1
- data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +11 -1
- data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
- data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
- data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
- data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
- data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
- data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
- data/lib/ultracart_api/models/sfvb_comms_lookup_owner.rb +260 -0
- data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb +301 -0
- data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
- data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
- data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
- data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
- data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
- data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
- data/lib/ultracart_api/models/sfvb_comms_ruler_validate_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_comms_ruler_validate_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
- data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_sequence_folder.rb +270 -0
- data/lib/ultracart_api/models/sfvb_comms_sequence_folder_response.rb +243 -0
- data/lib/ultracart_api/models/sfvb_comms_sequence_folders_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
- data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
- data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
- data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
- data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
- data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
- data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
- data/lib/ultracart_api/models/sfvb_comms_template_response.rb +281 -0
- data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
- data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
- data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
- data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
- data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_comms_unreferenced_email.rb +280 -0
- data/lib/ultracart_api/models/sfvb_comms_unreferenced_postcard.rb +250 -0
- data/lib/ultracart_api/models/sfvb_comms_unreferenced_response.rb +296 -0
- data/lib/ultracart_api/models/sfvb_email.rb +41 -1
- data/lib/ultracart_api/models/sfvb_flow.rb +21 -1
- data/lib/ultracart_api/models/sfvb_flow_backfill_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_flow_backfill_response.rb +322 -0
- data/lib/ultracart_api/models/sfvb_flow_write_request.rb +11 -1
- data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +41 -0
- metadata +84 -2
data/docs/SfvbApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
12
12
|
| [**archive_sfvb_flow**](SfvbApi.md#archive_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/archive | Archive or unarchive a flow |
|
|
13
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 |
|
|
14
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 |
|
|
15
|
+
| [**backfill_sfvb_comms_flow**](SfvbApi.md#backfill_sfvb_comms_flow) | **POST** /sfvb/storefronts/{storefront_oid}/comms/flows/{flow_uuid}/backfill | Back populate a live flow, or count who it would enroll |
|
|
15
16
|
| [**check_sfvb_redirect**](SfvbApi.md#check_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/check | Check a redirect rule without creating it |
|
|
16
17
|
| [**clear_sfvb_library_screenshot**](SfvbApi.md#clear_sfvb_library_screenshot) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Remove a library entry's screenshot |
|
|
17
18
|
| [**clone_sfvb_campaign**](SfvbApi.md#clone_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/clone | Copy a campaign on the same storefront |
|
|
@@ -25,6 +26,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
25
26
|
| [**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 |
|
|
26
27
|
| [**delete_sfvb_approval**](SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request |
|
|
27
28
|
| [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
|
|
29
|
+
| [**delete_sfvb_comms_campaign_folder**](SfvbApi.md#delete_sfvb_comms_campaign_folder) | **DELETE** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Delete a campaign folder |
|
|
30
|
+
| [**delete_sfvb_comms_flow_folder**](SfvbApi.md#delete_sfvb_comms_flow_folder) | **DELETE** /sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid} | Delete a flow folder |
|
|
28
31
|
| [**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 |
|
|
29
32
|
| [**delete_sfvb_comms_sending_domain**](SfvbApi.md#delete_sfvb_comms_sending_domain) | **DELETE** /sfvb/comms/sending_domains/{domain} | Remove a sending domain |
|
|
30
33
|
| [**delete_sfvb_comms_twilio_account**](SfvbApi.md#delete_sfvb_comms_twilio_account) | **DELETE** /sfvb/comms/twilio_account | Remove the Twilio account |
|
|
@@ -70,15 +73,29 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
70
73
|
| [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
|
|
71
74
|
| [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
|
|
72
75
|
| [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
|
|
76
|
+
| [**get_sfvb_comms_campaign_folder**](SfvbApi.md#get_sfvb_comms_campaign_folder) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Read one campaign folder |
|
|
77
|
+
| [**get_sfvb_comms_campaign_folders**](SfvbApi.md#get_sfvb_comms_campaign_folders) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders | List the campaign folders |
|
|
78
|
+
| [**get_sfvb_comms_dashboard_stats**](SfvbApi.md#get_sfvb_comms_dashboard_stats) | **GET** /sfvb/storefronts/{storefront_oid}/comms/stats/dashboard | Read every flow's and campaign's counts over a window, with the account's daily sending |
|
|
79
|
+
| [**get_sfvb_comms_email_clicks**](SfvbApi.md#get_sfvb_comms_email_clicks) | **GET** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/emails/{email_uuid}/clicks | Read each link in one email and how often it was clicked |
|
|
80
|
+
| [**get_sfvb_comms_flow_folder**](SfvbApi.md#get_sfvb_comms_flow_folder) | **GET** /sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid} | Read one flow folder |
|
|
81
|
+
| [**get_sfvb_comms_flow_folders**](SfvbApi.md#get_sfvb_comms_flow_folders) | **GET** /sfvb/storefronts/{storefront_oid}/flow_folders | List the flow folders |
|
|
73
82
|
| [**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
83
|
| [**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
84
|
| [**get_sfvb_comms_list**](SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list |
|
|
76
85
|
| [**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 |
|
|
86
|
+
| [**get_sfvb_comms_lookup**](SfvbApi.md#get_sfvb_comms_lookup) | **GET** /sfvb/comms/lookup | Find which storefront a communications uuid lives on |
|
|
87
|
+
| [**get_sfvb_comms_plan**](SfvbApi.md#get_sfvb_comms_plan) | **GET** /sfvb/storefronts/{storefront_oid}/comms/plan | Read the account's communications plan and sending health |
|
|
88
|
+
| [**get_sfvb_comms_providers**](SfvbApi.md#get_sfvb_comms_providers) | **GET** /sfvb/storefronts/{storefront_oid}/comms/providers | List the email providers the account can import lists from |
|
|
77
89
|
| [**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
90
|
| [**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 |
|
|
79
91
|
| [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
|
|
80
92
|
| [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
|
|
93
|
+
| [**get_sfvb_comms_sequence_stats**](SfvbApi.md#get_sfvb_comms_sequence_stats) | **GET** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/stats | Read a flow's or campaign's counts, overall and step by step |
|
|
94
|
+
| [**get_sfvb_comms_settings**](SfvbApi.md#get_sfvb_comms_settings) | **GET** /sfvb/storefronts/{storefront_oid}/comms/settings | Read a storefront's communications settings |
|
|
95
|
+
| [**get_sfvb_comms_template**](SfvbApi.md#get_sfvb_comms_template) | **GET** /sfvb/storefronts/{storefront_oid}/comms/templates/{email_template_oid} | Read one saved email template's body |
|
|
96
|
+
| [**get_sfvb_comms_templates**](SfvbApi.md#get_sfvb_comms_templates) | **GET** /sfvb/storefronts/{storefront_oid}/comms/templates | List the email templates a new email can start from |
|
|
81
97
|
| [**get_sfvb_comms_twilio_account**](SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account |
|
|
98
|
+
| [**get_sfvb_comms_unreferenced**](SfvbApi.md#get_sfvb_comms_unreferenced) | **GET** /sfvb/storefronts/{storefront_oid}/comms/unreferenced | List the emails and postcards on a storefront that no step names |
|
|
82
99
|
| [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
|
|
83
100
|
| [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
|
|
84
101
|
| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
|
|
@@ -147,10 +164,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
147
164
|
| [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
|
|
148
165
|
| [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
|
|
149
166
|
| [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
|
|
167
|
+
| [**import_sfvb_comms_provider_lists**](SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider |
|
|
150
168
|
| [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
|
|
151
169
|
| [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
|
|
152
170
|
| [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
|
|
153
171
|
| [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
|
|
172
|
+
| [**insert_sfvb_comms_campaign_folder**](SfvbApi.md#insert_sfvb_comms_campaign_folder) | **POST** /sfvb/storefronts/{storefront_oid}/campaign_folders | Create a campaign folder |
|
|
173
|
+
| [**insert_sfvb_comms_flow_folder**](SfvbApi.md#insert_sfvb_comms_flow_folder) | **POST** /sfvb/storefronts/{storefront_oid}/flow_folders | Create a flow folder |
|
|
154
174
|
| [**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
175
|
| [**insert_sfvb_comms_list**](SfvbApi.md#insert_sfvb_comms_list) | **POST** /sfvb/storefronts/{storefront_oid}/lists | Create an email list |
|
|
156
176
|
| [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
|
|
@@ -231,6 +251,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
231
251
|
| [**set_sfvb_library_screenshot**](SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot |
|
|
232
252
|
| [**share_sfvb_library_entry**](SfvbApi.md#share_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares | Share a published library entry with a linked account |
|
|
233
253
|
| [**start_sfvb_experiment**](SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment |
|
|
254
|
+
| [**test_sfvb_comms_email**](SfvbApi.md#test_sfvb_comms_email) | **POST** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_email | Send one test of an email step's email to a user on this account |
|
|
255
|
+
| [**test_sfvb_comms_postcard**](SfvbApi.md#test_sfvb_comms_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_postcard | Print and mail one real test postcard |
|
|
256
|
+
| [**test_sfvb_comms_sms**](SfvbApi.md#test_sfvb_comms_sms) | **POST** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_sms | Send one test of an SMS step to a user on this account |
|
|
234
257
|
| [**unarchive_sfvb_upsell_path**](SfvbApi.md#unarchive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/unarchive | Unarchive an upsell path |
|
|
235
258
|
| [**unfavorite_sfvb_library_entry**](SfvbApi.md#unfavorite_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Remove a library entry from favorites |
|
|
236
259
|
| [**unignore_sfvb_not_found_entry**](SfvbApi.md#unignore_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Stop ignoring a 404 path |
|
|
@@ -239,10 +262,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
239
262
|
| [**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 |
|
|
240
263
|
| [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
|
|
241
264
|
| [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
|
|
265
|
+
| [**update_sfvb_comms_campaign_folder**](SfvbApi.md#update_sfvb_comms_campaign_folder) | **PUT** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Rename a campaign folder |
|
|
266
|
+
| [**update_sfvb_comms_flow_folder**](SfvbApi.md#update_sfvb_comms_flow_folder) | **PUT** /sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid} | Rename a flow folder |
|
|
242
267
|
| [**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
268
|
| [**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 |
|
|
244
269
|
| [**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 |
|
|
245
270
|
| [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
|
|
271
|
+
| [**update_sfvb_comms_settings**](SfvbApi.md#update_sfvb_comms_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/comms/settings | Change a storefront's communications settings |
|
|
246
272
|
| [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
|
|
247
273
|
| [**update_sfvb_email**](SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text |
|
|
248
274
|
| [**update_sfvb_flow**](SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow |
|
|
@@ -263,6 +289,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
263
289
|
| [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
|
|
264
290
|
| [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
|
|
265
291
|
| [**validate_sfvb_cjson**](SfvbApi.md#validate_sfvb_cjson) | **POST** /sfvb/cjson/validate | Validate CJSON |
|
|
292
|
+
| [**validate_sfvb_comms_ruler**](SfvbApi.md#validate_sfvb_comms_ruler) | **POST** /sfvb/storefronts/{storefront_oid}/comms/ruler/validate | Check an Event Ruler pattern for an Is in BigQuery segment rule |
|
|
266
293
|
| [**validate_sfvb_velocity**](SfvbApi.md#validate_sfvb_velocity) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/velocity/validate | Validate a Velocity template against a theme |
|
|
267
294
|
|
|
268
295
|
|
|
@@ -707,6 +734,62 @@ end
|
|
|
707
734
|
- **Accept**: application/json
|
|
708
735
|
|
|
709
736
|
|
|
737
|
+
## backfill_sfvb_comms_flow
|
|
738
|
+
|
|
739
|
+
> <SfvbFlowBackfillResponse> backfill_sfvb_comms_flow(storefront_oid, flow_uuid, flow_backfill_request, opts)
|
|
740
|
+
|
|
741
|
+
Back populate a live flow, or count who it would enroll
|
|
742
|
+
|
|
743
|
+
Enrolls customers who would have met the flow's trigger before it existed: a segment trigger's members, or the orders of the last order_days_old days (1 to 90, default 5, every storefront on the account) for an order trigger, up to the plan's customer limit. The flow must be on. dry_run counts them and enrolls nobody. A real backfill needs sfvb_publish, the sign-in of a person, and an approved flow.backfill request for exactly this flow and window; it runs in the background and mails each customer through the flow.
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
### Examples
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
(No example for this operation).
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
#### Using the backfill_sfvb_comms_flow_with_http_info variant
|
|
753
|
+
|
|
754
|
+
This returns an Array which contains the response data, status code and headers.
|
|
755
|
+
|
|
756
|
+
> <Array(<SfvbFlowBackfillResponse>, Integer, Hash)> backfill_sfvb_comms_flow_with_http_info(storefront_oid, flow_uuid, flow_backfill_request, opts)
|
|
757
|
+
|
|
758
|
+
```ruby
|
|
759
|
+
begin
|
|
760
|
+
# Back populate a live flow, or count who it would enroll
|
|
761
|
+
data, status_code, headers = api_instance.backfill_sfvb_comms_flow_with_http_info(storefront_oid, flow_uuid, flow_backfill_request, opts)
|
|
762
|
+
p status_code # => 2xx
|
|
763
|
+
p headers # => { ... }
|
|
764
|
+
p data # => <SfvbFlowBackfillResponse>
|
|
765
|
+
rescue UltracartClient::ApiError => e
|
|
766
|
+
puts "Error when calling SfvbApi->backfill_sfvb_comms_flow_with_http_info: #{e}"
|
|
767
|
+
end
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
### Parameters
|
|
771
|
+
|
|
772
|
+
| Name | Type | Description | Notes |
|
|
773
|
+
| ---- | ---- | ----------- | ----- |
|
|
774
|
+
| **storefront_oid** | **Integer** | | |
|
|
775
|
+
| **flow_uuid** | **String** | | |
|
|
776
|
+
| **flow_backfill_request** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | The window and dry_run | |
|
|
777
|
+
| **approval_id** | **String** | The approval_id of an approved flow.backfill request for exactly this flow and window. See POST /sfvb/approvals. | [optional] |
|
|
778
|
+
|
|
779
|
+
### Return type
|
|
780
|
+
|
|
781
|
+
[**SfvbFlowBackfillResponse**](SfvbFlowBackfillResponse.md)
|
|
782
|
+
|
|
783
|
+
### Authorization
|
|
784
|
+
|
|
785
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
786
|
+
|
|
787
|
+
### HTTP request headers
|
|
788
|
+
|
|
789
|
+
- **Content-Type**: application/json
|
|
790
|
+
- **Accept**: application/json
|
|
791
|
+
|
|
792
|
+
|
|
710
793
|
## check_sfvb_redirect
|
|
711
794
|
|
|
712
795
|
> <SfvbRedirectCheckResponse> check_sfvb_redirect(storefront_oid, redirect_request)
|
|
@@ -1410,6 +1493,116 @@ nil (empty response body)
|
|
|
1410
1493
|
- **Accept**: application/json
|
|
1411
1494
|
|
|
1412
1495
|
|
|
1496
|
+
## delete_sfvb_comms_campaign_folder
|
|
1497
|
+
|
|
1498
|
+
> <SfvbCommsSequenceFolderResponse> delete_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, if_match)
|
|
1499
|
+
|
|
1500
|
+
Delete a campaign folder
|
|
1501
|
+
|
|
1502
|
+
Its campaigns 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.
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
### Examples
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
(No example for this operation).
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
#### Using the delete_sfvb_comms_campaign_folder_with_http_info variant
|
|
1512
|
+
|
|
1513
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1514
|
+
|
|
1515
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> delete_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1516
|
+
|
|
1517
|
+
```ruby
|
|
1518
|
+
begin
|
|
1519
|
+
# Delete a campaign folder
|
|
1520
|
+
data, status_code, headers = api_instance.delete_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1521
|
+
p status_code # => 2xx
|
|
1522
|
+
p headers # => { ... }
|
|
1523
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
1524
|
+
rescue UltracartClient::ApiError => e
|
|
1525
|
+
puts "Error when calling SfvbApi->delete_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
1526
|
+
end
|
|
1527
|
+
```
|
|
1528
|
+
|
|
1529
|
+
### Parameters
|
|
1530
|
+
|
|
1531
|
+
| Name | Type | Description | Notes |
|
|
1532
|
+
| ---- | ---- | ----------- | ----- |
|
|
1533
|
+
| **storefront_oid** | **Integer** | | |
|
|
1534
|
+
| **folder_uuid** | **String** | | |
|
|
1535
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
1536
|
+
|
|
1537
|
+
### Return type
|
|
1538
|
+
|
|
1539
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
1540
|
+
|
|
1541
|
+
### Authorization
|
|
1542
|
+
|
|
1543
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1544
|
+
|
|
1545
|
+
### HTTP request headers
|
|
1546
|
+
|
|
1547
|
+
- **Content-Type**: Not defined
|
|
1548
|
+
- **Accept**: application/json
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
## delete_sfvb_comms_flow_folder
|
|
1552
|
+
|
|
1553
|
+
> <SfvbCommsSequenceFolderResponse> delete_sfvb_comms_flow_folder(storefront_oid, folder_uuid, if_match)
|
|
1554
|
+
|
|
1555
|
+
Delete a flow folder
|
|
1556
|
+
|
|
1557
|
+
Its flows 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.
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
### Examples
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
(No example for this operation).
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
#### Using the delete_sfvb_comms_flow_folder_with_http_info variant
|
|
1567
|
+
|
|
1568
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1569
|
+
|
|
1570
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> delete_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1571
|
+
|
|
1572
|
+
```ruby
|
|
1573
|
+
begin
|
|
1574
|
+
# Delete a flow folder
|
|
1575
|
+
data, status_code, headers = api_instance.delete_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1576
|
+
p status_code # => 2xx
|
|
1577
|
+
p headers # => { ... }
|
|
1578
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
1579
|
+
rescue UltracartClient::ApiError => e
|
|
1580
|
+
puts "Error when calling SfvbApi->delete_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
1581
|
+
end
|
|
1582
|
+
```
|
|
1583
|
+
|
|
1584
|
+
### Parameters
|
|
1585
|
+
|
|
1586
|
+
| Name | Type | Description | Notes |
|
|
1587
|
+
| ---- | ---- | ----------- | ----- |
|
|
1588
|
+
| **storefront_oid** | **Integer** | | |
|
|
1589
|
+
| **folder_uuid** | **String** | | |
|
|
1590
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
1591
|
+
|
|
1592
|
+
### Return type
|
|
1593
|
+
|
|
1594
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
1595
|
+
|
|
1596
|
+
### Authorization
|
|
1597
|
+
|
|
1598
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1599
|
+
|
|
1600
|
+
### HTTP request headers
|
|
1601
|
+
|
|
1602
|
+
- **Content-Type**: Not defined
|
|
1603
|
+
- **Accept**: application/json
|
|
1604
|
+
|
|
1605
|
+
|
|
1413
1606
|
## delete_sfvb_comms_folder
|
|
1414
1607
|
|
|
1415
1608
|
> <SfvbCommsFolderResponse> delete_sfvb_comms_folder(storefront_oid, folder_uuid, if_match)
|
|
@@ -3860,13 +4053,13 @@ end
|
|
|
3860
4053
|
- **Accept**: application/json
|
|
3861
4054
|
|
|
3862
4055
|
|
|
3863
|
-
##
|
|
4056
|
+
## get_sfvb_comms_campaign_folder
|
|
3864
4057
|
|
|
3865
|
-
> <
|
|
4058
|
+
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_campaign_folder(storefront_oid, folder_uuid)
|
|
3866
4059
|
|
|
3867
|
-
Read one
|
|
4060
|
+
Read one campaign folder
|
|
3868
4061
|
|
|
3869
|
-
The folder, with the name and uuid of each
|
|
4062
|
+
The folder, with the name and uuid of each campaign filed in it.
|
|
3870
4063
|
|
|
3871
4064
|
|
|
3872
4065
|
### Examples
|
|
@@ -3875,21 +4068,21 @@ The folder, with the name and uuid of each list and segment filed in it.
|
|
|
3875
4068
|
(No example for this operation).
|
|
3876
4069
|
|
|
3877
4070
|
|
|
3878
|
-
#### Using the
|
|
4071
|
+
#### Using the get_sfvb_comms_campaign_folder_with_http_info variant
|
|
3879
4072
|
|
|
3880
4073
|
This returns an Array which contains the response data, status code and headers.
|
|
3881
4074
|
|
|
3882
|
-
> <Array(<
|
|
4075
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid)
|
|
3883
4076
|
|
|
3884
4077
|
```ruby
|
|
3885
4078
|
begin
|
|
3886
|
-
# Read one
|
|
3887
|
-
data, status_code, headers = api_instance.
|
|
4079
|
+
# Read one campaign folder
|
|
4080
|
+
data, status_code, headers = api_instance.get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid)
|
|
3888
4081
|
p status_code # => 2xx
|
|
3889
4082
|
p headers # => { ... }
|
|
3890
|
-
p data # => <
|
|
4083
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
3891
4084
|
rescue UltracartClient::ApiError => e
|
|
3892
|
-
puts "Error when calling SfvbApi->
|
|
4085
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
3893
4086
|
end
|
|
3894
4087
|
```
|
|
3895
4088
|
|
|
@@ -3902,7 +4095,7 @@ end
|
|
|
3902
4095
|
|
|
3903
4096
|
### Return type
|
|
3904
4097
|
|
|
3905
|
-
[**
|
|
4098
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
3906
4099
|
|
|
3907
4100
|
### Authorization
|
|
3908
4101
|
|
|
@@ -3914,13 +4107,13 @@ end
|
|
|
3914
4107
|
- **Accept**: application/json
|
|
3915
4108
|
|
|
3916
4109
|
|
|
3917
|
-
##
|
|
4110
|
+
## get_sfvb_comms_campaign_folders
|
|
3918
4111
|
|
|
3919
|
-
> <
|
|
4112
|
+
> <SfvbCommsSequenceFoldersResponse> get_sfvb_comms_campaign_folders(storefront_oid)
|
|
3920
4113
|
|
|
3921
|
-
List the
|
|
4114
|
+
List the campaign folders
|
|
3922
4115
|
|
|
3923
|
-
Each folder with how many
|
|
4116
|
+
Each campaign folder with how many campaigns are filed in it, whether the admin made it, and its hash_sha256.
|
|
3924
4117
|
|
|
3925
4118
|
|
|
3926
4119
|
### Examples
|
|
@@ -3929,21 +4122,21 @@ Each folder with how many lists and segments are filed in it, whether the admin
|
|
|
3929
4122
|
(No example for this operation).
|
|
3930
4123
|
|
|
3931
4124
|
|
|
3932
|
-
#### Using the
|
|
4125
|
+
#### Using the get_sfvb_comms_campaign_folders_with_http_info variant
|
|
3933
4126
|
|
|
3934
4127
|
This returns an Array which contains the response data, status code and headers.
|
|
3935
4128
|
|
|
3936
|
-
> <Array(<
|
|
4129
|
+
> <Array(<SfvbCommsSequenceFoldersResponse>, Integer, Hash)> get_sfvb_comms_campaign_folders_with_http_info(storefront_oid)
|
|
3937
4130
|
|
|
3938
4131
|
```ruby
|
|
3939
4132
|
begin
|
|
3940
|
-
# List the
|
|
3941
|
-
data, status_code, headers = api_instance.
|
|
4133
|
+
# List the campaign folders
|
|
4134
|
+
data, status_code, headers = api_instance.get_sfvb_comms_campaign_folders_with_http_info(storefront_oid)
|
|
3942
4135
|
p status_code # => 2xx
|
|
3943
4136
|
p headers # => { ... }
|
|
3944
|
-
p data # => <
|
|
4137
|
+
p data # => <SfvbCommsSequenceFoldersResponse>
|
|
3945
4138
|
rescue UltracartClient::ApiError => e
|
|
3946
|
-
puts "Error when calling SfvbApi->
|
|
4139
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_campaign_folders_with_http_info: #{e}"
|
|
3947
4140
|
end
|
|
3948
4141
|
```
|
|
3949
4142
|
|
|
@@ -3955,7 +4148,7 @@ end
|
|
|
3955
4148
|
|
|
3956
4149
|
### Return type
|
|
3957
4150
|
|
|
3958
|
-
[**
|
|
4151
|
+
[**SfvbCommsSequenceFoldersResponse**](SfvbCommsSequenceFoldersResponse.md)
|
|
3959
4152
|
|
|
3960
4153
|
### Authorization
|
|
3961
4154
|
|
|
@@ -3967,13 +4160,13 @@ end
|
|
|
3967
4160
|
- **Accept**: application/json
|
|
3968
4161
|
|
|
3969
4162
|
|
|
3970
|
-
##
|
|
4163
|
+
## get_sfvb_comms_dashboard_stats
|
|
3971
4164
|
|
|
3972
|
-
> <
|
|
4165
|
+
> <SfvbCommsDashboardResponse> get_sfvb_comms_dashboard_stats(storefront_oid, opts)
|
|
3973
4166
|
|
|
3974
|
-
Read
|
|
4167
|
+
Read every flow's and campaign's counts over a window, with the account's daily sending
|
|
3975
4168
|
|
|
3976
|
-
|
|
4169
|
+
rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account's last 31 days of sending, whatever the window. Read only.
|
|
3977
4170
|
|
|
3978
4171
|
|
|
3979
4172
|
### Examples
|
|
@@ -3982,21 +4175,21 @@ The list's name, folder, member count, public settings, and the campaigns and fl
|
|
|
3982
4175
|
(No example for this operation).
|
|
3983
4176
|
|
|
3984
4177
|
|
|
3985
|
-
#### Using the
|
|
4178
|
+
#### Using the get_sfvb_comms_dashboard_stats_with_http_info variant
|
|
3986
4179
|
|
|
3987
4180
|
This returns an Array which contains the response data, status code and headers.
|
|
3988
4181
|
|
|
3989
|
-
> <Array(<
|
|
4182
|
+
> <Array(<SfvbCommsDashboardResponse>, Integer, Hash)> get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts)
|
|
3990
4183
|
|
|
3991
4184
|
```ruby
|
|
3992
4185
|
begin
|
|
3993
|
-
# Read
|
|
3994
|
-
data, status_code, headers = api_instance.
|
|
4186
|
+
# Read every flow's and campaign's counts over a window, with the account's daily sending
|
|
4187
|
+
data, status_code, headers = api_instance.get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts)
|
|
3995
4188
|
p status_code # => 2xx
|
|
3996
4189
|
p headers # => { ... }
|
|
3997
|
-
p data # => <
|
|
4190
|
+
p data # => <SfvbCommsDashboardResponse>
|
|
3998
4191
|
rescue UltracartClient::ApiError => e
|
|
3999
|
-
puts "Error when calling SfvbApi->
|
|
4192
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_dashboard_stats_with_http_info: #{e}"
|
|
4000
4193
|
end
|
|
4001
4194
|
```
|
|
4002
4195
|
|
|
@@ -4005,11 +4198,11 @@ end
|
|
|
4005
4198
|
| Name | Type | Description | Notes |
|
|
4006
4199
|
| ---- | ---- | ----------- | ----- |
|
|
4007
4200
|
| **storefront_oid** | **Integer** | | |
|
|
4008
|
-
| **
|
|
4201
|
+
| **days** | **Integer** | The window for the rows, 1 to 365 days (default 30). | [optional] |
|
|
4009
4202
|
|
|
4010
4203
|
### Return type
|
|
4011
4204
|
|
|
4012
|
-
[**
|
|
4205
|
+
[**SfvbCommsDashboardResponse**](SfvbCommsDashboardResponse.md)
|
|
4013
4206
|
|
|
4014
4207
|
### Authorization
|
|
4015
4208
|
|
|
@@ -4021,13 +4214,13 @@ end
|
|
|
4021
4214
|
- **Accept**: application/json
|
|
4022
4215
|
|
|
4023
4216
|
|
|
4024
|
-
##
|
|
4217
|
+
## get_sfvb_comms_email_clicks
|
|
4025
4218
|
|
|
4026
|
-
> <
|
|
4219
|
+
> <SfvbCommsClicksResponse> get_sfvb_comms_email_clicks(storefront_oid, commseq_uuid, email_uuid, opts)
|
|
4027
4220
|
|
|
4028
|
-
Read one
|
|
4221
|
+
Read each link in one email and how often it was clicked
|
|
4029
4222
|
|
|
4030
|
-
|
|
4223
|
+
The email must be sent by an email or experiment step of this flow's or campaign's sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
|
|
4031
4224
|
|
|
4032
4225
|
|
|
4033
4226
|
### Examples
|
|
@@ -4036,21 +4229,21 @@ Each member's customer uuid, email and the date they joined. Email addresses ar
|
|
|
4036
4229
|
(No example for this operation).
|
|
4037
4230
|
|
|
4038
4231
|
|
|
4039
|
-
#### Using the
|
|
4232
|
+
#### Using the get_sfvb_comms_email_clicks_with_http_info variant
|
|
4040
4233
|
|
|
4041
4234
|
This returns an Array which contains the response data, status code and headers.
|
|
4042
4235
|
|
|
4043
|
-
> <Array(<
|
|
4236
|
+
> <Array(<SfvbCommsClicksResponse>, Integer, Hash)> get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts)
|
|
4044
4237
|
|
|
4045
4238
|
```ruby
|
|
4046
4239
|
begin
|
|
4047
|
-
# Read one
|
|
4048
|
-
data, status_code, headers = api_instance.
|
|
4240
|
+
# Read each link in one email and how often it was clicked
|
|
4241
|
+
data, status_code, headers = api_instance.get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts)
|
|
4049
4242
|
p status_code # => 2xx
|
|
4050
4243
|
p headers # => { ... }
|
|
4051
|
-
p data # => <
|
|
4244
|
+
p data # => <SfvbCommsClicksResponse>
|
|
4052
4245
|
rescue UltracartClient::ApiError => e
|
|
4053
|
-
puts "Error when calling SfvbApi->
|
|
4246
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_email_clicks_with_http_info: #{e}"
|
|
4054
4247
|
end
|
|
4055
4248
|
```
|
|
4056
4249
|
|
|
@@ -4059,14 +4252,13 @@ end
|
|
|
4059
4252
|
| Name | Type | Description | Notes |
|
|
4060
4253
|
| ---- | ---- | ----------- | ----- |
|
|
4061
4254
|
| **storefront_oid** | **Integer** | | |
|
|
4062
|
-
| **
|
|
4063
|
-
| **
|
|
4064
|
-
| **
|
|
4065
|
-
| **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
|
|
4255
|
+
| **commseq_uuid** | **String** | | |
|
|
4256
|
+
| **email_uuid** | **String** | | |
|
|
4257
|
+
| **days** | **Integer** | The window, 1 to 365 days (default 30). | [optional] |
|
|
4066
4258
|
|
|
4067
4259
|
### Return type
|
|
4068
4260
|
|
|
4069
|
-
[**
|
|
4261
|
+
[**SfvbCommsClicksResponse**](SfvbCommsClicksResponse.md)
|
|
4070
4262
|
|
|
4071
4263
|
### Authorization
|
|
4072
4264
|
|
|
@@ -4078,13 +4270,13 @@ end
|
|
|
4078
4270
|
- **Accept**: application/json
|
|
4079
4271
|
|
|
4080
4272
|
|
|
4081
|
-
##
|
|
4273
|
+
## get_sfvb_comms_flow_folder
|
|
4082
4274
|
|
|
4083
|
-
> <
|
|
4275
|
+
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_flow_folder(storefront_oid, folder_uuid)
|
|
4084
4276
|
|
|
4085
|
-
Read one
|
|
4277
|
+
Read one flow folder
|
|
4086
4278
|
|
|
4087
|
-
The
|
|
4279
|
+
The folder, with the name and uuid of each flow filed in it.
|
|
4088
4280
|
|
|
4089
4281
|
|
|
4090
4282
|
### Examples
|
|
@@ -4093,21 +4285,21 @@ The segment's name, folder, rule, member count at its last rebuild, whether a re
|
|
|
4093
4285
|
(No example for this operation).
|
|
4094
4286
|
|
|
4095
4287
|
|
|
4096
|
-
#### Using the
|
|
4288
|
+
#### Using the get_sfvb_comms_flow_folder_with_http_info variant
|
|
4097
4289
|
|
|
4098
4290
|
This returns an Array which contains the response data, status code and headers.
|
|
4099
4291
|
|
|
4100
|
-
> <Array(<
|
|
4292
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4101
4293
|
|
|
4102
4294
|
```ruby
|
|
4103
4295
|
begin
|
|
4104
|
-
# Read one
|
|
4105
|
-
data, status_code, headers = api_instance.
|
|
4296
|
+
# Read one flow folder
|
|
4297
|
+
data, status_code, headers = api_instance.get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4106
4298
|
p status_code # => 2xx
|
|
4107
4299
|
p headers # => { ... }
|
|
4108
|
-
p data # => <
|
|
4300
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
4109
4301
|
rescue UltracartClient::ApiError => e
|
|
4110
|
-
puts "Error when calling SfvbApi->
|
|
4302
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
4111
4303
|
end
|
|
4112
4304
|
```
|
|
4113
4305
|
|
|
@@ -4116,11 +4308,11 @@ end
|
|
|
4116
4308
|
| Name | Type | Description | Notes |
|
|
4117
4309
|
| ---- | ---- | ----------- | ----- |
|
|
4118
4310
|
| **storefront_oid** | **Integer** | | |
|
|
4119
|
-
| **
|
|
4311
|
+
| **folder_uuid** | **String** | | |
|
|
4120
4312
|
|
|
4121
4313
|
### Return type
|
|
4122
4314
|
|
|
4123
|
-
[**
|
|
4315
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
4124
4316
|
|
|
4125
4317
|
### Authorization
|
|
4126
4318
|
|
|
@@ -4132,13 +4324,13 @@ end
|
|
|
4132
4324
|
- **Accept**: application/json
|
|
4133
4325
|
|
|
4134
4326
|
|
|
4135
|
-
##
|
|
4327
|
+
## get_sfvb_comms_flow_folders
|
|
4136
4328
|
|
|
4137
|
-
> <
|
|
4329
|
+
> <SfvbCommsSequenceFoldersResponse> get_sfvb_comms_flow_folders(storefront_oid)
|
|
4138
4330
|
|
|
4139
|
-
|
|
4331
|
+
List the flow folders
|
|
4140
4332
|
|
|
4141
|
-
Each
|
|
4333
|
+
Each flow folder with how many flows are filed in it, whether the admin made it, and its hash_sha256.
|
|
4142
4334
|
|
|
4143
4335
|
|
|
4144
4336
|
### Examples
|
|
@@ -4147,21 +4339,21 @@ Each member's customer uuid, email and the date they joined. Email addresses ar
|
|
|
4147
4339
|
(No example for this operation).
|
|
4148
4340
|
|
|
4149
4341
|
|
|
4150
|
-
#### Using the
|
|
4342
|
+
#### Using the get_sfvb_comms_flow_folders_with_http_info variant
|
|
4151
4343
|
|
|
4152
4344
|
This returns an Array which contains the response data, status code and headers.
|
|
4153
4345
|
|
|
4154
|
-
> <Array(<
|
|
4346
|
+
> <Array(<SfvbCommsSequenceFoldersResponse>, Integer, Hash)> get_sfvb_comms_flow_folders_with_http_info(storefront_oid)
|
|
4155
4347
|
|
|
4156
4348
|
```ruby
|
|
4157
4349
|
begin
|
|
4158
|
-
#
|
|
4159
|
-
data, status_code, headers = api_instance.
|
|
4350
|
+
# List the flow folders
|
|
4351
|
+
data, status_code, headers = api_instance.get_sfvb_comms_flow_folders_with_http_info(storefront_oid)
|
|
4160
4352
|
p status_code # => 2xx
|
|
4161
4353
|
p headers # => { ... }
|
|
4162
|
-
p data # => <
|
|
4354
|
+
p data # => <SfvbCommsSequenceFoldersResponse>
|
|
4163
4355
|
rescue UltracartClient::ApiError => e
|
|
4164
|
-
puts "Error when calling SfvbApi->
|
|
4356
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_flow_folders_with_http_info: #{e}"
|
|
4165
4357
|
end
|
|
4166
4358
|
```
|
|
4167
4359
|
|
|
@@ -4170,14 +4362,10 @@ end
|
|
|
4170
4362
|
| Name | Type | Description | Notes |
|
|
4171
4363
|
| ---- | ---- | ----------- | ----- |
|
|
4172
4364
|
| **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
4365
|
|
|
4178
4366
|
### Return type
|
|
4179
4367
|
|
|
4180
|
-
[**
|
|
4368
|
+
[**SfvbCommsSequenceFoldersResponse**](SfvbCommsSequenceFoldersResponse.md)
|
|
4181
4369
|
|
|
4182
4370
|
### Authorization
|
|
4183
4371
|
|
|
@@ -4189,13 +4377,13 @@ end
|
|
|
4189
4377
|
- **Accept**: application/json
|
|
4190
4378
|
|
|
4191
4379
|
|
|
4192
|
-
##
|
|
4380
|
+
## get_sfvb_comms_folder
|
|
4193
4381
|
|
|
4194
|
-
> <
|
|
4382
|
+
> <SfvbCommsFolderResponse> get_sfvb_comms_folder(storefront_oid, folder_uuid)
|
|
4195
4383
|
|
|
4196
|
-
Read
|
|
4384
|
+
Read one list and segment folder
|
|
4197
4385
|
|
|
4198
|
-
|
|
4386
|
+
The folder, with the name and uuid of each list and segment filed in it.
|
|
4199
4387
|
|
|
4200
4388
|
|
|
4201
4389
|
### Examples
|
|
@@ -4204,21 +4392,21 @@ One sending domain as stored. To check an amazon domain's DNS again, use the st
|
|
|
4204
4392
|
(No example for this operation).
|
|
4205
4393
|
|
|
4206
4394
|
|
|
4207
|
-
#### Using the
|
|
4395
|
+
#### Using the get_sfvb_comms_folder_with_http_info variant
|
|
4208
4396
|
|
|
4209
4397
|
This returns an Array which contains the response data, status code and headers.
|
|
4210
4398
|
|
|
4211
|
-
> <Array(<
|
|
4399
|
+
> <Array(<SfvbCommsFolderResponse>, Integer, Hash)> get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4212
4400
|
|
|
4213
4401
|
```ruby
|
|
4214
4402
|
begin
|
|
4215
|
-
# Read
|
|
4216
|
-
data, status_code, headers = api_instance.
|
|
4403
|
+
# Read one list and segment folder
|
|
4404
|
+
data, status_code, headers = api_instance.get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4217
4405
|
p status_code # => 2xx
|
|
4218
4406
|
p headers # => { ... }
|
|
4219
|
-
p data # => <
|
|
4407
|
+
p data # => <SfvbCommsFolderResponse>
|
|
4220
4408
|
rescue UltracartClient::ApiError => e
|
|
4221
|
-
puts "Error when calling SfvbApi->
|
|
4409
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_folder_with_http_info: #{e}"
|
|
4222
4410
|
end
|
|
4223
4411
|
```
|
|
4224
4412
|
|
|
@@ -4226,11 +4414,12 @@ end
|
|
|
4226
4414
|
|
|
4227
4415
|
| Name | Type | Description | Notes |
|
|
4228
4416
|
| ---- | ---- | ----------- | ----- |
|
|
4229
|
-
| **
|
|
4417
|
+
| **storefront_oid** | **Integer** | | |
|
|
4418
|
+
| **folder_uuid** | **String** | | |
|
|
4230
4419
|
|
|
4231
4420
|
### Return type
|
|
4232
4421
|
|
|
4233
|
-
[**
|
|
4422
|
+
[**SfvbCommsFolderResponse**](SfvbCommsFolderResponse.md)
|
|
4234
4423
|
|
|
4235
4424
|
### Authorization
|
|
4236
4425
|
|
|
@@ -4242,13 +4431,13 @@ end
|
|
|
4242
4431
|
- **Accept**: application/json
|
|
4243
4432
|
|
|
4244
4433
|
|
|
4245
|
-
##
|
|
4434
|
+
## get_sfvb_comms_folders
|
|
4246
4435
|
|
|
4247
|
-
> <
|
|
4436
|
+
> <SfvbCommsFoldersResponse> get_sfvb_comms_folders(storefront_oid)
|
|
4248
4437
|
|
|
4249
|
-
List the
|
|
4438
|
+
List the list and segment folders
|
|
4250
4439
|
|
|
4251
|
-
|
|
4440
|
+
Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
4252
4441
|
|
|
4253
4442
|
|
|
4254
4443
|
### Examples
|
|
@@ -4257,28 +4446,515 @@ Every domain the account sends email from, with its provider, verification statu
|
|
|
4257
4446
|
(No example for this operation).
|
|
4258
4447
|
|
|
4259
4448
|
|
|
4260
|
-
#### Using the
|
|
4449
|
+
#### Using the get_sfvb_comms_folders_with_http_info variant
|
|
4261
4450
|
|
|
4262
4451
|
This returns an Array which contains the response data, status code and headers.
|
|
4263
4452
|
|
|
4264
|
-
> <Array(<
|
|
4453
|
+
> <Array(<SfvbCommsFoldersResponse>, Integer, Hash)> get_sfvb_comms_folders_with_http_info(storefront_oid)
|
|
4265
4454
|
|
|
4266
4455
|
```ruby
|
|
4267
4456
|
begin
|
|
4268
|
-
# List the
|
|
4269
|
-
data, status_code, headers = api_instance.
|
|
4457
|
+
# List the list and segment folders
|
|
4458
|
+
data, status_code, headers = api_instance.get_sfvb_comms_folders_with_http_info(storefront_oid)
|
|
4270
4459
|
p status_code # => 2xx
|
|
4271
4460
|
p headers # => { ... }
|
|
4272
|
-
p data # => <
|
|
4461
|
+
p data # => <SfvbCommsFoldersResponse>
|
|
4273
4462
|
rescue UltracartClient::ApiError => e
|
|
4274
|
-
puts "Error when calling SfvbApi->
|
|
4463
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_folders_with_http_info: #{e}"
|
|
4275
4464
|
end
|
|
4276
4465
|
```
|
|
4277
4466
|
|
|
4278
4467
|
### Parameters
|
|
4279
4468
|
|
|
4280
|
-
|
|
4281
|
-
|
|
4469
|
+
| Name | Type | Description | Notes |
|
|
4470
|
+
| ---- | ---- | ----------- | ----- |
|
|
4471
|
+
| **storefront_oid** | **Integer** | | |
|
|
4472
|
+
|
|
4473
|
+
### Return type
|
|
4474
|
+
|
|
4475
|
+
[**SfvbCommsFoldersResponse**](SfvbCommsFoldersResponse.md)
|
|
4476
|
+
|
|
4477
|
+
### Authorization
|
|
4478
|
+
|
|
4479
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4480
|
+
|
|
4481
|
+
### HTTP request headers
|
|
4482
|
+
|
|
4483
|
+
- **Content-Type**: Not defined
|
|
4484
|
+
- **Accept**: application/json
|
|
4485
|
+
|
|
4486
|
+
|
|
4487
|
+
## get_sfvb_comms_list
|
|
4488
|
+
|
|
4489
|
+
> <SfvbCommsListResponse> get_sfvb_comms_list(storefront_oid, list_uuid)
|
|
4490
|
+
|
|
4491
|
+
Read one email list
|
|
4492
|
+
|
|
4493
|
+
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.
|
|
4494
|
+
|
|
4495
|
+
|
|
4496
|
+
### Examples
|
|
4497
|
+
|
|
4498
|
+
|
|
4499
|
+
(No example for this operation).
|
|
4500
|
+
|
|
4501
|
+
|
|
4502
|
+
#### Using the get_sfvb_comms_list_with_http_info variant
|
|
4503
|
+
|
|
4504
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4505
|
+
|
|
4506
|
+
> <Array(<SfvbCommsListResponse>, Integer, Hash)> get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid)
|
|
4507
|
+
|
|
4508
|
+
```ruby
|
|
4509
|
+
begin
|
|
4510
|
+
# Read one email list
|
|
4511
|
+
data, status_code, headers = api_instance.get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid)
|
|
4512
|
+
p status_code # => 2xx
|
|
4513
|
+
p headers # => { ... }
|
|
4514
|
+
p data # => <SfvbCommsListResponse>
|
|
4515
|
+
rescue UltracartClient::ApiError => e
|
|
4516
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_list_with_http_info: #{e}"
|
|
4517
|
+
end
|
|
4518
|
+
```
|
|
4519
|
+
|
|
4520
|
+
### Parameters
|
|
4521
|
+
|
|
4522
|
+
| Name | Type | Description | Notes |
|
|
4523
|
+
| ---- | ---- | ----------- | ----- |
|
|
4524
|
+
| **storefront_oid** | **Integer** | | |
|
|
4525
|
+
| **list_uuid** | **String** | | |
|
|
4526
|
+
|
|
4527
|
+
### Return type
|
|
4528
|
+
|
|
4529
|
+
[**SfvbCommsListResponse**](SfvbCommsListResponse.md)
|
|
4530
|
+
|
|
4531
|
+
### Authorization
|
|
4532
|
+
|
|
4533
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4534
|
+
|
|
4535
|
+
### HTTP request headers
|
|
4536
|
+
|
|
4537
|
+
- **Content-Type**: Not defined
|
|
4538
|
+
- **Accept**: application/json
|
|
4539
|
+
|
|
4540
|
+
|
|
4541
|
+
## get_sfvb_comms_list_members
|
|
4542
|
+
|
|
4543
|
+
> <SfvbCommsMembersResponse> get_sfvb_comms_list_members(storefront_oid, list_uuid, opts)
|
|
4544
|
+
|
|
4545
|
+
Read one page of a list's members
|
|
4546
|
+
|
|
4547
|
+
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.
|
|
4548
|
+
|
|
4549
|
+
|
|
4550
|
+
### Examples
|
|
4551
|
+
|
|
4552
|
+
|
|
4553
|
+
(No example for this operation).
|
|
4554
|
+
|
|
4555
|
+
|
|
4556
|
+
#### Using the get_sfvb_comms_list_members_with_http_info variant
|
|
4557
|
+
|
|
4558
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4559
|
+
|
|
4560
|
+
> <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
|
|
4561
|
+
|
|
4562
|
+
```ruby
|
|
4563
|
+
begin
|
|
4564
|
+
# Read one page of a list's members
|
|
4565
|
+
data, status_code, headers = api_instance.get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
|
|
4566
|
+
p status_code # => 2xx
|
|
4567
|
+
p headers # => { ... }
|
|
4568
|
+
p data # => <SfvbCommsMembersResponse>
|
|
4569
|
+
rescue UltracartClient::ApiError => e
|
|
4570
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_list_members_with_http_info: #{e}"
|
|
4571
|
+
end
|
|
4572
|
+
```
|
|
4573
|
+
|
|
4574
|
+
### Parameters
|
|
4575
|
+
|
|
4576
|
+
| Name | Type | Description | Notes |
|
|
4577
|
+
| ---- | ---- | ----------- | ----- |
|
|
4578
|
+
| **storefront_oid** | **Integer** | | |
|
|
4579
|
+
| **list_uuid** | **String** | | |
|
|
4580
|
+
| **page** | **Integer** | The page, from 1 | [optional] |
|
|
4581
|
+
| **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
|
|
4582
|
+
| **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
|
|
4583
|
+
|
|
4584
|
+
### Return type
|
|
4585
|
+
|
|
4586
|
+
[**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
|
|
4587
|
+
|
|
4588
|
+
### Authorization
|
|
4589
|
+
|
|
4590
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4591
|
+
|
|
4592
|
+
### HTTP request headers
|
|
4593
|
+
|
|
4594
|
+
- **Content-Type**: Not defined
|
|
4595
|
+
- **Accept**: application/json
|
|
4596
|
+
|
|
4597
|
+
|
|
4598
|
+
## get_sfvb_comms_lookup
|
|
4599
|
+
|
|
4600
|
+
> <SfvbCommsLookupResponse> get_sfvb_comms_lookup(uuid)
|
|
4601
|
+
|
|
4602
|
+
Find which storefront a communications uuid lives on
|
|
4603
|
+
|
|
4604
|
+
Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account's storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account's included, is 404. Read only.
|
|
4605
|
+
|
|
4606
|
+
|
|
4607
|
+
### Examples
|
|
4608
|
+
|
|
4609
|
+
|
|
4610
|
+
(No example for this operation).
|
|
4611
|
+
|
|
4612
|
+
|
|
4613
|
+
#### Using the get_sfvb_comms_lookup_with_http_info variant
|
|
4614
|
+
|
|
4615
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4616
|
+
|
|
4617
|
+
> <Array(<SfvbCommsLookupResponse>, Integer, Hash)> get_sfvb_comms_lookup_with_http_info(uuid)
|
|
4618
|
+
|
|
4619
|
+
```ruby
|
|
4620
|
+
begin
|
|
4621
|
+
# Find which storefront a communications uuid lives on
|
|
4622
|
+
data, status_code, headers = api_instance.get_sfvb_comms_lookup_with_http_info(uuid)
|
|
4623
|
+
p status_code # => 2xx
|
|
4624
|
+
p headers # => { ... }
|
|
4625
|
+
p data # => <SfvbCommsLookupResponse>
|
|
4626
|
+
rescue UltracartClient::ApiError => e
|
|
4627
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_lookup_with_http_info: #{e}"
|
|
4628
|
+
end
|
|
4629
|
+
```
|
|
4630
|
+
|
|
4631
|
+
### Parameters
|
|
4632
|
+
|
|
4633
|
+
| Name | Type | Description | Notes |
|
|
4634
|
+
| ---- | ---- | ----------- | ----- |
|
|
4635
|
+
| **uuid** | **String** | The uuid to find. | |
|
|
4636
|
+
|
|
4637
|
+
### Return type
|
|
4638
|
+
|
|
4639
|
+
[**SfvbCommsLookupResponse**](SfvbCommsLookupResponse.md)
|
|
4640
|
+
|
|
4641
|
+
### Authorization
|
|
4642
|
+
|
|
4643
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4644
|
+
|
|
4645
|
+
### HTTP request headers
|
|
4646
|
+
|
|
4647
|
+
- **Content-Type**: Not defined
|
|
4648
|
+
- **Accept**: application/json
|
|
4649
|
+
|
|
4650
|
+
|
|
4651
|
+
## get_sfvb_comms_plan
|
|
4652
|
+
|
|
4653
|
+
> <SfvbCommsPlanResponse> get_sfvb_comms_plan(storefront_oid)
|
|
4654
|
+
|
|
4655
|
+
Read the account's communications plan and sending health
|
|
4656
|
+
|
|
4657
|
+
The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
|
|
4658
|
+
|
|
4659
|
+
|
|
4660
|
+
### Examples
|
|
4661
|
+
|
|
4662
|
+
|
|
4663
|
+
(No example for this operation).
|
|
4664
|
+
|
|
4665
|
+
|
|
4666
|
+
#### Using the get_sfvb_comms_plan_with_http_info variant
|
|
4667
|
+
|
|
4668
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4669
|
+
|
|
4670
|
+
> <Array(<SfvbCommsPlanResponse>, Integer, Hash)> get_sfvb_comms_plan_with_http_info(storefront_oid)
|
|
4671
|
+
|
|
4672
|
+
```ruby
|
|
4673
|
+
begin
|
|
4674
|
+
# Read the account's communications plan and sending health
|
|
4675
|
+
data, status_code, headers = api_instance.get_sfvb_comms_plan_with_http_info(storefront_oid)
|
|
4676
|
+
p status_code # => 2xx
|
|
4677
|
+
p headers # => { ... }
|
|
4678
|
+
p data # => <SfvbCommsPlanResponse>
|
|
4679
|
+
rescue UltracartClient::ApiError => e
|
|
4680
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_plan_with_http_info: #{e}"
|
|
4681
|
+
end
|
|
4682
|
+
```
|
|
4683
|
+
|
|
4684
|
+
### Parameters
|
|
4685
|
+
|
|
4686
|
+
| Name | Type | Description | Notes |
|
|
4687
|
+
| ---- | ---- | ----------- | ----- |
|
|
4688
|
+
| **storefront_oid** | **Integer** | | |
|
|
4689
|
+
|
|
4690
|
+
### Return type
|
|
4691
|
+
|
|
4692
|
+
[**SfvbCommsPlanResponse**](SfvbCommsPlanResponse.md)
|
|
4693
|
+
|
|
4694
|
+
### Authorization
|
|
4695
|
+
|
|
4696
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4697
|
+
|
|
4698
|
+
### HTTP request headers
|
|
4699
|
+
|
|
4700
|
+
- **Content-Type**: Not defined
|
|
4701
|
+
- **Accept**: application/json
|
|
4702
|
+
|
|
4703
|
+
|
|
4704
|
+
## get_sfvb_comms_providers
|
|
4705
|
+
|
|
4706
|
+
> <SfvbCommsProvidersResponse> get_sfvb_comms_providers(storefront_oid)
|
|
4707
|
+
|
|
4708
|
+
List the email providers the account can import lists from
|
|
4709
|
+
|
|
4710
|
+
Each provider that can share list members, connected or not, with a connected one's lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
|
|
4711
|
+
|
|
4712
|
+
|
|
4713
|
+
### Examples
|
|
4714
|
+
|
|
4715
|
+
|
|
4716
|
+
(No example for this operation).
|
|
4717
|
+
|
|
4718
|
+
|
|
4719
|
+
#### Using the get_sfvb_comms_providers_with_http_info variant
|
|
4720
|
+
|
|
4721
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4722
|
+
|
|
4723
|
+
> <Array(<SfvbCommsProvidersResponse>, Integer, Hash)> get_sfvb_comms_providers_with_http_info(storefront_oid)
|
|
4724
|
+
|
|
4725
|
+
```ruby
|
|
4726
|
+
begin
|
|
4727
|
+
# List the email providers the account can import lists from
|
|
4728
|
+
data, status_code, headers = api_instance.get_sfvb_comms_providers_with_http_info(storefront_oid)
|
|
4729
|
+
p status_code # => 2xx
|
|
4730
|
+
p headers # => { ... }
|
|
4731
|
+
p data # => <SfvbCommsProvidersResponse>
|
|
4732
|
+
rescue UltracartClient::ApiError => e
|
|
4733
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_providers_with_http_info: #{e}"
|
|
4734
|
+
end
|
|
4735
|
+
```
|
|
4736
|
+
|
|
4737
|
+
### Parameters
|
|
4738
|
+
|
|
4739
|
+
| Name | Type | Description | Notes |
|
|
4740
|
+
| ---- | ---- | ----------- | ----- |
|
|
4741
|
+
| **storefront_oid** | **Integer** | | |
|
|
4742
|
+
|
|
4743
|
+
### Return type
|
|
4744
|
+
|
|
4745
|
+
[**SfvbCommsProvidersResponse**](SfvbCommsProvidersResponse.md)
|
|
4746
|
+
|
|
4747
|
+
### Authorization
|
|
4748
|
+
|
|
4749
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4750
|
+
|
|
4751
|
+
### HTTP request headers
|
|
4752
|
+
|
|
4753
|
+
- **Content-Type**: Not defined
|
|
4754
|
+
- **Accept**: application/json
|
|
4755
|
+
|
|
4756
|
+
|
|
4757
|
+
## get_sfvb_comms_segment
|
|
4758
|
+
|
|
4759
|
+
> <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
|
|
4760
|
+
|
|
4761
|
+
Read one segment, with its rule
|
|
4762
|
+
|
|
4763
|
+
The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
4764
|
+
|
|
4765
|
+
|
|
4766
|
+
### Examples
|
|
4767
|
+
|
|
4768
|
+
|
|
4769
|
+
(No example for this operation).
|
|
4770
|
+
|
|
4771
|
+
|
|
4772
|
+
#### Using the get_sfvb_comms_segment_with_http_info variant
|
|
4773
|
+
|
|
4774
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4775
|
+
|
|
4776
|
+
> <Array(<SfvbCommsSegmentResponse>, Integer, Hash)> get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid)
|
|
4777
|
+
|
|
4778
|
+
```ruby
|
|
4779
|
+
begin
|
|
4780
|
+
# Read one segment, with its rule
|
|
4781
|
+
data, status_code, headers = api_instance.get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid)
|
|
4782
|
+
p status_code # => 2xx
|
|
4783
|
+
p headers # => { ... }
|
|
4784
|
+
p data # => <SfvbCommsSegmentResponse>
|
|
4785
|
+
rescue UltracartClient::ApiError => e
|
|
4786
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_segment_with_http_info: #{e}"
|
|
4787
|
+
end
|
|
4788
|
+
```
|
|
4789
|
+
|
|
4790
|
+
### Parameters
|
|
4791
|
+
|
|
4792
|
+
| Name | Type | Description | Notes |
|
|
4793
|
+
| ---- | ---- | ----------- | ----- |
|
|
4794
|
+
| **storefront_oid** | **Integer** | | |
|
|
4795
|
+
| **segment_uuid** | **String** | | |
|
|
4796
|
+
|
|
4797
|
+
### Return type
|
|
4798
|
+
|
|
4799
|
+
[**SfvbCommsSegmentResponse**](SfvbCommsSegmentResponse.md)
|
|
4800
|
+
|
|
4801
|
+
### Authorization
|
|
4802
|
+
|
|
4803
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4804
|
+
|
|
4805
|
+
### HTTP request headers
|
|
4806
|
+
|
|
4807
|
+
- **Content-Type**: Not defined
|
|
4808
|
+
- **Accept**: application/json
|
|
4809
|
+
|
|
4810
|
+
|
|
4811
|
+
## get_sfvb_comms_segment_members
|
|
4812
|
+
|
|
4813
|
+
> <SfvbCommsMembersResponse> get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts)
|
|
4814
|
+
|
|
4815
|
+
Read one page of a segment's members
|
|
4816
|
+
|
|
4817
|
+
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.
|
|
4818
|
+
|
|
4819
|
+
|
|
4820
|
+
### Examples
|
|
4821
|
+
|
|
4822
|
+
|
|
4823
|
+
(No example for this operation).
|
|
4824
|
+
|
|
4825
|
+
|
|
4826
|
+
#### Using the get_sfvb_comms_segment_members_with_http_info variant
|
|
4827
|
+
|
|
4828
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4829
|
+
|
|
4830
|
+
> <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
|
|
4831
|
+
|
|
4832
|
+
```ruby
|
|
4833
|
+
begin
|
|
4834
|
+
# Read one page of a segment's members
|
|
4835
|
+
data, status_code, headers = api_instance.get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
|
|
4836
|
+
p status_code # => 2xx
|
|
4837
|
+
p headers # => { ... }
|
|
4838
|
+
p data # => <SfvbCommsMembersResponse>
|
|
4839
|
+
rescue UltracartClient::ApiError => e
|
|
4840
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_segment_members_with_http_info: #{e}"
|
|
4841
|
+
end
|
|
4842
|
+
```
|
|
4843
|
+
|
|
4844
|
+
### Parameters
|
|
4845
|
+
|
|
4846
|
+
| Name | Type | Description | Notes |
|
|
4847
|
+
| ---- | ---- | ----------- | ----- |
|
|
4848
|
+
| **storefront_oid** | **Integer** | | |
|
|
4849
|
+
| **segment_uuid** | **String** | | |
|
|
4850
|
+
| **page** | **Integer** | The page, from 1 | [optional] |
|
|
4851
|
+
| **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
|
|
4852
|
+
| **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
|
|
4853
|
+
|
|
4854
|
+
### Return type
|
|
4855
|
+
|
|
4856
|
+
[**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
|
|
4857
|
+
|
|
4858
|
+
### Authorization
|
|
4859
|
+
|
|
4860
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4861
|
+
|
|
4862
|
+
### HTTP request headers
|
|
4863
|
+
|
|
4864
|
+
- **Content-Type**: Not defined
|
|
4865
|
+
- **Accept**: application/json
|
|
4866
|
+
|
|
4867
|
+
|
|
4868
|
+
## get_sfvb_comms_sending_domain
|
|
4869
|
+
|
|
4870
|
+
> <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
|
|
4871
|
+
|
|
4872
|
+
Read a sending domain
|
|
4873
|
+
|
|
4874
|
+
One sending domain as stored. To check an amazon domain's DNS again, use the status call.
|
|
4875
|
+
|
|
4876
|
+
|
|
4877
|
+
### Examples
|
|
4878
|
+
|
|
4879
|
+
|
|
4880
|
+
(No example for this operation).
|
|
4881
|
+
|
|
4882
|
+
|
|
4883
|
+
#### Using the get_sfvb_comms_sending_domain_with_http_info variant
|
|
4884
|
+
|
|
4885
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4886
|
+
|
|
4887
|
+
> <Array(<SfvbCommsSendingDomain>, Integer, Hash)> get_sfvb_comms_sending_domain_with_http_info(domain)
|
|
4888
|
+
|
|
4889
|
+
```ruby
|
|
4890
|
+
begin
|
|
4891
|
+
# Read a sending domain
|
|
4892
|
+
data, status_code, headers = api_instance.get_sfvb_comms_sending_domain_with_http_info(domain)
|
|
4893
|
+
p status_code # => 2xx
|
|
4894
|
+
p headers # => { ... }
|
|
4895
|
+
p data # => <SfvbCommsSendingDomain>
|
|
4896
|
+
rescue UltracartClient::ApiError => e
|
|
4897
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_sending_domain_with_http_info: #{e}"
|
|
4898
|
+
end
|
|
4899
|
+
```
|
|
4900
|
+
|
|
4901
|
+
### Parameters
|
|
4902
|
+
|
|
4903
|
+
| Name | Type | Description | Notes |
|
|
4904
|
+
| ---- | ---- | ----------- | ----- |
|
|
4905
|
+
| **domain** | **String** | | |
|
|
4906
|
+
|
|
4907
|
+
### Return type
|
|
4908
|
+
|
|
4909
|
+
[**SfvbCommsSendingDomain**](SfvbCommsSendingDomain.md)
|
|
4910
|
+
|
|
4911
|
+
### Authorization
|
|
4912
|
+
|
|
4913
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4914
|
+
|
|
4915
|
+
### HTTP request headers
|
|
4916
|
+
|
|
4917
|
+
- **Content-Type**: Not defined
|
|
4918
|
+
- **Accept**: application/json
|
|
4919
|
+
|
|
4920
|
+
|
|
4921
|
+
## get_sfvb_comms_sending_domains
|
|
4922
|
+
|
|
4923
|
+
> <SfvbCommsSendingDomainsResponse> get_sfvb_comms_sending_domains
|
|
4924
|
+
|
|
4925
|
+
List the sending domains
|
|
4926
|
+
|
|
4927
|
+
Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
4928
|
+
|
|
4929
|
+
|
|
4930
|
+
### Examples
|
|
4931
|
+
|
|
4932
|
+
|
|
4933
|
+
(No example for this operation).
|
|
4934
|
+
|
|
4935
|
+
|
|
4936
|
+
#### Using the get_sfvb_comms_sending_domains_with_http_info variant
|
|
4937
|
+
|
|
4938
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4939
|
+
|
|
4940
|
+
> <Array(<SfvbCommsSendingDomainsResponse>, Integer, Hash)> get_sfvb_comms_sending_domains_with_http_info
|
|
4941
|
+
|
|
4942
|
+
```ruby
|
|
4943
|
+
begin
|
|
4944
|
+
# List the sending domains
|
|
4945
|
+
data, status_code, headers = api_instance.get_sfvb_comms_sending_domains_with_http_info
|
|
4946
|
+
p status_code # => 2xx
|
|
4947
|
+
p headers # => { ... }
|
|
4948
|
+
p data # => <SfvbCommsSendingDomainsResponse>
|
|
4949
|
+
rescue UltracartClient::ApiError => e
|
|
4950
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_sending_domains_with_http_info: #{e}"
|
|
4951
|
+
end
|
|
4952
|
+
```
|
|
4953
|
+
|
|
4954
|
+
### Parameters
|
|
4955
|
+
|
|
4956
|
+
This endpoint does not need any parameter.
|
|
4957
|
+
|
|
4282
4958
|
### Return type
|
|
4283
4959
|
|
|
4284
4960
|
[**SfvbCommsSendingDomainsResponse**](SfvbCommsSendingDomainsResponse.md)
|
|
@@ -4293,6 +4969,221 @@ This endpoint does not need any parameter.
|
|
|
4293
4969
|
- **Accept**: application/json
|
|
4294
4970
|
|
|
4295
4971
|
|
|
4972
|
+
## get_sfvb_comms_sequence_stats
|
|
4973
|
+
|
|
4974
|
+
> <SfvbCommsSequenceStatsResponse> get_sfvb_comms_sequence_stats(storefront_oid, commseq_uuid, opts)
|
|
4975
|
+
|
|
4976
|
+
Read a flow's or campaign's counts, overall and step by step
|
|
4977
|
+
|
|
4978
|
+
overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
|
|
4979
|
+
|
|
4980
|
+
|
|
4981
|
+
### Examples
|
|
4982
|
+
|
|
4983
|
+
|
|
4984
|
+
(No example for this operation).
|
|
4985
|
+
|
|
4986
|
+
|
|
4987
|
+
#### Using the get_sfvb_comms_sequence_stats_with_http_info variant
|
|
4988
|
+
|
|
4989
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4990
|
+
|
|
4991
|
+
> <Array(<SfvbCommsSequenceStatsResponse>, Integer, Hash)> get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts)
|
|
4992
|
+
|
|
4993
|
+
```ruby
|
|
4994
|
+
begin
|
|
4995
|
+
# Read a flow's or campaign's counts, overall and step by step
|
|
4996
|
+
data, status_code, headers = api_instance.get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts)
|
|
4997
|
+
p status_code # => 2xx
|
|
4998
|
+
p headers # => { ... }
|
|
4999
|
+
p data # => <SfvbCommsSequenceStatsResponse>
|
|
5000
|
+
rescue UltracartClient::ApiError => e
|
|
5001
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_sequence_stats_with_http_info: #{e}"
|
|
5002
|
+
end
|
|
5003
|
+
```
|
|
5004
|
+
|
|
5005
|
+
### Parameters
|
|
5006
|
+
|
|
5007
|
+
| Name | Type | Description | Notes |
|
|
5008
|
+
| ---- | ---- | ----------- | ----- |
|
|
5009
|
+
| **storefront_oid** | **Integer** | | |
|
|
5010
|
+
| **commseq_uuid** | **String** | | |
|
|
5011
|
+
| **days** | **Integer** | The window for the step counts, 1 to 365 days (default 30). | [optional] |
|
|
5012
|
+
|
|
5013
|
+
### Return type
|
|
5014
|
+
|
|
5015
|
+
[**SfvbCommsSequenceStatsResponse**](SfvbCommsSequenceStatsResponse.md)
|
|
5016
|
+
|
|
5017
|
+
### Authorization
|
|
5018
|
+
|
|
5019
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5020
|
+
|
|
5021
|
+
### HTTP request headers
|
|
5022
|
+
|
|
5023
|
+
- **Content-Type**: Not defined
|
|
5024
|
+
- **Accept**: application/json
|
|
5025
|
+
|
|
5026
|
+
|
|
5027
|
+
## get_sfvb_comms_settings
|
|
5028
|
+
|
|
5029
|
+
> <SfvbCommsSettingsResponse> get_sfvb_comms_settings(storefront_oid)
|
|
5030
|
+
|
|
5031
|
+
Read a storefront's communications settings
|
|
5032
|
+
|
|
5033
|
+
The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
|
|
5034
|
+
|
|
5035
|
+
|
|
5036
|
+
### Examples
|
|
5037
|
+
|
|
5038
|
+
|
|
5039
|
+
(No example for this operation).
|
|
5040
|
+
|
|
5041
|
+
|
|
5042
|
+
#### Using the get_sfvb_comms_settings_with_http_info variant
|
|
5043
|
+
|
|
5044
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5045
|
+
|
|
5046
|
+
> <Array(<SfvbCommsSettingsResponse>, Integer, Hash)> get_sfvb_comms_settings_with_http_info(storefront_oid)
|
|
5047
|
+
|
|
5048
|
+
```ruby
|
|
5049
|
+
begin
|
|
5050
|
+
# Read a storefront's communications settings
|
|
5051
|
+
data, status_code, headers = api_instance.get_sfvb_comms_settings_with_http_info(storefront_oid)
|
|
5052
|
+
p status_code # => 2xx
|
|
5053
|
+
p headers # => { ... }
|
|
5054
|
+
p data # => <SfvbCommsSettingsResponse>
|
|
5055
|
+
rescue UltracartClient::ApiError => e
|
|
5056
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_settings_with_http_info: #{e}"
|
|
5057
|
+
end
|
|
5058
|
+
```
|
|
5059
|
+
|
|
5060
|
+
### Parameters
|
|
5061
|
+
|
|
5062
|
+
| Name | Type | Description | Notes |
|
|
5063
|
+
| ---- | ---- | ----------- | ----- |
|
|
5064
|
+
| **storefront_oid** | **Integer** | | |
|
|
5065
|
+
|
|
5066
|
+
### Return type
|
|
5067
|
+
|
|
5068
|
+
[**SfvbCommsSettingsResponse**](SfvbCommsSettingsResponse.md)
|
|
5069
|
+
|
|
5070
|
+
### Authorization
|
|
5071
|
+
|
|
5072
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5073
|
+
|
|
5074
|
+
### HTTP request headers
|
|
5075
|
+
|
|
5076
|
+
- **Content-Type**: Not defined
|
|
5077
|
+
- **Accept**: application/json
|
|
5078
|
+
|
|
5079
|
+
|
|
5080
|
+
## get_sfvb_comms_template
|
|
5081
|
+
|
|
5082
|
+
> <SfvbCommsTemplateResponse> get_sfvb_comms_template(storefront_oid, email_template_oid)
|
|
5083
|
+
|
|
5084
|
+
Read one saved email template's body
|
|
5085
|
+
|
|
5086
|
+
A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is the theme file at template_path; read it with the files endpoints. Read only.
|
|
5087
|
+
|
|
5088
|
+
|
|
5089
|
+
### Examples
|
|
5090
|
+
|
|
5091
|
+
|
|
5092
|
+
(No example for this operation).
|
|
5093
|
+
|
|
5094
|
+
|
|
5095
|
+
#### Using the get_sfvb_comms_template_with_http_info variant
|
|
5096
|
+
|
|
5097
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5098
|
+
|
|
5099
|
+
> <Array(<SfvbCommsTemplateResponse>, Integer, Hash)> get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid)
|
|
5100
|
+
|
|
5101
|
+
```ruby
|
|
5102
|
+
begin
|
|
5103
|
+
# Read one saved email template's body
|
|
5104
|
+
data, status_code, headers = api_instance.get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid)
|
|
5105
|
+
p status_code # => 2xx
|
|
5106
|
+
p headers # => { ... }
|
|
5107
|
+
p data # => <SfvbCommsTemplateResponse>
|
|
5108
|
+
rescue UltracartClient::ApiError => e
|
|
5109
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_template_with_http_info: #{e}"
|
|
5110
|
+
end
|
|
5111
|
+
```
|
|
5112
|
+
|
|
5113
|
+
### Parameters
|
|
5114
|
+
|
|
5115
|
+
| Name | Type | Description | Notes |
|
|
5116
|
+
| ---- | ---- | ----------- | ----- |
|
|
5117
|
+
| **storefront_oid** | **Integer** | | |
|
|
5118
|
+
| **email_template_oid** | **Integer** | | |
|
|
5119
|
+
|
|
5120
|
+
### Return type
|
|
5121
|
+
|
|
5122
|
+
[**SfvbCommsTemplateResponse**](SfvbCommsTemplateResponse.md)
|
|
5123
|
+
|
|
5124
|
+
### Authorization
|
|
5125
|
+
|
|
5126
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5127
|
+
|
|
5128
|
+
### HTTP request headers
|
|
5129
|
+
|
|
5130
|
+
- **Content-Type**: Not defined
|
|
5131
|
+
- **Accept**: application/json
|
|
5132
|
+
|
|
5133
|
+
|
|
5134
|
+
## get_sfvb_comms_templates
|
|
5135
|
+
|
|
5136
|
+
> <SfvbCommsTemplatesResponse> get_sfvb_comms_templates(storefront_oid)
|
|
5137
|
+
|
|
5138
|
+
List the email templates a new email can start from
|
|
5139
|
+
|
|
5140
|
+
One list: UltraCart's system templates and this storefront's saved ones (each with email_template_oid), then base templates, the active theme's files an email renders inside (each with path). Read only.
|
|
5141
|
+
|
|
5142
|
+
|
|
5143
|
+
### Examples
|
|
5144
|
+
|
|
5145
|
+
|
|
5146
|
+
(No example for this operation).
|
|
5147
|
+
|
|
5148
|
+
|
|
5149
|
+
#### Using the get_sfvb_comms_templates_with_http_info variant
|
|
5150
|
+
|
|
5151
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5152
|
+
|
|
5153
|
+
> <Array(<SfvbCommsTemplatesResponse>, Integer, Hash)> get_sfvb_comms_templates_with_http_info(storefront_oid)
|
|
5154
|
+
|
|
5155
|
+
```ruby
|
|
5156
|
+
begin
|
|
5157
|
+
# List the email templates a new email can start from
|
|
5158
|
+
data, status_code, headers = api_instance.get_sfvb_comms_templates_with_http_info(storefront_oid)
|
|
5159
|
+
p status_code # => 2xx
|
|
5160
|
+
p headers # => { ... }
|
|
5161
|
+
p data # => <SfvbCommsTemplatesResponse>
|
|
5162
|
+
rescue UltracartClient::ApiError => e
|
|
5163
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_templates_with_http_info: #{e}"
|
|
5164
|
+
end
|
|
5165
|
+
```
|
|
5166
|
+
|
|
5167
|
+
### Parameters
|
|
5168
|
+
|
|
5169
|
+
| Name | Type | Description | Notes |
|
|
5170
|
+
| ---- | ---- | ----------- | ----- |
|
|
5171
|
+
| **storefront_oid** | **Integer** | | |
|
|
5172
|
+
|
|
5173
|
+
### Return type
|
|
5174
|
+
|
|
5175
|
+
[**SfvbCommsTemplatesResponse**](SfvbCommsTemplatesResponse.md)
|
|
5176
|
+
|
|
5177
|
+
### Authorization
|
|
5178
|
+
|
|
5179
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5180
|
+
|
|
5181
|
+
### HTTP request headers
|
|
5182
|
+
|
|
5183
|
+
- **Content-Type**: Not defined
|
|
5184
|
+
- **Accept**: application/json
|
|
5185
|
+
|
|
5186
|
+
|
|
4296
5187
|
## get_sfvb_comms_twilio_account
|
|
4297
5188
|
|
|
4298
5189
|
> <SfvbCommsTwilioAccountResponse> get_sfvb_comms_twilio_account
|
|
@@ -4344,6 +5235,59 @@ This endpoint does not need any parameter.
|
|
|
4344
5235
|
- **Accept**: application/json
|
|
4345
5236
|
|
|
4346
5237
|
|
|
5238
|
+
## get_sfvb_comms_unreferenced
|
|
5239
|
+
|
|
5240
|
+
> <SfvbCommsUnreferencedResponse> get_sfvb_comms_unreferenced(storefront_oid)
|
|
5241
|
+
|
|
5242
|
+
List the emails and postcards on a storefront that no step names
|
|
5243
|
+
|
|
5244
|
+
An email or postcard no step of any sequence on this storefront names, an off or archived flow's included, so nothing sends it. The admin's add can leave one when its second call fails. Most recently changed first. Read only, nothing is deleted.
|
|
5245
|
+
|
|
5246
|
+
|
|
5247
|
+
### Examples
|
|
5248
|
+
|
|
5249
|
+
|
|
5250
|
+
(No example for this operation).
|
|
5251
|
+
|
|
5252
|
+
|
|
5253
|
+
#### Using the get_sfvb_comms_unreferenced_with_http_info variant
|
|
5254
|
+
|
|
5255
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5256
|
+
|
|
5257
|
+
> <Array(<SfvbCommsUnreferencedResponse>, Integer, Hash)> get_sfvb_comms_unreferenced_with_http_info(storefront_oid)
|
|
5258
|
+
|
|
5259
|
+
```ruby
|
|
5260
|
+
begin
|
|
5261
|
+
# List the emails and postcards on a storefront that no step names
|
|
5262
|
+
data, status_code, headers = api_instance.get_sfvb_comms_unreferenced_with_http_info(storefront_oid)
|
|
5263
|
+
p status_code # => 2xx
|
|
5264
|
+
p headers # => { ... }
|
|
5265
|
+
p data # => <SfvbCommsUnreferencedResponse>
|
|
5266
|
+
rescue UltracartClient::ApiError => e
|
|
5267
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_unreferenced_with_http_info: #{e}"
|
|
5268
|
+
end
|
|
5269
|
+
```
|
|
5270
|
+
|
|
5271
|
+
### Parameters
|
|
5272
|
+
|
|
5273
|
+
| Name | Type | Description | Notes |
|
|
5274
|
+
| ---- | ---- | ----------- | ----- |
|
|
5275
|
+
| **storefront_oid** | **Integer** | | |
|
|
5276
|
+
|
|
5277
|
+
### Return type
|
|
5278
|
+
|
|
5279
|
+
[**SfvbCommsUnreferencedResponse**](SfvbCommsUnreferencedResponse.md)
|
|
5280
|
+
|
|
5281
|
+
### Authorization
|
|
5282
|
+
|
|
5283
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5284
|
+
|
|
5285
|
+
### HTTP request headers
|
|
5286
|
+
|
|
5287
|
+
- **Content-Type**: Not defined
|
|
5288
|
+
- **Accept**: application/json
|
|
5289
|
+
|
|
5290
|
+
|
|
4347
5291
|
## get_sfvb_container
|
|
4348
5292
|
|
|
4349
5293
|
> <SfvbContainerResponse> get_sfvb_container(storefront_oid, owner_type, owner_object_id, opts)
|
|
@@ -4516,7 +5460,7 @@ end
|
|
|
4516
5460
|
|
|
4517
5461
|
Get a flow or campaign email's subject and preview text
|
|
4518
5462
|
|
|
4519
|
-
The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront's campaigns and flows.
|
|
5463
|
+
The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). The Velocity template it renders inside is the theme file at template_path; read it with the files endpoints, whose read reports valid and velocity_errors. Find the uuid in the storefront's campaigns and flows.
|
|
4520
5464
|
|
|
4521
5465
|
|
|
4522
5466
|
### Examples
|
|
@@ -8017,7 +8961,62 @@ end
|
|
|
8017
8961
|
|
|
8018
8962
|
### Return type
|
|
8019
8963
|
|
|
8020
|
-
[**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
|
|
8964
|
+
[**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
|
|
8965
|
+
|
|
8966
|
+
### Authorization
|
|
8967
|
+
|
|
8968
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8969
|
+
|
|
8970
|
+
### HTTP request headers
|
|
8971
|
+
|
|
8972
|
+
- **Content-Type**: Not defined
|
|
8973
|
+
- **Accept**: application/json
|
|
8974
|
+
|
|
8975
|
+
|
|
8976
|
+
## import_sfvb_comms_provider_lists
|
|
8977
|
+
|
|
8978
|
+
> <SfvbCommsProviderImportResponse> import_sfvb_comms_provider_lists(storefront_oid, provider_import_request, opts)
|
|
8979
|
+
|
|
8980
|
+
Import lists from another email provider
|
|
8981
|
+
|
|
8982
|
+
Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
|
|
8983
|
+
|
|
8984
|
+
|
|
8985
|
+
### Examples
|
|
8986
|
+
|
|
8987
|
+
|
|
8988
|
+
(No example for this operation).
|
|
8989
|
+
|
|
8990
|
+
|
|
8991
|
+
#### Using the import_sfvb_comms_provider_lists_with_http_info variant
|
|
8992
|
+
|
|
8993
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8994
|
+
|
|
8995
|
+
> <Array(<SfvbCommsProviderImportResponse>, Integer, Hash)> import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts)
|
|
8996
|
+
|
|
8997
|
+
```ruby
|
|
8998
|
+
begin
|
|
8999
|
+
# Import lists from another email provider
|
|
9000
|
+
data, status_code, headers = api_instance.import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts)
|
|
9001
|
+
p status_code # => 2xx
|
|
9002
|
+
p headers # => { ... }
|
|
9003
|
+
p data # => <SfvbCommsProviderImportResponse>
|
|
9004
|
+
rescue UltracartClient::ApiError => e
|
|
9005
|
+
puts "Error when calling SfvbApi->import_sfvb_comms_provider_lists_with_http_info: #{e}"
|
|
9006
|
+
end
|
|
9007
|
+
```
|
|
9008
|
+
|
|
9009
|
+
### Parameters
|
|
9010
|
+
|
|
9011
|
+
| Name | Type | Description | Notes |
|
|
9012
|
+
| ---- | ---- | ----------- | ----- |
|
|
9013
|
+
| **storefront_oid** | **Integer** | | |
|
|
9014
|
+
| **provider_import_request** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) | The provider and lists to import | |
|
|
9015
|
+
| **approval_id** | **String** | The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals. | [optional] |
|
|
9016
|
+
|
|
9017
|
+
### Return type
|
|
9018
|
+
|
|
9019
|
+
[**SfvbCommsProviderImportResponse**](SfvbCommsProviderImportResponse.md)
|
|
8021
9020
|
|
|
8022
9021
|
### Authorization
|
|
8023
9022
|
|
|
@@ -8025,7 +9024,7 @@ end
|
|
|
8025
9024
|
|
|
8026
9025
|
### HTTP request headers
|
|
8027
9026
|
|
|
8028
|
-
- **Content-Type**:
|
|
9027
|
+
- **Content-Type**: application/json
|
|
8029
9028
|
- **Accept**: application/json
|
|
8030
9029
|
|
|
8031
9030
|
|
|
@@ -8246,6 +9245,114 @@ end
|
|
|
8246
9245
|
- **Accept**: application/json
|
|
8247
9246
|
|
|
8248
9247
|
|
|
9248
|
+
## insert_sfvb_comms_campaign_folder
|
|
9249
|
+
|
|
9250
|
+
> <SfvbCommsSequenceFolderResponse> insert_sfvb_comms_campaign_folder(storefront_oid, folder_write_request)
|
|
9251
|
+
|
|
9252
|
+
Create a campaign folder
|
|
9253
|
+
|
|
9254
|
+
A new, empty folder. File a campaign in it by setting its folder_uuid.
|
|
9255
|
+
|
|
9256
|
+
|
|
9257
|
+
### Examples
|
|
9258
|
+
|
|
9259
|
+
|
|
9260
|
+
(No example for this operation).
|
|
9261
|
+
|
|
9262
|
+
|
|
9263
|
+
#### Using the insert_sfvb_comms_campaign_folder_with_http_info variant
|
|
9264
|
+
|
|
9265
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9266
|
+
|
|
9267
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> insert_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_write_request)
|
|
9268
|
+
|
|
9269
|
+
```ruby
|
|
9270
|
+
begin
|
|
9271
|
+
# Create a campaign folder
|
|
9272
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_write_request)
|
|
9273
|
+
p status_code # => 2xx
|
|
9274
|
+
p headers # => { ... }
|
|
9275
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
9276
|
+
rescue UltracartClient::ApiError => e
|
|
9277
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
9278
|
+
end
|
|
9279
|
+
```
|
|
9280
|
+
|
|
9281
|
+
### Parameters
|
|
9282
|
+
|
|
9283
|
+
| Name | Type | Description | Notes |
|
|
9284
|
+
| ---- | ---- | ----------- | ----- |
|
|
9285
|
+
| **storefront_oid** | **Integer** | | |
|
|
9286
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new folder's name | |
|
|
9287
|
+
|
|
9288
|
+
### Return type
|
|
9289
|
+
|
|
9290
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
9291
|
+
|
|
9292
|
+
### Authorization
|
|
9293
|
+
|
|
9294
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9295
|
+
|
|
9296
|
+
### HTTP request headers
|
|
9297
|
+
|
|
9298
|
+
- **Content-Type**: application/json
|
|
9299
|
+
- **Accept**: application/json
|
|
9300
|
+
|
|
9301
|
+
|
|
9302
|
+
## insert_sfvb_comms_flow_folder
|
|
9303
|
+
|
|
9304
|
+
> <SfvbCommsSequenceFolderResponse> insert_sfvb_comms_flow_folder(storefront_oid, folder_write_request)
|
|
9305
|
+
|
|
9306
|
+
Create a flow folder
|
|
9307
|
+
|
|
9308
|
+
A new, empty folder. File a flow in it by setting its folder_uuid.
|
|
9309
|
+
|
|
9310
|
+
|
|
9311
|
+
### Examples
|
|
9312
|
+
|
|
9313
|
+
|
|
9314
|
+
(No example for this operation).
|
|
9315
|
+
|
|
9316
|
+
|
|
9317
|
+
#### Using the insert_sfvb_comms_flow_folder_with_http_info variant
|
|
9318
|
+
|
|
9319
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9320
|
+
|
|
9321
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> insert_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_write_request)
|
|
9322
|
+
|
|
9323
|
+
```ruby
|
|
9324
|
+
begin
|
|
9325
|
+
# Create a flow folder
|
|
9326
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_write_request)
|
|
9327
|
+
p status_code # => 2xx
|
|
9328
|
+
p headers # => { ... }
|
|
9329
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
9330
|
+
rescue UltracartClient::ApiError => e
|
|
9331
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
9332
|
+
end
|
|
9333
|
+
```
|
|
9334
|
+
|
|
9335
|
+
### Parameters
|
|
9336
|
+
|
|
9337
|
+
| Name | Type | Description | Notes |
|
|
9338
|
+
| ---- | ---- | ----------- | ----- |
|
|
9339
|
+
| **storefront_oid** | **Integer** | | |
|
|
9340
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new folder's name | |
|
|
9341
|
+
|
|
9342
|
+
### Return type
|
|
9343
|
+
|
|
9344
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
9345
|
+
|
|
9346
|
+
### Authorization
|
|
9347
|
+
|
|
9348
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9349
|
+
|
|
9350
|
+
### HTTP request headers
|
|
9351
|
+
|
|
9352
|
+
- **Content-Type**: application/json
|
|
9353
|
+
- **Accept**: application/json
|
|
9354
|
+
|
|
9355
|
+
|
|
8249
9356
|
## insert_sfvb_comms_folder
|
|
8250
9357
|
|
|
8251
9358
|
> <SfvbCommsFolderResponse> insert_sfvb_comms_folder(storefront_oid, folder_write_request)
|
|
@@ -12437,13 +13544,181 @@ end
|
|
|
12437
13544
|
- **Accept**: application/json
|
|
12438
13545
|
|
|
12439
13546
|
|
|
12440
|
-
## search_sfvb_library
|
|
13547
|
+
## search_sfvb_library
|
|
13548
|
+
|
|
13549
|
+
> <SfvbLibraryResponse> search_sfvb_library(storefront_oid, opts)
|
|
13550
|
+
|
|
13551
|
+
Search the element library
|
|
13552
|
+
|
|
13553
|
+
Known-good CJSON fragments a human already built out of real elements. This is what a lint warning about a monolithic html element should point at - a warning that names a fragment solving the same problem is an instruction, where a warning on its own is only criticism. Results are terse; fetch a single entry for its CJSON. Narrow with a query parameter named after a facet, such as facet_purpose, whose value is the facet name, a colon and one of its options. Besides element type and author, the facets include purpose, section, industry and style from library/taxonomy, and the search text matches those tags too. Results follow the same rules as reading one entry, so others see published revisions only.
|
|
13554
|
+
|
|
13555
|
+
|
|
13556
|
+
### Examples
|
|
13557
|
+
|
|
13558
|
+
|
|
13559
|
+
(No example for this operation).
|
|
13560
|
+
|
|
13561
|
+
|
|
13562
|
+
#### Using the search_sfvb_library_with_http_info variant
|
|
13563
|
+
|
|
13564
|
+
This returns an Array which contains the response data, status code and headers.
|
|
13565
|
+
|
|
13566
|
+
> <Array(<SfvbLibraryResponse>, Integer, Hash)> search_sfvb_library_with_http_info(storefront_oid, opts)
|
|
13567
|
+
|
|
13568
|
+
```ruby
|
|
13569
|
+
begin
|
|
13570
|
+
# Search the element library
|
|
13571
|
+
data, status_code, headers = api_instance.search_sfvb_library_with_http_info(storefront_oid, opts)
|
|
13572
|
+
p status_code # => 2xx
|
|
13573
|
+
p headers # => { ... }
|
|
13574
|
+
p data # => <SfvbLibraryResponse>
|
|
13575
|
+
rescue UltracartClient::ApiError => e
|
|
13576
|
+
puts "Error when calling SfvbApi->search_sfvb_library_with_http_info: #{e}"
|
|
13577
|
+
end
|
|
13578
|
+
```
|
|
13579
|
+
|
|
13580
|
+
### Parameters
|
|
13581
|
+
|
|
13582
|
+
| Name | Type | Description | Notes |
|
|
13583
|
+
| ---- | ---- | ----------- | ----- |
|
|
13584
|
+
| **storefront_oid** | **Integer** | | |
|
|
13585
|
+
| **segment** | **String** | | [optional] |
|
|
13586
|
+
| **search** | **String** | | [optional] |
|
|
13587
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13588
|
+
| **results_per_page** | **Integer** | | [optional] |
|
|
13589
|
+
|
|
13590
|
+
### Return type
|
|
13591
|
+
|
|
13592
|
+
[**SfvbLibraryResponse**](SfvbLibraryResponse.md)
|
|
13593
|
+
|
|
13594
|
+
### Authorization
|
|
13595
|
+
|
|
13596
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
13597
|
+
|
|
13598
|
+
### HTTP request headers
|
|
13599
|
+
|
|
13600
|
+
- **Content-Type**: Not defined
|
|
13601
|
+
- **Accept**: application/json
|
|
13602
|
+
|
|
13603
|
+
|
|
13604
|
+
## set_sfvb_library_screenshot
|
|
13605
|
+
|
|
13606
|
+
> <SfvbLibraryEntry> set_sfvb_library_screenshot(storefront_oid, library_oid, if_match, screenshot_request)
|
|
13607
|
+
|
|
13608
|
+
Set a library entry's screenshot
|
|
13609
|
+
|
|
13610
|
+
Three calls, like the other uploads. Request an upload URL with files/upload_url/png, PUT the PNG bytes to it, then call this with the key, the sha256 of those bytes and where the image came from. Owner only, with the draft's hash_sha256 as If-Match. The PNG must be at most 5 MB and 4096 pixels a side; it is re-encoded, which drops any metadata, and a thumbnail is made from it before this returns. Capture it with test data only. A refused image leaves the previous screenshot in place. Other merchants see a new screenshot only after the next publish, whose review checks it.
|
|
13611
|
+
|
|
13612
|
+
|
|
13613
|
+
### Examples
|
|
13614
|
+
|
|
13615
|
+
|
|
13616
|
+
(No example for this operation).
|
|
13617
|
+
|
|
13618
|
+
|
|
13619
|
+
#### Using the set_sfvb_library_screenshot_with_http_info variant
|
|
13620
|
+
|
|
13621
|
+
This returns an Array which contains the response data, status code and headers.
|
|
13622
|
+
|
|
13623
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request)
|
|
13624
|
+
|
|
13625
|
+
```ruby
|
|
13626
|
+
begin
|
|
13627
|
+
# Set a library entry's screenshot
|
|
13628
|
+
data, status_code, headers = api_instance.set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request)
|
|
13629
|
+
p status_code # => 2xx
|
|
13630
|
+
p headers # => { ... }
|
|
13631
|
+
p data # => <SfvbLibraryEntry>
|
|
13632
|
+
rescue UltracartClient::ApiError => e
|
|
13633
|
+
puts "Error when calling SfvbApi->set_sfvb_library_screenshot_with_http_info: #{e}"
|
|
13634
|
+
end
|
|
13635
|
+
```
|
|
13636
|
+
|
|
13637
|
+
### Parameters
|
|
13638
|
+
|
|
13639
|
+
| Name | Type | Description | Notes |
|
|
13640
|
+
| ---- | ---- | ----------- | ----- |
|
|
13641
|
+
| **storefront_oid** | **Integer** | | |
|
|
13642
|
+
| **library_oid** | **Integer** | | |
|
|
13643
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
13644
|
+
| **screenshot_request** | [**SfvbLibraryScreenshotRequest**](SfvbLibraryScreenshotRequest.md) | The staged PNG | |
|
|
13645
|
+
|
|
13646
|
+
### Return type
|
|
13647
|
+
|
|
13648
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
13649
|
+
|
|
13650
|
+
### Authorization
|
|
13651
|
+
|
|
13652
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
13653
|
+
|
|
13654
|
+
### HTTP request headers
|
|
13655
|
+
|
|
13656
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
13657
|
+
- **Accept**: application/json
|
|
13658
|
+
|
|
13659
|
+
|
|
13660
|
+
## share_sfvb_library_entry
|
|
13661
|
+
|
|
13662
|
+
> <SfvbLibraryEntry> share_sfvb_library_entry(storefront_oid, library_oid, share_request)
|
|
13663
|
+
|
|
13664
|
+
Share a published library entry with a linked account
|
|
13665
|
+
|
|
13666
|
+
Owner only, and always needs sfvb_publish. The merchant must be one share_targets lists, and the entry must have a published revision, which is what the recipient sees. The published revision is checked again for absolute asset URLs and credentials. Idempotent.
|
|
13667
|
+
|
|
13668
|
+
|
|
13669
|
+
### Examples
|
|
13670
|
+
|
|
13671
|
+
|
|
13672
|
+
(No example for this operation).
|
|
13673
|
+
|
|
13674
|
+
|
|
13675
|
+
#### Using the share_sfvb_library_entry_with_http_info variant
|
|
13676
|
+
|
|
13677
|
+
This returns an Array which contains the response data, status code and headers.
|
|
13678
|
+
|
|
13679
|
+
> <Array(<SfvbLibraryEntry>, Integer, Hash)> share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request)
|
|
13680
|
+
|
|
13681
|
+
```ruby
|
|
13682
|
+
begin
|
|
13683
|
+
# Share a published library entry with a linked account
|
|
13684
|
+
data, status_code, headers = api_instance.share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request)
|
|
13685
|
+
p status_code # => 2xx
|
|
13686
|
+
p headers # => { ... }
|
|
13687
|
+
p data # => <SfvbLibraryEntry>
|
|
13688
|
+
rescue UltracartClient::ApiError => e
|
|
13689
|
+
puts "Error when calling SfvbApi->share_sfvb_library_entry_with_http_info: #{e}"
|
|
13690
|
+
end
|
|
13691
|
+
```
|
|
13692
|
+
|
|
13693
|
+
### Parameters
|
|
13694
|
+
|
|
13695
|
+
| Name | Type | Description | Notes |
|
|
13696
|
+
| ---- | ---- | ----------- | ----- |
|
|
13697
|
+
| **storefront_oid** | **Integer** | | |
|
|
13698
|
+
| **library_oid** | **Integer** | | |
|
|
13699
|
+
| **share_request** | [**SfvbLibraryShareRequest**](SfvbLibraryShareRequest.md) | The linked account | |
|
|
13700
|
+
|
|
13701
|
+
### Return type
|
|
13702
|
+
|
|
13703
|
+
[**SfvbLibraryEntry**](SfvbLibraryEntry.md)
|
|
13704
|
+
|
|
13705
|
+
### Authorization
|
|
13706
|
+
|
|
13707
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
13708
|
+
|
|
13709
|
+
### HTTP request headers
|
|
13710
|
+
|
|
13711
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
13712
|
+
- **Accept**: application/json
|
|
13713
|
+
|
|
13714
|
+
|
|
13715
|
+
## start_sfvb_experiment
|
|
12441
13716
|
|
|
12442
|
-
> <
|
|
13717
|
+
> <SfvbExperiment> start_sfvb_experiment(storefront_oid, experiment_start_request, opts)
|
|
12443
13718
|
|
|
12444
|
-
|
|
13719
|
+
Start an experiment
|
|
12445
13720
|
|
|
12446
|
-
|
|
13721
|
+
type page starts an experiment element already saved in a page body - send path, slot and widget_id, and its name, objective, duration and variations are read from the element with the builder's rules (2 to 5 variations numbered 0 up with no gaps, 3 to 90 days, traffic on all or none adding up to 100). The new id is written into the element and the body is saved, so pull it again before the next edit. type url splits visitors between existing pages at router_url, and always ends by itself after duration_days. Always needs sfvb_publish, because visitors are split as soon as it starts, and the approval of the person who signed in the CLI - an approved experiment.start request for exactly this start (see POST /sfvb/approvals).
|
|
12447
13722
|
|
|
12448
13723
|
|
|
12449
13724
|
### Examples
|
|
@@ -12452,21 +13727,21 @@ Known-good CJSON fragments a human already built out of real elements. This is
|
|
|
12452
13727
|
(No example for this operation).
|
|
12453
13728
|
|
|
12454
13729
|
|
|
12455
|
-
#### Using the
|
|
13730
|
+
#### Using the start_sfvb_experiment_with_http_info variant
|
|
12456
13731
|
|
|
12457
13732
|
This returns an Array which contains the response data, status code and headers.
|
|
12458
13733
|
|
|
12459
|
-
> <Array(<
|
|
13734
|
+
> <Array(<SfvbExperiment>, Integer, Hash)> start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts)
|
|
12460
13735
|
|
|
12461
13736
|
```ruby
|
|
12462
13737
|
begin
|
|
12463
|
-
#
|
|
12464
|
-
data, status_code, headers = api_instance.
|
|
13738
|
+
# Start an experiment
|
|
13739
|
+
data, status_code, headers = api_instance.start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts)
|
|
12465
13740
|
p status_code # => 2xx
|
|
12466
13741
|
p headers # => { ... }
|
|
12467
|
-
p data # => <
|
|
13742
|
+
p data # => <SfvbExperiment>
|
|
12468
13743
|
rescue UltracartClient::ApiError => e
|
|
12469
|
-
puts "Error when calling SfvbApi->
|
|
13744
|
+
puts "Error when calling SfvbApi->start_sfvb_experiment_with_http_info: #{e}"
|
|
12470
13745
|
end
|
|
12471
13746
|
```
|
|
12472
13747
|
|
|
@@ -12475,14 +13750,12 @@ end
|
|
|
12475
13750
|
| Name | Type | Description | Notes |
|
|
12476
13751
|
| ---- | ---- | ----------- | ----- |
|
|
12477
13752
|
| **storefront_oid** | **Integer** | | |
|
|
12478
|
-
| **
|
|
12479
|
-
| **
|
|
12480
|
-
| **page_number** | **Integer** | | [optional] |
|
|
12481
|
-
| **results_per_page** | **Integer** | | [optional] |
|
|
13753
|
+
| **experiment_start_request** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | The experiment to start | |
|
|
13754
|
+
| **approval_id** | **String** | The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals. | [optional] |
|
|
12482
13755
|
|
|
12483
13756
|
### Return type
|
|
12484
13757
|
|
|
12485
|
-
[**
|
|
13758
|
+
[**SfvbExperiment**](SfvbExperiment.md)
|
|
12486
13759
|
|
|
12487
13760
|
### Authorization
|
|
12488
13761
|
|
|
@@ -12490,17 +13763,17 @@ end
|
|
|
12490
13763
|
|
|
12491
13764
|
### HTTP request headers
|
|
12492
13765
|
|
|
12493
|
-
- **Content-Type**:
|
|
13766
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
12494
13767
|
- **Accept**: application/json
|
|
12495
13768
|
|
|
12496
13769
|
|
|
12497
|
-
##
|
|
13770
|
+
## test_sfvb_comms_email
|
|
12498
13771
|
|
|
12499
|
-
> <
|
|
13772
|
+
> <SfvbCommsTestSendResponse> test_sfvb_comms_email(storefront_oid, commseq_uuid, step_uuid, test_email_request)
|
|
12500
13773
|
|
|
12501
|
-
|
|
13774
|
+
Send one test of an email step's email to a user on this account
|
|
12502
13775
|
|
|
12503
|
-
|
|
13776
|
+
to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan's email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
|
|
12504
13777
|
|
|
12505
13778
|
|
|
12506
13779
|
### Examples
|
|
@@ -12509,21 +13782,21 @@ Three calls, like the other uploads. Request an upload URL with files/upload_ur
|
|
|
12509
13782
|
(No example for this operation).
|
|
12510
13783
|
|
|
12511
13784
|
|
|
12512
|
-
#### Using the
|
|
13785
|
+
#### Using the test_sfvb_comms_email_with_http_info variant
|
|
12513
13786
|
|
|
12514
13787
|
This returns an Array which contains the response data, status code and headers.
|
|
12515
13788
|
|
|
12516
|
-
> <Array(<
|
|
13789
|
+
> <Array(<SfvbCommsTestSendResponse>, Integer, Hash)> test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request)
|
|
12517
13790
|
|
|
12518
13791
|
```ruby
|
|
12519
13792
|
begin
|
|
12520
|
-
#
|
|
12521
|
-
data, status_code, headers = api_instance.
|
|
13793
|
+
# Send one test of an email step's email to a user on this account
|
|
13794
|
+
data, status_code, headers = api_instance.test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request)
|
|
12522
13795
|
p status_code # => 2xx
|
|
12523
13796
|
p headers # => { ... }
|
|
12524
|
-
p data # => <
|
|
13797
|
+
p data # => <SfvbCommsTestSendResponse>
|
|
12525
13798
|
rescue UltracartClient::ApiError => e
|
|
12526
|
-
puts "Error when calling SfvbApi->
|
|
13799
|
+
puts "Error when calling SfvbApi->test_sfvb_comms_email_with_http_info: #{e}"
|
|
12527
13800
|
end
|
|
12528
13801
|
```
|
|
12529
13802
|
|
|
@@ -12532,13 +13805,13 @@ end
|
|
|
12532
13805
|
| Name | Type | Description | Notes |
|
|
12533
13806
|
| ---- | ---- | ----------- | ----- |
|
|
12534
13807
|
| **storefront_oid** | **Integer** | | |
|
|
12535
|
-
| **
|
|
12536
|
-
| **
|
|
12537
|
-
| **
|
|
13808
|
+
| **commseq_uuid** | **String** | | |
|
|
13809
|
+
| **step_uuid** | **String** | | |
|
|
13810
|
+
| **test_email_request** | [**SfvbCommsTestEmailRequest**](SfvbCommsTestEmailRequest.md) | The email and the recipient | |
|
|
12538
13811
|
|
|
12539
13812
|
### Return type
|
|
12540
13813
|
|
|
12541
|
-
[**
|
|
13814
|
+
[**SfvbCommsTestSendResponse**](SfvbCommsTestSendResponse.md)
|
|
12542
13815
|
|
|
12543
13816
|
### Authorization
|
|
12544
13817
|
|
|
@@ -12546,17 +13819,17 @@ end
|
|
|
12546
13819
|
|
|
12547
13820
|
### HTTP request headers
|
|
12548
13821
|
|
|
12549
|
-
- **Content-Type**: application/json
|
|
13822
|
+
- **Content-Type**: application/json
|
|
12550
13823
|
- **Accept**: application/json
|
|
12551
13824
|
|
|
12552
13825
|
|
|
12553
|
-
##
|
|
13826
|
+
## test_sfvb_comms_postcard
|
|
12554
13827
|
|
|
12555
|
-
> <
|
|
13828
|
+
> <SfvbCommsTestSendResponse> test_sfvb_comms_postcard(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
|
|
12556
13829
|
|
|
12557
|
-
|
|
13830
|
+
Print and mail one real test postcard
|
|
12558
13831
|
|
|
12559
|
-
|
|
13832
|
+
It is printed and mailed at the account's cost and can't be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
|
|
12560
13833
|
|
|
12561
13834
|
|
|
12562
13835
|
### Examples
|
|
@@ -12565,21 +13838,21 @@ Owner only, and always needs sfvb_publish. The merchant must be one share_targe
|
|
|
12565
13838
|
(No example for this operation).
|
|
12566
13839
|
|
|
12567
13840
|
|
|
12568
|
-
#### Using the
|
|
13841
|
+
#### Using the test_sfvb_comms_postcard_with_http_info variant
|
|
12569
13842
|
|
|
12570
13843
|
This returns an Array which contains the response data, status code and headers.
|
|
12571
13844
|
|
|
12572
|
-
> <Array(<
|
|
13845
|
+
> <Array(<SfvbCommsTestSendResponse>, Integer, Hash)> test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
|
|
12573
13846
|
|
|
12574
13847
|
```ruby
|
|
12575
13848
|
begin
|
|
12576
|
-
#
|
|
12577
|
-
data, status_code, headers = api_instance.
|
|
13849
|
+
# Print and mail one real test postcard
|
|
13850
|
+
data, status_code, headers = api_instance.test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
|
|
12578
13851
|
p status_code # => 2xx
|
|
12579
13852
|
p headers # => { ... }
|
|
12580
|
-
p data # => <
|
|
13853
|
+
p data # => <SfvbCommsTestSendResponse>
|
|
12581
13854
|
rescue UltracartClient::ApiError => e
|
|
12582
|
-
puts "Error when calling SfvbApi->
|
|
13855
|
+
puts "Error when calling SfvbApi->test_sfvb_comms_postcard_with_http_info: #{e}"
|
|
12583
13856
|
end
|
|
12584
13857
|
```
|
|
12585
13858
|
|
|
@@ -12588,12 +13861,14 @@ end
|
|
|
12588
13861
|
| Name | Type | Description | Notes |
|
|
12589
13862
|
| ---- | ---- | ----------- | ----- |
|
|
12590
13863
|
| **storefront_oid** | **Integer** | | |
|
|
12591
|
-
| **
|
|
12592
|
-
| **
|
|
13864
|
+
| **commseq_uuid** | **String** | | |
|
|
13865
|
+
| **step_uuid** | **String** | | |
|
|
13866
|
+
| **test_postcard_request** | [**SfvbCommsTestPostcardRequest**](SfvbCommsTestPostcardRequest.md) | The address and mail_card | |
|
|
13867
|
+
| **approval_id** | **String** | The approval_id of an approved postcard.test_mail request for exactly this card and address. See POST /sfvb/approvals. | [optional] |
|
|
12593
13868
|
|
|
12594
13869
|
### Return type
|
|
12595
13870
|
|
|
12596
|
-
[**
|
|
13871
|
+
[**SfvbCommsTestSendResponse**](SfvbCommsTestSendResponse.md)
|
|
12597
13872
|
|
|
12598
13873
|
### Authorization
|
|
12599
13874
|
|
|
@@ -12601,17 +13876,17 @@ end
|
|
|
12601
13876
|
|
|
12602
13877
|
### HTTP request headers
|
|
12603
13878
|
|
|
12604
|
-
- **Content-Type**: application/json
|
|
13879
|
+
- **Content-Type**: application/json
|
|
12605
13880
|
- **Accept**: application/json
|
|
12606
13881
|
|
|
12607
13882
|
|
|
12608
|
-
##
|
|
13883
|
+
## test_sfvb_comms_sms
|
|
12609
13884
|
|
|
12610
|
-
> <
|
|
13885
|
+
> <SfvbCommsTestSendResponse> test_sfvb_comms_sms(storefront_oid, commseq_uuid, step_uuid, test_sms_request)
|
|
12611
13886
|
|
|
12612
|
-
|
|
13887
|
+
Send one test of an SMS step to a user on this account
|
|
12613
13888
|
|
|
12614
|
-
|
|
13889
|
+
to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account's Twilio account, from the flow's or campaign's SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
|
|
12615
13890
|
|
|
12616
13891
|
|
|
12617
13892
|
### Examples
|
|
@@ -12620,21 +13895,21 @@ type page starts an experiment element already saved in a page body - send path,
|
|
|
12620
13895
|
(No example for this operation).
|
|
12621
13896
|
|
|
12622
13897
|
|
|
12623
|
-
#### Using the
|
|
13898
|
+
#### Using the test_sfvb_comms_sms_with_http_info variant
|
|
12624
13899
|
|
|
12625
13900
|
This returns an Array which contains the response data, status code and headers.
|
|
12626
13901
|
|
|
12627
|
-
> <Array(<
|
|
13902
|
+
> <Array(<SfvbCommsTestSendResponse>, Integer, Hash)> test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request)
|
|
12628
13903
|
|
|
12629
13904
|
```ruby
|
|
12630
13905
|
begin
|
|
12631
|
-
#
|
|
12632
|
-
data, status_code, headers = api_instance.
|
|
13906
|
+
# Send one test of an SMS step to a user on this account
|
|
13907
|
+
data, status_code, headers = api_instance.test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request)
|
|
12633
13908
|
p status_code # => 2xx
|
|
12634
13909
|
p headers # => { ... }
|
|
12635
|
-
p data # => <
|
|
13910
|
+
p data # => <SfvbCommsTestSendResponse>
|
|
12636
13911
|
rescue UltracartClient::ApiError => e
|
|
12637
|
-
puts "Error when calling SfvbApi->
|
|
13912
|
+
puts "Error when calling SfvbApi->test_sfvb_comms_sms_with_http_info: #{e}"
|
|
12638
13913
|
end
|
|
12639
13914
|
```
|
|
12640
13915
|
|
|
@@ -12643,12 +13918,13 @@ end
|
|
|
12643
13918
|
| Name | Type | Description | Notes |
|
|
12644
13919
|
| ---- | ---- | ----------- | ----- |
|
|
12645
13920
|
| **storefront_oid** | **Integer** | | |
|
|
12646
|
-
| **
|
|
12647
|
-
| **
|
|
13921
|
+
| **commseq_uuid** | **String** | | |
|
|
13922
|
+
| **step_uuid** | **String** | | |
|
|
13923
|
+
| **test_sms_request** | [**SfvbCommsTestSmsRequest**](SfvbCommsTestSmsRequest.md) | The recipient | |
|
|
12648
13924
|
|
|
12649
13925
|
### Return type
|
|
12650
13926
|
|
|
12651
|
-
[**
|
|
13927
|
+
[**SfvbCommsTestSendResponse**](SfvbCommsTestSendResponse.md)
|
|
12652
13928
|
|
|
12653
13929
|
### Authorization
|
|
12654
13930
|
|
|
@@ -12656,7 +13932,7 @@ end
|
|
|
12656
13932
|
|
|
12657
13933
|
### HTTP request headers
|
|
12658
13934
|
|
|
12659
|
-
- **Content-Type**: application/json
|
|
13935
|
+
- **Content-Type**: application/json
|
|
12660
13936
|
- **Accept**: application/json
|
|
12661
13937
|
|
|
12662
13938
|
|
|
@@ -13100,6 +14376,118 @@ end
|
|
|
13100
14376
|
- **Accept**: application/json
|
|
13101
14377
|
|
|
13102
14378
|
|
|
14379
|
+
## update_sfvb_comms_campaign_folder
|
|
14380
|
+
|
|
14381
|
+
> <SfvbCommsSequenceFolderResponse> update_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14382
|
+
|
|
14383
|
+
Rename a campaign folder
|
|
14384
|
+
|
|
14385
|
+
Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
14386
|
+
|
|
14387
|
+
|
|
14388
|
+
### Examples
|
|
14389
|
+
|
|
14390
|
+
|
|
14391
|
+
(No example for this operation).
|
|
14392
|
+
|
|
14393
|
+
|
|
14394
|
+
#### Using the update_sfvb_comms_campaign_folder_with_http_info variant
|
|
14395
|
+
|
|
14396
|
+
This returns an Array which contains the response data, status code and headers.
|
|
14397
|
+
|
|
14398
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> update_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14399
|
+
|
|
14400
|
+
```ruby
|
|
14401
|
+
begin
|
|
14402
|
+
# Rename a campaign folder
|
|
14403
|
+
data, status_code, headers = api_instance.update_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14404
|
+
p status_code # => 2xx
|
|
14405
|
+
p headers # => { ... }
|
|
14406
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
14407
|
+
rescue UltracartClient::ApiError => e
|
|
14408
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
14409
|
+
end
|
|
14410
|
+
```
|
|
14411
|
+
|
|
14412
|
+
### Parameters
|
|
14413
|
+
|
|
14414
|
+
| Name | Type | Description | Notes |
|
|
14415
|
+
| ---- | ---- | ----------- | ----- |
|
|
14416
|
+
| **storefront_oid** | **Integer** | | |
|
|
14417
|
+
| **folder_uuid** | **String** | | |
|
|
14418
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
14419
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new name | |
|
|
14420
|
+
|
|
14421
|
+
### Return type
|
|
14422
|
+
|
|
14423
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
14424
|
+
|
|
14425
|
+
### Authorization
|
|
14426
|
+
|
|
14427
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
14428
|
+
|
|
14429
|
+
### HTTP request headers
|
|
14430
|
+
|
|
14431
|
+
- **Content-Type**: application/json
|
|
14432
|
+
- **Accept**: application/json
|
|
14433
|
+
|
|
14434
|
+
|
|
14435
|
+
## update_sfvb_comms_flow_folder
|
|
14436
|
+
|
|
14437
|
+
> <SfvbCommsSequenceFolderResponse> update_sfvb_comms_flow_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14438
|
+
|
|
14439
|
+
Rename a flow folder
|
|
14440
|
+
|
|
14441
|
+
Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
14442
|
+
|
|
14443
|
+
|
|
14444
|
+
### Examples
|
|
14445
|
+
|
|
14446
|
+
|
|
14447
|
+
(No example for this operation).
|
|
14448
|
+
|
|
14449
|
+
|
|
14450
|
+
#### Using the update_sfvb_comms_flow_folder_with_http_info variant
|
|
14451
|
+
|
|
14452
|
+
This returns an Array which contains the response data, status code and headers.
|
|
14453
|
+
|
|
14454
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> update_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14455
|
+
|
|
14456
|
+
```ruby
|
|
14457
|
+
begin
|
|
14458
|
+
# Rename a flow folder
|
|
14459
|
+
data, status_code, headers = api_instance.update_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14460
|
+
p status_code # => 2xx
|
|
14461
|
+
p headers # => { ... }
|
|
14462
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
14463
|
+
rescue UltracartClient::ApiError => e
|
|
14464
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
14465
|
+
end
|
|
14466
|
+
```
|
|
14467
|
+
|
|
14468
|
+
### Parameters
|
|
14469
|
+
|
|
14470
|
+
| Name | Type | Description | Notes |
|
|
14471
|
+
| ---- | ---- | ----------- | ----- |
|
|
14472
|
+
| **storefront_oid** | **Integer** | | |
|
|
14473
|
+
| **folder_uuid** | **String** | | |
|
|
14474
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
14475
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new name | |
|
|
14476
|
+
|
|
14477
|
+
### Return type
|
|
14478
|
+
|
|
14479
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
14480
|
+
|
|
14481
|
+
### Authorization
|
|
14482
|
+
|
|
14483
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
14484
|
+
|
|
14485
|
+
### HTTP request headers
|
|
14486
|
+
|
|
14487
|
+
- **Content-Type**: application/json
|
|
14488
|
+
- **Accept**: application/json
|
|
14489
|
+
|
|
14490
|
+
|
|
13103
14491
|
## update_sfvb_comms_folder
|
|
13104
14492
|
|
|
13105
14493
|
> <SfvbCommsFolderResponse> update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
@@ -13323,6 +14711,62 @@ end
|
|
|
13323
14711
|
- **Accept**: application/json
|
|
13324
14712
|
|
|
13325
14713
|
|
|
14714
|
+
## update_sfvb_comms_settings
|
|
14715
|
+
|
|
14716
|
+
> <SfvbCommsSettingsResponse> update_sfvb_comms_settings(storefront_oid, if_match, comms_settings_update_request, opts)
|
|
14717
|
+
|
|
14718
|
+
Change a storefront's communications settings
|
|
14719
|
+
|
|
14720
|
+
A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
|
|
14721
|
+
|
|
14722
|
+
|
|
14723
|
+
### Examples
|
|
14724
|
+
|
|
14725
|
+
|
|
14726
|
+
(No example for this operation).
|
|
14727
|
+
|
|
14728
|
+
|
|
14729
|
+
#### Using the update_sfvb_comms_settings_with_http_info variant
|
|
14730
|
+
|
|
14731
|
+
This returns an Array which contains the response data, status code and headers.
|
|
14732
|
+
|
|
14733
|
+
> <Array(<SfvbCommsSettingsResponse>, Integer, Hash)> update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts)
|
|
14734
|
+
|
|
14735
|
+
```ruby
|
|
14736
|
+
begin
|
|
14737
|
+
# Change a storefront's communications settings
|
|
14738
|
+
data, status_code, headers = api_instance.update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts)
|
|
14739
|
+
p status_code # => 2xx
|
|
14740
|
+
p headers # => { ... }
|
|
14741
|
+
p data # => <SfvbCommsSettingsResponse>
|
|
14742
|
+
rescue UltracartClient::ApiError => e
|
|
14743
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_settings_with_http_info: #{e}"
|
|
14744
|
+
end
|
|
14745
|
+
```
|
|
14746
|
+
|
|
14747
|
+
### Parameters
|
|
14748
|
+
|
|
14749
|
+
| Name | Type | Description | Notes |
|
|
14750
|
+
| ---- | ---- | ----------- | ----- |
|
|
14751
|
+
| **storefront_oid** | **Integer** | | |
|
|
14752
|
+
| **if_match** | **String** | The settings' hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
14753
|
+
| **comms_settings_update_request** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) | The settings to change | |
|
|
14754
|
+
| **approval_id** | **String** | The approval_id of an approved comms_settings.update request for exactly this change, when a sender or the SMS number changes. See POST /sfvb/approvals. | [optional] |
|
|
14755
|
+
|
|
14756
|
+
### Return type
|
|
14757
|
+
|
|
14758
|
+
[**SfvbCommsSettingsResponse**](SfvbCommsSettingsResponse.md)
|
|
14759
|
+
|
|
14760
|
+
### Authorization
|
|
14761
|
+
|
|
14762
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
14763
|
+
|
|
14764
|
+
### HTTP request headers
|
|
14765
|
+
|
|
14766
|
+
- **Content-Type**: application/json
|
|
14767
|
+
- **Accept**: application/json
|
|
14768
|
+
|
|
14769
|
+
|
|
13326
14770
|
## update_sfvb_comms_twilio_account
|
|
13327
14771
|
|
|
13328
14772
|
> <SfvbCommsTwilioAccountResponse> update_sfvb_comms_twilio_account(twilio_account)
|
|
@@ -14438,6 +15882,60 @@ end
|
|
|
14438
15882
|
- **Accept**: application/json
|
|
14439
15883
|
|
|
14440
15884
|
|
|
15885
|
+
## validate_sfvb_comms_ruler
|
|
15886
|
+
|
|
15887
|
+
> <SfvbCommsRulerValidateResponse> validate_sfvb_comms_ruler(storefront_oid, ruler_validate_request)
|
|
15888
|
+
|
|
15889
|
+
Check an Event Ruler pattern for an Is in BigQuery segment rule
|
|
15890
|
+
|
|
15891
|
+
Compiles the pattern the way an Is in BigQuery segment rule's bigquery_ruler is checked, and says whether it is valid and, if not, why. An invalid pattern is a 200 with valid false. Nothing is read or saved. A segment create or update refuses a rule whose pattern doesn't compile, or whose bigquery_table_id isn't project.dataset.table.
|
|
15892
|
+
|
|
15893
|
+
|
|
15894
|
+
### Examples
|
|
15895
|
+
|
|
15896
|
+
|
|
15897
|
+
(No example for this operation).
|
|
15898
|
+
|
|
15899
|
+
|
|
15900
|
+
#### Using the validate_sfvb_comms_ruler_with_http_info variant
|
|
15901
|
+
|
|
15902
|
+
This returns an Array which contains the response data, status code and headers.
|
|
15903
|
+
|
|
15904
|
+
> <Array(<SfvbCommsRulerValidateResponse>, Integer, Hash)> validate_sfvb_comms_ruler_with_http_info(storefront_oid, ruler_validate_request)
|
|
15905
|
+
|
|
15906
|
+
```ruby
|
|
15907
|
+
begin
|
|
15908
|
+
# Check an Event Ruler pattern for an Is in BigQuery segment rule
|
|
15909
|
+
data, status_code, headers = api_instance.validate_sfvb_comms_ruler_with_http_info(storefront_oid, ruler_validate_request)
|
|
15910
|
+
p status_code # => 2xx
|
|
15911
|
+
p headers # => { ... }
|
|
15912
|
+
p data # => <SfvbCommsRulerValidateResponse>
|
|
15913
|
+
rescue UltracartClient::ApiError => e
|
|
15914
|
+
puts "Error when calling SfvbApi->validate_sfvb_comms_ruler_with_http_info: #{e}"
|
|
15915
|
+
end
|
|
15916
|
+
```
|
|
15917
|
+
|
|
15918
|
+
### Parameters
|
|
15919
|
+
|
|
15920
|
+
| Name | Type | Description | Notes |
|
|
15921
|
+
| ---- | ---- | ----------- | ----- |
|
|
15922
|
+
| **storefront_oid** | **Integer** | | |
|
|
15923
|
+
| **ruler_validate_request** | [**SfvbCommsRulerValidateRequest**](SfvbCommsRulerValidateRequest.md) | The pattern to check | |
|
|
15924
|
+
|
|
15925
|
+
### Return type
|
|
15926
|
+
|
|
15927
|
+
[**SfvbCommsRulerValidateResponse**](SfvbCommsRulerValidateResponse.md)
|
|
15928
|
+
|
|
15929
|
+
### Authorization
|
|
15930
|
+
|
|
15931
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
15932
|
+
|
|
15933
|
+
### HTTP request headers
|
|
15934
|
+
|
|
15935
|
+
- **Content-Type**: application/json
|
|
15936
|
+
- **Accept**: application/json
|
|
15937
|
+
|
|
15938
|
+
|
|
14441
15939
|
## validate_sfvb_velocity
|
|
14442
15940
|
|
|
14443
15941
|
> <SfvbValidationResponse> validate_sfvb_velocity(storefront_oid, theme_oid, velocity_validate_request)
|