ultracart_api 4.1.204 → 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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7815bde776454273b316c70ab86eaf12ac8cf861c3652f2980792c3b887d34c7
4
- data.tar.gz: c92f4ce9441b1404982f7128ed1438807cf7ade3fe2107d1c19b27635805f18c
3
+ metadata.gz: 30d80e78c5a255c32b891b34d664c4cdc85b638f6d33a8de61d7bf1f55b5b6e9
4
+ data.tar.gz: 2b75ba48b42e01f66083af809b588d81e9a4e3c5a7406e55b85b9809df0cb700
5
5
  SHA512:
6
- metadata.gz: d55bdc78eb30b7c9cf57b478d1935b88f8b66831adaae49ff3b022ce2656d01af9ee3d2a19e4e7718b5f5e7d35ba181a0cde1fe96f3080d18659f339385fb375
7
- data.tar.gz: 6d3ee8ca16e665e0ab1b5bac845cc8987f0b0a44d7cbc1b962f9ef3e9f8765f4109eceb2b430c5f72c7c9e1027a4219f4e68eed2915a354b5711e5060d786502
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.204
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.204'
19
+ gem 'ultracart_api', '4.1.205'
20
20
  ```
21
21
 
22
22
  install:
@@ -569,6 +569,7 @@ Class | Method | HTTP request | Description
569
569
  *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
570
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
571
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
572
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
573
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
574
575
  *UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
@@ -628,6 +629,8 @@ Class | Method | HTTP request | Description
628
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
629
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
630
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
631
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
632
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
633
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
@@ -1911,6 +1914,8 @@ Class | Method | HTTP request | Description
1911
1914
  - [UltracartClient::SfvbElement](docs/SfvbElement.md)
1912
1915
  - [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
1913
1916
  - [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
1917
+ - [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
1918
+ - [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
1914
1919
  - [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
1915
1920
  - [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
1916
1921
  - [UltracartClient::SfvbEventsAuthRequest](docs/SfvbEventsAuthRequest.md)
@@ -2092,6 +2097,8 @@ Class | Method | HTTP request | Description
2092
2097
  - [UltracartClient::SfvbThemeFontFamily](docs/SfvbThemeFontFamily.md)
2093
2098
  - [UltracartClient::SfvbThemeJobResponse](docs/SfvbThemeJobResponse.md)
2094
2099
  - [UltracartClient::SfvbThemesResponse](docs/SfvbThemesResponse.md)
2100
+ - [UltracartClient::SfvbTransactionalEmail](docs/SfvbTransactionalEmail.md)
2101
+ - [UltracartClient::SfvbTransactionalEmailsResponse](docs/SfvbTransactionalEmailsResponse.md)
2095
2102
  - [UltracartClient::SfvbUpsellItemLogic](docs/SfvbUpsellItemLogic.md)
2096
2103
  - [UltracartClient::SfvbUpsellItemLogicItem](docs/SfvbUpsellItemLogicItem.md)
2097
2104
  - [UltracartClient::SfvbUpsellOffer](docs/SfvbUpsellOffer.md)
@@ -2280,6 +2287,7 @@ Not every change is committed to every SDK.
2280
2287
 
2281
2288
  | Version | Date | Comments |
2282
2289
  | --: | :-: | --- |
2290
+ | 4.1.205 | 10/15/2026 | sfvb internal testing |
2283
2291
  | 4.1.204 | 10/15/2026 | sfvb internal testing |
2284
2292
  | 4.1.203 | 10/15/2026 | sfvb internal testing |
2285
2293
  | 4.1.202 | 10/13/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -97,6 +97,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
97
97
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
98
98
  | [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
99
99
  | [**get_sfvb_theme_job**](SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job |
100
+ | [**get_sfvb_transactional_emails**](SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends |
100
101
  | [**get_sfvb_upsell_offer**](SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer |
101
102
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
102
103
  | [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
@@ -156,6 +157,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
156
157
  | [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy |
157
158
  | [**remove_sfvb_page_blog_posts**](SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page |
158
159
  | [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
160
+ | [**render_sfvb_email**](SfvbApi.md#render_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/render | Render a flow or campaign email without sending it |
161
+ | [**render_sfvb_transactional_email**](SfvbApi.md#render_sfvb_transactional_email) | **POST** /sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}/render | Render a transactional email without sending it |
159
162
  | [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
160
163
  | [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
161
164
  | [**reset_sfvb_i18n_message**](SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message |
@@ -5228,6 +5231,59 @@ end
5228
5231
  - **Accept**: application/json
5229
5232
 
5230
5233
 
5234
+ ## get_sfvb_transactional_emails
5235
+
5236
+ > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
5237
+
5238
+ List the transactional emails a storefront sends
5239
+
5240
+ The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
5241
+
5242
+
5243
+ ### Examples
5244
+
5245
+
5246
+ (No example for this operation).
5247
+
5248
+
5249
+ #### Using the get_sfvb_transactional_emails_with_http_info variant
5250
+
5251
+ This returns an Array which contains the response data, status code and headers.
5252
+
5253
+ > <Array(<SfvbTransactionalEmailsResponse>, Integer, Hash)> get_sfvb_transactional_emails_with_http_info(storefront_oid)
5254
+
5255
+ ```ruby
5256
+ begin
5257
+ # List the transactional emails a storefront sends
5258
+ data, status_code, headers = api_instance.get_sfvb_transactional_emails_with_http_info(storefront_oid)
5259
+ p status_code # => 2xx
5260
+ p headers # => { ... }
5261
+ p data # => <SfvbTransactionalEmailsResponse>
5262
+ rescue UltracartClient::ApiError => e
5263
+ puts "Error when calling SfvbApi->get_sfvb_transactional_emails_with_http_info: #{e}"
5264
+ end
5265
+ ```
5266
+
5267
+ ### Parameters
5268
+
5269
+ | Name | Type | Description | Notes |
5270
+ | ---- | ---- | ----------- | ----- |
5271
+ | **storefront_oid** | **Integer** | | |
5272
+
5273
+ ### Return type
5274
+
5275
+ [**SfvbTransactionalEmailsResponse**](SfvbTransactionalEmailsResponse.md)
5276
+
5277
+ ### Authorization
5278
+
5279
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5280
+
5281
+ ### HTTP request headers
5282
+
5283
+ - **Content-Type**: Not defined
5284
+ - **Accept**: application/json
5285
+
5286
+
5231
5287
  ## get_sfvb_upsell_offer
5232
5288
 
5233
5289
  > <SfvbUpsellOffer> get_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts)
@@ -8479,6 +8535,116 @@ end
8479
8535
  - **Accept**: application/json
8480
8536
 
8481
8537
 
8538
+ ## render_sfvb_email
8539
+
8540
+ > <SfvbEmailRenderResponse> render_sfvb_email(storefront_oid, email_uuid, email_render_request)
8541
+
8542
+ Render a flow or campaign email without sending it
8543
+
8544
+ Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
8545
+
8546
+
8547
+ ### Examples
8548
+
8549
+
8550
+ (No example for this operation).
8551
+
8552
+
8553
+ #### Using the render_sfvb_email_with_http_info variant
8554
+
8555
+ This returns an Array which contains the response data, status code and headers.
8556
+
8557
+ > <Array(<SfvbEmailRenderResponse>, Integer, Hash)> render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request)
8558
+
8559
+ ```ruby
8560
+ begin
8561
+ # Render a flow or campaign email without sending it
8562
+ data, status_code, headers = api_instance.render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request)
8563
+ p status_code # => 2xx
8564
+ p headers # => { ... }
8565
+ p data # => <SfvbEmailRenderResponse>
8566
+ rescue UltracartClient::ApiError => e
8567
+ puts "Error when calling SfvbApi->render_sfvb_email_with_http_info: #{e}"
8568
+ end
8569
+ ```
8570
+
8571
+ ### Parameters
8572
+
8573
+ | Name | Type | Description | Notes |
8574
+ | ---- | ---- | ----------- | ----- |
8575
+ | **storefront_oid** | **Integer** | | |
8576
+ | **email_uuid** | **String** | | |
8577
+ | **email_render_request** | [**SfvbEmailRenderRequest**](SfvbEmailRenderRequest.md) | What to render the email with | |
8578
+
8579
+ ### Return type
8580
+
8581
+ [**SfvbEmailRenderResponse**](SfvbEmailRenderResponse.md)
8582
+
8583
+ ### Authorization
8584
+
8585
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8586
+
8587
+ ### HTTP request headers
8588
+
8589
+ - **Content-Type**: application/json
8590
+ - **Accept**: application/json
8591
+
8592
+
8593
+ ## render_sfvb_transactional_email
8594
+
8595
+ > <SfvbEmailRenderResponse> render_sfvb_transactional_email(storefront_oid, file_name, email_render_request)
8596
+
8597
+ Render a transactional email without sending it
8598
+
8599
+ Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email's body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
8600
+
8601
+
8602
+ ### Examples
8603
+
8604
+
8605
+ (No example for this operation).
8606
+
8607
+
8608
+ #### Using the render_sfvb_transactional_email_with_http_info variant
8609
+
8610
+ This returns an Array which contains the response data, status code and headers.
8611
+
8612
+ > <Array(<SfvbEmailRenderResponse>, Integer, Hash)> render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request)
8613
+
8614
+ ```ruby
8615
+ begin
8616
+ # Render a transactional email without sending it
8617
+ data, status_code, headers = api_instance.render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request)
8618
+ p status_code # => 2xx
8619
+ p headers # => { ... }
8620
+ p data # => <SfvbEmailRenderResponse>
8621
+ rescue UltracartClient::ApiError => e
8622
+ puts "Error when calling SfvbApi->render_sfvb_transactional_email_with_http_info: #{e}"
8623
+ end
8624
+ ```
8625
+
8626
+ ### Parameters
8627
+
8628
+ | Name | Type | Description | Notes |
8629
+ | ---- | ---- | ----------- | ----- |
8630
+ | **storefront_oid** | **Integer** | | |
8631
+ | **file_name** | **String** | | |
8632
+ | **email_render_request** | [**SfvbEmailRenderRequest**](SfvbEmailRenderRequest.md) | What to render the email with | |
8633
+
8634
+ ### Return type
8635
+
8636
+ [**SfvbEmailRenderResponse**](SfvbEmailRenderResponse.md)
8637
+
8638
+ ### Authorization
8639
+
8640
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8641
+
8642
+ ### HTTP request headers
8643
+
8644
+ - **Content-Type**: application/json
8645
+ - **Accept**: application/json
8646
+
8647
+
8482
8648
  ## render_sfvb_widgets
8483
8649
 
8484
8650
  > <SfvbRenderResponse> render_sfvb_widgets(storefront_oid, theme_oid, render_request)
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbEmailRenderRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cart_item_ids** | **Array&lt;String&gt;** | Item ids for the cart the email renders with. For a cart flow email, or the transactional email this cart and email this item templates. | [optional] |
8
+ | **cjson** | **String** | An unsaved draft to render in place of the saved content. For a flow or campaign email, the email container. For a transactional email, the body container (the theme file core/emails/&lt;name&gt;_body.cjson). | [optional] |
9
+ | **customer_name** | **String** | The customer name a flow or campaign email greets. Defaults to the signed in user. | [optional] |
10
+ | **order_id** | **String** | A test order to render the email with. Real orders are refused. Without one, an order email renders with a made up order. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbEmailRenderRequest.new(
18
+ cart_item_ids: null,
19
+ cjson: null,
20
+ customer_name: null,
21
+ order_id: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,34 @@
1
+ # UltracartClient::SfvbEmailRenderResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **draft** | **Boolean** | True when an unsaved draft was rendered. | [optional] |
8
+ | **html** | **String** | The HTML body. | [optional] |
9
+ | **order_id** | **String** | The order the email rendered with, when it used one. | [optional] |
10
+ | **order_source** | **String** | Where that order came from. test (the order given), dummy (made up) or none. | [optional] |
11
+ | **preview_text** | **String** | The preview text an inbox shows after the subject, when the email has one. | [optional] |
12
+ | **subject** | **String** | The subject line. | [optional] |
13
+ | **text** | **String** | The plain text body. | [optional] |
14
+ | **validation** | [**SfvbValidationResponse**](SfvbValidationResponse.md) | | [optional] |
15
+ | **warnings** | [**Array&lt;SfvbErrorDetail&gt;**](SfvbErrorDetail.md) | Problems a real send would hit, such as a missing required footer token, and placeholders used in place of values a send creates. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ultracart_api'
21
+
22
+ instance = UltracartClient::SfvbEmailRenderResponse.new(
23
+ draft: null,
24
+ html: null,
25
+ order_id: null,
26
+ order_source: null,
27
+ preview_text: null,
28
+ subject: null,
29
+ text: null,
30
+ validation: null,
31
+ warnings: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbTransactionalEmail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **body_file_name** | **String** | The body container a draft replaces, such as receipt_body.cjson. | [optional] |
8
+ | **file_name** | **String** | The HTML template file, such as receipt_html.vm. | [optional] |
9
+ | **name** | **String** | The display name, such as Order - Receipt. | [optional] |
10
+ | **text_file_name** | **String** | The plain text template file, when the email has one. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbTransactionalEmail.new(
18
+ body_file_name: null,
19
+ file_name: null,
20
+ name: null,
21
+ text_file_name: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # UltracartClient::SfvbTransactionalEmailsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **emails** | [**Array&lt;SfvbTransactionalEmail&gt;**](SfvbTransactionalEmail.md) | The emails, sorted by name. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::SfvbTransactionalEmailsResponse.new(
15
+ emails: null
16
+ )
17
+ ```
18
+
@@ -6628,6 +6628,70 @@ module UltracartClient
6628
6628
  return data, status_code, headers
6629
6629
  end
6630
6630
 
6631
+ # List the transactional emails a storefront sends
6632
+ # The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
6633
+ # @param storefront_oid [Integer]
6634
+ # @param [Hash] opts the optional parameters
6635
+ # @return [SfvbTransactionalEmailsResponse]
6636
+ def get_sfvb_transactional_emails(storefront_oid, opts = {})
6637
+ data, _status_code, _headers = get_sfvb_transactional_emails_with_http_info(storefront_oid, opts)
6638
+ data
6639
+ end
6640
+
6641
+ # List the transactional emails a storefront sends
6642
+ # The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
6643
+ # @param storefront_oid [Integer]
6644
+ # @param [Hash] opts the optional parameters
6645
+ # @return [Array<(SfvbTransactionalEmailsResponse, Integer, Hash)>] SfvbTransactionalEmailsResponse data, response status code and response headers
6646
+ def get_sfvb_transactional_emails_with_http_info(storefront_oid, opts = {})
6647
+ if @api_client.config.debugging
6648
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_transactional_emails ...'
6649
+ end
6650
+ # verify the required parameter 'storefront_oid' is set
6651
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6652
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_transactional_emails"
6653
+ end
6654
+ # resource path
6655
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
6656
+
6657
+ # query parameters
6658
+ query_params = opts[:query_params] || {}
6659
+
6660
+ # header parameters
6661
+ header_params = opts[:header_params] || {}
6662
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6663
+ # HTTP header 'Accept' (if needed)
6664
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6665
+
6666
+ # form parameters
6667
+ form_params = opts[:form_params] || {}
6668
+
6669
+ # http body (model)
6670
+ post_body = opts[:debug_body]
6671
+
6672
+ # return_type
6673
+ return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailsResponse'
6674
+
6675
+ # auth_names
6676
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6677
+
6678
+ new_options = opts.merge(
6679
+ :operation => :"SfvbApi.get_sfvb_transactional_emails",
6680
+ :header_params => header_params,
6681
+ :query_params => query_params,
6682
+ :form_params => form_params,
6683
+ :body => post_body,
6684
+ :auth_names => auth_names,
6685
+ :return_type => return_type
6686
+ )
6687
+
6688
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6689
+ if @api_client.config.debugging
6690
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_transactional_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6691
+ end
6692
+ return data, status_code, headers
6693
+ end
6694
+
6631
6695
  # Get an upsell offer
6632
6696
  # The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
6633
6697
  # @param storefront_oid [Integer]
@@ -11150,6 +11214,168 @@ module UltracartClient
11150
11214
  return data, status_code, headers
11151
11215
  end
11152
11216
 
11217
+ # Render a flow or campaign email without sending it
11218
+ # Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
11219
+ # @param storefront_oid [Integer]
11220
+ # @param email_uuid [String]
11221
+ # @param email_render_request [SfvbEmailRenderRequest] What to render the email with
11222
+ # @param [Hash] opts the optional parameters
11223
+ # @return [SfvbEmailRenderResponse]
11224
+ def render_sfvb_email(storefront_oid, email_uuid, email_render_request, opts = {})
11225
+ data, _status_code, _headers = render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request, opts)
11226
+ data
11227
+ end
11228
+
11229
+ # Render a flow or campaign email without sending it
11230
+ # Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
11231
+ # @param storefront_oid [Integer]
11232
+ # @param email_uuid [String]
11233
+ # @param email_render_request [SfvbEmailRenderRequest] What to render the email with
11234
+ # @param [Hash] opts the optional parameters
11235
+ # @return [Array<(SfvbEmailRenderResponse, Integer, Hash)>] SfvbEmailRenderResponse data, response status code and response headers
11236
+ def render_sfvb_email_with_http_info(storefront_oid, email_uuid, email_render_request, opts = {})
11237
+ if @api_client.config.debugging
11238
+ @api_client.config.logger.debug 'Calling API: SfvbApi.render_sfvb_email ...'
11239
+ end
11240
+ # verify the required parameter 'storefront_oid' is set
11241
+ if @api_client.config.client_side_validation && storefront_oid.nil?
11242
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.render_sfvb_email"
11243
+ end
11244
+ # verify the required parameter 'email_uuid' is set
11245
+ if @api_client.config.client_side_validation && email_uuid.nil?
11246
+ fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.render_sfvb_email"
11247
+ end
11248
+ # verify the required parameter 'email_render_request' is set
11249
+ if @api_client.config.client_side_validation && email_render_request.nil?
11250
+ fail ArgumentError, "Missing the required parameter 'email_render_request' when calling SfvbApi.render_sfvb_email"
11251
+ end
11252
+ # resource path
11253
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/render'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
11254
+
11255
+ # query parameters
11256
+ query_params = opts[:query_params] || {}
11257
+
11258
+ # header parameters
11259
+ header_params = opts[:header_params] || {}
11260
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11261
+ # HTTP header 'Accept' (if needed)
11262
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11263
+ # HTTP header 'Content-Type'
11264
+ content_type = @api_client.select_header_content_type(['application/json'])
11265
+ if !content_type.nil?
11266
+ header_params['Content-Type'] = content_type
11267
+ end
11268
+
11269
+ # form parameters
11270
+ form_params = opts[:form_params] || {}
11271
+
11272
+ # http body (model)
11273
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(email_render_request)
11274
+
11275
+ # return_type
11276
+ return_type = opts[:debug_return_type] || 'SfvbEmailRenderResponse'
11277
+
11278
+ # auth_names
11279
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11280
+
11281
+ new_options = opts.merge(
11282
+ :operation => :"SfvbApi.render_sfvb_email",
11283
+ :header_params => header_params,
11284
+ :query_params => query_params,
11285
+ :form_params => form_params,
11286
+ :body => post_body,
11287
+ :auth_names => auth_names,
11288
+ :return_type => return_type
11289
+ )
11290
+
11291
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11292
+ if @api_client.config.debugging
11293
+ @api_client.config.logger.debug "API called: SfvbApi#render_sfvb_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11294
+ end
11295
+ return data, status_code, headers
11296
+ end
11297
+
11298
+ # Render a transactional email without sending it
11299
+ # Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email's body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
11300
+ # @param storefront_oid [Integer]
11301
+ # @param file_name [String]
11302
+ # @param email_render_request [SfvbEmailRenderRequest] What to render the email with
11303
+ # @param [Hash] opts the optional parameters
11304
+ # @return [SfvbEmailRenderResponse]
11305
+ def render_sfvb_transactional_email(storefront_oid, file_name, email_render_request, opts = {})
11306
+ data, _status_code, _headers = render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request, opts)
11307
+ data
11308
+ end
11309
+
11310
+ # Render a transactional email without sending it
11311
+ # Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email&#39;s body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
11312
+ # @param storefront_oid [Integer]
11313
+ # @param file_name [String]
11314
+ # @param email_render_request [SfvbEmailRenderRequest] What to render the email with
11315
+ # @param [Hash] opts the optional parameters
11316
+ # @return [Array<(SfvbEmailRenderResponse, Integer, Hash)>] SfvbEmailRenderResponse data, response status code and response headers
11317
+ def render_sfvb_transactional_email_with_http_info(storefront_oid, file_name, email_render_request, opts = {})
11318
+ if @api_client.config.debugging
11319
+ @api_client.config.logger.debug 'Calling API: SfvbApi.render_sfvb_transactional_email ...'
11320
+ end
11321
+ # verify the required parameter 'storefront_oid' is set
11322
+ if @api_client.config.client_side_validation && storefront_oid.nil?
11323
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.render_sfvb_transactional_email"
11324
+ end
11325
+ # verify the required parameter 'file_name' is set
11326
+ if @api_client.config.client_side_validation && file_name.nil?
11327
+ fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.render_sfvb_transactional_email"
11328
+ end
11329
+ # verify the required parameter 'email_render_request' is set
11330
+ if @api_client.config.client_side_validation && email_render_request.nil?
11331
+ fail ArgumentError, "Missing the required parameter 'email_render_request' when calling SfvbApi.render_sfvb_transactional_email"
11332
+ end
11333
+ # resource path
11334
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}/render'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
11335
+
11336
+ # query parameters
11337
+ query_params = opts[:query_params] || {}
11338
+
11339
+ # header parameters
11340
+ header_params = opts[:header_params] || {}
11341
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11342
+ # HTTP header 'Accept' (if needed)
11343
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11344
+ # HTTP header 'Content-Type'
11345
+ content_type = @api_client.select_header_content_type(['application/json'])
11346
+ if !content_type.nil?
11347
+ header_params['Content-Type'] = content_type
11348
+ end
11349
+
11350
+ # form parameters
11351
+ form_params = opts[:form_params] || {}
11352
+
11353
+ # http body (model)
11354
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(email_render_request)
11355
+
11356
+ # return_type
11357
+ return_type = opts[:debug_return_type] || 'SfvbEmailRenderResponse'
11358
+
11359
+ # auth_names
11360
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11361
+
11362
+ new_options = opts.merge(
11363
+ :operation => :"SfvbApi.render_sfvb_transactional_email",
11364
+ :header_params => header_params,
11365
+ :query_params => query_params,
11366
+ :form_params => form_params,
11367
+ :body => post_body,
11368
+ :auth_names => auth_names,
11369
+ :return_type => return_type
11370
+ )
11371
+
11372
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11373
+ if @api_client.config.debugging
11374
+ @api_client.config.logger.debug "API called: SfvbApi#render_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11375
+ end
11376
+ return data, status_code, headers
11377
+ end
11378
+
11153
11379
  # Render a CJSON node to HTML
11154
11380
  # Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item. Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
11155
11381
  # @param storefront_oid [Integer]