ultracart_api 4.1.216 → 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: c9d982114341675667b756d95ce82f8b73da11be370ae3be33c299498d979890
4
- data.tar.gz: '018a0ed9d2b4b54698c322ffabf20ae0ba0eb71d5f00ca98e46cbf90d7b2a301'
3
+ metadata.gz: d76c0b992eed2bfb5349e08efa3b2d62da4187db95f2337e2762d4a16ea835cc
4
+ data.tar.gz: 777c310a760c3b0beccea56908addcda91755175dd9de0ad4061a1153138e88f
5
5
  SHA512:
6
- metadata.gz: 5cbd5537546c75260f4c6717a22f811552d27b7e99ccc18d5d34a38f97140f23a3169dcf66d165fd1c22816d34cc0bc094102e0fd66a60c199d01f79e306f5bd
7
- data.tar.gz: f67506e1c0f8f1ac33c90e2e6d31d7abcc376f8d642814c6e51c7504bdd8b8ec48c97e0346e9ae6f3cc1f55fe7cb4e2468d34042a9c160b3704ce5587311d2f7
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.216
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.216'
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
@@ -2115,6 +2116,7 @@ Class | Method | HTTP request | Description
2115
2116
  - [UltracartClient::SfvbSequenceStep](docs/SfvbSequenceStep.md)
2116
2117
  - [UltracartClient::SfvbSequenceStepCreateRequest](docs/SfvbSequenceStepCreateRequest.md)
2117
2118
  - [UltracartClient::SfvbSequenceStepCreateResponse](docs/SfvbSequenceStepCreateResponse.md)
2119
+ - [UltracartClient::SfvbSequenceStepDeleteResponse](docs/SfvbSequenceStepDeleteResponse.md)
2118
2120
  - [UltracartClient::SfvbSequenceStepUpdateRequest](docs/SfvbSequenceStepUpdateRequest.md)
2119
2121
  - [UltracartClient::SfvbSequenceStepUpdateResponse](docs/SfvbSequenceStepUpdateResponse.md)
2120
2122
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
@@ -2334,6 +2336,7 @@ Not every change is committed to every SDK.
2334
2336
 
2335
2337
  | Version | Date | Comments |
2336
2338
  | --: | :-: | --- |
2339
+ | 4.1.217 | 10/29/2026 | sfvb internal testing |
2337
2340
  | 4.1.216 | 10/29/2026 | sfvb internal testing |
2338
2341
  | 4.1.215 | 10/28/2026 | sfvb internal testing |
2339
2342
  | 4.1.214 | 10/28/2026 | sfvb internal testing |
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 |
@@ -1793,6 +1794,63 @@ end
1793
1794
  - **Accept**: application/json
1794
1795
 
1795
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
+
1796
1854
  ## detach_sfvb_blog_post_image
1797
1855
 
1798
1856
  > <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
@@ -6557,7 +6615,7 @@ end
6557
6615
 
6558
6616
  Add an email step, with its new email
6559
6617
 
6560
- 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. 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.
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.
6561
6619
 
6562
6620
 
6563
6621
  ### Examples
@@ -6590,7 +6648,7 @@ end
6590
6648
  | ---- | ---- | ----------- | ----- |
6591
6649
  | **storefront_oid** | **Integer** | | |
6592
6650
  | **sequence_uuid** | **String** | | |
6593
- | **if_match** | **String** | The hash_sha256 of the step it goes after, or of the branching step. Required; 428 when absent, 412 when stale. | |
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. | |
6594
6652
  | **sequence_step_create_request** | [**SfvbSequenceStepCreateRequest**](SfvbSequenceStepCreateRequest.md) | Where the step goes, and the new email&#39;s subject and preview text | |
6595
6653
 
6596
6654
  ### Return type
@@ -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,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]
@@ -8371,10 +8457,10 @@ module UltracartClient
8371
8457
  end
8372
8458
 
8373
8459
  # Add an email step, with its new email
8374
- # 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. 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.
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.
8375
8461
  # @param storefront_oid [Integer]
8376
8462
  # @param sequence_uuid [String]
8377
- # @param if_match [String] The hash_sha256 of the step it goes after, or of the branching step. Required; 428 when absent, 412 when stale.
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.
8378
8464
  # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email&#39;s subject and preview text
8379
8465
  # @param [Hash] opts the optional parameters
8380
8466
  # @return [SfvbSequenceStepCreateResponse]
@@ -8384,10 +8470,10 @@ module UltracartClient
8384
8470
  end
8385
8471
 
8386
8472
  # Add an email step, with its new email
8387
- # 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. 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.
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.
8388
8474
  # @param storefront_oid [Integer]
8389
8475
  # @param sequence_uuid [String]
8390
- # @param if_match [String] The hash_sha256 of the step it goes after, or of the branching step. Required; 428 when absent, 412 when stale.
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.
8391
8477
  # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email&#39;s subject and preview text
8392
8478
  # @param [Hash] opts the optional parameters
8393
8479
  # @return [Array<(SfvbSequenceStepCreateResponse, Integer, Hash)>] SfvbSequenceStepCreateResponse data, response status code and response headers
@@ -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
@@ -0,0 +1,258 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module UltracartClient
17
+ class SfvbSequenceStepDeleteResponse
18
+ # The emails the step sent, now archived.
19
+ attr_accessor :archived_email_uuids
20
+
21
+ # The postcard the step sent, now archived.
22
+ attr_accessor :archived_postcard_uuids
23
+
24
+ # What was removed and archived, in words.
25
+ attr_accessor :notes
26
+
27
+ # The step removed, then any end, continue or merge markers that were on its sides.
28
+ attr_accessor :removed_step_uuids
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+ :'archived_email_uuids' => :'archived_email_uuids',
34
+ :'archived_postcard_uuids' => :'archived_postcard_uuids',
35
+ :'notes' => :'notes',
36
+ :'removed_step_uuids' => :'removed_step_uuids'
37
+ }
38
+ end
39
+
40
+ # Returns all the JSON keys this model knows about
41
+ def self.acceptable_attributes
42
+ attribute_map.values
43
+ end
44
+
45
+ # Attribute type mapping.
46
+ def self.openapi_types
47
+ {
48
+ :'archived_email_uuids' => :'Array<String>',
49
+ :'archived_postcard_uuids' => :'Array<String>',
50
+ :'notes' => :'Array<String>',
51
+ :'removed_step_uuids' => :'Array<String>'
52
+ }
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ ])
59
+ end
60
+
61
+ # Initializes the object
62
+ # @param [Hash] attributes Model attributes in the form of hash
63
+ def initialize(attributes = {})
64
+ if (!attributes.is_a?(Hash))
65
+ fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbSequenceStepDeleteResponse` initialize method"
66
+ end
67
+
68
+ # check to see if the attribute exists and convert string to symbol for hash key
69
+ attributes = attributes.each_with_object({}) { |(k, v), h|
70
+ if (!self.class.attribute_map.key?(k.to_sym))
71
+ fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbSequenceStepDeleteResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
+ end
73
+ h[k.to_sym] = v
74
+ }
75
+
76
+ if attributes.key?(:'archived_email_uuids')
77
+ if (value = attributes[:'archived_email_uuids']).is_a?(Array)
78
+ self.archived_email_uuids = value
79
+ end
80
+ end
81
+
82
+ if attributes.key?(:'archived_postcard_uuids')
83
+ if (value = attributes[:'archived_postcard_uuids']).is_a?(Array)
84
+ self.archived_postcard_uuids = value
85
+ end
86
+ end
87
+
88
+ if attributes.key?(:'notes')
89
+ if (value = attributes[:'notes']).is_a?(Array)
90
+ self.notes = value
91
+ end
92
+ end
93
+
94
+ if attributes.key?(:'removed_step_uuids')
95
+ if (value = attributes[:'removed_step_uuids']).is_a?(Array)
96
+ self.removed_step_uuids = value
97
+ end
98
+ end
99
+ end
100
+
101
+ # Show invalid properties with the reasons. Usually used together with valid?
102
+ # @return Array for valid properties with the reasons
103
+ def list_invalid_properties
104
+ invalid_properties = Array.new
105
+ invalid_properties
106
+ end
107
+
108
+ # Check to see if the all the properties in the model are valid
109
+ # @return true if the model is valid
110
+ def valid?
111
+ true
112
+ end
113
+
114
+ # Checks equality by comparing each attribute.
115
+ # @param [Object] Object to be compared
116
+ def ==(o)
117
+ return true if self.equal?(o)
118
+ self.class == o.class &&
119
+ archived_email_uuids == o.archived_email_uuids &&
120
+ archived_postcard_uuids == o.archived_postcard_uuids &&
121
+ notes == o.notes &&
122
+ removed_step_uuids == o.removed_step_uuids
123
+ end
124
+
125
+ # @see the `==` method
126
+ # @param [Object] Object to be compared
127
+ def eql?(o)
128
+ self == o
129
+ end
130
+
131
+ # Calculates hash code according to all attributes.
132
+ # @return [Integer] Hash code
133
+ def hash
134
+ [archived_email_uuids, archived_postcard_uuids, notes, removed_step_uuids].hash
135
+ end
136
+
137
+ # Builds the object from hash
138
+ # @param [Hash] attributes Model attributes in the form of hash
139
+ # @return [Object] Returns the model itself
140
+ def self.build_from_hash(attributes)
141
+ new.build_from_hash(attributes)
142
+ end
143
+
144
+ # Builds the object from hash
145
+ # @param [Hash] attributes Model attributes in the form of hash
146
+ # @return [Object] Returns the model itself
147
+ def build_from_hash(attributes)
148
+ return nil unless attributes.is_a?(Hash)
149
+ attributes = attributes.transform_keys(&:to_sym)
150
+ self.class.openapi_types.each_pair do |key, type|
151
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
152
+ self.send("#{key}=", nil)
153
+ elsif type =~ /\AArray<(.*)>/i
154
+ # check to ensure the input is an array given that the attribute
155
+ # is documented as an array but the input is not
156
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
157
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
158
+ end
159
+ elsif !attributes[self.class.attribute_map[key]].nil?
160
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
161
+ end
162
+ end
163
+
164
+ self
165
+ end
166
+
167
+ # Deserializes the data based on type
168
+ # @param string type Data type
169
+ # @param string value Value to be deserialized
170
+ # @return [Object] Deserialized data
171
+ def _deserialize(type, value)
172
+ case type.to_sym
173
+ when :Time
174
+ Time.parse(value)
175
+ when :Date
176
+ Date.parse(value)
177
+ when :String
178
+ value.to_s
179
+ when :Integer
180
+ value.to_i
181
+ when :Float
182
+ value.to_f
183
+ when :Boolean
184
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
185
+ true
186
+ else
187
+ false
188
+ end
189
+ when :Object
190
+ # generic object (usually a Hash), return directly
191
+ value
192
+ when /\AArray<(?<inner_type>.+)>\z/
193
+ inner_type = Regexp.last_match[:inner_type]
194
+ value.map { |v| _deserialize(inner_type, v) }
195
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
196
+ k_type = Regexp.last_match[:k_type]
197
+ v_type = Regexp.last_match[:v_type]
198
+ {}.tap do |hash|
199
+ value.each do |k, v|
200
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
201
+ end
202
+ end
203
+ else # model
204
+ # models (e.g. Pet) or oneOf
205
+ klass = UltracartClient.const_get(type)
206
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
207
+ end
208
+ end
209
+
210
+ # Returns the string representation of the object
211
+ # @return [String] String presentation of the object
212
+ def to_s
213
+ to_hash.to_s
214
+ end
215
+
216
+ # to_body is an alias to to_hash (backward compatibility)
217
+ # @return [Hash] Returns the object in the form of hash
218
+ def to_body
219
+ to_hash
220
+ end
221
+
222
+ # Returns the object in the form of hash
223
+ # @return [Hash] Returns the object in the form of hash
224
+ def to_hash
225
+ hash = {}
226
+ self.class.attribute_map.each_pair do |attr, param|
227
+ value = self.send(attr)
228
+ if value.nil?
229
+ is_nullable = self.class.openapi_nullable.include?(attr)
230
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
231
+ end
232
+
233
+ hash[param] = _to_hash(value)
234
+ end
235
+ hash
236
+ end
237
+
238
+ # Outputs non-array value in the form of hash
239
+ # For object, use to_hash. Otherwise, just return the value
240
+ # @param [Object] value Any valid value
241
+ # @return [Hash] Returns the value in the form of hash
242
+ def _to_hash(value)
243
+ if value.is_a?(Array)
244
+ value.compact.map { |v| _to_hash(v) }
245
+ elsif value.is_a?(Hash)
246
+ {}.tap do |hash|
247
+ value.each { |k, v| hash[k] = _to_hash(v) }
248
+ end
249
+ elsif value.respond_to? :to_hash
250
+ value.to_hash
251
+ else
252
+ value
253
+ end
254
+ end
255
+
256
+ end
257
+
258
+ end
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '4.1.216'
14
+ VERSION = '4.1.217'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -1191,6 +1191,7 @@ require 'ultracart_api/models/sfvb_sequence_branch'
1191
1191
  require 'ultracart_api/models/sfvb_sequence_step'
1192
1192
  require 'ultracart_api/models/sfvb_sequence_step_create_request'
1193
1193
  require 'ultracart_api/models/sfvb_sequence_step_create_response'
1194
+ require 'ultracart_api/models/sfvb_sequence_step_delete_response'
1194
1195
  require 'ultracart_api/models/sfvb_sequence_step_update_request'
1195
1196
  require 'ultracart_api/models/sfvb_sequence_step_update_response'
1196
1197
  require 'ultracart_api/models/sfvb_server_log'
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.216
4
+ version: 4.1.217
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
@@ -1253,6 +1253,7 @@ files:
1253
1253
  - docs/SfvbSequenceStep.md
1254
1254
  - docs/SfvbSequenceStepCreateRequest.md
1255
1255
  - docs/SfvbSequenceStepCreateResponse.md
1256
+ - docs/SfvbSequenceStepDeleteResponse.md
1256
1257
  - docs/SfvbSequenceStepUpdateRequest.md
1257
1258
  - docs/SfvbSequenceStepUpdateResponse.md
1258
1259
  - docs/SfvbServerLog.md
@@ -2604,6 +2605,7 @@ files:
2604
2605
  - lib/ultracart_api/models/sfvb_sequence_step.rb
2605
2606
  - lib/ultracart_api/models/sfvb_sequence_step_create_request.rb
2606
2607
  - lib/ultracart_api/models/sfvb_sequence_step_create_response.rb
2608
+ - lib/ultracart_api/models/sfvb_sequence_step_delete_response.rb
2607
2609
  - lib/ultracart_api/models/sfvb_sequence_step_update_request.rb
2608
2610
  - lib/ultracart_api/models/sfvb_sequence_step_update_response.rb
2609
2611
  - lib/ultracart_api/models/sfvb_server_log.rb