ultracart_api 4.1.255 → 4.1.257
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 +12 -3
- data/docs/SfvbApi.md +162 -52
- data/docs/SfvbCodeLibraryEmailCreateRequest.md +28 -0
- data/docs/SfvbCodeLibraryEmailDetail.md +32 -0
- data/docs/SfvbCodeLibraryEmailResponse.md +24 -0
- data/docs/SfvbCodeLibraryFile.md +22 -0
- data/docs/SfvbCodeLibraryFileSkipped.md +20 -0
- data/lib/ultracart_api/api/sfvb_api.rb +203 -58
- data/lib/ultracart_api/models/sfvb_code_library_email_create_request.rb +270 -0
- data/lib/ultracart_api/models/sfvb_code_library_email_detail.rb +292 -0
- data/lib/ultracart_api/models/sfvb_code_library_email_response.rb +253 -0
- data/lib/ultracart_api/models/sfvb_code_library_file.rb +240 -0
- data/lib/ultracart_api/models/sfvb_code_library_file_skipped.rb +230 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 76f8a404e7ab84f499b23cff0890bc36193494369b681fef89b7b866e6ddb8a1
|
|
4
|
+
data.tar.gz: 064b1829072beffa80e8d529470c6cb3a8454d2eb56e840b616fc9afde3b0461
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f07667aeeab0c57f4fd36594a5270ffc16e478f8338bc6fa9ba4be83237e9df031832c5d668cc4d2d6ef05e36a46ea21052fd26c054ba62f743c4b1921308bd8
|
|
7
|
+
data.tar.gz: 0e404db6c37280103af87a0b584db7ee07c9e0252951d56471d8ed069940db8eef60ce781689bd7e93f97af54c03ce3a404914f24a6e0c1769506dc8897ecd87
|
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.257
|
|
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.257'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -546,6 +546,7 @@ Class | Method | HTTP request | Description
|
|
|
546
546
|
*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
|
|
547
547
|
*UltracartClient::SfvbApi* | [**get_sfvb_campaign**](docs/SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign
|
|
548
548
|
*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
|
|
549
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_code_library_email**](docs/SfvbApi.md#get_sfvb_code_library_email) | **GET** /sfvb/storefronts/{storefront_oid}/code_library/emails/{library_item_oid} | One code library email item, with its body and file list
|
|
549
550
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_campaign_folder**](docs/SfvbApi.md#get_sfvb_comms_campaign_folder) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Read one campaign folder
|
|
550
551
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_campaign_folders**](docs/SfvbApi.md#get_sfvb_comms_campaign_folders) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders | List the campaign folders
|
|
551
552
|
*UltracartClient::SfvbApi* | [**get_sfvb_comms_dashboard_stats**](docs/SfvbApi.md#get_sfvb_comms_dashboard_stats) | **GET** /sfvb/storefronts/{storefront_oid}/comms/stats/dashboard | Read every flow's and campaign's counts over a window, with the account's daily sending
|
|
@@ -622,6 +623,7 @@ Class | Method | HTTP request | Description
|
|
|
622
623
|
*UltracartClient::SfvbApi* | [**get_sfvb_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
|
|
623
624
|
*UltracartClient::SfvbApi* | [**get_sfvb_sequence_step_dispatch_logs**](docs/SfvbApi.md#get_sfvb_sequence_step_dispatch_logs) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs | Read a flow or campaign step's dispatch log and counts
|
|
624
625
|
*UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
|
|
626
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_session**](docs/SfvbApi.md#get_sfvb_session) | **GET** /sfvb/session | Who this token is
|
|
625
627
|
*UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
|
|
626
628
|
*UltracartClient::SfvbApi* | [**get_sfvb_site_seo**](docs/SfvbApi.md#get_sfvb_site_seo) | **GET** /sfvb/storefronts/{storefront_oid}/seo | Read a storefront's search engine settings
|
|
627
629
|
*UltracartClient::SfvbApi* | [**get_sfvb_sitemaps**](docs/SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt
|
|
@@ -644,13 +646,13 @@ Class | Method | HTTP request | Description
|
|
|
644
646
|
*UltracartClient::SfvbApi* | [**get_sfvb_utm_shortcode**](docs/SfvbApi.md#get_sfvb_utm_shortcode) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Read one UTM shortcode
|
|
645
647
|
*UltracartClient::SfvbApi* | [**get_sfvb_utm_shortcodes**](docs/SfvbApi.md#get_sfvb_utm_shortcodes) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | List a storefront's UTM shortcodes
|
|
646
648
|
*UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
|
|
647
|
-
*UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
|
|
648
649
|
*UltracartClient::SfvbApi* | [**ignore_sfvb_not_found_entry**](docs/SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path
|
|
649
650
|
*UltracartClient::SfvbApi* | [**import_sfvb_comms_provider_lists**](docs/SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider
|
|
650
651
|
*UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
|
|
651
652
|
*UltracartClient::SfvbApi* | [**insert_sfvb_affiliate_network**](docs/SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network
|
|
652
653
|
*UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
|
|
653
654
|
*UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
|
|
655
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_code_library_email**](docs/SfvbApi.md#insert_sfvb_code_library_email) | **POST** /sfvb/storefronts/{storefront_oid}/code_library/emails | Save a reusable email to this account's code library
|
|
654
656
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_campaign_folder**](docs/SfvbApi.md#insert_sfvb_comms_campaign_folder) | **POST** /sfvb/storefronts/{storefront_oid}/campaign_folders | Create a campaign folder
|
|
655
657
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_flow_folder**](docs/SfvbApi.md#insert_sfvb_comms_flow_folder) | **POST** /sfvb/storefronts/{storefront_oid}/flow_folders | Create a flow folder
|
|
656
658
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_folder**](docs/SfvbApi.md#insert_sfvb_comms_folder) | **POST** /sfvb/storefronts/{storefront_oid}/list_segment_folders | Create a list and segment folder
|
|
@@ -2036,7 +2038,12 @@ Class | Method | HTTP request | Description
|
|
|
2036
2038
|
- [UltracartClient::SfvbCliLocation](docs/SfvbCliLocation.md)
|
|
2037
2039
|
- [UltracartClient::SfvbCliVersion](docs/SfvbCliVersion.md)
|
|
2038
2040
|
- [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
|
|
2041
|
+
- [UltracartClient::SfvbCodeLibraryEmailCreateRequest](docs/SfvbCodeLibraryEmailCreateRequest.md)
|
|
2042
|
+
- [UltracartClient::SfvbCodeLibraryEmailDetail](docs/SfvbCodeLibraryEmailDetail.md)
|
|
2043
|
+
- [UltracartClient::SfvbCodeLibraryEmailResponse](docs/SfvbCodeLibraryEmailResponse.md)
|
|
2039
2044
|
- [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
|
|
2045
|
+
- [UltracartClient::SfvbCodeLibraryFile](docs/SfvbCodeLibraryFile.md)
|
|
2046
|
+
- [UltracartClient::SfvbCodeLibraryFileSkipped](docs/SfvbCodeLibraryFileSkipped.md)
|
|
2040
2047
|
- [UltracartClient::SfvbCommsBranchStat](docs/SfvbCommsBranchStat.md)
|
|
2041
2048
|
- [UltracartClient::SfvbCommsChange](docs/SfvbCommsChange.md)
|
|
2042
2049
|
- [UltracartClient::SfvbCommsClick](docs/SfvbCommsClick.md)
|
|
@@ -2601,6 +2608,8 @@ Not every change is committed to every SDK.
|
|
|
2601
2608
|
|
|
2602
2609
|
| Version | Date | Comments |
|
|
2603
2610
|
| --: | :-: | --- |
|
|
2611
|
+
| 4.1.257 | 11/19/2026 | sfvb internal testing |
|
|
2612
|
+
| 4.1.256 | 11/17/2026 | sfvb internal testing |
|
|
2604
2613
|
| 4.1.255 | 11/17/2026 | sfvb internal testing |
|
|
2605
2614
|
| 4.1.254 | 11/15/2026 | sfvb internal testing |
|
|
2606
2615
|
| 4.1.253 | 11/13/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -74,6 +74,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
74
74
|
| [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
|
|
75
75
|
| [**get_sfvb_campaign**](SfvbApi.md#get_sfvb_campaign) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Get a campaign |
|
|
76
76
|
| [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
|
|
77
|
+
| [**get_sfvb_code_library_email**](SfvbApi.md#get_sfvb_code_library_email) | **GET** /sfvb/storefronts/{storefront_oid}/code_library/emails/{library_item_oid} | One code library email item, with its body and file list |
|
|
77
78
|
| [**get_sfvb_comms_campaign_folder**](SfvbApi.md#get_sfvb_comms_campaign_folder) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid} | Read one campaign folder |
|
|
78
79
|
| [**get_sfvb_comms_campaign_folders**](SfvbApi.md#get_sfvb_comms_campaign_folders) | **GET** /sfvb/storefronts/{storefront_oid}/campaign_folders | List the campaign folders |
|
|
79
80
|
| [**get_sfvb_comms_dashboard_stats**](SfvbApi.md#get_sfvb_comms_dashboard_stats) | **GET** /sfvb/storefronts/{storefront_oid}/comms/stats/dashboard | Read every flow's and campaign's counts over a window, with the account's daily sending |
|
|
@@ -150,6 +151,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
150
151
|
| [**get_sfvb_sequence**](SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree |
|
|
151
152
|
| [**get_sfvb_sequence_step_dispatch_logs**](SfvbApi.md#get_sfvb_sequence_step_dispatch_logs) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs | Read a flow or campaign step's dispatch log and counts |
|
|
152
153
|
| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
|
|
154
|
+
| [**get_sfvb_session**](SfvbApi.md#get_sfvb_session) | **GET** /sfvb/session | Who this token is |
|
|
153
155
|
| [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
|
|
154
156
|
| [**get_sfvb_site_seo**](SfvbApi.md#get_sfvb_site_seo) | **GET** /sfvb/storefronts/{storefront_oid}/seo | Read a storefront's search engine settings |
|
|
155
157
|
| [**get_sfvb_sitemaps**](SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt |
|
|
@@ -172,13 +174,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
172
174
|
| [**get_sfvb_utm_shortcode**](SfvbApi.md#get_sfvb_utm_shortcode) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Read one UTM shortcode |
|
|
173
175
|
| [**get_sfvb_utm_shortcodes**](SfvbApi.md#get_sfvb_utm_shortcodes) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | List a storefront's UTM shortcodes |
|
|
174
176
|
| [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
|
|
175
|
-
| [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
|
|
176
177
|
| [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
|
|
177
178
|
| [**import_sfvb_comms_provider_lists**](SfvbApi.md#import_sfvb_comms_provider_lists) | **POST** /sfvb/storefronts/{storefront_oid}/comms/providers/import | Import lists from another email provider |
|
|
178
179
|
| [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
|
|
179
180
|
| [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
|
|
180
181
|
| [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
|
|
181
182
|
| [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
|
|
183
|
+
| [**insert_sfvb_code_library_email**](SfvbApi.md#insert_sfvb_code_library_email) | **POST** /sfvb/storefronts/{storefront_oid}/code_library/emails | Save a reusable email to this account's code library |
|
|
182
184
|
| [**insert_sfvb_comms_campaign_folder**](SfvbApi.md#insert_sfvb_comms_campaign_folder) | **POST** /sfvb/storefronts/{storefront_oid}/campaign_folders | Create a campaign folder |
|
|
183
185
|
| [**insert_sfvb_comms_flow_folder**](SfvbApi.md#insert_sfvb_comms_flow_folder) | **POST** /sfvb/storefronts/{storefront_oid}/flow_folders | Create a flow folder |
|
|
184
186
|
| [**insert_sfvb_comms_folder**](SfvbApi.md#insert_sfvb_comms_folder) | **POST** /sfvb/storefronts/{storefront_oid}/list_segment_folders | Create a list and segment folder |
|
|
@@ -4131,6 +4133,60 @@ end
|
|
|
4131
4133
|
- **Accept**: application/json
|
|
4132
4134
|
|
|
4133
4135
|
|
|
4136
|
+
## get_sfvb_code_library_email
|
|
4137
|
+
|
|
4138
|
+
> <SfvbCodeLibraryEmailResponse> get_sfvb_code_library_email(storefront_oid, library_item_oid)
|
|
4139
|
+
|
|
4140
|
+
One code library email item, with its body and file list
|
|
4141
|
+
|
|
4142
|
+
Answers for an item this account owns, one shared with it, or one published for everyone, approved by UltraCart and free, the same items listSfvbCodeLibraryEmails lists; anything else is not found. Returns the title, description, subject, preview text, the body as stored and the image files the item carries, without their contents (#2126).
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
### Examples
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
(No example for this operation).
|
|
4149
|
+
|
|
4150
|
+
|
|
4151
|
+
#### Using the get_sfvb_code_library_email_with_http_info variant
|
|
4152
|
+
|
|
4153
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4154
|
+
|
|
4155
|
+
> <Array(<SfvbCodeLibraryEmailResponse>, Integer, Hash)> get_sfvb_code_library_email_with_http_info(storefront_oid, library_item_oid)
|
|
4156
|
+
|
|
4157
|
+
```ruby
|
|
4158
|
+
begin
|
|
4159
|
+
# One code library email item, with its body and file list
|
|
4160
|
+
data, status_code, headers = api_instance.get_sfvb_code_library_email_with_http_info(storefront_oid, library_item_oid)
|
|
4161
|
+
p status_code # => 2xx
|
|
4162
|
+
p headers # => { ... }
|
|
4163
|
+
p data # => <SfvbCodeLibraryEmailResponse>
|
|
4164
|
+
rescue UltracartClient::ApiError => e
|
|
4165
|
+
puts "Error when calling SfvbApi->get_sfvb_code_library_email_with_http_info: #{e}"
|
|
4166
|
+
end
|
|
4167
|
+
```
|
|
4168
|
+
|
|
4169
|
+
### Parameters
|
|
4170
|
+
|
|
4171
|
+
| Name | Type | Description | Notes |
|
|
4172
|
+
| ---- | ---- | ----------- | ----- |
|
|
4173
|
+
| **storefront_oid** | **Integer** | | |
|
|
4174
|
+
| **library_item_oid** | **Integer** | | |
|
|
4175
|
+
|
|
4176
|
+
### Return type
|
|
4177
|
+
|
|
4178
|
+
[**SfvbCodeLibraryEmailResponse**](SfvbCodeLibraryEmailResponse.md)
|
|
4179
|
+
|
|
4180
|
+
### Authorization
|
|
4181
|
+
|
|
4182
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4183
|
+
|
|
4184
|
+
### HTTP request headers
|
|
4185
|
+
|
|
4186
|
+
- **Content-Type**: Not defined
|
|
4187
|
+
- **Accept**: application/json
|
|
4188
|
+
|
|
4189
|
+
|
|
4134
4190
|
## get_sfvb_comms_campaign_folder
|
|
4135
4191
|
|
|
4136
4192
|
> <SfvbCommsSequenceFolderResponse> get_sfvb_comms_campaign_folder(storefront_oid, folder_uuid)
|
|
@@ -8250,6 +8306,57 @@ end
|
|
|
8250
8306
|
- **Accept**: application/json
|
|
8251
8307
|
|
|
8252
8308
|
|
|
8309
|
+
## get_sfvb_session
|
|
8310
|
+
|
|
8311
|
+
> <SfvbWhoamiResponse> get_sfvb_session
|
|
8312
|
+
|
|
8313
|
+
Who this token is
|
|
8314
|
+
|
|
8315
|
+
Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
|
|
8316
|
+
|
|
8317
|
+
|
|
8318
|
+
### Examples
|
|
8319
|
+
|
|
8320
|
+
|
|
8321
|
+
(No example for this operation).
|
|
8322
|
+
|
|
8323
|
+
|
|
8324
|
+
#### Using the get_sfvb_session_with_http_info variant
|
|
8325
|
+
|
|
8326
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8327
|
+
|
|
8328
|
+
> <Array(<SfvbWhoamiResponse>, Integer, Hash)> get_sfvb_session_with_http_info
|
|
8329
|
+
|
|
8330
|
+
```ruby
|
|
8331
|
+
begin
|
|
8332
|
+
# Who this token is
|
|
8333
|
+
data, status_code, headers = api_instance.get_sfvb_session_with_http_info
|
|
8334
|
+
p status_code # => 2xx
|
|
8335
|
+
p headers # => { ... }
|
|
8336
|
+
p data # => <SfvbWhoamiResponse>
|
|
8337
|
+
rescue UltracartClient::ApiError => e
|
|
8338
|
+
puts "Error when calling SfvbApi->get_sfvb_session_with_http_info: #{e}"
|
|
8339
|
+
end
|
|
8340
|
+
```
|
|
8341
|
+
|
|
8342
|
+
### Parameters
|
|
8343
|
+
|
|
8344
|
+
This endpoint does not need any parameter.
|
|
8345
|
+
|
|
8346
|
+
### Return type
|
|
8347
|
+
|
|
8348
|
+
[**SfvbWhoamiResponse**](SfvbWhoamiResponse.md)
|
|
8349
|
+
|
|
8350
|
+
### Authorization
|
|
8351
|
+
|
|
8352
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8353
|
+
|
|
8354
|
+
### HTTP request headers
|
|
8355
|
+
|
|
8356
|
+
- **Content-Type**: Not defined
|
|
8357
|
+
- **Accept**: application/json
|
|
8358
|
+
|
|
8359
|
+
|
|
8253
8360
|
## get_sfvb_site_attributes
|
|
8254
8361
|
|
|
8255
8362
|
> <SfvbSiteAttributesResponse> get_sfvb_site_attributes(storefront_oid)
|
|
@@ -9441,57 +9548,6 @@ This endpoint does not need any parameter.
|
|
|
9441
9548
|
- **Accept**: application/json
|
|
9442
9549
|
|
|
9443
9550
|
|
|
9444
|
-
## get_sfvb_whoami
|
|
9445
|
-
|
|
9446
|
-
> <SfvbWhoamiResponse> get_sfvb_whoami
|
|
9447
|
-
|
|
9448
|
-
Who this token is
|
|
9449
|
-
|
|
9450
|
-
Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
|
|
9451
|
-
|
|
9452
|
-
|
|
9453
|
-
### Examples
|
|
9454
|
-
|
|
9455
|
-
|
|
9456
|
-
(No example for this operation).
|
|
9457
|
-
|
|
9458
|
-
|
|
9459
|
-
#### Using the get_sfvb_whoami_with_http_info variant
|
|
9460
|
-
|
|
9461
|
-
This returns an Array which contains the response data, status code and headers.
|
|
9462
|
-
|
|
9463
|
-
> <Array(<SfvbWhoamiResponse>, Integer, Hash)> get_sfvb_whoami_with_http_info
|
|
9464
|
-
|
|
9465
|
-
```ruby
|
|
9466
|
-
begin
|
|
9467
|
-
# Who this token is
|
|
9468
|
-
data, status_code, headers = api_instance.get_sfvb_whoami_with_http_info
|
|
9469
|
-
p status_code # => 2xx
|
|
9470
|
-
p headers # => { ... }
|
|
9471
|
-
p data # => <SfvbWhoamiResponse>
|
|
9472
|
-
rescue UltracartClient::ApiError => e
|
|
9473
|
-
puts "Error when calling SfvbApi->get_sfvb_whoami_with_http_info: #{e}"
|
|
9474
|
-
end
|
|
9475
|
-
```
|
|
9476
|
-
|
|
9477
|
-
### Parameters
|
|
9478
|
-
|
|
9479
|
-
This endpoint does not need any parameter.
|
|
9480
|
-
|
|
9481
|
-
### Return type
|
|
9482
|
-
|
|
9483
|
-
[**SfvbWhoamiResponse**](SfvbWhoamiResponse.md)
|
|
9484
|
-
|
|
9485
|
-
### Authorization
|
|
9486
|
-
|
|
9487
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9488
|
-
|
|
9489
|
-
### HTTP request headers
|
|
9490
|
-
|
|
9491
|
-
- **Content-Type**: Not defined
|
|
9492
|
-
- **Accept**: application/json
|
|
9493
|
-
|
|
9494
|
-
|
|
9495
9551
|
## ignore_sfvb_not_found_entry
|
|
9496
9552
|
|
|
9497
9553
|
> <SfvbNotFoundEntry> ignore_sfvb_not_found_entry(storefront_oid, not_found_id)
|
|
@@ -9818,6 +9874,60 @@ end
|
|
|
9818
9874
|
- **Accept**: application/json
|
|
9819
9875
|
|
|
9820
9876
|
|
|
9877
|
+
## insert_sfvb_code_library_email
|
|
9878
|
+
|
|
9879
|
+
> <SfvbCodeLibraryEmailResponse> insert_sfvb_code_library_email(storefront_oid, code_library_email_create_request)
|
|
9880
|
+
|
|
9881
|
+
Save a reusable email to this account's code library
|
|
9882
|
+
|
|
9883
|
+
Saves a whole email (body, subject and preview text) as a code library email item that the admin's \"start from library\" picker and the step insert's library_item_oid can start a new email from (#2126). No flow, campaign, sequence or step is made, and nothing sends. The item is private to this account, never published or shared. The body must pass the library content scanner and the email container rules. Image files the body names by a path starting with / are carried with the item when they are PNG, JPEG or GIF and their contents are that image, up to 25 files, 5 MB each and 20 MB in all; any other file is listed in files_skipped with the reason. Make a new uuid for each save. Sending the same uuid again returns the item it saved, unchanged, with created false, so a retry after an uncertain response is safe. Titles may repeat.
|
|
9884
|
+
|
|
9885
|
+
|
|
9886
|
+
### Examples
|
|
9887
|
+
|
|
9888
|
+
|
|
9889
|
+
(No example for this operation).
|
|
9890
|
+
|
|
9891
|
+
|
|
9892
|
+
#### Using the insert_sfvb_code_library_email_with_http_info variant
|
|
9893
|
+
|
|
9894
|
+
This returns an Array which contains the response data, status code and headers.
|
|
9895
|
+
|
|
9896
|
+
> <Array(<SfvbCodeLibraryEmailResponse>, Integer, Hash)> insert_sfvb_code_library_email_with_http_info(storefront_oid, code_library_email_create_request)
|
|
9897
|
+
|
|
9898
|
+
```ruby
|
|
9899
|
+
begin
|
|
9900
|
+
# Save a reusable email to this account's code library
|
|
9901
|
+
data, status_code, headers = api_instance.insert_sfvb_code_library_email_with_http_info(storefront_oid, code_library_email_create_request)
|
|
9902
|
+
p status_code # => 2xx
|
|
9903
|
+
p headers # => { ... }
|
|
9904
|
+
p data # => <SfvbCodeLibraryEmailResponse>
|
|
9905
|
+
rescue UltracartClient::ApiError => e
|
|
9906
|
+
puts "Error when calling SfvbApi->insert_sfvb_code_library_email_with_http_info: #{e}"
|
|
9907
|
+
end
|
|
9908
|
+
```
|
|
9909
|
+
|
|
9910
|
+
### Parameters
|
|
9911
|
+
|
|
9912
|
+
| Name | Type | Description | Notes |
|
|
9913
|
+
| ---- | ---- | ----------- | ----- |
|
|
9914
|
+
| **storefront_oid** | **Integer** | | |
|
|
9915
|
+
| **code_library_email_create_request** | [**SfvbCodeLibraryEmailCreateRequest**](SfvbCodeLibraryEmailCreateRequest.md) | The email to save, with the uuid that makes a retry safe | |
|
|
9916
|
+
|
|
9917
|
+
### Return type
|
|
9918
|
+
|
|
9919
|
+
[**SfvbCodeLibraryEmailResponse**](SfvbCodeLibraryEmailResponse.md)
|
|
9920
|
+
|
|
9921
|
+
### Authorization
|
|
9922
|
+
|
|
9923
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
9924
|
+
|
|
9925
|
+
### HTTP request headers
|
|
9926
|
+
|
|
9927
|
+
- **Content-Type**: application/json
|
|
9928
|
+
- **Accept**: application/json
|
|
9929
|
+
|
|
9930
|
+
|
|
9821
9931
|
## insert_sfvb_comms_campaign_folder
|
|
9822
9932
|
|
|
9823
9933
|
> <SfvbCommsSequenceFolderResponse> insert_sfvb_comms_campaign_folder(storefront_oid, folder_write_request)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::SfvbCodeLibraryEmailCreateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **container_cjson** | **String** | The email body, a container that passes the email container rules. | [optional] |
|
|
8
|
+
| **description** | **String** | Up to 1000 characters on one line, or empty. | [optional] |
|
|
9
|
+
| **preview_text** | **String** | The preview text a new email started from the item takes, 5 to 150 characters on one line. | [optional] |
|
|
10
|
+
| **subject** | **String** | The subject a new email started from the item takes, 5 to 150 characters on one line. | [optional] |
|
|
11
|
+
| **title** | **String** | The title the new-email picker shows, 4 to 100 characters on one line. | [optional] |
|
|
12
|
+
| **uuid** | **String** | A UUID the caller makes for this save. Sending the same uuid again returns the item it saved, unchanged, so a retry after an uncertain response never makes a second item. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::SfvbCodeLibraryEmailCreateRequest.new(
|
|
20
|
+
container_cjson: null,
|
|
21
|
+
description: null,
|
|
22
|
+
preview_text: null,
|
|
23
|
+
subject: null,
|
|
24
|
+
title: null,
|
|
25
|
+
uuid: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbCodeLibraryEmailDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **container_cjson** | **String** | The item's body as stored. Starting a new email from it gives its elements new ids. | [optional] |
|
|
8
|
+
| **description** | **String** | The item's description. | [optional] |
|
|
9
|
+
| **files** | [**Array<SfvbCodeLibraryFile>**](SfvbCodeLibraryFile.md) | The image files the item carries, without their contents. | [optional] |
|
|
10
|
+
| **library_item_oid** | **Integer** | The item, to send as library_item_oid on the step insert. | [optional] |
|
|
11
|
+
| **preview_text** | **String** | The preview text a new email takes from the item, or null when it has none. | [optional] |
|
|
12
|
+
| **source** | **String** | owned (this account's own), shared (shared with this account) or public (published and approved by UltraCart). | [optional] |
|
|
13
|
+
| **subject** | **String** | The subject a new email takes from the item, or null when it has none. | [optional] |
|
|
14
|
+
| **title** | **String** | The item's title. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbCodeLibraryEmailDetail.new(
|
|
22
|
+
container_cjson: null,
|
|
23
|
+
description: null,
|
|
24
|
+
files: null,
|
|
25
|
+
library_item_oid: null,
|
|
26
|
+
preview_text: null,
|
|
27
|
+
source: null,
|
|
28
|
+
subject: null,
|
|
29
|
+
title: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbCodeLibraryEmailResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **created** | **Boolean** | On a save, true when this request made the item and false when an earlier save with the same uuid had, in which case nothing changed. Absent on a read. | [optional] |
|
|
8
|
+
| **email** | [**SfvbCodeLibraryEmailDetail**](SfvbCodeLibraryEmailDetail.md) | | [optional] |
|
|
9
|
+
| **files_skipped** | [**Array<SfvbCodeLibraryFileSkipped>**](SfvbCodeLibraryFileSkipped.md) | On a save, the files the body names that the item does not carry, each with the reason. Absent on a read. | [optional] |
|
|
10
|
+
| **notes** | **Array<String>** | Plain sentences about the save, for example executable elements or absolute file URLs in the body. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbCodeLibraryEmailResponse.new(
|
|
18
|
+
created: null,
|
|
19
|
+
email: null,
|
|
20
|
+
files_skipped: null,
|
|
21
|
+
notes: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbCodeLibraryFile
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mime_type** | **String** | The file's type. | [optional] |
|
|
8
|
+
| **path** | **String** | The path the body names the file by. Starting a new email from the item writes the file there, never over an existing file. | [optional] |
|
|
9
|
+
| **theme_storage** | **Boolean** | True when the file lives under the storefront's theme, so it is written under the theme of the storefront that uses the item. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbCodeLibraryFile.new(
|
|
17
|
+
mime_type: null,
|
|
18
|
+
path: null,
|
|
19
|
+
theme_storage: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbCodeLibraryFileSkipped
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **path** | **String** | The path the body names the file by. | [optional] |
|
|
8
|
+
| **reason** | **String** | not_found (no such file on the storefront), not_an_image (only PNG, JPEG and GIF files whose contents are that image are carried), too_large (over 5 MB), over_limit (past 25 files or 20 MB in all) or unreadable. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbCodeLibraryFileSkipped.new(
|
|
16
|
+
path: null,
|
|
17
|
+
reason: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|