ultracart_api 4.1.241 → 4.1.242
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 +6 -2
- data/docs/SfvbApi.md +59 -3
- data/docs/SfvbFileContentResponse.md +2 -0
- data/docs/SfvbFileSearchRequest.md +1 -1
- data/docs/SfvbTheme.md +4 -0
- data/docs/SfvbThemeChangeLogEntry.md +20 -0
- data/docs/SfvbThemeDuplicateRequest.md +3 -1
- data/docs/SfvbThemeJobResponse.md +8 -2
- data/docs/SfvbThemeUpgradeCheckResponse.md +40 -0
- data/docs/SfvbThemesResponse.md +4 -0
- data/lib/ultracart_api/api/sfvb_api.rb +79 -6
- data/lib/ultracart_api/models/sfvb_file_content_response.rb +11 -1
- data/lib/ultracart_api/models/sfvb_file_search_request.rb +1 -1
- data/lib/ultracart_api/models/sfvb_theme.rb +21 -1
- data/lib/ultracart_api/models/sfvb_theme_change_log_entry.rb +232 -0
- data/lib/ultracart_api/models/sfvb_theme_duplicate_request.rb +14 -4
- data/lib/ultracart_api/models/sfvb_theme_job_response.rb +37 -5
- data/lib/ultracart_api/models/sfvb_theme_upgrade_check_response.rb +344 -0
- data/lib/ultracart_api/models/sfvb_themes_response.rb +21 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +2 -0
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f0c5e04f0928ade94967a6ca8f26d32ed5641d810d38a44437d939a44fe80a6e
|
|
4
|
+
data.tar.gz: 57f0ff5f207dc57abc0739776bfa93dc67c33d68c0cbc80fa43df9eebc00ca89
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a207fdfc99800633a71b3fd967f36906004be2c32fbcd47d297a2712379937f8d31b08b9c3a90f85fb6dc6226616d1c004c3ba99a6e2f67bbd6afd3be611ef61
|
|
7
|
+
data.tar.gz: 151980c276255133bd262cd3943d8272264e644ff5f774bbd8196a8b1b56bd1a0df3ad421d88502cfc62db9409112bed758a274288937ce42345cbd8d2aab840
|
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.242
|
|
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.242'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -628,6 +628,7 @@ Class | Method | HTTP request | Description
|
|
|
628
628
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
|
|
629
629
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme_attributes**](docs/SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings
|
|
630
630
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme_job**](docs/SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job
|
|
631
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_theme_upgrade_check**](docs/SfvbApi.md#get_sfvb_theme_upgrade_check) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/upgrade_check | Check what upgrading a theme would do
|
|
631
632
|
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_check_plan**](docs/SfvbApi.md#get_sfvb_tracking_check_plan) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/check_plan | Plan a browser check of a storefront's tracking
|
|
632
633
|
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_html**](docs/SfvbApi.md#get_sfvb_tracking_html) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Read one custom tracking HTML slot
|
|
633
634
|
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_html_slots**](docs/SfvbApi.md#get_sfvb_tracking_html_slots) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html | List a storefront's custom tracking HTML slots
|
|
@@ -2349,10 +2350,12 @@ Class | Method | HTTP request | Description
|
|
|
2349
2350
|
- [UltracartClient::SfvbThemeAttributeUpdate](docs/SfvbThemeAttributeUpdate.md)
|
|
2350
2351
|
- [UltracartClient::SfvbThemeAttributeUpdateRequest](docs/SfvbThemeAttributeUpdateRequest.md)
|
|
2351
2352
|
- [UltracartClient::SfvbThemeAttributesResponse](docs/SfvbThemeAttributesResponse.md)
|
|
2353
|
+
- [UltracartClient::SfvbThemeChangeLogEntry](docs/SfvbThemeChangeLogEntry.md)
|
|
2352
2354
|
- [UltracartClient::SfvbThemeDuplicateRequest](docs/SfvbThemeDuplicateRequest.md)
|
|
2353
2355
|
- [UltracartClient::SfvbThemeFont](docs/SfvbThemeFont.md)
|
|
2354
2356
|
- [UltracartClient::SfvbThemeFontFamily](docs/SfvbThemeFontFamily.md)
|
|
2355
2357
|
- [UltracartClient::SfvbThemeJobResponse](docs/SfvbThemeJobResponse.md)
|
|
2358
|
+
- [UltracartClient::SfvbThemeUpgradeCheckResponse](docs/SfvbThemeUpgradeCheckResponse.md)
|
|
2356
2359
|
- [UltracartClient::SfvbThemesResponse](docs/SfvbThemesResponse.md)
|
|
2357
2360
|
- [UltracartClient::SfvbTrackingAdvanced](docs/SfvbTrackingAdvanced.md)
|
|
2358
2361
|
- [UltracartClient::SfvbTrackingAdvancedRequest](docs/SfvbTrackingAdvancedRequest.md)
|
|
@@ -2580,6 +2583,7 @@ Not every change is committed to every SDK.
|
|
|
2580
2583
|
|
|
2581
2584
|
| Version | Date | Comments |
|
|
2582
2585
|
| --: | :-: | --- |
|
|
2586
|
+
| 4.1.242 | 11/11/2026 | sfvb internal testing |
|
|
2583
2587
|
| 4.1.241 | 11/10/2026 | sfvb internal testing |
|
|
2584
2588
|
| 4.1.240 | 11/10/2026 | sfvb internal testing |
|
|
2585
2589
|
| 4.1.239 | 11/10/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -156,6 +156,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
156
156
|
| [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
|
|
157
157
|
| [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
|
|
158
158
|
| [**get_sfvb_theme_job**](SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job |
|
|
159
|
+
| [**get_sfvb_theme_upgrade_check**](SfvbApi.md#get_sfvb_theme_upgrade_check) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/upgrade_check | Check what upgrading a theme would do |
|
|
159
160
|
| [**get_sfvb_tracking_check_plan**](SfvbApi.md#get_sfvb_tracking_check_plan) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/check_plan | Plan a browser check of a storefront's tracking |
|
|
160
161
|
| [**get_sfvb_tracking_html**](SfvbApi.md#get_sfvb_tracking_html) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Read one custom tracking HTML slot |
|
|
161
162
|
| [**get_sfvb_tracking_html_slots**](SfvbApi.md#get_sfvb_tracking_html_slots) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html | List a storefront's custom tracking HTML slots |
|
|
@@ -3158,7 +3159,7 @@ end
|
|
|
3158
3159
|
|
|
3159
3160
|
Duplicate a theme
|
|
3160
3161
|
|
|
3161
|
-
Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it.
|
|
3162
|
+
Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3162
3163
|
|
|
3163
3164
|
|
|
3164
3165
|
### Examples
|
|
@@ -8514,7 +8515,7 @@ end
|
|
|
8514
8515
|
|
|
8515
8516
|
Status of an asynchronous theme job
|
|
8516
8517
|
|
|
8517
|
-
Poll until complete is true, then check success.
|
|
8518
|
+
Poll until complete is true, then check success. A successful job reports the new theme as theme_oid. After a duplicate with upgrade_to_version, success also means the copy reached that version, and merge_conflicts lists the copy's files that still need resolving - read fresh on every poll.
|
|
8518
8519
|
|
|
8519
8520
|
|
|
8520
8521
|
### Examples
|
|
@@ -8562,6 +8563,61 @@ end
|
|
|
8562
8563
|
- **Accept**: application/json
|
|
8563
8564
|
|
|
8564
8565
|
|
|
8566
|
+
## get_sfvb_theme_upgrade_check
|
|
8567
|
+
|
|
8568
|
+
> <SfvbThemeUpgradeCheckResponse> get_sfvb_theme_upgrade_check(storefront_oid, theme_oid, opts)
|
|
8569
|
+
|
|
8570
|
+
Check what upgrading a theme would do
|
|
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.
|
|
8573
|
+
|
|
8574
|
+
|
|
8575
|
+
### Examples
|
|
8576
|
+
|
|
8577
|
+
|
|
8578
|
+
(No example for this operation).
|
|
8579
|
+
|
|
8580
|
+
|
|
8581
|
+
#### Using the get_sfvb_theme_upgrade_check_with_http_info variant
|
|
8582
|
+
|
|
8583
|
+
This returns an Array which contains the response data, status code and headers.
|
|
8584
|
+
|
|
8585
|
+
> <Array(<SfvbThemeUpgradeCheckResponse>, Integer, Hash)> get_sfvb_theme_upgrade_check_with_http_info(storefront_oid, theme_oid, opts)
|
|
8586
|
+
|
|
8587
|
+
```ruby
|
|
8588
|
+
begin
|
|
8589
|
+
# Check what upgrading a theme would do
|
|
8590
|
+
data, status_code, headers = api_instance.get_sfvb_theme_upgrade_check_with_http_info(storefront_oid, theme_oid, opts)
|
|
8591
|
+
p status_code # => 2xx
|
|
8592
|
+
p headers # => { ... }
|
|
8593
|
+
p data # => <SfvbThemeUpgradeCheckResponse>
|
|
8594
|
+
rescue UltracartClient::ApiError => e
|
|
8595
|
+
puts "Error when calling SfvbApi->get_sfvb_theme_upgrade_check_with_http_info: #{e}"
|
|
8596
|
+
end
|
|
8597
|
+
```
|
|
8598
|
+
|
|
8599
|
+
### Parameters
|
|
8600
|
+
|
|
8601
|
+
| Name | Type | Description | Notes |
|
|
8602
|
+
| ---- | ---- | ----------- | ----- |
|
|
8603
|
+
| **storefront_oid** | **Integer** | | |
|
|
8604
|
+
| **theme_oid** | **Integer** | | |
|
|
8605
|
+
| **version** | **String** | | [optional] |
|
|
8606
|
+
|
|
8607
|
+
### Return type
|
|
8608
|
+
|
|
8609
|
+
[**SfvbThemeUpgradeCheckResponse**](SfvbThemeUpgradeCheckResponse.md)
|
|
8610
|
+
|
|
8611
|
+
### Authorization
|
|
8612
|
+
|
|
8613
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
8614
|
+
|
|
8615
|
+
### HTTP request headers
|
|
8616
|
+
|
|
8617
|
+
- **Content-Type**: Not defined
|
|
8618
|
+
- **Accept**: application/json
|
|
8619
|
+
|
|
8620
|
+
|
|
8565
8621
|
## get_sfvb_tracking_check_plan
|
|
8566
8622
|
|
|
8567
8623
|
> <SfvbTrackingCheckPlan> get_sfvb_tracking_check_plan(storefront_oid, path, opts)
|
|
@@ -14289,7 +14345,7 @@ end
|
|
|
14289
14345
|
|
|
14290
14346
|
Search storefront files
|
|
14291
14347
|
|
|
14292
|
-
Searches names and, when text is supplied, file contents. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported.
|
|
14348
|
+
Searches names and, when text is supplied, file contents. Text search covers text files, including .cjson and .json, and skips binaries such as images, fonts and PDFs. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported. merge_conflicts true with a theme's path lists the files an upgrade left with unresolved conflicts, as the admin file manager's merge conflicts search does.
|
|
14293
14349
|
|
|
14294
14350
|
|
|
14295
14351
|
### Examples
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **content** | **String** | UTF-8 content. Only text/* files can be read this way. | [optional] |
|
|
9
9
|
| **fs_file_oid** | **Integer** | StoreFront file system file oid. | [optional] |
|
|
10
10
|
| **hash_sha256** | **String** | SHA-256 of the content. Send this back as If-Match when writing. The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so this body value is the authoritative one. Both forms are accepted on write. | [optional] |
|
|
11
|
+
| **merge_conflict** | **Boolean** | True when a theme upgrade left unresolved merge conflicts in this file. The content holds conflict marker lines. Resolve each conflict and save the file without any marker lines to clear it - a save that still has marker lines is refused. | [optional] |
|
|
11
12
|
| **mime_type** | **String** | Mime type. | [optional] |
|
|
12
13
|
| **path** | **String** | Full path of the file. | [optional] |
|
|
13
14
|
| **size** | **Integer** | Size in bytes. | [optional] |
|
|
@@ -26,6 +27,7 @@ instance = UltracartClient::SfvbFileContentResponse.new(
|
|
|
26
27
|
content: null,
|
|
27
28
|
fs_file_oid: null,
|
|
28
29
|
hash_sha256: null,
|
|
30
|
+
merge_conflict: null,
|
|
29
31
|
mime_type: null,
|
|
30
32
|
path: null,
|
|
31
33
|
size: null,
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
| **size_max** | **Integer** | Maximum size in bytes. | [optional] |
|
|
20
20
|
| **size_min** | **Integer** | Minimum size in bytes. | [optional] |
|
|
21
21
|
| **sub_directories** | **Boolean** | Recurse below path. Defaults to true. | [optional] |
|
|
22
|
-
| **text** | **String** | Text to find inside files.
|
|
22
|
+
| **text** | **String** | Text to find inside files. Text files are searched, including .cjson and .json; binaries such as images, fonts and PDFs are skipped. This is the expensive filter; narrow with path or file_name where possible. | [optional] |
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
data/docs/SfvbTheme.md
CHANGED
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
| **active** | **Boolean** | True when this theme is the one serving live traffic. Writing to an active theme requires the sfvb_publish scope. | [optional] |
|
|
8
8
|
| **description** | **String** | What the theme is, where the author supplied a description. | [optional] |
|
|
9
9
|
| **fs_directory_oid** | **Integer** | Oid of the theme root directory in the storefront file system. | [optional] |
|
|
10
|
+
| **merge_conflict_count** | **Integer** | How many of the theme's files still have unresolved merge conflicts from an upgrade. Find them with searchSfvbFiles, merge_conflicts true and this theme's path. | [optional] |
|
|
11
|
+
| **ok_to_activate** | **Boolean** | False while any file in the theme has an unresolved merge conflict. Never activate a theme that reports false - resolve every conflict first. Activation itself happens in the UltraCart admin, which runs the same check. | [optional] |
|
|
10
12
|
| **path** | **String** | Root path of the theme in the storefront file system, for example /themes/mytheme/ | [optional] |
|
|
11
13
|
| **storefront_oid** | **Integer** | StoreFront oid this theme belongs to. | [optional] |
|
|
12
14
|
| **theme_name** | **String** | Theme name. | [optional] |
|
|
@@ -24,6 +26,8 @@ instance = UltracartClient::SfvbTheme.new(
|
|
|
24
26
|
active: null,
|
|
25
27
|
description: null,
|
|
26
28
|
fs_directory_oid: null,
|
|
29
|
+
merge_conflict_count: null,
|
|
30
|
+
ok_to_activate: null,
|
|
27
31
|
path: null,
|
|
28
32
|
storefront_oid: null,
|
|
29
33
|
theme_name: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbThemeChangeLogEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **changes** | **Array<String>** | What changed in this version, each as category - description. | [optional] |
|
|
8
|
+
| **version** | **String** | Theme version this entry describes. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbThemeChangeLogEntry.new(
|
|
16
|
+
changes: null,
|
|
17
|
+
version: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **folder** | **String** | Directory name for the new theme under /themes/. Letters and numbers, one path segment. Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for. Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made. | [optional] |
|
|
8
8
|
| **target_storefront_oid** | **Integer** | Storefront to create the copy on. Defaults to the storefront in the path. Supply it only when copying a theme between storefronts you own. | [optional] |
|
|
9
9
|
| **theme_name** | **String** | Name for the new theme. | [optional] |
|
|
10
|
+
| **upgrade_to_version** | **String** | Upgrade the copy to this theme version after copying it, as the admin's Duplicate and Upgrade does. Only the copy is upgraded - the source theme is never touched. Must be one of the available_versions from getSfvbThemeUpgradeCheck, which also predicts the merge conflicts. Omit for a plain copy. | [optional] |
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,7 +17,8 @@ require 'ultracart_api'
|
|
|
16
17
|
instance = UltracartClient::SfvbThemeDuplicateRequest.new(
|
|
17
18
|
folder: null,
|
|
18
19
|
target_storefront_oid: null,
|
|
19
|
-
theme_name: null
|
|
20
|
+
theme_name: null,
|
|
21
|
+
upgrade_to_version: null
|
|
20
22
|
)
|
|
21
23
|
```
|
|
22
24
|
|
|
@@ -9,13 +9,16 @@
|
|
|
9
9
|
| **error_message** | **String** | What to do next when the job did not produce a theme. The internal cause is not returned; it is recorded against the job id in the server log. | [optional] |
|
|
10
10
|
| **finished_dts** | **String** | When the job stopped, ISO 8601 UTC. Null until it does. | [optional] |
|
|
11
11
|
| **job_id** | **Integer** | Job handle. Poll getSfvbThemeJob with this. | [optional] |
|
|
12
|
+
| **merge_conflicts** | **Array<String>** | Paths of the copy's files that still have unresolved merge conflicts, read fresh on every poll, so the list shrinks as you resolve them. Each needs its conflict marker lines resolved and the file saved before the theme can be activated. Empty when there are none. | [optional] |
|
|
12
13
|
| **progress** | **Integer** | Percent complete, 0-100. | [optional] |
|
|
13
14
|
| **progress_description** | **String** | What the job is doing right now, for example 'Duplicating locale text'. | [optional] |
|
|
14
15
|
| **started_dts** | **String** | When the job started running, ISO 8601 UTC. Null until it does. | [optional] |
|
|
15
16
|
| **status** | **String** | Raw job status. | [optional] |
|
|
16
17
|
| **submitted_dts** | **String** | When the job was queued, ISO 8601 UTC. | [optional] |
|
|
17
18
|
| **success** | **Boolean** | True only when the job finished successfully. Check complete first. | [optional] |
|
|
18
|
-
| **target_path** | **String** | Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it.
|
|
19
|
+
| **target_path** | **String** | Path the new theme is being created at. Returned when the job is started and on every poll, so you do not have to keep the response that started it. Once the job completes, the theme found at this path is reported as theme_oid. It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending. | [optional] |
|
|
20
|
+
| **theme_oid** | **Integer** | Oid of the theme the job created, once it is complete and the theme exists. Null until then. | [optional] |
|
|
21
|
+
| **upgrade_to_version** | **String** | The version the copy was asked to be upgraded to, when the duplicate asked for an upgrade. Null for a plain copy. A complete job reports success only when the copy is at this version. | [optional] |
|
|
19
22
|
|
|
20
23
|
## Example
|
|
21
24
|
|
|
@@ -28,13 +31,16 @@ instance = UltracartClient::SfvbThemeJobResponse.new(
|
|
|
28
31
|
error_message: null,
|
|
29
32
|
finished_dts: null,
|
|
30
33
|
job_id: null,
|
|
34
|
+
merge_conflicts: null,
|
|
31
35
|
progress: null,
|
|
32
36
|
progress_description: null,
|
|
33
37
|
started_dts: null,
|
|
34
38
|
status: null,
|
|
35
39
|
submitted_dts: null,
|
|
36
40
|
success: null,
|
|
37
|
-
target_path: null
|
|
41
|
+
target_path: null,
|
|
42
|
+
theme_oid: null,
|
|
43
|
+
upgrade_to_version: null
|
|
38
44
|
)
|
|
39
45
|
```
|
|
40
46
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# UltracartClient::SfvbThemeUpgradeCheckResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **available_versions** | **Array<String>** | Newer versions this account may upgrade to, oldest first. Pass one as upgrade_to_version on duplicateSfvbTheme. | [optional] |
|
|
8
|
+
| **can_duplicate_and_upgrade** | **Boolean** | True when duplicateSfvbTheme with upgrade_to_version set to to_version will be accepted. When false, reason says why. | [optional] |
|
|
9
|
+
| **change_log** | [**Array<SfvbThemeChangeLogEntry>**](SfvbThemeChangeLogEntry.md) | What changed in each version after the theme's current one, up to to_version. | [optional] |
|
|
10
|
+
| **customized_files** | **Array<String>** | The theme's files that were edited after the theme was installed or last upgraded. Only these can merge, conflict or be overwritten - every other file is simply replaced with the new version's. | [optional] |
|
|
11
|
+
| **existing_merge_conflicts** | **Array<String>** | Files in this theme that still have unresolved conflicts from an earlier upgrade. While any exist the theme can't be upgraded again, and the predicted lists above are empty. | [optional] |
|
|
12
|
+
| **files_merged** | **Array<String>** | Customized files the upgrade would merge with the new version cleanly. Worth reviewing after the upgrade, but nothing to resolve. | [optional] |
|
|
13
|
+
| **files_overwritten** | **Array<String>** | Customized files that can't be merged (not a text type that merges) and are replaced by the new version's, losing the edits. Copy anything you need from them first. | [optional] |
|
|
14
|
+
| **files_with_merge_conflicts** | **Array<String>** | Customized files whose edits collide with the new version. The upgrade writes them with conflict marker lines and flags them, and the theme can't be activated until each is resolved. | [optional] |
|
|
15
|
+
| **from_version** | **String** | The theme's current version. | [optional] |
|
|
16
|
+
| **reason** | **String** | Why can_duplicate_and_upgrade is false. Null when it is true. | [optional] |
|
|
17
|
+
| **theme_oid** | **Integer** | The theme that was checked. | [optional] |
|
|
18
|
+
| **to_version** | **String** | The version the check was run against. Null when no upgrade is available. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'ultracart_api'
|
|
24
|
+
|
|
25
|
+
instance = UltracartClient::SfvbThemeUpgradeCheckResponse.new(
|
|
26
|
+
available_versions: null,
|
|
27
|
+
can_duplicate_and_upgrade: null,
|
|
28
|
+
change_log: null,
|
|
29
|
+
customized_files: null,
|
|
30
|
+
existing_merge_conflicts: null,
|
|
31
|
+
files_merged: null,
|
|
32
|
+
files_overwritten: null,
|
|
33
|
+
files_with_merge_conflicts: null,
|
|
34
|
+
from_version: null,
|
|
35
|
+
reason: null,
|
|
36
|
+
theme_oid: null,
|
|
37
|
+
to_version: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
data/docs/SfvbThemesResponse.md
CHANGED
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **active_theme_oid** | **Integer** | Oid of the active theme, repeated here so a caller does not have to scan the list. | [optional] |
|
|
8
|
+
| **theme_count** | **Integer** | How many themes the storefront holds now. When it equals theme_limit, delete an inactive theme in the admin before duplicating. | [optional] |
|
|
9
|
+
| **theme_limit** | **Integer** | Most themes a storefront can hold, active and inactive together. A duplicate or install at the limit is refused with sfvb.theme_limit_reached. | [optional] |
|
|
8
10
|
| **themes** | [**Array<SfvbTheme>**](SfvbTheme.md) | Themes belonging to the storefront. Exactly one is flagged active. | [optional] |
|
|
9
11
|
|
|
10
12
|
## Example
|
|
@@ -14,6 +16,8 @@ require 'ultracart_api'
|
|
|
14
16
|
|
|
15
17
|
instance = UltracartClient::SfvbThemesResponse.new(
|
|
16
18
|
active_theme_oid: null,
|
|
19
|
+
theme_count: null,
|
|
20
|
+
theme_limit: null,
|
|
17
21
|
themes: null
|
|
18
22
|
)
|
|
19
23
|
```
|
|
@@ -3939,7 +3939,7 @@ module UltracartClient
|
|
|
3939
3939
|
end
|
|
3940
3940
|
|
|
3941
3941
|
# Duplicate a theme
|
|
3942
|
-
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it.
|
|
3942
|
+
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3943
3943
|
# @param storefront_oid [Integer]
|
|
3944
3944
|
# @param theme_oid [Integer]
|
|
3945
3945
|
# @param duplicate_request [SfvbThemeDuplicateRequest] Theme duplication details
|
|
@@ -3951,7 +3951,7 @@ module UltracartClient
|
|
|
3951
3951
|
end
|
|
3952
3952
|
|
|
3953
3953
|
# Duplicate a theme
|
|
3954
|
-
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it.
|
|
3954
|
+
# Copies a theme into a new one and returns a job handle to poll. Asynchronous, because copying a theme copies every file in it. Needs sfvb_write rather than sfvb_publish, because the job explicitly does not activate what it creates, so the worst outcome of a mistaken call is a spare theme. This is how you get somewhere safe to work - duplicate, edit the copy with an ordinary write scope, and let a human promote it. Set upgrade_to_version to also upgrade the copy to a newer theme version, as the admin's Duplicate and Upgrade does - only the copy is upgraded. Run getSfvbThemeUpgradeCheck first to see the available versions and the merge conflicts the upgrade will leave, then resolve those in the copy before anyone activates it. Refused with sfvb.theme_limit_reached at the storefront's theme limit, sfvb.theme_upgrade_unavailable for a version that can't be used, and sfvb.theme_merge_conflicts while the source theme has unresolved conflicts.
|
|
3955
3955
|
# @param storefront_oid [Integer]
|
|
3956
3956
|
# @param theme_oid [Integer]
|
|
3957
3957
|
# @param duplicate_request [SfvbThemeDuplicateRequest] Theme duplication details
|
|
@@ -10802,7 +10802,7 @@ module UltracartClient
|
|
|
10802
10802
|
end
|
|
10803
10803
|
|
|
10804
10804
|
# Status of an asynchronous theme job
|
|
10805
|
-
# Poll until complete is true, then check success.
|
|
10805
|
+
# Poll until complete is true, then check success. A successful job reports the new theme as theme_oid. After a duplicate with upgrade_to_version, success also means the copy reached that version, and merge_conflicts lists the copy's files that still need resolving - read fresh on every poll.
|
|
10806
10806
|
# @param storefront_oid [Integer]
|
|
10807
10807
|
# @param job_id [Integer]
|
|
10808
10808
|
# @param [Hash] opts the optional parameters
|
|
@@ -10813,7 +10813,7 @@ module UltracartClient
|
|
|
10813
10813
|
end
|
|
10814
10814
|
|
|
10815
10815
|
# Status of an asynchronous theme job
|
|
10816
|
-
# Poll until complete is true, then check success.
|
|
10816
|
+
# Poll until complete is true, then check success. A successful job reports the new theme as theme_oid. After a duplicate with upgrade_to_version, success also means the copy reached that version, and merge_conflicts lists the copy's files that still need resolving - read fresh on every poll.
|
|
10817
10817
|
# @param storefront_oid [Integer]
|
|
10818
10818
|
# @param job_id [Integer]
|
|
10819
10819
|
# @param [Hash] opts the optional parameters
|
|
@@ -10871,6 +10871,79 @@ module UltracartClient
|
|
|
10871
10871
|
return data, status_code, headers
|
|
10872
10872
|
end
|
|
10873
10873
|
|
|
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.
|
|
10876
|
+
# @param storefront_oid [Integer]
|
|
10877
|
+
# @param theme_oid [Integer]
|
|
10878
|
+
# @param [Hash] opts the optional parameters
|
|
10879
|
+
# @option opts [String] :version
|
|
10880
|
+
# @return [SfvbThemeUpgradeCheckResponse]
|
|
10881
|
+
def get_sfvb_theme_upgrade_check(storefront_oid, theme_oid, opts = {})
|
|
10882
|
+
data, _status_code, _headers = get_sfvb_theme_upgrade_check_with_http_info(storefront_oid, theme_oid, opts)
|
|
10883
|
+
data
|
|
10884
|
+
end
|
|
10885
|
+
|
|
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.
|
|
10888
|
+
# @param storefront_oid [Integer]
|
|
10889
|
+
# @param theme_oid [Integer]
|
|
10890
|
+
# @param [Hash] opts the optional parameters
|
|
10891
|
+
# @option opts [String] :version
|
|
10892
|
+
# @return [Array<(SfvbThemeUpgradeCheckResponse, Integer, Hash)>] SfvbThemeUpgradeCheckResponse data, response status code and response headers
|
|
10893
|
+
def get_sfvb_theme_upgrade_check_with_http_info(storefront_oid, theme_oid, opts = {})
|
|
10894
|
+
if @api_client.config.debugging
|
|
10895
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_theme_upgrade_check ...'
|
|
10896
|
+
end
|
|
10897
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10898
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10899
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_theme_upgrade_check"
|
|
10900
|
+
end
|
|
10901
|
+
# verify the required parameter 'theme_oid' is set
|
|
10902
|
+
if @api_client.config.client_side_validation && theme_oid.nil?
|
|
10903
|
+
fail ArgumentError, "Missing the required parameter 'theme_oid' when calling SfvbApi.get_sfvb_theme_upgrade_check"
|
|
10904
|
+
end
|
|
10905
|
+
# resource path
|
|
10906
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/upgrade_check'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'theme_oid' + '}', CGI.escape(theme_oid.to_s))
|
|
10907
|
+
|
|
10908
|
+
# query parameters
|
|
10909
|
+
query_params = opts[:query_params] || {}
|
|
10910
|
+
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
10911
|
+
|
|
10912
|
+
# header parameters
|
|
10913
|
+
header_params = opts[:header_params] || {}
|
|
10914
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10915
|
+
# HTTP header 'Accept' (if needed)
|
|
10916
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10917
|
+
|
|
10918
|
+
# form parameters
|
|
10919
|
+
form_params = opts[:form_params] || {}
|
|
10920
|
+
|
|
10921
|
+
# http body (model)
|
|
10922
|
+
post_body = opts[:debug_body]
|
|
10923
|
+
|
|
10924
|
+
# return_type
|
|
10925
|
+
return_type = opts[:debug_return_type] || 'SfvbThemeUpgradeCheckResponse'
|
|
10926
|
+
|
|
10927
|
+
# auth_names
|
|
10928
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10929
|
+
|
|
10930
|
+
new_options = opts.merge(
|
|
10931
|
+
:operation => :"SfvbApi.get_sfvb_theme_upgrade_check",
|
|
10932
|
+
:header_params => header_params,
|
|
10933
|
+
:query_params => query_params,
|
|
10934
|
+
:form_params => form_params,
|
|
10935
|
+
:body => post_body,
|
|
10936
|
+
:auth_names => auth_names,
|
|
10937
|
+
:return_type => return_type
|
|
10938
|
+
)
|
|
10939
|
+
|
|
10940
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
10941
|
+
if @api_client.config.debugging
|
|
10942
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_theme_upgrade_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10943
|
+
end
|
|
10944
|
+
return data, status_code, headers
|
|
10945
|
+
end
|
|
10946
|
+
|
|
10874
10947
|
# Plan a browser check of a storefront's tracking
|
|
10875
10948
|
# What each tracking provider should load on one page, for page_view or a test order's purchase, under a consent state and region, with the requests and calls to look for and the ones that must not appear. Built from the same rules the storefront's tracking templates follow, never by running them, so nothing is sent to any provider. Includes the hosts the storefront's custom and affiliate network HTML loads, the sends made from UltraCart servers, and a snippet that collects what the browser saw. Grade the results locally; they are never sent here. With neither consent nor region, every provider is listed with the gate that holds it back. A purchase needs a test order on this account.
|
|
10876
10949
|
# @param storefront_oid [Integer]
|
|
@@ -18816,7 +18889,7 @@ module UltracartClient
|
|
|
18816
18889
|
end
|
|
18817
18890
|
|
|
18818
18891
|
# Search storefront files
|
|
18819
|
-
# Searches names and, when text is supplied, file contents. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported.
|
|
18892
|
+
# Searches names and, when text is supplied, file contents. Text search covers text files, including .cjson and .json, and skips binaries such as images, fonts and PDFs. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported. merge_conflicts true with a theme's path lists the files an upgrade left with unresolved conflicts, as the admin file manager's merge conflicts search does.
|
|
18820
18893
|
# @param storefront_oid [Integer]
|
|
18821
18894
|
# @param search_request [SfvbFileSearchRequest] File search
|
|
18822
18895
|
# @param [Hash] opts the optional parameters
|
|
@@ -18827,7 +18900,7 @@ module UltracartClient
|
|
|
18827
18900
|
end
|
|
18828
18901
|
|
|
18829
18902
|
# Search storefront files
|
|
18830
|
-
# Searches names and, when text is supplied, file contents. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported.
|
|
18903
|
+
# Searches names and, when text is supplied, file contents. Text search covers text files, including .cjson and .json, and skips binaries such as images, fonts and PDFs. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported. merge_conflicts true with a theme's path lists the files an upgrade left with unresolved conflicts, as the admin file manager's merge conflicts search does.
|
|
18831
18904
|
# @param storefront_oid [Integer]
|
|
18832
18905
|
# @param search_request [SfvbFileSearchRequest] File search
|
|
18833
18906
|
# @param [Hash] opts the optional parameters
|
|
@@ -27,6 +27,9 @@ module UltracartClient
|
|
|
27
27
|
# SHA-256 of the content. Send this back as If-Match when writing. The ETag header carries the same hash, but a compressing proxy may append a suffix such as -gzip to it, so this body value is the authoritative one. Both forms are accepted on write.
|
|
28
28
|
attr_accessor :hash_sha256
|
|
29
29
|
|
|
30
|
+
# True when a theme upgrade left unresolved merge conflicts in this file. The content holds conflict marker lines. Resolve each conflict and save the file without any marker lines to clear it - a save that still has marker lines is refused.
|
|
31
|
+
attr_accessor :merge_conflict
|
|
32
|
+
|
|
30
33
|
# Mime type.
|
|
31
34
|
attr_accessor :mime_type
|
|
32
35
|
|
|
@@ -55,6 +58,7 @@ module UltracartClient
|
|
|
55
58
|
:'content' => :'content',
|
|
56
59
|
:'fs_file_oid' => :'fs_file_oid',
|
|
57
60
|
:'hash_sha256' => :'hash_sha256',
|
|
61
|
+
:'merge_conflict' => :'merge_conflict',
|
|
58
62
|
:'mime_type' => :'mime_type',
|
|
59
63
|
:'path' => :'path',
|
|
60
64
|
:'size' => :'size',
|
|
@@ -77,6 +81,7 @@ module UltracartClient
|
|
|
77
81
|
:'content' => :'String',
|
|
78
82
|
:'fs_file_oid' => :'Integer',
|
|
79
83
|
:'hash_sha256' => :'String',
|
|
84
|
+
:'merge_conflict' => :'Boolean',
|
|
80
85
|
:'mime_type' => :'String',
|
|
81
86
|
:'path' => :'String',
|
|
82
87
|
:'size' => :'Integer',
|
|
@@ -124,6 +129,10 @@ module UltracartClient
|
|
|
124
129
|
self.hash_sha256 = attributes[:'hash_sha256']
|
|
125
130
|
end
|
|
126
131
|
|
|
132
|
+
if attributes.key?(:'merge_conflict')
|
|
133
|
+
self.merge_conflict = attributes[:'merge_conflict']
|
|
134
|
+
end
|
|
135
|
+
|
|
127
136
|
if attributes.key?(:'mime_type')
|
|
128
137
|
self.mime_type = attributes[:'mime_type']
|
|
129
138
|
end
|
|
@@ -175,6 +184,7 @@ module UltracartClient
|
|
|
175
184
|
content == o.content &&
|
|
176
185
|
fs_file_oid == o.fs_file_oid &&
|
|
177
186
|
hash_sha256 == o.hash_sha256 &&
|
|
187
|
+
merge_conflict == o.merge_conflict &&
|
|
178
188
|
mime_type == o.mime_type &&
|
|
179
189
|
path == o.path &&
|
|
180
190
|
size == o.size &&
|
|
@@ -193,7 +203,7 @@ module UltracartClient
|
|
|
193
203
|
# Calculates hash code according to all attributes.
|
|
194
204
|
# @return [Integer] Hash code
|
|
195
205
|
def hash
|
|
196
|
-
[auto_compiled, content, fs_file_oid, hash_sha256, mime_type, path, size, truncated, valid, velocity_errors, version].hash
|
|
206
|
+
[auto_compiled, content, fs_file_oid, hash_sha256, merge_conflict, mime_type, path, size, truncated, valid, velocity_errors, version].hash
|
|
197
207
|
end
|
|
198
208
|
|
|
199
209
|
# Builds the object from hash
|
|
@@ -60,7 +60,7 @@ module UltracartClient
|
|
|
60
60
|
# Recurse below path. Defaults to true.
|
|
61
61
|
attr_accessor :sub_directories
|
|
62
62
|
|
|
63
|
-
# Text to find inside files.
|
|
63
|
+
# Text to find inside files. Text files are searched, including .cjson and .json; binaries such as images, fonts and PDFs are skipped. This is the expensive filter; narrow with path or file_name where possible.
|
|
64
64
|
attr_accessor :text
|
|
65
65
|
|
|
66
66
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -24,6 +24,12 @@ module UltracartClient
|
|
|
24
24
|
# Oid of the theme root directory in the storefront file system.
|
|
25
25
|
attr_accessor :fs_directory_oid
|
|
26
26
|
|
|
27
|
+
# How many of the theme's files still have unresolved merge conflicts from an upgrade. Find them with searchSfvbFiles, merge_conflicts true and this theme's path.
|
|
28
|
+
attr_accessor :merge_conflict_count
|
|
29
|
+
|
|
30
|
+
# False while any file in the theme has an unresolved merge conflict. Never activate a theme that reports false - resolve every conflict first. Activation itself happens in the UltraCart admin, which runs the same check.
|
|
31
|
+
attr_accessor :ok_to_activate
|
|
32
|
+
|
|
27
33
|
# Root path of the theme in the storefront file system, for example /themes/mytheme/
|
|
28
34
|
attr_accessor :path
|
|
29
35
|
|
|
@@ -51,6 +57,8 @@ module UltracartClient
|
|
|
51
57
|
:'active' => :'active',
|
|
52
58
|
:'description' => :'description',
|
|
53
59
|
:'fs_directory_oid' => :'fs_directory_oid',
|
|
60
|
+
:'merge_conflict_count' => :'merge_conflict_count',
|
|
61
|
+
:'ok_to_activate' => :'ok_to_activate',
|
|
54
62
|
:'path' => :'path',
|
|
55
63
|
:'storefront_oid' => :'storefront_oid',
|
|
56
64
|
:'theme_name' => :'theme_name',
|
|
@@ -72,6 +80,8 @@ module UltracartClient
|
|
|
72
80
|
:'active' => :'Boolean',
|
|
73
81
|
:'description' => :'String',
|
|
74
82
|
:'fs_directory_oid' => :'Integer',
|
|
83
|
+
:'merge_conflict_count' => :'Integer',
|
|
84
|
+
:'ok_to_activate' => :'Boolean',
|
|
75
85
|
:'path' => :'String',
|
|
76
86
|
:'storefront_oid' => :'Integer',
|
|
77
87
|
:'theme_name' => :'String',
|
|
@@ -115,6 +125,14 @@ module UltracartClient
|
|
|
115
125
|
self.fs_directory_oid = attributes[:'fs_directory_oid']
|
|
116
126
|
end
|
|
117
127
|
|
|
128
|
+
if attributes.key?(:'merge_conflict_count')
|
|
129
|
+
self.merge_conflict_count = attributes[:'merge_conflict_count']
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
if attributes.key?(:'ok_to_activate')
|
|
133
|
+
self.ok_to_activate = attributes[:'ok_to_activate']
|
|
134
|
+
end
|
|
135
|
+
|
|
118
136
|
if attributes.key?(:'path')
|
|
119
137
|
self.path = attributes[:'path']
|
|
120
138
|
end
|
|
@@ -165,6 +183,8 @@ module UltracartClient
|
|
|
165
183
|
active == o.active &&
|
|
166
184
|
description == o.description &&
|
|
167
185
|
fs_directory_oid == o.fs_directory_oid &&
|
|
186
|
+
merge_conflict_count == o.merge_conflict_count &&
|
|
187
|
+
ok_to_activate == o.ok_to_activate &&
|
|
168
188
|
path == o.path &&
|
|
169
189
|
storefront_oid == o.storefront_oid &&
|
|
170
190
|
theme_name == o.theme_name &&
|
|
@@ -183,7 +203,7 @@ module UltracartClient
|
|
|
183
203
|
# Calculates hash code according to all attributes.
|
|
184
204
|
# @return [Integer] Hash code
|
|
185
205
|
def hash
|
|
186
|
-
[active, description, fs_directory_oid, path, storefront_oid, theme_name, theme_oid, upgrade_available, valid, version].hash
|
|
206
|
+
[active, description, fs_directory_oid, merge_conflict_count, ok_to_activate, path, storefront_oid, theme_name, theme_oid, upgrade_available, valid, version].hash
|
|
187
207
|
end
|
|
188
208
|
|
|
189
209
|
# Builds the object from hash
|