ultracart_api 4.1.203 → 4.1.205

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 (29) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -2
  3. data/docs/SfvbApi.md +711 -7
  4. data/docs/SfvbApprovalParams.md +4 -0
  5. data/docs/SfvbCommsDnsRecord.md +24 -0
  6. data/docs/SfvbCommsSendingDomain.md +38 -0
  7. data/docs/SfvbCommsSendingDomainsResponse.md +18 -0
  8. data/docs/SfvbCommsTwilioAccount.md +38 -0
  9. data/docs/SfvbCommsTwilioAccountResponse.md +20 -0
  10. data/docs/SfvbEmailRenderRequest.md +24 -0
  11. data/docs/SfvbEmailRenderResponse.md +34 -0
  12. data/docs/SfvbSecretRequestCreate.md +1 -1
  13. data/docs/SfvbTransactionalEmail.md +24 -0
  14. data/docs/SfvbTransactionalEmailsResponse.md +18 -0
  15. data/lib/ultracart_api/api/sfvb_api.rb +906 -26
  16. data/lib/ultracart_api/models/sfvb_approval_params.rb +21 -1
  17. data/lib/ultracart_api/models/sfvb_comms_dns_record.rb +296 -0
  18. data/lib/ultracart_api/models/sfvb_comms_sending_domain.rb +356 -0
  19. data/lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb +222 -0
  20. data/lib/ultracart_api/models/sfvb_comms_twilio_account.rb +322 -0
  21. data/lib/ultracart_api/models/sfvb_comms_twilio_account_response.rb +231 -0
  22. data/lib/ultracart_api/models/sfvb_email_render_request.rb +252 -0
  23. data/lib/ultracart_api/models/sfvb_email_render_response.rb +301 -0
  24. data/lib/ultracart_api/models/sfvb_secret_request_create.rb +1 -1
  25. data/lib/ultracart_api/models/sfvb_transactional_email.rb +250 -0
  26. data/lib/ultracart_api/models/sfvb_transactional_emails_response.rb +222 -0
  27. data/lib/ultracart_api/version.rb +1 -1
  28. data/lib/ultracart_api.rb +9 -0
  29. metadata +19 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 00666a9bf01ef4230812762f575d67f10482bba350bd40952ba485c405ebde29
4
- data.tar.gz: b2a50501d6cad4f28cb8f98beaeb379f19df30d8185bfad75d7775ffd5478205
3
+ metadata.gz: 30d80e78c5a255c32b891b34d664c4cdc85b638f6d33a8de61d7bf1f55b5b6e9
4
+ data.tar.gz: 2b75ba48b42e01f66083af809b588d81e9a4e3c5a7406e55b85b9809df0cb700
5
5
  SHA512:
6
- metadata.gz: eab1417ea0f102c391989bbf39a7356175d9070c18b710474f09c911ce9fcb12086e38de37b1f343f897afeab6a2fc2fb3861e0224fa18248d14b5f7eb08c862
7
- data.tar.gz: 25d9f4c87f0d91cec8b10f02f15db07e10c408700c1a62f5563374ab436cfc74e1d1e207996132bf7122c2a4af04da0fcf626c8307183ecccea7853268e1f5cb
6
+ metadata.gz: 2d93e5fc74c7c490d4fbb6358f86d7e9eabb1f13c1852438fb06dc4f6671a0c66643c1029d991c37976dd035f4fe9ca249518b04fccbc93d9b6835e28af56008
7
+ data.tar.gz: 890c1b17a98e86db826294f10eb2ace13d85769857caa4dd6a02d785e16a70fe1c4cd896da66ce8f31cec970508d6f111a250ca874188330a0a3108b103cb955
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.203
10
+ - Package version: 4.1.205
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.203'
19
+ gem 'ultracart_api', '4.1.205'
20
20
  ```
21
21
 
22
22
  install:
@@ -488,6 +488,8 @@ Class | Method | HTTP request | Description
488
488
  *UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
489
489
  *UltracartClient::SfvbApi* | [**delete_sfvb_approval**](docs/SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request
490
490
  *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
491
+ *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
492
+ *UltracartClient::SfvbApi* | [**delete_sfvb_comms_twilio_account**](docs/SfvbApi.md#delete_sfvb_comms_twilio_account) | **DELETE** /sfvb/comms/twilio_account | Remove the Twilio account
491
493
  *UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
492
494
  *UltracartClient::SfvbApi* | [**delete_sfvb_item_attribute**](docs/SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item
493
495
  *UltracartClient::SfvbApi* | [**delete_sfvb_item_multimedia**](docs/SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item
@@ -519,6 +521,9 @@ Class | Method | HTTP request | Description
519
521
  *UltracartClient::SfvbApi* | [**get_sfvb_approvals**](docs/SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests
520
522
  *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
521
523
  *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
524
+ *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
525
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
526
+ *UltracartClient::SfvbApi* | [**get_sfvb_comms_twilio_account**](docs/SfvbApi.md#get_sfvb_comms_twilio_account) | **GET** /sfvb/comms/twilio_account | Read the Twilio account
522
527
  *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
523
528
  *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
524
529
  *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
@@ -564,6 +569,7 @@ Class | Method | HTTP request | Description
564
569
  *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
565
570
  *UltracartClient::SfvbApi* | [**get_sfvb_theme_attributes**](docs/SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings
566
571
  *UltracartClient::SfvbApi* | [**get_sfvb_theme_job**](docs/SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job
572
+ *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
567
573
  *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
568
574
  *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
569
575
  *UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
@@ -572,6 +578,8 @@ Class | Method | HTTP request | Description
572
578
  *UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
573
579
  *UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
574
580
  *UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
581
+ *UltracartClient::SfvbApi* | [**insert_sfvb_comms_sending_domain**](docs/SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain
582
+ *UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
575
583
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
576
584
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
577
585
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
@@ -617,9 +625,12 @@ Class | Method | HTTP request | Description
617
625
  *UltracartClient::SfvbApi* | [**put_sfvb_recording_settings**](docs/SfvbApi.md#put_sfvb_recording_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/recording_settings | Turn the storefront's screen recording on or off
618
626
  *UltracartClient::SfvbApi* | [**put_sfvb_site_attributes**](docs/SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes
619
627
  *UltracartClient::SfvbApi* | [**put_sfvb_theme_attributes**](docs/SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings
628
+ *UltracartClient::SfvbApi* | [**refresh_sfvb_comms_sending_domain_status**](docs/SfvbApi.md#refresh_sfvb_comms_sending_domain_status) | **POST** /sfvb/comms/sending_domains/{domain}/status | Check a sending domain's verification
620
629
  *UltracartClient::SfvbApi* | [**refresh_sfvb_page**](docs/SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy
621
630
  *UltracartClient::SfvbApi* | [**remove_sfvb_page_blog_posts**](docs/SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page
622
631
  *UltracartClient::SfvbApi* | [**remove_sfvb_page_items**](docs/SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page
632
+ *UltracartClient::SfvbApi* | [**render_sfvb_email**](docs/SfvbApi.md#render_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/render | Render a flow or campaign email without sending it
633
+ *UltracartClient::SfvbApi* | [**render_sfvb_transactional_email**](docs/SfvbApi.md#render_sfvb_transactional_email) | **POST** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}/render | Render a transactional email without sending it
623
634
  *UltracartClient::SfvbApi* | [**render_sfvb_widgets**](docs/SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML
624
635
  *UltracartClient::SfvbApi* | [**reserve_sfvb_widget_ids**](docs/SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids
625
636
  *UltracartClient::SfvbApi* | [**reset_sfvb_i18n_message**](docs/SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message
@@ -639,6 +650,8 @@ Class | Method | HTTP request | Description
639
650
  *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
640
651
  *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
641
652
  *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
653
+ *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
654
+ *UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
642
655
  *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
643
656
  *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
644
657
  *UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
@@ -1886,6 +1899,11 @@ Class | Method | HTTP request | Description
1886
1899
  - [UltracartClient::SfvbBlogPostImageRequest](docs/SfvbBlogPostImageRequest.md)
1887
1900
  - [UltracartClient::SfvbBlogPostRequest](docs/SfvbBlogPostRequest.md)
1888
1901
  - [UltracartClient::SfvbBlogPostsResponse](docs/SfvbBlogPostsResponse.md)
1902
+ - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
1903
+ - [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
1904
+ - [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
1905
+ - [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
1906
+ - [UltracartClient::SfvbCommsTwilioAccountResponse](docs/SfvbCommsTwilioAccountResponse.md)
1889
1907
  - [UltracartClient::SfvbCompileRequest](docs/SfvbCompileRequest.md)
1890
1908
  - [UltracartClient::SfvbCompileResponse](docs/SfvbCompileResponse.md)
1891
1909
  - [UltracartClient::SfvbContainerResponse](docs/SfvbContainerResponse.md)
@@ -1896,6 +1914,8 @@ Class | Method | HTTP request | Description
1896
1914
  - [UltracartClient::SfvbElement](docs/SfvbElement.md)
1897
1915
  - [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
1898
1916
  - [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
1917
+ - [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
1918
+ - [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
1899
1919
  - [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
1900
1920
  - [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
1901
1921
  - [UltracartClient::SfvbEventsAuthRequest](docs/SfvbEventsAuthRequest.md)
@@ -2077,6 +2097,8 @@ Class | Method | HTTP request | Description
2077
2097
  - [UltracartClient::SfvbThemeFontFamily](docs/SfvbThemeFontFamily.md)
2078
2098
  - [UltracartClient::SfvbThemeJobResponse](docs/SfvbThemeJobResponse.md)
2079
2099
  - [UltracartClient::SfvbThemesResponse](docs/SfvbThemesResponse.md)
2100
+ - [UltracartClient::SfvbTransactionalEmail](docs/SfvbTransactionalEmail.md)
2101
+ - [UltracartClient::SfvbTransactionalEmailsResponse](docs/SfvbTransactionalEmailsResponse.md)
2080
2102
  - [UltracartClient::SfvbUpsellItemLogic](docs/SfvbUpsellItemLogic.md)
2081
2103
  - [UltracartClient::SfvbUpsellItemLogicItem](docs/SfvbUpsellItemLogicItem.md)
2082
2104
  - [UltracartClient::SfvbUpsellOffer](docs/SfvbUpsellOffer.md)
@@ -2265,6 +2287,8 @@ Not every change is committed to every SDK.
2265
2287
 
2266
2288
  | Version | Date | Comments |
2267
2289
  | --: | :-: | --- |
2290
+ | 4.1.205 | 10/15/2026 | sfvb internal testing |
2291
+ | 4.1.204 | 10/15/2026 | sfvb internal testing |
2268
2292
  | 4.1.203 | 10/15/2026 | sfvb internal testing |
2269
2293
  | 4.1.202 | 10/13/2026 | sfvb internal testing |
2270
2294
  | 4.1.201 | 10/12/2026 | sfvb internal testing |