ultracart_api 4.1.177 → 4.1.178
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 +9 -2
- data/docs/SfvbApi.md +114 -0
- data/docs/SfvbServerLog.md +38 -0
- data/docs/SfvbServerLogDetail.md +26 -0
- data/docs/SfvbServerLogEntry.md +24 -0
- data/docs/SfvbServerLogsResponse.md +26 -0
- data/lib/ultracart_api/api/sfvb_api.rb +149 -0
- data/lib/ultracart_api/models/sfvb_server_log.rb +320 -0
- data/lib/ultracart_api/models/sfvb_server_log_detail.rb +261 -0
- data/lib/ultracart_api/models/sfvb_server_log_entry.rb +250 -0
- data/lib/ultracart_api/models/sfvb_server_logs_response.rb +262 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +9 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 75de5d6a801f97c0481e98f5c17fb66ac241af836f9d30ff9369229edb1bc23b
|
|
4
|
+
data.tar.gz: 40a12b20d2798ca351030b2f9a6be99618d9ac3fb05b179e0a25326ae1a61463
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bd5a31348ed0119da97074917037d73a5389012834e82c6acf6fb514ffdb51c0710df2f4fc803aa18c11459a8c162852d697e86ccd763afba30e413f776e5b98
|
|
7
|
+
data.tar.gz: a9f8101fae58933c68ccf127dda356da2f07f3865f81d7fd3330f30de655c32c759696703f521af12a18ef7e5550e99d70bfb9fae9eb37ae6fcf1ee50e6ac50b
|
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.178
|
|
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.178'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -512,6 +512,7 @@ Class | Method | HTTP request | Description
|
|
|
512
512
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_items**](docs/SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page
|
|
513
513
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_selectors**](docs/SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors
|
|
514
514
|
*UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
|
|
515
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
|
|
515
516
|
*UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
|
|
516
517
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
|
|
517
518
|
*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
|
|
@@ -533,6 +534,7 @@ Class | Method | HTTP request | Description
|
|
|
533
534
|
*UltracartClient::SfvbApi* | [**list_sfvb_files**](docs/SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory
|
|
534
535
|
*UltracartClient::SfvbApi* | [**list_sfvb_item_containers**](docs/SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account
|
|
535
536
|
*UltracartClient::SfvbApi* | [**list_sfvb_pages**](docs/SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages
|
|
537
|
+
*UltracartClient::SfvbApi* | [**list_sfvb_server_logs**](docs/SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs
|
|
536
538
|
*UltracartClient::SfvbApi* | [**list_sfvb_storefronts**](docs/SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts
|
|
537
539
|
*UltracartClient::SfvbApi* | [**list_sfvb_templates**](docs/SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates
|
|
538
540
|
*UltracartClient::SfvbApi* | [**list_sfvb_themes**](docs/SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront
|
|
@@ -1881,6 +1883,10 @@ Class | Method | HTTP request | Description
|
|
|
1881
1883
|
- [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
|
|
1882
1884
|
- [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
|
|
1883
1885
|
- [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
|
|
1886
|
+
- [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
|
|
1887
|
+
- [UltracartClient::SfvbServerLogDetail](docs/SfvbServerLogDetail.md)
|
|
1888
|
+
- [UltracartClient::SfvbServerLogEntry](docs/SfvbServerLogEntry.md)
|
|
1889
|
+
- [UltracartClient::SfvbServerLogsResponse](docs/SfvbServerLogsResponse.md)
|
|
1884
1890
|
- [UltracartClient::SfvbSiteAttribute](docs/SfvbSiteAttribute.md)
|
|
1885
1891
|
- [UltracartClient::SfvbSiteAttributeUpdate](docs/SfvbSiteAttributeUpdate.md)
|
|
1886
1892
|
- [UltracartClient::SfvbSiteAttributeUpdateRequest](docs/SfvbSiteAttributeUpdateRequest.md)
|
|
@@ -2090,6 +2096,7 @@ Not every change is committed to every SDK.
|
|
|
2090
2096
|
|
|
2091
2097
|
| Version | Date | Comments |
|
|
2092
2098
|
| --: | :-: | --- |
|
|
2099
|
+
| 4.1.178 | 09/30/2026 | sfvb internal testing |
|
|
2093
2100
|
| 4.1.177 | 09/30/2026 | sfvb internal testing |
|
|
2094
2101
|
| 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
|
|
2095
2102
|
| 4.1.175 | 09/29/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -44,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
44
44
|
| [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
|
|
45
45
|
| [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
|
|
46
46
|
| [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
|
|
47
|
+
| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
|
|
47
48
|
| [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
|
|
48
49
|
| [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
|
|
49
50
|
| [**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 |
|
|
@@ -65,6 +66,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
65
66
|
| [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
|
|
66
67
|
| [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
|
|
67
68
|
| [**list_sfvb_pages**](SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages |
|
|
69
|
+
| [**list_sfvb_server_logs**](SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs |
|
|
68
70
|
| [**list_sfvb_storefronts**](SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts |
|
|
69
71
|
| [**list_sfvb_templates**](SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates |
|
|
70
72
|
| [**list_sfvb_themes**](SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront |
|
|
@@ -2282,6 +2284,61 @@ end
|
|
|
2282
2284
|
- **Accept**: application/json
|
|
2283
2285
|
|
|
2284
2286
|
|
|
2287
|
+
## get_sfvb_server_log
|
|
2288
|
+
|
|
2289
|
+
> <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
|
|
2290
|
+
|
|
2291
|
+
Get one storefront render log
|
|
2292
|
+
|
|
2293
|
+
One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
### Examples
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
(No example for this operation).
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
#### Using the get_sfvb_server_log_with_http_info variant
|
|
2303
|
+
|
|
2304
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2305
|
+
|
|
2306
|
+
> <Array(<SfvbServerLogDetail>, Integer, Hash)> get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
|
|
2307
|
+
|
|
2308
|
+
```ruby
|
|
2309
|
+
begin
|
|
2310
|
+
# Get one storefront render log
|
|
2311
|
+
data, status_code, headers = api_instance.get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
|
|
2312
|
+
p status_code # => 2xx
|
|
2313
|
+
p headers # => { ... }
|
|
2314
|
+
p data # => <SfvbServerLogDetail>
|
|
2315
|
+
rescue UltracartClient::ApiError => e
|
|
2316
|
+
puts "Error when calling SfvbApi->get_sfvb_server_log_with_http_info: #{e}"
|
|
2317
|
+
end
|
|
2318
|
+
```
|
|
2319
|
+
|
|
2320
|
+
### Parameters
|
|
2321
|
+
|
|
2322
|
+
| Name | Type | Description | Notes |
|
|
2323
|
+
| ---- | ---- | ----------- | ----- |
|
|
2324
|
+
| **storefront_oid** | **Integer** | | |
|
|
2325
|
+
| **log_id** | **String** | | |
|
|
2326
|
+
| **min_level** | **String** | | [optional] |
|
|
2327
|
+
|
|
2328
|
+
### Return type
|
|
2329
|
+
|
|
2330
|
+
[**SfvbServerLogDetail**](SfvbServerLogDetail.md)
|
|
2331
|
+
|
|
2332
|
+
### Authorization
|
|
2333
|
+
|
|
2334
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2335
|
+
|
|
2336
|
+
### HTTP request headers
|
|
2337
|
+
|
|
2338
|
+
- **Content-Type**: Not defined
|
|
2339
|
+
- **Accept**: application/json
|
|
2340
|
+
|
|
2341
|
+
|
|
2285
2342
|
## get_sfvb_site_attributes
|
|
2286
2343
|
|
|
2287
2344
|
> <SfvbSiteAttributesResponse> get_sfvb_site_attributes(storefront_oid)
|
|
@@ -3425,6 +3482,63 @@ end
|
|
|
3425
3482
|
- **Accept**: application/json
|
|
3426
3483
|
|
|
3427
3484
|
|
|
3485
|
+
## list_sfvb_server_logs
|
|
3486
|
+
|
|
3487
|
+
> <SfvbServerLogsResponse> list_sfvb_server_logs(storefront_oid, opts)
|
|
3488
|
+
|
|
3489
|
+
List recent storefront render logs
|
|
3490
|
+
|
|
3491
|
+
The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
|
|
3492
|
+
|
|
3493
|
+
|
|
3494
|
+
### Examples
|
|
3495
|
+
|
|
3496
|
+
|
|
3497
|
+
(No example for this operation).
|
|
3498
|
+
|
|
3499
|
+
|
|
3500
|
+
#### Using the list_sfvb_server_logs_with_http_info variant
|
|
3501
|
+
|
|
3502
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3503
|
+
|
|
3504
|
+
> <Array(<SfvbServerLogsResponse>, Integer, Hash)> list_sfvb_server_logs_with_http_info(storefront_oid, opts)
|
|
3505
|
+
|
|
3506
|
+
```ruby
|
|
3507
|
+
begin
|
|
3508
|
+
# List recent storefront render logs
|
|
3509
|
+
data, status_code, headers = api_instance.list_sfvb_server_logs_with_http_info(storefront_oid, opts)
|
|
3510
|
+
p status_code # => 2xx
|
|
3511
|
+
p headers # => { ... }
|
|
3512
|
+
p data # => <SfvbServerLogsResponse>
|
|
3513
|
+
rescue UltracartClient::ApiError => e
|
|
3514
|
+
puts "Error when calling SfvbApi->list_sfvb_server_logs_with_http_info: #{e}"
|
|
3515
|
+
end
|
|
3516
|
+
```
|
|
3517
|
+
|
|
3518
|
+
### Parameters
|
|
3519
|
+
|
|
3520
|
+
| Name | Type | Description | Notes |
|
|
3521
|
+
| ---- | ---- | ----------- | ----- |
|
|
3522
|
+
| **storefront_oid** | **Integer** | | |
|
|
3523
|
+
| **uri** | **String** | | [optional] |
|
|
3524
|
+
| **since** | **String** | | [optional] |
|
|
3525
|
+
| **errors_only** | **Boolean** | | [optional] |
|
|
3526
|
+
| **limit** | **Integer** | | [optional] |
|
|
3527
|
+
|
|
3528
|
+
### Return type
|
|
3529
|
+
|
|
3530
|
+
[**SfvbServerLogsResponse**](SfvbServerLogsResponse.md)
|
|
3531
|
+
|
|
3532
|
+
### Authorization
|
|
3533
|
+
|
|
3534
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3535
|
+
|
|
3536
|
+
### HTTP request headers
|
|
3537
|
+
|
|
3538
|
+
- **Content-Type**: Not defined
|
|
3539
|
+
- **Accept**: application/json
|
|
3540
|
+
|
|
3541
|
+
|
|
3428
3542
|
## list_sfvb_storefronts
|
|
3429
3543
|
|
|
3430
3544
|
> <SfvbStorefrontsResponse> list_sfvb_storefronts
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# UltracartClient::SfvbServerLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **app_error** | **Boolean** | True when the render itself failed and the page could not be produced. | [optional] |
|
|
8
|
+
| **duration_ms** | **Integer** | How long the render took in milliseconds. | [optional] |
|
|
9
|
+
| **error_count** | **Integer** | Error lines in the log, including Velocity problems such as a null | [optional] |
|
|
10
|
+
| **line_count** | **Integer** | Lines in the full log text. | [optional] |
|
|
11
|
+
| **log_id** | **String** | Opaque id of this log. Pass it to the get endpoint. Preview pages send the same id in the X-UltraCart-Storefront-Log-Id response header. | [optional] |
|
|
12
|
+
| **request_template** | **String** | The template the page rendered with, when known. | [optional] |
|
|
13
|
+
| **request_url** | **String** | The address that was rendered, as the server recorded it. | [optional] |
|
|
14
|
+
| **start_date** | **String** | When the render started, ISO-8601 in UTC. | [optional] |
|
|
15
|
+
| **status** | **String** | ERROR when the render logged any error line or failed, otherwise SUCCESS. | [optional] |
|
|
16
|
+
| **stop_date** | **String** | When the render finished, ISO-8601 in UTC. | [optional] |
|
|
17
|
+
| **warning_count** | **Integer** | Warning lines in the log. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'ultracart_api'
|
|
23
|
+
|
|
24
|
+
instance = UltracartClient::SfvbServerLog.new(
|
|
25
|
+
app_error: null,
|
|
26
|
+
duration_ms: null,
|
|
27
|
+
error_count: null,
|
|
28
|
+
line_count: null,
|
|
29
|
+
log_id: null,
|
|
30
|
+
request_template: null,
|
|
31
|
+
request_url: null,
|
|
32
|
+
start_date: null,
|
|
33
|
+
status: null,
|
|
34
|
+
stop_date: null,
|
|
35
|
+
warning_count: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbServerLogDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **entries** | [**Array<SfvbServerLogEntry>**](SfvbServerLogEntry.md) | The log's lines in the order they were written, at or above min_level. | [optional] |
|
|
8
|
+
| **log** | [**SfvbServerLog**](SfvbServerLog.md) | | [optional] |
|
|
9
|
+
| **min_level** | **String** | The lowest level included in entries. | [optional] |
|
|
10
|
+
| **remote_ip** | **String** | The address of the browser that asked for the page, as the backend log viewer shows it. | [optional] |
|
|
11
|
+
| **user_agent** | **String** | The browser's user agent, as the backend log viewer shows it. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbServerLogDetail.new(
|
|
19
|
+
entries: null,
|
|
20
|
+
log: null,
|
|
21
|
+
min_level: null,
|
|
22
|
+
remote_ip: null,
|
|
23
|
+
user_agent: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbServerLogEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **category** | **String** | The area that wrote the line, such as VELOCITY, FLOW, CACHE or RUNTIME. Empty for SYSERR lines. | [optional] |
|
|
8
|
+
| **level** | **String** | DEBUG, INFO, WARN, ERROR or SYSERR. SYSERR is an internal logging failure and counts as an error. | [optional] |
|
|
9
|
+
| **logged_at** | **String** | The line's own time as the log wrote it, yyyy/MM/dd hh.mm.ss on a 12 hour clock without AM or PM. Use the log start_date and the entry order for real timing. | [optional] |
|
|
10
|
+
| **message** | **String** | The line's text. A message that spanned several lines keeps its line breaks. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbServerLogEntry.new(
|
|
18
|
+
category: null,
|
|
19
|
+
level: null,
|
|
20
|
+
logged_at: null,
|
|
21
|
+
message: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbServerLogsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **limit** | **Integer** | The most logs returned. | [optional] |
|
|
8
|
+
| **logs** | [**Array<SfvbServerLog>**](SfvbServerLog.md) | Matching logs, newest first, without their text. | [optional] |
|
|
9
|
+
| **more_available** | **Boolean** | True when older logs in the window were not read. Narrow since, or page by moving since back. | [optional] |
|
|
10
|
+
| **searched** | **Integer** | How many of the newest logs in the window were read to find these. | [optional] |
|
|
11
|
+
| **since** | **String** | The start of the window searched, ISO-8601 in UTC. Logs are kept for seven days. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbServerLogsResponse.new(
|
|
19
|
+
limit: null,
|
|
20
|
+
logs: null,
|
|
21
|
+
more_available: null,
|
|
22
|
+
searched: null,
|
|
23
|
+
since: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -2930,6 +2930,79 @@ module UltracartClient
|
|
|
2930
2930
|
return data, status_code, headers
|
|
2931
2931
|
end
|
|
2932
2932
|
|
|
2933
|
+
# Get one storefront render log
|
|
2934
|
+
# One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2935
|
+
# @param storefront_oid [Integer]
|
|
2936
|
+
# @param log_id [String]
|
|
2937
|
+
# @param [Hash] opts the optional parameters
|
|
2938
|
+
# @option opts [String] :min_level
|
|
2939
|
+
# @return [SfvbServerLogDetail]
|
|
2940
|
+
def get_sfvb_server_log(storefront_oid, log_id, opts = {})
|
|
2941
|
+
data, _status_code, _headers = get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
|
|
2942
|
+
data
|
|
2943
|
+
end
|
|
2944
|
+
|
|
2945
|
+
# Get one storefront render log
|
|
2946
|
+
# One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2947
|
+
# @param storefront_oid [Integer]
|
|
2948
|
+
# @param log_id [String]
|
|
2949
|
+
# @param [Hash] opts the optional parameters
|
|
2950
|
+
# @option opts [String] :min_level
|
|
2951
|
+
# @return [Array<(SfvbServerLogDetail, Integer, Hash)>] SfvbServerLogDetail data, response status code and response headers
|
|
2952
|
+
def get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts = {})
|
|
2953
|
+
if @api_client.config.debugging
|
|
2954
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_server_log ...'
|
|
2955
|
+
end
|
|
2956
|
+
# verify the required parameter 'storefront_oid' is set
|
|
2957
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
2958
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_server_log"
|
|
2959
|
+
end
|
|
2960
|
+
# verify the required parameter 'log_id' is set
|
|
2961
|
+
if @api_client.config.client_side_validation && log_id.nil?
|
|
2962
|
+
fail ArgumentError, "Missing the required parameter 'log_id' when calling SfvbApi.get_sfvb_server_log"
|
|
2963
|
+
end
|
|
2964
|
+
# resource path
|
|
2965
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/logs/{log_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'log_id' + '}', CGI.escape(log_id.to_s))
|
|
2966
|
+
|
|
2967
|
+
# query parameters
|
|
2968
|
+
query_params = opts[:query_params] || {}
|
|
2969
|
+
query_params[:'min_level'] = opts[:'min_level'] if !opts[:'min_level'].nil?
|
|
2970
|
+
|
|
2971
|
+
# header parameters
|
|
2972
|
+
header_params = opts[:header_params] || {}
|
|
2973
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2974
|
+
# HTTP header 'Accept' (if needed)
|
|
2975
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2976
|
+
|
|
2977
|
+
# form parameters
|
|
2978
|
+
form_params = opts[:form_params] || {}
|
|
2979
|
+
|
|
2980
|
+
# http body (model)
|
|
2981
|
+
post_body = opts[:debug_body]
|
|
2982
|
+
|
|
2983
|
+
# return_type
|
|
2984
|
+
return_type = opts[:debug_return_type] || 'SfvbServerLogDetail'
|
|
2985
|
+
|
|
2986
|
+
# auth_names
|
|
2987
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2988
|
+
|
|
2989
|
+
new_options = opts.merge(
|
|
2990
|
+
:operation => :"SfvbApi.get_sfvb_server_log",
|
|
2991
|
+
:header_params => header_params,
|
|
2992
|
+
:query_params => query_params,
|
|
2993
|
+
:form_params => form_params,
|
|
2994
|
+
:body => post_body,
|
|
2995
|
+
:auth_names => auth_names,
|
|
2996
|
+
:return_type => return_type
|
|
2997
|
+
)
|
|
2998
|
+
|
|
2999
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3000
|
+
if @api_client.config.debugging
|
|
3001
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_server_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3002
|
+
end
|
|
3003
|
+
return data, status_code, headers
|
|
3004
|
+
end
|
|
3005
|
+
|
|
2933
3006
|
# Read a storefront's site attributes
|
|
2934
3007
|
# The values the siteattribute element and $site.attr render. These are not in any file or theme. Attributes a template declares but nothing has set are included with the template's default, so the response describes what the templates can render rather than only what has been saved. Credentials stored as site attributes are never included.
|
|
2935
3008
|
# @param storefront_oid [Integer]
|
|
@@ -4418,6 +4491,82 @@ module UltracartClient
|
|
|
4418
4491
|
return data, status_code, headers
|
|
4419
4492
|
end
|
|
4420
4493
|
|
|
4494
|
+
# List recent storefront render logs
|
|
4495
|
+
# The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
|
|
4496
|
+
# @param storefront_oid [Integer]
|
|
4497
|
+
# @param [Hash] opts the optional parameters
|
|
4498
|
+
# @option opts [String] :uri
|
|
4499
|
+
# @option opts [String] :since
|
|
4500
|
+
# @option opts [Boolean] :errors_only
|
|
4501
|
+
# @option opts [Integer] :limit
|
|
4502
|
+
# @return [SfvbServerLogsResponse]
|
|
4503
|
+
def list_sfvb_server_logs(storefront_oid, opts = {})
|
|
4504
|
+
data, _status_code, _headers = list_sfvb_server_logs_with_http_info(storefront_oid, opts)
|
|
4505
|
+
data
|
|
4506
|
+
end
|
|
4507
|
+
|
|
4508
|
+
# List recent storefront render logs
|
|
4509
|
+
# The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
|
|
4510
|
+
# @param storefront_oid [Integer]
|
|
4511
|
+
# @param [Hash] opts the optional parameters
|
|
4512
|
+
# @option opts [String] :uri
|
|
4513
|
+
# @option opts [String] :since
|
|
4514
|
+
# @option opts [Boolean] :errors_only
|
|
4515
|
+
# @option opts [Integer] :limit
|
|
4516
|
+
# @return [Array<(SfvbServerLogsResponse, Integer, Hash)>] SfvbServerLogsResponse data, response status code and response headers
|
|
4517
|
+
def list_sfvb_server_logs_with_http_info(storefront_oid, opts = {})
|
|
4518
|
+
if @api_client.config.debugging
|
|
4519
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.list_sfvb_server_logs ...'
|
|
4520
|
+
end
|
|
4521
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4522
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4523
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.list_sfvb_server_logs"
|
|
4524
|
+
end
|
|
4525
|
+
# resource path
|
|
4526
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4527
|
+
|
|
4528
|
+
# query parameters
|
|
4529
|
+
query_params = opts[:query_params] || {}
|
|
4530
|
+
query_params[:'uri'] = opts[:'uri'] if !opts[:'uri'].nil?
|
|
4531
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
4532
|
+
query_params[:'errors_only'] = opts[:'errors_only'] if !opts[:'errors_only'].nil?
|
|
4533
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
4534
|
+
|
|
4535
|
+
# header parameters
|
|
4536
|
+
header_params = opts[:header_params] || {}
|
|
4537
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4538
|
+
# HTTP header 'Accept' (if needed)
|
|
4539
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4540
|
+
|
|
4541
|
+
# form parameters
|
|
4542
|
+
form_params = opts[:form_params] || {}
|
|
4543
|
+
|
|
4544
|
+
# http body (model)
|
|
4545
|
+
post_body = opts[:debug_body]
|
|
4546
|
+
|
|
4547
|
+
# return_type
|
|
4548
|
+
return_type = opts[:debug_return_type] || 'SfvbServerLogsResponse'
|
|
4549
|
+
|
|
4550
|
+
# auth_names
|
|
4551
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4552
|
+
|
|
4553
|
+
new_options = opts.merge(
|
|
4554
|
+
:operation => :"SfvbApi.list_sfvb_server_logs",
|
|
4555
|
+
:header_params => header_params,
|
|
4556
|
+
:query_params => query_params,
|
|
4557
|
+
:form_params => form_params,
|
|
4558
|
+
:body => post_body,
|
|
4559
|
+
:auth_names => auth_names,
|
|
4560
|
+
:return_type => return_type
|
|
4561
|
+
)
|
|
4562
|
+
|
|
4563
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4564
|
+
if @api_client.config.debugging
|
|
4565
|
+
@api_client.config.logger.debug "API called: SfvbApi#list_sfvb_server_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4566
|
+
end
|
|
4567
|
+
return data, status_code, headers
|
|
4568
|
+
end
|
|
4569
|
+
|
|
4421
4570
|
# List storefronts
|
|
4422
4571
|
# @param [Hash] opts the optional parameters
|
|
4423
4572
|
# @return [SfvbStorefrontsResponse]
|