ultracart_api 4.1.256 → 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 +10 -2
- data/docs/SfvbApi.md +110 -0
- 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 +145 -0
- 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
|
|
@@ -651,6 +652,7 @@ Class | Method | HTTP request | Description
|
|
|
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,7 @@ 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 |
|
|
2604
2612
|
| 4.1.256 | 11/17/2026 | sfvb internal testing |
|
|
2605
2613
|
| 4.1.255 | 11/17/2026 | sfvb internal testing |
|
|
2606
2614
|
| 4.1.254 | 11/15/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 |
|
|
@@ -179,6 +180,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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)
|
|
@@ -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
|
+
|
|
@@ -5217,6 +5217,76 @@ module UltracartClient
|
|
|
5217
5217
|
return data, status_code, headers
|
|
5218
5218
|
end
|
|
5219
5219
|
|
|
5220
|
+
# One code library email item, with its body and file list
|
|
5221
|
+
# 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).
|
|
5222
|
+
# @param storefront_oid [Integer]
|
|
5223
|
+
# @param library_item_oid [Integer]
|
|
5224
|
+
# @param [Hash] opts the optional parameters
|
|
5225
|
+
# @return [SfvbCodeLibraryEmailResponse]
|
|
5226
|
+
def get_sfvb_code_library_email(storefront_oid, library_item_oid, opts = {})
|
|
5227
|
+
data, _status_code, _headers = get_sfvb_code_library_email_with_http_info(storefront_oid, library_item_oid, opts)
|
|
5228
|
+
data
|
|
5229
|
+
end
|
|
5230
|
+
|
|
5231
|
+
# One code library email item, with its body and file list
|
|
5232
|
+
# 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).
|
|
5233
|
+
# @param storefront_oid [Integer]
|
|
5234
|
+
# @param library_item_oid [Integer]
|
|
5235
|
+
# @param [Hash] opts the optional parameters
|
|
5236
|
+
# @return [Array<(SfvbCodeLibraryEmailResponse, Integer, Hash)>] SfvbCodeLibraryEmailResponse data, response status code and response headers
|
|
5237
|
+
def get_sfvb_code_library_email_with_http_info(storefront_oid, library_item_oid, opts = {})
|
|
5238
|
+
if @api_client.config.debugging
|
|
5239
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_code_library_email ...'
|
|
5240
|
+
end
|
|
5241
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5242
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5243
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_code_library_email"
|
|
5244
|
+
end
|
|
5245
|
+
# verify the required parameter 'library_item_oid' is set
|
|
5246
|
+
if @api_client.config.client_side_validation && library_item_oid.nil?
|
|
5247
|
+
fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling SfvbApi.get_sfvb_code_library_email"
|
|
5248
|
+
end
|
|
5249
|
+
# resource path
|
|
5250
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/code_library/emails/{library_item_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))
|
|
5251
|
+
|
|
5252
|
+
# query parameters
|
|
5253
|
+
query_params = opts[:query_params] || {}
|
|
5254
|
+
|
|
5255
|
+
# header parameters
|
|
5256
|
+
header_params = opts[:header_params] || {}
|
|
5257
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5258
|
+
# HTTP header 'Accept' (if needed)
|
|
5259
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5260
|
+
|
|
5261
|
+
# form parameters
|
|
5262
|
+
form_params = opts[:form_params] || {}
|
|
5263
|
+
|
|
5264
|
+
# http body (model)
|
|
5265
|
+
post_body = opts[:debug_body]
|
|
5266
|
+
|
|
5267
|
+
# return_type
|
|
5268
|
+
return_type = opts[:debug_return_type] || 'SfvbCodeLibraryEmailResponse'
|
|
5269
|
+
|
|
5270
|
+
# auth_names
|
|
5271
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5272
|
+
|
|
5273
|
+
new_options = opts.merge(
|
|
5274
|
+
:operation => :"SfvbApi.get_sfvb_code_library_email",
|
|
5275
|
+
:header_params => header_params,
|
|
5276
|
+
:query_params => query_params,
|
|
5277
|
+
:form_params => form_params,
|
|
5278
|
+
:body => post_body,
|
|
5279
|
+
:auth_names => auth_names,
|
|
5280
|
+
:return_type => return_type
|
|
5281
|
+
)
|
|
5282
|
+
|
|
5283
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5284
|
+
if @api_client.config.debugging
|
|
5285
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_code_library_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5286
|
+
end
|
|
5287
|
+
return data, status_code, headers
|
|
5288
|
+
end
|
|
5289
|
+
|
|
5220
5290
|
# Read one campaign folder
|
|
5221
5291
|
# The folder, with the name and uuid of each campaign filed in it.
|
|
5222
5292
|
# @param storefront_oid [Integer]
|
|
@@ -12502,6 +12572,81 @@ module UltracartClient
|
|
|
12502
12572
|
return data, status_code, headers
|
|
12503
12573
|
end
|
|
12504
12574
|
|
|
12575
|
+
# Save a reusable email to this account's code library
|
|
12576
|
+
# 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.
|
|
12577
|
+
# @param storefront_oid [Integer]
|
|
12578
|
+
# @param code_library_email_create_request [SfvbCodeLibraryEmailCreateRequest] The email to save, with the uuid that makes a retry safe
|
|
12579
|
+
# @param [Hash] opts the optional parameters
|
|
12580
|
+
# @return [SfvbCodeLibraryEmailResponse]
|
|
12581
|
+
def insert_sfvb_code_library_email(storefront_oid, code_library_email_create_request, opts = {})
|
|
12582
|
+
data, _status_code, _headers = insert_sfvb_code_library_email_with_http_info(storefront_oid, code_library_email_create_request, opts)
|
|
12583
|
+
data
|
|
12584
|
+
end
|
|
12585
|
+
|
|
12586
|
+
# Save a reusable email to this account's code library
|
|
12587
|
+
# 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.
|
|
12588
|
+
# @param storefront_oid [Integer]
|
|
12589
|
+
# @param code_library_email_create_request [SfvbCodeLibraryEmailCreateRequest] The email to save, with the uuid that makes a retry safe
|
|
12590
|
+
# @param [Hash] opts the optional parameters
|
|
12591
|
+
# @return [Array<(SfvbCodeLibraryEmailResponse, Integer, Hash)>] SfvbCodeLibraryEmailResponse data, response status code and response headers
|
|
12592
|
+
def insert_sfvb_code_library_email_with_http_info(storefront_oid, code_library_email_create_request, opts = {})
|
|
12593
|
+
if @api_client.config.debugging
|
|
12594
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_code_library_email ...'
|
|
12595
|
+
end
|
|
12596
|
+
# verify the required parameter 'storefront_oid' is set
|
|
12597
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
12598
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_code_library_email"
|
|
12599
|
+
end
|
|
12600
|
+
# verify the required parameter 'code_library_email_create_request' is set
|
|
12601
|
+
if @api_client.config.client_side_validation && code_library_email_create_request.nil?
|
|
12602
|
+
fail ArgumentError, "Missing the required parameter 'code_library_email_create_request' when calling SfvbApi.insert_sfvb_code_library_email"
|
|
12603
|
+
end
|
|
12604
|
+
# resource path
|
|
12605
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/code_library/emails'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
12606
|
+
|
|
12607
|
+
# query parameters
|
|
12608
|
+
query_params = opts[:query_params] || {}
|
|
12609
|
+
|
|
12610
|
+
# header parameters
|
|
12611
|
+
header_params = opts[:header_params] || {}
|
|
12612
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
12613
|
+
# HTTP header 'Accept' (if needed)
|
|
12614
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
12615
|
+
# HTTP header 'Content-Type'
|
|
12616
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
12617
|
+
if !content_type.nil?
|
|
12618
|
+
header_params['Content-Type'] = content_type
|
|
12619
|
+
end
|
|
12620
|
+
|
|
12621
|
+
# form parameters
|
|
12622
|
+
form_params = opts[:form_params] || {}
|
|
12623
|
+
|
|
12624
|
+
# http body (model)
|
|
12625
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(code_library_email_create_request)
|
|
12626
|
+
|
|
12627
|
+
# return_type
|
|
12628
|
+
return_type = opts[:debug_return_type] || 'SfvbCodeLibraryEmailResponse'
|
|
12629
|
+
|
|
12630
|
+
# auth_names
|
|
12631
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
12632
|
+
|
|
12633
|
+
new_options = opts.merge(
|
|
12634
|
+
:operation => :"SfvbApi.insert_sfvb_code_library_email",
|
|
12635
|
+
:header_params => header_params,
|
|
12636
|
+
:query_params => query_params,
|
|
12637
|
+
:form_params => form_params,
|
|
12638
|
+
:body => post_body,
|
|
12639
|
+
:auth_names => auth_names,
|
|
12640
|
+
:return_type => return_type
|
|
12641
|
+
)
|
|
12642
|
+
|
|
12643
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
12644
|
+
if @api_client.config.debugging
|
|
12645
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_code_library_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
12646
|
+
end
|
|
12647
|
+
return data, status_code, headers
|
|
12648
|
+
end
|
|
12649
|
+
|
|
12505
12650
|
# Create a campaign folder
|
|
12506
12651
|
# A new, empty folder. File a campaign in it by setting its folder_uuid.
|
|
12507
12652
|
# @param storefront_oid [Integer]
|