ultracart_api 4.1.229 → 4.1.230

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 (31) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -2
  3. data/docs/ItemAutoOrder.md +6 -0
  4. data/docs/SfvbApi.md +557 -1
  5. data/docs/SfvbCommsFolder.md +28 -0
  6. data/docs/SfvbCommsFolderItem.md +22 -0
  7. data/docs/SfvbCommsFolderResponse.md +22 -0
  8. data/docs/SfvbCommsFolderWriteRequest.md +18 -0
  9. data/docs/SfvbCommsFoldersResponse.md +18 -0
  10. data/docs/SfvbCommsListDetail.md +34 -0
  11. data/docs/SfvbCommsListResponse.md +20 -0
  12. data/docs/SfvbCommsListWriteRequest.md +24 -0
  13. data/docs/SfvbFlowWriteRequest.md +2 -2
  14. data/docs/SfvbSequenceStep.md +1 -1
  15. data/docs/SfvbStepCounts.md +1 -1
  16. data/lib/ultracart_api/api/sfvb_api.rb +785 -24
  17. data/lib/ultracart_api/models/item_auto_order.rb +35 -1
  18. data/lib/ultracart_api/models/sfvb_comms_folder.rb +270 -0
  19. data/lib/ultracart_api/models/sfvb_comms_folder_item.rb +240 -0
  20. data/lib/ultracart_api/models/sfvb_comms_folder_response.rb +243 -0
  21. data/lib/ultracart_api/models/sfvb_comms_folder_write_request.rb +220 -0
  22. data/lib/ultracart_api/models/sfvb_comms_folders_response.rb +222 -0
  23. data/lib/ultracart_api/models/sfvb_comms_list_detail.rb +302 -0
  24. data/lib/ultracart_api/models/sfvb_comms_list_response.rb +231 -0
  25. data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb +250 -0
  26. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
  27. data/lib/ultracart_api/models/sfvb_sequence_step.rb +1 -1
  28. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  29. data/lib/ultracart_api/version.rb +1 -1
  30. data/lib/ultracart_api.rb +8 -0
  31. metadata +18 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5c79f38be76fcf243083adb78d107b515a55270bfaf6f373d65522824b06b1b0
4
- data.tar.gz: 5143d7f94b5201bc245f75645acf4df1145904cff2a36d5b34ea3898487b8e32
3
+ metadata.gz: 8f9e8c96d40d233f7b4de128adb8b7ad1dcb6fa3e759cf34386c5b5dca84f14f
4
+ data.tar.gz: 84aedc789f08af3d4b05854443ba583ac6735c261f1732c1c08aa778d32ae50d
5
5
  SHA512:
6
- metadata.gz: 58b8dcaebcad1cf5d564d13818963d056e14d6d253eaa6055c507c18e62d0374bc1cf73bbdbeb0ae42e52687a6268ce42a8407294d0e6a1cc6f7ffd627c43a7a
7
- data.tar.gz: b0992b1b4fead1f9eca93886e5bd9202848a3ee890bc83af2d6745825f2bbbc992187a570efbff1f927ee242b45ec86bba8b744647a8304fd21c27012dcba988
6
+ metadata.gz: a9148b9834b2edfe1461224ac073fad73ead2aa41292e502768f123c86a1927414273c1ff524553a584d9ab30d841ca52d842bc7322e538943d264ee6db4f540
7
+ data.tar.gz: d0bbeb2f7b483c0bcdbcbd54e676c4d3481fa455be87d683a170c0703e2b298c650fc59431c93af5f3ed117d5af8ab563969b252a1887067eb7436411967aef3
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.229
10
+ - Package version: 4.1.230
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.229'
19
+ gem 'ultracart_api', '4.1.230'
20
20
  ```
21
21
 
22
22
  install:
@@ -479,6 +479,8 @@ Class | Method | HTTP request | Description
479
479
  *UltracartClient::SfvbApi* | [**add_sfvb_page_blog_posts**](docs/SfvbApi.md#add_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/add | Assign blog posts to a page
480
480
  *UltracartClient::SfvbApi* | [**add_sfvb_page_items**](docs/SfvbApi.md#add_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/add | Assign items to a page
481
481
  *UltracartClient::SfvbApi* | [**archive_sfvb_campaign**](docs/SfvbApi.md#archive_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/archive | Archive or unarchive a campaign
482
+ *UltracartClient::SfvbApi* | [**archive_sfvb_comms_list**](docs/SfvbApi.md#archive_sfvb_comms_list) | **PUT** /sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/archive | Archive an email list
483
+ *UltracartClient::SfvbApi* | [**archive_sfvb_comms_segment**](docs/SfvbApi.md#archive_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/archive | Archive a segment
482
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
483
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
484
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
@@ -495,6 +497,7 @@ Class | Method | HTTP request | Description
495
497
  *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
496
498
  *UltracartClient::SfvbApi* | [**delete_sfvb_approval**](docs/SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request
497
499
  *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
500
+ *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
498
501
  *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
499
502
  *UltracartClient::SfvbApi* | [**delete_sfvb_comms_twilio_account**](docs/SfvbApi.md#delete_sfvb_comms_twilio_account) | **DELETE** /sfvb/comms/twilio_account | Remove the Twilio account
500
503
  *UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
@@ -539,6 +542,9 @@ Class | Method | HTTP request | Description
539
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
540
543
  *UltracartClient::SfvbApi* | [**get_sfvb_campaign**](docs/SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign
541
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_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
+ *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
+ *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
542
548
  *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
543
549
  *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
544
550
  *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
@@ -613,6 +619,8 @@ Class | Method | HTTP request | Description
613
619
  *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
614
620
  *UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
615
621
  *UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
622
+ *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
623
+ *UltracartClient::SfvbApi* | [**insert_sfvb_comms_list**](docs/SfvbApi.md#insert_sfvb_comms_list) | **POST** /sfvb/storefronts/{storefront_oid}/lists | Create an email list
616
624
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_segment**](docs/SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment
617
625
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_sending_domain**](docs/SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain
618
626
  *UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
@@ -699,6 +707,8 @@ Class | Method | HTTP request | Description
699
707
  *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
700
708
  *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
701
709
  *UltracartClient::SfvbApi* | [**update_sfvb_campaign**](docs/SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign
710
+ *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
711
+ *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
702
712
  *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
703
713
  *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
704
714
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
@@ -1972,7 +1982,15 @@ Class | Method | HTTP request | Description
1972
1982
  - [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
1973
1983
  - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
1974
1984
  - [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
1985
+ - [UltracartClient::SfvbCommsFolder](docs/SfvbCommsFolder.md)
1986
+ - [UltracartClient::SfvbCommsFolderItem](docs/SfvbCommsFolderItem.md)
1987
+ - [UltracartClient::SfvbCommsFolderResponse](docs/SfvbCommsFolderResponse.md)
1988
+ - [UltracartClient::SfvbCommsFolderWriteRequest](docs/SfvbCommsFolderWriteRequest.md)
1989
+ - [UltracartClient::SfvbCommsFoldersResponse](docs/SfvbCommsFoldersResponse.md)
1975
1990
  - [UltracartClient::SfvbCommsList](docs/SfvbCommsList.md)
1991
+ - [UltracartClient::SfvbCommsListDetail](docs/SfvbCommsListDetail.md)
1992
+ - [UltracartClient::SfvbCommsListResponse](docs/SfvbCommsListResponse.md)
1993
+ - [UltracartClient::SfvbCommsListWriteRequest](docs/SfvbCommsListWriteRequest.md)
1976
1994
  - [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
1977
1995
  - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
1978
1996
  - [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
@@ -2425,6 +2443,7 @@ Not every change is committed to every SDK.
2425
2443
 
2426
2444
  | Version | Date | Comments |
2427
2445
  | --: | :-: | --- |
2446
+ | 4.1.230 | 11/05/2026 | sfvb internal testing |
2428
2447
  | 4.1.229 | 11/04/2026 | sfvb internal testing |
2429
2448
  | 4.1.228 | 11/04/2026 | sfvb internal testing |
2430
2449
  | 4.1.227 | 11/04/2026 | sfvb internal testing |
data/docs/ItemAutoOrder.md CHANGED
@@ -14,6 +14,9 @@
14
14
  | **auto_order_cancel_minimum_rebill_count** | **Integer** | The minimum rebill count that must be billed in order to not be charged the cancellation item. | [optional] |
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
+ | **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. Omit to leave unchanged. | [optional] |
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] |
17
20
  | **auto_order_paused** | **Boolean** | True if the rebill processing of this item is paused | [optional] |
18
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] |
19
22
  | **auto_order_schedules** | **Array<String>** | The user selectable schedules that are available | [optional] |
@@ -43,6 +46,9 @@ instance = UltracartClient::ItemAutoOrder.new(
43
46
  auto_order_cancel_minimum_rebill_count: null,
44
47
  auto_order_cancel_minimum_rebill_value: null,
45
48
  auto_order_downgrade_items: null,
49
+ auto_order_myaccount_frequency_day_counts: null,
50
+ auto_order_myaccount_frequency_last_step_only: null,
51
+ auto_order_myaccount_frequency_schedules: null,
46
52
  auto_order_paused: null,
47
53
  auto_order_prohibit_expiring_cards: null,
48
54
  auto_order_schedules: null,