ultracart_api 4.1.242 → 4.1.244
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 +5 -2
- data/docs/OauthTokenResponse.md +4 -0
- data/docs/SfvbApi.md +1 -1
- data/docs/SfvbCliAccess.md +20 -0
- data/docs/SfvbPageResponse.md +14 -0
- data/docs/SfvbWhoamiResponse.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +2 -2
- data/lib/ultracart_api/models/oauth_token_response.rb +21 -1
- data/lib/ultracart_api/models/sfvb_cli_access.rb +230 -0
- data/lib/ultracart_api/models/sfvb_page_response.rb +71 -1
- data/lib/ultracart_api/models/sfvb_whoami_response.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +3 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b022fff14dbe7db2c7e2ab984f842bff18ce97407c7a097f686dec7deb7fbf1e
|
|
4
|
+
data.tar.gz: e37ee0cafcbf021677c3f4aef6a1bf42020d5c6464401025781c42322d755841
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c478e3e91f0c010385654d8663fd6ef6d94101426e99ed9e312985aedc905ea75b076489fb16cbe132f34d38fe8d367315d0a2e3f044e0b4c6b7b5c2a8ca67f8
|
|
7
|
+
data.tar.gz: 2d9349d6344f073dd3ca993ce7d596e2d420065318acd396506bc89f75eb17be8fe95494f68f766fbe807473be1db515d346b8237e6987ce34e0afbc7081cea3
|
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.244
|
|
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.244'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -2026,6 +2026,7 @@ Class | Method | HTTP request | Description
|
|
|
2026
2026
|
- [UltracartClient::SfvbCampaignMembership](docs/SfvbCampaignMembership.md)
|
|
2027
2027
|
- [UltracartClient::SfvbCampaignWriteRequest](docs/SfvbCampaignWriteRequest.md)
|
|
2028
2028
|
- [UltracartClient::SfvbCampaignsResponse](docs/SfvbCampaignsResponse.md)
|
|
2029
|
+
- [UltracartClient::SfvbCliAccess](docs/SfvbCliAccess.md)
|
|
2029
2030
|
- [UltracartClient::SfvbCodeLibraryEmail](docs/SfvbCodeLibraryEmail.md)
|
|
2030
2031
|
- [UltracartClient::SfvbCodeLibraryEmailsResponse](docs/SfvbCodeLibraryEmailsResponse.md)
|
|
2031
2032
|
- [UltracartClient::SfvbCommsBranchStat](docs/SfvbCommsBranchStat.md)
|
|
@@ -2583,6 +2584,8 @@ Not every change is committed to every SDK.
|
|
|
2583
2584
|
|
|
2584
2585
|
| Version | Date | Comments |
|
|
2585
2586
|
| --: | :-: | --- |
|
|
2587
|
+
| 4.1.244 | 11/11/2026 | sfvb internal testing |
|
|
2588
|
+
| 4.1.243 | 11/11/2026 | sfvb internal testing |
|
|
2586
2589
|
| 4.1.242 | 11/11/2026 | sfvb internal testing |
|
|
2587
2590
|
| 4.1.241 | 11/10/2026 | sfvb internal testing |
|
|
2588
2591
|
| 4.1.240 | 11/10/2026 | sfvb internal testing |
|
data/docs/OauthTokenResponse.md
CHANGED
|
@@ -6,10 +6,12 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **access_token** | **String** | Access token to use in OAuth authenticated API call | [optional] |
|
|
8
8
|
| **error** | **String** | | [optional] |
|
|
9
|
+
| **error_code** | **String** | With error access_denied, a machine readable reason. sfvb.beta_access_required means the account isn't enabled for the StoreFront CLI beta, not that a person clicked Deny. | [optional] |
|
|
9
10
|
| **error_description** | **String** | | [optional] |
|
|
10
11
|
| **error_uri** | **String** | | [optional] |
|
|
11
12
|
| **expires_in** | **String** | The number of seconds since issuance when the access token will expire and need to be refreshed using the refresh token | [optional] |
|
|
12
13
|
| **merchant_id** | **String** | The UltraCart merchant account that authorized this token. Use it to map the token to the merchant within your own system. Also returned by GET /oauth/me along with the account name. | [optional] |
|
|
14
|
+
| **object_id** | **String** | With error_code sfvb.beta_access_required, the merchant id that was refused. | [optional] |
|
|
13
15
|
| **refresh_token** | **String** | The refresh token that should be used to fetch a new access token when the expiration occurs | [optional] |
|
|
14
16
|
| **refresh_token_expires_in** | **String** | Seconds until the refresh token expires. Returned only by applications that rotate refresh tokens, which return a new refresh token on every refresh. | [optional] |
|
|
15
17
|
| **scope** | **String** | The scope of permissions associated with teh access token | [optional] |
|
|
@@ -23,10 +25,12 @@ require 'ultracart_api'
|
|
|
23
25
|
instance = UltracartClient::OauthTokenResponse.new(
|
|
24
26
|
access_token: null,
|
|
25
27
|
error: null,
|
|
28
|
+
error_code: null,
|
|
26
29
|
error_description: null,
|
|
27
30
|
error_uri: null,
|
|
28
31
|
expires_in: null,
|
|
29
32
|
merchant_id: null,
|
|
33
|
+
object_id: null,
|
|
30
34
|
refresh_token: null,
|
|
31
35
|
refresh_token_expires_in: null,
|
|
32
36
|
scope: null,
|
data/docs/SfvbApi.md
CHANGED
|
@@ -8569,7 +8569,7 @@ end
|
|
|
8569
8569
|
|
|
8570
8570
|
Check what upgrading a theme would do
|
|
8571
8571
|
|
|
8572
|
-
The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable.
|
|
8572
|
+
The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable. Limited to 10 a minute and 100 an hour per account.
|
|
8573
8573
|
|
|
8574
8574
|
|
|
8575
8575
|
### Examples
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbCliAccess
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | True when the account is on the StoreFront CLI beta list. Omitted when false. | [optional] |
|
|
8
|
+
| **request_access_url** | **String** | Where to request access. Returned only when enabled is false. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbCliAccess.new(
|
|
16
|
+
enabled: null,
|
|
17
|
+
request_access_url: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/SfvbPageResponse.md
CHANGED
|
@@ -5,12 +5,19 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **attributes** | [**Array<SfvbPageAttribute>**](SfvbPageAttribute.md) | Every attribute this page has, including ones a template declares but nothing has set yet. These are what the pageattribute element renders. Sorted by name. | [optional] |
|
|
8
|
+
| **blog_post_template** | **String** | Template that renders the blog posts under this page. Omitted when not set. | [optional] |
|
|
8
9
|
| **description** | **String** | The page description, the text a page template renders as the page's description. Omitted when empty. | [optional] |
|
|
9
10
|
| **exclude_from_sitemap** | **Boolean** | True when the page is left out of the sitemap and marked noindex. | [optional] |
|
|
10
11
|
| **group_template** | **String** | Template file that renders the page itself, a bare .vm name found anywhere in the active theme. | [optional] |
|
|
11
12
|
| **item_template** | **String** | Template file that renders the item pages under this page. | [optional] |
|
|
13
|
+
| **items_per_page** | **Integer** | Items per page on a template that paginates. Omitted when the template's default applies. | [optional] |
|
|
12
14
|
| **multimedia** | [**Array<SfvbPageMultimedia>**](SfvbPageMultimedia.md) | The page's images, including codes a template declares but nothing has attached yet. These are what the pageimage element renders - the default image when pageImageCode is empty, otherwise the image with that code. The default image comes first. | [optional] |
|
|
15
|
+
| **page_type** | **String** | S for a static page, D for a dynamic one. | [optional] |
|
|
13
16
|
| **path** | **String** | The page path, normalized to begin and end with a slash. | [optional] |
|
|
17
|
+
| **review_template** | **String** | Template that renders the item review pages under this page. Omitted when not set. | [optional] |
|
|
18
|
+
| **sort_order** | **Integer** | Position among its siblings when the parent sorts child pages by a custom order. Omitted when not set. | [optional] |
|
|
19
|
+
| **sort_order_child_groups** | **String** | How the pages under this one are ordered. TA or TD by title, DA or DD by description, C custom. | [optional] |
|
|
20
|
+
| **sort_order_child_items** | **String** | How the page's items are ordered. IA or ID by item id, DA or DD by description, SA or SD by manufacturer SKU, PA or PD by price, RA or RD by review, NA or ND by inventory, C custom. | [optional] |
|
|
14
21
|
| **title** | **String** | The page title. | [optional] |
|
|
15
22
|
| **visible** | **Boolean** | False when the page is hidden. A hidden page answers 404 to shoppers. | [optional] |
|
|
16
23
|
| **visible_dts** | **String** | When set, the page stays hidden until this time (ISO 8601, UTC). | [optional] |
|
|
@@ -22,12 +29,19 @@ require 'ultracart_api'
|
|
|
22
29
|
|
|
23
30
|
instance = UltracartClient::SfvbPageResponse.new(
|
|
24
31
|
attributes: null,
|
|
32
|
+
blog_post_template: null,
|
|
25
33
|
description: null,
|
|
26
34
|
exclude_from_sitemap: null,
|
|
27
35
|
group_template: null,
|
|
28
36
|
item_template: null,
|
|
37
|
+
items_per_page: null,
|
|
29
38
|
multimedia: null,
|
|
39
|
+
page_type: null,
|
|
30
40
|
path: null,
|
|
41
|
+
review_template: null,
|
|
42
|
+
sort_order: null,
|
|
43
|
+
sort_order_child_groups: null,
|
|
44
|
+
sort_order_child_items: null,
|
|
31
45
|
title: null,
|
|
32
46
|
visible: null,
|
|
33
47
|
visible_dts: null
|
data/docs/SfvbWhoamiResponse.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **can_read** | **Boolean** | True when this token may read. Do not infer this from the requested scope name. | [optional] |
|
|
14
14
|
| **can_read_items** | **Boolean** | True when this token may read item data - the item, its pricing, pre-order and related items. Needs can_read, and the UltraCart user behind the token must hold View Items or Edit Items. A token with no user is judged on its scopes alone. | [optional] |
|
|
15
15
|
| **can_write** | **Boolean** | True when this token may write. Writing a target that is not currently live needs only this. | [optional] |
|
|
16
|
+
| **cli_access** | [**SfvbCliAccess**](SfvbCliAccess.md) | | [optional] |
|
|
16
17
|
| **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
|
|
17
18
|
| **login** | **String** | Login of the user who approved this token. Populated for device flow tokens; null for plain API key credentials. | [optional] |
|
|
18
19
|
| **merchant_id** | **String** | Merchant id this token acts against. | [optional] |
|
|
@@ -36,6 +37,7 @@ instance = UltracartClient::SfvbWhoamiResponse.new(
|
|
|
36
37
|
can_read: null,
|
|
37
38
|
can_read_items: null,
|
|
38
39
|
can_write: null,
|
|
40
|
+
cli_access: null,
|
|
39
41
|
device_scope: null,
|
|
40
42
|
login: null,
|
|
41
43
|
merchant_id: null,
|
|
@@ -10872,7 +10872,7 @@ module UltracartClient
|
|
|
10872
10872
|
end
|
|
10873
10873
|
|
|
10874
10874
|
# Check what upgrading a theme would do
|
|
10875
|
-
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable.
|
|
10875
|
+
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable. Limited to 10 a minute and 100 an hour per account.
|
|
10876
10876
|
# @param storefront_oid [Integer]
|
|
10877
10877
|
# @param theme_oid [Integer]
|
|
10878
10878
|
# @param [Hash] opts the optional parameters
|
|
@@ -10884,7 +10884,7 @@ module UltracartClient
|
|
|
10884
10884
|
end
|
|
10885
10885
|
|
|
10886
10886
|
# Check what upgrading a theme would do
|
|
10887
|
-
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable.
|
|
10887
|
+
# The same dry run the admin shows before an upgrade, and nothing is changed. Lists the newer versions this account may use, and for one of them (version, or the newest when omitted) which customized files the upgrade would merge cleanly, leave with merge conflicts, or overwrite, plus the change log. Use it before duplicateSfvbTheme with upgrade_to_version. When no upgrade is possible the response says why in reason with can_duplicate_and_upgrade false. A version that was asked for and is not available is refused with sfvb.theme_upgrade_unavailable. Limited to 10 a minute and 100 an hour per account.
|
|
10888
10888
|
# @param storefront_oid [Integer]
|
|
10889
10889
|
# @param theme_oid [Integer]
|
|
10890
10890
|
# @param [Hash] opts the optional parameters
|
|
@@ -20,6 +20,9 @@ module UltracartClient
|
|
|
20
20
|
|
|
21
21
|
attr_accessor :error
|
|
22
22
|
|
|
23
|
+
# With error access_denied, a machine readable reason. sfvb.beta_access_required means the account isn't enabled for the StoreFront CLI beta, not that a person clicked Deny.
|
|
24
|
+
attr_accessor :error_code
|
|
25
|
+
|
|
23
26
|
attr_accessor :error_description
|
|
24
27
|
|
|
25
28
|
attr_accessor :error_uri
|
|
@@ -30,6 +33,9 @@ module UltracartClient
|
|
|
30
33
|
# The UltraCart merchant account that authorized this token. Use it to map the token to the merchant within your own system. Also returned by GET /oauth/me along with the account name.
|
|
31
34
|
attr_accessor :merchant_id
|
|
32
35
|
|
|
36
|
+
# With error_code sfvb.beta_access_required, the merchant id that was refused.
|
|
37
|
+
attr_accessor :object_id
|
|
38
|
+
|
|
33
39
|
# The refresh token that should be used to fetch a new access token when the expiration occurs
|
|
34
40
|
attr_accessor :refresh_token
|
|
35
41
|
|
|
@@ -69,10 +75,12 @@ module UltracartClient
|
|
|
69
75
|
{
|
|
70
76
|
:'access_token' => :'access_token',
|
|
71
77
|
:'error' => :'error',
|
|
78
|
+
:'error_code' => :'error_code',
|
|
72
79
|
:'error_description' => :'error_description',
|
|
73
80
|
:'error_uri' => :'error_uri',
|
|
74
81
|
:'expires_in' => :'expires_in',
|
|
75
82
|
:'merchant_id' => :'merchant_id',
|
|
83
|
+
:'object_id' => :'object_id',
|
|
76
84
|
:'refresh_token' => :'refresh_token',
|
|
77
85
|
:'refresh_token_expires_in' => :'refresh_token_expires_in',
|
|
78
86
|
:'scope' => :'scope',
|
|
@@ -90,10 +98,12 @@ module UltracartClient
|
|
|
90
98
|
{
|
|
91
99
|
:'access_token' => :'String',
|
|
92
100
|
:'error' => :'String',
|
|
101
|
+
:'error_code' => :'String',
|
|
93
102
|
:'error_description' => :'String',
|
|
94
103
|
:'error_uri' => :'String',
|
|
95
104
|
:'expires_in' => :'String',
|
|
96
105
|
:'merchant_id' => :'String',
|
|
106
|
+
:'object_id' => :'String',
|
|
97
107
|
:'refresh_token' => :'String',
|
|
98
108
|
:'refresh_token_expires_in' => :'String',
|
|
99
109
|
:'scope' => :'String',
|
|
@@ -130,6 +140,10 @@ module UltracartClient
|
|
|
130
140
|
self.error = attributes[:'error']
|
|
131
141
|
end
|
|
132
142
|
|
|
143
|
+
if attributes.key?(:'error_code')
|
|
144
|
+
self.error_code = attributes[:'error_code']
|
|
145
|
+
end
|
|
146
|
+
|
|
133
147
|
if attributes.key?(:'error_description')
|
|
134
148
|
self.error_description = attributes[:'error_description']
|
|
135
149
|
end
|
|
@@ -146,6 +160,10 @@ module UltracartClient
|
|
|
146
160
|
self.merchant_id = attributes[:'merchant_id']
|
|
147
161
|
end
|
|
148
162
|
|
|
163
|
+
if attributes.key?(:'object_id')
|
|
164
|
+
self.object_id = attributes[:'object_id']
|
|
165
|
+
end
|
|
166
|
+
|
|
149
167
|
if attributes.key?(:'refresh_token')
|
|
150
168
|
self.refresh_token = attributes[:'refresh_token']
|
|
151
169
|
end
|
|
@@ -195,10 +213,12 @@ module UltracartClient
|
|
|
195
213
|
self.class == o.class &&
|
|
196
214
|
access_token == o.access_token &&
|
|
197
215
|
error == o.error &&
|
|
216
|
+
error_code == o.error_code &&
|
|
198
217
|
error_description == o.error_description &&
|
|
199
218
|
error_uri == o.error_uri &&
|
|
200
219
|
expires_in == o.expires_in &&
|
|
201
220
|
merchant_id == o.merchant_id &&
|
|
221
|
+
object_id == o.object_id &&
|
|
202
222
|
refresh_token == o.refresh_token &&
|
|
203
223
|
refresh_token_expires_in == o.refresh_token_expires_in &&
|
|
204
224
|
scope == o.scope &&
|
|
@@ -214,7 +234,7 @@ module UltracartClient
|
|
|
214
234
|
# Calculates hash code according to all attributes.
|
|
215
235
|
# @return [Integer] Hash code
|
|
216
236
|
def hash
|
|
217
|
-
[access_token, error, error_description, error_uri, expires_in, merchant_id, refresh_token, refresh_token_expires_in, scope, token_type].hash
|
|
237
|
+
[access_token, error, error_code, error_description, error_uri, expires_in, merchant_id, object_id, refresh_token, refresh_token_expires_in, scope, token_type].hash
|
|
218
238
|
end
|
|
219
239
|
|
|
220
240
|
# Builds the object from hash
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module UltracartClient
|
|
17
|
+
class SfvbCliAccess
|
|
18
|
+
# True when the account is on the StoreFront CLI beta list. Omitted when false.
|
|
19
|
+
attr_accessor :enabled
|
|
20
|
+
|
|
21
|
+
# Where to request access. Returned only when enabled is false.
|
|
22
|
+
attr_accessor :request_access_url
|
|
23
|
+
|
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
25
|
+
def self.attribute_map
|
|
26
|
+
{
|
|
27
|
+
:'enabled' => :'enabled',
|
|
28
|
+
:'request_access_url' => :'request_access_url'
|
|
29
|
+
}
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Returns all the JSON keys this model knows about
|
|
33
|
+
def self.acceptable_attributes
|
|
34
|
+
attribute_map.values
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Attribute type mapping.
|
|
38
|
+
def self.openapi_types
|
|
39
|
+
{
|
|
40
|
+
:'enabled' => :'Boolean',
|
|
41
|
+
:'request_access_url' => :'String'
|
|
42
|
+
}
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# List of attributes with nullable: true
|
|
46
|
+
def self.openapi_nullable
|
|
47
|
+
Set.new([
|
|
48
|
+
])
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Initializes the object
|
|
52
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
|
+
def initialize(attributes = {})
|
|
54
|
+
if (!attributes.is_a?(Hash))
|
|
55
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbCliAccess` initialize method"
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
61
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbCliAccess`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
62
|
+
end
|
|
63
|
+
h[k.to_sym] = v
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
if attributes.key?(:'enabled')
|
|
67
|
+
self.enabled = attributes[:'enabled']
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
if attributes.key?(:'request_access_url')
|
|
71
|
+
self.request_access_url = attributes[:'request_access_url']
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
76
|
+
# @return Array for valid properties with the reasons
|
|
77
|
+
def list_invalid_properties
|
|
78
|
+
invalid_properties = Array.new
|
|
79
|
+
invalid_properties
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Check to see if the all the properties in the model are valid
|
|
83
|
+
# @return true if the model is valid
|
|
84
|
+
def valid?
|
|
85
|
+
true
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Checks equality by comparing each attribute.
|
|
89
|
+
# @param [Object] Object to be compared
|
|
90
|
+
def ==(o)
|
|
91
|
+
return true if self.equal?(o)
|
|
92
|
+
self.class == o.class &&
|
|
93
|
+
enabled == o.enabled &&
|
|
94
|
+
request_access_url == o.request_access_url
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# @see the `==` method
|
|
98
|
+
# @param [Object] Object to be compared
|
|
99
|
+
def eql?(o)
|
|
100
|
+
self == o
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Calculates hash code according to all attributes.
|
|
104
|
+
# @return [Integer] Hash code
|
|
105
|
+
def hash
|
|
106
|
+
[enabled, request_access_url].hash
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Builds the object from hash
|
|
110
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
111
|
+
# @return [Object] Returns the model itself
|
|
112
|
+
def self.build_from_hash(attributes)
|
|
113
|
+
new.build_from_hash(attributes)
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Builds the object from hash
|
|
117
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
118
|
+
# @return [Object] Returns the model itself
|
|
119
|
+
def build_from_hash(attributes)
|
|
120
|
+
return nil unless attributes.is_a?(Hash)
|
|
121
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
122
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
123
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
124
|
+
self.send("#{key}=", nil)
|
|
125
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
126
|
+
# check to ensure the input is an array given that the attribute
|
|
127
|
+
# is documented as an array but the input is not
|
|
128
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
129
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
130
|
+
end
|
|
131
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
132
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
self
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Deserializes the data based on type
|
|
140
|
+
# @param string type Data type
|
|
141
|
+
# @param string value Value to be deserialized
|
|
142
|
+
# @return [Object] Deserialized data
|
|
143
|
+
def _deserialize(type, value)
|
|
144
|
+
case type.to_sym
|
|
145
|
+
when :Time
|
|
146
|
+
Time.parse(value)
|
|
147
|
+
when :Date
|
|
148
|
+
Date.parse(value)
|
|
149
|
+
when :String
|
|
150
|
+
value.to_s
|
|
151
|
+
when :Integer
|
|
152
|
+
value.to_i
|
|
153
|
+
when :Float
|
|
154
|
+
value.to_f
|
|
155
|
+
when :Boolean
|
|
156
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
157
|
+
true
|
|
158
|
+
else
|
|
159
|
+
false
|
|
160
|
+
end
|
|
161
|
+
when :Object
|
|
162
|
+
# generic object (usually a Hash), return directly
|
|
163
|
+
value
|
|
164
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
165
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
166
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
167
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
168
|
+
k_type = Regexp.last_match[:k_type]
|
|
169
|
+
v_type = Regexp.last_match[:v_type]
|
|
170
|
+
{}.tap do |hash|
|
|
171
|
+
value.each do |k, v|
|
|
172
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
else # model
|
|
176
|
+
# models (e.g. Pet) or oneOf
|
|
177
|
+
klass = UltracartClient.const_get(type)
|
|
178
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# Returns the string representation of the object
|
|
183
|
+
# @return [String] String presentation of the object
|
|
184
|
+
def to_s
|
|
185
|
+
to_hash.to_s
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
189
|
+
# @return [Hash] Returns the object in the form of hash
|
|
190
|
+
def to_body
|
|
191
|
+
to_hash
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
# Returns the object in the form of hash
|
|
195
|
+
# @return [Hash] Returns the object in the form of hash
|
|
196
|
+
def to_hash
|
|
197
|
+
hash = {}
|
|
198
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
199
|
+
value = self.send(attr)
|
|
200
|
+
if value.nil?
|
|
201
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
202
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
hash[param] = _to_hash(value)
|
|
206
|
+
end
|
|
207
|
+
hash
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Outputs non-array value in the form of hash
|
|
211
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
212
|
+
# @param [Object] value Any valid value
|
|
213
|
+
# @return [Hash] Returns the value in the form of hash
|
|
214
|
+
def _to_hash(value)
|
|
215
|
+
if value.is_a?(Array)
|
|
216
|
+
value.compact.map { |v| _to_hash(v) }
|
|
217
|
+
elsif value.is_a?(Hash)
|
|
218
|
+
{}.tap do |hash|
|
|
219
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
220
|
+
end
|
|
221
|
+
elsif value.respond_to? :to_hash
|
|
222
|
+
value.to_hash
|
|
223
|
+
else
|
|
224
|
+
value
|
|
225
|
+
end
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
end
|
|
@@ -18,6 +18,9 @@ module UltracartClient
|
|
|
18
18
|
# Every attribute this page has, including ones a template declares but nothing has set yet. These are what the pageattribute element renders. Sorted by name.
|
|
19
19
|
attr_accessor :attributes
|
|
20
20
|
|
|
21
|
+
# Template that renders the blog posts under this page. Omitted when not set.
|
|
22
|
+
attr_accessor :blog_post_template
|
|
23
|
+
|
|
21
24
|
# The page description, the text a page template renders as the page's description. Omitted when empty.
|
|
22
25
|
attr_accessor :description
|
|
23
26
|
|
|
@@ -30,12 +33,30 @@ module UltracartClient
|
|
|
30
33
|
# Template file that renders the item pages under this page.
|
|
31
34
|
attr_accessor :item_template
|
|
32
35
|
|
|
36
|
+
# Items per page on a template that paginates. Omitted when the template's default applies.
|
|
37
|
+
attr_accessor :items_per_page
|
|
38
|
+
|
|
33
39
|
# The page's images, including codes a template declares but nothing has attached yet. These are what the pageimage element renders - the default image when pageImageCode is empty, otherwise the image with that code. The default image comes first.
|
|
34
40
|
attr_accessor :multimedia
|
|
35
41
|
|
|
42
|
+
# S for a static page, D for a dynamic one.
|
|
43
|
+
attr_accessor :page_type
|
|
44
|
+
|
|
36
45
|
# The page path, normalized to begin and end with a slash.
|
|
37
46
|
attr_accessor :path
|
|
38
47
|
|
|
48
|
+
# Template that renders the item review pages under this page. Omitted when not set.
|
|
49
|
+
attr_accessor :review_template
|
|
50
|
+
|
|
51
|
+
# Position among its siblings when the parent sorts child pages by a custom order. Omitted when not set.
|
|
52
|
+
attr_accessor :sort_order
|
|
53
|
+
|
|
54
|
+
# How the pages under this one are ordered. TA or TD by title, DA or DD by description, C custom.
|
|
55
|
+
attr_accessor :sort_order_child_groups
|
|
56
|
+
|
|
57
|
+
# How the page's items are ordered. IA or ID by item id, DA or DD by description, SA or SD by manufacturer SKU, PA or PD by price, RA or RD by review, NA or ND by inventory, C custom.
|
|
58
|
+
attr_accessor :sort_order_child_items
|
|
59
|
+
|
|
39
60
|
# The page title.
|
|
40
61
|
attr_accessor :title
|
|
41
62
|
|
|
@@ -49,12 +70,19 @@ module UltracartClient
|
|
|
49
70
|
def self.attribute_map
|
|
50
71
|
{
|
|
51
72
|
:'attributes' => :'attributes',
|
|
73
|
+
:'blog_post_template' => :'blog_post_template',
|
|
52
74
|
:'description' => :'description',
|
|
53
75
|
:'exclude_from_sitemap' => :'exclude_from_sitemap',
|
|
54
76
|
:'group_template' => :'group_template',
|
|
55
77
|
:'item_template' => :'item_template',
|
|
78
|
+
:'items_per_page' => :'items_per_page',
|
|
56
79
|
:'multimedia' => :'multimedia',
|
|
80
|
+
:'page_type' => :'page_type',
|
|
57
81
|
:'path' => :'path',
|
|
82
|
+
:'review_template' => :'review_template',
|
|
83
|
+
:'sort_order' => :'sort_order',
|
|
84
|
+
:'sort_order_child_groups' => :'sort_order_child_groups',
|
|
85
|
+
:'sort_order_child_items' => :'sort_order_child_items',
|
|
58
86
|
:'title' => :'title',
|
|
59
87
|
:'visible' => :'visible',
|
|
60
88
|
:'visible_dts' => :'visible_dts'
|
|
@@ -70,12 +98,19 @@ module UltracartClient
|
|
|
70
98
|
def self.openapi_types
|
|
71
99
|
{
|
|
72
100
|
:'attributes' => :'Array<SfvbPageAttribute>',
|
|
101
|
+
:'blog_post_template' => :'String',
|
|
73
102
|
:'description' => :'String',
|
|
74
103
|
:'exclude_from_sitemap' => :'Boolean',
|
|
75
104
|
:'group_template' => :'String',
|
|
76
105
|
:'item_template' => :'String',
|
|
106
|
+
:'items_per_page' => :'Integer',
|
|
77
107
|
:'multimedia' => :'Array<SfvbPageMultimedia>',
|
|
108
|
+
:'page_type' => :'String',
|
|
78
109
|
:'path' => :'String',
|
|
110
|
+
:'review_template' => :'String',
|
|
111
|
+
:'sort_order' => :'Integer',
|
|
112
|
+
:'sort_order_child_groups' => :'String',
|
|
113
|
+
:'sort_order_child_items' => :'String',
|
|
79
114
|
:'title' => :'String',
|
|
80
115
|
:'visible' => :'Boolean',
|
|
81
116
|
:'visible_dts' => :'String'
|
|
@@ -109,6 +144,10 @@ module UltracartClient
|
|
|
109
144
|
end
|
|
110
145
|
end
|
|
111
146
|
|
|
147
|
+
if attributes.key?(:'blog_post_template')
|
|
148
|
+
self.blog_post_template = attributes[:'blog_post_template']
|
|
149
|
+
end
|
|
150
|
+
|
|
112
151
|
if attributes.key?(:'description')
|
|
113
152
|
self.description = attributes[:'description']
|
|
114
153
|
end
|
|
@@ -125,16 +164,40 @@ module UltracartClient
|
|
|
125
164
|
self.item_template = attributes[:'item_template']
|
|
126
165
|
end
|
|
127
166
|
|
|
167
|
+
if attributes.key?(:'items_per_page')
|
|
168
|
+
self.items_per_page = attributes[:'items_per_page']
|
|
169
|
+
end
|
|
170
|
+
|
|
128
171
|
if attributes.key?(:'multimedia')
|
|
129
172
|
if (value = attributes[:'multimedia']).is_a?(Array)
|
|
130
173
|
self.multimedia = value
|
|
131
174
|
end
|
|
132
175
|
end
|
|
133
176
|
|
|
177
|
+
if attributes.key?(:'page_type')
|
|
178
|
+
self.page_type = attributes[:'page_type']
|
|
179
|
+
end
|
|
180
|
+
|
|
134
181
|
if attributes.key?(:'path')
|
|
135
182
|
self.path = attributes[:'path']
|
|
136
183
|
end
|
|
137
184
|
|
|
185
|
+
if attributes.key?(:'review_template')
|
|
186
|
+
self.review_template = attributes[:'review_template']
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
if attributes.key?(:'sort_order')
|
|
190
|
+
self.sort_order = attributes[:'sort_order']
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
if attributes.key?(:'sort_order_child_groups')
|
|
194
|
+
self.sort_order_child_groups = attributes[:'sort_order_child_groups']
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
if attributes.key?(:'sort_order_child_items')
|
|
198
|
+
self.sort_order_child_items = attributes[:'sort_order_child_items']
|
|
199
|
+
end
|
|
200
|
+
|
|
138
201
|
if attributes.key?(:'title')
|
|
139
202
|
self.title = attributes[:'title']
|
|
140
203
|
end
|
|
@@ -167,12 +230,19 @@ module UltracartClient
|
|
|
167
230
|
return true if self.equal?(o)
|
|
168
231
|
self.class == o.class &&
|
|
169
232
|
attributes == o.attributes &&
|
|
233
|
+
blog_post_template == o.blog_post_template &&
|
|
170
234
|
description == o.description &&
|
|
171
235
|
exclude_from_sitemap == o.exclude_from_sitemap &&
|
|
172
236
|
group_template == o.group_template &&
|
|
173
237
|
item_template == o.item_template &&
|
|
238
|
+
items_per_page == o.items_per_page &&
|
|
174
239
|
multimedia == o.multimedia &&
|
|
240
|
+
page_type == o.page_type &&
|
|
175
241
|
path == o.path &&
|
|
242
|
+
review_template == o.review_template &&
|
|
243
|
+
sort_order == o.sort_order &&
|
|
244
|
+
sort_order_child_groups == o.sort_order_child_groups &&
|
|
245
|
+
sort_order_child_items == o.sort_order_child_items &&
|
|
176
246
|
title == o.title &&
|
|
177
247
|
visible == o.visible &&
|
|
178
248
|
visible_dts == o.visible_dts
|
|
@@ -187,7 +257,7 @@ module UltracartClient
|
|
|
187
257
|
# Calculates hash code according to all attributes.
|
|
188
258
|
# @return [Integer] Hash code
|
|
189
259
|
def hash
|
|
190
|
-
[attributes, description, exclude_from_sitemap, group_template, item_template, multimedia, path, title, visible, visible_dts].hash
|
|
260
|
+
[attributes, blog_post_template, description, exclude_from_sitemap, group_template, item_template, items_per_page, multimedia, page_type, path, review_template, sort_order, sort_order_child_groups, sort_order_child_items, title, visible, visible_dts].hash
|
|
191
261
|
end
|
|
192
262
|
|
|
193
263
|
# Builds the object from hash
|
|
@@ -42,6 +42,8 @@ module UltracartClient
|
|
|
42
42
|
# True when this token may write. Writing a target that is not currently live needs only this.
|
|
43
43
|
attr_accessor :can_write
|
|
44
44
|
|
|
45
|
+
attr_accessor :cli_access
|
|
46
|
+
|
|
45
47
|
# Device scope name, when this is a device flow token.
|
|
46
48
|
attr_accessor :device_scope
|
|
47
49
|
|
|
@@ -75,6 +77,7 @@ module UltracartClient
|
|
|
75
77
|
:'can_read' => :'can_read',
|
|
76
78
|
:'can_read_items' => :'can_read_items',
|
|
77
79
|
:'can_write' => :'can_write',
|
|
80
|
+
:'cli_access' => :'cli_access',
|
|
78
81
|
:'device_scope' => :'device_scope',
|
|
79
82
|
:'login' => :'login',
|
|
80
83
|
:'merchant_id' => :'merchant_id',
|
|
@@ -102,6 +105,7 @@ module UltracartClient
|
|
|
102
105
|
:'can_read' => :'Boolean',
|
|
103
106
|
:'can_read_items' => :'Boolean',
|
|
104
107
|
:'can_write' => :'Boolean',
|
|
108
|
+
:'cli_access' => :'SfvbCliAccess',
|
|
105
109
|
:'device_scope' => :'String',
|
|
106
110
|
:'login' => :'String',
|
|
107
111
|
:'merchant_id' => :'String',
|
|
@@ -169,6 +173,10 @@ module UltracartClient
|
|
|
169
173
|
self.can_write = attributes[:'can_write']
|
|
170
174
|
end
|
|
171
175
|
|
|
176
|
+
if attributes.key?(:'cli_access')
|
|
177
|
+
self.cli_access = attributes[:'cli_access']
|
|
178
|
+
end
|
|
179
|
+
|
|
172
180
|
if attributes.key?(:'device_scope')
|
|
173
181
|
self.device_scope = attributes[:'device_scope']
|
|
174
182
|
end
|
|
@@ -229,6 +237,7 @@ module UltracartClient
|
|
|
229
237
|
can_read == o.can_read &&
|
|
230
238
|
can_read_items == o.can_read_items &&
|
|
231
239
|
can_write == o.can_write &&
|
|
240
|
+
cli_access == o.cli_access &&
|
|
232
241
|
device_scope == o.device_scope &&
|
|
233
242
|
login == o.login &&
|
|
234
243
|
merchant_id == o.merchant_id &&
|
|
@@ -247,7 +256,7 @@ module UltracartClient
|
|
|
247
256
|
# Calculates hash code according to all attributes.
|
|
248
257
|
# @return [Integer] Hash code
|
|
249
258
|
def hash
|
|
250
|
-
[acting_as_user, application_name, authentication_type, can_edit_items, can_publish, can_publish_public, can_read, can_read_items, can_write, device_scope, login, merchant_id, scopes, storefronts, storefronts_withheld, user_name].hash
|
|
259
|
+
[acting_as_user, application_name, authentication_type, can_edit_items, can_publish, can_publish_public, can_read, can_read_items, can_write, cli_access, device_scope, login, merchant_id, scopes, storefronts, storefronts_withheld, user_name].hash
|
|
251
260
|
end
|
|
252
261
|
|
|
253
262
|
# Builds the object from hash
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -1004,6 +1004,7 @@ require 'ultracart_api/models/sfvb_campaign'
|
|
|
1004
1004
|
require 'ultracart_api/models/sfvb_campaign_membership'
|
|
1005
1005
|
require 'ultracart_api/models/sfvb_campaign_write_request'
|
|
1006
1006
|
require 'ultracart_api/models/sfvb_campaigns_response'
|
|
1007
|
+
require 'ultracart_api/models/sfvb_cli_access'
|
|
1007
1008
|
require 'ultracart_api/models/sfvb_code_library_email'
|
|
1008
1009
|
require 'ultracart_api/models/sfvb_code_library_emails_response'
|
|
1009
1010
|
require 'ultracart_api/models/sfvb_comms_branch_stat'
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.1.
|
|
4
|
+
version: 4.1.244
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
@@ -1066,6 +1066,7 @@ files:
|
|
|
1066
1066
|
- docs/SfvbCampaignMembership.md
|
|
1067
1067
|
- docs/SfvbCampaignWriteRequest.md
|
|
1068
1068
|
- docs/SfvbCampaignsResponse.md
|
|
1069
|
+
- docs/SfvbCliAccess.md
|
|
1069
1070
|
- docs/SfvbCodeLibraryEmail.md
|
|
1070
1071
|
- docs/SfvbCodeLibraryEmailsResponse.md
|
|
1071
1072
|
- docs/SfvbCommsBranchStat.md
|
|
@@ -2568,6 +2569,7 @@ files:
|
|
|
2568
2569
|
- lib/ultracart_api/models/sfvb_campaign_membership.rb
|
|
2569
2570
|
- lib/ultracart_api/models/sfvb_campaign_write_request.rb
|
|
2570
2571
|
- lib/ultracart_api/models/sfvb_campaigns_response.rb
|
|
2572
|
+
- lib/ultracart_api/models/sfvb_cli_access.rb
|
|
2571
2573
|
- lib/ultracart_api/models/sfvb_code_library_email.rb
|
|
2572
2574
|
- lib/ultracart_api/models/sfvb_code_library_emails_response.rb
|
|
2573
2575
|
- lib/ultracart_api/models/sfvb_comms_branch_stat.rb
|