ultracart_api 4.1.222 → 4.1.224

data/docs/SfvbApprovalCreateRequest.md

@@ -5,7 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **action** | **String** | The gated action to approve. | [optional] |
-| **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB.  UltraCart reviews it and keeps only its hash, so send the same bytes again on the write.  Leave it out for a revert, which names params.version. | [optional] |
+| **affiliate_network** | [**SfvbAffiliateNetworkRequest**](SfvbAffiliateNetworkRequest.md) |  | [optional] |
+| **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB.  For tracking_html.put, the exact HTML the write will send, at most 256 KB.  UltraCart reviews it and keeps only its hash, so send the same bytes again on the write.  Leave it out for a revert, which names params.version. | [optional] |
 | **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) |  | [optional] |
 | **item_attribute_rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256.  UltraCart keeps only their hash. | [optional] |
 | **item_pricing** | [**SfvbItemPricingRequest**](SfvbItemPricingRequest.md) |  | [optional] |
@@ -13,6 +14,8 @@
 | **reason** | **String** | Why the agent wants to do this, in a sentence.  Shown to the person as unverified text, capped at 500 characters. | [optional] |
 | **redirect_rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256.  UltraCart keeps only their hash. | [optional] |
 | **segment_update** | [**SfvbCommsSegmentWriteRequest**](SfvbCommsSegmentWriteRequest.md) |  | [optional] |
+| **smart_attribution** | [**SfvbSmartAttributionRequest**](SfvbSmartAttributionRequest.md) |  | [optional] |
+| **tracking_provider** | [**SfvbTrackingProviderRequest**](SfvbTrackingProviderRequest.md) |  | [optional] |
 
 ## Example
 
@@ -21,6 +24,7 @@ require 'ultracart_api'
 
 instance = UltracartClient::SfvbApprovalCreateRequest.new(
   action: null,
+  affiliate_network: null,
   content: null,
   experiment_start: null,
   item_attribute_rows: null,
@@ -28,7 +32,9 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
   params: null,
   reason: null,
   redirect_rows: null,
-  segment_update: null
+  segment_update: null,
+  smart_attribution: null,
+  tracking_provider: null
 )
 ```
 

data/docs/SfvbApprovalParams.md

@@ -4,25 +4,27 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **affiliate_network_oid** | **Integer** | The affiliate network, for affiliate_network.change and affiliate_network.delete.  0 or left out for affiliate_network.change of a network the create call will add. | [optional] |
 | **after_step_uuid** | **String** | For sequence_step.move, the step it moves after.  Or branch_step_uuid with side. | [optional] |
 | **attribute_names** | **Array<String>** | For item.attribute_batch, the attributes the batch would change.  Set by the server. | [optional] |
 | **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
 | **branch_step_uuid** | **String** | For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of. | [optional] |
-| **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved.  Set by the server, never by the caller.  The write must send bytes with this hash. | [optional] |
+| **content_sha256** | **String** | For file.put_script and tracking_html.put, the SHA-256 of the exact bytes approved, and for affiliate_network.change the SHA-256 of the conversion pixel.  Set by the server, never by the caller.  The write must send bytes with this hash. | [optional] |
 | **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
 | **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account's esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
 | **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
 | **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested.  Set by the server. | [optional] |
 | **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
 | **path** | **String** | The file path, for file.delete and file.put_script, or the page path for experiment.start of a page experiment.  Exactly as the gated call will send it. | [optional] |
-| **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, and for item.pricing the hash of the change.  Set by the server.  The gated call must send the same. | [optional] |
+| **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, for item.pricing, tracking_provider.change and affiliate_network.change the hash of the change, and for smart_attribution.change the hash of the configuration the change would store.  Set by the server.  The gated call must send the same. | [optional] |
 | **rows_sha256** | **String** | For redirect.delete_batch and item.attribute_batch, the plan_hash of the exact rows approved.  Set by the server.  The batch must send rows with this hash. | [optional] |
 | **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested.  Set by the server. | [optional] |
 | **segment_uuid** | **String** | The segment whose rule changes, for segment.update. | [optional] |
 | **sequence_uuid** | **String** | The communication sequence, for sequence_step.delete, sequence_step.move and sequence_step.enable_postcard. | [optional] |
 | **side** | **String** | For sequence_step.move with branch_step_uuid, the side's label from the sequence read. | [optional] |
-| **slot** | **String** | For experiment.start of a page experiment, the page body name.  Defaults to body. | [optional] |
+| **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] |
 | **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] |
+| **tracking_provider** | **String** | The tracking provider key, for tracking_provider.change. | [optional] |
 | **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
 | **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
 | **version** | **Integer** | For file.put_script, the history version a revert restores.  Leave it out, and send content instead, for a write. | [optional] |
@@ -35,6 +37,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::SfvbApprovalParams.new(
+  affiliate_network_oid: null,
   after_step_uuid: null,
   attribute_names: null,
   blog_post_oid: null,
@@ -54,6 +57,7 @@ instance = UltracartClient::SfvbApprovalParams.new(
   side: null,
   slot: null,
   step_uuid: null,
+  tracking_provider: null,
   upsell_kind: null,
   upsell_oid: null,
   version: null,

data/docs/SfvbContainerResponse.md

@@ -11,6 +11,7 @@
 | **merchant_item_id** | **String** | The merchant item id of the owning item, for item containers only and absent for every other owner type.  owner_object_id is the item oid, which appears nowhere on a rendered storefront, so this is how a caller confirms which item an oid actually reached.  It is read fresh on every call and so reflects a renamed item.  A container's own id embeds this value, which is what a preview session keys an item container on. | [optional] |
 | **owner_object_id** | **String** | Identifier of the owning object within its store. | [optional] |
 | **owner_type** | **String** | Where this container lives. | [optional] |
+| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Quality warnings from validating this write.  The write succeeded; each one says what to look at, such as a postcard QR code URL with a fragment.  Absent when there are none. | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = UltracartClient::SfvbContainerResponse.new(
   last_modified: null,
   merchant_item_id: null,
   owner_object_id: null,
-  owner_type: null
+  owner_type: null,
+  warnings: null
 )
 ```
 

data/docs/SfvbSmartAttribution.md

@@ -0,0 +1,38 @@
+# UltracartClient::SfvbSmartAttribution
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assist_percent** | **Float** | The global assist credit, 0 to 1. | [optional] |
+| **attribution_model** | **String** | position_based, linear, time_decay or custom. | [optional] |
+| **available_platforms** | [**Array<SfvbSmartAttributionPlatform>**](SfvbSmartAttributionPlatform.md) | Platforms detected from the storefront's tracking integrations that are not configured yet, with suggested settings. | [optional] |
+| **closer_percent** | **Float** | The global closer credit, 0 to 1. | [optional] |
+| **configured** | **Boolean** | True when the storefront has a saved configuration.  When false, the other fields are the defaults an enable would save. | [optional] |
+| **hash_sha256** | **String** | The hash of the configuration.  Send it as If-Match when changing or deleting it. | [optional] |
+| **lookback_days** | **Integer** | How many days of a shopper's visits count toward an order, 7 to 365. | [optional] |
+| **mode** | **String** | disabled, report_only (decisions are recorded but every platform reports as before) or active (Smart Attribution decides whether each platform's conversion fires and what value it reports). | [optional] |
+| **originator_percent** | **Float** | The global originator credit, 0 to 1.  The three global percentages total exactly 1. | [optional] |
+| **platforms** | [**Array<SfvbSmartAttributionPlatform>**](SfvbSmartAttributionPlatform.md) | The configured platforms. | [optional] |
+| **storefront_oid** | **Integer** | The storefront this configuration belongs to. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSmartAttribution.new(
+  assist_percent: null,
+  attribution_model: null,
+  available_platforms: null,
+  closer_percent: null,
+  configured: null,
+  hash_sha256: null,
+  lookback_days: null,
+  mode: null,
+  originator_percent: null,
+  platforms: null,
+  storefront_oid: null
+)
+```
+

data/docs/SfvbSmartAttributionPlatform.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbSmartAttributionPlatform
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assist_percent** | **Float** | This platform's assist credit, 0 to 1.  Used only when platform_type_override is true. | [optional] |
+| **closer_percent** | **Float** | This platform's closer credit, 0 to 1.  Used only when platform_type_override is true. | [optional] |
+| **fire_on_rebill** | **Boolean** | True when the platform also reports auto order rebills.  On a write, when left out, true for paid and owned and false for the affiliate types. | [optional] |
+| **integration_id** | **Integer** | The integration's id, such as an affiliate network pixel's oid.  Null for a platform matched by name.  On a write it must be an id from platforms or available_platforms. | [optional] |
+| **integration_name** | **String** | The platform, as Smart Attribution names it, up to 50 characters. | [optional] |
+| **non_participant_percent** | **Float** | The credit this platform reports for an order it took no part in, 0 to 1.  0 when left out. | [optional] |
+| **originator_percent** | **Float** | This platform's originator credit, 0 to 1.  Used only when platform_type_override is true. | [optional] |
+| **platform_type** | **String** | paid, owned, external affiliate, affiliate network pixel, or excluded. | [optional] |
+| **platform_type_override** | **Boolean** | True when this platform uses its own originator, assist and closer split instead of the global one.  On a write, when left out, true if all three of its percentages are sent. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSmartAttributionPlatform.new(
+  assist_percent: null,
+  closer_percent: null,
+  fire_on_rebill: null,
+  integration_id: null,
+  integration_name: null,
+  non_participant_percent: null,
+  originator_percent: null,
+  platform_type: null,
+  platform_type_override: null
+)
+```
+

data/docs/SfvbSmartAttributionRequest.md

@@ -0,0 +1,30 @@
+# UltracartClient::SfvbSmartAttributionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assist_percent** | **Float** | 0 to 1, at most 4 decimals. | [optional] |
+| **attribution_model** | **String** | position_based, linear, time_decay or custom. | [optional] |
+| **closer_percent** | **Float** | 0 to 1, at most 4 decimals. | [optional] |
+| **lookback_days** | **Integer** | 7 to 365. | [optional] |
+| **mode** | **String** | disabled, report_only or active.  Making it active, or any change while it is active, needs an approval. | [optional] |
+| **originator_percent** | **Float** | 0 to 1, at most 4 decimals.  The three global percentages must total exactly 1, so send all three to change the split. | [optional] |
+| **platforms** | [**Array<SfvbSmartAttributionPlatform>**](SfvbSmartAttributionPlatform.md) | When sent, replaces the whole platform list.  Up to 100, each name and id once.  Left out, the list is unchanged. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbSmartAttributionRequest.new(
+  assist_percent: null,
+  attribution_model: null,
+  closer_percent: null,
+  lookback_days: null,
+  mode: null,
+  originator_percent: null,
+  platforms: null
+)
+```
+

data/docs/SfvbTrackingAdvanced.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbTrackingAdvanced
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **catalog_url** | **String** | The override for the storefront's catalog URL (the admin's Override Catalog URL).  A path starting with / or an absolute http or https URL, up to 250 characters.  Null when not overridden. | [optional] |
+| **continue_shopping_url** | **String** | Where the continue shopping button goes instead of the default.  A path starting with / or an absolute http or https URL, up to 250 characters.  Null when not overridden. | [optional] |
+| **conversion_pixel_only_if_paid** | **Boolean** | True when the receipt's conversion HTML runs only for orders whose payment succeeded. | [optional] |
+| **default_currency** | **String** | The storefront's default currency code, one of the response's currencies.  Null when not set. | [optional] |
+| **hash_sha256** | **String** | The hash of the seven writable settings.  Send it as If-Match when changing them. | [optional] |
+| **omit_order_data** | **Boolean** | True when the order data is left off the custom thank you URL. | [optional] |
+| **order_hash_secret_key_set** | **Boolean** | True when the account has an order hash secret key.  The key is shared by every storefront on the account, is never returned, and is changed only in the admin.  Null when it could not be checked. | [optional] |
+| **payment_pending_url** | **String** | Where the shopper goes when the order's payment is still pending.  A path starting with / or an absolute http or https URL, up to 500 characters.  Null when not set. | [optional] |
+| **thank_you_url** | **String** | Where the shopper goes after placing an order, instead of the built-in receipt.  A path starting with / or an absolute http or https URL, up to 500 characters.  Null for the built-in receipt. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingAdvanced.new(
+  catalog_url: null,
+  continue_shopping_url: null,
+  conversion_pixel_only_if_paid: null,
+  default_currency: null,
+  hash_sha256: null,
+  omit_order_data: null,
+  order_hash_secret_key_set: null,
+  payment_pending_url: null,
+  thank_you_url: null
+)
+```
+

data/docs/SfvbTrackingAdvancedRequest.md

@@ -0,0 +1,34 @@
+# UltracartClient::SfvbTrackingAdvancedRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **catalog_url** | **String** | A path starting with / or an absolute http or https URL, up to 250 characters. | [optional] |
+| **continue_shopping_url** | **String** | A path starting with / or an absolute http or https URL, up to 250 characters. | [optional] |
+| **conversion_pixel_only_if_paid** | **Boolean** | True to run the receipt's conversion HTML only for orders whose payment succeeded. | [optional] |
+| **default_currency** | **String** | A currency code from the read's currencies. | [optional] |
+| **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
+| **omit_order_data** | **Boolean** | True to leave the order data off the custom thank you URL. | [optional] |
+| **payment_pending_url** | **String** | A path starting with / or an absolute http or https URL, up to 500 characters. | [optional] |
+| **thank_you_url** | **String** | A path starting with / or an absolute http or https URL, up to 500 characters. | [optional] |
+| **unset** | **Array<String>** | Text settings to clear, by key.  continue_shopping_url, catalog_url, thank_you_url, payment_pending_url or default_currency.  Not with a value for the same key. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingAdvancedRequest.new(
+  catalog_url: null,
+  continue_shopping_url: null,
+  conversion_pixel_only_if_paid: null,
+  default_currency: null,
+  dry_run: null,
+  omit_order_data: null,
+  payment_pending_url: null,
+  thank_you_url: null,
+  unset: null
+)
+```
+

data/docs/SfvbTrackingChange.md

@@ -0,0 +1,24 @@
+# UltracartClient::SfvbTrackingChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | The value before.  Null when it was not set.  Booleans are true or false. | [optional] |
+| **key** | **String** | The setting's key, as the read names it. | [optional] |
+| **section** | **String** | What the setting belongs to.  privacy or advanced for the tracking settings, the provider's key for a tracking provider, or affiliate_network. | [optional] |
+| **to** | **String** | The value after.  Null when it is cleared.  Booleans are true or false. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingChange.new(
+  from: null,
+  key: null,
+  section: null,
+  to: null
+)
+```
+

data/docs/SfvbTrackingHtml.md

@@ -0,0 +1,36 @@
+# UltracartClient::SfvbTrackingHtml
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_needed** | **Boolean** | On a dry run, whether the real write needs an approved tracking_html.put request. | [optional] |
+| **changed** | **Boolean** | On a write, whether the slot changed.  False when the content was already the same. | [optional] |
+| **content** | **String** | The HTML, with its Velocity tokens as stored.  Only on a read of one slot and on a write.  Null when empty. | [optional] |
+| **dry_run** | **Boolean** | On a write, true when nothing was saved. | [optional] |
+| **hash_sha256** | **String** | The SHA-256 of the HTML as UTF-8, the hash of an empty string when empty.  Send it as If-Match on the write. | [optional] |
+| **label** | **String** | The slot's name in the admin. | [optional] |
+| **runs_on** | **String** | Where the storefront injects it, in words. | [optional] |
+| **set** | **Boolean** | True when the slot holds any HTML. | [optional] |
+| **size_bytes** | **Integer** | The size of the HTML in UTF-8 bytes.  0 when empty. | [optional] |
+| **slot** | **String** | tracking is injected into every page except the receipt.  conversion is injected into the receipt only. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingHtml.new(
+  approval_needed: null,
+  changed: null,
+  content: null,
+  dry_run: null,
+  hash_sha256: null,
+  label: null,
+  runs_on: null,
+  set: null,
+  size_bytes: null,
+  slot: null
+)
+```
+

data/docs/SfvbTrackingHtmlRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbTrackingHtmlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** | The whole HTML the slot will hold, at most 256 KB as UTF-8.  An empty string empties the slot, which needs no approval.  Anything else needs an approved tracking_html.put request for exactly these bytes. | [optional] |
+| **dry_run** | **Boolean** | True to check the write and say whether it needs an approval, without saving. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingHtmlRequest.new(
+  content: null,
+  dry_run: null
+)
+```
+

data/docs/SfvbTrackingHtmlResponse.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbTrackingHtmlResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_bytes** | **Integer** | The largest HTML the API writes to a slot, in UTF-8 bytes.  The admin allows larger, but UltraCart's review must read the whole of it. | [optional] |
+| **slots** | [**Array<SfvbTrackingHtml>**](SfvbTrackingHtml.md) | tracking and conversion, each with its size and hash_sha256.  Read one slot for its content. | [optional] |
+| **storefront_oid** | **Integer** | The storefront. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingHtmlResponse.new(
+  max_bytes: null,
+  slots: null,
+  storefront_oid: null
+)
+```
+

data/docs/SfvbTrackingPrivacy.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbTrackingPrivacy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **anonymize_ip** | **String** | Which shoppers have their IP address anonymized on the cart and order.  all, eea, non_us, or null for nobody. | [optional] |
+| **default_mailing_list_off** | **String** | Which shoppers start checkout with the mailing list sign-up unchecked.  all, eea, non_us, or null for nobody. | [optional] |
+| **disable_return_email** | **String** | Which shoppers are left out of the return email (the admin's Disable Return Email rule).  all, eea, non_us, or null for nobody. | [optional] |
+| **exclude_purchase_bubble_history** | **String** | Which shoppers' purchases are left out of the purchase bubble history.  all, eea, non_us, or null for nobody. | [optional] |
+| **hash_sha256** | **String** | The hash of these five rules.  Send it as If-Match when changing them. | [optional] |
+| **show_cookie_notice** | **String** | Which shoppers see the privacy and cookie notice.  all, eea (shoppers in the European Economic Area), non_us, or null for nobody. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingPrivacy.new(
+  anonymize_ip: null,
+  default_mailing_list_off: null,
+  disable_return_email: null,
+  exclude_purchase_bubble_history: null,
+  hash_sha256: null,
+  show_cookie_notice: null
+)
+```
+

data/docs/SfvbTrackingPrivacyRequest.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbTrackingPrivacyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **anonymize_ip** | **String** | all, eea, non_us, or off. | [optional] |
+| **default_mailing_list_off** | **String** | all, eea, non_us, or off. | [optional] |
+| **disable_return_email** | **String** | all, eea, non_us, or off. | [optional] |
+| **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
+| **exclude_purchase_bubble_history** | **String** | all, eea, non_us, or off. | [optional] |
+| **show_cookie_notice** | **String** | all, eea, non_us, or off. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingPrivacyRequest.new(
+  anonymize_ip: null,
+  default_mailing_list_off: null,
+  disable_return_email: null,
+  dry_run: null,
+  exclude_purchase_bubble_history: null,
+  show_cookie_notice: null
+)
+```
+

data/docs/SfvbTrackingProvider.md

@@ -0,0 +1,48 @@
+# UltracartClient::SfvbTrackingProvider
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin_path** | **String** | Where the provider is in the admin. | [optional] |
+| **changes** | [**Array<SfvbTrackingChange>**](SfvbTrackingChange.md) | On a write, each setting it changed, or would change on a dry run.  Secrets read only set or cleared. | [optional] |
+| **configured** | **Boolean** | True when the provider is on, which means one of its identifying fields is set. | [optional] |
+| **consent** | [**SfvbTrackingProviderConsent**](SfvbTrackingProviderConsent.md) |  | [optional] |
+| **consent_supported** | **Boolean** | True when the provider can be held back until the shopper consents. | [optional] |
+| **cost** | **String** | For google_tag_manager, what turning on Google Tag Gateway costs. | [optional] |
+| **dry_run** | **Boolean** | On a write, true when nothing was saved. | [optional] |
+| **events** | [**Array<SfvbTrackingProviderEvent>**](SfvbTrackingProviderEvent.md) | For a provider with standard events, each one and whether it is sent. | [optional] |
+| **fields** | [**Array<SfvbTrackingProviderField>**](SfvbTrackingProviderField.md) | Every field, in the order the admin shows them. | [optional] |
+| **group** | **String** | google or other, the admin tab it is on. | [optional] |
+| **hash_sha256** | **String** | The hash of the stored settings.  A secret counts by its mask and length only.  Send it as If-Match when changing or clearing the provider. | [optional] |
+| **key** | **String** | The provider key, such as facebook or google_analytics. | [optional] |
+| **name** | **String** | The name the admin shows. | [optional] |
+| **notes** | **Array<String>** | Anything the write left for a person to do, such as disconnecting an OAuth connection in the admin. | [optional] |
+| **oauth** | [**SfvbTrackingProviderOauth**](SfvbTrackingProviderOauth.md) |  | [optional] |
+| **wholesale_tiers** | [**Array<SfvbTrackingWholesaleTier>**](SfvbTrackingWholesaleTier.md) | For google_analytics, the account number per wholesale pricing tier. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingProvider.new(
+  admin_path: null,
+  changes: null,
+  configured: null,
+  consent: null,
+  consent_supported: null,
+  cost: null,
+  dry_run: null,
+  events: null,
+  fields: null,
+  group: null,
+  hash_sha256: null,
+  key: null,
+  name: null,
+  notes: null,
+  oauth: null,
+  wholesale_tiers: null
+)
+```
+

data/docs/SfvbTrackingProviderConsent.md

@@ -0,0 +1,22 @@
+# UltracartClient::SfvbTrackingProviderConsent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_false** | **Boolean** | On a write, true to remove the gate.  Not with type or region. | [optional] |
+| **region** | **String** | Which shoppers the gate applies to.  all, eea or non_us. | [optional] |
+| **type** | **String** | Statistics, Preferences or Marketing. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingProviderConsent.new(
+  _false: null,
+  region: null,
+  type: null
+)
+```
+

data/docs/SfvbTrackingProviderEvent.md

@@ -0,0 +1,20 @@
+# UltracartClient::SfvbTrackingProviderEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | AddPaymentInfo, AddToCart, AddToWishlist, CompleteRegistration, InitiateCheckout, Lead, Search or ViewContent. | [optional] |
+| **_true** | **Boolean** | True when the event is sent to the provider. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingProviderEvent.new(
+  name: null,
+  _true: null
+)
+```
+

data/docs/SfvbTrackingProviderField.md

@@ -0,0 +1,42 @@
+# UltracartClient::SfvbTrackingProviderField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed** | **Array<String>** | For a select, the values accepted. | [optional] |
+| **key** | **String** | The field key a write names. | [optional] |
+| **label** | **String** | The label the admin shows. | [optional] |
+| **mask** | **String** | For a stored secret, its mask.  Send it back, or leave the secret out, to keep it. | [optional] |
+| **max** | **Integer** | The longest value accepted, or for an id_list the longest line. | [optional] |
+| **max_value** | **Integer** | For a number, the largest value accepted. | [optional] |
+| **min_value** | **Integer** | For a number, the smallest value accepted. | [optional] |
+| **secret** | **Boolean** | True for a secret.  Its value is never returned; set and mask say whether one is stored. | [optional] |
+| **set** | **Boolean** | For a secret, true when one is stored. | [optional] |
+| **sink** | **String** | For a writable secret, the sink a secret request names, with this storefront_oid as its target. | [optional] |
+| **type** | **String** | id, id_list, token, url, server_url, host, host_list, bool, select, number, numeric_id or secret.  It decides what a write accepts. | [optional] |
+| **value** | **String** | The stored value.  Booleans are true or false.  Null when blank.  Never present for a secret. | [optional] |
+| **writable** | **Boolean** | False for a field the API reports but does not change. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingProviderField.new(
+  allowed: null,
+  key: null,
+  label: null,
+  mask: null,
+  max: null,
+  max_value: null,
+  min_value: null,
+  secret: null,
+  set: null,
+  sink: null,
+  type: null,
+  value: null,
+  writable: null
+)
+```
+

data/docs/SfvbTrackingProviderOauth.md

@@ -0,0 +1,28 @@
+# UltracartClient::SfvbTrackingProviderOauth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **admin_path** | **String** | Where in the admin a person connects or disconnects it. | [optional] |
+| **ads_connected** | **Boolean** | For twitter, true when the Ads connection is made. | [optional] |
+| **connected** | **Boolean** | True when the connection is made. | [optional] |
+| **expires_at** | **String** | For facebook, when the connection expires, ISO 8601. | [optional] |
+| **feeds_connected** | **Boolean** | For twitter, true when the Feeds connection is made. | [optional] |
+| **kind** | **String** | google_ads, facebook, hubspot, snapchat, tiktok or twitter. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingProviderOauth.new(
+  admin_path: null,
+  ads_connected: null,
+  connected: null,
+  expires_at: null,
+  feeds_connected: null,
+  kind: null
+)
+```
+

data/docs/SfvbTrackingProviderRequest.md

@@ -0,0 +1,32 @@
+# UltracartClient::SfvbTrackingProviderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_cost** | **Boolean** | True to accept the cost of turning on Google Tag Gateway.  Required to turn it on. | [optional] |
+| **consent** | [**SfvbTrackingProviderConsent**](SfvbTrackingProviderConsent.md) |  | [optional] |
+| **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
+| **events** | **Object** | Standard events by name, true to send. | [optional] |
+| **fields** | **Object** | Plain field values by key.  An empty string clears one.  Booleans are true or false.  Secrets go in secrets instead. | [optional] |
+| **secrets** | [**SfvbTrackingProviderSecrets**](SfvbTrackingProviderSecrets.md) |  | [optional] |
+| **unset** | **Array<String>** | Plain field keys to clear. | [optional] |
+| **wholesale_tiers** | [**Array<SfvbTrackingWholesaleTier>**](SfvbTrackingWholesaleTier.md) | For google_analytics, account numbers by pricing_tier_oid. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::SfvbTrackingProviderRequest.new(
+  accept_cost: null,
+  consent: null,
+  dry_run: null,
+  events: null,
+  fields: null,
+  secrets: null,
+  unset: null,
+  wholesale_tiers: null
+)
+```
+