ultracart_api 4.1.247 → 4.1.249

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: d2a50c8b648f3e68c1dc08e27faf508b0d30c90ca597a2beb2f3d29b84d404d0
4
+ data.tar.gz: de10ef55641a3911c0793ae971d4ad82f7458db616934b24e89c7d4ae98267c4
5
5
  SHA512:
6
- metadata.gz: 50319a1021d6172afefb46e3d2208a96eda8b6d9743440ca303a18ffbac01611f49b0dcaed2d182c6360c6213be2a960e282a189ad5b3580fbef620765097b12
7
- data.tar.gz: 7339caa35de83db7f0ec308c2be2d5ffb23230721c0bd2ca2a14ce2eef7880c55988e6fe780ba4eb276b607f812f08dc0ddcc570f6657b9b84f753557719c0f6
6
+ metadata.gz: cc7febc7fcd39d991fbc780a67efbc4cf1b8fead7b5e94a60213d507189bafc0c5948c9a30218beb4e529b73566c89e2cb2252dc86d012c9d6be5e20501ce155
7
+ data.tar.gz: ab48f08943c9d4acc8a23c1965e670b7e42b6f80b4a87d1032e7afc836e387caa0aa8074943446d939c33891852b7274696f6bdfa13e26f89890f48c12c898d0
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.249
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.249'
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.249 | 11/12/2026 | sfvb internal testing |
2589
+ | 4.1.248 | 11/12/2026 | sfvb internal testing |
2588
2590
  | 4.1.247 | 11/12/2026 | sfvb internal testing |
2589
2591
  | 4.1.246 | 11/11/2026 | sfvb internal testing |
2590
2592
  | 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 |
@@ -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 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.
9604
+ Asks the person who signed in the CLI to approve one gated action on one exact target, or with delegate_email a colleague on the account who holds a permission covering the action. 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 # => { ... }
@@ -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
data/docs/SfvbApproval.md CHANGED
@@ -8,6 +8,9 @@
8
8
  | **approval_id** | **String** | Send this as the Approval-Id header on the gated call once status is approved. | [optional] |
9
9
  | **approval_url** | **String** | The page where the person approves or denies. Show it to them. Never open or fill it in yourself. | [optional] |
10
10
  | **created_at** | **String** | When the request was made, ISO 8601 UTC. | [optional] |
11
+ | **decided_by** | **String** | Who decided the request, once decided. | [optional] |
12
+ | **delegate_name** | **String** | The name of the colleague the request was handed to, while it is. Tell the person who is now deciding. | [optional] |
13
+ | **delegated** | **Boolean** | True when the request was handed to a colleague to decide. | [optional] |
11
14
  | **description** | **String** | The sentence the person reads before approving. Written by the server, not the agent. | [optional] |
12
15
  | **expires_at** | **String** | When this approval stops being usable, ISO 8601 UTC. For a pending request, when it lapses undecided. For an approved one, when it must have been used by. | [optional] |
13
16
  | **expires_in_seconds** | **Integer** | Seconds until expires_at. Zero once passed. | [optional] |
@@ -35,6 +38,9 @@ instance = UltracartClient::SfvbApproval.new(
35
38
  approval_id: null,
36
39
  approval_url: null,
37
40
  created_at: null,
41
+ decided_by: null,
42
+ delegate_name: null,
43
+ delegated: null,
38
44
  description: null,
39
45
  expires_at: null,
40
46
  expires_in_seconds: null,
@@ -9,6 +9,7 @@
9
9
  | **comms_list_import** | [**SfvbCommsProviderImportRequest**](SfvbCommsProviderImportRequest.md) | | [optional] |
10
10
  | **comms_settings** | [**SfvbCommsSettingsUpdateRequest**](SfvbCommsSettingsUpdateRequest.md) | | [optional] |
11
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
+ | **delegate_email** | **String** | Optional. The email of a colleague on this account who should decide the request instead of the person who signed in. They must hold an admin permission that covers the action; they get an email with a link and decide with their own authenticator code. Any colleague who can&#39;t be used is refused with sfvb.delegate_not_allowed, for every reason alike. The approval stays yours to poll and use. | [optional] |
12
13
  | **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
13
14
  | **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | | [optional] |
14
15
  | **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] |
@@ -38,6 +39,7 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
38
39
  comms_list_import: null,
39
40
  comms_settings: null,
40
41
  content: null,
42
+ delegate_email: null,
41
43
  experiment_start: null,
42
44
  flow_backfill: null,
43
45
  item_attribute_rows: 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 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.
12218
+ # Asks the person who signed in the CLI to approve one gated action on one exact target, or with delegate_email a colleague on the account who holds a permission covering the action. 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 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.
12229
+ # Asks the person who signed in the CLI to approve one gated action on one exact target, or with delegate_email a colleague on the account who holds a permission covering the action. 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.
@@ -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]
@@ -27,6 +27,15 @@ module UltracartClient
27
27
  # When the request was made, ISO 8601 UTC.
28
28
  attr_accessor :created_at
29
29
 
30
+ # Who decided the request, once decided.
31
+ attr_accessor :decided_by
32
+
33
+ # The name of the colleague the request was handed to, while it is. Tell the person who is now deciding.
34
+ attr_accessor :delegate_name
35
+
36
+ # True when the request was handed to a colleague to decide.
37
+ attr_accessor :delegated
38
+
30
39
  # The sentence the person reads before approving. Written by the server, not the agent.
31
40
  attr_accessor :description
32
41
 
@@ -102,6 +111,9 @@ module UltracartClient
102
111
  :'approval_id' => :'approval_id',
103
112
  :'approval_url' => :'approval_url',
104
113
  :'created_at' => :'created_at',
114
+ :'decided_by' => :'decided_by',
115
+ :'delegate_name' => :'delegate_name',
116
+ :'delegated' => :'delegated',
105
117
  :'description' => :'description',
106
118
  :'expires_at' => :'expires_at',
107
119
  :'expires_in_seconds' => :'expires_in_seconds',
@@ -133,6 +145,9 @@ module UltracartClient
133
145
  :'approval_id' => :'String',
134
146
  :'approval_url' => :'String',
135
147
  :'created_at' => :'String',
148
+ :'decided_by' => :'String',
149
+ :'delegate_name' => :'String',
150
+ :'delegated' => :'Boolean',
136
151
  :'description' => :'String',
137
152
  :'expires_at' => :'String',
138
153
  :'expires_in_seconds' => :'Integer',
@@ -189,6 +204,18 @@ module UltracartClient
189
204
  self.created_at = attributes[:'created_at']
190
205
  end
191
206
 
207
+ if attributes.key?(:'decided_by')
208
+ self.decided_by = attributes[:'decided_by']
209
+ end
210
+
211
+ if attributes.key?(:'delegate_name')
212
+ self.delegate_name = attributes[:'delegate_name']
213
+ end
214
+
215
+ if attributes.key?(:'delegated')
216
+ self.delegated = attributes[:'delegated']
217
+ end
218
+
192
219
  if attributes.key?(:'description')
193
220
  self.description = attributes[:'description']
194
221
  end
@@ -264,6 +291,8 @@ module UltracartClient
264
291
  # Check to see if the all the properties in the model are valid
265
292
  # @return true if the model is valid
266
293
  def valid?
294
+ decided_by_validator = EnumAttributeValidator.new('String', ["requester", "delegate"])
295
+ return false unless decided_by_validator.valid?(@decided_by)
267
296
  outcome_validator = EnumAttributeValidator.new('String', ["succeeded", "failed"])
268
297
  return false unless outcome_validator.valid?(@outcome)
269
298
  status_validator = EnumAttributeValidator.new('String', ["reviewing", "pending", "approved", "denied", "cancelled", "expired", "used", "refused"])
@@ -271,6 +300,16 @@ module UltracartClient
271
300
  true
272
301
  end
273
302
 
303
+ # Custom attribute writer method checking allowed values (enum).
304
+ # @param [Object] decided_by Object to be assigned
305
+ def decided_by=(decided_by)
306
+ validator = EnumAttributeValidator.new('String', ["requester", "delegate"])
307
+ unless validator.valid?(decided_by)
308
+ fail ArgumentError, "invalid value for \"decided_by\", must be one of #{validator.allowable_values}."
309
+ end
310
+ @decided_by = decided_by
311
+ end
312
+
274
313
  # Custom attribute writer method checking allowed values (enum).
275
314
  # @param [Object] outcome Object to be assigned
276
315
  def outcome=(outcome)
@@ -300,6 +339,9 @@ module UltracartClient
300
339
  approval_id == o.approval_id &&
301
340
  approval_url == o.approval_url &&
302
341
  created_at == o.created_at &&
342
+ decided_by == o.decided_by &&
343
+ delegate_name == o.delegate_name &&
344
+ delegated == o.delegated &&
303
345
  description == o.description &&
304
346
  expires_at == o.expires_at &&
305
347
  expires_in_seconds == o.expires_in_seconds &&
@@ -327,7 +369,7 @@ module UltracartClient
327
369
  # Calculates hash code according to all attributes.
328
370
  # @return [Integer] Hash code
329
371
  def hash
330
- [action, approval_id, approval_url, created_at, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, review, scope, status, storefront_oid, used_at, user_code].hash
372
+ [action, approval_id, approval_url, created_at, decided_by, delegate_name, delegated, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, review, scope, status, storefront_oid, used_at, user_code].hash
331
373
  end
332
374
 
333
375
  # Builds the object from hash
@@ -27,6 +27,9 @@ module UltracartClient
27
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
+ # Optional. The email of a colleague on this account who should decide the request instead of the person who signed in. They must hold an admin permission that covers the action; they get an email with a link and decide with their own authenticator code. Any colleague who can't be used is refused with sfvb.delegate_not_allowed, for every reason alike. The approval stays yours to poll and use.
31
+ attr_accessor :delegate_email
32
+
30
33
  attr_accessor :experiment_start
31
34
 
32
35
  attr_accessor :flow_backfill
@@ -95,6 +98,7 @@ module UltracartClient
95
98
  :'comms_list_import' => :'comms_list_import',
96
99
  :'comms_settings' => :'comms_settings',
97
100
  :'content' => :'content',
101
+ :'delegate_email' => :'delegate_email',
98
102
  :'experiment_start' => :'experiment_start',
99
103
  :'flow_backfill' => :'flow_backfill',
100
104
  :'item_attribute_rows' => :'item_attribute_rows',
@@ -128,6 +132,7 @@ module UltracartClient
128
132
  :'comms_list_import' => :'SfvbCommsProviderImportRequest',
129
133
  :'comms_settings' => :'SfvbCommsSettingsUpdateRequest',
130
134
  :'content' => :'String',
135
+ :'delegate_email' => :'String',
131
136
  :'experiment_start' => :'SfvbExperimentStartRequest',
132
137
  :'flow_backfill' => :'SfvbFlowBackfillRequest',
133
138
  :'item_attribute_rows' => :'Array<SfvbItemAttributeBatchRow>',
@@ -189,6 +194,10 @@ module UltracartClient
189
194
  self.content = attributes[:'content']
190
195
  end
191
196
 
197
+ if attributes.key?(:'delegate_email')
198
+ self.delegate_email = attributes[:'delegate_email']
199
+ end
200
+
192
201
  if attributes.key?(:'experiment_start')
193
202
  self.experiment_start = attributes[:'experiment_start']
194
203
  end
@@ -299,6 +308,7 @@ module UltracartClient
299
308
  comms_list_import == o.comms_list_import &&
300
309
  comms_settings == o.comms_settings &&
301
310
  content == o.content &&
311
+ delegate_email == o.delegate_email &&
302
312
  experiment_start == o.experiment_start &&
303
313
  flow_backfill == o.flow_backfill &&
304
314
  item_attribute_rows == o.item_attribute_rows &&
@@ -327,7 +337,7 @@ module UltracartClient
327
337
  # Calculates hash code according to all attributes.
328
338
  # @return [Integer] Hash code
329
339
  def hash
330
- [action, affiliate_network, comms_list_import, comms_settings, content, experiment_start, flow_backfill, item_attribute_rows, item_default_page_rows, item_preorder, item_preorder_children, item_pricing, item_variations, params, postcard_test_mail, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider, transactional_email].hash
340
+ [action, affiliate_network, comms_list_import, comms_settings, content, delegate_email, experiment_start, flow_backfill, item_attribute_rows, item_default_page_rows, item_preorder, item_preorder_children, item_pricing, item_variations, params, postcard_test_mail, reason, redirect_rows, segment_update, site_seo, smart_attribution, tracking_provider, transactional_email].hash
331
341
  end
332
342
 
333
343
  # 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.247'
14
+ VERSION = '4.1.249'
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.249
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart