ultracart_api 4.1.246 → 4.1.248

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: 4894e9bc180132783a16dbd3cb90e579dfb97fe666e30df09d29506c4bebe9ec
4
- data.tar.gz: 0d30062a2bf86089439004ac988b216277744f1657c96a4c06138d34a8d6055c
3
+ metadata.gz: ee14f6669622cd015794a180874856bdf9c64710e82800e7d9f6a1f010ebc685
4
+ data.tar.gz: 328328e44c07a90cde553f86fb044fc52f1128d148e39cd00d08f3acf5a775d8
5
5
  SHA512:
6
- metadata.gz: 1b5b1a95a19a63482825cf5f01016c8b6aea7052afc7ed97889fa87260a27e44969359b98b286e5279b90728faa135e465c7f4467cb9dffadbd3cfda2e7f1d17
7
- data.tar.gz: 3041bebaabae0e33461fa6e3166e38df440f709a3c9f55cc37fa1e4ab135d8eabaa2385cffa92949fdccd920d0adc9f4621a34fc064a2b0ab84803cac47f8418
6
+ metadata.gz: a853c22c7a42dd545a544d63e720e70edd0e29c99834611ca8405462da05e531180b0ffdadbc0cee1e86950eca9f1532eb6792139d822350abce66a4704c6b38
7
+ data.tar.gz: e62b9d617960b5b52fc936adce17e7ca8e0267a32b023f03e68ad4b6ce27666428e34d4bd1af8c369a5b4100d6616b8a121806fffba5306e6148ceb7953375ab
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.246
10
+ - Package version: 4.1.248
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.246'
19
+ gem 'ultracart_api', '4.1.248'
20
20
  ```
21
21
 
22
22
  install:
@@ -661,7 +661,7 @@ Class | Method | HTTP request | Description
661
661
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
662
662
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
663
663
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
664
- *UltracartClient::SfvbApi* | [**insert_sfvb_sequence_step**](docs/SfvbApi.md#insert_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps | Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
664
+ *UltracartClient::SfvbApi* | [**insert_sfvb_sequence_step**](docs/SfvbApi.md#insert_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps | Add an email step, with its new email, a wait step, a postcard step, with its new postcard, or a split or condition step
665
665
  *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_offer**](docs/SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer
666
666
  *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_path**](docs/SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path
667
667
  *UltracartClient::SfvbApi* | [**insert_sfvb_utm_shortcode**](docs/SfvbApi.md#insert_sfvb_utm_shortcode) | **POST** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | Create a UTM shortcode
@@ -2585,6 +2585,8 @@ Not every change is committed to every SDK.
2585
2585
 
2586
2586
  | Version | Date | Comments |
2587
2587
  | --: | :-: | --- |
2588
+ | 4.1.248 | 11/12/2026 | sfvb internal testing |
2589
+ | 4.1.247 | 11/12/2026 | sfvb internal testing |
2588
2590
  | 4.1.246 | 11/11/2026 | sfvb internal testing |
2589
2591
  | 4.1.245 | 11/11/2026 | sfvb internal testing |
2590
2592
  | 4.1.244 | 11/11/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -189,7 +189,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
189
189
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
190
190
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
191
191
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
192
- | [**insert_sfvb_sequence_step**](SfvbApi.md#insert_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps | Add an email step, with its new email, a wait step, or a postcard step, with its new postcard |
192
+ | [**insert_sfvb_sequence_step**](SfvbApi.md#insert_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps | Add an email step, with its new email, a wait step, a postcard step, with its new postcard, or a split or condition step |
193
193
  | [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
194
194
  | [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
195
195
  | [**insert_sfvb_utm_shortcode**](SfvbApi.md#insert_sfvb_utm_shortcode) | **POST** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | Create a UTM shortcode |
@@ -9601,7 +9601,7 @@ end
9601
9601
 
9602
9602
  Request a human approval
9603
9603
 
9604
- Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
9604
+ Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
9605
9605
 
9606
9606
 
9607
9607
  ### Examples
@@ -10352,9 +10352,9 @@ end
10352
10352
 
10353
10353
  > <SfvbSequenceStepCreateResponse> insert_sfvb_sequence_step(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
10354
10354
 
10355
- Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
10355
+ Add an email step, with its new email, a wait step, a postcard step, with its new postcard, or a split or condition step
10356
10356
 
10357
- type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account's own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin's default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin's editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
10357
+ type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account's own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin's default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. type split or condition (#2017) adds the step with its two sides, as the admin's editor adds one: the left or yes side starts with a continue step (customers there carry on after it) and the right or no side with an end step (customers there leave the sequence). config_json overrides the admin's default settings (a split's percentage_left, 0.01 to 0.99); a condition needs its rule in filter_profile_equation_json, checked as a segment's rule is. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin's editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
10358
10358
 
10359
10359
 
10360
10360
  ### Examples
@@ -10371,7 +10371,7 @@ This returns an Array which contains the response data, status code and headers.
10371
10371
 
10372
10372
  ```ruby
10373
10373
  begin
10374
- # Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
10374
+ # Add an email step, with its new email, a wait step, a postcard step, with its new postcard, or a split or condition step
10375
10375
  data, status_code, headers = api_instance.insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
10376
10376
  p status_code # => 2xx
10377
10377
  p headers # => { ... }
@@ -12161,7 +12161,7 @@ end
12161
12161
  | **if_match** | **String** | Content hash from the last read. Required; 428 when absent, 412 when stale. | |
12162
12162
  | **file_write_request** | [**SfvbFileWriteRequest**](SfvbFileWriteRequest.md) | File content to write | |
12163
12163
  | **path** | **String** | | [optional] |
12164
- | **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes. Required for scripts. See POST /sfvb/approvals. | [optional] |
12164
+ | **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals. | [optional] |
12165
12165
 
12166
12166
  ### Return type
12167
12167
 
@@ -14215,7 +14215,7 @@ end
14215
14215
  | **storefront_oid** | **Integer** | | |
14216
14216
  | **if_match** | **String** | Content hash of the file being reverted. Required; 428 when absent, 412 when stale. | |
14217
14217
  | **file_revert_request** | [**SfvbFileRevertRequest**](SfvbFileRevertRequest.md) | Version to revert the file to | |
14218
- | **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version. Required for scripts. See POST /sfvb/approvals. | [optional] |
14218
+ | **approval_id** | **String** | For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals. | [optional] |
14219
14219
 
14220
14220
  ### Return type
14221
14221
 
@@ -16065,7 +16065,7 @@ end
16065
16065
 
16066
16066
  Change one step's settings or audience filter
16067
16067
 
16068
- Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
16068
+ Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. An email step's audience filter changes here, but not its settings. Experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
16069
16069
 
16070
16070
 
16071
16071
  ### Examples
@@ -8,7 +8,7 @@
8
8
  | **affiliate_network** | [**SfvbAffiliateNetworkRequest**](SfvbAffiliateNetworkRequest.md) | | [optional] |
9
9
  | **comms_list_import** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) | | [optional] |
10
10
  | **comms_settings** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) | | [optional] |
11
- | **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] |
11
+ | **content** | **String** | For a file.put_script write, the exact script to be written, at most 256 KB, and for a file.put_template write the exact template. 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] |
12
12
  | **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
13
13
  | **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | | [optional] |
14
14
  | **item_attribute_rows** | [**Array&lt;SfvbItemAttributeBatchRow&gt;**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run&#39;s change rows, each with merchant_item_oid and current_sha256. UltraCart keeps only their hash. | [optional] |
@@ -9,13 +9,13 @@
9
9
  | **attribute_names** | **Array&lt;String&gt;** | For item.attribute_batch, the attributes the batch would change. Set by the server. | [optional] |
10
10
  | **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
11
11
  | **branch_step_uuid** | **String** | For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of. | [optional] |
12
- | **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] |
12
+ | **content_sha256** | **String** | For file.put_script, file.put_template 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] |
13
13
  | **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
14
14
  | **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account&#39;s esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
15
15
  | **experiment_oid** | **Integer** | For experiment.end, the experiment to end. | [optional] |
16
16
  | **item_count** | **Integer** | For item.attribute_batch, how many items the batch would change when it was requested. Set by the server. | [optional] |
17
17
  | **merchant_item_oid** | **Integer** | For item.pricing, the item whose pricing changes. | [optional] |
18
- | **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] |
18
+ | **path** | **String** | The file path, for file.delete, file.put_script and file.put_template, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it. | [optional] |
19
19
  | **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] |
20
20
  | **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] |
21
21
  | **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
@@ -27,7 +27,7 @@
27
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
- | **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
30
+ | **version** | **Integer** | For file.put_script and file.put_template, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
31
31
  | **widget_id** | **String** | For experiment.start of a page experiment, the id of the experiment element. | [optional] |
32
32
  | **winner_variation_number** | **Integer** | For experiment.end, the winning variation. Leave it out to end without a winner, and leave it out of the end call too. | [optional] |
33
33
 
@@ -8,9 +8,11 @@
8
8
  | **comment** | **String** | Comment recorded with the write that replaced this version. | [optional] |
9
9
  | **container_history_oid** | **Integer** | History record oid. Pass to the revert operation on the owning container. Absent on the entry marked current, which holds the value stored right now, has no history row of its own, and so cannot be fetched or reverted to. | [optional] |
10
10
  | **container_name** | **String** | Container name, where the owner has more than one container. | [optional] |
11
- | **created_dts** | **String** | When this snapshot was taken, ISO 8601 UTC. | [optional] |
11
+ | **content_created_dts** | **String** | When this version&#39;s content was written, ISO 8601 UTC. Same source and limits as content_edited_by. | [optional] |
12
+ | **content_edited_by** | **String** | Login of whoever wrote this version&#39;s content, taken from the write recorded on the next older entry. Absent on a create entry and on the oldest entry kept, such as a template body that was in place before any history. Saves made outside this API, in the admin visual builder, are not recorded, so after one this names the previous API write. | [optional] |
13
+ | **created_dts** | **String** | When the write that replaced this version happened, ISO 8601 UTC. On the current entry, when it was written. | [optional] |
12
14
  | **current** | **Boolean** | True for the value currently stored. | [optional] |
13
- | **edited_by** | **String** | Login of whoever caused this snapshot. | [optional] |
15
+ | **edited_by** | **String** | Login of whoever made the write that replaced this version. On the current entry, whoever wrote it. See content_edited_by for who wrote a history entry&#39;s content. | [optional] |
14
16
  | **hash_sha256** | **String** | SHA-256 of this version&#39;s CJSON. | [optional] |
15
17
  | **operation** | **String** | What the container was before the write this entry precedes. create means it did not exist, so reverting to this entry removes it again; update means it held the cjson recorded here. | [optional] |
16
18
  | **owner_object_id** | **String** | Owner object identifier. | [optional] |
@@ -27,6 +29,8 @@ instance = UltracartClient::SfvbContainerVersion.new(
27
29
  comment: null,
28
30
  container_history_oid: null,
29
31
  container_name: null,
32
+ content_created_dts: null,
33
+ content_edited_by: null,
30
34
  created_dts: null,
31
35
  current: null,
32
36
  edited_by: null,
@@ -7,13 +7,14 @@
7
7
  | **acknowledge_executable** | **Boolean** | With library_item_oid, true once the caller has seen that the item carries executable content (script, html, embed, css or velocity elements) and still wants it. An item with any is refused without it. | [optional] |
8
8
  | **after_step_uuid** | **String** | The step the new step follows, in the same list. Not an end, continue or merge step. | [optional] |
9
9
  | **branch_step_uuid** | **String** | A condition, split or inboxgeek step. With side, the new step goes first on that side. | [optional] |
10
- | **config_json** | **String** | A wait step&#39;s settings, as the admin saves them and set-config changes them, namely delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), and optionally the delay_until_* options. Not for an email step. | [optional] |
10
+ | **config_json** | **String** | A wait step&#39;s settings, as the admin saves them and set-config changes them, namely delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), and optionally the delay_until_* options. For a split, percentage_left (0.01 to 0.99, 0.5 by default) and merchant_notes. For a condition, reverse, disabled and merchant_notes. Not for an email step. | [optional] |
11
+ | **filter_profile_equation_json** | **String** | A condition step&#39;s rule, required for one, as an audience filter in the shape segments use. Customers who match go to the yes side. Only for a condition step. | [optional] |
11
12
  | **library_item_oid** | **Integer** | An email item from the code library (#1589) to start the new email from, taking its body, with new element ids, and its subject and preview text unless subject or preview_text is given. The item must be this account&#39;s own, shared with it, or published, approved by UltraCart and free. Only for an email step. The items are listed by the code library email read. | [optional] |
12
13
  | **name** | **String** | A post_card step&#39;s name, shown in the admin, 1 to 100 characters on one line. Postcard by default. Only for a post_card step. | [optional] |
13
14
  | **preview_text** | **String** | The new email&#39;s preview text, 5 to 150 characters. Optional with library_item_oid, whose preview text is used when this is left out. | [optional] |
14
15
  | **side** | **String** | With branch_step_uuid, the side&#39;s label from the sequence read. yes or no for a condition, left or right for a split or inboxgeek step. | [optional] |
15
16
  | **subject** | **String** | The new email&#39;s subject line, 5 to 150 characters. Optional with library_item_oid, whose subject is used when this is left out. | [optional] |
16
- | **type** | **String** | The kind of step, one of email (the default), wait or post_card. | [optional] |
17
+ | **type** | **String** | The kind of step, one of email (the default), wait, post_card, split or condition. | [optional] |
17
18
 
18
19
  ## Example
19
20
 
@@ -25,6 +26,7 @@ instance = UltracartClient::SfvbSequenceStepCreateRequest.new(
25
26
  after_step_uuid: null,
26
27
  branch_step_uuid: null,
27
28
  config_json: null,
29
+ filter_profile_equation_json: null,
28
30
  library_item_oid: null,
29
31
  name: null,
30
32
  preview_text: null,
@@ -12215,7 +12215,7 @@ module UltracartClient
12215
12215
  end
12216
12216
 
12217
12217
  # Request a human approval
12218
- # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12218
+ # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12219
12219
  # @param approval_request [SfvbApprovalCreateRequest] The request
12220
12220
  # @param [Hash] opts the optional parameters
12221
12221
  # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
@@ -12226,7 +12226,7 @@ module UltracartClient
12226
12226
  end
12227
12227
 
12228
12228
  # Request a human approval
12229
- # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart&#39;s scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12229
+ # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script and file.put_template send the file as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These four start as reviewing while UltraCart&#39;s scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
12230
12230
  # @param approval_request [SfvbApprovalCreateRequest] The request
12231
12231
  # @param [Hash] opts the optional parameters
12232
12232
  # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
@@ -13240,8 +13240,8 @@ module UltracartClient
13240
13240
  return data, status_code, headers
13241
13241
  end
13242
13242
 
13243
- # Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
13244
- # type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account's own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin's default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin's editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
13243
+ # Add an email step, with its new email, a wait step, a postcard step, with its new postcard, or a split or condition step
13244
+ # type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account's own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin's default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. type split or condition (#2017) adds the step with its two sides, as the admin's editor adds one: the left or yes side starts with a continue step (customers there carry on after it) and the right or no side with an end step (customers there leave the sequence). config_json overrides the admin's default settings (a split's percentage_left, 0.01 to 0.99); a condition needs its rule in filter_profile_equation_json, checked as a segment's rule is. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin's editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
13245
13245
  # @param storefront_oid [Integer]
13246
13246
  # @param sequence_uuid [String]
13247
13247
  # @param if_match [String] The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
@@ -13253,8 +13253,8 @@ module UltracartClient
13253
13253
  data
13254
13254
  end
13255
13255
 
13256
- # Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
13257
- # type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account&#39;s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin&#39;s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step&#39;s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin&#39;s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
13256
+ # Add an email step, with its new email, a wait step, a postcard step, with its new postcard, or a split or condition step
13257
+ # type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account&#39;s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin&#39;s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. type split or condition (#2017) adds the step with its two sides, as the admin&#39;s editor adds one: the left or yes side starts with a continue step (customers there carry on after it) and the right or no side with an end step (customers there leave the sequence). config_json overrides the admin&#39;s default settings (a split&#39;s percentage_left, 0.01 to 0.99); a condition needs its rule in filter_profile_equation_json, checked as a segment&#39;s rule is. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step&#39;s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin&#39;s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
13258
13258
  # @param storefront_oid [Integer]
13259
13259
  # @param sequence_uuid [String]
13260
13260
  # @param if_match [String] The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
@@ -15663,7 +15663,7 @@ module UltracartClient
15663
15663
  # @param file_write_request [SfvbFileWriteRequest] File content to write
15664
15664
  # @param [Hash] opts the optional parameters
15665
15665
  # @option opts [String] :path
15666
- # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes. Required for scripts. See POST /sfvb/approvals.
15666
+ # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
15667
15667
  # @return [SfvbFileWriteResponse]
15668
15668
  def put_sfvb_file_content(storefront_oid, if_match, file_write_request, opts = {})
15669
15669
  data, _status_code, _headers = put_sfvb_file_content_with_http_info(storefront_oid, if_match, file_write_request, opts)
@@ -15677,7 +15677,7 @@ module UltracartClient
15677
15677
  # @param file_write_request [SfvbFileWriteRequest] File content to write
15678
15678
  # @param [Hash] opts the optional parameters
15679
15679
  # @option opts [String] :path
15680
- # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes. Required for scripts. See POST /sfvb/approvals.
15680
+ # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request for exactly these bytes, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
15681
15681
  # @return [Array<(SfvbFileWriteResponse, Integer, Hash)>] SfvbFileWriteResponse data, response status code and response headers
15682
15682
  def put_sfvb_file_content_with_http_info(storefront_oid, if_match, file_write_request, opts = {})
15683
15683
  if @api_client.config.debugging
@@ -18664,7 +18664,7 @@ module UltracartClient
18664
18664
  # @param if_match [String] Content hash of the file being reverted. Required; 428 when absent, 412 when stale.
18665
18665
  # @param file_revert_request [SfvbFileRevertRequest] Version to revert the file to
18666
18666
  # @param [Hash] opts the optional parameters
18667
- # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version. Required for scripts. See POST /sfvb/approvals.
18667
+ # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
18668
18668
  # @return [SfvbFileWriteResponse]
18669
18669
  def revert_sfvb_file(storefront_oid, if_match, file_revert_request, opts = {})
18670
18670
  data, _status_code, _headers = revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request, opts)
@@ -18677,7 +18677,7 @@ module UltracartClient
18677
18677
  # @param if_match [String] Content hash of the file being reverted. Required; 428 when absent, 412 when stale.
18678
18678
  # @param file_revert_request [SfvbFileRevertRequest] Version to revert the file to
18679
18679
  # @param [Hash] opts the optional parameters
18680
- # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version. Required for scripts. See POST /sfvb/approvals.
18680
+ # @option opts [String] :approval_id For a .js or .mjs file, the approval_id of an approved file.put_script request naming this version, and for a .vm or .html file inside a theme, of an approved file.put_template request. Required for scripts and templates. See POST /sfvb/approvals.
18681
18681
  # @return [Array<(SfvbFileWriteResponse, Integer, Hash)>] SfvbFileWriteResponse data, response status code and response headers
18682
18682
  def revert_sfvb_file_with_http_info(storefront_oid, if_match, file_revert_request, opts = {})
18683
18683
  if @api_client.config.debugging
@@ -21446,7 +21446,7 @@ module UltracartClient
21446
21446
  end
21447
21447
 
21448
21448
  # Change one step's settings or audience filter
21449
- # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
21449
+ # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. An email step's audience filter changes here, but not its settings. Experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
21450
21450
  # @param storefront_oid [Integer]
21451
21451
  # @param sequence_uuid [String]
21452
21452
  # @param step_uuid [String]
@@ -21461,7 +21461,7 @@ module UltracartClient
21461
21461
  end
21462
21462
 
21463
21463
  # Change one step&#39;s settings or audience filter
21464
- # Replaces the step&#39;s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step&#39;s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
21464
+ # Replaces the step&#39;s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step&#39;s hash_sha256 as If-Match; the write only lands if the step is still what you read. An email step&#39;s audience filter changes here, but not its settings. Experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
21465
21465
  # @param storefront_oid [Integer]
21466
21466
  # @param sequence_uuid [String]
21467
21467
  # @param step_uuid [String]
@@ -24,7 +24,7 @@ module UltracartClient
24
24
 
25
25
  attr_accessor :comms_settings
26
26
 
27
- # 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.
27
+ # For a file.put_script write, the exact script to be written, at most 256 KB, and for a file.put_template write the exact template. 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.
28
28
  attr_accessor :content
29
29
 
30
30
  attr_accessor :experiment_start
@@ -274,7 +274,7 @@ module UltracartClient
274
274
  # Check to see if the all the properties in the model are valid
275
275
  # @return true if the model is valid
276
276
  def valid?
277
- action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
277
+ action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
278
278
  return false unless action_validator.valid?(@action)
279
279
  true
280
280
  end
@@ -282,7 +282,7 @@ module UltracartClient
282
282
  # Custom attribute writer method checking allowed values (enum).
283
283
  # @param [Object] action Object to be assigned
284
284
  def action=(action)
285
- validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
285
+ validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "file.put_template", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "item.preorder", "item.variations", "item.default_page", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "sequence_step.move", "sequence_step.enable_postcard", "segment.update", "smart_attribution.change", "smart_attribution.delete", "tracking_provider.change", "tracking_provider.clear", "tracking_html.put", "affiliate_network.change", "affiliate_network.delete", "site_seo.change", "transactional_email.update", "comms_settings.update", "comms_list.import", "postcard.test_mail", "flow.backfill"])
286
286
  unless validator.valid?(action)
287
287
  fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
288
288
  end
@@ -30,7 +30,7 @@ module UltracartClient
30
30
  # For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of.
31
31
  attr_accessor :branch_step_uuid
32
32
 
33
- # 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.
33
+ # For file.put_script, file.put_template 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.
34
34
  attr_accessor :content_sha256
35
35
 
36
36
  # For sending_domain.delete, the sending domain.
@@ -48,7 +48,7 @@ module UltracartClient
48
48
  # For item.pricing, the item whose pricing changes.
49
49
  attr_accessor :merchant_item_oid
50
50
 
51
- # 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.
51
+ # The file path, for file.delete, file.put_script and file.put_template, or the page path for experiment.start of a page experiment. Exactly as the gated call will send it.
52
52
  attr_accessor :path
53
53
 
54
54
  # 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.
@@ -84,7 +84,7 @@ module UltracartClient
84
84
  # For upsell.enable, the oid of the offer or path to switch on.
85
85
  attr_accessor :upsell_oid
86
86
 
87
- # For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write.
87
+ # For file.put_script and file.put_template, the history version a revert restores. Leave it out, and send content instead, for a write.
88
88
  attr_accessor :version
89
89
 
90
90
  # For experiment.start of a page experiment, the id of the experiment element.
@@ -27,13 +27,19 @@ module UltracartClient
27
27
  # Container name, where the owner has more than one container.
28
28
  attr_accessor :container_name
29
29
 
30
- # When this snapshot was taken, ISO 8601 UTC.
30
+ # When this version's content was written, ISO 8601 UTC. Same source and limits as content_edited_by.
31
+ attr_accessor :content_created_dts
32
+
33
+ # Login of whoever wrote this version's content, taken from the write recorded on the next older entry. Absent on a create entry and on the oldest entry kept, such as a template body that was in place before any history. Saves made outside this API, in the admin visual builder, are not recorded, so after one this names the previous API write.
34
+ attr_accessor :content_edited_by
35
+
36
+ # When the write that replaced this version happened, ISO 8601 UTC. On the current entry, when it was written.
31
37
  attr_accessor :created_dts
32
38
 
33
39
  # True for the value currently stored.
34
40
  attr_accessor :current
35
41
 
36
- # Login of whoever caused this snapshot.
42
+ # Login of whoever made the write that replaced this version. On the current entry, whoever wrote it. See content_edited_by for who wrote a history entry's content.
37
43
  attr_accessor :edited_by
38
44
 
39
45
  # SHA-256 of this version's CJSON.
@@ -80,6 +86,8 @@ module UltracartClient
80
86
  :'comment' => :'comment',
81
87
  :'container_history_oid' => :'container_history_oid',
82
88
  :'container_name' => :'container_name',
89
+ :'content_created_dts' => :'content_created_dts',
90
+ :'content_edited_by' => :'content_edited_by',
83
91
  :'created_dts' => :'created_dts',
84
92
  :'current' => :'current',
85
93
  :'edited_by' => :'edited_by',
@@ -103,6 +111,8 @@ module UltracartClient
103
111
  :'comment' => :'String',
104
112
  :'container_history_oid' => :'Integer',
105
113
  :'container_name' => :'String',
114
+ :'content_created_dts' => :'String',
115
+ :'content_edited_by' => :'String',
106
116
  :'created_dts' => :'String',
107
117
  :'current' => :'Boolean',
108
118
  :'edited_by' => :'String',
@@ -151,6 +161,14 @@ module UltracartClient
151
161
  self.container_name = attributes[:'container_name']
152
162
  end
153
163
 
164
+ if attributes.key?(:'content_created_dts')
165
+ self.content_created_dts = attributes[:'content_created_dts']
166
+ end
167
+
168
+ if attributes.key?(:'content_edited_by')
169
+ self.content_edited_by = attributes[:'content_edited_by']
170
+ end
171
+
154
172
  if attributes.key?(:'created_dts')
155
173
  self.created_dts = attributes[:'created_dts']
156
174
  end
@@ -230,6 +248,8 @@ module UltracartClient
230
248
  comment == o.comment &&
231
249
  container_history_oid == o.container_history_oid &&
232
250
  container_name == o.container_name &&
251
+ content_created_dts == o.content_created_dts &&
252
+ content_edited_by == o.content_edited_by &&
233
253
  created_dts == o.created_dts &&
234
254
  current == o.current &&
235
255
  edited_by == o.edited_by &&
@@ -249,7 +269,7 @@ module UltracartClient
249
269
  # Calculates hash code according to all attributes.
250
270
  # @return [Integer] Hash code
251
271
  def hash
252
- [cjson, comment, container_history_oid, container_name, created_dts, current, edited_by, hash_sha256, operation, owner_object_id, owner_type, size].hash
272
+ [cjson, comment, container_history_oid, container_name, content_created_dts, content_edited_by, created_dts, current, edited_by, hash_sha256, operation, owner_object_id, owner_type, size].hash
253
273
  end
254
274
 
255
275
  # Builds the object from hash
@@ -24,9 +24,12 @@ module UltracartClient
24
24
  # A condition, split or inboxgeek step. With side, the new step goes first on that side.
25
25
  attr_accessor :branch_step_uuid
26
26
 
27
- # A wait step's settings, as the admin saves them and set-config changes them, namely delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), and optionally the delay_until_* options. Not for an email step.
27
+ # A wait step's settings, as the admin saves them and set-config changes them, namely delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), and optionally the delay_until_* options. For a split, percentage_left (0.01 to 0.99, 0.5 by default) and merchant_notes. For a condition, reverse, disabled and merchant_notes. Not for an email step.
28
28
  attr_accessor :config_json
29
29
 
30
+ # A condition step's rule, required for one, as an audience filter in the shape segments use. Customers who match go to the yes side. Only for a condition step.
31
+ attr_accessor :filter_profile_equation_json
32
+
30
33
  # An email item from the code library (#1589) to start the new email from, taking its body, with new element ids, and its subject and preview text unless subject or preview_text is given. The item must be this account's own, shared with it, or published, approved by UltraCart and free. Only for an email step. The items are listed by the code library email read.
31
34
  attr_accessor :library_item_oid
32
35
 
@@ -42,7 +45,7 @@ module UltracartClient
42
45
  # The new email's subject line, 5 to 150 characters. Optional with library_item_oid, whose subject is used when this is left out.
43
46
  attr_accessor :subject
44
47
 
45
- # The kind of step, one of email (the default), wait or post_card.
48
+ # The kind of step, one of email (the default), wait, post_card, split or condition.
46
49
  attr_accessor :type
47
50
 
48
51
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -52,6 +55,7 @@ module UltracartClient
52
55
  :'after_step_uuid' => :'after_step_uuid',
53
56
  :'branch_step_uuid' => :'branch_step_uuid',
54
57
  :'config_json' => :'config_json',
58
+ :'filter_profile_equation_json' => :'filter_profile_equation_json',
55
59
  :'library_item_oid' => :'library_item_oid',
56
60
  :'name' => :'name',
57
61
  :'preview_text' => :'preview_text',
@@ -73,6 +77,7 @@ module UltracartClient
73
77
  :'after_step_uuid' => :'String',
74
78
  :'branch_step_uuid' => :'String',
75
79
  :'config_json' => :'String',
80
+ :'filter_profile_equation_json' => :'String',
76
81
  :'library_item_oid' => :'Integer',
77
82
  :'name' => :'String',
78
83
  :'preview_text' => :'String',
@@ -119,6 +124,10 @@ module UltracartClient
119
124
  self.config_json = attributes[:'config_json']
120
125
  end
121
126
 
127
+ if attributes.key?(:'filter_profile_equation_json')
128
+ self.filter_profile_equation_json = attributes[:'filter_profile_equation_json']
129
+ end
130
+
122
131
  if attributes.key?(:'library_item_oid')
123
132
  self.library_item_oid = attributes[:'library_item_oid']
124
133
  end
@@ -166,6 +175,7 @@ module UltracartClient
166
175
  after_step_uuid == o.after_step_uuid &&
167
176
  branch_step_uuid == o.branch_step_uuid &&
168
177
  config_json == o.config_json &&
178
+ filter_profile_equation_json == o.filter_profile_equation_json &&
169
179
  library_item_oid == o.library_item_oid &&
170
180
  name == o.name &&
171
181
  preview_text == o.preview_text &&
@@ -183,7 +193,7 @@ module UltracartClient
183
193
  # Calculates hash code according to all attributes.
184
194
  # @return [Integer] Hash code
185
195
  def hash
186
- [acknowledge_executable, after_step_uuid, branch_step_uuid, config_json, library_item_oid, name, preview_text, side, subject, type].hash
196
+ [acknowledge_executable, after_step_uuid, branch_step_uuid, config_json, filter_profile_equation_json, library_item_oid, name, preview_text, side, subject, type].hash
187
197
  end
188
198
 
189
199
  # Builds the object from hash
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.246'
14
+ VERSION = '4.1.248'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.246
4
+ version: 4.1.248
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-11-11 00:00:00.000000000 Z
11
+ date: 2026-11-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus