ultracart_api 4.1.205 → 4.1.207
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 -2
- data/docs/SfvbApi.md +226 -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/SfvbFlow.md +40 -0
- data/docs/SfvbFlowsResponse.md +24 -0
- data/docs/SfvbTransactionalEmail.md +3 -1
- data/lib/ultracart_api/api/sfvb_api.rb +292 -0
- 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_flow.rb +334 -0
- data/lib/ultracart_api/models/sfvb_flows_response.rb +252 -0
- data/lib/ultracart_api/models/sfvb_transactional_email.rb +12 -2
- 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: 6744f4e0dacef9815b35ba7d361ad6c3a004b2082087fe5dd2bf8a9080a39b7b
|
|
4
|
+
data.tar.gz: 736cbe24406af15bbc288eb879458f7164de9bbf7be7eb91f03d3cc033636ceb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 971ad17902b7469aa50522e4493d8f50f6fd9e47c9ab76aeef4e4e6980317142dd04f8ad0e244267b278eafedc0c8d3fa62fddbcaf1cf19f497a60662b739389
|
|
7
|
+
data.tar.gz: a418834642c184d169ae942a84c4c1096bb191de93afa545eb8b7dafd704f423293a2079cbac1e137999827c578048d366d30a63b1c82b7348868ad8a6dbeeff
|
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.207
|
|
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.207'
|
|
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
|
|
@@ -533,6 +534,7 @@ Class | Method | HTTP request | Description
|
|
|
533
534
|
*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
535
|
*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
536
|
*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
|
|
537
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_flow**](docs/SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow
|
|
536
538
|
*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
539
|
*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
540
|
*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 +589,13 @@ Class | Method | HTTP request | Description
|
|
|
587
589
|
*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
590
|
*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
591
|
*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
|
|
592
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_campaigns**](docs/SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns
|
|
590
593
|
*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
594
|
*UltracartClient::SfvbApi* | [**list_sfvb_elements**](docs/SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type
|
|
592
595
|
*UltracartClient::SfvbApi* | [**list_sfvb_experiments**](docs/SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments
|
|
593
596
|
*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
597
|
*UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
|
|
598
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_flows**](docs/SfvbApi.md#list_sfvb_flows) | **GET** /sfvb/storefronts/{storefront_oid}/flows | List the storefront's flows
|
|
595
599
|
*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
600
|
*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
601
|
*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
|
|
@@ -1899,7 +1903,11 @@ Class | Method | HTTP request | Description
|
|
|
1899
1903
|
- [UltracartClient::SfvbBlogPostImageRequest](docs/SfvbBlogPostImageRequest.md)
|
|
1900
1904
|
- [UltracartClient::SfvbBlogPostRequest](docs/SfvbBlogPostRequest.md)
|
|
1901
1905
|
- [UltracartClient::SfvbBlogPostsResponse](docs/SfvbBlogPostsResponse.md)
|
|
1906
|
+
- [UltracartClient::SfvbCampaign](docs/SfvbCampaign.md)
|
|
1907
|
+
- [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
|
|
1902
1908
|
- [UltracartClient::SfvbCommsDnsRecord](docs/SfvbCommsDnsRecord.md)
|
|
1909
|
+
- [UltracartClient::SfvbCommsEmail](docs/SfvbCommsEmail.md)
|
|
1910
|
+
- [UltracartClient::SfvbCommsPostcard](docs/SfvbCommsPostcard.md)
|
|
1903
1911
|
- [UltracartClient::SfvbCommsSendingDomain](docs/SfvbCommsSendingDomain.md)
|
|
1904
1912
|
- [UltracartClient::SfvbCommsSendingDomainsResponse](docs/SfvbCommsSendingDomainsResponse.md)
|
|
1905
1913
|
- [UltracartClient::SfvbCommsTwilioAccount](docs/SfvbCommsTwilioAccount.md)
|
|
@@ -1941,6 +1949,8 @@ Class | Method | HTTP request | Description
|
|
|
1941
1949
|
- [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
|
|
1942
1950
|
- [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
|
|
1943
1951
|
- [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
|
|
1952
|
+
- [UltracartClient::SfvbFlow](docs/SfvbFlow.md)
|
|
1953
|
+
- [UltracartClient::SfvbFlowsResponse](docs/SfvbFlowsResponse.md)
|
|
1944
1954
|
- [UltracartClient::SfvbI18nGlossary](docs/SfvbI18nGlossary.md)
|
|
1945
1955
|
- [UltracartClient::SfvbI18nGlossaryRequest](docs/SfvbI18nGlossaryRequest.md)
|
|
1946
1956
|
- [UltracartClient::SfvbI18nLanguage](docs/SfvbI18nLanguage.md)
|
|
@@ -2287,6 +2297,8 @@ Not every change is committed to every SDK.
|
|
|
2287
2297
|
|
|
2288
2298
|
| Version | Date | Comments |
|
|
2289
2299
|
| --: | :-: | --- |
|
|
2300
|
+
| 4.1.207 | 10/16/2026 | sfvb internal testing |
|
|
2301
|
+
| 4.1.206 | 10/16/2026 | sfvb internal testing |
|
|
2290
2302
|
| 4.1.205 | 10/15/2026 | sfvb internal testing |
|
|
2291
2303
|
| 4.1.204 | 10/15/2026 | sfvb internal testing |
|
|
2292
2304
|
| 4.1.203 | 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 |
|
|
@@ -61,6 +62,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
61
62
|
| [**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
63
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
63
64
|
| [**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 |
|
|
65
|
+
| [**get_sfvb_flow**](SfvbApi.md#get_sfvb_flow) | **GET** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Get a flow |
|
|
64
66
|
| [**get_sfvb_i18n_glossary**](SfvbApi.md#get_sfvb_i18n_glossary) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/glossary | Read the storefront's translation glossary |
|
|
65
67
|
| [**get_sfvb_i18n_languages**](SfvbApi.md#get_sfvb_i18n_languages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/languages | List a storefront's languages |
|
|
66
68
|
| [**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 +117,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
115
117
|
| [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
|
|
116
118
|
| [**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
119
|
| [**list_sfvb_blog_posts**](SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts |
|
|
120
|
+
| [**list_sfvb_campaigns**](SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns |
|
|
118
121
|
| [**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
122
|
| [**list_sfvb_elements**](SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type |
|
|
120
123
|
| [**list_sfvb_experiments**](SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments |
|
|
121
124
|
| [**list_sfvb_file_versions**](SfvbApi.md#list_sfvb_file_versions) | **GET** /sfvb/storefronts/{storefront_oid}/files/versions | Version history for a storefront file |
|
|
122
125
|
| [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
|
|
126
|
+
| [**list_sfvb_flows**](SfvbApi.md#list_sfvb_flows) | **GET** /sfvb/storefronts/{storefront_oid}/flows | List the storefront's flows |
|
|
123
127
|
| [**list_sfvb_i18n_messages**](SfvbApi.md#list_sfvb_i18n_messages) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages | List built-in messages |
|
|
124
128
|
| [**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
129
|
| [**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 |
|
|
@@ -2585,6 +2589,60 @@ end
|
|
|
2585
2589
|
- **Accept**: application/json
|
|
2586
2590
|
|
|
2587
2591
|
|
|
2592
|
+
## get_sfvb_campaign
|
|
2593
|
+
|
|
2594
|
+
> <SfvbCampaign> get_sfvb_campaign(storefront_oid, campaign_uuid)
|
|
2595
|
+
|
|
2596
|
+
Get a campaign
|
|
2597
|
+
|
|
2598
|
+
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.
|
|
2599
|
+
|
|
2600
|
+
|
|
2601
|
+
### Examples
|
|
2602
|
+
|
|
2603
|
+
|
|
2604
|
+
(No example for this operation).
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
#### Using the get_sfvb_campaign_with_http_info variant
|
|
2608
|
+
|
|
2609
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2610
|
+
|
|
2611
|
+
> <Array(<SfvbCampaign>, Integer, Hash)> get_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
|
|
2612
|
+
|
|
2613
|
+
```ruby
|
|
2614
|
+
begin
|
|
2615
|
+
# Get a campaign
|
|
2616
|
+
data, status_code, headers = api_instance.get_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
|
|
2617
|
+
p status_code # => 2xx
|
|
2618
|
+
p headers # => { ... }
|
|
2619
|
+
p data # => <SfvbCampaign>
|
|
2620
|
+
rescue UltracartClient::ApiError => e
|
|
2621
|
+
puts "Error when calling SfvbApi->get_sfvb_campaign_with_http_info: #{e}"
|
|
2622
|
+
end
|
|
2623
|
+
```
|
|
2624
|
+
|
|
2625
|
+
### Parameters
|
|
2626
|
+
|
|
2627
|
+
| Name | Type | Description | Notes |
|
|
2628
|
+
| ---- | ---- | ----------- | ----- |
|
|
2629
|
+
| **storefront_oid** | **Integer** | | |
|
|
2630
|
+
| **campaign_uuid** | **String** | | |
|
|
2631
|
+
|
|
2632
|
+
### Return type
|
|
2633
|
+
|
|
2634
|
+
[**SfvbCampaign**](SfvbCampaign.md)
|
|
2635
|
+
|
|
2636
|
+
### Authorization
|
|
2637
|
+
|
|
2638
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2639
|
+
|
|
2640
|
+
### HTTP request headers
|
|
2641
|
+
|
|
2642
|
+
- **Content-Type**: Not defined
|
|
2643
|
+
- **Accept**: application/json
|
|
2644
|
+
|
|
2645
|
+
|
|
2588
2646
|
## get_sfvb_cjson_used_elements
|
|
2589
2647
|
|
|
2590
2648
|
> <SfvbElementsResponse> get_sfvb_cjson_used_elements(compile_request)
|
|
@@ -3282,6 +3340,60 @@ end
|
|
|
3282
3340
|
- **Accept**: application/json
|
|
3283
3341
|
|
|
3284
3342
|
|
|
3343
|
+
## get_sfvb_flow
|
|
3344
|
+
|
|
3345
|
+
> <SfvbFlow> get_sfvb_flow(storefront_oid, flow_uuid)
|
|
3346
|
+
|
|
3347
|
+
Get a flow
|
|
3348
|
+
|
|
3349
|
+
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.
|
|
3350
|
+
|
|
3351
|
+
|
|
3352
|
+
### Examples
|
|
3353
|
+
|
|
3354
|
+
|
|
3355
|
+
(No example for this operation).
|
|
3356
|
+
|
|
3357
|
+
|
|
3358
|
+
#### Using the get_sfvb_flow_with_http_info variant
|
|
3359
|
+
|
|
3360
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3361
|
+
|
|
3362
|
+
> <Array(<SfvbFlow>, Integer, Hash)> get_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
|
|
3363
|
+
|
|
3364
|
+
```ruby
|
|
3365
|
+
begin
|
|
3366
|
+
# Get a flow
|
|
3367
|
+
data, status_code, headers = api_instance.get_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
|
|
3368
|
+
p status_code # => 2xx
|
|
3369
|
+
p headers # => { ... }
|
|
3370
|
+
p data # => <SfvbFlow>
|
|
3371
|
+
rescue UltracartClient::ApiError => e
|
|
3372
|
+
puts "Error when calling SfvbApi->get_sfvb_flow_with_http_info: #{e}"
|
|
3373
|
+
end
|
|
3374
|
+
```
|
|
3375
|
+
|
|
3376
|
+
### Parameters
|
|
3377
|
+
|
|
3378
|
+
| Name | Type | Description | Notes |
|
|
3379
|
+
| ---- | ---- | ----------- | ----- |
|
|
3380
|
+
| **storefront_oid** | **Integer** | | |
|
|
3381
|
+
| **flow_uuid** | **String** | | |
|
|
3382
|
+
|
|
3383
|
+
### Return type
|
|
3384
|
+
|
|
3385
|
+
[**SfvbFlow**](SfvbFlow.md)
|
|
3386
|
+
|
|
3387
|
+
### Authorization
|
|
3388
|
+
|
|
3389
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3390
|
+
|
|
3391
|
+
### HTTP request headers
|
|
3392
|
+
|
|
3393
|
+
- **Content-Type**: Not defined
|
|
3394
|
+
- **Accept**: application/json
|
|
3395
|
+
|
|
3396
|
+
|
|
3285
3397
|
## get_sfvb_i18n_glossary
|
|
3286
3398
|
|
|
3287
3399
|
> <SfvbI18nGlossary> get_sfvb_i18n_glossary(storefront_oid)
|
|
@@ -6204,6 +6316,63 @@ end
|
|
|
6204
6316
|
- **Accept**: application/json
|
|
6205
6317
|
|
|
6206
6318
|
|
|
6319
|
+
## list_sfvb_campaigns
|
|
6320
|
+
|
|
6321
|
+
> <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
|
|
6322
|
+
|
|
6323
|
+
List the storefront's campaigns
|
|
6324
|
+
|
|
6325
|
+
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.
|
|
6326
|
+
|
|
6327
|
+
|
|
6328
|
+
### Examples
|
|
6329
|
+
|
|
6330
|
+
|
|
6331
|
+
(No example for this operation).
|
|
6332
|
+
|
|
6333
|
+
|
|
6334
|
+
#### Using the list_sfvb_campaigns_with_http_info variant
|
|
6335
|
+
|
|
6336
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6337
|
+
|
|
6338
|
+
> <Array(<SfvbCampaignsResponse>, Integer, Hash)> list_sfvb_campaigns_with_http_info(storefront_oid, opts)
|
|
6339
|
+
|
|
6340
|
+
```ruby
|
|
6341
|
+
begin
|
|
6342
|
+
# List the storefront's campaigns
|
|
6343
|
+
data, status_code, headers = api_instance.list_sfvb_campaigns_with_http_info(storefront_oid, opts)
|
|
6344
|
+
p status_code # => 2xx
|
|
6345
|
+
p headers # => { ... }
|
|
6346
|
+
p data # => <SfvbCampaignsResponse>
|
|
6347
|
+
rescue UltracartClient::ApiError => e
|
|
6348
|
+
puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
|
|
6349
|
+
end
|
|
6350
|
+
```
|
|
6351
|
+
|
|
6352
|
+
### Parameters
|
|
6353
|
+
|
|
6354
|
+
| Name | Type | Description | Notes |
|
|
6355
|
+
| ---- | ---- | ----------- | ----- |
|
|
6356
|
+
| **storefront_oid** | **Integer** | | |
|
|
6357
|
+
| **search** | **String** | Text to search for in the name | [optional] |
|
|
6358
|
+
| **page** | **Integer** | Page number, starting at 1 | [optional] |
|
|
6359
|
+
| **page_size** | **Integer** | Campaigns per page, 1 to 100, default 50 | [optional] |
|
|
6360
|
+
| **include_deleted** | **Boolean** | Include deleted campaigns | [optional] |
|
|
6361
|
+
|
|
6362
|
+
### Return type
|
|
6363
|
+
|
|
6364
|
+
[**SfvbCampaignsResponse**](SfvbCampaignsResponse.md)
|
|
6365
|
+
|
|
6366
|
+
### Authorization
|
|
6367
|
+
|
|
6368
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6369
|
+
|
|
6370
|
+
### HTTP request headers
|
|
6371
|
+
|
|
6372
|
+
- **Content-Type**: Not defined
|
|
6373
|
+
- **Accept**: application/json
|
|
6374
|
+
|
|
6375
|
+
|
|
6207
6376
|
## list_sfvb_container_versions
|
|
6208
6377
|
|
|
6209
6378
|
> <SfvbContainerVersionsResponse> list_sfvb_container_versions(storefront_oid, opts)
|
|
@@ -6478,6 +6647,63 @@ end
|
|
|
6478
6647
|
- **Accept**: application/json
|
|
6479
6648
|
|
|
6480
6649
|
|
|
6650
|
+
## list_sfvb_flows
|
|
6651
|
+
|
|
6652
|
+
> <SfvbFlowsResponse> list_sfvb_flows(storefront_oid, opts)
|
|
6653
|
+
|
|
6654
|
+
List the storefront's flows
|
|
6655
|
+
|
|
6656
|
+
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.
|
|
6657
|
+
|
|
6658
|
+
|
|
6659
|
+
### Examples
|
|
6660
|
+
|
|
6661
|
+
|
|
6662
|
+
(No example for this operation).
|
|
6663
|
+
|
|
6664
|
+
|
|
6665
|
+
#### Using the list_sfvb_flows_with_http_info variant
|
|
6666
|
+
|
|
6667
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6668
|
+
|
|
6669
|
+
> <Array(<SfvbFlowsResponse>, Integer, Hash)> list_sfvb_flows_with_http_info(storefront_oid, opts)
|
|
6670
|
+
|
|
6671
|
+
```ruby
|
|
6672
|
+
begin
|
|
6673
|
+
# List the storefront's flows
|
|
6674
|
+
data, status_code, headers = api_instance.list_sfvb_flows_with_http_info(storefront_oid, opts)
|
|
6675
|
+
p status_code # => 2xx
|
|
6676
|
+
p headers # => { ... }
|
|
6677
|
+
p data # => <SfvbFlowsResponse>
|
|
6678
|
+
rescue UltracartClient::ApiError => e
|
|
6679
|
+
puts "Error when calling SfvbApi->list_sfvb_flows_with_http_info: #{e}"
|
|
6680
|
+
end
|
|
6681
|
+
```
|
|
6682
|
+
|
|
6683
|
+
### Parameters
|
|
6684
|
+
|
|
6685
|
+
| Name | Type | Description | Notes |
|
|
6686
|
+
| ---- | ---- | ----------- | ----- |
|
|
6687
|
+
| **storefront_oid** | **Integer** | | |
|
|
6688
|
+
| **search** | **String** | Text to search for in the name | [optional] |
|
|
6689
|
+
| **page** | **Integer** | Page number, starting at 1 | [optional] |
|
|
6690
|
+
| **page_size** | **Integer** | Flows per page, 1 to 100, default 50 | [optional] |
|
|
6691
|
+
| **include_deleted** | **Boolean** | Include deleted flows | [optional] |
|
|
6692
|
+
|
|
6693
|
+
### Return type
|
|
6694
|
+
|
|
6695
|
+
[**SfvbFlowsResponse**](SfvbFlowsResponse.md)
|
|
6696
|
+
|
|
6697
|
+
### Authorization
|
|
6698
|
+
|
|
6699
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6700
|
+
|
|
6701
|
+
### HTTP request headers
|
|
6702
|
+
|
|
6703
|
+
- **Content-Type**: Not defined
|
|
6704
|
+
- **Accept**: application/json
|
|
6705
|
+
|
|
6706
|
+
|
|
6481
6707
|
## list_sfvb_i18n_messages
|
|
6482
6708
|
|
|
6483
6709
|
> <SfvbI18nMessagesResponse> list_sfvb_i18n_messages(storefront_oid, 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
|
+
|
data/docs/SfvbFlow.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# UltracartClient::SfvbFlow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **communication_sequence_uuid** | **String** | The communication sequence the steps belong to. | [optional] |
|
|
8
|
+
| **created_dts** | **String** | When the flow was created (ISO 8601, UTC). | [optional] |
|
|
9
|
+
| **deleted** | **Boolean** | True when the flow was deleted. | [optional] |
|
|
10
|
+
| **emails** | [**Array<SfvbCommsEmail>**](SfvbCommsEmail.md) | Its emails, in step order. | [optional] |
|
|
11
|
+
| **flow_uuid** | **String** | The flow uuid. | [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 flow name. | [optional] |
|
|
14
|
+
| **postcards** | [**Array<SfvbCommsPostcard>**](SfvbCommsPostcard.md) | Its postcards, in step order. | [optional] |
|
|
15
|
+
| **status** | **String** | The status, such as draft, active, paused, draining or inactive. | [optional] |
|
|
16
|
+
| **status_dts** | **String** | When the status last changed (ISO 8601, UTC). | [optional] |
|
|
17
|
+
| **trigger_parameter_name** | **String** | The name of the trigger parameter, when the trigger takes one. | [optional] |
|
|
18
|
+
| **trigger_type** | **String** | What starts the flow, such as cart abandon or an order. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'ultracart_api'
|
|
24
|
+
|
|
25
|
+
instance = UltracartClient::SfvbFlow.new(
|
|
26
|
+
communication_sequence_uuid: null,
|
|
27
|
+
created_dts: null,
|
|
28
|
+
deleted: null,
|
|
29
|
+
emails: null,
|
|
30
|
+
flow_uuid: null,
|
|
31
|
+
live: null,
|
|
32
|
+
name: null,
|
|
33
|
+
postcards: null,
|
|
34
|
+
status: null,
|
|
35
|
+
status_dts: null,
|
|
36
|
+
trigger_parameter_name: null,
|
|
37
|
+
trigger_type: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbFlowsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **flows** | [**Array<SfvbFlow>**](SfvbFlow.md) | The flows 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::SfvbFlowsResponse.new(
|
|
18
|
+
flows: null,
|
|
19
|
+
page: null,
|
|
20
|
+
page_size: null,
|
|
21
|
+
total: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **body_file_name** | **String** | The body container a draft replaces, such as receipt_body.cjson. | [optional] |
|
|
7
|
+
| **body_file_name** | **String** | The body container a draft replaces, such as receipt_body.cjson. Present only when the theme has the file. | [optional] |
|
|
8
|
+
| **body_path** | **String** | The full theme file path of the body container, such as /themes/Elements/core/emails/receipt_body.cjson. Read it with the files endpoint. Present only when the theme has the file. | [optional] |
|
|
8
9
|
| **file_name** | **String** | The HTML template file, such as receipt_html.vm. | [optional] |
|
|
9
10
|
| **name** | **String** | The display name, such as Order - Receipt. | [optional] |
|
|
10
11
|
| **text_file_name** | **String** | The plain text template file, when the email has one. | [optional] |
|
|
@@ -16,6 +17,7 @@ require 'ultracart_api'
|
|
|
16
17
|
|
|
17
18
|
instance = UltracartClient::SfvbTransactionalEmail.new(
|
|
18
19
|
body_file_name: null,
|
|
20
|
+
body_path: null,
|
|
19
21
|
file_name: null,
|
|
20
22
|
name: null,
|
|
21
23
|
text_file_name: null
|