ultracart_api 4.1.206 → 4.1.208
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 +18 -2
- data/docs/SfvbApi.md +338 -0
- data/docs/SfvbCampaign.md +38 -0
- data/docs/SfvbCampaignsResponse.md +24 -0
- data/docs/SfvbCommsEmail.md +38 -0
- data/docs/SfvbCommsPostcard.md +28 -0
- data/docs/SfvbEmail.md +40 -0
- data/docs/SfvbEmailUpdateRequest.md +20 -0
- data/docs/SfvbFlow.md +40 -0
- data/docs/SfvbFlowsResponse.md +24 -0
- data/lib/ultracart_api/api/sfvb_api.rb +450 -0
- data/lib/ultracart_api/models/item_third_party_email_marketing.rb +2 -2
- data/lib/ultracart_api/models/sfvb_campaign.rb +324 -0
- data/lib/ultracart_api/models/sfvb_campaigns_response.rb +252 -0
- data/lib/ultracart_api/models/sfvb_comms_email.rb +320 -0
- data/lib/ultracart_api/models/sfvb_comms_postcard.rb +270 -0
- data/lib/ultracart_api/models/sfvb_email.rb +330 -0
- data/lib/ultracart_api/models/sfvb_email_update_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_flow.rb +334 -0
- data/lib/ultracart_api/models/sfvb_flows_response.rb +252 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +8 -0
- metadata +18 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 62fd7064999430105ea3b09ae20d62424894503c5c05d5cbc581fc37bf6a1436
|
|
4
|
+
data.tar.gz: 9cd9c6fed78ad9ea47e21e1e4749f0f44ce6b11f04090e3c2e615fe4958c0b95
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '099e55cb7722932b2cfcaa08420ea5ef89679facce8d0c52b3c3532d0297eb866923a830d997589e4b59f22d86b62766ecadcfaa2e33cbc804a18fdfe1064dee'
|
|
7
|
+
data.tar.gz: 45f76315807bc93a073ff2caf262a6508eea9e56629d730726ec514027d75d8557b921f76ba1cd3f9d51275b358daa7397d3915e8a8d00ee8193e0472ed1ff45
|
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.208
|
|
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.208'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -520,6 +520,7 @@ Class | Method | HTTP request | Description
|
|
|
520
520
|
*UltracartClient::SfvbApi* | [**get_sfvb_approval**](docs/SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request
|
|
521
521
|
*UltracartClient::SfvbApi* | [**get_sfvb_approvals**](docs/SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests
|
|
522
522
|
*UltracartClient::SfvbApi* | [**get_sfvb_blog_post**](docs/SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post
|
|
523
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_campaign**](docs/SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign
|
|
523
524
|
*UltracartClient::SfvbApi* | [**get_sfvb_cjson_used_elements**](docs/SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container
|
|
524
525
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domain**](docs/SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain
|
|
525
526
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_sending_domains**](docs/SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains
|
|
@@ -527,12 +528,14 @@ Class | Method | HTTP request | Description
|
|
|
527
528
|
*UltracartClient::SfvbApi* | [**get_sfvb_container**](docs/SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system
|
|
528
529
|
*UltracartClient::SfvbApi* | [**get_sfvb_container_version**](docs/SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry
|
|
529
530
|
*UltracartClient::SfvbApi* | [**get_sfvb_element**](docs/SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type
|
|
531
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_email**](docs/SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text
|
|
530
532
|
*UltracartClient::SfvbApi* | [**get_sfvb_events**](docs/SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events
|
|
531
533
|
*UltracartClient::SfvbApi* | [**get_sfvb_events_authorization**](docs/SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream
|
|
532
534
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment**](docs/SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics
|
|
533
535
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment_objectives**](docs/SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize
|
|
534
536
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
|
|
535
537
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to
|
|
538
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_flow**](docs/SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow
|
|
536
539
|
*UltracartClient::SfvbApi* | [**get_sfvb_i18n_glossary**](docs/SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary
|
|
537
540
|
*UltracartClient::SfvbApi* | [**get_sfvb_i18n_languages**](docs/SfvbApi.md#get_sfvb_i18n_languages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/languages | List a storefront's languages
|
|
538
541
|
*UltracartClient::SfvbApi* | [**get_sfvb_i18n_machine_translations**](docs/SfvbApi.md#get_sfvb_i18n_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/machine_translations | Read where a widget setting's translations come from
|
|
@@ -587,11 +590,13 @@ Class | Method | HTTP request | Description
|
|
|
587
590
|
*UltracartClient::SfvbApi* | [**insert_sfvb_upsell_path**](docs/SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path
|
|
588
591
|
*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
|
|
589
592
|
*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
|
|
593
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_campaigns**](docs/SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns
|
|
590
594
|
*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
|
|
591
595
|
*UltracartClient::SfvbApi* | [**list_sfvb_elements**](docs/SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type
|
|
592
596
|
*UltracartClient::SfvbApi* | [**list_sfvb_experiments**](docs/SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments
|
|
593
597
|
*UltracartClient::SfvbApi* | [**list_sfvb_file_versions**](docs/SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file
|
|
594
598
|
*UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
|
|
599
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_flows**](docs/SfvbApi.md#list_sfvb_flows) | **GET** /sfvb/storefronts/{storefront_oid}/flows | List the storefront's flows
|
|
595
600
|
*UltracartClient::SfvbApi* | [**list_sfvb_i18n_messages**](docs/SfvbApi.md#list_sfvb_i18n_messages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages | List built-in messages
|
|
596
601
|
*UltracartClient::SfvbApi* | [**list_sfvb_item_containers**](docs/SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account
|
|
597
602
|
*UltracartClient::SfvbApi* | [**list_sfvb_library_installs**](docs/SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront
|
|
@@ -652,6 +657,7 @@ Class | Method | HTTP request | Description
|
|
|
652
657
|
*UltracartClient::SfvbApi* | [**update_sfvb_blog_post**](docs/SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post
|
|
653
658
|
*UltracartClient::SfvbApi* | [**update_sfvb_comms_sending_domain**](docs/SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain
|
|
654
659
|
*UltracartClient::SfvbApi* | [**update_sfvb_comms_twilio_account**](docs/SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account
|
|
660
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_email**](docs/SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text
|
|
655
661
|
*UltracartClient::SfvbApi* | [**update_sfvb_item_attribute_batch**](docs/SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call
|
|
656
662
|
*UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
|
|
657
663
|
*UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
|
|
@@ -1899,7 +1905,11 @@ Class | Method | HTTP request | Description
|
|
|
1899
1905
|
- [UltracartClient::SfvbBlogPostImageRequest](docs/SfvbBlogPostImageRequest.md)
|
|
1900
1906
|
- [UltracartClient::SfvbBlogPostRequest](docs/SfvbBlogPostRequest.md)
|
|
1901
1907
|
- [UltracartClient::SfvbBlogPostsResponse](docs/SfvbBlogPostsResponse.md)
|
|
1908
|
+
- [UltracartClient::SfvbCampaign](docs/SfvbCampaign.md)
|
|
1909
|
+
- [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
|
|
1902
1910
|
- [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
|
|
1911
|
+
- [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
|
|
1912
|
+
- [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
|
|
1903
1913
|
- [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
|
|
1904
1914
|
- [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
|
|
1905
1915
|
- [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
|
|
@@ -1914,8 +1924,10 @@ Class | Method | HTTP request | Description
|
|
|
1914
1924
|
- [UltracartClient::SfvbElement](docs/SfvbElement.md)
|
|
1915
1925
|
- [UltracartClient::SfvbElementSchemaResponse](docs/SfvbElementSchemaResponse.md)
|
|
1916
1926
|
- [UltracartClient::SfvbElementsResponse](docs/SfvbElementsResponse.md)
|
|
1927
|
+
- [UltracartClient::SfvbEmail](docs/SfvbEmail.md)
|
|
1917
1928
|
- [UltracartClient::SfvbEmailRenderRequest](docs/SfvbEmailRenderRequest.md)
|
|
1918
1929
|
- [UltracartClient::SfvbEmailRenderResponse](docs/SfvbEmailRenderResponse.md)
|
|
1930
|
+
- [UltracartClient::SfvbEmailUpdateRequest](docs/SfvbEmailUpdateRequest.md)
|
|
1919
1931
|
- [UltracartClient::SfvbErrorDetail](docs/SfvbErrorDetail.md)
|
|
1920
1932
|
- [UltracartClient::SfvbEvent](docs/SfvbEvent.md)
|
|
1921
1933
|
- [UltracartClient::SfvbEventsAuthRequest](docs/SfvbEventsAuthRequest.md)
|
|
@@ -1941,6 +1953,8 @@ Class | Method | HTTP request | Description
|
|
|
1941
1953
|
- [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
|
|
1942
1954
|
- [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
|
|
1943
1955
|
- [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
|
|
1956
|
+
- [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
|
|
1957
|
+
- [UltracartClient::SfvbFlowsResponse](docs/SfvbFlowsResponse.md)
|
|
1944
1958
|
- [UltracartClient::SfvbI18nGlossary](docs/SfvbI18nGlossary.md)
|
|
1945
1959
|
- [UltracartClient::SfvbI18nGlossaryRequest](docs/SfvbI18nGlossaryRequest.md)
|
|
1946
1960
|
- [UltracartClient::SfvbI18nLanguage](docs/SfvbI18nLanguage.md)
|
|
@@ -2287,6 +2301,8 @@ Not every change is committed to every SDK.
|
|
|
2287
2301
|
|
|
2288
2302
|
| Version | Date | Comments |
|
|
2289
2303
|
| --: | :-: | --- |
|
|
2304
|
+
| 4.1.208 | 10/26/2026 | sfvb internal testing |
|
|
2305
|
+
| 4.1.207 | 10/16/2026 | sfvb internal testing |
|
|
2290
2306
|
| 4.1.206 | 10/16/2026 | sfvb internal testing |
|
|
2291
2307
|
| 4.1.205 | 10/15/2026 | sfvb internal testing |
|
|
2292
2308
|
| 4.1.204 | 10/15/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -48,6 +48,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
48
48
|
| [**get_sfvb_approval**](SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request |
|
|
49
49
|
| [**get_sfvb_approvals**](SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests |
|
|
50
50
|
| [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
|
|
51
|
+
| [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
|
|
51
52
|
| [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
|
|
52
53
|
| [**get_sfvb_comms_sending_domain**](SfvbApi.md#get_sfvb_comms_sending_domain) | **GET** /sfvb/comms/sending_domains/{domain} | Read a sending domain |
|
|
53
54
|
| [**get_sfvb_comms_sending_domains**](SfvbApi.md#get_sfvb_comms_sending_domains) | **GET** /sfvb/comms/sending_domains | List the sending domains |
|
|
@@ -55,12 +56,14 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
55
56
|
| [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
|
|
56
57
|
| [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
|
|
57
58
|
| [**get_sfvb_element**](SfvbApi.md#get_sfvb_element) | **GET** /sfvb/elements/{element_type} | Configuration schema and field card for one element type |
|
|
59
|
+
| [**get_sfvb_email**](SfvbApi.md#get_sfvb_email) | **GET** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Get a flow or campaign email's subject and preview text |
|
|
58
60
|
| [**get_sfvb_events**](SfvbApi.md#get_sfvb_events) | **GET** /sfvb/events | Replay events |
|
|
59
61
|
| [**get_sfvb_events_authorization**](SfvbApi.md#get_sfvb_events_authorization) | **PUT** /sfvb/events/auth | Open the event stream |
|
|
60
62
|
| [**get_sfvb_experiment**](SfvbApi.md#get_sfvb_experiment) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid} | Read one experiment and its statistics |
|
|
61
63
|
| [**get_sfvb_experiment_objectives**](SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize |
|
|
62
64
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
63
65
|
| [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
|
|
66
|
+
| [**get_sfvb_flow**](SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow |
|
|
64
67
|
| [**get_sfvb_i18n_glossary**](SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary |
|
|
65
68
|
| [**get_sfvb_i18n_languages**](SfvbApi.md#get_sfvb_i18n_languages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/languages | List a storefront's languages |
|
|
66
69
|
| [**get_sfvb_i18n_machine_translations**](SfvbApi.md#get_sfvb_i18n_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/machine_translations | Read where a widget setting's translations come from |
|
|
@@ -115,11 +118,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
115
118
|
| [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
|
|
116
119
|
| [**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 |
|
|
117
120
|
| [**list_sfvb_blog_posts**](SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts |
|
|
121
|
+
| [**list_sfvb_campaigns**](SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns |
|
|
118
122
|
| [**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 |
|
|
119
123
|
| [**list_sfvb_elements**](SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type |
|
|
120
124
|
| [**list_sfvb_experiments**](SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments |
|
|
121
125
|
| [**list_sfvb_file_versions**](SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file |
|
|
122
126
|
| [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
|
|
127
|
+
| [**list_sfvb_flows**](SfvbApi.md#list_sfvb_flows) | **GET** /sfvb/storefronts/{storefront_oid}/flows | List the storefront's flows |
|
|
123
128
|
| [**list_sfvb_i18n_messages**](SfvbApi.md#list_sfvb_i18n_messages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages | List built-in messages |
|
|
124
129
|
| [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
|
|
125
130
|
| [**list_sfvb_library_installs**](SfvbApi.md#list_sfvb_library_installs) | **GET** /sfvb/storefronts/{storefront_oid}/library/installs | List the library entries installed on a storefront |
|
|
@@ -180,6 +185,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
180
185
|
| [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
|
|
181
186
|
| [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
|
|
182
187
|
| [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
|
|
188
|
+
| [**update_sfvb_email**](SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text |
|
|
183
189
|
| [**update_sfvb_item_attribute_batch**](SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call |
|
|
184
190
|
| [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
|
|
185
191
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
@@ -2585,6 +2591,60 @@ end
|
|
|
2585
2591
|
- **Accept**: application/json
|
|
2586
2592
|
|
|
2587
2593
|
|
|
2594
|
+
## get_sfvb_campaign
|
|
2595
|
+
|
|
2596
|
+
> <SfvbCampaign> get_sfvb_campaign(storefront_oid, campaign_uuid)
|
|
2597
|
+
|
|
2598
|
+
Get a campaign
|
|
2599
|
+
|
|
2600
|
+
One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
### Examples
|
|
2604
|
+
|
|
2605
|
+
|
|
2606
|
+
(No example for this operation).
|
|
2607
|
+
|
|
2608
|
+
|
|
2609
|
+
#### Using the get_sfvb_campaign_with_http_info variant
|
|
2610
|
+
|
|
2611
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2612
|
+
|
|
2613
|
+
> <Array(<SfvbCampaign>, Integer, Hash)> get_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
|
|
2614
|
+
|
|
2615
|
+
```ruby
|
|
2616
|
+
begin
|
|
2617
|
+
# Get a campaign
|
|
2618
|
+
data, status_code, headers = api_instance.get_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
|
|
2619
|
+
p status_code # => 2xx
|
|
2620
|
+
p headers # => { ... }
|
|
2621
|
+
p data # => <SfvbCampaign>
|
|
2622
|
+
rescue UltracartClient::ApiError => e
|
|
2623
|
+
puts "Error when calling SfvbApi->get_sfvb_campaign_with_http_info: #{e}"
|
|
2624
|
+
end
|
|
2625
|
+
```
|
|
2626
|
+
|
|
2627
|
+
### Parameters
|
|
2628
|
+
|
|
2629
|
+
| Name | Type | Description | Notes |
|
|
2630
|
+
| ---- | ---- | ----------- | ----- |
|
|
2631
|
+
| **storefront_oid** | **Integer** | | |
|
|
2632
|
+
| **campaign_uuid** | **String** | | |
|
|
2633
|
+
|
|
2634
|
+
### Return type
|
|
2635
|
+
|
|
2636
|
+
[**SfvbCampaign**](SfvbCampaign.md)
|
|
2637
|
+
|
|
2638
|
+
### Authorization
|
|
2639
|
+
|
|
2640
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2641
|
+
|
|
2642
|
+
### HTTP request headers
|
|
2643
|
+
|
|
2644
|
+
- **Content-Type**: Not defined
|
|
2645
|
+
- **Accept**: application/json
|
|
2646
|
+
|
|
2647
|
+
|
|
2588
2648
|
## get_sfvb_cjson_used_elements
|
|
2589
2649
|
|
|
2590
2650
|
> <SfvbElementsResponse> get_sfvb_cjson_used_elements(compile_request)
|
|
@@ -2957,6 +3017,60 @@ end
|
|
|
2957
3017
|
- **Accept**: application/json
|
|
2958
3018
|
|
|
2959
3019
|
|
|
3020
|
+
## get_sfvb_email
|
|
3021
|
+
|
|
3022
|
+
> <SfvbEmail> get_sfvb_email(storefront_oid, email_uuid)
|
|
3023
|
+
|
|
3024
|
+
Get a flow or campaign email's subject and preview text
|
|
3025
|
+
|
|
3026
|
+
The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront's campaigns and flows.
|
|
3027
|
+
|
|
3028
|
+
|
|
3029
|
+
### Examples
|
|
3030
|
+
|
|
3031
|
+
|
|
3032
|
+
(No example for this operation).
|
|
3033
|
+
|
|
3034
|
+
|
|
3035
|
+
#### Using the get_sfvb_email_with_http_info variant
|
|
3036
|
+
|
|
3037
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3038
|
+
|
|
3039
|
+
> <Array(<SfvbEmail>, Integer, Hash)> get_sfvb_email_with_http_info(storefront_oid, email_uuid)
|
|
3040
|
+
|
|
3041
|
+
```ruby
|
|
3042
|
+
begin
|
|
3043
|
+
# Get a flow or campaign email's subject and preview text
|
|
3044
|
+
data, status_code, headers = api_instance.get_sfvb_email_with_http_info(storefront_oid, email_uuid)
|
|
3045
|
+
p status_code # => 2xx
|
|
3046
|
+
p headers # => { ... }
|
|
3047
|
+
p data # => <SfvbEmail>
|
|
3048
|
+
rescue UltracartClient::ApiError => e
|
|
3049
|
+
puts "Error when calling SfvbApi->get_sfvb_email_with_http_info: #{e}"
|
|
3050
|
+
end
|
|
3051
|
+
```
|
|
3052
|
+
|
|
3053
|
+
### Parameters
|
|
3054
|
+
|
|
3055
|
+
| Name | Type | Description | Notes |
|
|
3056
|
+
| ---- | ---- | ----------- | ----- |
|
|
3057
|
+
| **storefront_oid** | **Integer** | | |
|
|
3058
|
+
| **email_uuid** | **String** | | |
|
|
3059
|
+
|
|
3060
|
+
### Return type
|
|
3061
|
+
|
|
3062
|
+
[**SfvbEmail**](SfvbEmail.md)
|
|
3063
|
+
|
|
3064
|
+
### Authorization
|
|
3065
|
+
|
|
3066
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3067
|
+
|
|
3068
|
+
### HTTP request headers
|
|
3069
|
+
|
|
3070
|
+
- **Content-Type**: Not defined
|
|
3071
|
+
- **Accept**: application/json
|
|
3072
|
+
|
|
3073
|
+
|
|
2960
3074
|
## get_sfvb_events
|
|
2961
3075
|
|
|
2962
3076
|
> <SfvbEventsResponse> get_sfvb_events(opts)
|
|
@@ -3282,6 +3396,60 @@ end
|
|
|
3282
3396
|
- **Accept**: application/json
|
|
3283
3397
|
|
|
3284
3398
|
|
|
3399
|
+
## get_sfvb_flow
|
|
3400
|
+
|
|
3401
|
+
> <SfvbFlow> get_sfvb_flow(storefront_oid, flow_uuid)
|
|
3402
|
+
|
|
3403
|
+
Get a flow
|
|
3404
|
+
|
|
3405
|
+
One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
|
|
3406
|
+
|
|
3407
|
+
|
|
3408
|
+
### Examples
|
|
3409
|
+
|
|
3410
|
+
|
|
3411
|
+
(No example for this operation).
|
|
3412
|
+
|
|
3413
|
+
|
|
3414
|
+
#### Using the get_sfvb_flow_with_http_info variant
|
|
3415
|
+
|
|
3416
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3417
|
+
|
|
3418
|
+
> <Array(<SfvbFlow>, Integer, Hash)> get_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
|
|
3419
|
+
|
|
3420
|
+
```ruby
|
|
3421
|
+
begin
|
|
3422
|
+
# Get a flow
|
|
3423
|
+
data, status_code, headers = api_instance.get_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
|
|
3424
|
+
p status_code # => 2xx
|
|
3425
|
+
p headers # => { ... }
|
|
3426
|
+
p data # => <SfvbFlow>
|
|
3427
|
+
rescue UltracartClient::ApiError => e
|
|
3428
|
+
puts "Error when calling SfvbApi->get_sfvb_flow_with_http_info: #{e}"
|
|
3429
|
+
end
|
|
3430
|
+
```
|
|
3431
|
+
|
|
3432
|
+
### Parameters
|
|
3433
|
+
|
|
3434
|
+
| Name | Type | Description | Notes |
|
|
3435
|
+
| ---- | ---- | ----------- | ----- |
|
|
3436
|
+
| **storefront_oid** | **Integer** | | |
|
|
3437
|
+
| **flow_uuid** | **String** | | |
|
|
3438
|
+
|
|
3439
|
+
### Return type
|
|
3440
|
+
|
|
3441
|
+
[**SfvbFlow**](SfvbFlow.md)
|
|
3442
|
+
|
|
3443
|
+
### Authorization
|
|
3444
|
+
|
|
3445
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3446
|
+
|
|
3447
|
+
### HTTP request headers
|
|
3448
|
+
|
|
3449
|
+
- **Content-Type**: Not defined
|
|
3450
|
+
- **Accept**: application/json
|
|
3451
|
+
|
|
3452
|
+
|
|
3285
3453
|
## get_sfvb_i18n_glossary
|
|
3286
3454
|
|
|
3287
3455
|
> <SfvbI18nGlossary> get_sfvb_i18n_glossary(storefront_oid)
|
|
@@ -6204,6 +6372,63 @@ end
|
|
|
6204
6372
|
- **Accept**: application/json
|
|
6205
6373
|
|
|
6206
6374
|
|
|
6375
|
+
## list_sfvb_campaigns
|
|
6376
|
+
|
|
6377
|
+
> <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
|
|
6378
|
+
|
|
6379
|
+
List the storefront's campaigns
|
|
6380
|
+
|
|
6381
|
+
One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
|
|
6382
|
+
|
|
6383
|
+
|
|
6384
|
+
### Examples
|
|
6385
|
+
|
|
6386
|
+
|
|
6387
|
+
(No example for this operation).
|
|
6388
|
+
|
|
6389
|
+
|
|
6390
|
+
#### Using the list_sfvb_campaigns_with_http_info variant
|
|
6391
|
+
|
|
6392
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6393
|
+
|
|
6394
|
+
> <Array(<SfvbCampaignsResponse>, Integer, Hash)> list_sfvb_campaigns_with_http_info(storefront_oid, opts)
|
|
6395
|
+
|
|
6396
|
+
```ruby
|
|
6397
|
+
begin
|
|
6398
|
+
# List the storefront's campaigns
|
|
6399
|
+
data, status_code, headers = api_instance.list_sfvb_campaigns_with_http_info(storefront_oid, opts)
|
|
6400
|
+
p status_code # => 2xx
|
|
6401
|
+
p headers # => { ... }
|
|
6402
|
+
p data # => <SfvbCampaignsResponse>
|
|
6403
|
+
rescue UltracartClient::ApiError => e
|
|
6404
|
+
puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
|
|
6405
|
+
end
|
|
6406
|
+
```
|
|
6407
|
+
|
|
6408
|
+
### Parameters
|
|
6409
|
+
|
|
6410
|
+
| Name | Type | Description | Notes |
|
|
6411
|
+
| ---- | ---- | ----------- | ----- |
|
|
6412
|
+
| **storefront_oid** | **Integer** | | |
|
|
6413
|
+
| **search** | **String** | Text to search for in the name | [optional] |
|
|
6414
|
+
| **page** | **Integer** | Page number, starting at 1 | [optional] |
|
|
6415
|
+
| **page_size** | **Integer** | Campaigns per page, 1 to 100, default 50 | [optional] |
|
|
6416
|
+
| **include_deleted** | **Boolean** | Include deleted campaigns | [optional] |
|
|
6417
|
+
|
|
6418
|
+
### Return type
|
|
6419
|
+
|
|
6420
|
+
[**SfvbCampaignsResponse**](SfvbCampaignsResponse.md)
|
|
6421
|
+
|
|
6422
|
+
### Authorization
|
|
6423
|
+
|
|
6424
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6425
|
+
|
|
6426
|
+
### HTTP request headers
|
|
6427
|
+
|
|
6428
|
+
- **Content-Type**: Not defined
|
|
6429
|
+
- **Accept**: application/json
|
|
6430
|
+
|
|
6431
|
+
|
|
6207
6432
|
## list_sfvb_container_versions
|
|
6208
6433
|
|
|
6209
6434
|
> <SfvbContainerVersionsResponse> list_sfvb_container_versions(storefront_oid, opts)
|
|
@@ -6478,6 +6703,63 @@ end
|
|
|
6478
6703
|
- **Accept**: application/json
|
|
6479
6704
|
|
|
6480
6705
|
|
|
6706
|
+
## list_sfvb_flows
|
|
6707
|
+
|
|
6708
|
+
> <SfvbFlowsResponse> list_sfvb_flows(storefront_oid, opts)
|
|
6709
|
+
|
|
6710
|
+
List the storefront's flows
|
|
6711
|
+
|
|
6712
|
+
One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
|
|
6713
|
+
|
|
6714
|
+
|
|
6715
|
+
### Examples
|
|
6716
|
+
|
|
6717
|
+
|
|
6718
|
+
(No example for this operation).
|
|
6719
|
+
|
|
6720
|
+
|
|
6721
|
+
#### Using the list_sfvb_flows_with_http_info variant
|
|
6722
|
+
|
|
6723
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6724
|
+
|
|
6725
|
+
> <Array(<SfvbFlowsResponse>, Integer, Hash)> list_sfvb_flows_with_http_info(storefront_oid, opts)
|
|
6726
|
+
|
|
6727
|
+
```ruby
|
|
6728
|
+
begin
|
|
6729
|
+
# List the storefront's flows
|
|
6730
|
+
data, status_code, headers = api_instance.list_sfvb_flows_with_http_info(storefront_oid, opts)
|
|
6731
|
+
p status_code # => 2xx
|
|
6732
|
+
p headers # => { ... }
|
|
6733
|
+
p data # => <SfvbFlowsResponse>
|
|
6734
|
+
rescue UltracartClient::ApiError => e
|
|
6735
|
+
puts "Error when calling SfvbApi->list_sfvb_flows_with_http_info: #{e}"
|
|
6736
|
+
end
|
|
6737
|
+
```
|
|
6738
|
+
|
|
6739
|
+
### Parameters
|
|
6740
|
+
|
|
6741
|
+
| Name | Type | Description | Notes |
|
|
6742
|
+
| ---- | ---- | ----------- | ----- |
|
|
6743
|
+
| **storefront_oid** | **Integer** | | |
|
|
6744
|
+
| **search** | **String** | Text to search for in the name | [optional] |
|
|
6745
|
+
| **page** | **Integer** | Page number, starting at 1 | [optional] |
|
|
6746
|
+
| **page_size** | **Integer** | Flows per page, 1 to 100, default 50 | [optional] |
|
|
6747
|
+
| **include_deleted** | **Boolean** | Include deleted flows | [optional] |
|
|
6748
|
+
|
|
6749
|
+
### Return type
|
|
6750
|
+
|
|
6751
|
+
[**SfvbFlowsResponse**](SfvbFlowsResponse.md)
|
|
6752
|
+
|
|
6753
|
+
### Authorization
|
|
6754
|
+
|
|
6755
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6756
|
+
|
|
6757
|
+
### HTTP request headers
|
|
6758
|
+
|
|
6759
|
+
- **Content-Type**: Not defined
|
|
6760
|
+
- **Accept**: application/json
|
|
6761
|
+
|
|
6762
|
+
|
|
6481
6763
|
## list_sfvb_i18n_messages
|
|
6482
6764
|
|
|
6483
6765
|
> <SfvbI18nMessagesResponse> list_sfvb_i18n_messages(storefront_oid, opts)
|
|
@@ -9797,6 +10079,62 @@ end
|
|
|
9797
10079
|
- **Accept**: application/json
|
|
9798
10080
|
|
|
9799
10081
|
|
|
10082
|
+
## update_sfvb_email
|
|
10083
|
+
|
|
10084
|
+
> <SfvbEmail> update_sfvb_email(storefront_oid, email_uuid, if_match, email_update_request)
|
|
10085
|
+
|
|
10086
|
+
Change a flow or campaign email's subject or preview text
|
|
10087
|
+
|
|
10088
|
+
A field left out keeps its value. Each is 5 to 150 characters on one line. Send the hash_sha256 you read as If-Match. An email in a sending flow or campaign needs sfvb_publish, as a body push does. The merchant's content review rule applies, so an email waiting for review or rejected goes back to needing review. An email suspended for spam is refused with sfvb.email_suspended.
|
|
10089
|
+
|
|
10090
|
+
|
|
10091
|
+
### Examples
|
|
10092
|
+
|
|
10093
|
+
|
|
10094
|
+
(No example for this operation).
|
|
10095
|
+
|
|
10096
|
+
|
|
10097
|
+
#### Using the update_sfvb_email_with_http_info variant
|
|
10098
|
+
|
|
10099
|
+
This returns an Array which contains the response data, status code and headers.
|
|
10100
|
+
|
|
10101
|
+
> <Array(<SfvbEmail>, Integer, Hash)> update_sfvb_email_with_http_info(storefront_oid, email_uuid, if_match, email_update_request)
|
|
10102
|
+
|
|
10103
|
+
```ruby
|
|
10104
|
+
begin
|
|
10105
|
+
# Change a flow or campaign email's subject or preview text
|
|
10106
|
+
data, status_code, headers = api_instance.update_sfvb_email_with_http_info(storefront_oid, email_uuid, if_match, email_update_request)
|
|
10107
|
+
p status_code # => 2xx
|
|
10108
|
+
p headers # => { ... }
|
|
10109
|
+
p data # => <SfvbEmail>
|
|
10110
|
+
rescue UltracartClient::ApiError => e
|
|
10111
|
+
puts "Error when calling SfvbApi->update_sfvb_email_with_http_info: #{e}"
|
|
10112
|
+
end
|
|
10113
|
+
```
|
|
10114
|
+
|
|
10115
|
+
### Parameters
|
|
10116
|
+
|
|
10117
|
+
| Name | Type | Description | Notes |
|
|
10118
|
+
| ---- | ---- | ----------- | ----- |
|
|
10119
|
+
| **storefront_oid** | **Integer** | | |
|
|
10120
|
+
| **email_uuid** | **String** | | |
|
|
10121
|
+
| **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
|
|
10122
|
+
| **email_update_request** | [**SfvbEmailUpdateRequest**](SfvbEmailUpdateRequest.md) | The subject or preview text to change | |
|
|
10123
|
+
|
|
10124
|
+
### Return type
|
|
10125
|
+
|
|
10126
|
+
[**SfvbEmail**](SfvbEmail.md)
|
|
10127
|
+
|
|
10128
|
+
### Authorization
|
|
10129
|
+
|
|
10130
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
10131
|
+
|
|
10132
|
+
### HTTP request headers
|
|
10133
|
+
|
|
10134
|
+
- **Content-Type**: application/json
|
|
10135
|
+
- **Accept**: application/json
|
|
10136
|
+
|
|
10137
|
+
|
|
9800
10138
|
## update_sfvb_item_attribute_batch
|
|
9801
10139
|
|
|
9802
10140
|
> <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::SfvbCampaign
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **campaign_uuid** | **String** | The campaign uuid. | [optional] |
|
|
8
|
+
| **communication_sequence_uuid** | **String** | The communication sequence the steps belong to. | [optional] |
|
|
9
|
+
| **created_dts** | **String** | When the campaign was created (ISO 8601, UTC). | [optional] |
|
|
10
|
+
| **deleted** | **Boolean** | True when the campaign was deleted. | [optional] |
|
|
11
|
+
| **emails** | [**Array<SfvbCommsEmail>**](SfvbCommsEmail.md) | Its emails, in step order. | [optional] |
|
|
12
|
+
| **live** | **Boolean** | True when the emails and postcards reach customers now, so a change to one shows at once. False only in a status that sends nothing. | [optional] |
|
|
13
|
+
| **name** | **String** | The campaign name. | [optional] |
|
|
14
|
+
| **postcards** | [**Array<SfvbCommsPostcard>**](SfvbCommsPostcard.md) | Its postcards, in step order. | [optional] |
|
|
15
|
+
| **scheduled_dts** | **String** | When the campaign is scheduled to send (ISO 8601, UTC), when it is. | [optional] |
|
|
16
|
+
| **status** | **String** | The status, such as draft, scheduled, sending, sent or archived. | [optional] |
|
|
17
|
+
| **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::SfvbCampaign.new(
|
|
25
|
+
campaign_uuid: null,
|
|
26
|
+
communication_sequence_uuid: null,
|
|
27
|
+
created_dts: null,
|
|
28
|
+
deleted: null,
|
|
29
|
+
emails: null,
|
|
30
|
+
live: null,
|
|
31
|
+
name: null,
|
|
32
|
+
postcards: null,
|
|
33
|
+
scheduled_dts: null,
|
|
34
|
+
status: null,
|
|
35
|
+
status_dts: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbCampaignsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **campaigns** | [**Array<SfvbCampaign>**](SfvbCampaign.md) | The campaigns on this page, newest first. | [optional] |
|
|
8
|
+
| **page** | **Integer** | This page number, starting at 1. | [optional] |
|
|
9
|
+
| **page_size** | **Integer** | The page size. | [optional] |
|
|
10
|
+
| **total** | **Integer** | How many match, across every page. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbCampaignsResponse.new(
|
|
18
|
+
campaigns: null,
|
|
19
|
+
page: null,
|
|
20
|
+
page_size: null,
|
|
21
|
+
total: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::SfvbCommsEmail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **container_last_modified_dts** | **String** | When the email container was last changed (ISO 8601, UTC). | [optional] |
|
|
8
|
+
| **deleted** | **Boolean** | True when the email was deleted. | [optional] |
|
|
9
|
+
| **email_uuid** | **String** | The email uuid. Use it with the email container (owner type email) and with the email render endpoint. | [optional] |
|
|
10
|
+
| **pending_review** | **Boolean** | True while a change waits for review. | [optional] |
|
|
11
|
+
| **preview_text** | **String** | The preview text an inbox shows after the subject. | [optional] |
|
|
12
|
+
| **rejected** | **Boolean** | True when review rejected the email. Don't edit it without the merchant. | [optional] |
|
|
13
|
+
| **requires_review** | **Boolean** | True when a change to this email must be reviewed before it sends. | [optional] |
|
|
14
|
+
| **step_uuid** | **String** | The step that sends this email. | [optional] |
|
|
15
|
+
| **subject** | **String** | The subject line. | [optional] |
|
|
16
|
+
| **transactional** | **Boolean** | True for a transactional email, which skips the marketing footer rules. | [optional] |
|
|
17
|
+
| **version** | **Integer** | The email version. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::SfvbCommsEmail.new(
|
|
25
|
+
container_last_modified_dts: null,
|
|
26
|
+
deleted: null,
|
|
27
|
+
email_uuid: null,
|
|
28
|
+
pending_review: null,
|
|
29
|
+
preview_text: null,
|
|
30
|
+
rejected: null,
|
|
31
|
+
requires_review: null,
|
|
32
|
+
step_uuid: null,
|
|
33
|
+
subject: null,
|
|
34
|
+
transactional: null,
|
|
35
|
+
version: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::SfvbCommsPostcard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **back_container_uuid** | **String** | The back side container uuid (owner type postcardback). | [optional] |
|
|
8
|
+
| **container_last_modified_dts** | **String** | When either side was last changed (ISO 8601, UTC). | [optional] |
|
|
9
|
+
| **deleted** | **Boolean** | True when the postcard was deleted. | [optional] |
|
|
10
|
+
| **front_container_uuid** | **String** | The front side container uuid (owner type postcardfront). | [optional] |
|
|
11
|
+
| **postcard_uuid** | **String** | The postcard uuid. | [optional] |
|
|
12
|
+
| **step_uuid** | **String** | The step that sends this postcard. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::SfvbCommsPostcard.new(
|
|
20
|
+
back_container_uuid: null,
|
|
21
|
+
container_last_modified_dts: null,
|
|
22
|
+
deleted: null,
|
|
23
|
+
front_container_uuid: null,
|
|
24
|
+
postcard_uuid: null,
|
|
25
|
+
step_uuid: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|