ultracart_api 4.1.208 → 4.1.210

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -2
  3. data/docs/SfvbApi.md +717 -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 +2 -0
  14. data/docs/SfvbEmailReviewRequest.md +18 -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 +1027 -88
  19. data/lib/ultracart_api/models/sfvb_archive_request.rb +220 -0
  20. data/lib/ultracart_api/models/sfvb_campaign.rb +85 -1
  21. data/lib/ultracart_api/models/sfvb_campaign_membership.rb +250 -0
  22. data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +292 -0
  23. data/lib/ultracart_api/models/sfvb_comms_email.rb +31 -1
  24. data/lib/ultracart_api/models/sfvb_comms_list.rb +250 -0
  25. data/lib/ultracart_api/models/sfvb_comms_lists_response.rb +222 -0
  26. data/lib/ultracart_api/models/sfvb_comms_segment.rb +260 -0
  27. data/lib/ultracart_api/models/sfvb_comms_segments_response.rb +222 -0
  28. data/lib/ultracart_api/models/sfvb_email.rb +13 -1
  29. data/lib/ultracart_api/models/sfvb_email_review_request.rb +220 -0
  30. data/lib/ultracart_api/models/sfvb_flow.rb +113 -1
  31. data/lib/ultracart_api/models/sfvb_flow_status_request.rb +254 -0
  32. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +354 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +10 -0
  35. metadata +22 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 62fd7064999430105ea3b09ae20d62424894503c5c05d5cbc581fc37bf6a1436
4
- data.tar.gz: 9cd9c6fed78ad9ea47e21e1e4749f0f44ce6b11f04090e3c2e615fe4958c0b95
3
+ metadata.gz: e01b5f98446f4cd7a17870cd2492a7909f7e890cee3d71e968937e3ea161e861
4
+ data.tar.gz: 4845b8436645b593f800f84e32313d14384e619d1d58c4dd0cddd066d2102648
5
5
  SHA512:
6
- metadata.gz: '099e55cb7722932b2cfcaa08420ea5ef89679facce8d0c52b3c3532d0297eb866923a830d997589e4b59f22d86b62766ecadcfaa2e33cbc804a18fdfe1064dee'
7
- data.tar.gz: 45f76315807bc93a073ff2caf262a6508eea9e56629d730726ec514027d75d8557b921f76ba1cd3f9d51275b358daa7397d3915e8a8d00ee8193e0472ed1ff45
6
+ metadata.gz: 8eae36df126bd5b1af621ae04b4db5243b507394ba0dc2d47a8f6c900b71a40a4a0c03fc66fa57839384b5da16e6f5bd0d20d9a0876ab16ff6cc12c7f4dac357
7
+ data.tar.gz: 9600f18f9314f9fcc61264cafdb0ccf00748f099d08c376a5148d5cc02cd927e0628eb565969dc3ba5f756f49f474866b2d19da8c1eb4e25aba4a8e075d3f035
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.208
10
+ - Package version: 4.1.210
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.208'
19
+ gem 'ultracart_api', '4.1.210'
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
@@ -591,6 +597,8 @@ Class | Method | HTTP request | Description
591
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
592
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
593
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
594
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
595
603
  *UltracartClient::SfvbApi* | [**list_sfvb_elements**](docs/SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type
596
604
  *UltracartClient::SfvbApi* | [**list_sfvb_experiments**](docs/SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments
@@ -643,6 +651,7 @@ Class | Method | HTTP request | Description
643
651
  *UltracartClient::SfvbApi* | [**resolve_sfvb_template**](docs/SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders
644
652
  *UltracartClient::SfvbApi* | [**revert_sfvb_container**](docs/SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system
645
653
  *UltracartClient::SfvbApi* | [**revert_sfvb_file**](docs/SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version
654
+ *UltracartClient::SfvbApi* | [**review_sfvb_email**](docs/SfvbApi.md#review_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/review | Request a content review of a flow or campaign email
646
655
  *UltracartClient::SfvbApi* | [**revoke_sfvb_secret_request**](docs/SfvbApi.md#revoke_sfvb_secret_request) | **POST** /sfvb/secrets/{request_id}/revoke | Revoke a fulfilled request's unused handles
647
656
  *UltracartClient::SfvbApi* | [**search_sfvb_files**](docs/SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files
648
657
  *UltracartClient::SfvbApi* | [**search_sfvb_library**](docs/SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library
@@ -655,9 +664,12 @@ Class | Method | HTTP request | Description
655
664
  *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
656
665
  *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
657
666
  *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
667
+ *UltracartClient::SfvbApi* | [**update_sfvb_campaign**](docs/SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign
658
668
  *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
659
669
  *UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
660
670
  *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
671
+ *UltracartClient::SfvbApi* | [**update_sfvb_flow**](docs/SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow
672
+ *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
661
673
  *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
662
674
  *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
663
675
  *UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
@@ -1899,6 +1911,7 @@ Class | Method | HTTP request | Description
1899
1911
  - [UltracartClient::SfvbApprovalReview](docs/SfvbApprovalReview.md)
1900
1912
  - [UltracartClient::SfvbApprovalReviewFinding](docs/SfvbApprovalReviewFinding.md)
1901
1913
  - [UltracartClient::SfvbApprovalsResponse](docs/SfvbApprovalsResponse.md)
1914
+ - [UltracartClient::SfvbArchiveRequest](docs/SfvbArchiveRequest.md)
1902
1915
  - [UltracartClient::SfvbBlogPost](docs/SfvbBlogPost.md)
1903
1916
  - [UltracartClient::SfvbBlogPostDetail](docs/SfvbBlogPostDetail.md)
1904
1917
  - [UltracartClient::SfvbBlogPostImage](docs/SfvbBlogPostImage.md)
@@ -1906,10 +1919,16 @@ Class | Method | HTTP request | Description
1906
1919
  - [UltracartClient::SfvbBlogPostRequest](docs/SfvbBlogPostRequest.md)
1907
1920
  - [UltracartClient::SfvbBlogPostsResponse](docs/SfvbBlogPostsResponse.md)
1908
1921
  - [UltracartClient::SfvbCampaign](docs/SfvbCampaign.md)
1922
+ - [UltracartClient::SfvbCampaignMembership](docs/SfvbCampaignMembership.md)
1923
+ - [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
1909
1924
  - [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
1910
1925
  - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
1911
1926
  - [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
1927
+ - [UltracartClient::SfvbCommsList](docs/SfvbCommsList.md)
1928
+ - [UltracartClient::SfvbCommsListsResponse](docs/SfvbCommsListsResponse.md)
1912
1929
  - [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
1930
+ - [UltracartClient::SfvbCommsSegment](docs/SfvbCommsSegment.md)
1931
+ - [UltracartClient::SfvbCommsSegmentsResponse](docs/SfvbCommsSegmentsResponse.md)
1913
1932
  - [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
1914
1933
  - [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
1915
1934
  - [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
@@ -1927,6 +1946,7 @@ Class | Method | HTTP request | Description
1927
1946
  - [UltracartClient::SfvbEmail](docs/SfvbEmail.md)
1928
1947
  - [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
1929
1948
  - [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
1949
+ - [UltracartClient::SfvbEmailReviewRequest](docs/SfvbEmailReviewRequest.md)
1930
1950
  - [UltracartClient::SfvbEmailUpdateRequest](docs/SfvbEmailUpdateRequest.md)
1931
1951
  - [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
1932
1952
  - [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
@@ -1954,6 +1974,8 @@ Class | Method | HTTP request | Description
1954
1974
  - [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
1955
1975
  - [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
1956
1976
  - [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
1977
+ - [UltracartClient::SfvbFlowStatusRequest](docs/SfvbFlowStatusRequest.md)
1978
+ - [UltracartClient::SfvbFlowWriteRequest](docs/SfvbFlowWriteRequest.md)
1957
1979
  - [UltracartClient::SfvbFlowsResponse](docs/SfvbFlowsResponse.md)
1958
1980
  - [UltracartClient::SfvbI18nGlossary](docs/SfvbI18nGlossary.md)
1959
1981
  - [UltracartClient::SfvbI18nGlossaryRequest](docs/SfvbI18nGlossaryRequest.md)
@@ -2301,6 +2323,8 @@ Not every change is committed to every SDK.
2301
2323
 
2302
2324
  | Version | Date | Comments |
2303
2325
  | --: | :-: | --- |
2326
+ | 4.1.210 | 10/27/2026 | sfvb internal testing |
2327
+ | 4.1.209 | 10/27/2026 | sfvb internal testing |
2304
2328
  | 4.1.208 | 10/26/2026 | sfvb internal testing |
2305
2329
  | 4.1.207 | 10/16/2026 | sfvb internal testing |
2306
2330
  | 4.1.206 | 10/16/2026 | sfvb internal testing |