ultracart_api 4.1.219 → 4.1.221
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 +4 -4
- data/README.md +14 -3
- data/docs/SfvbApi.md +181 -9
- data/docs/SfvbApprovalParams.md +8 -2
- data/docs/SfvbCodeLibraryEmail.md +28 -0
- data/docs/SfvbCodeLibraryEmailsResponse.md +20 -0
- data/docs/SfvbPostcardProofRequest.md +34 -0
- data/docs/SfvbPostcardProofResponse.md +38 -0
- data/docs/SfvbSequenceStepCreateRequest.md +11 -3
- data/docs/SfvbSequenceStepCreateResponse.md +14 -0
- data/docs/SfvbSequenceStepMoveRequest.md +24 -0
- data/docs/SfvbSequenceStepMoveResponse.md +20 -0
- data/docs/StorefrontApi.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +262 -8
- data/lib/ultracart_api/api/storefront_api.rb +2 -0
- data/lib/ultracart_api/models/sfvb_approval_params.rb +33 -3
- data/lib/ultracart_api/models/sfvb_code_library_email.rb +270 -0
- data/lib/ultracart_api/models/sfvb_code_library_emails_response.rb +232 -0
- data/lib/ultracart_api/models/sfvb_postcard_proof_request.rb +302 -0
- data/lib/ultracart_api/models/sfvb_postcard_proof_response.rb +356 -0
- data/lib/ultracart_api/models/sfvb_sequence_step_create_request.rb +44 -4
- data/lib/ultracart_api/models/sfvb_sequence_step_create_response.rb +77 -1
- data/lib/ultracart_api/models/sfvb_sequence_step_move_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_sequence_step_move_response.rb +231 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4267bcfb9ff75c959b4bcb691612a889458a32f1bb98c34f2930c02f591ab493
|
|
4
|
+
data.tar.gz: 8350f1778b128b70b8fe74fe40513082f5eab243ef11ce7f701b6849e6a61892
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a1aea1e4700ef49b020d24e0ba38ccc8172b37d4f8d87eba25070c0823323f61b9e075ca777a75ee74171471bbb52c390a37d01d2667186e23287328d5c3f8f3
|
|
7
|
+
data.tar.gz: b587b333770e47e1d8e7b0018b3c025f560c7e952d22b43ca0c58cf875834d9b7d6cce4b57d99908cd85a05a40713c7ab607797f7de87c648a255b03790443e2
|
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.
|
|
10
|
+
- Package version: 4.1.221
|
|
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.
|
|
19
|
+
gem 'ultracart_api', '4.1.221'
|
|
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,7 +621,9 @@ 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
|
|
626
|
+
*UltracartClient::SfvbApi* | [**proof_sfvb_sequence_postcard**](docs/SfvbApi.md#proof_sfvb_sequence_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof | Proof a postcard step without mailing it
|
|
624
627
|
*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
628
|
*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
|
|
626
629
|
*UltracartClient::SfvbApi* | [**put_sfvb_experiment_variation**](docs/SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation
|
|
@@ -1929,6 +1932,8 @@ Class | Method | HTTP request | Description
|
|
|
1929
1932
|
- [UltracartClient::SfvbCampaignMembership](docs/SfvbCampaignMembership.md)
|
|
1930
1933
|
- [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
|
|
1931
1934
|
- [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
|
|
1935
|
+
- [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
|
|
1936
|
+
- [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
|
|
1932
1937
|
- [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
|
|
1933
1938
|
- [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
|
|
1934
1939
|
- [UltracartClient::SfvbCommsList](docs/SfvbCommsList.md)
|
|
@@ -2080,6 +2085,8 @@ Class | Method | HTTP request | Description
|
|
|
2080
2085
|
- [UltracartClient::SfvbPageSelectors](docs/SfvbPageSelectors.md)
|
|
2081
2086
|
- [UltracartClient::SfvbPageSettingsRequest](docs/SfvbPageSettingsRequest.md)
|
|
2082
2087
|
- [UltracartClient::SfvbPageSummary](docs/SfvbPageSummary.md)
|
|
2088
|
+
- [UltracartClient::SfvbPostcardProofRequest](docs/SfvbPostcardProofRequest.md)
|
|
2089
|
+
- [UltracartClient::SfvbPostcardProofResponse](docs/SfvbPostcardProofResponse.md)
|
|
2083
2090
|
- [UltracartClient::SfvbPreviewAccessRequest](docs/SfvbPreviewAccessRequest.md)
|
|
2084
2091
|
- [UltracartClient::SfvbPreviewAccessResponse](docs/SfvbPreviewAccessResponse.md)
|
|
2085
2092
|
- [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
|
|
@@ -2124,6 +2131,8 @@ Class | Method | HTTP request | Description
|
|
|
2124
2131
|
- [UltracartClient::SfvbSequenceStepCreateRequest](docs/SfvbSequenceStepCreateRequest.md)
|
|
2125
2132
|
- [UltracartClient::SfvbSequenceStepCreateResponse](docs/SfvbSequenceStepCreateResponse.md)
|
|
2126
2133
|
- [UltracartClient::SfvbSequenceStepDeleteResponse](docs/SfvbSequenceStepDeleteResponse.md)
|
|
2134
|
+
- [UltracartClient::SfvbSequenceStepMoveRequest](docs/SfvbSequenceStepMoveRequest.md)
|
|
2135
|
+
- [UltracartClient::SfvbSequenceStepMoveResponse](docs/SfvbSequenceStepMoveResponse.md)
|
|
2127
2136
|
- [UltracartClient::SfvbSequenceStepUpdateRequest](docs/SfvbSequenceStepUpdateRequest.md)
|
|
2128
2137
|
- [UltracartClient::SfvbSequenceStepUpdateResponse](docs/SfvbSequenceStepUpdateResponse.md)
|
|
2129
2138
|
- [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
|
|
@@ -2343,6 +2352,8 @@ Not every change is committed to every SDK.
|
|
|
2343
2352
|
|
|
2344
2353
|
| Version | Date | Comments |
|
|
2345
2354
|
| --: | :-: | --- |
|
|
2355
|
+
| 4.1.221 | 11/02/2026 | sfvb internal testing |
|
|
2356
|
+
| 4.1.220 | 11/02/2026 | sfvb internal testing |
|
|
2346
2357
|
| 4.1.219 | 10/30/2026 | item - field for hsa/fsa eligibility |
|
|
2347
2358
|
| 4.1.218 | 10/30/2026 | svfb internal testing |
|
|
2348
2359
|
| 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,7 +149,9 @@ 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 |
|
|
154
|
+
| [**proof_sfvb_sequence_postcard**](SfvbApi.md#proof_sfvb_sequence_postcard) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof | Proof a postcard step without mailing it |
|
|
152
155
|
| [**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
156
|
| [**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 |
|
|
154
157
|
| [**put_sfvb_experiment_variation**](SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation |
|
|
@@ -6724,9 +6727,9 @@ end
|
|
|
6724
6727
|
|
|
6725
6728
|
> <SfvbSequenceStepCreateResponse> insert_sfvb_sequence_step(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
|
|
6726
6729
|
|
|
6727
|
-
Add an email step, with its new email
|
|
6730
|
+
Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
6728
6731
|
|
|
6729
|
-
|
|
6732
|
+
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
6733
|
|
|
6731
6734
|
|
|
6732
6735
|
### Examples
|
|
@@ -6743,7 +6746,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
6743
6746
|
|
|
6744
6747
|
```ruby
|
|
6745
6748
|
begin
|
|
6746
|
-
# Add an email step, with its new email
|
|
6749
|
+
# Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
6747
6750
|
data, status_code, headers = api_instance.insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request)
|
|
6748
6751
|
p status_code # => 2xx
|
|
6749
6752
|
p headers # => { ... }
|
|
@@ -6760,7 +6763,7 @@ end
|
|
|
6760
6763
|
| **storefront_oid** | **Integer** | | |
|
|
6761
6764
|
| **sequence_uuid** | **String** | | |
|
|
6762
6765
|
| **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's subject and preview text | |
|
|
6766
|
+
| **sequence_step_create_request** | [**SfvbSequenceStepCreateRequest**](SfvbSequenceStepCreateRequest.md) | Where the step goes, and the new email's subject and preview text or code library item, the wait's config_json, or the postcard step's name | |
|
|
6764
6767
|
|
|
6765
6768
|
### Return type
|
|
6766
6769
|
|
|
@@ -7052,6 +7055,60 @@ end
|
|
|
7052
7055
|
- **Accept**: application/json
|
|
7053
7056
|
|
|
7054
7057
|
|
|
7058
|
+
## list_sfvb_code_library_emails
|
|
7059
|
+
|
|
7060
|
+
> <SfvbCodeLibraryEmailsResponse> list_sfvb_code_library_emails(storefront_oid, opts)
|
|
7061
|
+
|
|
7062
|
+
Email items from the code library that can start a new email step
|
|
7063
|
+
|
|
7064
|
+
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.
|
|
7065
|
+
|
|
7066
|
+
|
|
7067
|
+
### Examples
|
|
7068
|
+
|
|
7069
|
+
|
|
7070
|
+
(No example for this operation).
|
|
7071
|
+
|
|
7072
|
+
|
|
7073
|
+
#### Using the list_sfvb_code_library_emails_with_http_info variant
|
|
7074
|
+
|
|
7075
|
+
This returns an Array which contains the response data, status code and headers.
|
|
7076
|
+
|
|
7077
|
+
> <Array(<SfvbCodeLibraryEmailsResponse>, Integer, Hash)> list_sfvb_code_library_emails_with_http_info(storefront_oid, opts)
|
|
7078
|
+
|
|
7079
|
+
```ruby
|
|
7080
|
+
begin
|
|
7081
|
+
# Email items from the code library that can start a new email step
|
|
7082
|
+
data, status_code, headers = api_instance.list_sfvb_code_library_emails_with_http_info(storefront_oid, opts)
|
|
7083
|
+
p status_code # => 2xx
|
|
7084
|
+
p headers # => { ... }
|
|
7085
|
+
p data # => <SfvbCodeLibraryEmailsResponse>
|
|
7086
|
+
rescue UltracartClient::ApiError => e
|
|
7087
|
+
puts "Error when calling SfvbApi->list_sfvb_code_library_emails_with_http_info: #{e}"
|
|
7088
|
+
end
|
|
7089
|
+
```
|
|
7090
|
+
|
|
7091
|
+
### Parameters
|
|
7092
|
+
|
|
7093
|
+
| Name | Type | Description | Notes |
|
|
7094
|
+
| ---- | ---- | ----------- | ----- |
|
|
7095
|
+
| **storefront_oid** | **Integer** | | |
|
|
7096
|
+
| **search** | **String** | Part of the title to match, with case. Up to 100 characters. | [optional] |
|
|
7097
|
+
|
|
7098
|
+
### Return type
|
|
7099
|
+
|
|
7100
|
+
[**SfvbCodeLibraryEmailsResponse**](SfvbCodeLibraryEmailsResponse.md)
|
|
7101
|
+
|
|
7102
|
+
### Authorization
|
|
7103
|
+
|
|
7104
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
7105
|
+
|
|
7106
|
+
### HTTP request headers
|
|
7107
|
+
|
|
7108
|
+
- **Content-Type**: Not defined
|
|
7109
|
+
- **Accept**: application/json
|
|
7110
|
+
|
|
7111
|
+
|
|
7055
7112
|
## list_sfvb_comms_lists
|
|
7056
7113
|
|
|
7057
7114
|
> <SfvbCommsListsResponse> list_sfvb_comms_lists(storefront_oid)
|
|
@@ -8045,6 +8102,64 @@ end
|
|
|
8045
8102
|
- **Accept**: application/json
|
|
8046
8103
|
|
|
8047
8104
|
|
|
8105
|
+
## move_sfvb_sequence_step
|
|
8106
|
+
|
|
8107
|
+
> <SfvbSequenceStepMoveResponse> move_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
|
|
8108
|
+
|
|
8109
|
+
Move one step
|
|
8110
|
+
|
|
8111
|
+
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.
|
|
8112
|
+
|
|
8113
|
+
|
|
8114
|
+
### Examples
|
|
8115
|
+
|
|
8116
|
+
|
|
8117
|
+
(No example for this operation).
|
|
8118
|
+
|
|
8119
|
+
|
|
8120
|
+
#### Using the move_sfvb_sequence_step_with_http_info variant
|
|
8121
|
+
|
|
8122
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8123
|
+
|
|
8124
|
+
> <Array(<SfvbSequenceStepMoveResponse>, Integer, Hash)> move_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
|
|
8125
|
+
|
|
8126
|
+
```ruby
|
|
8127
|
+
begin
|
|
8128
|
+
# Move one step
|
|
8129
|
+
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)
|
|
8130
|
+
p status_code # => 2xx
|
|
8131
|
+
p headers # => { ... }
|
|
8132
|
+
p data # => <SfvbSequenceStepMoveResponse>
|
|
8133
|
+
rescue UltracartClient::ApiError => e
|
|
8134
|
+
puts "Error when calling SfvbApi->move_sfvb_sequence_step_with_http_info: #{e}"
|
|
8135
|
+
end
|
|
8136
|
+
```
|
|
8137
|
+
|
|
8138
|
+
### Parameters
|
|
8139
|
+
|
|
8140
|
+
| Name | Type | Description | Notes |
|
|
8141
|
+
| ---- | ---- | ----------- | ----- |
|
|
8142
|
+
| **storefront_oid** | **Integer** | | |
|
|
8143
|
+
| **sequence_uuid** | **String** | | |
|
|
8144
|
+
| **step_uuid** | **String** | | |
|
|
8145
|
+
| **if_match** | **String** | The moved step's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
8146
|
+
| **sequence_step_move_request** | [**SfvbSequenceStepMoveRequest**](SfvbSequenceStepMoveRequest.md) | Where the step moves, and the hash of the step it goes next to | |
|
|
8147
|
+
| **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] |
|
|
8148
|
+
|
|
8149
|
+
### Return type
|
|
8150
|
+
|
|
8151
|
+
[**SfvbSequenceStepMoveResponse**](SfvbSequenceStepMoveResponse.md)
|
|
8152
|
+
|
|
8153
|
+
### Authorization
|
|
8154
|
+
|
|
8155
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8156
|
+
|
|
8157
|
+
### HTTP request headers
|
|
8158
|
+
|
|
8159
|
+
- **Content-Type**: application/json
|
|
8160
|
+
- **Accept**: application/json
|
|
8161
|
+
|
|
8162
|
+
|
|
8048
8163
|
## move_sfvb_upsell_path
|
|
8049
8164
|
|
|
8050
8165
|
> <SfvbUpsellPath> move_sfvb_upsell_path(storefront_oid, upsell_path_oid, move_request)
|
|
@@ -8100,6 +8215,62 @@ end
|
|
|
8100
8215
|
- **Accept**: application/json
|
|
8101
8216
|
|
|
8102
8217
|
|
|
8218
|
+
## proof_sfvb_sequence_postcard
|
|
8219
|
+
|
|
8220
|
+
> <SfvbPostcardProofResponse> proof_sfvb_sequence_postcard(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request)
|
|
8221
|
+
|
|
8222
|
+
Proof a postcard step without mailing it
|
|
8223
|
+
|
|
8224
|
+
Renders both sides of the step's postcard as a send renders them, then has the print vendor render the card as a dry run. Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor's thumbnails and its proof PDF. The QR code is the short link a send prints. No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created. A unique coupon code shows as PREVIEW-UNIQUE. The image urls are public. html_only returns the HTML alone, with no vendor render. An order must be a test order. cart_item_ids fills the cart a cart flow card shows. Works whether the step is on or off.
|
|
8225
|
+
|
|
8226
|
+
|
|
8227
|
+
### Examples
|
|
8228
|
+
|
|
8229
|
+
|
|
8230
|
+
(No example for this operation).
|
|
8231
|
+
|
|
8232
|
+
|
|
8233
|
+
#### Using the proof_sfvb_sequence_postcard_with_http_info variant
|
|
8234
|
+
|
|
8235
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8236
|
+
|
|
8237
|
+
> <Array(<SfvbPostcardProofResponse>, Integer, Hash)> proof_sfvb_sequence_postcard_with_http_info(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request)
|
|
8238
|
+
|
|
8239
|
+
```ruby
|
|
8240
|
+
begin
|
|
8241
|
+
# Proof a postcard step without mailing it
|
|
8242
|
+
data, status_code, headers = api_instance.proof_sfvb_sequence_postcard_with_http_info(storefront_oid, sequence_uuid, step_uuid, postcard_proof_request)
|
|
8243
|
+
p status_code # => 2xx
|
|
8244
|
+
p headers # => { ... }
|
|
8245
|
+
p data # => <SfvbPostcardProofResponse>
|
|
8246
|
+
rescue UltracartClient::ApiError => e
|
|
8247
|
+
puts "Error when calling SfvbApi->proof_sfvb_sequence_postcard_with_http_info: #{e}"
|
|
8248
|
+
end
|
|
8249
|
+
```
|
|
8250
|
+
|
|
8251
|
+
### Parameters
|
|
8252
|
+
|
|
8253
|
+
| Name | Type | Description | Notes |
|
|
8254
|
+
| ---- | ---- | ----------- | ----- |
|
|
8255
|
+
| **storefront_oid** | **Integer** | | |
|
|
8256
|
+
| **sequence_uuid** | **String** | | |
|
|
8257
|
+
| **step_uuid** | **String** | | |
|
|
8258
|
+
| **postcard_proof_request** | [**SfvbPostcardProofRequest**](SfvbPostcardProofRequest.md) | Who the card is addressed to, and the order or cart it shows | |
|
|
8259
|
+
|
|
8260
|
+
### Return type
|
|
8261
|
+
|
|
8262
|
+
[**SfvbPostcardProofResponse**](SfvbPostcardProofResponse.md)
|
|
8263
|
+
|
|
8264
|
+
### Authorization
|
|
8265
|
+
|
|
8266
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8267
|
+
|
|
8268
|
+
### HTTP request headers
|
|
8269
|
+
|
|
8270
|
+
- **Content-Type**: application/json
|
|
8271
|
+
- **Accept**: application/json
|
|
8272
|
+
|
|
8273
|
+
|
|
8103
8274
|
## publish_sfvb_library_entry
|
|
8104
8275
|
|
|
8105
8276
|
> <SfvbLibraryEntry> publish_sfvb_library_entry(storefront_oid, library_oid, if_match, publish_request)
|
|
@@ -11313,11 +11484,11 @@ end
|
|
|
11313
11484
|
|
|
11314
11485
|
## update_sfvb_sequence_step
|
|
11315
11486
|
|
|
11316
|
-
> <SfvbSequenceStepUpdateResponse> update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
|
|
11487
|
+
> <SfvbSequenceStepUpdateResponse> update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
|
|
11317
11488
|
|
|
11318
11489
|
Change one step's settings or audience filter
|
|
11319
11490
|
|
|
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,
|
|
11491
|
+
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
11492
|
|
|
11322
11493
|
|
|
11323
11494
|
### Examples
|
|
@@ -11330,12 +11501,12 @@ Replaces the step's settings (config_json), its audience filter (filter_profile_
|
|
|
11330
11501
|
|
|
11331
11502
|
This returns an Array which contains the response data, status code and headers.
|
|
11332
11503
|
|
|
11333
|
-
> <Array(<SfvbSequenceStepUpdateResponse>, Integer, Hash)> update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request)
|
|
11504
|
+
> <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
11505
|
|
|
11335
11506
|
```ruby
|
|
11336
11507
|
begin
|
|
11337
11508
|
# 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)
|
|
11509
|
+
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
11510
|
p status_code # => 2xx
|
|
11340
11511
|
p headers # => { ... }
|
|
11341
11512
|
p data # => <SfvbSequenceStepUpdateResponse>
|
|
@@ -11353,6 +11524,7 @@ end
|
|
|
11353
11524
|
| **step_uuid** | **String** | | |
|
|
11354
11525
|
| **if_match** | **String** | The step's hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
11355
11526
|
| **sequence_step_update_request** | [**SfvbSequenceStepUpdateRequest**](SfvbSequenceStepUpdateRequest.md) | The settings, the filter, or both | |
|
|
11527
|
+
| **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
11528
|
|
|
11357
11529
|
### Return type
|
|
11358
11530
|
|
data/docs/SfvbApprovalParams.md
CHANGED
|
@@ -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<String>** | 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'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'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'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'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'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<SfvbCodeLibraryEmail>**](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
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# UltracartClient::SfvbPostcardProofRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address1** | **String** | The recipient street address. Without address1, city, state and postal_code, a sample address is used. | [optional] |
|
|
8
|
+
| **address2** | **String** | The recipient second address line. | [optional] |
|
|
9
|
+
| **cart_item_ids** | **Array<String>** | Item ids for the cart a cart flow card renders with. The cart is made for the proof and deleted after it. | [optional] |
|
|
10
|
+
| **city** | **String** | The recipient city. | [optional] |
|
|
11
|
+
| **customer_name** | **String** | The recipient name the card greets and is addressed to. Defaults to the signed in user. | [optional] |
|
|
12
|
+
| **html_only** | **Boolean** | True to return only the rendered HTML of both sides, with no print vendor render. The default, false, also returns the images that would print and the vendor proof PDF. | [optional] |
|
|
13
|
+
| **order_id** | **String** | A test order for an order flow card. Real orders are refused. Without one, an order flow card renders with a made up order. | [optional] |
|
|
14
|
+
| **postal_code** | **String** | The recipient postal code. | [optional] |
|
|
15
|
+
| **state** | **String** | The recipient state. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'ultracart_api'
|
|
21
|
+
|
|
22
|
+
instance = UltracartClient::SfvbPostcardProofRequest.new(
|
|
23
|
+
address1: null,
|
|
24
|
+
address2: null,
|
|
25
|
+
cart_item_ids: null,
|
|
26
|
+
city: null,
|
|
27
|
+
customer_name: null,
|
|
28
|
+
html_only: null,
|
|
29
|
+
order_id: null,
|
|
30
|
+
postal_code: null,
|
|
31
|
+
state: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::SfvbPostcardProofResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **back_html** | **String** | The back as the send renders it, after the name tokens are filled. | [optional] |
|
|
8
|
+
| **back_image_url** | **String** | The back as the PNG image the print vendor prints from. A public url. | [optional] |
|
|
9
|
+
| **back_thumbnail_url** | **String** | The print vendor thumbnail of the back. | [optional] |
|
|
10
|
+
| **front_html** | **String** | The front as the send renders it, after the name tokens are filled. | [optional] |
|
|
11
|
+
| **front_image_url** | **String** | The front as the PNG image the print vendor prints from. A public url. | [optional] |
|
|
12
|
+
| **front_thumbnail_url** | **String** | The print vendor thumbnail of the front. | [optional] |
|
|
13
|
+
| **order_source** | **String** | Where the order came from. test for the order_id given, dummy for a made up one, none for no order. | [optional] |
|
|
14
|
+
| **postcard_uuid** | **String** | The postcard the step mails. | [optional] |
|
|
15
|
+
| **rendered_pdf_url** | **String** | The print vendor proof PDF of both sides. | [optional] |
|
|
16
|
+
| **vendor_rendered** | **Boolean** | True when the print vendor rendered the card, so the image and PDF urls are set. | [optional] |
|
|
17
|
+
| **warnings** | [**Array<SfvbErrorDetail>**](SfvbErrorDetail.md) | Where the proof differs from a send, such as a placeholder coupon code or a sample address, and anything that would make a send skip the card. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::SfvbPostcardProofResponse.new(
|
|
25
|
+
back_html: null,
|
|
26
|
+
back_image_url: null,
|
|
27
|
+
back_thumbnail_url: null,
|
|
28
|
+
front_html: null,
|
|
29
|
+
front_image_url: null,
|
|
30
|
+
front_thumbnail_url: null,
|
|
31
|
+
order_source: null,
|
|
32
|
+
postcard_uuid: null,
|
|
33
|
+
rendered_pdf_url: null,
|
|
34
|
+
vendor_rendered: null,
|
|
35
|
+
warnings: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -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
|
-
| **
|
|
10
|
+
| **config_json** | **String** | A wait step's settings, as the admin saves them and set-config changes them, namely delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), and optionally the delay_until_* options. Not for an email step. | [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'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'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'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'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's subject line, 5 to 150 characters. | [optional] |
|
|
12
|
-
| **type** | **String** | The kind of step
|
|
15
|
+
| **subject** | **String** | The new email'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's back, the container with owner type postcardback and this owner id. | [optional] |
|
|
7
8
|
| **email_uuid** | **String** | The new email's uuid. Its body is the email container with this owner id. | [optional] |
|
|
9
|
+
| **front_container_uuid** | **String** | A post_card step's front, the container with owner type postcardfront and this owner id. | [optional] |
|
|
10
|
+
| **library_files_kept** | **Array<String>** | The library item's files whose path already held a file, which was kept, not replaced. | [optional] |
|
|
11
|
+
| **library_files_skipped** | **Array<String>** | The library item's files that weren't written because they aren'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<String>** | Storefront file paths the library item'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<String>** | 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'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'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'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
|
+
|