ultracart_api 4.1.233 → 4.1.234

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: dea0377c91abc70344fa313cb83d06d12cd477b6e33e24e1a2e085e3046025d8
4
- data.tar.gz: 2b0c4b96fbd2ade73660101b6a1ce7ff17c4de207030cba15640218af07bffc6
3
+ metadata.gz: 75ffce8f1fa39e73d38e80da92b9873a7deaaf8fbfe5f4fc4f1598423cb0b990
4
+ data.tar.gz: 0a4895f146c296ead35e15f72ec0f51352757a35992ff03cac97864c24f40ab9
5
5
  SHA512:
6
- metadata.gz: eecaed9c534531fa3298b17b68f89a22804f97f17238841b8bd58615173627ce3fe09efa81350658a9fd344665f8850cfda5fb667ebd06b1f6441517c5a1c19b
7
- data.tar.gz: 770c6bf348349aab6a379e8e05ffa488957474477997ff9aefeed7abf1a3a33fe45f171a3029183969c2540abcefd33ab1e39502ebcb02badbdc07c8f4bfc0b4
6
+ metadata.gz: 6e8447c9f9cfc8fc2829b3cf6a4d92b11ab6cd06967a1e4a4cd5c9eae1e35c5a877cc1fbff9d08d7080c7a752fcf99cc60047f40b7eeb225c04ee9c9ee3adfec
7
+ data.tar.gz: 8e269bf1158c46beba9a0d44408ec031c76f39fe9e7f7c7d5bd5ca89b56eb517ffff52405925248fe96a1f7c002e20392030be8ef770a474d6bef71e33030907
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.233
10
+ - Package version: 4.1.234
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.233'
19
+ gem 'ultracart_api', '4.1.234'
20
20
  ```
21
21
 
22
22
  install:
@@ -699,6 +699,7 @@ Class | Method | HTTP request | Description
699
699
  *UltracartClient::SfvbApi* | [**put_sfvb_page_selectors**](docs/SfvbApi.md#put_sfvb_page_selectors) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/selectors | Replace a page's selectors
700
700
  *UltracartClient::SfvbApi* | [**put_sfvb_page_settings**](docs/SfvbApi.md#put_sfvb_page_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/settings | Change a page's settings
701
701
  *UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
702
+ *UltracartClient::SfvbApi* | [**put_sfvb_preview_tracking_html**](docs/SfvbApi.md#put_sfvb_preview_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/tracking_html | Stage custom tracking HTML in a preview session
702
703
  *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
703
704
  *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
704
705
  *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
@@ -707,6 +708,7 @@ Class | Method | HTTP request | Description
707
708
  *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
708
709
  *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
709
710
  *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
711
+ *UltracartClient::SfvbApi* | [**render_sfvb_tracking_html**](docs/SfvbApi.md#render_sfvb_tracking_html) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot}/render | Render the Conversion HTML against a test order
710
712
  *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
711
713
  *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
712
714
  *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
@@ -2224,6 +2226,7 @@ Class | Method | HTTP request | Description
2224
2226
  - [UltracartClient::SfvbPreviewAccessResponse](docs/SfvbPreviewAccessResponse.md)
2225
2227
  - [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
2226
2228
  - [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
2229
+ - [UltracartClient::SfvbPreviewTrackingHtmlRequest](docs/SfvbPreviewTrackingHtmlRequest.md)
2227
2230
  - [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
2228
2231
  - [UltracartClient::SfvbRecording](docs/SfvbRecording.md)
2229
2232
  - [UltracartClient::SfvbRecordingEvent](docs/SfvbRecordingEvent.md)
@@ -2314,6 +2317,8 @@ Class | Method | HTTP request | Description
2314
2317
  - [UltracartClient::SfvbTrackingAdvancedRequest](docs/SfvbTrackingAdvancedRequest.md)
2315
2318
  - [UltracartClient::SfvbTrackingChange](docs/SfvbTrackingChange.md)
2316
2319
  - [UltracartClient::SfvbTrackingHtml](docs/SfvbTrackingHtml.md)
2320
+ - [UltracartClient::SfvbTrackingHtmlRenderRequest](docs/SfvbTrackingHtmlRenderRequest.md)
2321
+ - [UltracartClient::SfvbTrackingHtmlRenderResponse](docs/SfvbTrackingHtmlRenderResponse.md)
2317
2322
  - [UltracartClient::SfvbTrackingHtmlRequest](docs/SfvbTrackingHtmlRequest.md)
2318
2323
  - [UltracartClient::SfvbTrackingHtmlResponse](docs/SfvbTrackingHtmlResponse.md)
2319
2324
  - [UltracartClient::SfvbTrackingPrivacy](docs/SfvbTrackingPrivacy.md)
@@ -2527,6 +2532,7 @@ Not every change is committed to every SDK.
2527
2532
 
2528
2533
  | Version | Date | Comments |
2529
2534
  | --: | :-: | --- |
2535
+ | 4.1.234 | 11/09/2026 | sfvb internal testing |
2530
2536
  | 4.1.233 | 11/06/2026 | sfvb internal testing |
2531
2537
  | 4.1.232 | 11/05/2026 | sfvb internal testing |
2532
2538
  | 4.1.231 | 11/05/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -227,6 +227,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
227
227
  | [**put_sfvb_page_selectors**](SfvbApi.md#put_sfvb_page_selectors) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/selectors | Replace a page's selectors |
228
228
  | [**put_sfvb_page_settings**](SfvbApi.md#put_sfvb_page_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/settings | Change a page's settings |
229
229
  | [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
230
+ | [**put_sfvb_preview_tracking_html**](SfvbApi.md#put_sfvb_preview_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/tracking_html | Stage custom tracking HTML in a preview session |
230
231
  | [**put_sfvb_recording_settings**](SfvbApi.md#put_sfvb_recording_settings) | **PUT** /sfvb/storefronts/{storefront_oid}/recording_settings | Turn the storefront's screen recording on or off |
231
232
  | [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
232
233
  | [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings |
@@ -235,6 +236,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
235
236
  | [**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 |
236
237
  | [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
237
238
  | [**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 |
239
+ | [**render_sfvb_tracking_html**](SfvbApi.md#render_sfvb_tracking_html) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot}/render | Render the Conversion HTML against a test order |
238
240
  | [**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 |
239
241
  | [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
240
242
  | [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
@@ -2430,11 +2432,11 @@ nil (empty response body)
2430
2432
 
2431
2433
  ## delete_sfvb_tracking_provider
2432
2434
 
2433
- > <SfvbTrackingProvider> delete_sfvb_tracking_provider(storefront_oid, provider, if_match)
2435
+ > <SfvbTrackingProvider> delete_sfvb_tracking_provider(storefront_oid, provider, if_match, opts)
2434
2436
 
2435
2437
  Clear one tracking provider
2436
2438
 
2437
- Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider's hash_sha256 as If-Match. Needs sfvb_publish. No approval.
2439
+ Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider's hash_sha256 as If-Match. Needs sfvb_publish. dry_run=true reports the changes, and approval_needed, without clearing. No approval, except when the clear removes a consent gate while something outside the provider's fields still fires it (Google Ads for an affiliate's own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id).
2438
2440
 
2439
2441
 
2440
2442
  ### Examples
@@ -2447,12 +2449,12 @@ Clears every field and secret the API can change, the consent gate and the event
2447
2449
 
2448
2450
  This returns an Array which contains the response data, status code and headers.
2449
2451
 
2450
- > <Array(<SfvbTrackingProvider>, Integer, Hash)> delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match)
2452
+ > <Array(<SfvbTrackingProvider>, Integer, Hash)> delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, opts)
2451
2453
 
2452
2454
  ```ruby
2453
2455
  begin
2454
2456
  # Clear one tracking provider
2455
- data, status_code, headers = api_instance.delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match)
2457
+ data, status_code, headers = api_instance.delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, opts)
2456
2458
  p status_code # => 2xx
2457
2459
  p headers # => { ... }
2458
2460
  p data # => <SfvbTrackingProvider>
@@ -2468,6 +2470,8 @@ end
2468
2470
  | **storefront_oid** | **Integer** | | |
2469
2471
  | **provider** | **String** | | |
2470
2472
  | **if_match** | **String** | The provider&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
2473
+ | **dry_run** | **Boolean** | | [optional] |
2474
+ | **approval_id** | **String** | When the clear removes a consent gate while something else still fires the provider, the approval_id of an approved tracking_provider.clear request for it. See POST /sfvb/approvals. | [optional] |
2471
2475
 
2472
2476
  ### Return type
2473
2477
 
@@ -4601,7 +4605,7 @@ end
4601
4605
 
4602
4606
  Find which storefront a communications uuid lives on
4603
4607
 
4604
- Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account's storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account's included, is 404. Read only.
4608
+ Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account's storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one. A uuid nothing on this account has, another account's included, and a deleted step, email, postcard, list or segment, is 404. Read only.
4605
4609
 
4606
4610
 
4607
4611
  ### Examples
@@ -12450,6 +12454,61 @@ end
12450
12454
  - **Accept**: application/json
12451
12455
 
12452
12456
 
12457
+ ## put_sfvb_preview_tracking_html
12458
+
12459
+ > <SfvbTrackingHtmlResponse> put_sfvb_preview_tracking_html(storefront_oid, preview_session_id, preview_tracking_html)
12460
+
12461
+ Stage custom tracking HTML in a preview session
12462
+
12463
+ Runs Tracking HTML, Conversion HTML or both instead of the storefront's live slots, only in a browser that opened this session's preview access link, so a page can be checked before the write is approved. Staged Conversion HTML runs only on a test order's receipt. Each slot gets the same checks as a write. An empty string unstages a slot; a slot left out is left as it is. Containers pushed to the session later keep what is staged. Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user's own session runs it.
12464
+
12465
+
12466
+ ### Examples
12467
+
12468
+
12469
+ (No example for this operation).
12470
+
12471
+
12472
+ #### Using the put_sfvb_preview_tracking_html_with_http_info variant
12473
+
12474
+ This returns an Array which contains the response data, status code and headers.
12475
+
12476
+ > <Array(<SfvbTrackingHtmlResponse>, Integer, Hash)> put_sfvb_preview_tracking_html_with_http_info(storefront_oid, preview_session_id, preview_tracking_html)
12477
+
12478
+ ```ruby
12479
+ begin
12480
+ # Stage custom tracking HTML in a preview session
12481
+ data, status_code, headers = api_instance.put_sfvb_preview_tracking_html_with_http_info(storefront_oid, preview_session_id, preview_tracking_html)
12482
+ p status_code # => 2xx
12483
+ p headers # => { ... }
12484
+ p data # => <SfvbTrackingHtmlResponse>
12485
+ rescue UltracartClient::ApiError => e
12486
+ puts "Error when calling SfvbApi->put_sfvb_preview_tracking_html_with_http_info: #{e}"
12487
+ end
12488
+ ```
12489
+
12490
+ ### Parameters
12491
+
12492
+ | Name | Type | Description | Notes |
12493
+ | ---- | ---- | ----------- | ----- |
12494
+ | **storefront_oid** | **Integer** | | |
12495
+ | **preview_session_id** | **String** | | |
12496
+ | **preview_tracking_html** | [**SfvbPreviewTrackingHtmlRequest**](SfvbPreviewTrackingHtmlRequest.md) | The HTML to stage | |
12497
+
12498
+ ### Return type
12499
+
12500
+ [**SfvbTrackingHtmlResponse**](SfvbTrackingHtmlResponse.md)
12501
+
12502
+ ### Authorization
12503
+
12504
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12505
+
12506
+ ### HTTP request headers
12507
+
12508
+ - **Content-Type**: application/json; charset=UTF-8
12509
+ - **Accept**: application/json
12510
+
12511
+
12453
12512
  ## put_sfvb_recording_settings
12454
12513
 
12455
12514
  > <SfvbRecordingSettingsResponse> put_sfvb_recording_settings(storefront_oid, recording_settings_request)
@@ -12885,6 +12944,61 @@ end
12885
12944
  - **Accept**: application/json
12886
12945
 
12887
12946
 
12947
+ ## render_sfvb_tracking_html
12948
+
12949
+ > <SfvbTrackingHtmlRenderResponse> render_sfvb_tracking_html(storefront_oid, slot, tracking_html_render_request)
12950
+
12951
+ Render the Conversion HTML against a test order
12952
+
12953
+ The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper. Renders the stored slot, or content when it is sent (a draft, checked as a write is). Only a test order on this account may be used; a real or unknown order is refused the same way. Nothing is saved, injected or sent: the receipt's provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written. Only the conversion slot renders; tracking HTML is checked by staging it in a preview session.
12954
+
12955
+
12956
+ ### Examples
12957
+
12958
+
12959
+ (No example for this operation).
12960
+
12961
+
12962
+ #### Using the render_sfvb_tracking_html_with_http_info variant
12963
+
12964
+ This returns an Array which contains the response data, status code and headers.
12965
+
12966
+ > <Array(<SfvbTrackingHtmlRenderResponse>, Integer, Hash)> render_sfvb_tracking_html_with_http_info(storefront_oid, slot, tracking_html_render_request)
12967
+
12968
+ ```ruby
12969
+ begin
12970
+ # Render the Conversion HTML against a test order
12971
+ data, status_code, headers = api_instance.render_sfvb_tracking_html_with_http_info(storefront_oid, slot, tracking_html_render_request)
12972
+ p status_code # => 2xx
12973
+ p headers # => { ... }
12974
+ p data # => <SfvbTrackingHtmlRenderResponse>
12975
+ rescue UltracartClient::ApiError => e
12976
+ puts "Error when calling SfvbApi->render_sfvb_tracking_html_with_http_info: #{e}"
12977
+ end
12978
+ ```
12979
+
12980
+ ### Parameters
12981
+
12982
+ | Name | Type | Description | Notes |
12983
+ | ---- | ---- | ----------- | ----- |
12984
+ | **storefront_oid** | **Integer** | | |
12985
+ | **slot** | **String** | conversion | |
12986
+ | **tracking_html_render_request** | [**SfvbTrackingHtmlRenderRequest**](SfvbTrackingHtmlRenderRequest.md) | The test order, and optionally a draft | |
12987
+
12988
+ ### Return type
12989
+
12990
+ [**SfvbTrackingHtmlRenderResponse**](SfvbTrackingHtmlRenderResponse.md)
12991
+
12992
+ ### Authorization
12993
+
12994
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12995
+
12996
+ ### HTTP request headers
12997
+
12998
+ - **Content-Type**: application/json; charset=UTF-8
12999
+ - **Accept**: application/json
13000
+
13001
+
12888
13002
  ## render_sfvb_transactional_email
12889
13003
 
12890
13004
  > <SfvbEmailRenderResponse> render_sfvb_transactional_email(storefront_oid, file_name, email_render_request)
@@ -24,7 +24,7 @@
24
24
  | **side** | **String** | For sequence_step.move with branch_step_uuid, the side&#39;s label from the sequence read. | [optional] |
25
25
  | **slot** | **String** | For experiment.start of a page experiment, the page body name, which defaults to body. For tracking_html.put, tracking or conversion. | [optional] |
26
26
  | **step_uuid** | **String** | The step to remove, for sequence_step.delete, to move, for sequence_step.move, or to turn on, for sequence_step.enable_postcard. | [optional] |
27
- | **tracking_provider** | **String** | The tracking provider key, for tracking_provider.change. | [optional] |
27
+ | **tracking_provider** | **String** | The tracking provider key, for tracking_provider.change and tracking_provider.clear. | [optional] |
28
28
  | **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
29
29
  | **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
30
30
  | **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **archived** | **Boolean** | True when the campaign or flow is archived. It sends nothing, and &#39;sf comms flows list&#39; or &#39;campaigns list&#39; shows it only with --include-deleted. | [optional] |
7
8
  | **live** | **Boolean** | True when it is sending now, by the same rule the sequence read uses. | [optional] |
8
9
  | **name** | **String** | Its name. | [optional] |
9
10
  | **status** | **String** | Its status as stored. | [optional] |
@@ -16,6 +17,7 @@
16
17
  require 'ultracart_api'
17
18
 
18
19
  instance = UltracartClient::SfvbCommsLookupOwner.new(
20
+ archived: null,
19
21
  live: null,
20
22
  name: null,
21
23
  status: null,
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **archived** | **Boolean** | True when the uuid is an archived campaign or flow. It is still on its storefront and can be read; it sends nothing. | [optional] |
7
8
  | **communication_sequence_uuid** | **String** | The sequence it belongs to, when there is one. | [optional] |
8
9
  | **kind** | **String** | campaign, flow, sequence, step, email, postcard, list or segment. | [optional] |
9
10
  | **name** | **String** | The campaign, flow, list or segment name, or the email subject. | [optional] |
@@ -20,6 +21,7 @@
20
21
  require 'ultracart_api'
21
22
 
22
23
  instance = UltracartClient::SfvbCommsLookupResponse.new(
24
+ archived: null,
23
25
  communication_sequence_uuid: null,
24
26
  kind: null,
25
27
  name: null,
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbPreviewTrackingHtmlRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversion_html** | **String** | Conversion HTML to run instead of the live slot on a test order&#39;s receipt opened through this session&#39;s preview access link. Never on a real order&#39;s receipt. An empty string unstages it. The same checks as a write apply. | [optional] |
8
+ | **tracking_html** | **String** | Tracking HTML to run instead of the live slot on pages opened through this session&#39;s preview access link. An empty string unstages it. The same checks as a write apply. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbPreviewTrackingHtmlRequest.new(
16
+ conversion_html: null,
17
+ tracking_html: null
18
+ )
19
+ ```
20
+
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **app_error** | **Boolean** | True when the render itself failed and the page could not be produced. | [optional] |
8
8
  | **duration_ms** | **Integer** | How long the render took in milliseconds. | [optional] |
9
- | **error_count** | **Integer** | Error lines in the log, including Velocity problems such as a null | [optional] |
9
+ | **error_count** | **Integer** | Error lines in the log, including Velocity problems such as setting a variable to null. | [optional] |
10
10
  | **line_count** | **Integer** | Lines in the full log text. | [optional] |
11
11
  | **log_id** | **String** | Opaque id of this log. Pass it to the get endpoint. Preview pages send the same id in the X-UltraCart-Storefront-Log-Id response header. | [optional] |
12
12
  | **request_template** | **String** | The template the page rendered with, when known. | [optional] |
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbTrackingHtmlRenderRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content** | **String** | HTML to render instead of the stored slot, such as a draft about to be written. The same checks as a write apply. Left out, the stored slot is rendered. | [optional] |
8
+ | **order_id** | **String** | A test order on this account, as sf orders test-orders lists them. A real or unknown order is refused the same way. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbTrackingHtmlRenderRequest.new(
16
+ content: null,
17
+ order_id: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,32 @@
1
+ # UltracartClient::SfvbTrackingHtmlRenderResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content_sha256** | **String** | The SHA-256 of the HTML rendered, before rendering, as the slot would store it. For a draft, the hash a tracking_html.put approval binds. | [optional] |
8
+ | **html** | **String** | The rendered HTML, with order tokens filled and Velocity run, as the receipt would inject it. Empty when the slot is empty. | [optional] |
9
+ | **order_id** | **String** | The test order rendered against. | [optional] |
10
+ | **provides** | **Array&lt;String&gt;** | The Velocity references the render provides. Any other reference the receipt page has is left as written. | [optional] |
11
+ | **size_bytes** | **Integer** | The size of html in UTF-8 bytes. | [optional] |
12
+ | **slot** | **String** | The slot rendered. Always conversion. | [optional] |
13
+ | **source** | **String** | stored when the slot&#39;s saved HTML was rendered, draft when the request&#39;s content was. | [optional] |
14
+ | **warnings** | [**Array&lt;SfvbErrorDetail&gt;**](SfvbErrorDetail.md) | What the render left out or could not do, such as tokens it doesn&#39;t fill. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::SfvbTrackingHtmlRenderResponse.new(
22
+ content_sha256: null,
23
+ html: null,
24
+ order_id: null,
25
+ provides: null,
26
+ size_bytes: null,
27
+ slot: null,
28
+ source: null,
29
+ warnings: null
30
+ )
31
+ ```
32
+
@@ -20,6 +20,7 @@
20
20
  | **name** | **String** | The name the admin shows. | [optional] |
21
21
  | **notes** | **Array&lt;String&gt;** | Anything the write left for a person to do, such as disconnecting an OAuth connection in the admin. | [optional] |
22
22
  | **oauth** | [**SfvbTrackingProviderOauth**](SfvbTrackingProviderOauth.md) | | [optional] |
23
+ | **server_side** | **String** | What the provider also sends from UltraCart&#39;s servers. A consent gate holds back only the browser pixel, not these. Absent when it sends nothing server side. | [optional] |
23
24
  | **wholesale_tiers** | [**Array&lt;SfvbTrackingWholesaleTier&gt;**](SfvbTrackingWholesaleTier.md) | For google_analytics, the account number per wholesale pricing tier. | [optional] |
24
25
 
25
26
  ## Example
@@ -44,6 +45,7 @@ instance = UltracartClient::SfvbTrackingProvider.new(
44
45
  name: null,
45
46
  notes: null,
46
47
  oauth: null,
48
+ server_side: null,
47
49
  wholesale_tiers: null
48
50
  )
49
51
  ```