ultracart_api 4.1.231 → 4.1.233

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +72 -2
  3. data/docs/ItemContentMultimedia.md +2 -0
  4. data/docs/SfvbApi.md +1660 -162
  5. data/docs/SfvbApprovalCreateRequest.md +8 -0
  6. data/docs/SfvbCampaign.md +4 -0
  7. data/docs/SfvbCampaignWriteRequest.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/SfvbCommsLookupOwner.md +26 -0
  16. data/docs/SfvbCommsLookupResponse.md +34 -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/SfvbCommsRulerValidateRequest.md +18 -0
  25. data/docs/SfvbCommsRulerValidateResponse.md +22 -0
  26. data/docs/SfvbCommsSender.md +24 -0
  27. data/docs/SfvbCommsSenderUpdate.md +22 -0
  28. data/docs/SfvbCommsSequenceFolder.md +28 -0
  29. data/docs/SfvbCommsSequenceFolderResponse.md +22 -0
  30. data/docs/SfvbCommsSequenceFoldersResponse.md +18 -0
  31. data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
  32. data/docs/SfvbCommsSettings.md +34 -0
  33. data/docs/SfvbCommsSettingsResponse.md +24 -0
  34. data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
  35. data/docs/SfvbCommsStat.md +54 -0
  36. data/docs/SfvbCommsStepStat.md +34 -0
  37. data/docs/SfvbCommsTemplate.md +30 -0
  38. data/docs/SfvbCommsTemplateResponse.md +30 -0
  39. data/docs/SfvbCommsTemplatesResponse.md +20 -0
  40. data/docs/SfvbCommsTestEmailRequest.md +24 -0
  41. data/docs/SfvbCommsTestPostcardRequest.md +36 -0
  42. data/docs/SfvbCommsTestSendResponse.md +32 -0
  43. data/docs/SfvbCommsTestSmsRequest.md +18 -0
  44. data/docs/SfvbCommsUnreferencedEmail.md +30 -0
  45. data/docs/SfvbCommsUnreferencedPostcard.md +24 -0
  46. data/docs/SfvbCommsUnreferencedResponse.md +32 -0
  47. data/docs/SfvbEmail.md +8 -0
  48. data/docs/SfvbFlow.md +4 -0
  49. data/docs/SfvbFlowBackfillRequest.md +24 -0
  50. data/docs/SfvbFlowBackfillResponse.md +38 -0
  51. data/docs/SfvbFlowWriteRequest.md +2 -0
  52. data/docs/SfvbStepCounts.md +1 -1
  53. data/lib/ultracart_api/api/sfvb_api.rb +2356 -348
  54. data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
  55. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +39 -3
  56. data/lib/ultracart_api/models/sfvb_campaign.rb +21 -1
  57. data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +11 -1
  58. data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
  59. data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
  60. data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
  61. data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
  62. data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
  63. data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
  64. data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
  65. data/lib/ultracart_api/models/sfvb_comms_lookup_owner.rb +260 -0
  66. data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb +301 -0
  67. data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
  68. data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
  69. data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
  70. data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
  71. data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
  72. data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
  73. data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
  74. data/lib/ultracart_api/models/sfvb_comms_ruler_validate_request.rb +220 -0
  75. data/lib/ultracart_api/models/sfvb_comms_ruler_validate_response.rb +242 -0
  76. data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
  77. data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
  78. data/lib/ultracart_api/models/sfvb_comms_sequence_folder.rb +270 -0
  79. data/lib/ultracart_api/models/sfvb_comms_sequence_folder_response.rb +243 -0
  80. data/lib/ultracart_api/models/sfvb_comms_sequence_folders_response.rb +222 -0
  81. data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
  82. data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
  83. data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
  84. data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
  85. data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
  86. data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
  87. data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
  88. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +281 -0
  89. data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
  90. data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
  91. data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
  92. data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
  93. data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
  94. data/lib/ultracart_api/models/sfvb_comms_unreferenced_email.rb +280 -0
  95. data/lib/ultracart_api/models/sfvb_comms_unreferenced_postcard.rb +250 -0
  96. data/lib/ultracart_api/models/sfvb_comms_unreferenced_response.rb +296 -0
  97. data/lib/ultracart_api/models/sfvb_email.rb +41 -1
  98. data/lib/ultracart_api/models/sfvb_flow.rb +21 -1
  99. data/lib/ultracart_api/models/sfvb_flow_backfill_request.rb +250 -0
  100. data/lib/ultracart_api/models/sfvb_flow_backfill_response.rb +322 -0
  101. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +11 -1
  102. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  103. data/lib/ultracart_api/version.rb +1 -1
  104. data/lib/ultracart_api.rb +41 -0
  105. metadata +84 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dcde7cba5dd0621691aa5391f6f7c46b5792172018f897da1898a6ee63735015
4
- data.tar.gz: 429ce3d4d320b966d2e9c9ee1d8c4d04d315725f114dc2c44b2be6836bead467
3
+ metadata.gz: dea0377c91abc70344fa313cb83d06d12cd477b6e33e24e1a2e085e3046025d8
4
+ data.tar.gz: 2b0c4b96fbd2ade73660101b6a1ce7ff17c4de207030cba15640218af07bffc6
5
5
  SHA512:
6
- metadata.gz: 4e9df0afbc6550dabf30a517188337cab264b610f5a511bb22d6bab935db4df2f8afb685f8a0e4677f366c5def6873a58aee80a43f90bae52714b0bd863e4822
7
- data.tar.gz: '06085c5c64588823122b2453d1676900455b0f3d2993cb92de7b50c1a3a036356172f3c696362ac8041f8b2ac19c6991fec4e4d4fa0bf84e140679a4c53a1229'
6
+ metadata.gz: eecaed9c534531fa3298b17b68f89a22804f97f17238841b8bd58615173627ce3fe09efa81350658a9fd344665f8850cfda5fb667ebd06b1f6441517c5a1c19b
7
+ data.tar.gz: 770c6bf348349aab6a379e8e05ffa488957474477997ff9aefeed7abf1a3a33fe45f171a3029183969c2540abcefd33ab1e39502ebcb02badbdc07c8f4bfc0b4
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.231
10
+ - Package version: 4.1.233
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.231'
19
+ gem 'ultracart_api', '4.1.233'
20
20
  ```
21
21
 
22
22
  install:
@@ -484,6 +484,7 @@ Class | Method | HTTP request | Description
484
484
  *UltracartClient::SfvbApi* | [**archive_sfvb_flow**](docs/SfvbApi.md#archive_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/archive | Archive or unarchive a flow
485
485
  *UltracartClient::SfvbApi* | [**archive_sfvb_upsell_path**](docs/SfvbApi.md#archive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/archive | Archive an upsell path
486
486
  *UltracartClient::SfvbApi* | [**attach_sfvb_blog_post_image**](docs/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
487
+ *UltracartClient::SfvbApi* | [**backfill_sfvb_comms_flow**](docs/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
487
488
  *UltracartClient::SfvbApi* | [**check_sfvb_redirect**](docs/SfvbApi.md#check_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/check | Check a redirect rule without creating it
488
489
  *UltracartClient::SfvbApi* | [**clear_sfvb_library_screenshot**](docs/SfvbApi.md#clear_sfvb_library_screenshot) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Remove a library entry's screenshot
489
490
  *UltracartClient::SfvbApi* | [**clone_sfvb_campaign**](docs/SfvbApi.md#clone_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/clone | Copy a campaign on the same storefront
@@ -497,6 +498,8 @@ Class | Method | HTTP request | Description
497
498
  *UltracartClient::SfvbApi* | [**delete_sfvb_affiliate_network**](docs/SfvbApi.md#delete_sfvb_affiliate_network) | **DELETE** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Delete an affiliate network
498
499
  *UltracartClient::SfvbApi* | [**delete_sfvb_approval**](docs/SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request
499
500
  *UltracartClient::SfvbApi* | [**delete_sfvb_blog_post**](docs/SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post
501
+ *UltracartClient::SfvbApi* | [**delete_sfvb_comms_campaign_folder**](docs/SfvbApi.md#delete_sfvb_comms_campaign_folder) | **DELETE** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Delete a campaign folder
502
+ *UltracartClient::SfvbApi* | [**delete_sfvb_comms_flow_folder**](docs/SfvbApi.md#delete_sfvb_comms_flow_folder) | **DELETE** /sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid} | Delete a flow folder
500
503
  *UltracartClient::SfvbApi* | [**delete_sfvb_comms_folder**](docs/SfvbApi.md#delete_sfvb_comms_folder) | **DELETE** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Delete a list and segment folder
501
504
  *UltracartClient::SfvbApi* | [**delete_sfvb_comms_sending_domain**](docs/SfvbApi.md#delete_sfvb_comms_sending_domain) | **DELETE** /sfvb/comms/sending_domains/{domain} | Remove a sending domain
502
505
  *UltracartClient::SfvbApi* | [**delete_sfvb_comms_twilio_account**](docs/SfvbApi.md#delete_sfvb_comms_twilio_account) | **DELETE** /sfvb/comms/twilio_account | Remove the Twilio account
@@ -542,15 +545,29 @@ Class | Method | HTTP request | Description
542
545
  *UltracartClient::SfvbApi* | [**get_sfvb_blog_post**](docs/SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post
543
546
  *UltracartClient::SfvbApi* | [**get_sfvb_campaign**](docs/SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign
544
547
  *UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
548
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_campaign_folder**](docs/SfvbApi.md#get_sfvb_comms_campaign_folder) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Read one campaign folder
549
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_campaign_folders**](docs/SfvbApi.md#get_sfvb_comms_campaign_folders) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders | List the campaign folders
550
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_dashboard_stats**](docs/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
551
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_email_clicks**](docs/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
552
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_flow_folder**](docs/SfvbApi.md#get_sfvb_comms_flow_folder) | **GET** /sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid} | Read one flow folder
553
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_flow_folders**](docs/SfvbApi.md#get_sfvb_comms_flow_folders) | **GET** /sfvb/storefronts/{storefront_oid}/flow_folders | List the flow folders
545
554
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_folder**](docs/SfvbApi.md#get_sfvb_comms_folder) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Read one list and segment folder
546
555
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_folders**](docs/SfvbApi.md#get_sfvb_comms_folders) | **GET** /sfvb/storefronts/{storefront_oid}/list_segment_folders | List the list and segment folders
547
556
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_list**](docs/SfvbApi.md#get_sfvb_comms_list) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Read one email list
548
557
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_list_members**](docs/SfvbApi.md#get_sfvb_comms_list_members) | **GET** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members | Read one page of a list's members
558
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_lookup**](docs/SfvbApi.md#get_sfvb_comms_lookup) | **GET** /sfvb/comms/lookup | Find which storefront a communications uuid lives on
559
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_plan**](docs/SfvbApi.md#get_sfvb_comms_plan) | **GET** /sfvb/storefronts/{storefront_oid}/comms/plan | Read the account's communications plan and sending health
560
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_providers**](docs/SfvbApi.md#get_sfvb_comms_providers) | **GET** /sfvb/storefronts/{storefront_oid}/comms/providers | List the email providers the account can import lists from
549
561
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_segment**](docs/SfvbApi.md#get_sfvb_comms_segment) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Read one segment, with its rule
550
562
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_segment_members**](docs/SfvbApi.md#get_sfvb_comms_segment_members) | **GET** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members | Read one page of a segment's members
551
563
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domain**](docs/SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain
552
564
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
565
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_sequence_stats**](docs/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
566
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_settings**](docs/SfvbApi.md#get_sfvb_comms_settings) | **GET** /sfvb/storefronts/{storefront_oid}/comms/settings | Read a storefront's communications settings
567
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_template**](docs/SfvbApi.md#get_sfvb_comms_template) | **GET** /sfvb/storefronts/{storefront_oid}/comms/templates/{email_template_oid} | Read one saved email template's body
568
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_templates**](docs/SfvbApi.md#get_sfvb_comms_templates) | **GET** /sfvb/storefronts/{storefront_oid}/comms/templates | List the email templates a new email can start from
553
569
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_twilio_account**](docs/SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account
570
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_unreferenced**](docs/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
554
571
  *UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
555
572
  *UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/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
556
573
  *UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type
@@ -619,10 +636,13 @@ Class | Method | HTTP request | Description
619
636
  *UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
620
637
  *UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
621
638
  *UltracartClient::SfvbApi* | [**ignore_sfvb_not_found_entry**](docs/SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path
639
+ *UltracartClient::SfvbApi* | [**import_sfvb_comms_provider_lists**](docs/SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider
622
640
  *UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
623
641
  *UltracartClient::SfvbApi* | [**insert_sfvb_affiliate_network**](docs/SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network
624
642
  *UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
625
643
  *UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
644
+ *UltracartClient::SfvbApi* | [**insert_sfvb_comms_campaign_folder**](docs/SfvbApi.md#insert_sfvb_comms_campaign_folder) | **POST** /sfvb/storefronts/{storefront_oid}/campaign_folders | Create a campaign folder
645
+ *UltracartClient::SfvbApi* | [**insert_sfvb_comms_flow_folder**](docs/SfvbApi.md#insert_sfvb_comms_flow_folder) | **POST** /sfvb/storefronts/{storefront_oid}/flow_folders | Create a flow folder
626
646
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_folder**](docs/SfvbApi.md#insert_sfvb_comms_folder) | **POST** /sfvb/storefronts/{storefront_oid}/list_segment_folders | Create a list and segment folder
627
647
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_list**](docs/SfvbApi.md#insert_sfvb_comms_list) | **POST** /sfvb/storefronts/{storefront_oid}/lists | Create an email list
628
648
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_segment**](docs/SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment
@@ -703,6 +723,9 @@ Class | Method | HTTP request | Description
703
723
  *UltracartClient::SfvbApi* | [**set_sfvb_library_screenshot**](docs/SfvbApi.md#set_sfvb_library_screenshot) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Set a library entry's screenshot
704
724
  *UltracartClient::SfvbApi* | [**share_sfvb_library_entry**](docs/SfvbApi.md#share_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares | Share a published library entry with a linked account
705
725
  *UltracartClient::SfvbApi* | [**start_sfvb_experiment**](docs/SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment
726
+ *UltracartClient::SfvbApi* | [**test_sfvb_comms_email**](docs/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
727
+ *UltracartClient::SfvbApi* | [**test_sfvb_comms_postcard**](docs/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
728
+ *UltracartClient::SfvbApi* | [**test_sfvb_comms_sms**](docs/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
706
729
  *UltracartClient::SfvbApi* | [**unarchive_sfvb_upsell_path**](docs/SfvbApi.md#unarchive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/unarchive | Unarchive an upsell path
707
730
  *UltracartClient::SfvbApi* | [**unfavorite_sfvb_library_entry**](docs/SfvbApi.md#unfavorite_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Remove a library entry from favorites
708
731
  *UltracartClient::SfvbApi* | [**unignore_sfvb_not_found_entry**](docs/SfvbApi.md#unignore_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Stop ignoring a 404 path
@@ -711,10 +734,13 @@ Class | Method | HTTP request | Description
711
734
  *UltracartClient::SfvbApi* | [**update_sfvb_affiliate_network**](docs/SfvbApi.md#update_sfvb_affiliate_network) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Change an affiliate network
712
735
  *UltracartClient::SfvbApi* | [**update_sfvb_blog_post**](docs/SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post
713
736
  *UltracartClient::SfvbApi* | [**update_sfvb_campaign**](docs/SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign
737
+ *UltracartClient::SfvbApi* | [**update_sfvb_comms_campaign_folder**](docs/SfvbApi.md#update_sfvb_comms_campaign_folder) | **PUT** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Rename a campaign folder
738
+ *UltracartClient::SfvbApi* | [**update_sfvb_comms_flow_folder**](docs/SfvbApi.md#update_sfvb_comms_flow_folder) | **PUT** /sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid} | Rename a flow folder
714
739
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_folder**](docs/SfvbApi.md#update_sfvb_comms_folder) | **PUT** /sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid} | Rename a list and segment folder
715
740
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_list**](docs/SfvbApi.md#update_sfvb_comms_list) | **PUT** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid} | Change an email list's name, folder or public settings
716
741
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_segment**](docs/SfvbApi.md#update_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Change a segment's name, rule or folder
717
742
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_sending_domain**](docs/SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain
743
+ *UltracartClient::SfvbApi* | [**update_sfvb_comms_settings**](docs/SfvbApi.md#update_sfvb_comms_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/comms/settings | Change a storefront's communications settings
718
744
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
719
745
  *UltracartClient::SfvbApi* | [**update_sfvb_email**](docs/SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text
720
746
  *UltracartClient::SfvbApi* | [**update_sfvb_flow**](docs/SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow
@@ -735,6 +761,7 @@ Class | Method | HTTP request | Description
735
761
  *UltracartClient::SfvbApi* | [**update_sfvb_utm_shortcode**](docs/SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode
736
762
  *UltracartClient::SfvbApi* | [**upload_sfvb_file**](docs/SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded
737
763
  *UltracartClient::SfvbApi* | [**validate_sfvb_cjson**](docs/SfvbApi.md#validate_sfvb_cjson) | **POST** /sfvb/cjson/validate | Validate CJSON
764
+ *UltracartClient::SfvbApi* | [**validate_sfvb_comms_ruler**](docs/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
738
765
  *UltracartClient::SfvbApi* | [**validate_sfvb_velocity**](docs/SfvbApi.md#validate_sfvb_velocity) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/velocity/validate | Validate a Velocity template against a theme
739
766
  *UltracartClient::SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
740
767
  *UltracartClient::SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
@@ -1985,6 +2012,13 @@ Class | Method | HTTP request | Description
1985
2012
  - [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
1986
2013
  - [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
1987
2014
  - [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
2015
+ - [UltracartClient::SfvbCommsBranchStat](docs/SfvbCommsBranchStat.md)
2016
+ - [UltracartClient::SfvbCommsChange](docs/SfvbCommsChange.md)
2017
+ - [UltracartClient::SfvbCommsClick](docs/SfvbCommsClick.md)
2018
+ - [UltracartClient::SfvbCommsClicksResponse](docs/SfvbCommsClicksResponse.md)
2019
+ - [UltracartClient::SfvbCommsDailyStat](docs/SfvbCommsDailyStat.md)
2020
+ - [UltracartClient::SfvbCommsDashboardResponse](docs/SfvbCommsDashboardResponse.md)
2021
+ - [UltracartClient::SfvbCommsDashboardRow](docs/SfvbCommsDashboardRow.md)
1988
2022
  - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
1989
2023
  - [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
1990
2024
  - [UltracartClient::SfvbCommsFolder](docs/SfvbCommsFolder.md)
@@ -1997,19 +2031,51 @@ Class | Method | HTTP request | Description
1997
2031
  - [UltracartClient::SfvbCommsListResponse](docs/SfvbCommsListResponse.md)
1998
2032
  - [UltracartClient::SfvbCommsListWriteRequest](docs/SfvbCommsListWriteRequest.md)
1999
2033
  - [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
2034
+ - [UltracartClient::SfvbCommsLookupOwner](docs/SfvbCommsLookupOwner.md)
2035
+ - [UltracartClient::SfvbCommsLookupResponse](docs/SfvbCommsLookupResponse.md)
2000
2036
  - [UltracartClient::SfvbCommsMember](docs/SfvbCommsMember.md)
2001
2037
  - [UltracartClient::SfvbCommsMembersResponse](docs/SfvbCommsMembersResponse.md)
2038
+ - [UltracartClient::SfvbCommsPlan](docs/SfvbCommsPlan.md)
2039
+ - [UltracartClient::SfvbCommsPlanResponse](docs/SfvbCommsPlanResponse.md)
2002
2040
  - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
2041
+ - [UltracartClient::SfvbCommsProvider](docs/SfvbCommsProvider.md)
2042
+ - [UltracartClient::SfvbCommsProviderImportRequest](docs/SfvbCommsProviderImportRequest.md)
2043
+ - [UltracartClient::SfvbCommsProviderImportResponse](docs/SfvbCommsProviderImportResponse.md)
2044
+ - [UltracartClient::SfvbCommsProviderList](docs/SfvbCommsProviderList.md)
2045
+ - [UltracartClient::SfvbCommsProvidersResponse](docs/SfvbCommsProvidersResponse.md)
2046
+ - [UltracartClient::SfvbCommsRulerValidateRequest](docs/SfvbCommsRulerValidateRequest.md)
2047
+ - [UltracartClient::SfvbCommsRulerValidateResponse](docs/SfvbCommsRulerValidateResponse.md)
2003
2048
  - [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
2004
2049
  - [UltracartClient::SfvbCommsSegmentDetail](docs/SfvbCommsSegmentDetail.md)
2005
2050
  - [UltracartClient::SfvbCommsSegmentResponse](docs/SfvbCommsSegmentResponse.md)
2006
2051
  - [UltracartClient::SfvbCommsSegmentUsedBy](docs/SfvbCommsSegmentUsedBy.md)
2007
2052
  - [UltracartClient::SfvbCommsSegmentWriteRequest](docs/SfvbCommsSegmentWriteRequest.md)
2008
2053
  - [UltracartClient::SfvbCommsSegmentsResponse](docs/SfvbCommsSegmentsResponse.md)
2054
+ - [UltracartClient::SfvbCommsSender](docs/SfvbCommsSender.md)
2055
+ - [UltracartClient::SfvbCommsSenderUpdate](docs/SfvbCommsSenderUpdate.md)
2009
2056
  - [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
2010
2057
  - [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
2058
+ - [UltracartClient::SfvbCommsSequenceFolder](docs/SfvbCommsSequenceFolder.md)
2059
+ - [UltracartClient::SfvbCommsSequenceFolderResponse](docs/SfvbCommsSequenceFolderResponse.md)
2060
+ - [UltracartClient::SfvbCommsSequenceFoldersResponse](docs/SfvbCommsSequenceFoldersResponse.md)
2061
+ - [UltracartClient::SfvbCommsSequenceStatsResponse](docs/SfvbCommsSequenceStatsResponse.md)
2062
+ - [UltracartClient::SfvbCommsSettings](docs/SfvbCommsSettings.md)
2063
+ - [UltracartClient::SfvbCommsSettingsResponse](docs/SfvbCommsSettingsResponse.md)
2064
+ - [UltracartClient::SfvbCommsSettingsUpdateRequest](docs/SfvbCommsSettingsUpdateRequest.md)
2065
+ - [UltracartClient::SfvbCommsStat](docs/SfvbCommsStat.md)
2066
+ - [UltracartClient::SfvbCommsStepStat](docs/SfvbCommsStepStat.md)
2067
+ - [UltracartClient::SfvbCommsTemplate](docs/SfvbCommsTemplate.md)
2068
+ - [UltracartClient::SfvbCommsTemplateResponse](docs/SfvbCommsTemplateResponse.md)
2069
+ - [UltracartClient::SfvbCommsTemplatesResponse](docs/SfvbCommsTemplatesResponse.md)
2070
+ - [UltracartClient::SfvbCommsTestEmailRequest](docs/SfvbCommsTestEmailRequest.md)
2071
+ - [UltracartClient::SfvbCommsTestPostcardRequest](docs/SfvbCommsTestPostcardRequest.md)
2072
+ - [UltracartClient::SfvbCommsTestSendResponse](docs/SfvbCommsTestSendResponse.md)
2073
+ - [UltracartClient::SfvbCommsTestSmsRequest](docs/SfvbCommsTestSmsRequest.md)
2011
2074
  - [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
2012
2075
  - [UltracartClient::SfvbCommsTwilioAccountResponse](docs/SfvbCommsTwilioAccountResponse.md)
2076
+ - [UltracartClient::SfvbCommsUnreferencedEmail](docs/SfvbCommsUnreferencedEmail.md)
2077
+ - [UltracartClient::SfvbCommsUnreferencedPostcard](docs/SfvbCommsUnreferencedPostcard.md)
2078
+ - [UltracartClient::SfvbCommsUnreferencedResponse](docs/SfvbCommsUnreferencedResponse.md)
2013
2079
  - [UltracartClient::SfvbCompileRequest](docs/SfvbCompileRequest.md)
2014
2080
  - [UltracartClient::SfvbCompileResponse](docs/SfvbCompileResponse.md)
2015
2081
  - [UltracartClient::SfvbContainerResponse](docs/SfvbContainerResponse.md)
@@ -2051,6 +2117,8 @@ Class | Method | HTTP request | Description
2051
2117
  - [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
2052
2118
  - [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
2053
2119
  - [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
2120
+ - [UltracartClient::SfvbFlowBackfillRequest](docs/SfvbFlowBackfillRequest.md)
2121
+ - [UltracartClient::SfvbFlowBackfillResponse](docs/SfvbFlowBackfillResponse.md)
2054
2122
  - [UltracartClient::SfvbFlowStatusRequest](docs/SfvbFlowStatusRequest.md)
2055
2123
  - [UltracartClient::SfvbFlowWriteRequest](docs/SfvbFlowWriteRequest.md)
2056
2124
  - [UltracartClient::SfvbFlowsResponse](docs/SfvbFlowsResponse.md)
@@ -2459,6 +2527,8 @@ Not every change is committed to every SDK.
2459
2527
 
2460
2528
  | Version | Date | Comments |
2461
2529
  | --: | :-: | --- |
2530
+ | 4.1.233 | 11/06/2026 | sfvb internal testing |
2531
+ | 4.1.232 | 11/05/2026 | sfvb internal testing |
2462
2532
  | 4.1.231 | 11/05/2026 | sfvb internal testing |
2463
2533
  | 4.1.230 | 11/05/2026 | sfvb internal testing |
2464
2534
  | 4.1.229 | 11/04/2026 | sfvb internal testing |
data/docs/ItemContentMultimedia.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **ai_alt_text** | **String** | AI generated alt text for the image. StoreFront uses this when description is empty. | [optional] |
7
8
  | **cloud_url** | **String** | URL where the image can be downloaded from the cloud | [optional] |
8
9
  | **cloud_url_expiration** | **String** | Expiration date of the cloud URL | [optional] |
9
10
  | **code** | **String** | Code assigned to the file | [optional] |
@@ -27,6 +28,7 @@
27
28
  require 'ultracart_api'
28
29
 
29
30
  instance = UltracartClient::ItemContentMultimedia.new(
31
+ ai_alt_text: null,
30
32
  cloud_url: null,
31
33
  cloud_url_expiration: null,
32
34
  code: null,