ultracart_api 4.1.230 → 4.1.231
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 +19 -2
- data/docs/ItemAutoOrder.md +1 -1
- data/docs/SfvbApi.md +287 -0
- data/docs/SfvbApprovalCreateRequest.md +3 -1
- data/docs/SfvbCampaign.md +2 -0
- data/docs/SfvbCommsMember.md +22 -0
- data/docs/SfvbCommsMembersResponse.md +36 -0
- data/docs/SfvbFlow.md +2 -0
- data/docs/SfvbPostcardAddress.md +28 -0
- data/docs/SfvbPostcardCard.md +40 -0
- data/docs/SfvbPostcardTrackingResponse.md +34 -0
- data/docs/SfvbTransactionalChange.md +24 -0
- data/docs/SfvbTransactionalDeliveryOption.md +22 -0
- data/docs/SfvbTransactionalEmailDetail.md +30 -0
- data/docs/SfvbTransactionalEmailResponse.md +24 -0
- data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
- data/docs/SfvbTransactionalSender.md +24 -0
- data/lib/ultracart_api/api/sfvb_api.rb +398 -0
- data/lib/ultracart_api/models/item_auto_order.rb +1 -1
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +15 -6
- data/lib/ultracart_api/models/sfvb_campaign.rb +11 -1
- data/lib/ultracart_api/models/sfvb_comms_member.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
- data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
- data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
- data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
- data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
- data/lib/ultracart_api/models/sfvb_transactional_change.rb +250 -0
- data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
- data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +11 -0
- metadata +23 -1
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# UltracartClient::SfvbPostcardTrackingResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cards** | [**Array<SfvbPostcardCard>**](SfvbPostcardCard.md) | This page of cards. | [optional] |
|
|
8
|
+
| **customer_data** | **String** | masked, or shown when show_customer_data was sent. | [optional] |
|
|
9
|
+
| **notes** | **Array<String>** | What to keep in mind, such as how to handle customer data that is shown. | [optional] |
|
|
10
|
+
| **page** | **Integer** | The page number, from 1. | [optional] |
|
|
11
|
+
| **page_cost** | **Float** | The total cost of the cards on this page. | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | Cards per page. | [optional] |
|
|
13
|
+
| **postcard_uuid** | **String** | The postcard. | [optional] |
|
|
14
|
+
| **total_cards** | **Integer** | How many cards have been mailed for this postcard. | [optional] |
|
|
15
|
+
| **total_pages** | **Integer** | How many pages there are. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'ultracart_api'
|
|
21
|
+
|
|
22
|
+
instance = UltracartClient::SfvbPostcardTrackingResponse.new(
|
|
23
|
+
cards: null,
|
|
24
|
+
customer_data: null,
|
|
25
|
+
notes: null,
|
|
26
|
+
page: null,
|
|
27
|
+
page_cost: null,
|
|
28
|
+
page_size: null,
|
|
29
|
+
postcard_uuid: null,
|
|
30
|
+
total_cards: null,
|
|
31
|
+
total_pages: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbTransactionalChange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | subject, option, sending_domain_uuid, sending_user or sending_name. | [optional] |
|
|
8
|
+
| **from** | **String** | The value before. | [optional] |
|
|
9
|
+
| **name** | **String** | For an option, its name. | [optional] |
|
|
10
|
+
| **to** | **String** | The value after. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbTransactionalChange.new(
|
|
18
|
+
field: null,
|
|
19
|
+
from: null,
|
|
20
|
+
name: null,
|
|
21
|
+
to: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbTransactionalDeliveryOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | What the option does. | [optional] |
|
|
8
|
+
| **name** | **String** | The option's name. An update names options by it. | [optional] |
|
|
9
|
+
| **selected** | **Boolean** | True when the option is on. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbTransactionalDeliveryOption.new(
|
|
17
|
+
description: null,
|
|
18
|
+
name: null,
|
|
19
|
+
selected: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::SfvbTransactionalEmailDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **delivery_options** | [**Array<SfvbTransactionalDeliveryOption>**](SfvbTransactionalDeliveryOption.md) | Its delivery options. Empty for an email that has none. | [optional] |
|
|
8
|
+
| **file_name** | **String** | The HTML template file, such as receipt_html.vm. | [optional] |
|
|
9
|
+
| **hash_sha256** | **String** | The hash of the subject, the options and the sender. Send it as If-Match to change them. | [optional] |
|
|
10
|
+
| **name** | **String** | The display name, such as Order - Receipt. | [optional] |
|
|
11
|
+
| **sender** | [**SfvbTransactionalSender**](SfvbTransactionalSender.md) | | [optional] |
|
|
12
|
+
| **sender_shared_with** | **Array<String>** | Every storefront on this account that shares the sender, this one included. | [optional] |
|
|
13
|
+
| **subject** | **String** | The subject line. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::SfvbTransactionalEmailDetail.new(
|
|
21
|
+
delivery_options: null,
|
|
22
|
+
file_name: null,
|
|
23
|
+
hash_sha256: null,
|
|
24
|
+
name: null,
|
|
25
|
+
sender: null,
|
|
26
|
+
sender_shared_with: null,
|
|
27
|
+
subject: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbTransactionalEmailResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **changes** | [**Array<SfvbTransactionalChange>**](SfvbTransactionalChange.md) | What the update changes, or would change on a dry run. | [optional] |
|
|
8
|
+
| **dry_run** | **Boolean** | True when nothing was written. | [optional] |
|
|
9
|
+
| **email** | [**SfvbTransactionalEmailDetail**](SfvbTransactionalEmailDetail.md) | | [optional] |
|
|
10
|
+
| **notes** | **Array<String>** | What the change means, such as the orders it reaches and the storefronts that share a sender. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbTransactionalEmailResponse.new(
|
|
18
|
+
changes: null,
|
|
19
|
+
dry_run: null,
|
|
20
|
+
email: null,
|
|
21
|
+
notes: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::SfvbTransactionalEmailUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **delivery_options** | [**Array<SfvbTransactionalDeliveryOption>**](SfvbTransactionalDeliveryOption.md) | Options to turn on or off, each by name with selected. | [optional] |
|
|
8
|
+
| **dry_run** | **Boolean** | True to check the change and show it without writing anything or using an approval. | [optional] |
|
|
9
|
+
| **sending_domain_uuid** | **String** | A sending domain on this account. | [optional] |
|
|
10
|
+
| **sending_name** | **String** | The from name. | [optional] |
|
|
11
|
+
| **sending_user** | **String** | The part of the from address before the at sign. | [optional] |
|
|
12
|
+
| **subject** | **String** | The subject line, 1 to 150 characters. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::SfvbTransactionalEmailUpdateRequest.new(
|
|
20
|
+
delivery_options: null,
|
|
21
|
+
dry_run: null,
|
|
22
|
+
sending_domain_uuid: null,
|
|
23
|
+
sending_name: null,
|
|
24
|
+
sending_user: null,
|
|
25
|
+
subject: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbTransactionalSender
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **sending_domain_uuid** | **String** | The sending domain uuid, or none. | [optional] |
|
|
8
|
+
| **sending_name** | **String** | The from name. | [optional] |
|
|
9
|
+
| **sending_user** | **String** | The part of the from address before the at sign. | [optional] |
|
|
10
|
+
| **smtp** | **Boolean** | True when it sends through the merchant's own mail server, which only the admin changes. Its credentials are never returned. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbTransactionalSender.new(
|
|
18
|
+
sending_domain_uuid: null,
|
|
19
|
+
sending_name: null,
|
|
20
|
+
sending_user: null,
|
|
21
|
+
smtp: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -5102,6 +5102,85 @@ module UltracartClient
|
|
|
5102
5102
|
return data, status_code, headers
|
|
5103
5103
|
end
|
|
5104
5104
|
|
|
5105
|
+
# Read one page of a list's members
|
|
5106
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5107
|
+
# @param storefront_oid [Integer]
|
|
5108
|
+
# @param list_uuid [String]
|
|
5109
|
+
# @param [Hash] opts the optional parameters
|
|
5110
|
+
# @option opts [Integer] :page The page, from 1
|
|
5111
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5112
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5113
|
+
# @return [SfvbCommsMembersResponse]
|
|
5114
|
+
def get_sfvb_comms_list_members(storefront_oid, list_uuid, opts = {})
|
|
5115
|
+
data, _status_code, _headers = get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
|
|
5116
|
+
data
|
|
5117
|
+
end
|
|
5118
|
+
|
|
5119
|
+
# Read one page of a list's members
|
|
5120
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5121
|
+
# @param storefront_oid [Integer]
|
|
5122
|
+
# @param list_uuid [String]
|
|
5123
|
+
# @param [Hash] opts the optional parameters
|
|
5124
|
+
# @option opts [Integer] :page The page, from 1
|
|
5125
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5126
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5127
|
+
# @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
|
|
5128
|
+
def get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts = {})
|
|
5129
|
+
if @api_client.config.debugging
|
|
5130
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list_members ...'
|
|
5131
|
+
end
|
|
5132
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5133
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5134
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list_members"
|
|
5135
|
+
end
|
|
5136
|
+
# verify the required parameter 'list_uuid' is set
|
|
5137
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
5138
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list_members"
|
|
5139
|
+
end
|
|
5140
|
+
# resource path
|
|
5141
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
5142
|
+
|
|
5143
|
+
# query parameters
|
|
5144
|
+
query_params = opts[:query_params] || {}
|
|
5145
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
5146
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
5147
|
+
query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
|
|
5148
|
+
|
|
5149
|
+
# header parameters
|
|
5150
|
+
header_params = opts[:header_params] || {}
|
|
5151
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5152
|
+
# HTTP header 'Accept' (if needed)
|
|
5153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5154
|
+
|
|
5155
|
+
# form parameters
|
|
5156
|
+
form_params = opts[:form_params] || {}
|
|
5157
|
+
|
|
5158
|
+
# http body (model)
|
|
5159
|
+
post_body = opts[:debug_body]
|
|
5160
|
+
|
|
5161
|
+
# return_type
|
|
5162
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
|
|
5163
|
+
|
|
5164
|
+
# auth_names
|
|
5165
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5166
|
+
|
|
5167
|
+
new_options = opts.merge(
|
|
5168
|
+
:operation => :"SfvbApi.get_sfvb_comms_list_members",
|
|
5169
|
+
:header_params => header_params,
|
|
5170
|
+
:query_params => query_params,
|
|
5171
|
+
:form_params => form_params,
|
|
5172
|
+
:body => post_body,
|
|
5173
|
+
:auth_names => auth_names,
|
|
5174
|
+
:return_type => return_type
|
|
5175
|
+
)
|
|
5176
|
+
|
|
5177
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5178
|
+
if @api_client.config.debugging
|
|
5179
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5180
|
+
end
|
|
5181
|
+
return data, status_code, headers
|
|
5182
|
+
end
|
|
5183
|
+
|
|
5105
5184
|
# Read one segment, with its rule
|
|
5106
5185
|
# The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
5107
5186
|
# @param storefront_oid [Integer]
|
|
@@ -5172,6 +5251,85 @@ module UltracartClient
|
|
|
5172
5251
|
return data, status_code, headers
|
|
5173
5252
|
end
|
|
5174
5253
|
|
|
5254
|
+
# Read one page of a segment's members
|
|
5255
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5256
|
+
# @param storefront_oid [Integer]
|
|
5257
|
+
# @param segment_uuid [String]
|
|
5258
|
+
# @param [Hash] opts the optional parameters
|
|
5259
|
+
# @option opts [Integer] :page The page, from 1
|
|
5260
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5261
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5262
|
+
# @return [SfvbCommsMembersResponse]
|
|
5263
|
+
def get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts = {})
|
|
5264
|
+
data, _status_code, _headers = get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
|
|
5265
|
+
data
|
|
5266
|
+
end
|
|
5267
|
+
|
|
5268
|
+
# Read one page of a segment's members
|
|
5269
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5270
|
+
# @param storefront_oid [Integer]
|
|
5271
|
+
# @param segment_uuid [String]
|
|
5272
|
+
# @param [Hash] opts the optional parameters
|
|
5273
|
+
# @option opts [Integer] :page The page, from 1
|
|
5274
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5275
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5276
|
+
# @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
|
|
5277
|
+
def get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts = {})
|
|
5278
|
+
if @api_client.config.debugging
|
|
5279
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment_members ...'
|
|
5280
|
+
end
|
|
5281
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5282
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5283
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment_members"
|
|
5284
|
+
end
|
|
5285
|
+
# verify the required parameter 'segment_uuid' is set
|
|
5286
|
+
if @api_client.config.client_side_validation && segment_uuid.nil?
|
|
5287
|
+
fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment_members"
|
|
5288
|
+
end
|
|
5289
|
+
# resource path
|
|
5290
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
|
|
5291
|
+
|
|
5292
|
+
# query parameters
|
|
5293
|
+
query_params = opts[:query_params] || {}
|
|
5294
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
5295
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
5296
|
+
query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
|
|
5297
|
+
|
|
5298
|
+
# header parameters
|
|
5299
|
+
header_params = opts[:header_params] || {}
|
|
5300
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5301
|
+
# HTTP header 'Accept' (if needed)
|
|
5302
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5303
|
+
|
|
5304
|
+
# form parameters
|
|
5305
|
+
form_params = opts[:form_params] || {}
|
|
5306
|
+
|
|
5307
|
+
# http body (model)
|
|
5308
|
+
post_body = opts[:debug_body]
|
|
5309
|
+
|
|
5310
|
+
# return_type
|
|
5311
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
|
|
5312
|
+
|
|
5313
|
+
# auth_names
|
|
5314
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5315
|
+
|
|
5316
|
+
new_options = opts.merge(
|
|
5317
|
+
:operation => :"SfvbApi.get_sfvb_comms_segment_members",
|
|
5318
|
+
:header_params => header_params,
|
|
5319
|
+
:query_params => query_params,
|
|
5320
|
+
:form_params => form_params,
|
|
5321
|
+
:body => post_body,
|
|
5322
|
+
:auth_names => auth_names,
|
|
5323
|
+
:return_type => return_type
|
|
5324
|
+
)
|
|
5325
|
+
|
|
5326
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5327
|
+
if @api_client.config.debugging
|
|
5328
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5329
|
+
end
|
|
5330
|
+
return data, status_code, headers
|
|
5331
|
+
end
|
|
5332
|
+
|
|
5175
5333
|
# Read a sending domain
|
|
5176
5334
|
# One sending domain as stored. To check an amazon domain's DNS again, use the status call.
|
|
5177
5335
|
# @param domain [String]
|
|
@@ -7655,6 +7813,85 @@ module UltracartClient
|
|
|
7655
7813
|
return data, status_code, headers
|
|
7656
7814
|
end
|
|
7657
7815
|
|
|
7816
|
+
# Read one page of the cards mailed for a postcard
|
|
7817
|
+
# Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
|
|
7818
|
+
# @param storefront_oid [Integer]
|
|
7819
|
+
# @param postcard_uuid [String]
|
|
7820
|
+
# @param [Hash] opts the optional parameters
|
|
7821
|
+
# @option opts [Integer] :page The page, from 1
|
|
7822
|
+
# @option opts [Integer] :page_size Cards per page, 1 to 100 (default 50)
|
|
7823
|
+
# @option opts [Boolean] :show_customer_data True to return the recipients' real names and street addresses
|
|
7824
|
+
# @return [SfvbPostcardTrackingResponse]
|
|
7825
|
+
def get_sfvb_postcard_tracking(storefront_oid, postcard_uuid, opts = {})
|
|
7826
|
+
data, _status_code, _headers = get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
|
|
7827
|
+
data
|
|
7828
|
+
end
|
|
7829
|
+
|
|
7830
|
+
# Read one page of the cards mailed for a postcard
|
|
7831
|
+
# Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
|
|
7832
|
+
# @param storefront_oid [Integer]
|
|
7833
|
+
# @param postcard_uuid [String]
|
|
7834
|
+
# @param [Hash] opts the optional parameters
|
|
7835
|
+
# @option opts [Integer] :page The page, from 1
|
|
7836
|
+
# @option opts [Integer] :page_size Cards per page, 1 to 100 (default 50)
|
|
7837
|
+
# @option opts [Boolean] :show_customer_data True to return the recipients' real names and street addresses
|
|
7838
|
+
# @return [Array<(SfvbPostcardTrackingResponse, Integer, Hash)>] SfvbPostcardTrackingResponse data, response status code and response headers
|
|
7839
|
+
def get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts = {})
|
|
7840
|
+
if @api_client.config.debugging
|
|
7841
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_postcard_tracking ...'
|
|
7842
|
+
end
|
|
7843
|
+
# verify the required parameter 'storefront_oid' is set
|
|
7844
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
7845
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_postcard_tracking"
|
|
7846
|
+
end
|
|
7847
|
+
# verify the required parameter 'postcard_uuid' is set
|
|
7848
|
+
if @api_client.config.client_side_validation && postcard_uuid.nil?
|
|
7849
|
+
fail ArgumentError, "Missing the required parameter 'postcard_uuid' when calling SfvbApi.get_sfvb_postcard_tracking"
|
|
7850
|
+
end
|
|
7851
|
+
# resource path
|
|
7852
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'postcard_uuid' + '}', CGI.escape(postcard_uuid.to_s))
|
|
7853
|
+
|
|
7854
|
+
# query parameters
|
|
7855
|
+
query_params = opts[:query_params] || {}
|
|
7856
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
7857
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
7858
|
+
query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
|
|
7859
|
+
|
|
7860
|
+
# header parameters
|
|
7861
|
+
header_params = opts[:header_params] || {}
|
|
7862
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
7863
|
+
# HTTP header 'Accept' (if needed)
|
|
7864
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
7865
|
+
|
|
7866
|
+
# form parameters
|
|
7867
|
+
form_params = opts[:form_params] || {}
|
|
7868
|
+
|
|
7869
|
+
# http body (model)
|
|
7870
|
+
post_body = opts[:debug_body]
|
|
7871
|
+
|
|
7872
|
+
# return_type
|
|
7873
|
+
return_type = opts[:debug_return_type] || 'SfvbPostcardTrackingResponse'
|
|
7874
|
+
|
|
7875
|
+
# auth_names
|
|
7876
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
7877
|
+
|
|
7878
|
+
new_options = opts.merge(
|
|
7879
|
+
:operation => :"SfvbApi.get_sfvb_postcard_tracking",
|
|
7880
|
+
:header_params => header_params,
|
|
7881
|
+
:query_params => query_params,
|
|
7882
|
+
:form_params => form_params,
|
|
7883
|
+
:body => post_body,
|
|
7884
|
+
:auth_names => auth_names,
|
|
7885
|
+
:return_type => return_type
|
|
7886
|
+
)
|
|
7887
|
+
|
|
7888
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
7889
|
+
if @api_client.config.debugging
|
|
7890
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
7891
|
+
end
|
|
7892
|
+
return data, status_code, headers
|
|
7893
|
+
end
|
|
7894
|
+
|
|
7658
7895
|
# URL that renders a preview session
|
|
7659
7896
|
# Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
7660
7897
|
# @param storefront_oid [Integer]
|
|
@@ -9364,6 +9601,76 @@ module UltracartClient
|
|
|
9364
9601
|
return data, status_code, headers
|
|
9365
9602
|
end
|
|
9366
9603
|
|
|
9604
|
+
# Read a transactional email's subject, delivery options and sender
|
|
9605
|
+
# file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
9606
|
+
# @param storefront_oid [Integer]
|
|
9607
|
+
# @param file_name [String]
|
|
9608
|
+
# @param [Hash] opts the optional parameters
|
|
9609
|
+
# @return [SfvbTransactionalEmailResponse]
|
|
9610
|
+
def get_sfvb_transactional_email(storefront_oid, file_name, opts = {})
|
|
9611
|
+
data, _status_code, _headers = get_sfvb_transactional_email_with_http_info(storefront_oid, file_name, opts)
|
|
9612
|
+
data
|
|
9613
|
+
end
|
|
9614
|
+
|
|
9615
|
+
# Read a transactional email's subject, delivery options and sender
|
|
9616
|
+
# file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
9617
|
+
# @param storefront_oid [Integer]
|
|
9618
|
+
# @param file_name [String]
|
|
9619
|
+
# @param [Hash] opts the optional parameters
|
|
9620
|
+
# @return [Array<(SfvbTransactionalEmailResponse, Integer, Hash)>] SfvbTransactionalEmailResponse data, response status code and response headers
|
|
9621
|
+
def get_sfvb_transactional_email_with_http_info(storefront_oid, file_name, opts = {})
|
|
9622
|
+
if @api_client.config.debugging
|
|
9623
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_transactional_email ...'
|
|
9624
|
+
end
|
|
9625
|
+
# verify the required parameter 'storefront_oid' is set
|
|
9626
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
9627
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_transactional_email"
|
|
9628
|
+
end
|
|
9629
|
+
# verify the required parameter 'file_name' is set
|
|
9630
|
+
if @api_client.config.client_side_validation && file_name.nil?
|
|
9631
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.get_sfvb_transactional_email"
|
|
9632
|
+
end
|
|
9633
|
+
# resource path
|
|
9634
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
|
|
9635
|
+
|
|
9636
|
+
# query parameters
|
|
9637
|
+
query_params = opts[:query_params] || {}
|
|
9638
|
+
|
|
9639
|
+
# header parameters
|
|
9640
|
+
header_params = opts[:header_params] || {}
|
|
9641
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
9642
|
+
# HTTP header 'Accept' (if needed)
|
|
9643
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9644
|
+
|
|
9645
|
+
# form parameters
|
|
9646
|
+
form_params = opts[:form_params] || {}
|
|
9647
|
+
|
|
9648
|
+
# http body (model)
|
|
9649
|
+
post_body = opts[:debug_body]
|
|
9650
|
+
|
|
9651
|
+
# return_type
|
|
9652
|
+
return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailResponse'
|
|
9653
|
+
|
|
9654
|
+
# auth_names
|
|
9655
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9656
|
+
|
|
9657
|
+
new_options = opts.merge(
|
|
9658
|
+
:operation => :"SfvbApi.get_sfvb_transactional_email",
|
|
9659
|
+
:header_params => header_params,
|
|
9660
|
+
:query_params => query_params,
|
|
9661
|
+
:form_params => form_params,
|
|
9662
|
+
:body => post_body,
|
|
9663
|
+
:auth_names => auth_names,
|
|
9664
|
+
:return_type => return_type
|
|
9665
|
+
)
|
|
9666
|
+
|
|
9667
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
9668
|
+
if @api_client.config.debugging
|
|
9669
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9670
|
+
end
|
|
9671
|
+
return data, status_code, headers
|
|
9672
|
+
end
|
|
9673
|
+
|
|
9367
9674
|
# List the transactional emails a storefront sends
|
|
9368
9675
|
# The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
9369
9676
|
# @param storefront_oid [Integer]
|
|
@@ -18584,6 +18891,97 @@ module UltracartClient
|
|
|
18584
18891
|
return data, status_code, headers
|
|
18585
18892
|
end
|
|
18586
18893
|
|
|
18894
|
+
# Change a transactional email's subject, delivery options or sender
|
|
18895
|
+
# A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
|
|
18896
|
+
# @param storefront_oid [Integer]
|
|
18897
|
+
# @param file_name [String]
|
|
18898
|
+
# @param if_match [String] The email's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
18899
|
+
# @param transactional_email_update_request [SfvbTransactionalEmailUpdateRequest] The fields to change
|
|
18900
|
+
# @param [Hash] opts the optional parameters
|
|
18901
|
+
# @option opts [String] :approval_id The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
|
|
18902
|
+
# @return [SfvbTransactionalEmailResponse]
|
|
18903
|
+
def update_sfvb_transactional_email(storefront_oid, file_name, if_match, transactional_email_update_request, opts = {})
|
|
18904
|
+
data, _status_code, _headers = update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
|
|
18905
|
+
data
|
|
18906
|
+
end
|
|
18907
|
+
|
|
18908
|
+
# Change a transactional email's subject, delivery options or sender
|
|
18909
|
+
# A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
|
|
18910
|
+
# @param storefront_oid [Integer]
|
|
18911
|
+
# @param file_name [String]
|
|
18912
|
+
# @param if_match [String] The email's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
18913
|
+
# @param transactional_email_update_request [SfvbTransactionalEmailUpdateRequest] The fields to change
|
|
18914
|
+
# @param [Hash] opts the optional parameters
|
|
18915
|
+
# @option opts [String] :approval_id The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
|
|
18916
|
+
# @return [Array<(SfvbTransactionalEmailResponse, Integer, Hash)>] SfvbTransactionalEmailResponse data, response status code and response headers
|
|
18917
|
+
def update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts = {})
|
|
18918
|
+
if @api_client.config.debugging
|
|
18919
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_transactional_email ...'
|
|
18920
|
+
end
|
|
18921
|
+
# verify the required parameter 'storefront_oid' is set
|
|
18922
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
18923
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18924
|
+
end
|
|
18925
|
+
# verify the required parameter 'file_name' is set
|
|
18926
|
+
if @api_client.config.client_side_validation && file_name.nil?
|
|
18927
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18928
|
+
end
|
|
18929
|
+
# verify the required parameter 'if_match' is set
|
|
18930
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
18931
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18932
|
+
end
|
|
18933
|
+
# verify the required parameter 'transactional_email_update_request' is set
|
|
18934
|
+
if @api_client.config.client_side_validation && transactional_email_update_request.nil?
|
|
18935
|
+
fail ArgumentError, "Missing the required parameter 'transactional_email_update_request' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18936
|
+
end
|
|
18937
|
+
# resource path
|
|
18938
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
|
|
18939
|
+
|
|
18940
|
+
# query parameters
|
|
18941
|
+
query_params = opts[:query_params] || {}
|
|
18942
|
+
|
|
18943
|
+
# header parameters
|
|
18944
|
+
header_params = opts[:header_params] || {}
|
|
18945
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
18946
|
+
# HTTP header 'Accept' (if needed)
|
|
18947
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
18948
|
+
# HTTP header 'Content-Type'
|
|
18949
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
18950
|
+
if !content_type.nil?
|
|
18951
|
+
header_params['Content-Type'] = content_type
|
|
18952
|
+
end
|
|
18953
|
+
header_params[:'If-Match'] = if_match
|
|
18954
|
+
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
18955
|
+
|
|
18956
|
+
# form parameters
|
|
18957
|
+
form_params = opts[:form_params] || {}
|
|
18958
|
+
|
|
18959
|
+
# http body (model)
|
|
18960
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactional_email_update_request)
|
|
18961
|
+
|
|
18962
|
+
# return_type
|
|
18963
|
+
return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailResponse'
|
|
18964
|
+
|
|
18965
|
+
# auth_names
|
|
18966
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
18967
|
+
|
|
18968
|
+
new_options = opts.merge(
|
|
18969
|
+
:operation => :"SfvbApi.update_sfvb_transactional_email",
|
|
18970
|
+
:header_params => header_params,
|
|
18971
|
+
:query_params => query_params,
|
|
18972
|
+
:form_params => form_params,
|
|
18973
|
+
:body => post_body,
|
|
18974
|
+
:auth_names => auth_names,
|
|
18975
|
+
:return_type => return_type
|
|
18976
|
+
)
|
|
18977
|
+
|
|
18978
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
18979
|
+
if @api_client.config.debugging
|
|
18980
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
18981
|
+
end
|
|
18982
|
+
return data, status_code, headers
|
|
18983
|
+
end
|
|
18984
|
+
|
|
18587
18985
|
# Update an upsell offer
|
|
18588
18986
|
# A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer's screenshots, are kept.
|
|
18589
18987
|
# @param storefront_oid [Integer]
|
|
@@ -48,7 +48,7 @@ module UltracartClient
|
|
|
48
48
|
# Day counts (1 to 365, at most 20) a customer may switch this auto-enrolled item to from MyAccount, for example [30, 60, 90]. Requires the advanced auto order settings to be enabled on the account. Omit to leave unchanged; send an empty array to clear.
|
|
49
49
|
attr_accessor :auto_order_myaccount_frequency_day_counts
|
|
50
50
|
|
|
51
|
-
# True if the MyAccount frequency change is only offered once the item is on its last auto order step.
|
|
51
|
+
# True if the MyAccount frequency change is only offered once the item is on its last auto order step. If auto_order_myaccount_frequency_schedules or auto_order_myaccount_frequency_day_counts is sent without this property, it is set to false; if none of the three are sent, it is left unchanged.
|
|
52
52
|
attr_accessor :auto_order_myaccount_frequency_last_step_only
|
|
53
53
|
|
|
54
54
|
# Standard schedules a customer may switch this auto-enrolled item to from MyAccount. Requires the advanced auto order settings to be enabled on the account. Omit to leave unchanged; send an empty array to clear.
|