ultracart_api 4.1.230 → 4.1.232

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -2
  3. data/docs/ItemAutoOrder.md +1 -1
  4. data/docs/ItemContentMultimedia.md +2 -0
  5. data/docs/SfvbApi.md +1011 -0
  6. data/docs/SfvbApprovalCreateRequest.md +9 -1
  7. data/docs/SfvbCampaign.md +2 -0
  8. data/docs/SfvbCommsBranchStat.md +20 -0
  9. data/docs/SfvbCommsChange.md +22 -0
  10. data/docs/SfvbCommsClick.md +20 -0
  11. data/docs/SfvbCommsClicksResponse.md +26 -0
  12. data/docs/SfvbCommsDailyStat.md +30 -0
  13. data/docs/SfvbCommsDashboardResponse.md +24 -0
  14. data/docs/SfvbCommsDashboardRow.md +28 -0
  15. data/docs/SfvbCommsMember.md +22 -0
  16. data/docs/SfvbCommsMembersResponse.md +36 -0
  17. data/docs/SfvbCommsPlan.md +66 -0
  18. data/docs/SfvbCommsPlanResponse.md +20 -0
  19. data/docs/SfvbCommsProvider.md +28 -0
  20. data/docs/SfvbCommsProviderImportRequest.md +22 -0
  21. data/docs/SfvbCommsProviderImportResponse.md +26 -0
  22. data/docs/SfvbCommsProviderList.md +20 -0
  23. data/docs/SfvbCommsProvidersResponse.md +22 -0
  24. data/docs/SfvbCommsSender.md +24 -0
  25. data/docs/SfvbCommsSenderUpdate.md +22 -0
  26. data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
  27. data/docs/SfvbCommsSettings.md +34 -0
  28. data/docs/SfvbCommsSettingsResponse.md +24 -0
  29. data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
  30. data/docs/SfvbCommsStat.md +54 -0
  31. data/docs/SfvbCommsStepStat.md +34 -0
  32. data/docs/SfvbCommsTemplate.md +30 -0
  33. data/docs/SfvbCommsTemplateResponse.md +24 -0
  34. data/docs/SfvbCommsTemplatesResponse.md +20 -0
  35. data/docs/SfvbCommsTestEmailRequest.md +24 -0
  36. data/docs/SfvbCommsTestPostcardRequest.md +36 -0
  37. data/docs/SfvbCommsTestSendResponse.md +32 -0
  38. data/docs/SfvbCommsTestSmsRequest.md +18 -0
  39. data/docs/SfvbFlow.md +2 -0
  40. data/docs/SfvbPostcardAddress.md +28 -0
  41. data/docs/SfvbPostcardCard.md +40 -0
  42. data/docs/SfvbPostcardTrackingResponse.md +34 -0
  43. data/docs/SfvbTransactionalChange.md +24 -0
  44. data/docs/SfvbTransactionalDeliveryOption.md +22 -0
  45. data/docs/SfvbTransactionalEmailDetail.md +30 -0
  46. data/docs/SfvbTransactionalEmailResponse.md +24 -0
  47. data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
  48. data/docs/SfvbTransactionalSender.md +24 -0
  49. data/lib/ultracart_api/api/sfvb_api.rb +1553 -183
  50. data/lib/ultracart_api/models/item_auto_order.rb +1 -1
  51. data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
  52. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +42 -6
  53. data/lib/ultracart_api/models/sfvb_campaign.rb +11 -1
  54. data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
  55. data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
  56. data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
  57. data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
  58. data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
  59. data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
  60. data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
  61. data/lib/ultracart_api/models/sfvb_comms_member.rb +240 -0
  62. data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
  63. data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
  64. data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
  65. data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
  66. data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
  67. data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
  68. data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
  69. data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
  70. data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
  71. data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
  72. data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
  73. data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
  74. data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
  75. data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
  76. data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
  77. data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
  78. data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
  79. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +251 -0
  80. data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
  81. data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
  82. data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
  83. data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
  84. data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
  85. data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
  86. data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
  87. data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
  88. data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
  89. data/lib/ultracart_api/models/sfvb_transactional_change.rb +250 -0
  90. data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
  91. data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
  92. data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
  93. data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
  94. data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
  95. data/lib/ultracart_api/version.rb +1 -1
  96. data/lib/ultracart_api.rb +40 -0
  97. metadata +81 -1
data/docs/SfvbApi.md CHANGED
@@ -70,12 +70,22 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
70
70
  | [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
71
71
  | [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
72
72
  | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
73
+ | [**get_sfvb_comms_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
+ | [**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 |
73
75
  | [**get_sfvb_comms_folder**](SfvbApi.md#get_sfvb_comms_folder) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Read one list and segment folder |
74
76
  | [**get_sfvb_comms_folders**](SfvbApi.md#get_sfvb_comms_folders) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders | List the list and segment folders |
75
77
  | [**get_sfvb_comms_list**](SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list |
78
+ | [**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 |
79
+ | [**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
+ | [**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 |
76
81
  | [**get_sfvb_comms_segment**](SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule |
82
+ | [**get_sfvb_comms_segment_members**](SfvbApi.md#get_sfvb_comms_segment_members) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members | Read one page of a segment's members |
77
83
  | [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
78
84
  | [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
85
+ | [**get_sfvb_comms_sequence_stats**](SfvbApi.md#get_sfvb_comms_sequence_stats) | **GET** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/stats | Read a flow's or campaign's counts, overall and step by step |
86
+ | [**get_sfvb_comms_settings**](SfvbApi.md#get_sfvb_comms_settings) | **GET** /sfvb/storefronts/{storefront_oid}/comms/settings | Read a storefront's communications settings |
87
+ | [**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
+ | [**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 |
79
89
  | [**get_sfvb_comms_twilio_account**](SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account |
80
90
  | [**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 |
81
91
  | [**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 |
@@ -110,6 +120,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
110
120
  | [**get_sfvb_page_blog_posts**](SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page |
111
121
  | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
112
122
  | [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
123
+ | [**get_sfvb_postcard_tracking**](SfvbApi.md#get_sfvb_postcard_tracking) | **GET** /sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking | Read one page of the cards mailed for a postcard |
113
124
  | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
114
125
  | [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
115
126
  | [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events |
@@ -135,6 +146,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
135
146
  | [**get_sfvb_tracking_provider**](SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider |
136
147
  | [**get_sfvb_tracking_providers**](SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers |
137
148
  | [**get_sfvb_tracking_settings**](SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings |
149
+ | [**get_sfvb_transactional_email**](SfvbApi.md#get_sfvb_transactional_email) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Read a transactional email's subject, delivery options and sender |
138
150
  | [**get_sfvb_transactional_emails**](SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends |
139
151
  | [**get_sfvb_upsell_offer**](SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer |
140
152
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
@@ -143,6 +155,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
143
155
  | [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
144
156
  | [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
145
157
  | [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
158
+ | [**import_sfvb_comms_provider_lists**](SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider |
146
159
  | [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
147
160
  | [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
148
161
  | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
@@ -227,6 +240,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
227
240
  | [**set_sfvb_library_screenshot**](SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot |
228
241
  | [**share_sfvb_library_entry**](SfvbApi.md#share_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares | Share a published library entry with a linked account |
229
242
  | [**start_sfvb_experiment**](SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment |
243
+ | [**test_sfvb_comms_email**](SfvbApi.md#test_sfvb_comms_email) | **POST** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_email | Send one test of an email step's email to a user on this account |
244
+ | [**test_sfvb_comms_postcard**](SfvbApi.md#test_sfvb_comms_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_postcard | Print and mail one real test postcard |
245
+ | [**test_sfvb_comms_sms**](SfvbApi.md#test_sfvb_comms_sms) | **POST** /sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_sms | Send one test of an SMS step to a user on this account |
230
246
  | [**unarchive_sfvb_upsell_path**](SfvbApi.md#unarchive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/unarchive | Unarchive an upsell path |
231
247
  | [**unfavorite_sfvb_library_entry**](SfvbApi.md#unfavorite_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Remove a library entry from favorites |
232
248
  | [**unignore_sfvb_not_found_entry**](SfvbApi.md#unignore_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Stop ignoring a 404 path |
@@ -239,6 +255,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
239
255
  | [**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 |
240
256
  | [**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 |
241
257
  | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
258
+ | [**update_sfvb_comms_settings**](SfvbApi.md#update_sfvb_comms_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/comms/settings | Change a storefront's communications settings |
242
259
  | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
243
260
  | [**update_sfvb_email**](SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text |
244
261
  | [**update_sfvb_flow**](SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow |
@@ -253,6 +270,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
253
270
  | [**update_sfvb_tracking_html**](SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot |
254
271
  | [**update_sfvb_tracking_privacy**](SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules |
255
272
  | [**update_sfvb_tracking_provider**](SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider |
273
+ | [**update_sfvb_transactional_email**](SfvbApi.md#update_sfvb_transactional_email) | **PUT** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name} | Change a transactional email's subject, delivery options or sender |
256
274
  | [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
257
275
  | [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
258
276
  | [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
@@ -3855,6 +3873,116 @@ end
3855
3873
  - **Accept**: application/json
3856
3874
 
3857
3875
 
3876
+ ## get_sfvb_comms_dashboard_stats
3877
+
3878
+ > <SfvbCommsDashboardResponse> get_sfvb_comms_dashboard_stats(storefront_oid, opts)
3879
+
3880
+ Read every flow's and campaign's counts over a window, with the account's daily sending
3881
+
3882
+ rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account's last 31 days of sending, whatever the window. Read only.
3883
+
3884
+
3885
+ ### Examples
3886
+
3887
+
3888
+ (No example for this operation).
3889
+
3890
+
3891
+ #### Using the get_sfvb_comms_dashboard_stats_with_http_info variant
3892
+
3893
+ This returns an Array which contains the response data, status code and headers.
3894
+
3895
+ > <Array(<SfvbCommsDashboardResponse>, Integer, Hash)> get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts)
3896
+
3897
+ ```ruby
3898
+ begin
3899
+ # Read every flow's and campaign's counts over a window, with the account's daily sending
3900
+ data, status_code, headers = api_instance.get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts)
3901
+ p status_code # => 2xx
3902
+ p headers # => { ... }
3903
+ p data # => <SfvbCommsDashboardResponse>
3904
+ rescue UltracartClient::ApiError => e
3905
+ puts "Error when calling SfvbApi->get_sfvb_comms_dashboard_stats_with_http_info: #{e}"
3906
+ end
3907
+ ```
3908
+
3909
+ ### Parameters
3910
+
3911
+ | Name | Type | Description | Notes |
3912
+ | ---- | ---- | ----------- | ----- |
3913
+ | **storefront_oid** | **Integer** | | |
3914
+ | **days** | **Integer** | The window for the rows, 1 to 365 days (default 30). | [optional] |
3915
+
3916
+ ### Return type
3917
+
3918
+ [**SfvbCommsDashboardResponse**](SfvbCommsDashboardResponse.md)
3919
+
3920
+ ### Authorization
3921
+
3922
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3923
+
3924
+ ### HTTP request headers
3925
+
3926
+ - **Content-Type**: Not defined
3927
+ - **Accept**: application/json
3928
+
3929
+
3930
+ ## get_sfvb_comms_email_clicks
3931
+
3932
+ > <SfvbCommsClicksResponse> get_sfvb_comms_email_clicks(storefront_oid, commseq_uuid, email_uuid, opts)
3933
+
3934
+ Read each link in one email and how often it was clicked
3935
+
3936
+ The email must be sent by an email or experiment step of this flow's or campaign's sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
3937
+
3938
+
3939
+ ### Examples
3940
+
3941
+
3942
+ (No example for this operation).
3943
+
3944
+
3945
+ #### Using the get_sfvb_comms_email_clicks_with_http_info variant
3946
+
3947
+ This returns an Array which contains the response data, status code and headers.
3948
+
3949
+ > <Array(<SfvbCommsClicksResponse>, Integer, Hash)> get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts)
3950
+
3951
+ ```ruby
3952
+ begin
3953
+ # Read each link in one email and how often it was clicked
3954
+ data, status_code, headers = api_instance.get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts)
3955
+ p status_code # => 2xx
3956
+ p headers # => { ... }
3957
+ p data # => <SfvbCommsClicksResponse>
3958
+ rescue UltracartClient::ApiError => e
3959
+ puts "Error when calling SfvbApi->get_sfvb_comms_email_clicks_with_http_info: #{e}"
3960
+ end
3961
+ ```
3962
+
3963
+ ### Parameters
3964
+
3965
+ | Name | Type | Description | Notes |
3966
+ | ---- | ---- | ----------- | ----- |
3967
+ | **storefront_oid** | **Integer** | | |
3968
+ | **commseq_uuid** | **String** | | |
3969
+ | **email_uuid** | **String** | | |
3970
+ | **days** | **Integer** | The window, 1 to 365 days (default 30). | [optional] |
3971
+
3972
+ ### Return type
3973
+
3974
+ [**SfvbCommsClicksResponse**](SfvbCommsClicksResponse.md)
3975
+
3976
+ ### Authorization
3977
+
3978
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3979
+
3980
+ ### HTTP request headers
3981
+
3982
+ - **Content-Type**: Not defined
3983
+ - **Accept**: application/json
3984
+
3985
+
3858
3986
  ## get_sfvb_comms_folder
3859
3987
 
3860
3988
  > <SfvbCommsFolderResponse> get_sfvb_comms_folder(storefront_oid, folder_uuid)
@@ -4016,6 +4144,169 @@ end
4016
4144
  - **Accept**: application/json
4017
4145
 
4018
4146
 
4147
+ ## get_sfvb_comms_list_members
4148
+
4149
+ > <SfvbCommsMembersResponse> get_sfvb_comms_list_members(storefront_oid, list_uuid, opts)
4150
+
4151
+ Read one page of a list's members
4152
+
4153
+ Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
4154
+
4155
+
4156
+ ### Examples
4157
+
4158
+
4159
+ (No example for this operation).
4160
+
4161
+
4162
+ #### Using the get_sfvb_comms_list_members_with_http_info variant
4163
+
4164
+ This returns an Array which contains the response data, status code and headers.
4165
+
4166
+ > <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
4167
+
4168
+ ```ruby
4169
+ begin
4170
+ # Read one page of a list's members
4171
+ data, status_code, headers = api_instance.get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
4172
+ p status_code # => 2xx
4173
+ p headers # => { ... }
4174
+ p data # => <SfvbCommsMembersResponse>
4175
+ rescue UltracartClient::ApiError => e
4176
+ puts "Error when calling SfvbApi->get_sfvb_comms_list_members_with_http_info: #{e}"
4177
+ end
4178
+ ```
4179
+
4180
+ ### Parameters
4181
+
4182
+ | Name | Type | Description | Notes |
4183
+ | ---- | ---- | ----------- | ----- |
4184
+ | **storefront_oid** | **Integer** | | |
4185
+ | **list_uuid** | **String** | | |
4186
+ | **page** | **Integer** | The page, from 1 | [optional] |
4187
+ | **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
4188
+ | **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
4189
+
4190
+ ### Return type
4191
+
4192
+ [**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
4193
+
4194
+ ### Authorization
4195
+
4196
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4197
+
4198
+ ### HTTP request headers
4199
+
4200
+ - **Content-Type**: Not defined
4201
+ - **Accept**: application/json
4202
+
4203
+
4204
+ ## get_sfvb_comms_plan
4205
+
4206
+ > <SfvbCommsPlanResponse> get_sfvb_comms_plan(storefront_oid)
4207
+
4208
+ Read the account's communications plan and sending health
4209
+
4210
+ The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
4211
+
4212
+
4213
+ ### Examples
4214
+
4215
+
4216
+ (No example for this operation).
4217
+
4218
+
4219
+ #### Using the get_sfvb_comms_plan_with_http_info variant
4220
+
4221
+ This returns an Array which contains the response data, status code and headers.
4222
+
4223
+ > <Array(<SfvbCommsPlanResponse>, Integer, Hash)> get_sfvb_comms_plan_with_http_info(storefront_oid)
4224
+
4225
+ ```ruby
4226
+ begin
4227
+ # Read the account's communications plan and sending health
4228
+ data, status_code, headers = api_instance.get_sfvb_comms_plan_with_http_info(storefront_oid)
4229
+ p status_code # => 2xx
4230
+ p headers # => { ... }
4231
+ p data # => <SfvbCommsPlanResponse>
4232
+ rescue UltracartClient::ApiError => e
4233
+ puts "Error when calling SfvbApi->get_sfvb_comms_plan_with_http_info: #{e}"
4234
+ end
4235
+ ```
4236
+
4237
+ ### Parameters
4238
+
4239
+ | Name | Type | Description | Notes |
4240
+ | ---- | ---- | ----------- | ----- |
4241
+ | **storefront_oid** | **Integer** | | |
4242
+
4243
+ ### Return type
4244
+
4245
+ [**SfvbCommsPlanResponse**](SfvbCommsPlanResponse.md)
4246
+
4247
+ ### Authorization
4248
+
4249
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4250
+
4251
+ ### HTTP request headers
4252
+
4253
+ - **Content-Type**: Not defined
4254
+ - **Accept**: application/json
4255
+
4256
+
4257
+ ## get_sfvb_comms_providers
4258
+
4259
+ > <SfvbCommsProvidersResponse> get_sfvb_comms_providers(storefront_oid)
4260
+
4261
+ List the email providers the account can import lists from
4262
+
4263
+ Each provider that can share list members, connected or not, with a connected one's lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
4264
+
4265
+
4266
+ ### Examples
4267
+
4268
+
4269
+ (No example for this operation).
4270
+
4271
+
4272
+ #### Using the get_sfvb_comms_providers_with_http_info variant
4273
+
4274
+ This returns an Array which contains the response data, status code and headers.
4275
+
4276
+ > <Array(<SfvbCommsProvidersResponse>, Integer, Hash)> get_sfvb_comms_providers_with_http_info(storefront_oid)
4277
+
4278
+ ```ruby
4279
+ begin
4280
+ # List the email providers the account can import lists from
4281
+ data, status_code, headers = api_instance.get_sfvb_comms_providers_with_http_info(storefront_oid)
4282
+ p status_code # => 2xx
4283
+ p headers # => { ... }
4284
+ p data # => <SfvbCommsProvidersResponse>
4285
+ rescue UltracartClient::ApiError => e
4286
+ puts "Error when calling SfvbApi->get_sfvb_comms_providers_with_http_info: #{e}"
4287
+ end
4288
+ ```
4289
+
4290
+ ### Parameters
4291
+
4292
+ | Name | Type | Description | Notes |
4293
+ | ---- | ---- | ----------- | ----- |
4294
+ | **storefront_oid** | **Integer** | | |
4295
+
4296
+ ### Return type
4297
+
4298
+ [**SfvbCommsProvidersResponse**](SfvbCommsProvidersResponse.md)
4299
+
4300
+ ### Authorization
4301
+
4302
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4303
+
4304
+ ### HTTP request headers
4305
+
4306
+ - **Content-Type**: Not defined
4307
+ - **Accept**: application/json
4308
+
4309
+
4019
4310
  ## get_sfvb_comms_segment
4020
4311
 
4021
4312
  > <SfvbCommsSegmentResponse> get_sfvb_comms_segment(storefront_oid, segment_uuid)
@@ -4070,6 +4361,63 @@ end
4070
4361
  - **Accept**: application/json
4071
4362
 
4072
4363
 
4364
+ ## get_sfvb_comms_segment_members
4365
+
4366
+ > <SfvbCommsMembersResponse> get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts)
4367
+
4368
+ Read one page of a segment's members
4369
+
4370
+ Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
4371
+
4372
+
4373
+ ### Examples
4374
+
4375
+
4376
+ (No example for this operation).
4377
+
4378
+
4379
+ #### Using the get_sfvb_comms_segment_members_with_http_info variant
4380
+
4381
+ This returns an Array which contains the response data, status code and headers.
4382
+
4383
+ > <Array(<SfvbCommsMembersResponse>, Integer, Hash)> get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
4384
+
4385
+ ```ruby
4386
+ begin
4387
+ # Read one page of a segment's members
4388
+ data, status_code, headers = api_instance.get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
4389
+ p status_code # => 2xx
4390
+ p headers # => { ... }
4391
+ p data # => <SfvbCommsMembersResponse>
4392
+ rescue UltracartClient::ApiError => e
4393
+ puts "Error when calling SfvbApi->get_sfvb_comms_segment_members_with_http_info: #{e}"
4394
+ end
4395
+ ```
4396
+
4397
+ ### Parameters
4398
+
4399
+ | Name | Type | Description | Notes |
4400
+ | ---- | ---- | ----------- | ----- |
4401
+ | **storefront_oid** | **Integer** | | |
4402
+ | **segment_uuid** | **String** | | |
4403
+ | **page** | **Integer** | The page, from 1 | [optional] |
4404
+ | **page_size** | **Integer** | Members per page, 1 to 100 (default 50) | [optional] |
4405
+ | **show_customer_data** | **Boolean** | True to return the real email addresses instead of masked ones | [optional] |
4406
+
4407
+ ### Return type
4408
+
4409
+ [**SfvbCommsMembersResponse**](SfvbCommsMembersResponse.md)
4410
+
4411
+ ### Authorization
4412
+
4413
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4414
+
4415
+ ### HTTP request headers
4416
+
4417
+ - **Content-Type**: Not defined
4418
+ - **Accept**: application/json
4419
+
4420
+
4073
4421
  ## get_sfvb_comms_sending_domain
4074
4422
 
4075
4423
  > <SfvbCommsSendingDomain> get_sfvb_comms_sending_domain(domain)
@@ -4174,6 +4522,221 @@ This endpoint does not need any parameter.
4174
4522
  - **Accept**: application/json
4175
4523
 
4176
4524
 
4525
+ ## get_sfvb_comms_sequence_stats
4526
+
4527
+ > <SfvbCommsSequenceStatsResponse> get_sfvb_comms_sequence_stats(storefront_oid, commseq_uuid, opts)
4528
+
4529
+ Read a flow's or campaign's counts, overall and step by step
4530
+
4531
+ overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
4532
+
4533
+
4534
+ ### Examples
4535
+
4536
+
4537
+ (No example for this operation).
4538
+
4539
+
4540
+ #### Using the get_sfvb_comms_sequence_stats_with_http_info variant
4541
+
4542
+ This returns an Array which contains the response data, status code and headers.
4543
+
4544
+ > <Array(<SfvbCommsSequenceStatsResponse>, Integer, Hash)> get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts)
4545
+
4546
+ ```ruby
4547
+ begin
4548
+ # Read a flow's or campaign's counts, overall and step by step
4549
+ data, status_code, headers = api_instance.get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts)
4550
+ p status_code # => 2xx
4551
+ p headers # => { ... }
4552
+ p data # => <SfvbCommsSequenceStatsResponse>
4553
+ rescue UltracartClient::ApiError => e
4554
+ puts "Error when calling SfvbApi->get_sfvb_comms_sequence_stats_with_http_info: #{e}"
4555
+ end
4556
+ ```
4557
+
4558
+ ### Parameters
4559
+
4560
+ | Name | Type | Description | Notes |
4561
+ | ---- | ---- | ----------- | ----- |
4562
+ | **storefront_oid** | **Integer** | | |
4563
+ | **commseq_uuid** | **String** | | |
4564
+ | **days** | **Integer** | The window for the step counts, 1 to 365 days (default 30). | [optional] |
4565
+
4566
+ ### Return type
4567
+
4568
+ [**SfvbCommsSequenceStatsResponse**](SfvbCommsSequenceStatsResponse.md)
4569
+
4570
+ ### Authorization
4571
+
4572
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4573
+
4574
+ ### HTTP request headers
4575
+
4576
+ - **Content-Type**: Not defined
4577
+ - **Accept**: application/json
4578
+
4579
+
4580
+ ## get_sfvb_comms_settings
4581
+
4582
+ > <SfvbCommsSettingsResponse> get_sfvb_comms_settings(storefront_oid)
4583
+
4584
+ Read a storefront's communications settings
4585
+
4586
+ The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
4587
+
4588
+
4589
+ ### Examples
4590
+
4591
+
4592
+ (No example for this operation).
4593
+
4594
+
4595
+ #### Using the get_sfvb_comms_settings_with_http_info variant
4596
+
4597
+ This returns an Array which contains the response data, status code and headers.
4598
+
4599
+ > <Array(<SfvbCommsSettingsResponse>, Integer, Hash)> get_sfvb_comms_settings_with_http_info(storefront_oid)
4600
+
4601
+ ```ruby
4602
+ begin
4603
+ # Read a storefront's communications settings
4604
+ data, status_code, headers = api_instance.get_sfvb_comms_settings_with_http_info(storefront_oid)
4605
+ p status_code # => 2xx
4606
+ p headers # => { ... }
4607
+ p data # => <SfvbCommsSettingsResponse>
4608
+ rescue UltracartClient::ApiError => e
4609
+ puts "Error when calling SfvbApi->get_sfvb_comms_settings_with_http_info: #{e}"
4610
+ end
4611
+ ```
4612
+
4613
+ ### Parameters
4614
+
4615
+ | Name | Type | Description | Notes |
4616
+ | ---- | ---- | ----------- | ----- |
4617
+ | **storefront_oid** | **Integer** | | |
4618
+
4619
+ ### Return type
4620
+
4621
+ [**SfvbCommsSettingsResponse**](SfvbCommsSettingsResponse.md)
4622
+
4623
+ ### Authorization
4624
+
4625
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4626
+
4627
+ ### HTTP request headers
4628
+
4629
+ - **Content-Type**: Not defined
4630
+ - **Accept**: application/json
4631
+
4632
+
4633
+ ## get_sfvb_comms_template
4634
+
4635
+ > <SfvbCommsTemplateResponse> get_sfvb_comms_template(storefront_oid, email_template_oid)
4636
+
4637
+ Read one saved email template's body
4638
+
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 named in email_template_vm_path, not shown. Read only.
4640
+
4641
+
4642
+ ### Examples
4643
+
4644
+
4645
+ (No example for this operation).
4646
+
4647
+
4648
+ #### Using the get_sfvb_comms_template_with_http_info variant
4649
+
4650
+ This returns an Array which contains the response data, status code and headers.
4651
+
4652
+ > <Array(<SfvbCommsTemplateResponse>, Integer, Hash)> get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid)
4653
+
4654
+ ```ruby
4655
+ begin
4656
+ # Read one saved email template's body
4657
+ data, status_code, headers = api_instance.get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid)
4658
+ p status_code # => 2xx
4659
+ p headers # => { ... }
4660
+ p data # => <SfvbCommsTemplateResponse>
4661
+ rescue UltracartClient::ApiError => e
4662
+ puts "Error when calling SfvbApi->get_sfvb_comms_template_with_http_info: #{e}"
4663
+ end
4664
+ ```
4665
+
4666
+ ### Parameters
4667
+
4668
+ | Name | Type | Description | Notes |
4669
+ | ---- | ---- | ----------- | ----- |
4670
+ | **storefront_oid** | **Integer** | | |
4671
+ | **email_template_oid** | **Integer** | | |
4672
+
4673
+ ### Return type
4674
+
4675
+ [**SfvbCommsTemplateResponse**](SfvbCommsTemplateResponse.md)
4676
+
4677
+ ### Authorization
4678
+
4679
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4680
+
4681
+ ### HTTP request headers
4682
+
4683
+ - **Content-Type**: Not defined
4684
+ - **Accept**: application/json
4685
+
4686
+
4687
+ ## get_sfvb_comms_templates
4688
+
4689
+ > <SfvbCommsTemplatesResponse> get_sfvb_comms_templates(storefront_oid)
4690
+
4691
+ List the email templates a new email can start from
4692
+
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.
4694
+
4695
+
4696
+ ### Examples
4697
+
4698
+
4699
+ (No example for this operation).
4700
+
4701
+
4702
+ #### Using the get_sfvb_comms_templates_with_http_info variant
4703
+
4704
+ This returns an Array which contains the response data, status code and headers.
4705
+
4706
+ > <Array(<SfvbCommsTemplatesResponse>, Integer, Hash)> get_sfvb_comms_templates_with_http_info(storefront_oid)
4707
+
4708
+ ```ruby
4709
+ begin
4710
+ # List the email templates a new email can start from
4711
+ data, status_code, headers = api_instance.get_sfvb_comms_templates_with_http_info(storefront_oid)
4712
+ p status_code # => 2xx
4713
+ p headers # => { ... }
4714
+ p data # => <SfvbCommsTemplatesResponse>
4715
+ rescue UltracartClient::ApiError => e
4716
+ puts "Error when calling SfvbApi->get_sfvb_comms_templates_with_http_info: #{e}"
4717
+ end
4718
+ ```
4719
+
4720
+ ### Parameters
4721
+
4722
+ | Name | Type | Description | Notes |
4723
+ | ---- | ---- | ----------- | ----- |
4724
+ | **storefront_oid** | **Integer** | | |
4725
+
4726
+ ### Return type
4727
+
4728
+ [**SfvbCommsTemplatesResponse**](SfvbCommsTemplatesResponse.md)
4729
+
4730
+ ### Authorization
4731
+
4732
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4733
+
4734
+ ### HTTP request headers
4735
+
4736
+ - **Content-Type**: Not defined
4737
+ - **Accept**: application/json
4738
+
4739
+
4177
4740
  ## get_sfvb_comms_twilio_account
4178
4741
 
4179
4742
  > <SfvbCommsTwilioAccountResponse> get_sfvb_comms_twilio_account
@@ -6020,6 +6583,63 @@ end
6020
6583
  - **Accept**: application/json
6021
6584
 
6022
6585
 
6586
+ ## get_sfvb_postcard_tracking
6587
+
6588
+ > <SfvbPostcardTrackingResponse> get_sfvb_postcard_tracking(storefront_oid, postcard_uuid, opts)
6589
+
6590
+ Read one page of the cards mailed for a postcard
6591
+
6592
+ Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
6593
+
6594
+
6595
+ ### Examples
6596
+
6597
+
6598
+ (No example for this operation).
6599
+
6600
+
6601
+ #### Using the get_sfvb_postcard_tracking_with_http_info variant
6602
+
6603
+ This returns an Array which contains the response data, status code and headers.
6604
+
6605
+ > <Array(<SfvbPostcardTrackingResponse>, Integer, Hash)> get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
6606
+
6607
+ ```ruby
6608
+ begin
6609
+ # Read one page of the cards mailed for a postcard
6610
+ data, status_code, headers = api_instance.get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
6611
+ p status_code # => 2xx
6612
+ p headers # => { ... }
6613
+ p data # => <SfvbPostcardTrackingResponse>
6614
+ rescue UltracartClient::ApiError => e
6615
+ puts "Error when calling SfvbApi->get_sfvb_postcard_tracking_with_http_info: #{e}"
6616
+ end
6617
+ ```
6618
+
6619
+ ### Parameters
6620
+
6621
+ | Name | Type | Description | Notes |
6622
+ | ---- | ---- | ----------- | ----- |
6623
+ | **storefront_oid** | **Integer** | | |
6624
+ | **postcard_uuid** | **String** | | |
6625
+ | **page** | **Integer** | The page, from 1 | [optional] |
6626
+ | **page_size** | **Integer** | Cards per page, 1 to 100 (default 50) | [optional] |
6627
+ | **show_customer_data** | **Boolean** | True to return the recipients&#39; real names and street addresses | [optional] |
6628
+
6629
+ ### Return type
6630
+
6631
+ [**SfvbPostcardTrackingResponse**](SfvbPostcardTrackingResponse.md)
6632
+
6633
+ ### Authorization
6634
+
6635
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6636
+
6637
+ ### HTTP request headers
6638
+
6639
+ - **Content-Type**: Not defined
6640
+ - **Accept**: application/json
6641
+
6642
+
6023
6643
  ## get_sfvb_preview_url
6024
6644
 
6025
6645
  > <SfvbPreviewUrlResponse> get_sfvb_preview_url(storefront_oid, preview_session_id, opts)
@@ -7366,6 +7986,60 @@ end
7366
7986
  - **Accept**: application/json
7367
7987
 
7368
7988
 
7989
+ ## get_sfvb_transactional_email
7990
+
7991
+ > <SfvbTransactionalEmailResponse> get_sfvb_transactional_email(storefront_oid, file_name)
7992
+
7993
+ Read a transactional email's subject, delivery options and sender
7994
+
7995
+ file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
7996
+
7997
+
7998
+ ### Examples
7999
+
8000
+
8001
+ (No example for this operation).
8002
+
8003
+
8004
+ #### Using the get_sfvb_transactional_email_with_http_info variant
8005
+
8006
+ This returns an Array which contains the response data, status code and headers.
8007
+
8008
+ > <Array(<SfvbTransactionalEmailResponse>, Integer, Hash)> get_sfvb_transactional_email_with_http_info(storefront_oid, file_name)
8009
+
8010
+ ```ruby
8011
+ begin
8012
+ # Read a transactional email's subject, delivery options and sender
8013
+ data, status_code, headers = api_instance.get_sfvb_transactional_email_with_http_info(storefront_oid, file_name)
8014
+ p status_code # => 2xx
8015
+ p headers # => { ... }
8016
+ p data # => <SfvbTransactionalEmailResponse>
8017
+ rescue UltracartClient::ApiError => e
8018
+ puts "Error when calling SfvbApi->get_sfvb_transactional_email_with_http_info: #{e}"
8019
+ end
8020
+ ```
8021
+
8022
+ ### Parameters
8023
+
8024
+ | Name | Type | Description | Notes |
8025
+ | ---- | ---- | ----------- | ----- |
8026
+ | **storefront_oid** | **Integer** | | |
8027
+ | **file_name** | **String** | | |
8028
+
8029
+ ### Return type
8030
+
8031
+ [**SfvbTransactionalEmailResponse**](SfvbTransactionalEmailResponse.md)
8032
+
8033
+ ### Authorization
8034
+
8035
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8036
+
8037
+ ### HTTP request headers
8038
+
8039
+ - **Content-Type**: Not defined
8040
+ - **Accept**: application/json
8041
+
8042
+
7369
8043
  ## get_sfvb_transactional_emails
7370
8044
 
7371
8045
  > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
@@ -7799,6 +8473,61 @@ end
7799
8473
  - **Accept**: application/json
7800
8474
 
7801
8475
 
8476
+ ## import_sfvb_comms_provider_lists
8477
+
8478
+ > <SfvbCommsProviderImportResponse> import_sfvb_comms_provider_lists(storefront_oid, provider_import_request, opts)
8479
+
8480
+ Import lists from another email provider
8481
+
8482
+ Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
8483
+
8484
+
8485
+ ### Examples
8486
+
8487
+
8488
+ (No example for this operation).
8489
+
8490
+
8491
+ #### Using the import_sfvb_comms_provider_lists_with_http_info variant
8492
+
8493
+ This returns an Array which contains the response data, status code and headers.
8494
+
8495
+ > <Array(<SfvbCommsProviderImportResponse>, Integer, Hash)> import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts)
8496
+
8497
+ ```ruby
8498
+ begin
8499
+ # Import lists from another email provider
8500
+ data, status_code, headers = api_instance.import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts)
8501
+ p status_code # => 2xx
8502
+ p headers # => { ... }
8503
+ p data # => <SfvbCommsProviderImportResponse>
8504
+ rescue UltracartClient::ApiError => e
8505
+ puts "Error when calling SfvbApi->import_sfvb_comms_provider_lists_with_http_info: #{e}"
8506
+ end
8507
+ ```
8508
+
8509
+ ### Parameters
8510
+
8511
+ | Name | Type | Description | Notes |
8512
+ | ---- | ---- | ----------- | ----- |
8513
+ | **storefront_oid** | **Integer** | | |
8514
+ | **provider_import_request** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) | The provider and lists to import | |
8515
+ | **approval_id** | **String** | The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals. | [optional] |
8516
+
8517
+ ### Return type
8518
+
8519
+ [**SfvbCommsProviderImportResponse**](SfvbCommsProviderImportResponse.md)
8520
+
8521
+ ### Authorization
8522
+
8523
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8524
+
8525
+ ### HTTP request headers
8526
+
8527
+ - **Content-Type**: application/json
8528
+ - **Accept**: application/json
8529
+
8530
+
7802
8531
  ## import_sfvb_redirects
7803
8532
 
7804
8533
  > <SfvbRedirectImportResponse> import_sfvb_redirects(storefront_oid, redirect_import_request)
@@ -12430,6 +13159,175 @@ end
12430
13159
  - **Accept**: application/json
12431
13160
 
12432
13161
 
13162
+ ## test_sfvb_comms_email
13163
+
13164
+ > <SfvbCommsTestSendResponse> test_sfvb_comms_email(storefront_oid, commseq_uuid, step_uuid, test_email_request)
13165
+
13166
+ Send one test of an email step's email to a user on this account
13167
+
13168
+ to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan's email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
13169
+
13170
+
13171
+ ### Examples
13172
+
13173
+
13174
+ (No example for this operation).
13175
+
13176
+
13177
+ #### Using the test_sfvb_comms_email_with_http_info variant
13178
+
13179
+ This returns an Array which contains the response data, status code and headers.
13180
+
13181
+ > <Array(<SfvbCommsTestSendResponse>, Integer, Hash)> test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request)
13182
+
13183
+ ```ruby
13184
+ begin
13185
+ # Send one test of an email step's email to a user on this account
13186
+ data, status_code, headers = api_instance.test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request)
13187
+ p status_code # => 2xx
13188
+ p headers # => { ... }
13189
+ p data # => <SfvbCommsTestSendResponse>
13190
+ rescue UltracartClient::ApiError => e
13191
+ puts "Error when calling SfvbApi->test_sfvb_comms_email_with_http_info: #{e}"
13192
+ end
13193
+ ```
13194
+
13195
+ ### Parameters
13196
+
13197
+ | Name | Type | Description | Notes |
13198
+ | ---- | ---- | ----------- | ----- |
13199
+ | **storefront_oid** | **Integer** | | |
13200
+ | **commseq_uuid** | **String** | | |
13201
+ | **step_uuid** | **String** | | |
13202
+ | **test_email_request** | [**SfvbCommsTestEmailRequest**](SfvbCommsTestEmailRequest.md) | The email and the recipient | |
13203
+
13204
+ ### Return type
13205
+
13206
+ [**SfvbCommsTestSendResponse**](SfvbCommsTestSendResponse.md)
13207
+
13208
+ ### Authorization
13209
+
13210
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
13211
+
13212
+ ### HTTP request headers
13213
+
13214
+ - **Content-Type**: application/json
13215
+ - **Accept**: application/json
13216
+
13217
+
13218
+ ## test_sfvb_comms_postcard
13219
+
13220
+ > <SfvbCommsTestSendResponse> test_sfvb_comms_postcard(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
13221
+
13222
+ Print and mail one real test postcard
13223
+
13224
+ It is printed and mailed at the account's cost and can't be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
13225
+
13226
+
13227
+ ### Examples
13228
+
13229
+
13230
+ (No example for this operation).
13231
+
13232
+
13233
+ #### Using the test_sfvb_comms_postcard_with_http_info variant
13234
+
13235
+ This returns an Array which contains the response data, status code and headers.
13236
+
13237
+ > <Array(<SfvbCommsTestSendResponse>, Integer, Hash)> test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
13238
+
13239
+ ```ruby
13240
+ begin
13241
+ # Print and mail one real test postcard
13242
+ data, status_code, headers = api_instance.test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
13243
+ p status_code # => 2xx
13244
+ p headers # => { ... }
13245
+ p data # => <SfvbCommsTestSendResponse>
13246
+ rescue UltracartClient::ApiError => e
13247
+ puts "Error when calling SfvbApi->test_sfvb_comms_postcard_with_http_info: #{e}"
13248
+ end
13249
+ ```
13250
+
13251
+ ### Parameters
13252
+
13253
+ | Name | Type | Description | Notes |
13254
+ | ---- | ---- | ----------- | ----- |
13255
+ | **storefront_oid** | **Integer** | | |
13256
+ | **commseq_uuid** | **String** | | |
13257
+ | **step_uuid** | **String** | | |
13258
+ | **test_postcard_request** | [**SfvbCommsTestPostcardRequest**](SfvbCommsTestPostcardRequest.md) | The address and mail_card | |
13259
+ | **approval_id** | **String** | The approval_id of an approved postcard.test_mail request for exactly this card and address. See POST /sfvb/approvals. | [optional] |
13260
+
13261
+ ### Return type
13262
+
13263
+ [**SfvbCommsTestSendResponse**](SfvbCommsTestSendResponse.md)
13264
+
13265
+ ### Authorization
13266
+
13267
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
13268
+
13269
+ ### HTTP request headers
13270
+
13271
+ - **Content-Type**: application/json
13272
+ - **Accept**: application/json
13273
+
13274
+
13275
+ ## test_sfvb_comms_sms
13276
+
13277
+ > <SfvbCommsTestSendResponse> test_sfvb_comms_sms(storefront_oid, commseq_uuid, step_uuid, test_sms_request)
13278
+
13279
+ Send one test of an SMS step to a user on this account
13280
+
13281
+ to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account's Twilio account, from the flow's or campaign's SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
13282
+
13283
+
13284
+ ### Examples
13285
+
13286
+
13287
+ (No example for this operation).
13288
+
13289
+
13290
+ #### Using the test_sfvb_comms_sms_with_http_info variant
13291
+
13292
+ This returns an Array which contains the response data, status code and headers.
13293
+
13294
+ > <Array(<SfvbCommsTestSendResponse>, Integer, Hash)> test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request)
13295
+
13296
+ ```ruby
13297
+ begin
13298
+ # Send one test of an SMS step to a user on this account
13299
+ data, status_code, headers = api_instance.test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request)
13300
+ p status_code # => 2xx
13301
+ p headers # => { ... }
13302
+ p data # => <SfvbCommsTestSendResponse>
13303
+ rescue UltracartClient::ApiError => e
13304
+ puts "Error when calling SfvbApi->test_sfvb_comms_sms_with_http_info: #{e}"
13305
+ end
13306
+ ```
13307
+
13308
+ ### Parameters
13309
+
13310
+ | Name | Type | Description | Notes |
13311
+ | ---- | ---- | ----------- | ----- |
13312
+ | **storefront_oid** | **Integer** | | |
13313
+ | **commseq_uuid** | **String** | | |
13314
+ | **step_uuid** | **String** | | |
13315
+ | **test_sms_request** | [**SfvbCommsTestSmsRequest**](SfvbCommsTestSmsRequest.md) | The recipient | |
13316
+
13317
+ ### Return type
13318
+
13319
+ [**SfvbCommsTestSendResponse**](SfvbCommsTestSendResponse.md)
13320
+
13321
+ ### Authorization
13322
+
13323
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
13324
+
13325
+ ### HTTP request headers
13326
+
13327
+ - **Content-Type**: application/json
13328
+ - **Accept**: application/json
13329
+
13330
+
12433
13331
  ## unarchive_sfvb_upsell_path
12434
13332
 
12435
13333
  > <SfvbUpsellPath> unarchive_sfvb_upsell_path(storefront_oid, upsell_path_oid)
@@ -13093,6 +13991,62 @@ end
13093
13991
  - **Accept**: application/json
13094
13992
 
13095
13993
 
13994
+ ## update_sfvb_comms_settings
13995
+
13996
+ > <SfvbCommsSettingsResponse> update_sfvb_comms_settings(storefront_oid, if_match, comms_settings_update_request, opts)
13997
+
13998
+ Change a storefront's communications settings
13999
+
14000
+ A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
14001
+
14002
+
14003
+ ### Examples
14004
+
14005
+
14006
+ (No example for this operation).
14007
+
14008
+
14009
+ #### Using the update_sfvb_comms_settings_with_http_info variant
14010
+
14011
+ This returns an Array which contains the response data, status code and headers.
14012
+
14013
+ > <Array(<SfvbCommsSettingsResponse>, Integer, Hash)> update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts)
14014
+
14015
+ ```ruby
14016
+ begin
14017
+ # Change a storefront's communications settings
14018
+ data, status_code, headers = api_instance.update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts)
14019
+ p status_code # => 2xx
14020
+ p headers # => { ... }
14021
+ p data # => <SfvbCommsSettingsResponse>
14022
+ rescue UltracartClient::ApiError => e
14023
+ puts "Error when calling SfvbApi->update_sfvb_comms_settings_with_http_info: #{e}"
14024
+ end
14025
+ ```
14026
+
14027
+ ### Parameters
14028
+
14029
+ | Name | Type | Description | Notes |
14030
+ | ---- | ---- | ----------- | ----- |
14031
+ | **storefront_oid** | **Integer** | | |
14032
+ | **if_match** | **String** | The settings&#39; hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
14033
+ | **comms_settings_update_request** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) | The settings to change | |
14034
+ | **approval_id** | **String** | The approval_id of an approved comms_settings.update request for exactly this change, when a sender or the SMS number changes. See POST /sfvb/approvals. | [optional] |
14035
+
14036
+ ### Return type
14037
+
14038
+ [**SfvbCommsSettingsResponse**](SfvbCommsSettingsResponse.md)
14039
+
14040
+ ### Authorization
14041
+
14042
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
14043
+
14044
+ ### HTTP request headers
14045
+
14046
+ - **Content-Type**: application/json
14047
+ - **Accept**: application/json
14048
+
14049
+
13096
14050
  ## update_sfvb_comms_twilio_account
13097
14051
 
13098
14052
  > <SfvbCommsTwilioAccountResponse> update_sfvb_comms_twilio_account(twilio_account)
@@ -13875,6 +14829,63 @@ end
13875
14829
  - **Accept**: application/json
13876
14830
 
13877
14831
 
14832
+ ## update_sfvb_transactional_email
14833
+
14834
+ > <SfvbTransactionalEmailResponse> update_sfvb_transactional_email(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14835
+
14836
+ Change a transactional email's subject, delivery options or sender
14837
+
14838
+ A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
14839
+
14840
+
14841
+ ### Examples
14842
+
14843
+
14844
+ (No example for this operation).
14845
+
14846
+
14847
+ #### Using the update_sfvb_transactional_email_with_http_info variant
14848
+
14849
+ This returns an Array which contains the response data, status code and headers.
14850
+
14851
+ > <Array(<SfvbTransactionalEmailResponse>, Integer, Hash)> update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14852
+
14853
+ ```ruby
14854
+ begin
14855
+ # Change a transactional email's subject, delivery options or sender
14856
+ data, status_code, headers = api_instance.update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
14857
+ p status_code # => 2xx
14858
+ p headers # => { ... }
14859
+ p data # => <SfvbTransactionalEmailResponse>
14860
+ rescue UltracartClient::ApiError => e
14861
+ puts "Error when calling SfvbApi->update_sfvb_transactional_email_with_http_info: #{e}"
14862
+ end
14863
+ ```
14864
+
14865
+ ### Parameters
14866
+
14867
+ | Name | Type | Description | Notes |
14868
+ | ---- | ---- | ----------- | ----- |
14869
+ | **storefront_oid** | **Integer** | | |
14870
+ | **file_name** | **String** | | |
14871
+ | **if_match** | **String** | The email&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
14872
+ | **transactional_email_update_request** | [**SfvbTransactionalEmailUpdateRequest**](SfvbTransactionalEmailUpdateRequest.md) | The fields to change | |
14873
+ | **approval_id** | **String** | The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals. | [optional] |
14874
+
14875
+ ### Return type
14876
+
14877
+ [**SfvbTransactionalEmailResponse**](SfvbTransactionalEmailResponse.md)
14878
+
14879
+ ### Authorization
14880
+
14881
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
14882
+
14883
+ ### HTTP request headers
14884
+
14885
+ - **Content-Type**: application/json
14886
+ - **Accept**: application/json
14887
+
14888
+
13878
14889
  ## update_sfvb_upsell_offer
13879
14890
 
13880
14891
  > <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)