ultracart_api 4.1.207 → 4.1.209

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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -2
  3. data/docs/SfvbApi.md +773 -48
  4. data/docs/SfvbArchiveRequest.md +18 -0
  5. data/docs/SfvbCampaign.md +16 -0
  6. data/docs/SfvbCampaignMembership.md +24 -0
  7. data/docs/SfvbCampaignWriteRequest.md +32 -0
  8. data/docs/SfvbCommsEmail.md +6 -0
  9. data/docs/SfvbCommsList.md +24 -0
  10. data/docs/SfvbCommsListsResponse.md +18 -0
  11. data/docs/SfvbCommsSegment.md +26 -0
  12. data/docs/SfvbCommsSegmentsResponse.md +18 -0
  13. data/docs/SfvbEmail.md +40 -0
  14. data/docs/SfvbEmailUpdateRequest.md +20 -0
  15. data/docs/SfvbFlow.md +22 -0
  16. data/docs/SfvbFlowStatusRequest.md +18 -0
  17. data/docs/SfvbFlowWriteRequest.md +38 -0
  18. data/lib/ultracart_api/api/sfvb_api.rb +5346 -4330
  19. data/lib/ultracart_api/models/item_third_party_email_marketing.rb +2 -2
  20. data/lib/ultracart_api/models/sfvb_archive_request.rb +220 -0
  21. data/lib/ultracart_api/models/sfvb_campaign.rb +85 -1
  22. data/lib/ultracart_api/models/sfvb_campaign_membership.rb +250 -0
  23. data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +292 -0
  24. data/lib/ultracart_api/models/sfvb_comms_email.rb +31 -1
  25. data/lib/ultracart_api/models/sfvb_comms_list.rb +250 -0
  26. data/lib/ultracart_api/models/sfvb_comms_lists_response.rb +222 -0
  27. data/lib/ultracart_api/models/sfvb_comms_segment.rb +260 -0
  28. data/lib/ultracart_api/models/sfvb_comms_segments_response.rb +222 -0
  29. data/lib/ultracart_api/models/sfvb_email.rb +330 -0
  30. data/lib/ultracart_api/models/sfvb_email_update_request.rb +230 -0
  31. data/lib/ultracart_api/models/sfvb_flow.rb +113 -1
  32. data/lib/ultracart_api/models/sfvb_flow_status_request.rb +254 -0
  33. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +354 -0
  34. data/lib/ultracart_api/version.rb +1 -1
  35. data/lib/ultracart_api.rb +11 -0
  36. metadata +24 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6744f4e0dacef9815b35ba7d361ad6c3a004b2082087fe5dd2bf8a9080a39b7b
4
- data.tar.gz: 736cbe24406af15bbc288eb879458f7164de9bbf7be7eb91f03d3cc033636ceb
3
+ metadata.gz: e0c962b8931e0142a262e884bb6d133b3d99a87b303518b9dae0ca640a41819b
4
+ data.tar.gz: 2ae7fa35c9b3393aa512a70866239cc71481b84a86f28a5d4ef470be04cb349f
5
5
  SHA512:
6
- metadata.gz: 971ad17902b7469aa50522e4493d8f50f6fd9e47c9ab76aeef4e4e6980317142dd04f8ad0e244267b278eafedc0c8d3fa62fddbcaf1cf19f497a60662b739389
7
- data.tar.gz: a418834642c184d169ae942a84c4c1096bb191de93afa545eb8b7dafd704f423293a2079cbac1e137999827c578048d366d30a63b1c82b7348868ad8a6dbeeff
6
+ metadata.gz: c93fcf30f8484e75e27bfb3598ff5f92ef16618710fd5b94a6d653b3c73afc57b156d640dd197d5c9aeda21b0a14efb62bf16c892a3e4b9ec5bdaf0148e41f20
7
+ data.tar.gz: 6daf4f903bf2d574f2250efba9aefd9b5b866c0af8d4dd69789e9b80a5a709be7563247d4be5e4d075c4f82357f801e6ea336c4538c5958fefa6f28bb33e24a0
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.207
10
+ - Package version: 4.1.209
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.207'
19
+ gem 'ultracart_api', '4.1.209'
20
20
  ```
21
21
 
22
22
  install:
@@ -478,11 +478,17 @@ Class | Method | HTTP request | Description
478
478
  *UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
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
+ *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_flow**](docs/SfvbApi.md#archive_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/archive | Archive or unarchive a flow
481
483
  *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
482
484
  *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
483
485
  *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
484
486
  *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
487
+ *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
488
+ *UltracartClient::SfvbApi* | [**clone_sfvb_flow**](docs/SfvbApi.md#clone_sfvb_flow) | **POST** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/clone | Copy a flow on the same storefront
485
489
  *UltracartClient::SfvbApi* | [**compile_sfvb_cjson**](docs/SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity
490
+ *UltracartClient::SfvbApi* | [**create_sfvb_campaign**](docs/SfvbApi.md#create_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns | Create a draft campaign
491
+ *UltracartClient::SfvbApi* | [**create_sfvb_flow**](docs/SfvbApi.md#create_sfvb_flow) | **POST** /sfvb/storefronts/{storefront_oid}/flows | Create a draft flow
486
492
  *UltracartClient::SfvbApi* | [**create_sfvb_library_entry**](docs/SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library
487
493
  *UltracartClient::SfvbApi* | [**create_sfvb_preview_access**](docs/SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login
488
494
  *UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
@@ -528,6 +534,7 @@ Class | Method | HTTP request | Description
528
534
  *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
529
535
  *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
530
536
  *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
537
+ *UltracartClient::SfvbApi* | [**get_sfvb_email**](docs/SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text
531
538
  *UltracartClient::SfvbApi* | [**get_sfvb_events**](docs/SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events
532
539
  *UltracartClient::SfvbApi* | [**get_sfvb_events_authorization**](docs/SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream
533
540
  *UltracartClient::SfvbApi* | [**get_sfvb_experiment**](docs/SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics
@@ -590,6 +597,8 @@ Class | Method | HTTP request | Description
590
597
  *UltracartClient::SfvbApi* | [**install_sfvb_library_entry**](docs/SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront
591
598
  *UltracartClient::SfvbApi* | [**list_sfvb_blog_posts**](docs/SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts
592
599
  *UltracartClient::SfvbApi* | [**list_sfvb_campaigns**](docs/SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns
600
+ *UltracartClient::SfvbApi* | [**list_sfvb_comms_lists**](docs/SfvbApi.md#list_sfvb_comms_lists) | **GET** /sfvb/storefronts/{storefront_oid}/lists | List the storefront's email lists
601
+ *UltracartClient::SfvbApi* | [**list_sfvb_comms_segments**](docs/SfvbApi.md#list_sfvb_comms_segments) | **GET** /sfvb/storefronts/{storefront_oid}/segments | List the storefront's segments
593
602
  *UltracartClient::SfvbApi* | [**list_sfvb_container_versions**](docs/SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system
594
603
  *UltracartClient::SfvbApi* | [**list_sfvb_elements**](docs/SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type
595
604
  *UltracartClient::SfvbApi* | [**list_sfvb_experiments**](docs/SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments
@@ -654,8 +663,12 @@ Class | Method | HTTP request | Description
654
663
  *UltracartClient::SfvbApi* | [**unpublish_sfvb_library_entry**](docs/SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry
655
664
  *UltracartClient::SfvbApi* | [**unshare_sfvb_library_entry**](docs/SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account
656
665
  *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
666
+ *UltracartClient::SfvbApi* | [**update_sfvb_campaign**](docs/SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign
657
667
  *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
658
668
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
669
+ *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
670
+ *UltracartClient::SfvbApi* | [**update_sfvb_flow**](docs/SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow
671
+ *UltracartClient::SfvbApi* | [**update_sfvb_flow_status**](docs/SfvbApi.md#update_sfvb_flow_status) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/status | Turn a flow on or off
659
672
  *UltracartClient::SfvbApi* | [**update_sfvb_item_attribute_batch**](docs/SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call
660
673
  *UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
661
674
  *UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
@@ -1897,6 +1910,7 @@ Class | Method | HTTP request | Description
1897
1910
  - [UltracartClient::SfvbApprovalReview](docs/SfvbApprovalReview.md)
1898
1911
  - [UltracartClient::SfvbApprovalReviewFinding](docs/SfvbApprovalReviewFinding.md)
1899
1912
  - [UltracartClient::SfvbApprovalsResponse](docs/SfvbApprovalsResponse.md)
1913
+ - [UltracartClient::SfvbArchiveRequest](docs/SfvbArchiveRequest.md)
1900
1914
  - [UltracartClient::SfvbBlogPost](docs/SfvbBlogPost.md)
1901
1915
  - [UltracartClient::SfvbBlogPostDetail](docs/SfvbBlogPostDetail.md)
1902
1916
  - [UltracartClient::SfvbBlogPostImage](docs/SfvbBlogPostImage.md)
@@ -1904,10 +1918,16 @@ Class | Method | HTTP request | Description
1904
1918
  - [UltracartClient::SfvbBlogPostRequest](docs/SfvbBlogPostRequest.md)
1905
1919
  - [UltracartClient::SfvbBlogPostsResponse](docs/SfvbBlogPostsResponse.md)
1906
1920
  - [UltracartClient::SfvbCampaign](docs/SfvbCampaign.md)
1921
+ - [UltracartClient::SfvbCampaignMembership](docs/SfvbCampaignMembership.md)
1922
+ - [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
1907
1923
  - [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
1908
1924
  - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
1909
1925
  - [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
1926
+ - [UltracartClient::SfvbCommsList](docs/SfvbCommsList.md)
1927
+ - [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
1910
1928
  - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
1929
+ - [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
1930
+ - [UltracartClient::SfvbCommsSegmentsResponse](docs/SfvbCommsSegmentsResponse.md)
1911
1931
  - [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
1912
1932
  - [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
1913
1933
  - [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
@@ -1922,8 +1942,10 @@ Class | Method | HTTP request | Description
1922
1942
  - [UltracartClient::SfvbElement](docs/SfvbElement.md)
1923
1943
  - [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
1924
1944
  - [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
1945
+ - [UltracartClient::SfvbEmail](docs/SfvbEmail.md)
1925
1946
  - [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
1926
1947
  - [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
1948
+ - [UltracartClient::SfvbEmailUpdateRequest](docs/SfvbEmailUpdateRequest.md)
1927
1949
  - [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
1928
1950
  - [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
1929
1951
  - [UltracartClient::SfvbEventsAuthRequest](docs/SfvbEventsAuthRequest.md)
@@ -1950,6 +1972,8 @@ Class | Method | HTTP request | Description
1950
1972
  - [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
1951
1973
  - [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
1952
1974
  - [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
1975
+ - [UltracartClient::SfvbFlowStatusRequest](docs/SfvbFlowStatusRequest.md)
1976
+ - [UltracartClient::SfvbFlowWriteRequest](docs/SfvbFlowWriteRequest.md)
1953
1977
  - [UltracartClient::SfvbFlowsResponse](docs/SfvbFlowsResponse.md)
1954
1978
  - [UltracartClient::SfvbI18nGlossary](docs/SfvbI18nGlossary.md)
1955
1979
  - [UltracartClient::SfvbI18nGlossaryRequest](docs/SfvbI18nGlossaryRequest.md)
@@ -2297,6 +2321,8 @@ Not every change is committed to every SDK.
2297
2321
 
2298
2322
  | Version | Date | Comments |
2299
2323
  | --: | :-: | --- |
2324
+ | 4.1.209 | 10/27/2026 | sfvb internal testing |
2325
+ | 4.1.208 | 10/26/2026 | sfvb internal testing |
2300
2326
  | 4.1.207 | 10/16/2026 | sfvb internal testing |
2301
2327
  | 4.1.206 | 10/16/2026 | sfvb internal testing |
2302
2328
  | 4.1.205 | 10/15/2026 | sfvb internal testing |