ultracart_api 4.1.232 → 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 +29 -2
- data/docs/SfvbApi.md +799 -25
- data/docs/SfvbApprovalCreateRequest.md +2 -0
- data/docs/SfvbCampaign.md +4 -0
- data/docs/SfvbCampaignWriteRequest.md +2 -0
- data/docs/SfvbCommsLookupOwner.md +26 -0
- data/docs/SfvbCommsLookupResponse.md +34 -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/SfvbStepCounts.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +1098 -62
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -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_lookup_owner.rb +260 -0
- data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb +301 -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_step_counts.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +12 -0
- metadata +26 -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 |
|
|
@@ -251,6 +262,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
251
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 |
|
|
252
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 |
|
|
253
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 |
|
|
254
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 |
|
|
255
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 |
|
|
256
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 |
|
|
@@ -276,6 +289,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
276
289
|
| [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
|
|
277
290
|
| [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
|
|
278
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 |
|
|
279
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 |
|
|
280
294
|
|
|
281
295
|
|
|
@@ -720,6 +734,62 @@ end
|
|
|
720
734
|
- **Accept**: application/json
|
|
721
735
|
|
|
722
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
|
+
|
|
723
793
|
## check_sfvb_redirect
|
|
724
794
|
|
|
725
795
|
> <SfvbRedirectCheckResponse> check_sfvb_redirect(storefront_oid, redirect_request)
|
|
@@ -1423,6 +1493,116 @@ nil (empty response body)
|
|
|
1423
1493
|
- **Accept**: application/json
|
|
1424
1494
|
|
|
1425
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
|
+
|
|
1426
1606
|
## delete_sfvb_comms_folder
|
|
1427
1607
|
|
|
1428
1608
|
> <SfvbCommsFolderResponse> delete_sfvb_comms_folder(storefront_oid, folder_uuid, if_match)
|
|
@@ -3873,6 +4053,113 @@ end
|
|
|
3873
4053
|
- **Accept**: application/json
|
|
3874
4054
|
|
|
3875
4055
|
|
|
4056
|
+
## get_sfvb_comms_campaign_folder
|
|
4057
|
+
|
|
4058
|
+
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_campaign_folder(storefront_oid, folder_uuid)
|
|
4059
|
+
|
|
4060
|
+
Read one campaign folder
|
|
4061
|
+
|
|
4062
|
+
The folder, with the name and uuid of each campaign filed in it.
|
|
4063
|
+
|
|
4064
|
+
|
|
4065
|
+
### Examples
|
|
4066
|
+
|
|
4067
|
+
|
|
4068
|
+
(No example for this operation).
|
|
4069
|
+
|
|
4070
|
+
|
|
4071
|
+
#### Using the get_sfvb_comms_campaign_folder_with_http_info variant
|
|
4072
|
+
|
|
4073
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4074
|
+
|
|
4075
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4076
|
+
|
|
4077
|
+
```ruby
|
|
4078
|
+
begin
|
|
4079
|
+
# Read one campaign folder
|
|
4080
|
+
data, status_code, headers = api_instance.get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4081
|
+
p status_code # => 2xx
|
|
4082
|
+
p headers # => { ... }
|
|
4083
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
4084
|
+
rescue UltracartClient::ApiError => e
|
|
4085
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_campaign_folder_with_http_info: #{e}"
|
|
4086
|
+
end
|
|
4087
|
+
```
|
|
4088
|
+
|
|
4089
|
+
### Parameters
|
|
4090
|
+
|
|
4091
|
+
| Name | Type | Description | Notes |
|
|
4092
|
+
| ---- | ---- | ----------- | ----- |
|
|
4093
|
+
| **storefront_oid** | **Integer** | | |
|
|
4094
|
+
| **folder_uuid** | **String** | | |
|
|
4095
|
+
|
|
4096
|
+
### Return type
|
|
4097
|
+
|
|
4098
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
4099
|
+
|
|
4100
|
+
### Authorization
|
|
4101
|
+
|
|
4102
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4103
|
+
|
|
4104
|
+
### HTTP request headers
|
|
4105
|
+
|
|
4106
|
+
- **Content-Type**: Not defined
|
|
4107
|
+
- **Accept**: application/json
|
|
4108
|
+
|
|
4109
|
+
|
|
4110
|
+
## get_sfvb_comms_campaign_folders
|
|
4111
|
+
|
|
4112
|
+
> <SfvbCommsSequenceFoldersResponse> get_sfvb_comms_campaign_folders(storefront_oid)
|
|
4113
|
+
|
|
4114
|
+
List the campaign folders
|
|
4115
|
+
|
|
4116
|
+
Each campaign folder with how many campaigns are filed in it, whether the admin made it, and its hash_sha256.
|
|
4117
|
+
|
|
4118
|
+
|
|
4119
|
+
### Examples
|
|
4120
|
+
|
|
4121
|
+
|
|
4122
|
+
(No example for this operation).
|
|
4123
|
+
|
|
4124
|
+
|
|
4125
|
+
#### Using the get_sfvb_comms_campaign_folders_with_http_info variant
|
|
4126
|
+
|
|
4127
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4128
|
+
|
|
4129
|
+
> <Array(<SfvbCommsSequenceFoldersResponse>, Integer, Hash)> get_sfvb_comms_campaign_folders_with_http_info(storefront_oid)
|
|
4130
|
+
|
|
4131
|
+
```ruby
|
|
4132
|
+
begin
|
|
4133
|
+
# List the campaign folders
|
|
4134
|
+
data, status_code, headers = api_instance.get_sfvb_comms_campaign_folders_with_http_info(storefront_oid)
|
|
4135
|
+
p status_code # => 2xx
|
|
4136
|
+
p headers # => { ... }
|
|
4137
|
+
p data # => <SfvbCommsSequenceFoldersResponse>
|
|
4138
|
+
rescue UltracartClient::ApiError => e
|
|
4139
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_campaign_folders_with_http_info: #{e}"
|
|
4140
|
+
end
|
|
4141
|
+
```
|
|
4142
|
+
|
|
4143
|
+
### Parameters
|
|
4144
|
+
|
|
4145
|
+
| Name | Type | Description | Notes |
|
|
4146
|
+
| ---- | ---- | ----------- | ----- |
|
|
4147
|
+
| **storefront_oid** | **Integer** | | |
|
|
4148
|
+
|
|
4149
|
+
### Return type
|
|
4150
|
+
|
|
4151
|
+
[**SfvbCommsSequenceFoldersResponse**](SfvbCommsSequenceFoldersResponse.md)
|
|
4152
|
+
|
|
4153
|
+
### Authorization
|
|
4154
|
+
|
|
4155
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4156
|
+
|
|
4157
|
+
### HTTP request headers
|
|
4158
|
+
|
|
4159
|
+
- **Content-Type**: Not defined
|
|
4160
|
+
- **Accept**: application/json
|
|
4161
|
+
|
|
4162
|
+
|
|
3876
4163
|
## get_sfvb_comms_dashboard_stats
|
|
3877
4164
|
|
|
3878
4165
|
> <SfvbCommsDashboardResponse> get_sfvb_comms_dashboard_stats(storefront_oid, opts)
|
|
@@ -3983,6 +4270,113 @@ end
|
|
|
3983
4270
|
- **Accept**: application/json
|
|
3984
4271
|
|
|
3985
4272
|
|
|
4273
|
+
## get_sfvb_comms_flow_folder
|
|
4274
|
+
|
|
4275
|
+
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_flow_folder(storefront_oid, folder_uuid)
|
|
4276
|
+
|
|
4277
|
+
Read one flow folder
|
|
4278
|
+
|
|
4279
|
+
The folder, with the name and uuid of each flow filed in it.
|
|
4280
|
+
|
|
4281
|
+
|
|
4282
|
+
### Examples
|
|
4283
|
+
|
|
4284
|
+
|
|
4285
|
+
(No example for this operation).
|
|
4286
|
+
|
|
4287
|
+
|
|
4288
|
+
#### Using the get_sfvb_comms_flow_folder_with_http_info variant
|
|
4289
|
+
|
|
4290
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4291
|
+
|
|
4292
|
+
> <Array(<SfvbCommsSequenceFolderResponse>, Integer, Hash)> get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4293
|
+
|
|
4294
|
+
```ruby
|
|
4295
|
+
begin
|
|
4296
|
+
# Read one flow folder
|
|
4297
|
+
data, status_code, headers = api_instance.get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid)
|
|
4298
|
+
p status_code # => 2xx
|
|
4299
|
+
p headers # => { ... }
|
|
4300
|
+
p data # => <SfvbCommsSequenceFolderResponse>
|
|
4301
|
+
rescue UltracartClient::ApiError => e
|
|
4302
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_flow_folder_with_http_info: #{e}"
|
|
4303
|
+
end
|
|
4304
|
+
```
|
|
4305
|
+
|
|
4306
|
+
### Parameters
|
|
4307
|
+
|
|
4308
|
+
| Name | Type | Description | Notes |
|
|
4309
|
+
| ---- | ---- | ----------- | ----- |
|
|
4310
|
+
| **storefront_oid** | **Integer** | | |
|
|
4311
|
+
| **folder_uuid** | **String** | | |
|
|
4312
|
+
|
|
4313
|
+
### Return type
|
|
4314
|
+
|
|
4315
|
+
[**SfvbCommsSequenceFolderResponse**](SfvbCommsSequenceFolderResponse.md)
|
|
4316
|
+
|
|
4317
|
+
### Authorization
|
|
4318
|
+
|
|
4319
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4320
|
+
|
|
4321
|
+
### HTTP request headers
|
|
4322
|
+
|
|
4323
|
+
- **Content-Type**: Not defined
|
|
4324
|
+
- **Accept**: application/json
|
|
4325
|
+
|
|
4326
|
+
|
|
4327
|
+
## get_sfvb_comms_flow_folders
|
|
4328
|
+
|
|
4329
|
+
> <SfvbCommsSequenceFoldersResponse> get_sfvb_comms_flow_folders(storefront_oid)
|
|
4330
|
+
|
|
4331
|
+
List the flow folders
|
|
4332
|
+
|
|
4333
|
+
Each flow folder with how many flows are filed in it, whether the admin made it, and its hash_sha256.
|
|
4334
|
+
|
|
4335
|
+
|
|
4336
|
+
### Examples
|
|
4337
|
+
|
|
4338
|
+
|
|
4339
|
+
(No example for this operation).
|
|
4340
|
+
|
|
4341
|
+
|
|
4342
|
+
#### Using the get_sfvb_comms_flow_folders_with_http_info variant
|
|
4343
|
+
|
|
4344
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4345
|
+
|
|
4346
|
+
> <Array(<SfvbCommsSequenceFoldersResponse>, Integer, Hash)> get_sfvb_comms_flow_folders_with_http_info(storefront_oid)
|
|
4347
|
+
|
|
4348
|
+
```ruby
|
|
4349
|
+
begin
|
|
4350
|
+
# List the flow folders
|
|
4351
|
+
data, status_code, headers = api_instance.get_sfvb_comms_flow_folders_with_http_info(storefront_oid)
|
|
4352
|
+
p status_code # => 2xx
|
|
4353
|
+
p headers # => { ... }
|
|
4354
|
+
p data # => <SfvbCommsSequenceFoldersResponse>
|
|
4355
|
+
rescue UltracartClient::ApiError => e
|
|
4356
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_flow_folders_with_http_info: #{e}"
|
|
4357
|
+
end
|
|
4358
|
+
```
|
|
4359
|
+
|
|
4360
|
+
### Parameters
|
|
4361
|
+
|
|
4362
|
+
| Name | Type | Description | Notes |
|
|
4363
|
+
| ---- | ---- | ----------- | ----- |
|
|
4364
|
+
| **storefront_oid** | **Integer** | | |
|
|
4365
|
+
|
|
4366
|
+
### Return type
|
|
4367
|
+
|
|
4368
|
+
[**SfvbCommsSequenceFoldersResponse**](SfvbCommsSequenceFoldersResponse.md)
|
|
4369
|
+
|
|
4370
|
+
### Authorization
|
|
4371
|
+
|
|
4372
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4373
|
+
|
|
4374
|
+
### HTTP request headers
|
|
4375
|
+
|
|
4376
|
+
- **Content-Type**: Not defined
|
|
4377
|
+
- **Accept**: application/json
|
|
4378
|
+
|
|
4379
|
+
|
|
3986
4380
|
## get_sfvb_comms_folder
|
|
3987
4381
|
|
|
3988
4382
|
> <SfvbCommsFolderResponse> get_sfvb_comms_folder(storefront_oid, folder_uuid)
|
|
@@ -4201,6 +4595,59 @@ end
|
|
|
4201
4595
|
- **Accept**: application/json
|
|
4202
4596
|
|
|
4203
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
|
+
|
|
4204
4651
|
## get_sfvb_comms_plan
|
|
4205
4652
|
|
|
4206
4653
|
> <SfvbCommsPlanResponse> get_sfvb_comms_plan(storefront_oid)
|
|
@@ -4636,7 +5083,7 @@ end
|
|
|
4636
5083
|
|
|
4637
5084
|
Read one saved email template's body
|
|
4638
5085
|
|
|
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
|
|
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.
|
|
4640
5087
|
|
|
4641
5088
|
|
|
4642
5089
|
### Examples
|
|
@@ -4690,7 +5137,60 @@ end
|
|
|
4690
5137
|
|
|
4691
5138
|
List the email templates a new email can start from
|
|
4692
5139
|
|
|
4693
|
-
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.
|
|
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
|
+
|
|
5187
|
+
## get_sfvb_comms_twilio_account
|
|
5188
|
+
|
|
5189
|
+
> <SfvbCommsTwilioAccountResponse> get_sfvb_comms_twilio_account
|
|
5190
|
+
|
|
5191
|
+
Read the Twilio account
|
|
5192
|
+
|
|
5193
|
+
The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
4694
5194
|
|
|
4695
5195
|
|
|
4696
5196
|
### Examples
|
|
@@ -4699,33 +5199,31 @@ One list: UltraCart's system templates and this storefront's saved ones (each wi
|
|
|
4699
5199
|
(No example for this operation).
|
|
4700
5200
|
|
|
4701
5201
|
|
|
4702
|
-
#### Using the
|
|
5202
|
+
#### Using the get_sfvb_comms_twilio_account_with_http_info variant
|
|
4703
5203
|
|
|
4704
5204
|
This returns an Array which contains the response data, status code and headers.
|
|
4705
5205
|
|
|
4706
|
-
> <Array(<
|
|
5206
|
+
> <Array(<SfvbCommsTwilioAccountResponse>, Integer, Hash)> get_sfvb_comms_twilio_account_with_http_info
|
|
4707
5207
|
|
|
4708
5208
|
```ruby
|
|
4709
5209
|
begin
|
|
4710
|
-
#
|
|
4711
|
-
data, status_code, headers = api_instance.
|
|
5210
|
+
# Read the Twilio account
|
|
5211
|
+
data, status_code, headers = api_instance.get_sfvb_comms_twilio_account_with_http_info
|
|
4712
5212
|
p status_code # => 2xx
|
|
4713
5213
|
p headers # => { ... }
|
|
4714
|
-
p data # => <
|
|
5214
|
+
p data # => <SfvbCommsTwilioAccountResponse>
|
|
4715
5215
|
rescue UltracartClient::ApiError => e
|
|
4716
|
-
puts "Error when calling SfvbApi->
|
|
5216
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_twilio_account_with_http_info: #{e}"
|
|
4717
5217
|
end
|
|
4718
5218
|
```
|
|
4719
5219
|
|
|
4720
5220
|
### Parameters
|
|
4721
5221
|
|
|
4722
|
-
|
|
4723
|
-
| ---- | ---- | ----------- | ----- |
|
|
4724
|
-
| **storefront_oid** | **Integer** | | |
|
|
5222
|
+
This endpoint does not need any parameter.
|
|
4725
5223
|
|
|
4726
5224
|
### Return type
|
|
4727
5225
|
|
|
4728
|
-
[**
|
|
5226
|
+
[**SfvbCommsTwilioAccountResponse**](SfvbCommsTwilioAccountResponse.md)
|
|
4729
5227
|
|
|
4730
5228
|
### Authorization
|
|
4731
5229
|
|
|
@@ -4737,13 +5235,13 @@ end
|
|
|
4737
5235
|
- **Accept**: application/json
|
|
4738
5236
|
|
|
4739
5237
|
|
|
4740
|
-
##
|
|
5238
|
+
## get_sfvb_comms_unreferenced
|
|
4741
5239
|
|
|
4742
|
-
> <
|
|
5240
|
+
> <SfvbCommsUnreferencedResponse> get_sfvb_comms_unreferenced(storefront_oid)
|
|
4743
5241
|
|
|
4744
|
-
|
|
5242
|
+
List the emails and postcards on a storefront that no step names
|
|
4745
5243
|
|
|
4746
|
-
|
|
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.
|
|
4747
5245
|
|
|
4748
5246
|
|
|
4749
5247
|
### Examples
|
|
@@ -4752,31 +5250,33 @@ The account's Twilio account, used for SMS and the phone system, or none. An ac
|
|
|
4752
5250
|
(No example for this operation).
|
|
4753
5251
|
|
|
4754
5252
|
|
|
4755
|
-
#### Using the
|
|
5253
|
+
#### Using the get_sfvb_comms_unreferenced_with_http_info variant
|
|
4756
5254
|
|
|
4757
5255
|
This returns an Array which contains the response data, status code and headers.
|
|
4758
5256
|
|
|
4759
|
-
> <Array(<
|
|
5257
|
+
> <Array(<SfvbCommsUnreferencedResponse>, Integer, Hash)> get_sfvb_comms_unreferenced_with_http_info(storefront_oid)
|
|
4760
5258
|
|
|
4761
5259
|
```ruby
|
|
4762
5260
|
begin
|
|
4763
|
-
#
|
|
4764
|
-
data, status_code, headers = api_instance.
|
|
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)
|
|
4765
5263
|
p status_code # => 2xx
|
|
4766
5264
|
p headers # => { ... }
|
|
4767
|
-
p data # => <
|
|
5265
|
+
p data # => <SfvbCommsUnreferencedResponse>
|
|
4768
5266
|
rescue UltracartClient::ApiError => e
|
|
4769
|
-
puts "Error when calling SfvbApi->
|
|
5267
|
+
puts "Error when calling SfvbApi->get_sfvb_comms_unreferenced_with_http_info: #{e}"
|
|
4770
5268
|
end
|
|
4771
5269
|
```
|
|
4772
5270
|
|
|
4773
5271
|
### Parameters
|
|
4774
5272
|
|
|
4775
|
-
|
|
5273
|
+
| Name | Type | Description | Notes |
|
|
5274
|
+
| ---- | ---- | ----------- | ----- |
|
|
5275
|
+
| **storefront_oid** | **Integer** | | |
|
|
4776
5276
|
|
|
4777
5277
|
### Return type
|
|
4778
5278
|
|
|
4779
|
-
[**
|
|
5279
|
+
[**SfvbCommsUnreferencedResponse**](SfvbCommsUnreferencedResponse.md)
|
|
4780
5280
|
|
|
4781
5281
|
### Authorization
|
|
4782
5282
|
|
|
@@ -4960,7 +5460,7 @@ end
|
|
|
4960
5460
|
|
|
4961
5461
|
Get a flow or campaign email's subject and preview text
|
|
4962
5462
|
|
|
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.
|
|
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.
|
|
4964
5464
|
|
|
4965
5465
|
|
|
4966
5466
|
### Examples
|
|
@@ -8745,6 +9245,114 @@ end
|
|
|
8745
9245
|
- **Accept**: application/json
|
|
8746
9246
|
|
|
8747
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
|
+
|
|
8748
9356
|
## insert_sfvb_comms_folder
|
|
8749
9357
|
|
|
8750
9358
|
> <SfvbCommsFolderResponse> insert_sfvb_comms_folder(storefront_oid, folder_write_request)
|
|
@@ -13768,6 +14376,118 @@ end
|
|
|
13768
14376
|
- **Accept**: application/json
|
|
13769
14377
|
|
|
13770
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
|
+
|
|
13771
14491
|
## update_sfvb_comms_folder
|
|
13772
14492
|
|
|
13773
14493
|
> <SfvbCommsFolderResponse> update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request)
|
|
@@ -15162,6 +15882,60 @@ end
|
|
|
15162
15882
|
- **Accept**: application/json
|
|
15163
15883
|
|
|
15164
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
|
+
|
|
15165
15939
|
## validate_sfvb_velocity
|
|
15166
15940
|
|
|
15167
15941
|
> <SfvbValidationResponse> validate_sfvb_velocity(storefront_oid, theme_oid, velocity_validate_request)
|