ultracart_api 4.1.247 → 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: e300f6bf0b8638272290eec0d6fb3a7b70cd1d7f25787761a111b88f2a0b2f1c
4
- data.tar.gz: 37182faebb890d633d130501268fd5549cc547fb89f0049a95968e8932dae3ad
3
+ metadata.gz: ee14f6669622cd015794a180874856bdf9c64710e82800e7d9f6a1f010ebc685
4
+ data.tar.gz: 328328e44c07a90cde553f86fb044fc52f1128d148e39cd00d08f3acf5a775d8
5
5
  SHA512:
6
- metadata.gz: 50319a1021d6172afefb46e3d2208a96eda8b6d9743440ca303a18ffbac01611f49b0dcaed2d182c6360c6213be2a960e282a189ad5b3580fbef620765097b12
7
- data.tar.gz: 7339caa35de83db7f0ec308c2be2d5ffb23230721c0bd2ca2a14ce2eef7880c55988e6fe780ba4eb276b607f812f08dc0ddcc570f6657b9b84f753557719c0f6
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.247
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.247'
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,7 @@ 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 |
2588
2589
  | 4.1.247 | 11/12/2026 | sfvb internal testing |
2589
2590
  | 4.1.246 | 11/11/2026 | sfvb internal testing |
2590
2591
  | 4.1.245 | 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 |
@@ -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 # => { ... }
@@ -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
@@ -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,
@@ -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.
@@ -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,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.247'
14
+ VERSION = '4.1.248'
15
15
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.247
4
+ version: 4.1.248
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart