ultracart_api 4.1.173 → 4.1.175
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 +11 -2
- data/docs/SfvbApi.md +112 -1
- data/docs/SfvbPageRefreshRequest.md +18 -0
- data/docs/SfvbPageRefreshResponse.md +26 -0
- data/docs/SfvbTemplateResolveCandidate.md +20 -0
- data/docs/SfvbTemplateResolvePath.md +24 -0
- data/docs/SfvbTemplateResolveResponse.md +30 -0
- data/lib/ultracart_api/api/sfvb_api.rb +151 -2
- data/lib/ultracart_api/models/sfvb_page_refresh_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_page_refresh_response.rb +260 -0
- data/lib/ultracart_api/models/sfvb_template_resolve_candidate.rb +230 -0
- data/lib/ultracart_api/models/sfvb_template_resolve_path.rb +252 -0
- data/lib/ultracart_api/models/sfvb_template_resolve_response.rb +282 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fd4dd3e7065e2143fbfc5fcc87b849ab24f74fca230a1a88a84219878fa7febf
|
|
4
|
+
data.tar.gz: 5db7bb27d9a3702e72c4243a2ffe7ab8c27f6afb9ac3b27148a1d45de7667f40
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 444b2b719369623a51d8f11e5d7122d84deb63049d3c13245b319fc6d021d41dda6da2e701520be8b4693308a33f06ac0e7ecad40a0fd74e376515d3dcdcf7c0
|
|
7
|
+
data.tar.gz: a6ba6a9fd8f1d77e42bed140af7147f067189795a08072e0e15d0adca4f1c2bbb81f80b0cdd2e5be7dbf0813b74c44fdb95437a02dd67c93dec18fca53ade9ad
|
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.175
|
|
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.175'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -549,10 +549,12 @@ Class | Method | HTTP request | Description
|
|
|
549
549
|
*UltracartClient::SfvbApi* | [**put_sfvb_preview_session**](docs/SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session
|
|
550
550
|
*UltracartClient::SfvbApi* | [**put_sfvb_site_attributes**](docs/SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes
|
|
551
551
|
*UltracartClient::SfvbApi* | [**put_sfvb_theme_attributes**](docs/SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings
|
|
552
|
+
*UltracartClient::SfvbApi* | [**refresh_sfvb_page**](docs/SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy
|
|
552
553
|
*UltracartClient::SfvbApi* | [**remove_sfvb_page_blog_posts**](docs/SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page
|
|
553
554
|
*UltracartClient::SfvbApi* | [**remove_sfvb_page_items**](docs/SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page
|
|
554
555
|
*UltracartClient::SfvbApi* | [**render_sfvb_widgets**](docs/SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML
|
|
555
556
|
*UltracartClient::SfvbApi* | [**reserve_sfvb_widget_ids**](docs/SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids
|
|
557
|
+
*UltracartClient::SfvbApi* | [**resolve_sfvb_template**](docs/SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders
|
|
556
558
|
*UltracartClient::SfvbApi* | [**revert_sfvb_container**](docs/SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system
|
|
557
559
|
*UltracartClient::SfvbApi* | [**revert_sfvb_file**](docs/SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version
|
|
558
560
|
*UltracartClient::SfvbApi* | [**search_sfvb_files**](docs/SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files
|
|
@@ -1853,6 +1855,8 @@ Class | Method | HTTP request | Description
|
|
|
1853
1855
|
- [UltracartClient::SfvbPageListResponse](docs/SfvbPageListResponse.md)
|
|
1854
1856
|
- [UltracartClient::SfvbPageMultimedia](docs/SfvbPageMultimedia.md)
|
|
1855
1857
|
- [UltracartClient::SfvbPageMultimediaRequest](docs/SfvbPageMultimediaRequest.md)
|
|
1858
|
+
- [UltracartClient::SfvbPageRefreshRequest](docs/SfvbPageRefreshRequest.md)
|
|
1859
|
+
- [UltracartClient::SfvbPageRefreshResponse](docs/SfvbPageRefreshResponse.md)
|
|
1856
1860
|
- [UltracartClient::SfvbPageResponse](docs/SfvbPageResponse.md)
|
|
1857
1861
|
- [UltracartClient::SfvbPageSelectors](docs/SfvbPageSelectors.md)
|
|
1858
1862
|
- [UltracartClient::SfvbPageSettingsRequest](docs/SfvbPageSettingsRequest.md)
|
|
@@ -1871,6 +1875,9 @@ Class | Method | HTTP request | Description
|
|
|
1871
1875
|
- [UltracartClient::SfvbStorefront](docs/SfvbStorefront.md)
|
|
1872
1876
|
- [UltracartClient::SfvbStorefrontsResponse](docs/SfvbStorefrontsResponse.md)
|
|
1873
1877
|
- [UltracartClient::SfvbTemplate](docs/SfvbTemplate.md)
|
|
1878
|
+
- [UltracartClient::SfvbTemplateResolveCandidate](docs/SfvbTemplateResolveCandidate.md)
|
|
1879
|
+
- [UltracartClient::SfvbTemplateResolvePath](docs/SfvbTemplateResolvePath.md)
|
|
1880
|
+
- [UltracartClient::SfvbTemplateResolveResponse](docs/SfvbTemplateResolveResponse.md)
|
|
1874
1881
|
- [UltracartClient::SfvbTemplatesResponse](docs/SfvbTemplatesResponse.md)
|
|
1875
1882
|
- [UltracartClient::SfvbTheme](docs/SfvbTheme.md)
|
|
1876
1883
|
- [UltracartClient::SfvbThemeAttribute](docs/SfvbThemeAttribute.md)
|
|
@@ -2066,6 +2073,8 @@ Not every change is committed to every SDK.
|
|
|
2066
2073
|
|
|
2067
2074
|
| Version | Date | Comments |
|
|
2068
2075
|
| --: | :-: | --- |
|
|
2076
|
+
| 4.1.175 | 09/29/2026 | sfvb internal testing |
|
|
2077
|
+
| 4.1.174 | 09/25/2026 | sfvb internal testing |
|
|
2069
2078
|
| 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
|
|
2070
2079
|
| 4.1.172 | 09/24/2026 | storefront communications flow re-entry setting |
|
|
2071
2080
|
| 4.1.171 | 09/23/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -81,10 +81,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
81
81
|
| [**put_sfvb_preview_session**](SfvbApi.md#put_sfvb_preview_session) | **PUT** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Push containers into a preview session |
|
|
82
82
|
| [**put_sfvb_site_attributes**](SfvbApi.md#put_sfvb_site_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/attributes | Change a storefront's site attributes |
|
|
83
83
|
| [**put_sfvb_theme_attributes**](SfvbApi.md#put_sfvb_theme_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Change a theme's colors, fonts and settings |
|
|
84
|
+
| [**refresh_sfvb_page**](SfvbApi.md#refresh_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages/refresh | Drop one page's cached copy |
|
|
84
85
|
| [**remove_sfvb_page_blog_posts**](SfvbApi.md#remove_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/remove | Take blog posts off a page |
|
|
85
86
|
| [**remove_sfvb_page_items**](SfvbApi.md#remove_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/remove | Take items off a page |
|
|
86
87
|
| [**render_sfvb_widgets**](SfvbApi.md#render_sfvb_widgets) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/render | Render a CJSON node to HTML |
|
|
87
88
|
| [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
|
|
89
|
+
| [**resolve_sfvb_template**](SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders |
|
|
88
90
|
| [**revert_sfvb_container**](SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system |
|
|
89
91
|
| [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
|
|
90
92
|
| [**search_sfvb_files**](SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files |
|
|
@@ -1086,7 +1088,7 @@ end
|
|
|
1086
1088
|
|
|
1087
1089
|
End an experiment
|
|
1088
1090
|
|
|
1089
|
-
Ends a running experiment. With winner_variation_number the winner gets
|
|
1091
|
+
Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment's winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment's id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
|
|
1090
1092
|
|
|
1091
1093
|
|
|
1092
1094
|
### Examples
|
|
@@ -4310,6 +4312,60 @@ end
|
|
|
4310
4312
|
- **Accept**: application/json
|
|
4311
4313
|
|
|
4312
4314
|
|
|
4315
|
+
## refresh_sfvb_page
|
|
4316
|
+
|
|
4317
|
+
> <SfvbPageRefreshResponse> refresh_sfvb_page(storefront_oid, page_refresh_request)
|
|
4318
|
+
|
|
4319
|
+
Drop one page's cached copy
|
|
4320
|
+
|
|
4321
|
+
The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
|
|
4322
|
+
|
|
4323
|
+
|
|
4324
|
+
### Examples
|
|
4325
|
+
|
|
4326
|
+
|
|
4327
|
+
(No example for this operation).
|
|
4328
|
+
|
|
4329
|
+
|
|
4330
|
+
#### Using the refresh_sfvb_page_with_http_info variant
|
|
4331
|
+
|
|
4332
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4333
|
+
|
|
4334
|
+
> <Array(<SfvbPageRefreshResponse>, Integer, Hash)> refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request)
|
|
4335
|
+
|
|
4336
|
+
```ruby
|
|
4337
|
+
begin
|
|
4338
|
+
# Drop one page's cached copy
|
|
4339
|
+
data, status_code, headers = api_instance.refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request)
|
|
4340
|
+
p status_code # => 2xx
|
|
4341
|
+
p headers # => { ... }
|
|
4342
|
+
p data # => <SfvbPageRefreshResponse>
|
|
4343
|
+
rescue UltracartClient::ApiError => e
|
|
4344
|
+
puts "Error when calling SfvbApi->refresh_sfvb_page_with_http_info: #{e}"
|
|
4345
|
+
end
|
|
4346
|
+
```
|
|
4347
|
+
|
|
4348
|
+
### Parameters
|
|
4349
|
+
|
|
4350
|
+
| Name | Type | Description | Notes |
|
|
4351
|
+
| ---- | ---- | ----------- | ----- |
|
|
4352
|
+
| **storefront_oid** | **Integer** | | |
|
|
4353
|
+
| **page_refresh_request** | [**SfvbPageRefreshRequest**](SfvbPageRefreshRequest.md) | The page to refresh | |
|
|
4354
|
+
|
|
4355
|
+
### Return type
|
|
4356
|
+
|
|
4357
|
+
[**SfvbPageRefreshResponse**](SfvbPageRefreshResponse.md)
|
|
4358
|
+
|
|
4359
|
+
### Authorization
|
|
4360
|
+
|
|
4361
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4362
|
+
|
|
4363
|
+
### HTTP request headers
|
|
4364
|
+
|
|
4365
|
+
- **Content-Type**: application/json
|
|
4366
|
+
- **Accept**: application/json
|
|
4367
|
+
|
|
4368
|
+
|
|
4313
4369
|
## remove_sfvb_page_blog_posts
|
|
4314
4370
|
|
|
4315
4371
|
> <SfvbPageBlogPostsResponse> remove_sfvb_page_blog_posts(storefront_oid, path, page_blog_posts_request)
|
|
@@ -4529,6 +4585,61 @@ end
|
|
|
4529
4585
|
- **Accept**: application/json
|
|
4530
4586
|
|
|
4531
4587
|
|
|
4588
|
+
## resolve_sfvb_template
|
|
4589
|
+
|
|
4590
|
+
> <SfvbTemplateResolveResponse> resolve_sfvb_template(storefront_oid, name, opts)
|
|
4591
|
+
|
|
4592
|
+
Resolve a template name to the file a page renders
|
|
4593
|
+
|
|
4594
|
+
A page stores only its template's file name. This runs the storefront's own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme's resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
4595
|
+
|
|
4596
|
+
|
|
4597
|
+
### Examples
|
|
4598
|
+
|
|
4599
|
+
|
|
4600
|
+
(No example for this operation).
|
|
4601
|
+
|
|
4602
|
+
|
|
4603
|
+
#### Using the resolve_sfvb_template_with_http_info variant
|
|
4604
|
+
|
|
4605
|
+
This returns an Array which contains the response data, status code and headers.
|
|
4606
|
+
|
|
4607
|
+
> <Array(<SfvbTemplateResolveResponse>, Integer, Hash)> resolve_sfvb_template_with_http_info(storefront_oid, name, opts)
|
|
4608
|
+
|
|
4609
|
+
```ruby
|
|
4610
|
+
begin
|
|
4611
|
+
# Resolve a template name to the file a page renders
|
|
4612
|
+
data, status_code, headers = api_instance.resolve_sfvb_template_with_http_info(storefront_oid, name, opts)
|
|
4613
|
+
p status_code # => 2xx
|
|
4614
|
+
p headers # => { ... }
|
|
4615
|
+
p data # => <SfvbTemplateResolveResponse>
|
|
4616
|
+
rescue UltracartClient::ApiError => e
|
|
4617
|
+
puts "Error when calling SfvbApi->resolve_sfvb_template_with_http_info: #{e}"
|
|
4618
|
+
end
|
|
4619
|
+
```
|
|
4620
|
+
|
|
4621
|
+
### Parameters
|
|
4622
|
+
|
|
4623
|
+
| Name | Type | Description | Notes |
|
|
4624
|
+
| ---- | ---- | ----------- | ----- |
|
|
4625
|
+
| **storefront_oid** | **Integer** | | |
|
|
4626
|
+
| **name** | **String** | The template file name, such as catalog.vm | |
|
|
4627
|
+
| **theme_oid** | **Integer** | Resolve in this theme instead of the active theme | [optional] |
|
|
4628
|
+
|
|
4629
|
+
### Return type
|
|
4630
|
+
|
|
4631
|
+
[**SfvbTemplateResolveResponse**](SfvbTemplateResolveResponse.md)
|
|
4632
|
+
|
|
4633
|
+
### Authorization
|
|
4634
|
+
|
|
4635
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
4636
|
+
|
|
4637
|
+
### HTTP request headers
|
|
4638
|
+
|
|
4639
|
+
- **Content-Type**: Not defined
|
|
4640
|
+
- **Accept**: application/json
|
|
4641
|
+
|
|
4642
|
+
|
|
4532
4643
|
## revert_sfvb_container
|
|
4533
4644
|
|
|
4534
4645
|
> <SfvbContainerResponse> revert_sfvb_container(storefront_oid, owner_type, owner_object_id, if_match, container_revert_request, opts)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageRefreshRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | The page to refresh. A path such as /shop/coffee.html, or a full URL on this storefront's host. The query string is ignored, and a path ending in / means its index.html. One page per request. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbPageRefreshRequest.new(
|
|
15
|
+
url: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbPageRefreshResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | A plain sentence saying what happened. | [optional] |
|
|
8
|
+
| **path** | **String** | The page path the refresh used, after normalization. | [optional] |
|
|
9
|
+
| **refreshed** | **Boolean** | True when a cached copy was dropped. The next request renders the page fresh. | [optional] |
|
|
10
|
+
| **was_cached** | **Boolean** | True when the page had a cache entry. | [optional] |
|
|
11
|
+
| **was_valid** | **Boolean** | True when that entry was being served from cache. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbPageRefreshResponse.new(
|
|
19
|
+
message: null,
|
|
20
|
+
path: null,
|
|
21
|
+
refreshed: null,
|
|
22
|
+
was_cached: null,
|
|
23
|
+
was_valid: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbTemplateResolveCandidate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **skipped** | **String** | Why the storefront never uses this file for a page, or null. snippets means it sits in the resource path's own snippets folder. | [optional] |
|
|
8
|
+
| **theme_relative_path** | **String** | Where the file sits inside the theme. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbTemplateResolveCandidate.new(
|
|
16
|
+
skipped: null,
|
|
17
|
+
theme_relative_path: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbTemplateResolvePath
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **candidates** | [**Array<SfvbTemplateResolveCandidate>**](SfvbTemplateResolveCandidate.md) | Every file of that name below this path, in the order the storefront searches. | [optional] |
|
|
8
|
+
| **directory_found** | **Boolean** | False when the theme has no such directory, so the storefront skips this path. | [optional] |
|
|
9
|
+
| **match** | **String** | The candidate this path supplies, relative to the theme root, or null. It is the first candidate that is not skipped. | [optional] |
|
|
10
|
+
| **resource_path** | **String** | The resource path, relative to the theme root. / is the theme root itself. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbTemplateResolvePath.new(
|
|
18
|
+
candidates: null,
|
|
19
|
+
directory_found: null,
|
|
20
|
+
match: null,
|
|
21
|
+
resource_path: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::SfvbTemplateResolveResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **exists** | **Boolean** | Whether resolved_path is a file. False means a page naming this template cannot render. | [optional] |
|
|
8
|
+
| **fallback** | **Boolean** | True when no resource path held the name, so the storefront fell back to the name at the theme root. | [optional] |
|
|
9
|
+
| **name** | **String** | The template file name that was resolved, as a page's group_template or item_template holds it. | [optional] |
|
|
10
|
+
| **resolved_path** | **String** | The file a page naming this template renders, relative to theme_path. This is the storefront's own answer. | [optional] |
|
|
11
|
+
| **resource_paths** | [**Array<SfvbTemplateResolvePath>**](SfvbTemplateResolvePath.md) | The theme's resource paths in search order, each with the files of that name found below it. The first path with a match wins, which is how a theme copy overrides a shared core copy. | [optional] |
|
|
12
|
+
| **theme_oid** | **Integer** | The theme the name was resolved in. | [optional] |
|
|
13
|
+
| **theme_path** | **String** | The theme's path in the file manager, such as /themes/Elements/. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::SfvbTemplateResolveResponse.new(
|
|
21
|
+
exists: null,
|
|
22
|
+
fallback: null,
|
|
23
|
+
name: null,
|
|
24
|
+
resolved_path: null,
|
|
25
|
+
resource_paths: null,
|
|
26
|
+
theme_oid: null,
|
|
27
|
+
theme_path: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -1355,7 +1355,7 @@ module UltracartClient
|
|
|
1355
1355
|
end
|
|
1356
1356
|
|
|
1357
1357
|
# End an experiment
|
|
1358
|
-
# Ends a running experiment. With winner_variation_number the winner gets
|
|
1358
|
+
# Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment's winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment's id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
|
|
1359
1359
|
# @param storefront_oid [Integer]
|
|
1360
1360
|
# @param experiment_oid [Integer]
|
|
1361
1361
|
# @param [Hash] opts the optional parameters
|
|
@@ -1367,7 +1367,7 @@ module UltracartClient
|
|
|
1367
1367
|
end
|
|
1368
1368
|
|
|
1369
1369
|
# End an experiment
|
|
1370
|
-
# Ends a running experiment. With winner_variation_number the winner gets
|
|
1370
|
+
# Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment's winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment's id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish.
|
|
1371
1371
|
# @param storefront_oid [Integer]
|
|
1372
1372
|
# @param experiment_oid [Integer]
|
|
1373
1373
|
# @param [Hash] opts the optional parameters
|
|
@@ -5721,6 +5721,81 @@ module UltracartClient
|
|
|
5721
5721
|
return data, status_code, headers
|
|
5722
5722
|
end
|
|
5723
5723
|
|
|
5724
|
+
# Drop one page's cached copy
|
|
5725
|
+
# The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
|
|
5726
|
+
# @param storefront_oid [Integer]
|
|
5727
|
+
# @param page_refresh_request [SfvbPageRefreshRequest] The page to refresh
|
|
5728
|
+
# @param [Hash] opts the optional parameters
|
|
5729
|
+
# @return [SfvbPageRefreshResponse]
|
|
5730
|
+
def refresh_sfvb_page(storefront_oid, page_refresh_request, opts = {})
|
|
5731
|
+
data, _status_code, _headers = refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request, opts)
|
|
5732
|
+
data
|
|
5733
|
+
end
|
|
5734
|
+
|
|
5735
|
+
# Drop one page's cached copy
|
|
5736
|
+
# The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
|
|
5737
|
+
# @param storefront_oid [Integer]
|
|
5738
|
+
# @param page_refresh_request [SfvbPageRefreshRequest] The page to refresh
|
|
5739
|
+
# @param [Hash] opts the optional parameters
|
|
5740
|
+
# @return [Array<(SfvbPageRefreshResponse, Integer, Hash)>] SfvbPageRefreshResponse data, response status code and response headers
|
|
5741
|
+
def refresh_sfvb_page_with_http_info(storefront_oid, page_refresh_request, opts = {})
|
|
5742
|
+
if @api_client.config.debugging
|
|
5743
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.refresh_sfvb_page ...'
|
|
5744
|
+
end
|
|
5745
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5746
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5747
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.refresh_sfvb_page"
|
|
5748
|
+
end
|
|
5749
|
+
# verify the required parameter 'page_refresh_request' is set
|
|
5750
|
+
if @api_client.config.client_side_validation && page_refresh_request.nil?
|
|
5751
|
+
fail ArgumentError, "Missing the required parameter 'page_refresh_request' when calling SfvbApi.refresh_sfvb_page"
|
|
5752
|
+
end
|
|
5753
|
+
# resource path
|
|
5754
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/pages/refresh'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
5755
|
+
|
|
5756
|
+
# query parameters
|
|
5757
|
+
query_params = opts[:query_params] || {}
|
|
5758
|
+
|
|
5759
|
+
# header parameters
|
|
5760
|
+
header_params = opts[:header_params] || {}
|
|
5761
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5762
|
+
# HTTP header 'Accept' (if needed)
|
|
5763
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5764
|
+
# HTTP header 'Content-Type'
|
|
5765
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
5766
|
+
if !content_type.nil?
|
|
5767
|
+
header_params['Content-Type'] = content_type
|
|
5768
|
+
end
|
|
5769
|
+
|
|
5770
|
+
# form parameters
|
|
5771
|
+
form_params = opts[:form_params] || {}
|
|
5772
|
+
|
|
5773
|
+
# http body (model)
|
|
5774
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(page_refresh_request)
|
|
5775
|
+
|
|
5776
|
+
# return_type
|
|
5777
|
+
return_type = opts[:debug_return_type] || 'SfvbPageRefreshResponse'
|
|
5778
|
+
|
|
5779
|
+
# auth_names
|
|
5780
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5781
|
+
|
|
5782
|
+
new_options = opts.merge(
|
|
5783
|
+
:operation => :"SfvbApi.refresh_sfvb_page",
|
|
5784
|
+
:header_params => header_params,
|
|
5785
|
+
:query_params => query_params,
|
|
5786
|
+
:form_params => form_params,
|
|
5787
|
+
:body => post_body,
|
|
5788
|
+
:auth_names => auth_names,
|
|
5789
|
+
:return_type => return_type
|
|
5790
|
+
)
|
|
5791
|
+
|
|
5792
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
5793
|
+
if @api_client.config.debugging
|
|
5794
|
+
@api_client.config.logger.debug "API called: SfvbApi#refresh_sfvb_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5795
|
+
end
|
|
5796
|
+
return data, status_code, headers
|
|
5797
|
+
end
|
|
5798
|
+
|
|
5724
5799
|
# Take blog posts off a page
|
|
5725
5800
|
# Removes posts by blog_post_oid, at most 500 at a time. Every oid must be on the page, and one that is not changes nothing. The posts themselves are not touched. Always needs sfvb_publish.
|
|
5726
5801
|
# @param storefront_oid [Integer]
|
|
@@ -6033,6 +6108,80 @@ module UltracartClient
|
|
|
6033
6108
|
return data, status_code, headers
|
|
6034
6109
|
end
|
|
6035
6110
|
|
|
6111
|
+
# Resolve a template name to the file a page renders
|
|
6112
|
+
# A page stores only its template's file name. This runs the storefront's own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme's resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
6113
|
+
# @param storefront_oid [Integer]
|
|
6114
|
+
# @param name [String] The template file name, such as catalog.vm
|
|
6115
|
+
# @param [Hash] opts the optional parameters
|
|
6116
|
+
# @option opts [Integer] :theme_oid Resolve in this theme instead of the active theme
|
|
6117
|
+
# @return [SfvbTemplateResolveResponse]
|
|
6118
|
+
def resolve_sfvb_template(storefront_oid, name, opts = {})
|
|
6119
|
+
data, _status_code, _headers = resolve_sfvb_template_with_http_info(storefront_oid, name, opts)
|
|
6120
|
+
data
|
|
6121
|
+
end
|
|
6122
|
+
|
|
6123
|
+
# Resolve a template name to the file a page renders
|
|
6124
|
+
# A page stores only its template's file name. This runs the storefront's own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme's resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
6125
|
+
# @param storefront_oid [Integer]
|
|
6126
|
+
# @param name [String] The template file name, such as catalog.vm
|
|
6127
|
+
# @param [Hash] opts the optional parameters
|
|
6128
|
+
# @option opts [Integer] :theme_oid Resolve in this theme instead of the active theme
|
|
6129
|
+
# @return [Array<(SfvbTemplateResolveResponse, Integer, Hash)>] SfvbTemplateResolveResponse data, response status code and response headers
|
|
6130
|
+
def resolve_sfvb_template_with_http_info(storefront_oid, name, opts = {})
|
|
6131
|
+
if @api_client.config.debugging
|
|
6132
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.resolve_sfvb_template ...'
|
|
6133
|
+
end
|
|
6134
|
+
# verify the required parameter 'storefront_oid' is set
|
|
6135
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
6136
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.resolve_sfvb_template"
|
|
6137
|
+
end
|
|
6138
|
+
# verify the required parameter 'name' is set
|
|
6139
|
+
if @api_client.config.client_side_validation && name.nil?
|
|
6140
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling SfvbApi.resolve_sfvb_template"
|
|
6141
|
+
end
|
|
6142
|
+
# resource path
|
|
6143
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/templates/resolve'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
6144
|
+
|
|
6145
|
+
# query parameters
|
|
6146
|
+
query_params = opts[:query_params] || {}
|
|
6147
|
+
query_params[:'name'] = name
|
|
6148
|
+
query_params[:'theme_oid'] = opts[:'theme_oid'] if !opts[:'theme_oid'].nil?
|
|
6149
|
+
|
|
6150
|
+
# header parameters
|
|
6151
|
+
header_params = opts[:header_params] || {}
|
|
6152
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
6153
|
+
# HTTP header 'Accept' (if needed)
|
|
6154
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6155
|
+
|
|
6156
|
+
# form parameters
|
|
6157
|
+
form_params = opts[:form_params] || {}
|
|
6158
|
+
|
|
6159
|
+
# http body (model)
|
|
6160
|
+
post_body = opts[:debug_body]
|
|
6161
|
+
|
|
6162
|
+
# return_type
|
|
6163
|
+
return_type = opts[:debug_return_type] || 'SfvbTemplateResolveResponse'
|
|
6164
|
+
|
|
6165
|
+
# auth_names
|
|
6166
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
6167
|
+
|
|
6168
|
+
new_options = opts.merge(
|
|
6169
|
+
:operation => :"SfvbApi.resolve_sfvb_template",
|
|
6170
|
+
:header_params => header_params,
|
|
6171
|
+
:query_params => query_params,
|
|
6172
|
+
:form_params => form_params,
|
|
6173
|
+
:body => post_body,
|
|
6174
|
+
:auth_names => auth_names,
|
|
6175
|
+
:return_type => return_type
|
|
6176
|
+
)
|
|
6177
|
+
|
|
6178
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6179
|
+
if @api_client.config.debugging
|
|
6180
|
+
@api_client.config.logger.debug "API called: SfvbApi#resolve_sfvb_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6181
|
+
end
|
|
6182
|
+
return data, status_code, headers
|
|
6183
|
+
end
|
|
6184
|
+
|
|
6036
6185
|
# Revert a container stored outside the file system
|
|
6037
6186
|
# The restore is itself snapshotted, so a revert can be undone in turn. Reverting to an entry recorded before the container existed removes it again. Addressed through the owning container and guarded by If-Match, because a revert overwrites live content just as much as an ordinary write does. owner_type also says how owner_object_id is read, so a version written by oid can be reverted by merchant item id and the other way round.
|
|
6038
6187
|
# @param storefront_oid [Integer]
|