ultracart_api 4.1.219 → 4.1.220

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: e85e145044e21ca3027cf792c90310a8514c9ea77b6653a1b44ce3df77beebcb
4
- data.tar.gz: 68de13bbf5f7aedde6487537f8180463517a740fd21297b9c953ef29138abe10
3
+ metadata.gz: d9f468a5a838e0757e3d1c52895907d01171a84e8c78886210c10a23ef59c2d4
4
+ data.tar.gz: 585ebaf78936ba8ca36c7f42737e08825d35bc06eeeaa85dfe32e8fdcd79ce06
5
5
  SHA512:
6
- metadata.gz: 4c0d1e3c50eaa9d3ca5ee5cedab03defc74ebdcf06f0c965fc57eb5d56a9e233d363615f6c75c3ed7dd5c239101066e98e664913b9a34b4b7bd74fdd2d16c935
7
- data.tar.gz: 58d3013bdc90636a7f0bc5a16a30682e9d45a1da68146ce15816d6482b8f22675e8e09d17b31c8debf2210b713323b3e9e72462cc46ff1c8d5f12ef341b76588
6
+ metadata.gz: c49285cea1818a391a316891abf1916c0a9aedfd1b936c9b49df28f261743607c742d9e249b25577fdf7dfdf6fc5dc2b1eb8f0c36eb91e434101d2e059a5ef03
7
+ data.tar.gz: 36ce759345a12d073a59301cc2dbbfea1f2ac943842b42c41c51967d0f0f82832a9a457c910b6c187ee9e9fb308d2638ab0d159f0dfb513fa932aa76f442aeb2
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.219
10
+ - Package version: 4.1.220
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.219'
19
+ gem 'ultracart_api', '4.1.220'
20
20
  ```
21
21
 
22
22
  install:
@@ -596,12 +596,13 @@ Class | Method | HTTP request | Description
596
596
  *UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
597
597
  *UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
598
598
  *UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
599
- *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
599
+ *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
600
600
  *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_offer**](docs/SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer
601
601
  *UltracartClient::SfvbApi* | [**insert_sfvb_upsell_path**](docs/SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path
602
602
  *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
603
603
  *UltracartClient::SfvbApi* | [**list_sfvb_blog_posts**](docs/SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts
604
604
  *UltracartClient::SfvbApi* | [**list_sfvb_campaigns**](docs/SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns
605
+ *UltracartClient::SfvbApi* | [**list_sfvb_code_library_emails**](docs/SfvbApi.md#list_sfvb_code_library_emails) | **GET** /sfvb/storefronts/{storefront_oid}/code_library/emails | Email items from the code library that can start a new email step
605
606
  *UltracartClient::SfvbApi* | [**list_sfvb_comms_lists**](docs/SfvbApi.md#list_sfvb_comms_lists) | **GET** /sfvb/storefronts/{storefront_oid}/lists | List the storefront's email lists
606
607
  *UltracartClient::SfvbApi* | [**list_sfvb_comms_segments**](docs/SfvbApi.md#list_sfvb_comms_segments) | **GET** /sfvb/storefronts/{storefront_oid}/segments | List the storefront's segments
607
608
  *UltracartClient::SfvbApi* | [**list_sfvb_container_versions**](docs/SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system
@@ -620,6 +621,7 @@ Class | Method | HTTP request | Description
620
621
  *UltracartClient::SfvbApi* | [**list_sfvb_themes**](docs/SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront
621
622
  *UltracartClient::SfvbApi* | [**list_sfvb_upsell_offers**](docs/SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers
622
623
  *UltracartClient::SfvbApi* | [**list_sfvb_upsell_paths**](docs/SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths
624
+ *UltracartClient::SfvbApi* | [**move_sfvb_sequence_step**](docs/SfvbApi.md#move_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move | Move one step
623
625
  *UltracartClient::SfvbApi* | [**move_sfvb_upsell_path**](docs/SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path
624
626
  *UltracartClient::SfvbApi* | [**publish_sfvb_library_entry**](docs/SfvbApi.md#publish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/publish | Publish a library entry's draft
625
627
  *UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
@@ -1929,6 +1931,8 @@ Class | Method | HTTP request | Description
1929
1931
  - [UltracartClient::SfvbCampaignMembership](docs/SfvbCampaignMembership.md)
1930
1932
  - [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
1931
1933
  - [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
1934
+ - [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
1935
+ - [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
1932
1936
  - [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
1933
1937
  - [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
1934
1938
  - [UltracartClient::SfvbCommsList](docs/SfvbCommsList.md)
@@ -2124,6 +2128,8 @@ Class | Method | HTTP request | Description
2124
2128
  - [UltracartClient::SfvbSequenceStepCreateRequest](docs/SfvbSequenceStepCreateRequest.md)
2125
2129
  - [UltracartClient::SfvbSequenceStepCreateResponse](docs/SfvbSequenceStepCreateResponse.md)
2126
2130
  - [UltracartClient::SfvbSequenceStepDeleteResponse](docs/SfvbSequenceStepDeleteResponse.md)
2131
+ - [UltracartClient::SfvbSequenceStepMoveRequest](docs/SfvbSequenceStepMoveRequest.md)
2132
+ - [UltracartClient::SfvbSequenceStepMoveResponse](docs/SfvbSequenceStepMoveResponse.md)
2127
2133
  - [UltracartClient::SfvbSequenceStepUpdateRequest](docs/SfvbSequenceStepUpdateRequest.md)
2128
2134
  - [UltracartClient::SfvbSequenceStepUpdateResponse](docs/SfvbSequenceStepUpdateResponse.md)
2129
2135
  - [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
@@ -2343,6 +2349,7 @@ Not every change is committed to every SDK.
2343
2349
 
2344
2350
  | Version | Date | Comments |
2345
2351
  | --: | :-: | --- |
2352
+ | 4.1.220 | 11/02/2026 | sfvb internal testing |
2346
2353
  | 4.1.219 | 10/30/2026 | item - field for hsa/fsa eligibility |
2347
2354
  | 4.1.218 | 10/30/2026 | svfb internal testing |
2348
2355
  | 4.1.217 | 10/29/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -124,12 +124,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
124
124
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
125
125
  | [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
126
126
  | [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
127
- | [**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 |
127
+ | [**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 |
128
128
  | [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
129
129
  | [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
130
130
  | [**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 |
131
131
  | [**list_sfvb_blog_posts**](SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts |
132
132
  | [**list_sfvb_campaigns**](SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns |
133
+ | [**list_sfvb_code_library_emails**](SfvbApi.md#list_sfvb_code_library_emails) | **GET** /sfvb/storefronts/{storefront_oid}/code_library/emails | Email items from the code library that can start a new email step |
133
134
  | [**list_sfvb_comms_lists**](SfvbApi.md#list_sfvb_comms_lists) | **GET** /sfvb/storefronts/{storefront_oid}/lists | List the storefront's email lists |
134
135
  | [**list_sfvb_comms_segments**](SfvbApi.md#list_sfvb_comms_segments) | **GET** /sfvb/storefronts/{storefront_oid}/segments | List the storefront's segments |
135
136
  | [**list_sfvb_container_versions**](SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system |
@@ -148,6 +149,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
148
149
  | [**list_sfvb_themes**](SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront |
149
150
  | [**list_sfvb_upsell_offers**](SfvbApi.md#list_sfvb_upsell_offers) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers | List upsell offers |
150
151
  | [**list_sfvb_upsell_paths**](SfvbApi.md#list_sfvb_upsell_paths) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths | List upsell paths |
152
+ | [**move_sfvb_sequence_step**](SfvbApi.md#move_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move | Move one step |
151
153
  | [**move_sfvb_upsell_path**](SfvbApi.md#move_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/move | Move an upsell path |
152
154
  | [**publish_sfvb_library_entry**](SfvbApi.md#publish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/publish | Publish a library entry's draft |
153
155
  | [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
@@ -6724,9 +6726,9 @@ end
6724
6726
 
6725
6727
  > <SfvbSequenceStepCreateResponse> insert_sfvb_sequence_step(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
6726
6728
 
6727
- Add an email step, with its new email
6729
+ Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
6728
6730
 
6729
- 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.
6731
+ 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.
6730
6732
 
6731
6733
 
6732
6734
  ### Examples
@@ -6743,7 +6745,7 @@ This returns an Array which contains the response data, status code and headers.
6743
6745
 
6744
6746
  ```ruby
6745
6747
  begin
6746
- # Add an email step, with its new email
6748
+ # Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
6747
6749
  data, status_code, headers = api_instance.insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
6748
6750
  p status_code # => 2xx
6749
6751
  p headers # => { ... }
@@ -6760,7 +6762,7 @@ end
6760
6762
  | **storefront_oid** | **Integer** | | |
6761
6763
  | **sequence_uuid** | **String** | | |
6762
6764
  | **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. | |
6763
- | **sequence_step_create_request** | [**SfvbSequenceStepCreateRequest**](SfvbSequenceStepCreateRequest.md) | Where the step goes, and the new email&#39;s subject and preview text | |
6765
+ | **sequence_step_create_request** | [**SfvbSequenceStepCreateRequest**](SfvbSequenceStepCreateRequest.md) | Where the step goes, and the new email&#39;s subject and preview text or code library item, the wait&#39;s config_json, or the postcard step&#39;s name | |
6764
6766
 
6765
6767
  ### Return type
6766
6768
 
@@ -7052,6 +7054,60 @@ end
7052
7054
  - **Accept**: application/json
7053
7055
 
7054
7056
 
7057
+ ## list_sfvb_code_library_emails
7058
+
7059
+ > <SfvbCodeLibraryEmailsResponse> list_sfvb_code_library_emails(storefront_oid, opts)
7060
+
7061
+ Email items from the code library that can start a new email step
7062
+
7063
+ The code library is the one the admin's \"start from library\" uses; it isn't the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item's library_item_oid on the step insert to start a new email from it.
7064
+
7065
+
7066
+ ### Examples
7067
+
7068
+
7069
+ (No example for this operation).
7070
+
7071
+
7072
+ #### Using the list_sfvb_code_library_emails_with_http_info variant
7073
+
7074
+ This returns an Array which contains the response data, status code and headers.
7075
+
7076
+ > <Array(<SfvbCodeLibraryEmailsResponse>, Integer, Hash)> list_sfvb_code_library_emails_with_http_info(storefront_oid, opts)
7077
+
7078
+ ```ruby
7079
+ begin
7080
+ # Email items from the code library that can start a new email step
7081
+ data, status_code, headers = api_instance.list_sfvb_code_library_emails_with_http_info(storefront_oid, opts)
7082
+ p status_code # => 2xx
7083
+ p headers # => { ... }
7084
+ p data # => <SfvbCodeLibraryEmailsResponse>
7085
+ rescue UltracartClient::ApiError => e
7086
+ puts "Error when calling SfvbApi->list_sfvb_code_library_emails_with_http_info: #{e}"
7087
+ end
7088
+ ```
7089
+
7090
+ ### Parameters
7091
+
7092
+ | Name | Type | Description | Notes |
7093
+ | ---- | ---- | ----------- | ----- |
7094
+ | **storefront_oid** | **Integer** | | |
7095
+ | **search** | **String** | Part of the title to match, with case. Up to 100 characters. | [optional] |
7096
+
7097
+ ### Return type
7098
+
7099
+ [**SfvbCodeLibraryEmailsResponse**](SfvbCodeLibraryEmailsResponse.md)
7100
+
7101
+ ### Authorization
7102
+
7103
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7104
+
7105
+ ### HTTP request headers
7106
+
7107
+ - **Content-Type**: Not defined
7108
+ - **Accept**: application/json
7109
+
7110
+
7055
7111
  ## list_sfvb_comms_lists
7056
7112
 
7057
7113
  > <SfvbCommsListsResponse> list_sfvb_comms_lists(storefront_oid)
@@ -8045,6 +8101,64 @@ end
8045
8101
  - **Accept**: application/json
8046
8102
 
8047
8103
 
8104
+ ## move_sfvb_sequence_step
8105
+
8106
+ > <SfvbSequenceStepMoveResponse> move_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
8107
+
8108
+ Move one step
8109
+
8110
+ Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step's hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
8111
+
8112
+
8113
+ ### Examples
8114
+
8115
+
8116
+ (No example for this operation).
8117
+
8118
+
8119
+ #### Using the move_sfvb_sequence_step_with_http_info variant
8120
+
8121
+ This returns an Array which contains the response data, status code and headers.
8122
+
8123
+ > <Array(<SfvbSequenceStepMoveResponse>, Integer, Hash)> move_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
8124
+
8125
+ ```ruby
8126
+ begin
8127
+ # Move one step
8128
+ data, status_code, headers = api_instance.move_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
8129
+ p status_code # => 2xx
8130
+ p headers # => { ... }
8131
+ p data # => <SfvbSequenceStepMoveResponse>
8132
+ rescue UltracartClient::ApiError => e
8133
+ puts "Error when calling SfvbApi->move_sfvb_sequence_step_with_http_info: #{e}"
8134
+ end
8135
+ ```
8136
+
8137
+ ### Parameters
8138
+
8139
+ | Name | Type | Description | Notes |
8140
+ | ---- | ---- | ----------- | ----- |
8141
+ | **storefront_oid** | **Integer** | | |
8142
+ | **sequence_uuid** | **String** | | |
8143
+ | **step_uuid** | **String** | | |
8144
+ | **if_match** | **String** | The moved step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
8145
+ | **sequence_step_move_request** | [**SfvbSequenceStepMoveRequest**](SfvbSequenceStepMoveRequest.md) | Where the step moves, and the hash of the step it goes next to | |
8146
+ | **approval_id** | **String** | When the sequence is live, the approval_id of an approved sequence_step.move request for exactly this move. See POST /sfvb/approvals. | [optional] |
8147
+
8148
+ ### Return type
8149
+
8150
+ [**SfvbSequenceStepMoveResponse**](SfvbSequenceStepMoveResponse.md)
8151
+
8152
+ ### Authorization
8153
+
8154
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
8155
+
8156
+ ### HTTP request headers
8157
+
8158
+ - **Content-Type**: application/json
8159
+ - **Accept**: application/json
8160
+
8161
+
8048
8162
  ## move_sfvb_upsell_path
8049
8163
 
8050
8164
  > <SfvbUpsellPath> move_sfvb_upsell_path(storefront_oid, upsell_path_oid, move_request)
@@ -11313,11 +11427,11 @@ end
11313
11427
 
11314
11428
  ## update_sfvb_sequence_step
11315
11429
 
11316
- > <SfvbSequenceStepUpdateResponse> update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
11430
+ > <SfvbSequenceStepUpdateResponse> update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
11317
11431
 
11318
11432
  Change one step's settings or audience filter
11319
11433
 
11320
- 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, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
11434
+ 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.
11321
11435
 
11322
11436
 
11323
11437
  ### Examples
@@ -11330,12 +11444,12 @@ Replaces the step's settings (config_json), its audience filter (filter_profile_
11330
11444
 
11331
11445
  This returns an Array which contains the response data, status code and headers.
11332
11446
 
11333
- > <Array(<SfvbSequenceStepUpdateResponse>, Integer, Hash)> update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
11447
+ > <Array(<SfvbSequenceStepUpdateResponse>, Integer, Hash)> update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
11334
11448
 
11335
11449
  ```ruby
11336
11450
  begin
11337
11451
  # Change one step's settings or audience filter
11338
- data, status_code, headers = api_instance.update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
11452
+ data, status_code, headers = api_instance.update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
11339
11453
  p status_code # => 2xx
11340
11454
  p headers # => { ... }
11341
11455
  p data # => <SfvbSequenceStepUpdateResponse>
@@ -11353,6 +11467,7 @@ end
11353
11467
  | **step_uuid** | **String** | | |
11354
11468
  | **if_match** | **String** | The step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
11355
11469
  | **sequence_step_update_request** | [**SfvbSequenceStepUpdateRequest**](SfvbSequenceStepUpdateRequest.md) | The settings, the filter, or both | |
11470
+ | **approval_id** | **String** | When the change turns a post_card step on, the approval_id of an approved sequence_step.enable_postcard request for this step. See POST /sfvb/approvals. | [optional] |
11356
11471
 
11357
11472
  ### Return type
11358
11473
 
@@ -4,8 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **after_step_uuid** | **String** | For sequence_step.move, the step it moves after. Or branch_step_uuid with side. | [optional] |
7
8
  | **attribute_names** | **Array&lt;String&gt;** | For item.attribute_batch, the attributes the batch would change. Set by the server. | [optional] |
8
9
  | **blog_post_oid** | **Integer** | The blog post, for blog_post.delete. | [optional] |
10
+ | **branch_step_uuid** | **String** | For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of. | [optional] |
9
11
  | **content_sha256** | **String** | For file.put_script, the SHA-256 of the exact bytes approved. Set by the server, never by the caller. The write must send bytes with this hash. | [optional] |
10
12
  | **domain** | **String** | For sending_domain.delete, the sending domain. | [optional] |
11
13
  | **esp_twilio_uuid** | **String** | For twilio_account.delete, the Twilio account&#39;s esp_twilio_uuid, as GET comms/twilio_account returns it. | [optional] |
@@ -17,9 +19,10 @@
17
19
  | **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
20
  | **rule_count** | **Integer** | For redirect.delete_batch, how many rules the batch would delete when it was requested. Set by the server. | [optional] |
19
21
  | **segment_uuid** | **String** | The segment whose rule changes, for segment.update. | [optional] |
20
- | **sequence_uuid** | **String** | The communication sequence, for sequence_step.delete. | [optional] |
22
+ | **sequence_uuid** | **String** | The communication sequence, for sequence_step.delete and sequence_step.move. | [optional] |
23
+ | **side** | **String** | For sequence_step.move with branch_step_uuid, the side&#39;s label from the sequence read. | [optional] |
21
24
  | **slot** | **String** | For experiment.start of a page experiment, the page body name. Defaults to body. | [optional] |
22
- | **step_uuid** | **String** | The step to remove, for sequence_step.delete. | [optional] |
25
+ | **step_uuid** | **String** | The step to remove, for sequence_step.delete, or to move, for sequence_step.move. | [optional] |
23
26
  | **upsell_kind** | **String** | For upsell.enable, what to switch on. | [optional] |
24
27
  | **upsell_oid** | **Integer** | For upsell.enable, the oid of the offer or path to switch on. | [optional] |
25
28
  | **version** | **Integer** | For file.put_script, the history version a revert restores. Leave it out, and send content instead, for a write. | [optional] |
@@ -32,8 +35,10 @@
32
35
  require 'ultracart_api'
33
36
 
34
37
  instance = UltracartClient::SfvbApprovalParams.new(
38
+ after_step_uuid: null,
35
39
  attribute_names: null,
36
40
  blog_post_oid: null,
41
+ branch_step_uuid: null,
37
42
  content_sha256: null,
38
43
  domain: null,
39
44
  esp_twilio_uuid: null,
@@ -46,6 +51,7 @@ instance = UltracartClient::SfvbApprovalParams.new(
46
51
  rule_count: null,
47
52
  segment_uuid: null,
48
53
  sequence_uuid: null,
54
+ side: null,
49
55
  slot: null,
50
56
  step_uuid: null,
51
57
  upsell_kind: null,
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbCodeLibraryEmail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | The item&#39;s description. | [optional] |
8
+ | **library_item_oid** | **Integer** | The item, to send as library_item_oid on the step insert. | [optional] |
9
+ | **preview_text** | **String** | The preview text a new email takes from the item, or null when it has none and preview_text must be given. | [optional] |
10
+ | **source** | **String** | owned (this account&#39;s own), shared (shared with this account) or public (published and approved by UltraCart). | [optional] |
11
+ | **subject** | **String** | The subject a new email takes from the item, or null when it has none and subject must be given. | [optional] |
12
+ | **title** | **String** | The item&#39;s title. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbCodeLibraryEmail.new(
20
+ description: null,
21
+ library_item_oid: null,
22
+ preview_text: null,
23
+ source: null,
24
+ subject: null,
25
+ title: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbCodeLibraryEmailsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **emails** | [**Array&lt;SfvbCodeLibraryEmail&gt;**](SfvbCodeLibraryEmail.md) | The items, by title. | [optional] |
8
+ | **truncated** | **Boolean** | True when there were more items than listed. Narrow the search to see the rest. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbCodeLibraryEmailsResponse.new(
16
+ emails: null,
17
+ truncated: null
18
+ )
19
+ ```
20
+
@@ -4,12 +4,16 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
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] |
7
8
  | **after_step_uuid** | **String** | The step the new step follows, in the same list. Not an end, continue or merge step. | [optional] |
8
9
  | **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
+ | **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] |
11
+ | **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
+ | **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
+ | **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] |
10
14
  | **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] |
15
+ | **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] |
13
17
 
14
18
  ## Example
15
19
 
@@ -17,8 +21,12 @@
17
21
  require 'ultracart_api'
18
22
 
19
23
  instance = UltracartClient::SfvbSequenceStepCreateRequest.new(
24
+ acknowledge_executable: null,
20
25
  after_step_uuid: null,
21
26
  branch_step_uuid: null,
27
+ config_json: null,
28
+ library_item_oid: null,
29
+ name: null,
22
30
  preview_text: null,
23
31
  side: null,
24
32
  subject: null,
@@ -4,8 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **back_container_uuid** | **String** | A post_card step&#39;s back, the container with owner type postcardback and this owner id. | [optional] |
7
8
  | **email_uuid** | **String** | The new email&#39;s uuid. Its body is the email container with this owner id. | [optional] |
9
+ | **front_container_uuid** | **String** | A post_card step&#39;s front, the container with owner type postcardfront and this owner id. | [optional] |
10
+ | **library_files_kept** | **Array&lt;String&gt;** | The library item&#39;s files whose path already held a file, which was kept, not replaced. | [optional] |
11
+ | **library_files_skipped** | **Array&lt;String&gt;** | The library item&#39;s files that weren&#39;t written because they aren&#39;t a PNG, JPEG or GIF image whose bytes match its name. Only those images are copied from a library item. | [optional] |
12
+ | **library_files_written** | **Array&lt;String&gt;** | Storefront file paths the library item&#39;s files were written to. A file already at its path is kept as it is and listed in library_files_kept instead. | [optional] |
13
+ | **library_item_oid** | **Integer** | The code library email item the new email started from (#1589), when one was given. | [optional] |
8
14
  | **notes** | **Array&lt;String&gt;** | What to do next, such as writing the body, and customers already waiting on the step before it. | [optional] |
15
+ | **postcard_uuid** | **String** | A post_card step&#39;s new postcard (#1644). | [optional] |
9
16
  | **requires_review** | **Boolean** | True when the new email must pass content review before it sends. | [optional] |
10
17
  | **step** | [**SfvbSequenceStep**](SfvbSequenceStep.md) | | [optional] |
11
18
 
@@ -15,8 +22,15 @@
15
22
  require 'ultracart_api'
16
23
 
17
24
  instance = UltracartClient::SfvbSequenceStepCreateResponse.new(
25
+ back_container_uuid: null,
18
26
  email_uuid: null,
27
+ front_container_uuid: null,
28
+ library_files_kept: null,
29
+ library_files_skipped: null,
30
+ library_files_written: null,
31
+ library_item_oid: null,
19
32
  notes: null,
33
+ postcard_uuid: null,
20
34
  requires_review: null,
21
35
  step: null
22
36
  )
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbSequenceStepMoveRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **after_step_uuid** | **String** | The step it moves after, in that step&#39;s list. The begin step puts it first in the sequence. Not an end, continue or merge step. | [optional] |
8
+ | **anchor_hash_sha256** | **String** | The hash_sha256 of after_step_uuid, or of branch_step_uuid, from the last read. Required; 412 when stale. | [optional] |
9
+ | **branch_step_uuid** | **String** | A condition, split or inboxgeek step. With side, the step moves to the start of that side. | [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
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbSequenceStepMoveRequest.new(
18
+ after_step_uuid: null,
19
+ anchor_hash_sha256: null,
20
+ branch_step_uuid: null,
21
+ side: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::SfvbSequenceStepMoveResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **notes** | **Array&lt;String&gt;** | Where the step was and where it is now, and anyone waiting on the steps around it. | [optional] |
8
+ | **step** | [**SfvbSequenceStep**](SfvbSequenceStep.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::SfvbSequenceStepMoveResponse.new(
16
+ notes: null,
17
+ step: null
18
+ )
19
+ ```
20
+
@@ -2267,6 +2267,8 @@ end
2267
2267
 
2268
2268
  Get email campaigns with stats
2269
2269
 
2270
+ Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn't listed; getEmailCampaigns lists every campaign.
2271
+
2270
2272
 
2271
2273
  ### Examples
2272
2274