ultracart_api 4.1.232 → 4.1.234
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 +35 -2
- data/docs/SfvbApi.md +922 -34
- data/docs/SfvbApprovalCreateRequest.md +2 -0
- data/docs/SfvbApprovalParams.md +1 -1
- data/docs/SfvbCampaign.md +4 -0
- data/docs/SfvbCampaignWriteRequest.md +2 -0
- data/docs/SfvbCommsLookupOwner.md +28 -0
- data/docs/SfvbCommsLookupResponse.md +36 -0
- data/docs/SfvbCommsRulerValidateRequest.md +18 -0
- data/docs/SfvbCommsRulerValidateResponse.md +22 -0
- data/docs/SfvbCommsSequenceFolder.md +28 -0
- data/docs/SfvbCommsSequenceFolderResponse.md +22 -0
- data/docs/SfvbCommsSequenceFoldersResponse.md +18 -0
- data/docs/SfvbCommsStat.md +1 -1
- data/docs/SfvbCommsTemplateResponse.md +8 -2
- 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/SfvbPreviewTrackingHtmlRequest.md +20 -0
- data/docs/SfvbServerLog.md +1 -1
- data/docs/SfvbStepCounts.md +1 -1
- data/docs/SfvbTrackingHtmlRenderRequest.md +20 -0
- data/docs/SfvbTrackingHtmlRenderResponse.md +32 -0
- data/docs/SfvbTrackingProvider.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +1235 -31
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
- data/lib/ultracart_api/models/sfvb_approval_params.rb +1 -1
- 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_lookup_owner.rb +270 -0
- data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb +311 -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_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_stat.rb +1 -1
- data/lib/ultracart_api/models/sfvb_comms_template_response.rb +35 -5
- 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_preview_tracking_html_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_server_log.rb +1 -1
- data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
- data/lib/ultracart_api/models/sfvb_tracking_html_render_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_tracking_html_render_response.rb +328 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +15 -0
- metadata +32 -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,12 +73,17 @@ 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 |
|
|
73
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 |
|
|
74
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 |
|
|
75
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 |
|
|
76
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 |
|
|
77
84
|
| [**get_sfvb_comms_list**](SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list |
|
|
78
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 |
|
|
79
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 |
|
|
80
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 |
|
|
81
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 |
|
|
@@ -87,6 +95,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
87
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 |
|
|
88
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 |
|
|
89
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 |
|
|
90
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 |
|
|
91
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 |
|
|
92
101
|
| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
|
|
@@ -160,6 +169,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
160
169
|
| [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
|
|
161
170
|
| [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
|
|
162
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 |
|
|
163
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 |
|
|
164
175
|
| [**insert_sfvb_comms_list**](SfvbApi.md#insert_sfvb_comms_list) | **POST** /sfvb/storefronts/{storefront_oid}/lists | Create an email list |
|
|
165
176
|
| [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
|
|
@@ -216,6 +227,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
216
227
|
| [**put_sfvb_page_selectors**](SfvbApi.md#put_sfvb_page_selectors) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/selectors | Replace a page's selectors |
|
|
217
228
|
| [**put_sfvb_page_settings**](SfvbApi.md#put_sfvb_page_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/settings | Change a page's settings |
|
|
218
229
|
| [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
|
|
230
|
+
| [**put_sfvb_preview_tracking_html**](SfvbApi.md#put_sfvb_preview_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/tracking_html | Stage custom tracking HTML in a preview session |
|
|
219
231
|
| [**put_sfvb_recording_settings**](SfvbApi.md#put_sfvb_recording_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/recording_settings | Turn the storefront's screen recording on or off |
|
|
220
232
|
| [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
|
|
221
233
|
| [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings |
|
|
@@ -224,6 +236,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
224
236
|
| [**remove_sfvb_page_blog_posts**](SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page |
|
|
225
237
|
| [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
|
|
226
238
|
| [**render_sfvb_email**](SfvbApi.md#render_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/render | Render a flow or campaign email without sending it |
|
|
239
|
+
| [**render_sfvb_tracking_html**](SfvbApi.md#render_sfvb_tracking_html) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot}/render | Render the Conversion HTML against a test order |
|
|
227
240
|
| [**render_sfvb_transactional_email**](SfvbApi.md#render_sfvb_transactional_email) | **POST** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}/render | Render a transactional email without sending it |
|
|
228
241
|
| [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
|
|
229
242
|
| [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
|
|
@@ -251,6 +264,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
251
264
|
| [**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 |
|
|
252
265
|
| [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
|
|
253
266
|
| [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
|
|
267
|
+
| [**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 |
|
|
268
|
+
| [**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 |
|
|
254
269
|
| [**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 |
|
|
255
270
|
| [**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 |
|
|
256
271
|
| [**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 |
|
|
@@ -276,6 +291,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
276
291
|
| [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
|
|
277
292
|
| [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
|
|
278
293
|
| [**validate_sfvb_cjson**](SfvbApi.md#validate_sfvb_cjson) | **POST** /sfvb/cjson/validate | Validate CJSON |
|
|
294
|
+
| [**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 |
|
|
279
295
|
| [**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 |
|
|
280
296
|
|
|
281
297
|
|
|
@@ -720,6 +736,62 @@ end
|
|
|
720
736
|
- **Accept**: application/json
|
|
721
737
|
|
|
722
738
|
|
|
739
|
+
## backfill_sfvb_comms_flow
|
|
740
|
+
|
|
741
|
+
> <SfvbFlowBackfillResponse> backfill_sfvb_comms_flow(storefront_oid, flow_uuid, flow_backfill_request, opts)
|
|
742
|
+
|
|
743
|
+
Back populate a live flow, or count who it would enroll
|
|
744
|
+
|
|
745
|
+
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.
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
### Examples
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
(No example for this operation).
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
#### Using the backfill_sfvb_comms_flow_with_http_info variant
|
|
755
|
+
|
|
756
|
+
This returns an Array which contains the response data, status code and headers.
|
|
757
|
+
|
|
758
|
+
> <Array(<SfvbFlowBackfillResponse>, Integer, Hash)> backfill_sfvb_comms_flow_with_http_info(storefront_oid, flow_uuid, flow_backfill_request, opts)
|
|
759
|
+
|
|
760
|
+
```ruby
|
|
761
|
+
begin
|
|
762
|
+
# Back populate a live flow, or count who it would enroll
|
|
763
|
+
data, status_code, headers = api_instance.backfill_sfvb_comms_flow_with_http_info(storefront_oid, flow_uuid, flow_backfill_request, opts)
|
|
764
|
+
p status_code # => 2xx
|
|
765
|
+
p headers # => { ... }
|
|
766
|
+
p data # => <SfvbFlowBackfillResponse>
|
|
767
|
+
rescue UltracartClient::ApiError => e
|
|
768
|
+
puts "Error when calling SfvbApi->backfill_sfvb_comms_flow_with_http_info: #{e}"
|
|
769
|
+
end
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
### Parameters
|
|
773
|
+
|
|
774
|
+
| Name | Type | Description | Notes |
|
|
775
|
+
| ---- | ---- | ----------- | ----- |
|
|
776
|
+
| **storefront_oid** | **Integer** | | |
|
|
777
|
+
| **flow_uuid** | **String** | | |
|
|
778
|
+
| **flow_backfill_request** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | The window and dry_run | |
|
|
779
|
+
| **approval_id** | **String** | The approval_id of an approved flow.backfill request for exactly this flow and window. See POST /sfvb/approvals. | [optional] |
|
|
780
|
+
|
|
781
|
+
### Return type
|
|
782
|
+
|
|
783
|
+
[**SfvbFlowBackfillResponse**](SfvbFlowBackfillResponse.md)
|
|
784
|
+
|
|
785
|
+
### Authorization
|
|
786
|
+
|
|
787
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
788
|
+
|
|
789
|
+
### HTTP request headers
|
|
790
|
+
|
|
791
|
+
- **Content-Type**: application/json
|
|
792
|
+
- **Accept**: application/json
|
|
793
|
+
|
|
794
|
+
|
|
723
795
|
## check_sfvb_redirect
|
|
724
796
|
|
|
725
797
|
> <SfvbRedirectCheckResponse> check_sfvb_redirect(storefront_oid, redirect_request)
|
|
@@ -1423,6 +1495,116 @@ nil (empty response body)
|
|
|
1423
1495
|
- **Accept**: application/json
|
|
1424
1496
|
|
|
1425
1497
|
|
|
1498
|
+
## delete_sfvb_comms_campaign_folder
|
|
1499
|
+
|
|
1500
|
+
> <SfvbCommsSequenceFolderResponse> delete_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, if_match)
|
|
1501
|
+
|
|
1502
|
+
Delete a campaign folder
|
|
1503
|
+
|
|
1504
|
+
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.
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
### Examples
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
(No example for this operation).
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
#### Using the delete_sfvb_comms_campaign_folder_with_http_info variant
|
|
1514
|
+
|
|
1515
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1516
|
+
|
|
1517
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> delete_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1518
|
+
|
|
1519
|
+
```ruby
|
|
1520
|
+
begin
|
|
1521
|
+
# Delete a campaign folder
|
|
1522
|
+
data, status_code, headers = api_instance.delete_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1523
|
+
p status_code # => 2xx
|
|
1524
|
+
p headers # => { ... }
|
|
1525
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
1526
|
+
rescue UltracartClient::ApiError => e
|
|
1527
|
+
puts "Error when calling SfvbApi->delete_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
1528
|
+
end
|
|
1529
|
+
```
|
|
1530
|
+
|
|
1531
|
+
### Parameters
|
|
1532
|
+
|
|
1533
|
+
| Name | Type | Description | Notes |
|
|
1534
|
+
| ---- | ---- | ----------- | ----- |
|
|
1535
|
+
| **storefront_oid** | **Integer** | | |
|
|
1536
|
+
| **folder_uuid** | **String** | | |
|
|
1537
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
1538
|
+
|
|
1539
|
+
### Return type
|
|
1540
|
+
|
|
1541
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
1542
|
+
|
|
1543
|
+
### Authorization
|
|
1544
|
+
|
|
1545
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1546
|
+
|
|
1547
|
+
### HTTP request headers
|
|
1548
|
+
|
|
1549
|
+
- **Content-Type**: Not defined
|
|
1550
|
+
- **Accept**: application/json
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
## delete_sfvb_comms_flow_folder
|
|
1554
|
+
|
|
1555
|
+
> <SfvbCommsSequenceFolderResponse> delete_sfvb_comms_flow_folder(storefront_oid, folder_uuid, if_match)
|
|
1556
|
+
|
|
1557
|
+
Delete a flow folder
|
|
1558
|
+
|
|
1559
|
+
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.
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
### Examples
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
(No example for this operation).
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
#### Using the delete_sfvb_comms_flow_folder_with_http_info variant
|
|
1569
|
+
|
|
1570
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1571
|
+
|
|
1572
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> delete_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1573
|
+
|
|
1574
|
+
```ruby
|
|
1575
|
+
begin
|
|
1576
|
+
# Delete a flow folder
|
|
1577
|
+
data, status_code, headers = api_instance.delete_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match)
|
|
1578
|
+
p status_code # => 2xx
|
|
1579
|
+
p headers # => { ... }
|
|
1580
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
1581
|
+
rescue UltracartClient::ApiError => e
|
|
1582
|
+
puts "Error when calling SfvbApi->delete_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
1583
|
+
end
|
|
1584
|
+
```
|
|
1585
|
+
|
|
1586
|
+
### Parameters
|
|
1587
|
+
|
|
1588
|
+
| Name | Type | Description | Notes |
|
|
1589
|
+
| ---- | ---- | ----------- | ----- |
|
|
1590
|
+
| **storefront_oid** | **Integer** | | |
|
|
1591
|
+
| **folder_uuid** | **String** | | |
|
|
1592
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
1593
|
+
|
|
1594
|
+
### Return type
|
|
1595
|
+
|
|
1596
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
1597
|
+
|
|
1598
|
+
### Authorization
|
|
1599
|
+
|
|
1600
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1601
|
+
|
|
1602
|
+
### HTTP request headers
|
|
1603
|
+
|
|
1604
|
+
- **Content-Type**: Not defined
|
|
1605
|
+
- **Accept**: application/json
|
|
1606
|
+
|
|
1607
|
+
|
|
1426
1608
|
## delete_sfvb_comms_folder
|
|
1427
1609
|
|
|
1428
1610
|
> <SfvbCommsFolderResponse> delete_sfvb_comms_folder(storefront_oid, folder_uuid, if_match)
|
|
@@ -2250,11 +2432,11 @@ nil (empty response body)
|
|
|
2250
2432
|
|
|
2251
2433
|
## delete_sfvb_tracking_provider
|
|
2252
2434
|
|
|
2253
|
-
> <SfvbTrackingProvider> delete_sfvb_tracking_provider(storefront_oid, provider, if_match)
|
|
2435
|
+
> <SfvbTrackingProvider> delete_sfvb_tracking_provider(storefront_oid, provider, if_match, opts)
|
|
2254
2436
|
|
|
2255
2437
|
Clear one tracking provider
|
|
2256
2438
|
|
|
2257
|
-
Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.
|
|
2439
|
+
Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider's hash_sha256 as If-Match. Needs sfvb_publish. dry_run=true reports the changes, and approval_needed, without clearing. No approval, except when the clear removes a consent gate while something outside the provider's fields still fires it (Google Ads for an affiliate's own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id).
|
|
2258
2440
|
|
|
2259
2441
|
|
|
2260
2442
|
### Examples
|
|
@@ -2267,12 +2449,12 @@ Clears every field and secret the API can change, the consent gate and the event
|
|
|
2267
2449
|
|
|
2268
2450
|
This returns an Array which contains the response data, status code and headers.
|
|
2269
2451
|
|
|
2270
|
-
> <Array(<SfvbTrackingProvider>, Integer, Hash)> delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match)
|
|
2452
|
+
> <Array(<SfvbTrackingProvider>, Integer, Hash)> delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, opts)
|
|
2271
2453
|
|
|
2272
2454
|
```ruby
|
|
2273
2455
|
begin
|
|
2274
2456
|
# Clear one tracking provider
|
|
2275
|
-
data, status_code, headers = api_instance.delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match)
|
|
2457
|
+
data, status_code, headers = api_instance.delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, opts)
|
|
2276
2458
|
p status_code # => 2xx
|
|
2277
2459
|
p headers # => { ... }
|
|
2278
2460
|
p data # => <SfvbTrackingProvider>
|
|
@@ -2288,6 +2470,8 @@ end
|
|
|
2288
2470
|
| **storefront_oid** | **Integer** | | |
|
|
2289
2471
|
| **provider** | **String** | | |
|
|
2290
2472
|
| **if_match** | **String** | The provider's hash_sha256 from the last read. 428 when absent, 412 when stale. | |
|
|
2473
|
+
| **dry_run** | **Boolean** | | [optional] |
|
|
2474
|
+
| **approval_id** | **String** | When the clear removes a consent gate while something else still fires the provider, the approval_id of an approved tracking_provider.clear request for it. See POST /sfvb/approvals. | [optional] |
|
|
2291
2475
|
|
|
2292
2476
|
### Return type
|
|
2293
2477
|
|
|
@@ -3873,6 +4057,113 @@ end
|
|
|
3873
4057
|
- **Accept**: application/json
|
|
3874
4058
|
|
|
3875
4059
|
|
|
4060
|
+
## get_sfvb_comms_campaign_folder
|
|
4061
|
+
|
|
4062
|
+
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_campaign_folder(storefront_oid, folder_uuid)
|
|
4063
|
+
|
|
4064
|
+
Read one campaign folder
|
|
4065
|
+
|
|
4066
|
+
The folder, with the name and uuid of each campaign filed in it.
|
|
4067
|
+
|
|
4068
|
+
|
|
4069
|
+
### Examples
|
|
4070
|
+
|
|
4071
|
+
|
|
4072
|
+
(No example for this operation).
|
|
4073
|
+
|
|
4074
|
+
|
|
4075
|
+
#### Using the get_sfvb_comms_campaign_folder_with_http_info variant
|
|
4076
|
+
|
|
4077
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4078
|
+
|
|
4079
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4080
|
+
|
|
4081
|
+
```ruby
|
|
4082
|
+
begin
|
|
4083
|
+
# Read one campaign folder
|
|
4084
|
+
data, status_code, headers = api_instance.get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4085
|
+
p status_code # => 2xx
|
|
4086
|
+
p headers # => { ... }
|
|
4087
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
4088
|
+
rescue UltracartClient::ApiError => e
|
|
4089
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
4090
|
+
end
|
|
4091
|
+
```
|
|
4092
|
+
|
|
4093
|
+
### Parameters
|
|
4094
|
+
|
|
4095
|
+
| Name | Type | Description | Notes |
|
|
4096
|
+
| ---- | ---- | ----------- | ----- |
|
|
4097
|
+
| **storefront_oid** | **Integer** | | |
|
|
4098
|
+
| **folder_uuid** | **String** | | |
|
|
4099
|
+
|
|
4100
|
+
### Return type
|
|
4101
|
+
|
|
4102
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
4103
|
+
|
|
4104
|
+
### Authorization
|
|
4105
|
+
|
|
4106
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4107
|
+
|
|
4108
|
+
### HTTP request headers
|
|
4109
|
+
|
|
4110
|
+
- **Content-Type**: Not defined
|
|
4111
|
+
- **Accept**: application/json
|
|
4112
|
+
|
|
4113
|
+
|
|
4114
|
+
## get_sfvb_comms_campaign_folders
|
|
4115
|
+
|
|
4116
|
+
> <SfvbCommsSequenceFoldersResponse> get_sfvb_comms_campaign_folders(storefront_oid)
|
|
4117
|
+
|
|
4118
|
+
List the campaign folders
|
|
4119
|
+
|
|
4120
|
+
Each campaign folder with how many campaigns are filed in it, whether the admin made it, and its hash_sha256.
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
### Examples
|
|
4124
|
+
|
|
4125
|
+
|
|
4126
|
+
(No example for this operation).
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
#### Using the get_sfvb_comms_campaign_folders_with_http_info variant
|
|
4130
|
+
|
|
4131
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4132
|
+
|
|
4133
|
+
> <Array(<SfvbCommsSequenceFoldersResponse>, Integer, Hash)> get_sfvb_comms_campaign_folders_with_http_info(storefront_oid)
|
|
4134
|
+
|
|
4135
|
+
```ruby
|
|
4136
|
+
begin
|
|
4137
|
+
# List the campaign folders
|
|
4138
|
+
data, status_code, headers = api_instance.get_sfvb_comms_campaign_folders_with_http_info(storefront_oid)
|
|
4139
|
+
p status_code # => 2xx
|
|
4140
|
+
p headers # => { ... }
|
|
4141
|
+
p data # => <SfvbCommsSequenceFoldersResponse>
|
|
4142
|
+
rescue UltracartClient::ApiError => e
|
|
4143
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_campaign_folders_with_http_info: #{e}"
|
|
4144
|
+
end
|
|
4145
|
+
```
|
|
4146
|
+
|
|
4147
|
+
### Parameters
|
|
4148
|
+
|
|
4149
|
+
| Name | Type | Description | Notes |
|
|
4150
|
+
| ---- | ---- | ----------- | ----- |
|
|
4151
|
+
| **storefront_oid** | **Integer** | | |
|
|
4152
|
+
|
|
4153
|
+
### Return type
|
|
4154
|
+
|
|
4155
|
+
[**SfvbCommsSequenceFoldersResponse**](SfvbCommsSequenceFoldersResponse.md)
|
|
4156
|
+
|
|
4157
|
+
### Authorization
|
|
4158
|
+
|
|
4159
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4160
|
+
|
|
4161
|
+
### HTTP request headers
|
|
4162
|
+
|
|
4163
|
+
- **Content-Type**: Not defined
|
|
4164
|
+
- **Accept**: application/json
|
|
4165
|
+
|
|
4166
|
+
|
|
3876
4167
|
## get_sfvb_comms_dashboard_stats
|
|
3877
4168
|
|
|
3878
4169
|
> <SfvbCommsDashboardResponse> get_sfvb_comms_dashboard_stats(storefront_oid, opts)
|
|
@@ -3983,6 +4274,113 @@ end
|
|
|
3983
4274
|
- **Accept**: application/json
|
|
3984
4275
|
|
|
3985
4276
|
|
|
4277
|
+
## get_sfvb_comms_flow_folder
|
|
4278
|
+
|
|
4279
|
+
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_flow_folder(storefront_oid, folder_uuid)
|
|
4280
|
+
|
|
4281
|
+
Read one flow folder
|
|
4282
|
+
|
|
4283
|
+
The folder, with the name and uuid of each flow filed in it.
|
|
4284
|
+
|
|
4285
|
+
|
|
4286
|
+
### Examples
|
|
4287
|
+
|
|
4288
|
+
|
|
4289
|
+
(No example for this operation).
|
|
4290
|
+
|
|
4291
|
+
|
|
4292
|
+
#### Using the get_sfvb_comms_flow_folder_with_http_info variant
|
|
4293
|
+
|
|
4294
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4295
|
+
|
|
4296
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4297
|
+
|
|
4298
|
+
```ruby
|
|
4299
|
+
begin
|
|
4300
|
+
# Read one flow folder
|
|
4301
|
+
data, status_code, headers = api_instance.get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4302
|
+
p status_code # => 2xx
|
|
4303
|
+
p headers # => { ... }
|
|
4304
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
4305
|
+
rescue UltracartClient::ApiError => e
|
|
4306
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
4307
|
+
end
|
|
4308
|
+
```
|
|
4309
|
+
|
|
4310
|
+
### Parameters
|
|
4311
|
+
|
|
4312
|
+
| Name | Type | Description | Notes |
|
|
4313
|
+
| ---- | ---- | ----------- | ----- |
|
|
4314
|
+
| **storefront_oid** | **Integer** | | |
|
|
4315
|
+
| **folder_uuid** | **String** | | |
|
|
4316
|
+
|
|
4317
|
+
### Return type
|
|
4318
|
+
|
|
4319
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
4320
|
+
|
|
4321
|
+
### Authorization
|
|
4322
|
+
|
|
4323
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4324
|
+
|
|
4325
|
+
### HTTP request headers
|
|
4326
|
+
|
|
4327
|
+
- **Content-Type**: Not defined
|
|
4328
|
+
- **Accept**: application/json
|
|
4329
|
+
|
|
4330
|
+
|
|
4331
|
+
## get_sfvb_comms_flow_folders
|
|
4332
|
+
|
|
4333
|
+
> <SfvbCommsSequenceFoldersResponse> get_sfvb_comms_flow_folders(storefront_oid)
|
|
4334
|
+
|
|
4335
|
+
List the flow folders
|
|
4336
|
+
|
|
4337
|
+
Each flow folder with how many flows are filed in it, whether the admin made it, and its hash_sha256.
|
|
4338
|
+
|
|
4339
|
+
|
|
4340
|
+
### Examples
|
|
4341
|
+
|
|
4342
|
+
|
|
4343
|
+
(No example for this operation).
|
|
4344
|
+
|
|
4345
|
+
|
|
4346
|
+
#### Using the get_sfvb_comms_flow_folders_with_http_info variant
|
|
4347
|
+
|
|
4348
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4349
|
+
|
|
4350
|
+
> <Array(<SfvbCommsSequenceFoldersResponse>, Integer, Hash)> get_sfvb_comms_flow_folders_with_http_info(storefront_oid)
|
|
4351
|
+
|
|
4352
|
+
```ruby
|
|
4353
|
+
begin
|
|
4354
|
+
# List the flow folders
|
|
4355
|
+
data, status_code, headers = api_instance.get_sfvb_comms_flow_folders_with_http_info(storefront_oid)
|
|
4356
|
+
p status_code # => 2xx
|
|
4357
|
+
p headers # => { ... }
|
|
4358
|
+
p data # => <SfvbCommsSequenceFoldersResponse>
|
|
4359
|
+
rescue UltracartClient::ApiError => e
|
|
4360
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_flow_folders_with_http_info: #{e}"
|
|
4361
|
+
end
|
|
4362
|
+
```
|
|
4363
|
+
|
|
4364
|
+
### Parameters
|
|
4365
|
+
|
|
4366
|
+
| Name | Type | Description | Notes |
|
|
4367
|
+
| ---- | ---- | ----------- | ----- |
|
|
4368
|
+
| **storefront_oid** | **Integer** | | |
|
|
4369
|
+
|
|
4370
|
+
### Return type
|
|
4371
|
+
|
|
4372
|
+
[**SfvbCommsSequenceFoldersResponse**](SfvbCommsSequenceFoldersResponse.md)
|
|
4373
|
+
|
|
4374
|
+
### Authorization
|
|
4375
|
+
|
|
4376
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4377
|
+
|
|
4378
|
+
### HTTP request headers
|
|
4379
|
+
|
|
4380
|
+
- **Content-Type**: Not defined
|
|
4381
|
+
- **Accept**: application/json
|
|
4382
|
+
|
|
4383
|
+
|
|
3986
4384
|
## get_sfvb_comms_folder
|
|
3987
4385
|
|
|
3988
4386
|
> <SfvbCommsFolderResponse> get_sfvb_comms_folder(storefront_oid, folder_uuid)
|
|
@@ -4201,6 +4599,59 @@ end
|
|
|
4201
4599
|
- **Accept**: application/json
|
|
4202
4600
|
|
|
4203
4601
|
|
|
4602
|
+
## get_sfvb_comms_lookup
|
|
4603
|
+
|
|
4604
|
+
> <SfvbCommsLookupResponse> get_sfvb_comms_lookup(uuid)
|
|
4605
|
+
|
|
4606
|
+
Find which storefront a communications uuid lives on
|
|
4607
|
+
|
|
4608
|
+
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. An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one. A uuid nothing on this account has, another account's included, and a deleted step, email, postcard, list or segment, is 404. Read only.
|
|
4609
|
+
|
|
4610
|
+
|
|
4611
|
+
### Examples
|
|
4612
|
+
|
|
4613
|
+
|
|
4614
|
+
(No example for this operation).
|
|
4615
|
+
|
|
4616
|
+
|
|
4617
|
+
#### Using the get_sfvb_comms_lookup_with_http_info variant
|
|
4618
|
+
|
|
4619
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4620
|
+
|
|
4621
|
+
> <Array(<SfvbCommsLookupResponse>, Integer, Hash)> get_sfvb_comms_lookup_with_http_info(uuid)
|
|
4622
|
+
|
|
4623
|
+
```ruby
|
|
4624
|
+
begin
|
|
4625
|
+
# Find which storefront a communications uuid lives on
|
|
4626
|
+
data, status_code, headers = api_instance.get_sfvb_comms_lookup_with_http_info(uuid)
|
|
4627
|
+
p status_code # => 2xx
|
|
4628
|
+
p headers # => { ... }
|
|
4629
|
+
p data # => <SfvbCommsLookupResponse>
|
|
4630
|
+
rescue UltracartClient::ApiError => e
|
|
4631
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_lookup_with_http_info: #{e}"
|
|
4632
|
+
end
|
|
4633
|
+
```
|
|
4634
|
+
|
|
4635
|
+
### Parameters
|
|
4636
|
+
|
|
4637
|
+
| Name | Type | Description | Notes |
|
|
4638
|
+
| ---- | ---- | ----------- | ----- |
|
|
4639
|
+
| **uuid** | **String** | The uuid to find. | |
|
|
4640
|
+
|
|
4641
|
+
### Return type
|
|
4642
|
+
|
|
4643
|
+
[**SfvbCommsLookupResponse**](SfvbCommsLookupResponse.md)
|
|
4644
|
+
|
|
4645
|
+
### Authorization
|
|
4646
|
+
|
|
4647
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4648
|
+
|
|
4649
|
+
### HTTP request headers
|
|
4650
|
+
|
|
4651
|
+
- **Content-Type**: Not defined
|
|
4652
|
+
- **Accept**: application/json
|
|
4653
|
+
|
|
4654
|
+
|
|
4204
4655
|
## get_sfvb_comms_plan
|
|
4205
4656
|
|
|
4206
4657
|
> <SfvbCommsPlanResponse> get_sfvb_comms_plan(storefront_oid)
|
|
@@ -4636,7 +5087,7 @@ end
|
|
|
4636
5087
|
|
|
4637
5088
|
Read one saved email template's body
|
|
4638
5089
|
|
|
4639
|
-
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
|
|
5090
|
+
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.
|
|
4640
5091
|
|
|
4641
5092
|
|
|
4642
5093
|
### Examples
|
|
@@ -4788,6 +5239,59 @@ This endpoint does not need any parameter.
|
|
|
4788
5239
|
- **Accept**: application/json
|
|
4789
5240
|
|
|
4790
5241
|
|
|
5242
|
+
## get_sfvb_comms_unreferenced
|
|
5243
|
+
|
|
5244
|
+
> <SfvbCommsUnreferencedResponse> get_sfvb_comms_unreferenced(storefront_oid)
|
|
5245
|
+
|
|
5246
|
+
List the emails and postcards on a storefront that no step names
|
|
5247
|
+
|
|
5248
|
+
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.
|
|
5249
|
+
|
|
5250
|
+
|
|
5251
|
+
### Examples
|
|
5252
|
+
|
|
5253
|
+
|
|
5254
|
+
(No example for this operation).
|
|
5255
|
+
|
|
5256
|
+
|
|
5257
|
+
#### Using the get_sfvb_comms_unreferenced_with_http_info variant
|
|
5258
|
+
|
|
5259
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5260
|
+
|
|
5261
|
+
> <Array(<SfvbCommsUnreferencedResponse>, Integer, Hash)> get_sfvb_comms_unreferenced_with_http_info(storefront_oid)
|
|
5262
|
+
|
|
5263
|
+
```ruby
|
|
5264
|
+
begin
|
|
5265
|
+
# List the emails and postcards on a storefront that no step names
|
|
5266
|
+
data, status_code, headers = api_instance.get_sfvb_comms_unreferenced_with_http_info(storefront_oid)
|
|
5267
|
+
p status_code # => 2xx
|
|
5268
|
+
p headers # => { ... }
|
|
5269
|
+
p data # => <SfvbCommsUnreferencedResponse>
|
|
5270
|
+
rescue UltracartClient::ApiError => e
|
|
5271
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_unreferenced_with_http_info: #{e}"
|
|
5272
|
+
end
|
|
5273
|
+
```
|
|
5274
|
+
|
|
5275
|
+
### Parameters
|
|
5276
|
+
|
|
5277
|
+
| Name | Type | Description | Notes |
|
|
5278
|
+
| ---- | ---- | ----------- | ----- |
|
|
5279
|
+
| **storefront_oid** | **Integer** | | |
|
|
5280
|
+
|
|
5281
|
+
### Return type
|
|
5282
|
+
|
|
5283
|
+
[**SfvbCommsUnreferencedResponse**](SfvbCommsUnreferencedResponse.md)
|
|
5284
|
+
|
|
5285
|
+
### Authorization
|
|
5286
|
+
|
|
5287
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5288
|
+
|
|
5289
|
+
### HTTP request headers
|
|
5290
|
+
|
|
5291
|
+
- **Content-Type**: Not defined
|
|
5292
|
+
- **Accept**: application/json
|
|
5293
|
+
|
|
5294
|
+
|
|
4791
5295
|
## get_sfvb_container
|
|
4792
5296
|
|
|
4793
5297
|
> <SfvbContainerResponse> get_sfvb_container(storefront_oid, owner_type, owner_object_id, opts)
|
|
@@ -4960,7 +5464,7 @@ end
|
|
|
4960
5464
|
|
|
4961
5465
|
Get a flow or campaign email's subject and preview text
|
|
4962
5466
|
|
|
4963
|
-
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.
|
|
5467
|
+
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.
|
|
4964
5468
|
|
|
4965
5469
|
|
|
4966
5470
|
### Examples
|
|
@@ -8625,7 +9129,115 @@ end
|
|
|
8625
9129
|
|
|
8626
9130
|
### Return type
|
|
8627
9131
|
|
|
8628
|
-
[**SfvbAffiliateNetwork**](SfvbAffiliateNetwork.md)
|
|
9132
|
+
[**SfvbAffiliateNetwork**](SfvbAffiliateNetwork.md)
|
|
9133
|
+
|
|
9134
|
+
### Authorization
|
|
9135
|
+
|
|
9136
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9137
|
+
|
|
9138
|
+
### HTTP request headers
|
|
9139
|
+
|
|
9140
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
9141
|
+
- **Accept**: application/json
|
|
9142
|
+
|
|
9143
|
+
|
|
9144
|
+
## insert_sfvb_approval
|
|
9145
|
+
|
|
9146
|
+
> <SfvbApproval> insert_sfvb_approval(approval_request, opts)
|
|
9147
|
+
|
|
9148
|
+
Request a human approval
|
|
9149
|
+
|
|
9150
|
+
Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
|
|
9151
|
+
|
|
9152
|
+
|
|
9153
|
+
### Examples
|
|
9154
|
+
|
|
9155
|
+
|
|
9156
|
+
(No example for this operation).
|
|
9157
|
+
|
|
9158
|
+
|
|
9159
|
+
#### Using the insert_sfvb_approval_with_http_info variant
|
|
9160
|
+
|
|
9161
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9162
|
+
|
|
9163
|
+
> <Array(<SfvbApproval>, Integer, Hash)> insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
9164
|
+
|
|
9165
|
+
```ruby
|
|
9166
|
+
begin
|
|
9167
|
+
# Request a human approval
|
|
9168
|
+
data, status_code, headers = api_instance.insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
9169
|
+
p status_code # => 2xx
|
|
9170
|
+
p headers # => { ... }
|
|
9171
|
+
p data # => <SfvbApproval>
|
|
9172
|
+
rescue UltracartClient::ApiError => e
|
|
9173
|
+
puts "Error when calling SfvbApi->insert_sfvb_approval_with_http_info: #{e}"
|
|
9174
|
+
end
|
|
9175
|
+
```
|
|
9176
|
+
|
|
9177
|
+
### Parameters
|
|
9178
|
+
|
|
9179
|
+
| Name | Type | Description | Notes |
|
|
9180
|
+
| ---- | ---- | ----------- | ----- |
|
|
9181
|
+
| **approval_request** | [**SfvbApprovalCreateRequest**](SfvbApprovalCreateRequest.md) | The request | |
|
|
9182
|
+
| **storefront_oid** | **Integer** | The storefront the action runs on. Required for storefront actions, left out for account-wide ones. | [optional] |
|
|
9183
|
+
|
|
9184
|
+
### Return type
|
|
9185
|
+
|
|
9186
|
+
[**SfvbApproval**](SfvbApproval.md)
|
|
9187
|
+
|
|
9188
|
+
### Authorization
|
|
9189
|
+
|
|
9190
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9191
|
+
|
|
9192
|
+
### HTTP request headers
|
|
9193
|
+
|
|
9194
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
9195
|
+
- **Accept**: application/json
|
|
9196
|
+
|
|
9197
|
+
|
|
9198
|
+
## insert_sfvb_blog_post
|
|
9199
|
+
|
|
9200
|
+
> <SfvbBlogPostDetail> insert_sfvb_blog_post(storefront_oid, blog_post_request)
|
|
9201
|
+
|
|
9202
|
+
Create a blog post
|
|
9203
|
+
|
|
9204
|
+
title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page's selectors choose it.
|
|
9205
|
+
|
|
9206
|
+
|
|
9207
|
+
### Examples
|
|
9208
|
+
|
|
9209
|
+
|
|
9210
|
+
(No example for this operation).
|
|
9211
|
+
|
|
9212
|
+
|
|
9213
|
+
#### Using the insert_sfvb_blog_post_with_http_info variant
|
|
9214
|
+
|
|
9215
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9216
|
+
|
|
9217
|
+
> <Array(<SfvbBlogPostDetail>, Integer, Hash)> insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request)
|
|
9218
|
+
|
|
9219
|
+
```ruby
|
|
9220
|
+
begin
|
|
9221
|
+
# Create a blog post
|
|
9222
|
+
data, status_code, headers = api_instance.insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request)
|
|
9223
|
+
p status_code # => 2xx
|
|
9224
|
+
p headers # => { ... }
|
|
9225
|
+
p data # => <SfvbBlogPostDetail>
|
|
9226
|
+
rescue UltracartClient::ApiError => e
|
|
9227
|
+
puts "Error when calling SfvbApi->insert_sfvb_blog_post_with_http_info: #{e}"
|
|
9228
|
+
end
|
|
9229
|
+
```
|
|
9230
|
+
|
|
9231
|
+
### Parameters
|
|
9232
|
+
|
|
9233
|
+
| Name | Type | Description | Notes |
|
|
9234
|
+
| ---- | ---- | ----------- | ----- |
|
|
9235
|
+
| **storefront_oid** | **Integer** | | |
|
|
9236
|
+
| **blog_post_request** | [**SfvbBlogPostRequest**](SfvbBlogPostRequest.md) | The blog post to create | |
|
|
9237
|
+
|
|
9238
|
+
### Return type
|
|
9239
|
+
|
|
9240
|
+
[**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
|
|
8629
9241
|
|
|
8630
9242
|
### Authorization
|
|
8631
9243
|
|
|
@@ -8637,13 +9249,13 @@ end
|
|
|
8637
9249
|
- **Accept**: application/json
|
|
8638
9250
|
|
|
8639
9251
|
|
|
8640
|
-
##
|
|
9252
|
+
## insert_sfvb_comms_campaign_folder
|
|
8641
9253
|
|
|
8642
|
-
> <
|
|
9254
|
+
> <SfvbCommsSequenceFolderResponse> insert_sfvb_comms_campaign_folder(storefront_oid, folder_write_request)
|
|
8643
9255
|
|
|
8644
|
-
|
|
9256
|
+
Create a campaign folder
|
|
8645
9257
|
|
|
8646
|
-
|
|
9258
|
+
A new, empty folder. File a campaign in it by setting its folder_uuid.
|
|
8647
9259
|
|
|
8648
9260
|
|
|
8649
9261
|
### Examples
|
|
@@ -8652,21 +9264,21 @@ Asks the person who signed in the CLI to approve one gated action on one exact t
|
|
|
8652
9264
|
(No example for this operation).
|
|
8653
9265
|
|
|
8654
9266
|
|
|
8655
|
-
#### Using the
|
|
9267
|
+
#### Using the insert_sfvb_comms_campaign_folder_with_http_info variant
|
|
8656
9268
|
|
|
8657
9269
|
This returns an Array which contains the response data, status code and headers.
|
|
8658
9270
|
|
|
8659
|
-
> <Array(<
|
|
9271
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> insert_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_write_request)
|
|
8660
9272
|
|
|
8661
9273
|
```ruby
|
|
8662
9274
|
begin
|
|
8663
|
-
#
|
|
8664
|
-
data, status_code, headers = api_instance.
|
|
9275
|
+
# Create a campaign folder
|
|
9276
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_write_request)
|
|
8665
9277
|
p status_code # => 2xx
|
|
8666
9278
|
p headers # => { ... }
|
|
8667
|
-
p data # => <
|
|
9279
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
8668
9280
|
rescue UltracartClient::ApiError => e
|
|
8669
|
-
puts "Error when calling SfvbApi->
|
|
9281
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
8670
9282
|
end
|
|
8671
9283
|
```
|
|
8672
9284
|
|
|
@@ -8674,12 +9286,12 @@ end
|
|
|
8674
9286
|
|
|
8675
9287
|
| Name | Type | Description | Notes |
|
|
8676
9288
|
| ---- | ---- | ----------- | ----- |
|
|
8677
|
-
| **
|
|
8678
|
-
| **
|
|
9289
|
+
| **storefront_oid** | **Integer** | | |
|
|
9290
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new folder's name | |
|
|
8679
9291
|
|
|
8680
9292
|
### Return type
|
|
8681
9293
|
|
|
8682
|
-
[**
|
|
9294
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
8683
9295
|
|
|
8684
9296
|
### Authorization
|
|
8685
9297
|
|
|
@@ -8687,17 +9299,17 @@ end
|
|
|
8687
9299
|
|
|
8688
9300
|
### HTTP request headers
|
|
8689
9301
|
|
|
8690
|
-
- **Content-Type**: application/json
|
|
9302
|
+
- **Content-Type**: application/json
|
|
8691
9303
|
- **Accept**: application/json
|
|
8692
9304
|
|
|
8693
9305
|
|
|
8694
|
-
##
|
|
9306
|
+
## insert_sfvb_comms_flow_folder
|
|
8695
9307
|
|
|
8696
|
-
> <
|
|
9308
|
+
> <SfvbCommsSequenceFolderResponse> insert_sfvb_comms_flow_folder(storefront_oid, folder_write_request)
|
|
8697
9309
|
|
|
8698
|
-
Create a
|
|
9310
|
+
Create a flow folder
|
|
8699
9311
|
|
|
8700
|
-
|
|
9312
|
+
A new, empty folder. File a flow in it by setting its folder_uuid.
|
|
8701
9313
|
|
|
8702
9314
|
|
|
8703
9315
|
### Examples
|
|
@@ -8706,21 +9318,21 @@ title and url_part are required. The post is a draft unless visibility says oth
|
|
|
8706
9318
|
(No example for this operation).
|
|
8707
9319
|
|
|
8708
9320
|
|
|
8709
|
-
#### Using the
|
|
9321
|
+
#### Using the insert_sfvb_comms_flow_folder_with_http_info variant
|
|
8710
9322
|
|
|
8711
9323
|
This returns an Array which contains the response data, status code and headers.
|
|
8712
9324
|
|
|
8713
|
-
> <Array(<
|
|
9325
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> insert_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_write_request)
|
|
8714
9326
|
|
|
8715
9327
|
```ruby
|
|
8716
9328
|
begin
|
|
8717
|
-
# Create a
|
|
8718
|
-
data, status_code, headers = api_instance.
|
|
9329
|
+
# Create a flow folder
|
|
9330
|
+
data, status_code, headers = api_instance.insert_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_write_request)
|
|
8719
9331
|
p status_code # => 2xx
|
|
8720
9332
|
p headers # => { ... }
|
|
8721
|
-
p data # => <
|
|
9333
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
8722
9334
|
rescue UltracartClient::ApiError => e
|
|
8723
|
-
puts "Error when calling SfvbApi->
|
|
9335
|
+
puts "Error when calling SfvbApi->insert_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
8724
9336
|
end
|
|
8725
9337
|
```
|
|
8726
9338
|
|
|
@@ -8729,11 +9341,11 @@ end
|
|
|
8729
9341
|
| Name | Type | Description | Notes |
|
|
8730
9342
|
| ---- | ---- | ----------- | ----- |
|
|
8731
9343
|
| **storefront_oid** | **Integer** | | |
|
|
8732
|
-
| **
|
|
9344
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new folder's name | |
|
|
8733
9345
|
|
|
8734
9346
|
### Return type
|
|
8735
9347
|
|
|
8736
|
-
[**
|
|
9348
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
8737
9349
|
|
|
8738
9350
|
### Authorization
|
|
8739
9351
|
|
|
@@ -8741,7 +9353,7 @@ end
|
|
|
8741
9353
|
|
|
8742
9354
|
### HTTP request headers
|
|
8743
9355
|
|
|
8744
|
-
- **Content-Type**: application/json
|
|
9356
|
+
- **Content-Type**: application/json
|
|
8745
9357
|
- **Accept**: application/json
|
|
8746
9358
|
|
|
8747
9359
|
|
|
@@ -11842,6 +12454,61 @@ end
|
|
|
11842
12454
|
- **Accept**: application/json
|
|
11843
12455
|
|
|
11844
12456
|
|
|
12457
|
+
## put_sfvb_preview_tracking_html
|
|
12458
|
+
|
|
12459
|
+
> <SfvbTrackingHtmlResponse> put_sfvb_preview_tracking_html(storefront_oid, preview_session_id, preview_tracking_html)
|
|
12460
|
+
|
|
12461
|
+
Stage custom tracking HTML in a preview session
|
|
12462
|
+
|
|
12463
|
+
Runs Tracking HTML, Conversion HTML or both instead of the storefront's live slots, only in a browser that opened this session's preview access link, so a page can be checked before the write is approved. Staged Conversion HTML runs only on a test order's receipt. Each slot gets the same checks as a write. An empty string unstages a slot; a slot left out is left as it is. Containers pushed to the session later keep what is staged. Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user's own session runs it.
|
|
12464
|
+
|
|
12465
|
+
|
|
12466
|
+
### Examples
|
|
12467
|
+
|
|
12468
|
+
|
|
12469
|
+
(No example for this operation).
|
|
12470
|
+
|
|
12471
|
+
|
|
12472
|
+
#### Using the put_sfvb_preview_tracking_html_with_http_info variant
|
|
12473
|
+
|
|
12474
|
+
This returns an Array which contains the response data, status code and headers.
|
|
12475
|
+
|
|
12476
|
+
> <Array(<SfvbTrackingHtmlResponse>, Integer, Hash)> put_sfvb_preview_tracking_html_with_http_info(storefront_oid, preview_session_id, preview_tracking_html)
|
|
12477
|
+
|
|
12478
|
+
```ruby
|
|
12479
|
+
begin
|
|
12480
|
+
# Stage custom tracking HTML in a preview session
|
|
12481
|
+
data, status_code, headers = api_instance.put_sfvb_preview_tracking_html_with_http_info(storefront_oid, preview_session_id, preview_tracking_html)
|
|
12482
|
+
p status_code # => 2xx
|
|
12483
|
+
p headers # => { ... }
|
|
12484
|
+
p data # => <SfvbTrackingHtmlResponse>
|
|
12485
|
+
rescue UltracartClient::ApiError => e
|
|
12486
|
+
puts "Error when calling SfvbApi->put_sfvb_preview_tracking_html_with_http_info: #{e}"
|
|
12487
|
+
end
|
|
12488
|
+
```
|
|
12489
|
+
|
|
12490
|
+
### Parameters
|
|
12491
|
+
|
|
12492
|
+
| Name | Type | Description | Notes |
|
|
12493
|
+
| ---- | ---- | ----------- | ----- |
|
|
12494
|
+
| **storefront_oid** | **Integer** | | |
|
|
12495
|
+
| **preview_session_id** | **String** | | |
|
|
12496
|
+
| **preview_tracking_html** | [**SfvbPreviewTrackingHtmlRequest**](SfvbPreviewTrackingHtmlRequest.md) | The HTML to stage | |
|
|
12497
|
+
|
|
12498
|
+
### Return type
|
|
12499
|
+
|
|
12500
|
+
[**SfvbTrackingHtmlResponse**](SfvbTrackingHtmlResponse.md)
|
|
12501
|
+
|
|
12502
|
+
### Authorization
|
|
12503
|
+
|
|
12504
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
12505
|
+
|
|
12506
|
+
### HTTP request headers
|
|
12507
|
+
|
|
12508
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
12509
|
+
- **Accept**: application/json
|
|
12510
|
+
|
|
12511
|
+
|
|
11845
12512
|
## put_sfvb_recording_settings
|
|
11846
12513
|
|
|
11847
12514
|
> <SfvbRecordingSettingsResponse> put_sfvb_recording_settings(storefront_oid, recording_settings_request)
|
|
@@ -12277,6 +12944,61 @@ end
|
|
|
12277
12944
|
- **Accept**: application/json
|
|
12278
12945
|
|
|
12279
12946
|
|
|
12947
|
+
## render_sfvb_tracking_html
|
|
12948
|
+
|
|
12949
|
+
> <SfvbTrackingHtmlRenderResponse> render_sfvb_tracking_html(storefront_oid, slot, tracking_html_render_request)
|
|
12950
|
+
|
|
12951
|
+
Render the Conversion HTML against a test order
|
|
12952
|
+
|
|
12953
|
+
The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper. Renders the stored slot, or content when it is sent (a draft, checked as a write is). Only a test order on this account may be used; a real or unknown order is refused the same way. Nothing is saved, injected or sent: the receipt's provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written. Only the conversion slot renders; tracking HTML is checked by staging it in a preview session.
|
|
12954
|
+
|
|
12955
|
+
|
|
12956
|
+
### Examples
|
|
12957
|
+
|
|
12958
|
+
|
|
12959
|
+
(No example for this operation).
|
|
12960
|
+
|
|
12961
|
+
|
|
12962
|
+
#### Using the render_sfvb_tracking_html_with_http_info variant
|
|
12963
|
+
|
|
12964
|
+
This returns an Array which contains the response data, status code and headers.
|
|
12965
|
+
|
|
12966
|
+
> <Array(<SfvbTrackingHtmlRenderResponse>, Integer, Hash)> render_sfvb_tracking_html_with_http_info(storefront_oid, slot, tracking_html_render_request)
|
|
12967
|
+
|
|
12968
|
+
```ruby
|
|
12969
|
+
begin
|
|
12970
|
+
# Render the Conversion HTML against a test order
|
|
12971
|
+
data, status_code, headers = api_instance.render_sfvb_tracking_html_with_http_info(storefront_oid, slot, tracking_html_render_request)
|
|
12972
|
+
p status_code # => 2xx
|
|
12973
|
+
p headers # => { ... }
|
|
12974
|
+
p data # => <SfvbTrackingHtmlRenderResponse>
|
|
12975
|
+
rescue UltracartClient::ApiError => e
|
|
12976
|
+
puts "Error when calling SfvbApi->render_sfvb_tracking_html_with_http_info: #{e}"
|
|
12977
|
+
end
|
|
12978
|
+
```
|
|
12979
|
+
|
|
12980
|
+
### Parameters
|
|
12981
|
+
|
|
12982
|
+
| Name | Type | Description | Notes |
|
|
12983
|
+
| ---- | ---- | ----------- | ----- |
|
|
12984
|
+
| **storefront_oid** | **Integer** | | |
|
|
12985
|
+
| **slot** | **String** | conversion | |
|
|
12986
|
+
| **tracking_html_render_request** | [**SfvbTrackingHtmlRenderRequest**](SfvbTrackingHtmlRenderRequest.md) | The test order, and optionally a draft | |
|
|
12987
|
+
|
|
12988
|
+
### Return type
|
|
12989
|
+
|
|
12990
|
+
[**SfvbTrackingHtmlRenderResponse**](SfvbTrackingHtmlRenderResponse.md)
|
|
12991
|
+
|
|
12992
|
+
### Authorization
|
|
12993
|
+
|
|
12994
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
12995
|
+
|
|
12996
|
+
### HTTP request headers
|
|
12997
|
+
|
|
12998
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
12999
|
+
- **Accept**: application/json
|
|
13000
|
+
|
|
13001
|
+
|
|
12280
13002
|
## render_sfvb_transactional_email
|
|
12281
13003
|
|
|
12282
13004
|
> <SfvbEmailRenderResponse> render_sfvb_transactional_email(storefront_oid, file_name, email_render_request)
|
|
@@ -13768,6 +14490,118 @@ end
|
|
|
13768
14490
|
- **Accept**: application/json
|
|
13769
14491
|
|
|
13770
14492
|
|
|
14493
|
+
## update_sfvb_comms_campaign_folder
|
|
14494
|
+
|
|
14495
|
+
> <SfvbCommsSequenceFolderResponse> update_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14496
|
+
|
|
14497
|
+
Rename a campaign folder
|
|
14498
|
+
|
|
14499
|
+
Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
14500
|
+
|
|
14501
|
+
|
|
14502
|
+
### Examples
|
|
14503
|
+
|
|
14504
|
+
|
|
14505
|
+
(No example for this operation).
|
|
14506
|
+
|
|
14507
|
+
|
|
14508
|
+
#### Using the update_sfvb_comms_campaign_folder_with_http_info variant
|
|
14509
|
+
|
|
14510
|
+
This returns an Array which contains the response data, status code and headers.
|
|
14511
|
+
|
|
14512
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> update_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14513
|
+
|
|
14514
|
+
```ruby
|
|
14515
|
+
begin
|
|
14516
|
+
# Rename a campaign folder
|
|
14517
|
+
data, status_code, headers = api_instance.update_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14518
|
+
p status_code # => 2xx
|
|
14519
|
+
p headers # => { ... }
|
|
14520
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
14521
|
+
rescue UltracartClient::ApiError => e
|
|
14522
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
14523
|
+
end
|
|
14524
|
+
```
|
|
14525
|
+
|
|
14526
|
+
### Parameters
|
|
14527
|
+
|
|
14528
|
+
| Name | Type | Description | Notes |
|
|
14529
|
+
| ---- | ---- | ----------- | ----- |
|
|
14530
|
+
| **storefront_oid** | **Integer** | | |
|
|
14531
|
+
| **folder_uuid** | **String** | | |
|
|
14532
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
14533
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new name | |
|
|
14534
|
+
|
|
14535
|
+
### Return type
|
|
14536
|
+
|
|
14537
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
14538
|
+
|
|
14539
|
+
### Authorization
|
|
14540
|
+
|
|
14541
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
14542
|
+
|
|
14543
|
+
### HTTP request headers
|
|
14544
|
+
|
|
14545
|
+
- **Content-Type**: application/json
|
|
14546
|
+
- **Accept**: application/json
|
|
14547
|
+
|
|
14548
|
+
|
|
14549
|
+
## update_sfvb_comms_flow_folder
|
|
14550
|
+
|
|
14551
|
+
> <SfvbCommsSequenceFolderResponse> update_sfvb_comms_flow_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14552
|
+
|
|
14553
|
+
Rename a flow folder
|
|
14554
|
+
|
|
14555
|
+
Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
14556
|
+
|
|
14557
|
+
|
|
14558
|
+
### Examples
|
|
14559
|
+
|
|
14560
|
+
|
|
14561
|
+
(No example for this operation).
|
|
14562
|
+
|
|
14563
|
+
|
|
14564
|
+
#### Using the update_sfvb_comms_flow_folder_with_http_info variant
|
|
14565
|
+
|
|
14566
|
+
This returns an Array which contains the response data, status code and headers.
|
|
14567
|
+
|
|
14568
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> update_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14569
|
+
|
|
14570
|
+
```ruby
|
|
14571
|
+
begin
|
|
14572
|
+
# Rename a flow folder
|
|
14573
|
+
data, status_code, headers = api_instance.update_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
14574
|
+
p status_code # => 2xx
|
|
14575
|
+
p headers # => { ... }
|
|
14576
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
14577
|
+
rescue UltracartClient::ApiError => e
|
|
14578
|
+
puts "Error when calling SfvbApi->update_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
14579
|
+
end
|
|
14580
|
+
```
|
|
14581
|
+
|
|
14582
|
+
### Parameters
|
|
14583
|
+
|
|
14584
|
+
| Name | Type | Description | Notes |
|
|
14585
|
+
| ---- | ---- | ----------- | ----- |
|
|
14586
|
+
| **storefront_oid** | **Integer** | | |
|
|
14587
|
+
| **folder_uuid** | **String** | | |
|
|
14588
|
+
| **if_match** | **String** | The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
14589
|
+
| **folder_write_request** | [**SfvbCommsFolderWriteRequest**](SfvbCommsFolderWriteRequest.md) | The new name | |
|
|
14590
|
+
|
|
14591
|
+
### Return type
|
|
14592
|
+
|
|
14593
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
14594
|
+
|
|
14595
|
+
### Authorization
|
|
14596
|
+
|
|
14597
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
14598
|
+
|
|
14599
|
+
### HTTP request headers
|
|
14600
|
+
|
|
14601
|
+
- **Content-Type**: application/json
|
|
14602
|
+
- **Accept**: application/json
|
|
14603
|
+
|
|
14604
|
+
|
|
13771
14605
|
## update_sfvb_comms_folder
|
|
13772
14606
|
|
|
13773
14607
|
> <SfvbCommsFolderResponse> update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
@@ -15162,6 +15996,60 @@ end
|
|
|
15162
15996
|
- **Accept**: application/json
|
|
15163
15997
|
|
|
15164
15998
|
|
|
15999
|
+
## validate_sfvb_comms_ruler
|
|
16000
|
+
|
|
16001
|
+
> <SfvbCommsRulerValidateResponse> validate_sfvb_comms_ruler(storefront_oid, ruler_validate_request)
|
|
16002
|
+
|
|
16003
|
+
Check an Event Ruler pattern for an Is in BigQuery segment rule
|
|
16004
|
+
|
|
16005
|
+
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.
|
|
16006
|
+
|
|
16007
|
+
|
|
16008
|
+
### Examples
|
|
16009
|
+
|
|
16010
|
+
|
|
16011
|
+
(No example for this operation).
|
|
16012
|
+
|
|
16013
|
+
|
|
16014
|
+
#### Using the validate_sfvb_comms_ruler_with_http_info variant
|
|
16015
|
+
|
|
16016
|
+
This returns an Array which contains the response data, status code and headers.
|
|
16017
|
+
|
|
16018
|
+
> <Array(<SfvbCommsRulerValidateResponse>, Integer, Hash)> validate_sfvb_comms_ruler_with_http_info(storefront_oid, ruler_validate_request)
|
|
16019
|
+
|
|
16020
|
+
```ruby
|
|
16021
|
+
begin
|
|
16022
|
+
# Check an Event Ruler pattern for an Is in BigQuery segment rule
|
|
16023
|
+
data, status_code, headers = api_instance.validate_sfvb_comms_ruler_with_http_info(storefront_oid, ruler_validate_request)
|
|
16024
|
+
p status_code # => 2xx
|
|
16025
|
+
p headers # => { ... }
|
|
16026
|
+
p data # => <SfvbCommsRulerValidateResponse>
|
|
16027
|
+
rescue UltracartClient::ApiError => e
|
|
16028
|
+
puts "Error when calling SfvbApi->validate_sfvb_comms_ruler_with_http_info: #{e}"
|
|
16029
|
+
end
|
|
16030
|
+
```
|
|
16031
|
+
|
|
16032
|
+
### Parameters
|
|
16033
|
+
|
|
16034
|
+
| Name | Type | Description | Notes |
|
|
16035
|
+
| ---- | ---- | ----------- | ----- |
|
|
16036
|
+
| **storefront_oid** | **Integer** | | |
|
|
16037
|
+
| **ruler_validate_request** | [**SfvbCommsRulerValidateRequest**](SfvbCommsRulerValidateRequest.md) | The pattern to check | |
|
|
16038
|
+
|
|
16039
|
+
### Return type
|
|
16040
|
+
|
|
16041
|
+
[**SfvbCommsRulerValidateResponse**](SfvbCommsRulerValidateResponse.md)
|
|
16042
|
+
|
|
16043
|
+
### Authorization
|
|
16044
|
+
|
|
16045
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
16046
|
+
|
|
16047
|
+
### HTTP request headers
|
|
16048
|
+
|
|
16049
|
+
- **Content-Type**: application/json
|
|
16050
|
+
- **Accept**: application/json
|
|
16051
|
+
|
|
16052
|
+
|
|
15165
16053
|
## validate_sfvb_velocity
|
|
15166
16054
|
|
|
15167
16055
|
> <SfvbValidationResponse> validate_sfvb_velocity(storefront_oid, theme_oid, velocity_validate_request)
|