ultracart_api 4.1.215 → 4.1.217

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: 5e6a1f58298e6be7c7315a1d178bb1f6d3a419eebcd271dcbc69d222322411ce
4
- data.tar.gz: ba290b264b1eebea6e21742fc5912ed1d8a34bb1061684c0ddeefb8d0317cf5c
3
+ metadata.gz: d76c0b992eed2bfb5349e08efa3b2d62da4187db95f2337e2762d4a16ea835cc
4
+ data.tar.gz: 777c310a760c3b0beccea56908addcda91755175dd9de0ad4061a1153138e88f
5
5
  SHA512:
6
- metadata.gz: 7c5650d80171ed9a4a66dde88f638412e6d1f20c86e174354ea0a76ebcc898775613fca1a3bddb425ab78ddb07c3cad90bfe19b096bb98143de968dadca818e4
7
- data.tar.gz: ed66c16777f49efb3db6518750e80952bc2219b4cad97df4f7c205236b1a96f3608977fada351c8642f1a79339341a81382bcfd8ec63867202e6be4a08751c79
6
+ metadata.gz: c845f286641cac78685b9b6b94c7859117949b6b12b4a3996c541432603dc6cf4d6c718105852a1d791a9fd33372fe898e720b7ab11f7731a8708354b484d148
7
+ data.tar.gz: be12ad91c7d4e25688a40b42b85b3390548d2ea88ede70d3ae5de89c02ded837114f0ba41de0a6afc531ff37e6e5d37470ae25ce9da84ad81d30b184ba88e846
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.215
10
+ - Package version: 4.1.217
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.215'
19
+ gem 'ultracart_api', '4.1.217'
20
20
  ```
21
21
 
22
22
  install:
@@ -505,6 +505,7 @@ Class | Method | HTTP request | Description
505
505
  *UltracartClient::SfvbApi* | [**delete_sfvb_redirect**](docs/SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule
506
506
  *UltracartClient::SfvbApi* | [**delete_sfvb_redirects**](docs/SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call
507
507
  *UltracartClient::SfvbApi* | [**delete_sfvb_secret_request**](docs/SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request
508
+ *UltracartClient::SfvbApi* | [**delete_sfvb_sequence_step**](docs/SfvbApi.md#delete_sfvb_sequence_step) | **DELETE** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Remove one step
508
509
  *UltracartClient::SfvbApi* | [**detach_sfvb_blog_post_image**](docs/SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post
509
510
  *UltracartClient::SfvbApi* | [**disable_sfvb_i18n_language**](docs/SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language
510
511
  *UltracartClient::SfvbApi* | [**disable_sfvb_upsell_offer**](docs/SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer
@@ -593,6 +594,7 @@ Class | Method | HTTP request | Description
593
594
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
594
595
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
595
596
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
597
+ *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
596
598
  *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_offer**](docs/SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer
597
599
  *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_path**](docs/SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path
598
600
  *UltracartClient::SfvbApi* | [**install_sfvb_library_entry**](docs/SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront
@@ -2112,6 +2114,9 @@ Class | Method | HTTP request | Description
2112
2114
  - [UltracartClient::SfvbSequence](docs/SfvbSequence.md)
2113
2115
  - [UltracartClient::SfvbSequenceBranch](docs/SfvbSequenceBranch.md)
2114
2116
  - [UltracartClient::SfvbSequenceStep](docs/SfvbSequenceStep.md)
2117
+ - [UltracartClient::SfvbSequenceStepCreateRequest](docs/SfvbSequenceStepCreateRequest.md)
2118
+ - [UltracartClient::SfvbSequenceStepCreateResponse](docs/SfvbSequenceStepCreateResponse.md)
2119
+ - [UltracartClient::SfvbSequenceStepDeleteResponse](docs/SfvbSequenceStepDeleteResponse.md)
2115
2120
  - [UltracartClient::SfvbSequenceStepUpdateRequest](docs/SfvbSequenceStepUpdateRequest.md)
2116
2121
  - [UltracartClient::SfvbSequenceStepUpdateResponse](docs/SfvbSequenceStepUpdateResponse.md)
2117
2122
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
@@ -2331,6 +2336,8 @@ Not every change is committed to every SDK.
2331
2336
 
2332
2337
  | Version | Date | Comments |
2333
2338
  | --: | :-: | --- |
2339
+ | 4.1.217 | 10/29/2026 | sfvb internal testing |
2340
+ | 4.1.216 | 10/29/2026 | sfvb internal testing |
2334
2341
  | 4.1.215 | 10/28/2026 | sfvb internal testing |
2335
2342
  | 4.1.214 | 10/28/2026 | sfvb internal testing |
2336
2343
  | 4.1.213 | 10/28/2026 | auto order - improve item field descriptions |
data/docs/SfvbApi.md CHANGED
@@ -33,6 +33,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
33
33
  | [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
34
34
  | [**delete_sfvb_redirects**](SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call |
35
35
  | [**delete_sfvb_secret_request**](SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request |
36
+ | [**delete_sfvb_sequence_step**](SfvbApi.md#delete_sfvb_sequence_step) | **DELETE** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Remove one step |
36
37
  | [**detach_sfvb_blog_post_image**](SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post |
37
38
  | [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
38
39
  | [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
@@ -121,6 +122,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
121
122
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
122
123
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
123
124
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
125
+ | [**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 |
124
126
  | [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
125
127
  | [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
126
128
  | [**install_sfvb_library_entry**](SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront |
@@ -1792,6 +1794,63 @@ end
1792
1794
  - **Accept**: application/json
1793
1795
 
1794
1796
 
1797
+ ## delete_sfvb_sequence_step
1798
+
1799
+ > <SfvbSequenceStepDeleteResponse> delete_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
1800
+
1801
+ Remove one step
1802
+
1803
+ Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step's email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step's hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
1804
+
1805
+
1806
+ ### Examples
1807
+
1808
+
1809
+ (No example for this operation).
1810
+
1811
+
1812
+ #### Using the delete_sfvb_sequence_step_with_http_info variant
1813
+
1814
+ This returns an Array which contains the response data, status code and headers.
1815
+
1816
+ > <Array(<SfvbSequenceStepDeleteResponse>, Integer, Hash)> delete_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
1817
+
1818
+ ```ruby
1819
+ begin
1820
+ # Remove one step
1821
+ data, status_code, headers = api_instance.delete_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
1822
+ p status_code # => 2xx
1823
+ p headers # => { ... }
1824
+ p data # => <SfvbSequenceStepDeleteResponse>
1825
+ rescue UltracartClient::ApiError => e
1826
+ puts "Error when calling SfvbApi->delete_sfvb_sequence_step_with_http_info: #{e}"
1827
+ end
1828
+ ```
1829
+
1830
+ ### Parameters
1831
+
1832
+ | Name | Type | Description | Notes |
1833
+ | ---- | ---- | ----------- | ----- |
1834
+ | **storefront_oid** | **Integer** | | |
1835
+ | **sequence_uuid** | **String** | | |
1836
+ | **step_uuid** | **String** | | |
1837
+ | **if_match** | **String** | The step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
1838
+ | **approval_id** | **String** | When the sequence is live, the approval_id of an approved sequence_step.delete request for this step. See POST /sfvb/approvals. | [optional] |
1839
+
1840
+ ### Return type
1841
+
1842
+ [**SfvbSequenceStepDeleteResponse**](SfvbSequenceStepDeleteResponse.md)
1843
+
1844
+ ### Authorization
1845
+
1846
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1847
+
1848
+ ### HTTP request headers
1849
+
1850
+ - **Content-Type**: Not defined
1851
+ - **Accept**: application/json
1852
+
1853
+
1795
1854
  ## detach_sfvb_blog_post_image
1796
1855
 
1797
1856
  > <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
@@ -6550,6 +6609,62 @@ end
6550
6609
  - **Accept**: application/json
6551
6610
 
6552
6611
 
6612
+ ## insert_sfvb_sequence_step
6613
+
6614
+ > <SfvbSequenceStepCreateResponse> insert_sfvb_sequence_step(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
6615
+
6616
+ Add an email step, with its new email
6617
+
6618
+ Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It 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 email, as the admin's editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
6619
+
6620
+
6621
+ ### Examples
6622
+
6623
+
6624
+ (No example for this operation).
6625
+
6626
+
6627
+ #### Using the insert_sfvb_sequence_step_with_http_info variant
6628
+
6629
+ This returns an Array which contains the response data, status code and headers.
6630
+
6631
+ > <Array(<SfvbSequenceStepCreateResponse>, Integer, Hash)> insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
6632
+
6633
+ ```ruby
6634
+ begin
6635
+ # Add an email step, with its new email
6636
+ data, status_code, headers = api_instance.insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
6637
+ p status_code # => 2xx
6638
+ p headers # => { ... }
6639
+ p data # => <SfvbSequenceStepCreateResponse>
6640
+ rescue UltracartClient::ApiError => e
6641
+ puts "Error when calling SfvbApi->insert_sfvb_sequence_step_with_http_info: #{e}"
6642
+ end
6643
+ ```
6644
+
6645
+ ### Parameters
6646
+
6647
+ | Name | Type | Description | Notes |
6648
+ | ---- | ---- | ----------- | ----- |
6649
+ | **storefront_oid** | **Integer** | | |
6650
+ | **sequence_uuid** | **String** | | |
6651
+ | **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. | |
6652
+ | **sequence_step_create_request** | [**SfvbSequenceStepCreateRequest**](SfvbSequenceStepCreateRequest.md) | Where the step goes, and the new email&#39;s subject and preview text | |
6653
+
6654
+ ### Return type
6655
+
6656
+ [**SfvbSequenceStepCreateResponse**](SfvbSequenceStepCreateResponse.md)
6657
+
6658
+ ### Authorization
6659
+
6660
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6661
+
6662
+ ### HTTP request headers
6663
+
6664
+ - **Content-Type**: application/json
6665
+ - **Accept**: application/json
6666
+
6667
+
6553
6668
  ## insert_sfvb_upsell_offer
6554
6669
 
6555
6670
  > <SfvbUpsellOffer> insert_sfvb_upsell_offer(storefront_oid, upsell_offer)
@@ -16,7 +16,9 @@
16
16
  | **request_sha256** | **String** | For experiment.start of a url experiment, the hash of the checked experiment approved, and for item.pricing the hash of the change. Set by the server. The gated call must send the same. | [optional] |
17
17
  | **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] |
18
18
  | **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
19
+ | **sequence_uuid** | **String** | The communication sequence, for sequence_step.delete. | [optional] |
19
20
  | **slot** | **String** | For experiment.start of a page experiment, the page body name. Defaults to body. | [optional] |
21
+ | **step_uuid** | **String** | The step to remove, for sequence_step.delete. | [optional] |
20
22
  | **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
21
23
  | **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
22
24
  | **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
@@ -41,7 +43,9 @@ instance = UltracartClient::SfvbApprovalParams.new(
41
43
  request_sha256: null,
42
44
  rows_sha256: null,
43
45
  rule_count: null,
46
+ sequence_uuid: null,
44
47
  slot: null,
48
+ step_uuid: null,
45
49
  upsell_kind: null,
46
50
  upsell_oid: null,
47
51
  version: null,
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbSequenceStepCreateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **after_step_uuid** | **String** | The step the new step follows, in the same list. Not an end, continue or merge step. | [optional] |
8
+ | **branch_step_uuid** | **String** | A condition, split or inboxgeek step. With side, the new step goes first on that side. | [optional] |
9
+ | **preview_text** | **String** | The new email&#39;s preview text, 5 to 150 characters. | [optional] |
10
+ | **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] |
11
+ | **subject** | **String** | The new email&#39;s subject line, 5 to 150 characters. | [optional] |
12
+ | **type** | **String** | The kind of step. Only email for now. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbSequenceStepCreateRequest.new(
20
+ after_step_uuid: null,
21
+ branch_step_uuid: null,
22
+ preview_text: null,
23
+ side: null,
24
+ subject: null,
25
+ type: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbSequenceStepCreateResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email_uuid** | **String** | The new email&#39;s uuid. Its body is the email container with this owner id. | [optional] |
8
+ | **notes** | **Array&lt;String&gt;** | What to do next, such as writing the body, and customers already waiting on the step before it. | [optional] |
9
+ | **requires_review** | **Boolean** | True when the new email must pass content review before it sends. | [optional] |
10
+ | **step** | [**SfvbSequenceStep**](SfvbSequenceStep.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbSequenceStepCreateResponse.new(
18
+ email_uuid: null,
19
+ notes: null,
20
+ requires_review: null,
21
+ step: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbSequenceStepDeleteResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **archived_email_uuids** | **Array&lt;String&gt;** | The emails the step sent, now archived. | [optional] |
8
+ | **archived_postcard_uuids** | **Array&lt;String&gt;** | The postcard the step sent, now archived. | [optional] |
9
+ | **notes** | **Array&lt;String&gt;** | What was removed and archived, in words. | [optional] |
10
+ | **removed_step_uuids** | **Array&lt;String&gt;** | The step removed, then any end, continue or merge markers that were on its sides. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbSequenceStepDeleteResponse.new(
18
+ archived_email_uuids: null,
19
+ archived_postcard_uuids: null,
20
+ notes: null,
21
+ removed_step_uuids: null
22
+ )
23
+ ```
24
+
@@ -2182,6 +2182,92 @@ module UltracartClient
2182
2182
  return data, status_code, headers
2183
2183
  end
2184
2184
 
2185
+ # Remove one step
2186
+ # Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step's email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step's hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
2187
+ # @param storefront_oid [Integer]
2188
+ # @param sequence_uuid [String]
2189
+ # @param step_uuid [String]
2190
+ # @param if_match [String] The step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
2191
+ # @param [Hash] opts the optional parameters
2192
+ # @option opts [String] :approval_id When the sequence is live, the approval_id of an approved sequence_step.delete request for this step. See POST /sfvb/approvals.
2193
+ # @return [SfvbSequenceStepDeleteResponse]
2194
+ def delete_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, opts = {})
2195
+ data, _status_code, _headers = delete_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, opts)
2196
+ data
2197
+ end
2198
+
2199
+ # Remove one step
2200
+ # Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step&#39;s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step&#39;s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
2201
+ # @param storefront_oid [Integer]
2202
+ # @param sequence_uuid [String]
2203
+ # @param step_uuid [String]
2204
+ # @param if_match [String] The step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
2205
+ # @param [Hash] opts the optional parameters
2206
+ # @option opts [String] :approval_id When the sequence is live, the approval_id of an approved sequence_step.delete request for this step. See POST /sfvb/approvals.
2207
+ # @return [Array<(SfvbSequenceStepDeleteResponse, Integer, Hash)>] SfvbSequenceStepDeleteResponse data, response status code and response headers
2208
+ def delete_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, opts = {})
2209
+ if @api_client.config.debugging
2210
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_sequence_step ...'
2211
+ end
2212
+ # verify the required parameter 'storefront_oid' is set
2213
+ if @api_client.config.client_side_validation && storefront_oid.nil?
2214
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_sequence_step"
2215
+ end
2216
+ # verify the required parameter 'sequence_uuid' is set
2217
+ if @api_client.config.client_side_validation && sequence_uuid.nil?
2218
+ fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.delete_sfvb_sequence_step"
2219
+ end
2220
+ # verify the required parameter 'step_uuid' is set
2221
+ if @api_client.config.client_side_validation && step_uuid.nil?
2222
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.delete_sfvb_sequence_step"
2223
+ end
2224
+ # verify the required parameter 'if_match' is set
2225
+ if @api_client.config.client_side_validation && if_match.nil?
2226
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.delete_sfvb_sequence_step"
2227
+ end
2228
+ # resource path
2229
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
2230
+
2231
+ # query parameters
2232
+ query_params = opts[:query_params] || {}
2233
+
2234
+ # header parameters
2235
+ header_params = opts[:header_params] || {}
2236
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2237
+ # HTTP header 'Accept' (if needed)
2238
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2239
+ header_params[:'If-Match'] = if_match
2240
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
2241
+
2242
+ # form parameters
2243
+ form_params = opts[:form_params] || {}
2244
+
2245
+ # http body (model)
2246
+ post_body = opts[:debug_body]
2247
+
2248
+ # return_type
2249
+ return_type = opts[:debug_return_type] || 'SfvbSequenceStepDeleteResponse'
2250
+
2251
+ # auth_names
2252
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2253
+
2254
+ new_options = opts.merge(
2255
+ :operation => :"SfvbApi.delete_sfvb_sequence_step",
2256
+ :header_params => header_params,
2257
+ :query_params => query_params,
2258
+ :form_params => form_params,
2259
+ :body => post_body,
2260
+ :auth_names => auth_names,
2261
+ :return_type => return_type
2262
+ )
2263
+
2264
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
2265
+ if @api_client.config.debugging
2266
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_sequence_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2267
+ end
2268
+ return data, status_code, headers
2269
+ end
2270
+
2185
2271
  # Detach an image from a blog post
2186
2272
  # Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
2187
2273
  # @param storefront_oid [Integer]
@@ -8370,6 +8456,94 @@ module UltracartClient
8370
8456
  return data, status_code, headers
8371
8457
  end
8372
8458
 
8459
+ # Add an email step, with its new email
8460
+ # Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It 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 email, as the admin's editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
8461
+ # @param storefront_oid [Integer]
8462
+ # @param sequence_uuid [String]
8463
+ # @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.
8464
+ # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email&#39;s subject and preview text
8465
+ # @param [Hash] opts the optional parameters
8466
+ # @return [SfvbSequenceStepCreateResponse]
8467
+ def insert_sfvb_sequence_step(storefront_oid, sequence_uuid, if_match, sequence_step_create_request, opts = {})
8468
+ data, _status_code, _headers = insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request, opts)
8469
+ data
8470
+ end
8471
+
8472
+ # Add an email step, with its new email
8473
+ # Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It 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 email, as the admin&#39;s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
8474
+ # @param storefront_oid [Integer]
8475
+ # @param sequence_uuid [String]
8476
+ # @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.
8477
+ # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email&#39;s subject and preview text
8478
+ # @param [Hash] opts the optional parameters
8479
+ # @return [Array<(SfvbSequenceStepCreateResponse, Integer, Hash)>] SfvbSequenceStepCreateResponse data, response status code and response headers
8480
+ def insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request, opts = {})
8481
+ if @api_client.config.debugging
8482
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_sequence_step ...'
8483
+ end
8484
+ # verify the required parameter 'storefront_oid' is set
8485
+ if @api_client.config.client_side_validation && storefront_oid.nil?
8486
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_sequence_step"
8487
+ end
8488
+ # verify the required parameter 'sequence_uuid' is set
8489
+ if @api_client.config.client_side_validation && sequence_uuid.nil?
8490
+ fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.insert_sfvb_sequence_step"
8491
+ end
8492
+ # verify the required parameter 'if_match' is set
8493
+ if @api_client.config.client_side_validation && if_match.nil?
8494
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.insert_sfvb_sequence_step"
8495
+ end
8496
+ # verify the required parameter 'sequence_step_create_request' is set
8497
+ if @api_client.config.client_side_validation && sequence_step_create_request.nil?
8498
+ fail ArgumentError, "Missing the required parameter 'sequence_step_create_request' when calling SfvbApi.insert_sfvb_sequence_step"
8499
+ end
8500
+ # resource path
8501
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s))
8502
+
8503
+ # query parameters
8504
+ query_params = opts[:query_params] || {}
8505
+
8506
+ # header parameters
8507
+ header_params = opts[:header_params] || {}
8508
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
8509
+ # HTTP header 'Accept' (if needed)
8510
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8511
+ # HTTP header 'Content-Type'
8512
+ content_type = @api_client.select_header_content_type(['application/json'])
8513
+ if !content_type.nil?
8514
+ header_params['Content-Type'] = content_type
8515
+ end
8516
+ header_params[:'If-Match'] = if_match
8517
+
8518
+ # form parameters
8519
+ form_params = opts[:form_params] || {}
8520
+
8521
+ # http body (model)
8522
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sequence_step_create_request)
8523
+
8524
+ # return_type
8525
+ return_type = opts[:debug_return_type] || 'SfvbSequenceStepCreateResponse'
8526
+
8527
+ # auth_names
8528
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
8529
+
8530
+ new_options = opts.merge(
8531
+ :operation => :"SfvbApi.insert_sfvb_sequence_step",
8532
+ :header_params => header_params,
8533
+ :query_params => query_params,
8534
+ :form_params => form_params,
8535
+ :body => post_body,
8536
+ :auth_names => auth_names,
8537
+ :return_type => return_type
8538
+ )
8539
+
8540
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8541
+ if @api_client.config.debugging
8542
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_sequence_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8543
+ end
8544
+ return data, status_code, headers
8545
+ end
8546
+
8373
8547
  # Create an upsell offer
8374
8548
  # Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
8375
8549
  # @param storefront_oid [Integer]
@@ -260,7 +260,7 @@ module UltracartClient
260
260
  # Check to see if the all the properties in the model are valid
261
261
  # @return true if the model is valid
262
262
  def valid?
263
- payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane", "Klarna"])
263
+ payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Truemed", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane", "Klarna"])
264
264
  return false unless payment_method_validator.valid?(@payment_method)
265
265
  payment_status_validator = EnumAttributeValidator.new('String', ["Unprocessed", "Authorized", "Capture Failed", "Processed", "Declined", "Voided", "Refunded", "Skipped"])
266
266
  return false unless payment_status_validator.valid?(@payment_status)
@@ -270,7 +270,7 @@ module UltracartClient
270
270
  # Custom attribute writer method checking allowed values (enum).
271
271
  # @param [Object] payment_method Object to be assigned
272
272
  def payment_method=(payment_method)
273
- validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane", "Klarna"])
273
+ validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Truemed", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane", "Klarna"])
274
274
  unless validator.valid?(payment_method)
275
275
  fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
276
276
  end
@@ -159,7 +159,7 @@ module UltracartClient
159
159
  # Check to see if the all the properties in the model are valid
160
160
  # @return true if the model is valid
161
161
  def valid?
162
- 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"])
162
+ 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", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete"])
163
163
  return false unless action_validator.valid?(@action)
164
164
  true
165
165
  end
@@ -167,7 +167,7 @@ module UltracartClient
167
167
  # Custom attribute writer method checking allowed values (enum).
168
168
  # @param [Object] action Object to be assigned
169
169
  def action=(action)
170
- 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"])
170
+ 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", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete"])
171
171
  unless validator.valid?(action)
172
172
  fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
173
173
  end
@@ -51,9 +51,15 @@ module UltracartClient
51
51
  # For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server.
52
52
  attr_accessor :rule_count
53
53
 
54
+ # The communication sequence, for sequence_step.delete.
55
+ attr_accessor :sequence_uuid
56
+
54
57
  # For experiment.start of a page experiment, the page body name. Defaults to body.
55
58
  attr_accessor :slot
56
59
 
60
+ # The step to remove, for sequence_step.delete.
61
+ attr_accessor :step_uuid
62
+
57
63
  # For upsell.enable, what to switch on.
58
64
  attr_accessor :upsell_kind
59
65
 
@@ -106,7 +112,9 @@ module UltracartClient
106
112
  :'request_sha256' => :'request_sha256',
107
113
  :'rows_sha256' => :'rows_sha256',
108
114
  :'rule_count' => :'rule_count',
115
+ :'sequence_uuid' => :'sequence_uuid',
109
116
  :'slot' => :'slot',
117
+ :'step_uuid' => :'step_uuid',
110
118
  :'upsell_kind' => :'upsell_kind',
111
119
  :'upsell_oid' => :'upsell_oid',
112
120
  :'version' => :'version',
@@ -135,7 +143,9 @@ module UltracartClient
135
143
  :'request_sha256' => :'String',
136
144
  :'rows_sha256' => :'String',
137
145
  :'rule_count' => :'Integer',
146
+ :'sequence_uuid' => :'String',
138
147
  :'slot' => :'String',
148
+ :'step_uuid' => :'String',
139
149
  :'upsell_kind' => :'String',
140
150
  :'upsell_oid' => :'Integer',
141
151
  :'version' => :'Integer',
@@ -215,10 +225,18 @@ module UltracartClient
215
225
  self.rule_count = attributes[:'rule_count']
216
226
  end
217
227
 
228
+ if attributes.key?(:'sequence_uuid')
229
+ self.sequence_uuid = attributes[:'sequence_uuid']
230
+ end
231
+
218
232
  if attributes.key?(:'slot')
219
233
  self.slot = attributes[:'slot']
220
234
  end
221
235
 
236
+ if attributes.key?(:'step_uuid')
237
+ self.step_uuid = attributes[:'step_uuid']
238
+ end
239
+
222
240
  if attributes.key?(:'upsell_kind')
223
241
  self.upsell_kind = attributes[:'upsell_kind']
224
242
  end
@@ -282,7 +300,9 @@ module UltracartClient
282
300
  request_sha256 == o.request_sha256 &&
283
301
  rows_sha256 == o.rows_sha256 &&
284
302
  rule_count == o.rule_count &&
303
+ sequence_uuid == o.sequence_uuid &&
285
304
  slot == o.slot &&
305
+ step_uuid == o.step_uuid &&
286
306
  upsell_kind == o.upsell_kind &&
287
307
  upsell_oid == o.upsell_oid &&
288
308
  version == o.version &&
@@ -299,7 +319,7 @@ module UltracartClient
299
319
  # Calculates hash code according to all attributes.
300
320
  # @return [Integer] Hash code
301
321
  def hash
302
- [attribute_names, blog_post_oid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, path, request_sha256, rows_sha256, rule_count, slot, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
322
+ [attribute_names, blog_post_oid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, path, request_sha256, rows_sha256, rule_count, sequence_uuid, slot, step_uuid, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
303
323
  end
304
324
 
305
325
  # Builds the object from hash