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.
- checksums.yaml +4 -4
- data/README.md +62 -2
- data/docs/ItemAutoOrder.md +1 -1
- data/docs/ItemContentMultimedia.md +2 -0
- data/docs/SfvbApi.md +1011 -0
- data/docs/SfvbApprovalCreateRequest.md +9 -1
- data/docs/SfvbCampaign.md +2 -0
- data/docs/SfvbCommsBranchStat.md +20 -0
- data/docs/SfvbCommsChange.md +22 -0
- data/docs/SfvbCommsClick.md +20 -0
- data/docs/SfvbCommsClicksResponse.md +26 -0
- data/docs/SfvbCommsDailyStat.md +30 -0
- data/docs/SfvbCommsDashboardResponse.md +24 -0
- data/docs/SfvbCommsDashboardRow.md +28 -0
- data/docs/SfvbCommsMember.md +22 -0
- data/docs/SfvbCommsMembersResponse.md +36 -0
- data/docs/SfvbCommsPlan.md +66 -0
- data/docs/SfvbCommsPlanResponse.md +20 -0
- data/docs/SfvbCommsProvider.md +28 -0
- data/docs/SfvbCommsProviderImportRequest.md +22 -0
- data/docs/SfvbCommsProviderImportResponse.md +26 -0
- data/docs/SfvbCommsProviderList.md +20 -0
- data/docs/SfvbCommsProvidersResponse.md +22 -0
- data/docs/SfvbCommsSender.md +24 -0
- data/docs/SfvbCommsSenderUpdate.md +22 -0
- data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
- data/docs/SfvbCommsSettings.md +34 -0
- data/docs/SfvbCommsSettingsResponse.md +24 -0
- data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
- data/docs/SfvbCommsStat.md +54 -0
- data/docs/SfvbCommsStepStat.md +34 -0
- data/docs/SfvbCommsTemplate.md +30 -0
- data/docs/SfvbCommsTemplateResponse.md +24 -0
- data/docs/SfvbCommsTemplatesResponse.md +20 -0
- data/docs/SfvbCommsTestEmailRequest.md +24 -0
- data/docs/SfvbCommsTestPostcardRequest.md +36 -0
- data/docs/SfvbCommsTestSendResponse.md +32 -0
- data/docs/SfvbCommsTestSmsRequest.md +18 -0
- data/docs/SfvbFlow.md +2 -0
- data/docs/SfvbPostcardAddress.md +28 -0
- data/docs/SfvbPostcardCard.md +40 -0
- data/docs/SfvbPostcardTrackingResponse.md +34 -0
- data/docs/SfvbTransactionalChange.md +24 -0
- data/docs/SfvbTransactionalDeliveryOption.md +22 -0
- data/docs/SfvbTransactionalEmailDetail.md +30 -0
- data/docs/SfvbTransactionalEmailResponse.md +24 -0
- data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
- data/docs/SfvbTransactionalSender.md +24 -0
- data/lib/ultracart_api/api/sfvb_api.rb +1553 -183
- data/lib/ultracart_api/models/item_auto_order.rb +1 -1
- data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +42 -6
- data/lib/ultracart_api/models/sfvb_campaign.rb +11 -1
- data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
- data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
- data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
- data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
- data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
- data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
- data/lib/ultracart_api/models/sfvb_comms_member.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
- data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
- data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
- data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
- data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
- data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
- data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
- data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
- data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
- data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
- data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
- data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
- data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
- data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
- data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
- data/lib/ultracart_api/models/sfvb_comms_template_response.rb +251 -0
- data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
- data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
- data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
- data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
- data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
- data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
- data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
- data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
- data/lib/ultracart_api/models/sfvb_transactional_change.rb +250 -0
- data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
- data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +40 -0
- metadata +81 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2d11aef8e706ecd32401780e5e90746e945efb85a68b66ec462c8bcf9a37976a
|
|
4
|
+
data.tar.gz: bc8b56289dd23007c753a5fc412099c8741c3f0b6e2d1b57117e1e4f7e7bddbf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bebf458933b14b023db9153acfece97346a3e18581a730abc334ccba681771408ced14a1f24d0e52c8ada2a558486c3ffb2613079716ebe295b76ffd725bed0b
|
|
7
|
+
data.tar.gz: 564fc94baf156c8083c193732f8de7aadcef657ed93d0111d31f015c80b1f5c95be6449fe80e837c52cb9d44ccb7dc973b37a822453936f4addd021ef4628909
|
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.
|
|
10
|
+
- Package version: 4.1.232
|
|
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.
|
|
19
|
+
gem 'ultracart_api', '4.1.232'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -542,12 +542,22 @@ Class | Method | HTTP request | Description
|
|
|
542
542
|
*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
543
|
*UltracartClient::SfvbApi* | [**get_sfvb_campaign**](docs/SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign
|
|
544
544
|
*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
|
|
545
|
+
*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
|
|
546
|
+
*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
|
|
545
547
|
*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
548
|
*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
549
|
*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
|
|
550
|
+
*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
|
|
551
|
+
*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
|
|
552
|
+
*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
|
|
548
553
|
*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
|
|
554
|
+
*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
|
|
549
555
|
*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
|
|
550
556
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
|
|
557
|
+
*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
|
|
558
|
+
*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
|
|
559
|
+
*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
|
|
560
|
+
*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
|
|
551
561
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_twilio_account**](docs/SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account
|
|
552
562
|
*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
|
|
553
563
|
*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
|
|
@@ -582,6 +592,7 @@ Class | Method | HTTP request | Description
|
|
|
582
592
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_blog_posts**](docs/SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page
|
|
583
593
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_items**](docs/SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page
|
|
584
594
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_selectors**](docs/SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors
|
|
595
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_postcard_tracking**](docs/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
|
|
585
596
|
*UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
|
|
586
597
|
*UltracartClient::SfvbApi* | [**get_sfvb_recording**](docs/SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording
|
|
587
598
|
*UltracartClient::SfvbApi* | [**get_sfvb_recording_page_view_events**](docs/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
|
|
@@ -607,6 +618,7 @@ Class | Method | HTTP request | Description
|
|
|
607
618
|
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_provider**](docs/SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider
|
|
608
619
|
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_providers**](docs/SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers
|
|
609
620
|
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_settings**](docs/SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings
|
|
621
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_transactional_email**](docs/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
|
|
610
622
|
*UltracartClient::SfvbApi* | [**get_sfvb_transactional_emails**](docs/SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends
|
|
611
623
|
*UltracartClient::SfvbApi* | [**get_sfvb_upsell_offer**](docs/SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer
|
|
612
624
|
*UltracartClient::SfvbApi* | [**get_sfvb_upsell_path**](docs/SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path
|
|
@@ -615,6 +627,7 @@ Class | Method | HTTP request | Description
|
|
|
615
627
|
*UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
|
|
616
628
|
*UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
|
|
617
629
|
*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
|
|
630
|
+
*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
|
|
618
631
|
*UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
|
|
619
632
|
*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
|
|
620
633
|
*UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
|
|
@@ -699,6 +712,9 @@ Class | Method | HTTP request | Description
|
|
|
699
712
|
*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
|
|
700
713
|
*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
|
|
701
714
|
*UltracartClient::SfvbApi* | [**start_sfvb_experiment**](docs/SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment
|
|
715
|
+
*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
|
|
716
|
+
*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
|
|
717
|
+
*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
|
|
702
718
|
*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
|
|
703
719
|
*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
|
|
704
720
|
*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,6 +727,7 @@ Class | Method | HTTP request | Description
|
|
|
711
727
|
*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
|
|
712
728
|
*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
|
|
713
729
|
*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
|
|
730
|
+
*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
|
|
714
731
|
*UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
|
|
715
732
|
*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
|
|
716
733
|
*UltracartClient::SfvbApi* | [**update_sfvb_flow**](docs/SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow
|
|
@@ -725,6 +742,7 @@ Class | Method | HTTP request | Description
|
|
|
725
742
|
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_html**](docs/SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot
|
|
726
743
|
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_privacy**](docs/SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules
|
|
727
744
|
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_provider**](docs/SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider
|
|
745
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_transactional_email**](docs/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
|
|
728
746
|
*UltracartClient::SfvbApi* | [**update_sfvb_upsell_offer**](docs/SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer
|
|
729
747
|
*UltracartClient::SfvbApi* | [**update_sfvb_upsell_path**](docs/SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path
|
|
730
748
|
*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
|
|
@@ -1980,6 +1998,13 @@ Class | Method | HTTP request | Description
|
|
|
1980
1998
|
- [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
|
|
1981
1999
|
- [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
|
|
1982
2000
|
- [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
|
|
2001
|
+
- [UltracartClient::SfvbCommsBranchStat](docs/SfvbCommsBranchStat.md)
|
|
2002
|
+
- [UltracartClient::SfvbCommsChange](docs/SfvbCommsChange.md)
|
|
2003
|
+
- [UltracartClient::SfvbCommsClick](docs/SfvbCommsClick.md)
|
|
2004
|
+
- [UltracartClient::SfvbCommsClicksResponse](docs/SfvbCommsClicksResponse.md)
|
|
2005
|
+
- [UltracartClient::SfvbCommsDailyStat](docs/SfvbCommsDailyStat.md)
|
|
2006
|
+
- [UltracartClient::SfvbCommsDashboardResponse](docs/SfvbCommsDashboardResponse.md)
|
|
2007
|
+
- [UltracartClient::SfvbCommsDashboardRow](docs/SfvbCommsDashboardRow.md)
|
|
1983
2008
|
- [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
|
|
1984
2009
|
- [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
|
|
1985
2010
|
- [UltracartClient::SfvbCommsFolder](docs/SfvbCommsFolder.md)
|
|
@@ -1992,15 +2017,39 @@ Class | Method | HTTP request | Description
|
|
|
1992
2017
|
- [UltracartClient::SfvbCommsListResponse](docs/SfvbCommsListResponse.md)
|
|
1993
2018
|
- [UltracartClient::SfvbCommsListWriteRequest](docs/SfvbCommsListWriteRequest.md)
|
|
1994
2019
|
- [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
|
|
2020
|
+
- [UltracartClient::SfvbCommsMember](docs/SfvbCommsMember.md)
|
|
2021
|
+
- [UltracartClient::SfvbCommsMembersResponse](docs/SfvbCommsMembersResponse.md)
|
|
2022
|
+
- [UltracartClient::SfvbCommsPlan](docs/SfvbCommsPlan.md)
|
|
2023
|
+
- [UltracartClient::SfvbCommsPlanResponse](docs/SfvbCommsPlanResponse.md)
|
|
1995
2024
|
- [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
|
|
2025
|
+
- [UltracartClient::SfvbCommsProvider](docs/SfvbCommsProvider.md)
|
|
2026
|
+
- [UltracartClient::SfvbCommsProviderImportRequest](docs/SfvbCommsProviderImportRequest.md)
|
|
2027
|
+
- [UltracartClient::SfvbCommsProviderImportResponse](docs/SfvbCommsProviderImportResponse.md)
|
|
2028
|
+
- [UltracartClient::SfvbCommsProviderList](docs/SfvbCommsProviderList.md)
|
|
2029
|
+
- [UltracartClient::SfvbCommsProvidersResponse](docs/SfvbCommsProvidersResponse.md)
|
|
1996
2030
|
- [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
|
|
1997
2031
|
- [UltracartClient::SfvbCommsSegmentDetail](docs/SfvbCommsSegmentDetail.md)
|
|
1998
2032
|
- [UltracartClient::SfvbCommsSegmentResponse](docs/SfvbCommsSegmentResponse.md)
|
|
1999
2033
|
- [UltracartClient::SfvbCommsSegmentUsedBy](docs/SfvbCommsSegmentUsedBy.md)
|
|
2000
2034
|
- [UltracartClient::SfvbCommsSegmentWriteRequest](docs/SfvbCommsSegmentWriteRequest.md)
|
|
2001
2035
|
- [UltracartClient::SfvbCommsSegmentsResponse](docs/SfvbCommsSegmentsResponse.md)
|
|
2036
|
+
- [UltracartClient::SfvbCommsSender](docs/SfvbCommsSender.md)
|
|
2037
|
+
- [UltracartClient::SfvbCommsSenderUpdate](docs/SfvbCommsSenderUpdate.md)
|
|
2002
2038
|
- [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
|
|
2003
2039
|
- [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
|
|
2040
|
+
- [UltracartClient::SfvbCommsSequenceStatsResponse](docs/SfvbCommsSequenceStatsResponse.md)
|
|
2041
|
+
- [UltracartClient::SfvbCommsSettings](docs/SfvbCommsSettings.md)
|
|
2042
|
+
- [UltracartClient::SfvbCommsSettingsResponse](docs/SfvbCommsSettingsResponse.md)
|
|
2043
|
+
- [UltracartClient::SfvbCommsSettingsUpdateRequest](docs/SfvbCommsSettingsUpdateRequest.md)
|
|
2044
|
+
- [UltracartClient::SfvbCommsStat](docs/SfvbCommsStat.md)
|
|
2045
|
+
- [UltracartClient::SfvbCommsStepStat](docs/SfvbCommsStepStat.md)
|
|
2046
|
+
- [UltracartClient::SfvbCommsTemplate](docs/SfvbCommsTemplate.md)
|
|
2047
|
+
- [UltracartClient::SfvbCommsTemplateResponse](docs/SfvbCommsTemplateResponse.md)
|
|
2048
|
+
- [UltracartClient::SfvbCommsTemplatesResponse](docs/SfvbCommsTemplatesResponse.md)
|
|
2049
|
+
- [UltracartClient::SfvbCommsTestEmailRequest](docs/SfvbCommsTestEmailRequest.md)
|
|
2050
|
+
- [UltracartClient::SfvbCommsTestPostcardRequest](docs/SfvbCommsTestPostcardRequest.md)
|
|
2051
|
+
- [UltracartClient::SfvbCommsTestSendResponse](docs/SfvbCommsTestSendResponse.md)
|
|
2052
|
+
- [UltracartClient::SfvbCommsTestSmsRequest](docs/SfvbCommsTestSmsRequest.md)
|
|
2004
2053
|
- [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
|
|
2005
2054
|
- [UltracartClient::SfvbCommsTwilioAccountResponse](docs/SfvbCommsTwilioAccountResponse.md)
|
|
2006
2055
|
- [UltracartClient::SfvbCompileRequest](docs/SfvbCompileRequest.md)
|
|
@@ -2140,8 +2189,11 @@ Class | Method | HTTP request | Description
|
|
|
2140
2189
|
- [UltracartClient::SfvbPageSelectors](docs/SfvbPageSelectors.md)
|
|
2141
2190
|
- [UltracartClient::SfvbPageSettingsRequest](docs/SfvbPageSettingsRequest.md)
|
|
2142
2191
|
- [UltracartClient::SfvbPageSummary](docs/SfvbPageSummary.md)
|
|
2192
|
+
- [UltracartClient::SfvbPostcardAddress](docs/SfvbPostcardAddress.md)
|
|
2193
|
+
- [UltracartClient::SfvbPostcardCard](docs/SfvbPostcardCard.md)
|
|
2143
2194
|
- [UltracartClient::SfvbPostcardProofRequest](docs/SfvbPostcardProofRequest.md)
|
|
2144
2195
|
- [UltracartClient::SfvbPostcardProofResponse](docs/SfvbPostcardProofResponse.md)
|
|
2196
|
+
- [UltracartClient::SfvbPostcardTrackingResponse](docs/SfvbPostcardTrackingResponse.md)
|
|
2145
2197
|
- [UltracartClient::SfvbPreviewAccessRequest](docs/SfvbPreviewAccessRequest.md)
|
|
2146
2198
|
- [UltracartClient::SfvbPreviewAccessResponse](docs/SfvbPreviewAccessResponse.md)
|
|
2147
2199
|
- [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
|
|
@@ -2250,8 +2302,14 @@ Class | Method | HTTP request | Description
|
|
|
2250
2302
|
- [UltracartClient::SfvbTrackingProvidersResponse](docs/SfvbTrackingProvidersResponse.md)
|
|
2251
2303
|
- [UltracartClient::SfvbTrackingSettingsResponse](docs/SfvbTrackingSettingsResponse.md)
|
|
2252
2304
|
- [UltracartClient::SfvbTrackingWholesaleTier](docs/SfvbTrackingWholesaleTier.md)
|
|
2305
|
+
- [UltracartClient::SfvbTransactionalChange](docs/SfvbTransactionalChange.md)
|
|
2306
|
+
- [UltracartClient::SfvbTransactionalDeliveryOption](docs/SfvbTransactionalDeliveryOption.md)
|
|
2253
2307
|
- [UltracartClient::SfvbTransactionalEmail](docs/SfvbTransactionalEmail.md)
|
|
2308
|
+
- [UltracartClient::SfvbTransactionalEmailDetail](docs/SfvbTransactionalEmailDetail.md)
|
|
2309
|
+
- [UltracartClient::SfvbTransactionalEmailResponse](docs/SfvbTransactionalEmailResponse.md)
|
|
2310
|
+
- [UltracartClient::SfvbTransactionalEmailUpdateRequest](docs/SfvbTransactionalEmailUpdateRequest.md)
|
|
2254
2311
|
- [UltracartClient::SfvbTransactionalEmailsResponse](docs/SfvbTransactionalEmailsResponse.md)
|
|
2312
|
+
- [UltracartClient::SfvbTransactionalSender](docs/SfvbTransactionalSender.md)
|
|
2255
2313
|
- [UltracartClient::SfvbUpsellItemLogic](docs/SfvbUpsellItemLogic.md)
|
|
2256
2314
|
- [UltracartClient::SfvbUpsellItemLogicItem](docs/SfvbUpsellItemLogicItem.md)
|
|
2257
2315
|
- [UltracartClient::SfvbUpsellOffer](docs/SfvbUpsellOffer.md)
|
|
@@ -2443,6 +2501,8 @@ Not every change is committed to every SDK.
|
|
|
2443
2501
|
|
|
2444
2502
|
| Version | Date | Comments |
|
|
2445
2503
|
| --: | :-: | --- |
|
|
2504
|
+
| 4.1.232 | 11/05/2026 | sfvb internal testing |
|
|
2505
|
+
| 4.1.231 | 11/05/2026 | sfvb internal testing |
|
|
2446
2506
|
| 4.1.230 | 11/05/2026 | sfvb internal testing |
|
|
2447
2507
|
| 4.1.229 | 11/04/2026 | sfvb internal testing |
|
|
2448
2508
|
| 4.1.228 | 11/04/2026 | sfvb internal testing |
|
data/docs/ItemAutoOrder.md
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
| **auto_order_cancel_minimum_rebill_value** | **Float** | The minimum rebill value that must be paid in order to not be charged the cancellation item. | [optional] |
|
|
16
16
|
| **auto_order_downgrade_items** | **Array<String>** | List of downgrade items presented to customer service representatives | [optional] |
|
|
17
17
|
| **auto_order_myaccount_frequency_day_counts** | **Array<Integer>** | Day counts (1 to 365, at most 20) a customer may switch this auto-enrolled item to from MyAccount, for example [30, 60, 90]. Requires the advanced auto order settings to be enabled on the account. Omit to leave unchanged; send an empty array to clear. | [optional] |
|
|
18
|
-
| **auto_order_myaccount_frequency_last_step_only** | **Boolean** | True if the MyAccount frequency change is only offered once the item is on its last auto order step.
|
|
18
|
+
| **auto_order_myaccount_frequency_last_step_only** | **Boolean** | True if the MyAccount frequency change is only offered once the item is on its last auto order step. If auto_order_myaccount_frequency_schedules or auto_order_myaccount_frequency_day_counts is sent without this property, it is set to false; if none of the three are sent, it is left unchanged. | [optional] |
|
|
19
19
|
| **auto_order_myaccount_frequency_schedules** | **Array<String>** | Standard schedules a customer may switch this auto-enrolled item to from MyAccount. Requires the advanced auto order settings to be enabled on the account. Omit to leave unchanged; send an empty array to clear. | [optional] |
|
|
20
20
|
| **auto_order_paused** | **Boolean** | True if the rebill processing of this item is paused | [optional] |
|
|
21
21
|
| **auto_order_prohibit_expiring_cards** | **Integer** | Minimum number of months before expiration for the card. Overrides the account level setting if higher. Set to zero to disable. | [optional] |
|
|
@@ -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,
|