ultracart_rest_api_v2_typescript 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.
@@ -1077,6 +1077,10 @@ src/models/SfvbPreviewSessionResponse.ts
1077
1077
  src/models/SfvbPreviewUrlResponse.ts
1078
1078
  src/models/SfvbRenderRequest.ts
1079
1079
  src/models/SfvbRenderResponse.ts
1080
+ src/models/SfvbServerLog.ts
1081
+ src/models/SfvbServerLogDetail.ts
1082
+ src/models/SfvbServerLogEntry.ts
1083
+ src/models/SfvbServerLogsResponse.ts
1080
1084
  src/models/SfvbSiteAttribute.ts
1081
1085
  src/models/SfvbSiteAttributeUpdate.ts
1082
1086
  src/models/SfvbSiteAttributeUpdateRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.177
2
+ ## ultracart_rest_api_v2_typescript@4.1.178
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.177 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.178 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.178 | 09/30/2026 | sfvb internal testing |
87
88
  | 4.1.177 | 09/30/2026 | sfvb internal testing |
88
89
  | 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
89
90
  | 4.1.175 | 09/29/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -189,6 +189,11 @@ export interface GetSfvbPreviewUrlRequest {
189
189
  previewSessionId: string;
190
190
  path?: string;
191
191
  }
192
+ export interface GetSfvbServerLogRequest {
193
+ storefrontOid: number;
194
+ logId: string;
195
+ minLevel?: string;
196
+ }
192
197
  export interface GetSfvbSiteAttributesRequest {
193
198
  storefrontOid: number;
194
199
  }
@@ -281,6 +286,13 @@ export interface ListSfvbPagesRequest {
281
286
  storefrontOid: number;
282
287
  under?: string;
283
288
  }
289
+ export interface ListSfvbServerLogsRequest {
290
+ storefrontOid: number;
291
+ uri?: string;
292
+ since?: string;
293
+ errorsOnly?: boolean;
294
+ limit?: number;
295
+ }
284
296
  export interface ListSfvbTemplatesRequest {
285
297
  storefrontOid: number;
286
298
  pageType?: string;
@@ -1111,6 +1123,22 @@ export interface SfvbApiInterface {
1111
1123
  * URL that renders a preview session
1112
1124
  */
1113
1125
  getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
1126
+ /**
1127
+ * 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.
1128
+ * @summary Get one storefront render log
1129
+ * @param {number} storefrontOid
1130
+ * @param {string} logId
1131
+ * @param {string} [minLevel]
1132
+ * @param {*} [options] Override http request option.
1133
+ * @throws {RequiredError}
1134
+ * @memberof SfvbApiInterface
1135
+ */
1136
+ getSfvbServerLogRaw(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogDetail>>;
1137
+ /**
1138
+ * 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.
1139
+ * Get one storefront render log
1140
+ */
1141
+ getSfvbServerLog(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogDetail>;
1114
1142
  /**
1115
1143
  * 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.
1116
1144
  * @summary Read a storefront\'s site attributes
@@ -1439,6 +1467,24 @@ export interface SfvbApiInterface {
1439
1467
  * List the storefront\'s pages
1440
1468
  */
1441
1469
  listSfvbPages(requestParameters: ListSfvbPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageListResponse>;
1470
+ /**
1471
+ * 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.
1472
+ * @summary List recent storefront render logs
1473
+ * @param {number} storefrontOid
1474
+ * @param {string} [uri]
1475
+ * @param {string} [since]
1476
+ * @param {boolean} [errorsOnly]
1477
+ * @param {number} [limit]
1478
+ * @param {*} [options] Override http request option.
1479
+ * @throws {RequiredError}
1480
+ * @memberof SfvbApiInterface
1481
+ */
1482
+ listSfvbServerLogsRaw(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogsResponse>>;
1483
+ /**
1484
+ * 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.
1485
+ * List recent storefront render logs
1486
+ */
1487
+ listSfvbServerLogs(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogsResponse>;
1442
1488
  /**
1443
1489
  *
1444
1490
  * @summary List storefronts
@@ -2478,6 +2524,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2478
2524
  * URL that renders a preview session
2479
2525
  */
2480
2526
  getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
2527
+ /**
2528
+ * 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.
2529
+ * Get one storefront render log
2530
+ */
2531
+ getSfvbServerLogRaw(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogDetail>>;
2532
+ /**
2533
+ * 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.
2534
+ * Get one storefront render log
2535
+ */
2536
+ getSfvbServerLog(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogDetail>;
2481
2537
  /**
2482
2538
  * 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.
2483
2539
  * Read a storefront\'s site attributes
@@ -2686,6 +2742,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2686
2742
  * List the storefront\'s pages
2687
2743
  */
2688
2744
  listSfvbPages(requestParameters: ListSfvbPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageListResponse>;
2745
+ /**
2746
+ * 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.
2747
+ * List recent storefront render logs
2748
+ */
2749
+ listSfvbServerLogsRaw(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogsResponse>>;
2750
+ /**
2751
+ * 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.
2752
+ * List recent storefront render logs
2753
+ */
2754
+ listSfvbServerLogs(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogsResponse>;
2689
2755
  /**
2690
2756
  * List storefronts
2691
2757
  */
@@ -2639,6 +2639,71 @@ var SfvbApi = /** @class */ (function (_super) {
2639
2639
  });
2640
2640
  });
2641
2641
  };
2642
+ /**
2643
+ * 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.
2644
+ * Get one storefront render log
2645
+ */
2646
+ SfvbApi.prototype.getSfvbServerLogRaw = function (requestParameters, initOverrides) {
2647
+ return __awaiter(this, void 0, void 0, function () {
2648
+ var queryParameters, headerParameters, _a, _b, response;
2649
+ return __generator(this, function (_c) {
2650
+ switch (_c.label) {
2651
+ case 0:
2652
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2653
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbServerLog.');
2654
+ }
2655
+ if (requestParameters.logId === null || requestParameters.logId === undefined) {
2656
+ throw new runtime.RequiredError('logId', 'Required parameter requestParameters.logId was null or undefined when calling getSfvbServerLog.');
2657
+ }
2658
+ queryParameters = {};
2659
+ if (requestParameters.minLevel !== undefined) {
2660
+ queryParameters['min_level'] = requestParameters.minLevel;
2661
+ }
2662
+ headerParameters = {};
2663
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2664
+ // oauth required
2665
+ _a = headerParameters;
2666
+ _b = "Authorization";
2667
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2668
+ case 1:
2669
+ // oauth required
2670
+ _a[_b] = _c.sent();
2671
+ _c.label = 2;
2672
+ case 2:
2673
+ if (this.configuration && this.configuration.apiKey) {
2674
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2675
+ }
2676
+ return [4 /*yield*/, this.request({
2677
+ path: "/sfvb/storefronts/{storefront_oid}/logs/{log_id}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("log_id", "}"), encodeURIComponent(String(requestParameters.logId))),
2678
+ method: 'GET',
2679
+ headers: headerParameters,
2680
+ query: queryParameters,
2681
+ }, initOverrides)];
2682
+ case 3:
2683
+ response = _c.sent();
2684
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbServerLogDetailFromJSON)(jsonValue); })];
2685
+ }
2686
+ });
2687
+ });
2688
+ };
2689
+ /**
2690
+ * 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.
2691
+ * Get one storefront render log
2692
+ */
2693
+ SfvbApi.prototype.getSfvbServerLog = function (requestParameters, initOverrides) {
2694
+ return __awaiter(this, void 0, void 0, function () {
2695
+ var response;
2696
+ return __generator(this, function (_a) {
2697
+ switch (_a.label) {
2698
+ case 0: return [4 /*yield*/, this.getSfvbServerLogRaw(requestParameters, initOverrides)];
2699
+ case 1:
2700
+ response = _a.sent();
2701
+ return [4 /*yield*/, response.value()];
2702
+ case 2: return [2 /*return*/, _a.sent()];
2703
+ }
2704
+ });
2705
+ });
2706
+ };
2642
2707
  /**
2643
2708
  * 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.
2644
2709
  * Read a storefront\'s site attributes
@@ -3989,6 +4054,77 @@ var SfvbApi = /** @class */ (function (_super) {
3989
4054
  });
3990
4055
  });
3991
4056
  };
4057
+ /**
4058
+ * 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.
4059
+ * List recent storefront render logs
4060
+ */
4061
+ SfvbApi.prototype.listSfvbServerLogsRaw = function (requestParameters, initOverrides) {
4062
+ return __awaiter(this, void 0, void 0, function () {
4063
+ var queryParameters, headerParameters, _a, _b, response;
4064
+ return __generator(this, function (_c) {
4065
+ switch (_c.label) {
4066
+ case 0:
4067
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
4068
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling listSfvbServerLogs.');
4069
+ }
4070
+ queryParameters = {};
4071
+ if (requestParameters.uri !== undefined) {
4072
+ queryParameters['uri'] = requestParameters.uri;
4073
+ }
4074
+ if (requestParameters.since !== undefined) {
4075
+ queryParameters['since'] = requestParameters.since;
4076
+ }
4077
+ if (requestParameters.errorsOnly !== undefined) {
4078
+ queryParameters['errors_only'] = requestParameters.errorsOnly;
4079
+ }
4080
+ if (requestParameters.limit !== undefined) {
4081
+ queryParameters['limit'] = requestParameters.limit;
4082
+ }
4083
+ headerParameters = {};
4084
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
4085
+ // oauth required
4086
+ _a = headerParameters;
4087
+ _b = "Authorization";
4088
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
4089
+ case 1:
4090
+ // oauth required
4091
+ _a[_b] = _c.sent();
4092
+ _c.label = 2;
4093
+ case 2:
4094
+ if (this.configuration && this.configuration.apiKey) {
4095
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
4096
+ }
4097
+ return [4 /*yield*/, this.request({
4098
+ path: "/sfvb/storefronts/{storefront_oid}/logs".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
4099
+ method: 'GET',
4100
+ headers: headerParameters,
4101
+ query: queryParameters,
4102
+ }, initOverrides)];
4103
+ case 3:
4104
+ response = _c.sent();
4105
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbServerLogsResponseFromJSON)(jsonValue); })];
4106
+ }
4107
+ });
4108
+ });
4109
+ };
4110
+ /**
4111
+ * 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.
4112
+ * List recent storefront render logs
4113
+ */
4114
+ SfvbApi.prototype.listSfvbServerLogs = function (requestParameters, initOverrides) {
4115
+ return __awaiter(this, void 0, void 0, function () {
4116
+ var response;
4117
+ return __generator(this, function (_a) {
4118
+ switch (_a.label) {
4119
+ case 0: return [4 /*yield*/, this.listSfvbServerLogsRaw(requestParameters, initOverrides)];
4120
+ case 1:
4121
+ response = _a.sent();
4122
+ return [4 /*yield*/, response.value()];
4123
+ case 2: return [2 /*return*/, _a.sent()];
4124
+ }
4125
+ });
4126
+ });
4127
+ };
3992
4128
  /**
3993
4129
  * List storefronts
3994
4130
  */
@@ -0,0 +1,91 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbServerLog
16
+ */
17
+ export interface SfvbServerLog {
18
+ /**
19
+ * True when the render itself failed and the page could not be produced.
20
+ * @type {boolean}
21
+ * @memberof SfvbServerLog
22
+ */
23
+ app_error?: boolean;
24
+ /**
25
+ * How long the render took in milliseconds.
26
+ * @type {number}
27
+ * @memberof SfvbServerLog
28
+ */
29
+ duration_ms?: number;
30
+ /**
31
+ * Error lines in the log, including Velocity problems such as a null
32
+ * @type {number}
33
+ * @memberof SfvbServerLog
34
+ */
35
+ error_count?: number;
36
+ /**
37
+ * Lines in the full log text.
38
+ * @type {number}
39
+ * @memberof SfvbServerLog
40
+ */
41
+ line_count?: number;
42
+ /**
43
+ * 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.
44
+ * @type {string}
45
+ * @memberof SfvbServerLog
46
+ */
47
+ log_id?: string;
48
+ /**
49
+ * The template the page rendered with, when known.
50
+ * @type {string}
51
+ * @memberof SfvbServerLog
52
+ */
53
+ request_template?: string;
54
+ /**
55
+ * The address that was rendered, as the server recorded it.
56
+ * @type {string}
57
+ * @memberof SfvbServerLog
58
+ */
59
+ request_url?: string;
60
+ /**
61
+ * When the render started, ISO-8601 in UTC.
62
+ * @type {string}
63
+ * @memberof SfvbServerLog
64
+ */
65
+ start_date?: string;
66
+ /**
67
+ * ERROR when the render logged any error line or failed, otherwise SUCCESS.
68
+ * @type {string}
69
+ * @memberof SfvbServerLog
70
+ */
71
+ status?: string;
72
+ /**
73
+ * When the render finished, ISO-8601 in UTC.
74
+ * @type {string}
75
+ * @memberof SfvbServerLog
76
+ */
77
+ stop_date?: string;
78
+ /**
79
+ * Warning lines in the log.
80
+ * @type {number}
81
+ * @memberof SfvbServerLog
82
+ */
83
+ warning_count?: number;
84
+ }
85
+ /**
86
+ * Check if a given object implements the SfvbServerLog interface.
87
+ */
88
+ export declare function instanceOfSfvbServerLog(value: object): boolean;
89
+ export declare function SfvbServerLogFromJSON(json: any): SfvbServerLog;
90
+ export declare function SfvbServerLogFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbServerLog;
91
+ export declare function SfvbServerLogToJSON(value?: SfvbServerLog | null): any;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbServerLogToJSON = exports.SfvbServerLogFromJSONTyped = exports.SfvbServerLogFromJSON = exports.instanceOfSfvbServerLog = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbServerLog interface.
20
+ */
21
+ function instanceOfSfvbServerLog(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbServerLog = instanceOfSfvbServerLog;
26
+ function SfvbServerLogFromJSON(json) {
27
+ return SfvbServerLogFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbServerLogFromJSON = SfvbServerLogFromJSON;
30
+ function SfvbServerLogFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'app_error': !(0, runtime_1.exists)(json, 'app_error') ? undefined : json['app_error'],
36
+ 'duration_ms': !(0, runtime_1.exists)(json, 'duration_ms') ? undefined : json['duration_ms'],
37
+ 'error_count': !(0, runtime_1.exists)(json, 'error_count') ? undefined : json['error_count'],
38
+ 'line_count': !(0, runtime_1.exists)(json, 'line_count') ? undefined : json['line_count'],
39
+ 'log_id': !(0, runtime_1.exists)(json, 'log_id') ? undefined : json['log_id'],
40
+ 'request_template': !(0, runtime_1.exists)(json, 'request_template') ? undefined : json['request_template'],
41
+ 'request_url': !(0, runtime_1.exists)(json, 'request_url') ? undefined : json['request_url'],
42
+ 'start_date': !(0, runtime_1.exists)(json, 'start_date') ? undefined : json['start_date'],
43
+ 'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
44
+ 'stop_date': !(0, runtime_1.exists)(json, 'stop_date') ? undefined : json['stop_date'],
45
+ 'warning_count': !(0, runtime_1.exists)(json, 'warning_count') ? undefined : json['warning_count'],
46
+ };
47
+ }
48
+ exports.SfvbServerLogFromJSONTyped = SfvbServerLogFromJSONTyped;
49
+ function SfvbServerLogToJSON(value) {
50
+ if (value === undefined) {
51
+ return undefined;
52
+ }
53
+ if (value === null) {
54
+ return null;
55
+ }
56
+ return {
57
+ 'app_error': value.app_error,
58
+ 'duration_ms': value.duration_ms,
59
+ 'error_count': value.error_count,
60
+ 'line_count': value.line_count,
61
+ 'log_id': value.log_id,
62
+ 'request_template': value.request_template,
63
+ 'request_url': value.request_url,
64
+ 'start_date': value.start_date,
65
+ 'status': value.status,
66
+ 'stop_date': value.stop_date,
67
+ 'warning_count': value.warning_count,
68
+ };
69
+ }
70
+ exports.SfvbServerLogToJSON = SfvbServerLogToJSON;
@@ -0,0 +1,57 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { SfvbServerLog } from './SfvbServerLog';
13
+ import { SfvbServerLogEntry } from './SfvbServerLogEntry';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface SfvbServerLogDetail
18
+ */
19
+ export interface SfvbServerLogDetail {
20
+ /**
21
+ * The log's lines in the order they were written, at or above min_level.
22
+ * @type {Array<SfvbServerLogEntry>}
23
+ * @memberof SfvbServerLogDetail
24
+ */
25
+ entries?: Array<SfvbServerLogEntry>;
26
+ /**
27
+ *
28
+ * @type {SfvbServerLog}
29
+ * @memberof SfvbServerLogDetail
30
+ */
31
+ log?: SfvbServerLog;
32
+ /**
33
+ * The lowest level included in entries.
34
+ * @type {string}
35
+ * @memberof SfvbServerLogDetail
36
+ */
37
+ min_level?: string;
38
+ /**
39
+ * The address of the browser that asked for the page, as the backend log viewer shows it.
40
+ * @type {string}
41
+ * @memberof SfvbServerLogDetail
42
+ */
43
+ remote_ip?: string;
44
+ /**
45
+ * The browser's user agent, as the backend log viewer shows it.
46
+ * @type {string}
47
+ * @memberof SfvbServerLogDetail
48
+ */
49
+ user_agent?: string;
50
+ }
51
+ /**
52
+ * Check if a given object implements the SfvbServerLogDetail interface.
53
+ */
54
+ export declare function instanceOfSfvbServerLogDetail(value: object): boolean;
55
+ export declare function SfvbServerLogDetailFromJSON(json: any): SfvbServerLogDetail;
56
+ export declare function SfvbServerLogDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbServerLogDetail;
57
+ export declare function SfvbServerLogDetailToJSON(value?: SfvbServerLogDetail | null): any;
@@ -0,0 +1,60 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbServerLogDetailToJSON = exports.SfvbServerLogDetailFromJSONTyped = exports.SfvbServerLogDetailFromJSON = exports.instanceOfSfvbServerLogDetail = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var SfvbServerLog_1 = require("./SfvbServerLog");
19
+ var SfvbServerLogEntry_1 = require("./SfvbServerLogEntry");
20
+ /**
21
+ * Check if a given object implements the SfvbServerLogDetail interface.
22
+ */
23
+ function instanceOfSfvbServerLogDetail(value) {
24
+ var isInstance = true;
25
+ return isInstance;
26
+ }
27
+ exports.instanceOfSfvbServerLogDetail = instanceOfSfvbServerLogDetail;
28
+ function SfvbServerLogDetailFromJSON(json) {
29
+ return SfvbServerLogDetailFromJSONTyped(json, false);
30
+ }
31
+ exports.SfvbServerLogDetailFromJSON = SfvbServerLogDetailFromJSON;
32
+ function SfvbServerLogDetailFromJSONTyped(json, ignoreDiscriminator) {
33
+ if ((json === undefined) || (json === null)) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'entries': !(0, runtime_1.exists)(json, 'entries') ? undefined : (json['entries'].map(SfvbServerLogEntry_1.SfvbServerLogEntryFromJSON)),
38
+ 'log': !(0, runtime_1.exists)(json, 'log') ? undefined : (0, SfvbServerLog_1.SfvbServerLogFromJSON)(json['log']),
39
+ 'min_level': !(0, runtime_1.exists)(json, 'min_level') ? undefined : json['min_level'],
40
+ 'remote_ip': !(0, runtime_1.exists)(json, 'remote_ip') ? undefined : json['remote_ip'],
41
+ 'user_agent': !(0, runtime_1.exists)(json, 'user_agent') ? undefined : json['user_agent'],
42
+ };
43
+ }
44
+ exports.SfvbServerLogDetailFromJSONTyped = SfvbServerLogDetailFromJSONTyped;
45
+ function SfvbServerLogDetailToJSON(value) {
46
+ if (value === undefined) {
47
+ return undefined;
48
+ }
49
+ if (value === null) {
50
+ return null;
51
+ }
52
+ return {
53
+ 'entries': value.entries === undefined ? undefined : (value.entries.map(SfvbServerLogEntry_1.SfvbServerLogEntryToJSON)),
54
+ 'log': (0, SfvbServerLog_1.SfvbServerLogToJSON)(value.log),
55
+ 'min_level': value.min_level,
56
+ 'remote_ip': value.remote_ip,
57
+ 'user_agent': value.user_agent,
58
+ };
59
+ }
60
+ exports.SfvbServerLogDetailToJSON = SfvbServerLogDetailToJSON;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbServerLogEntry
16
+ */
17
+ export interface SfvbServerLogEntry {
18
+ /**
19
+ * The area that wrote the line, such as VELOCITY, FLOW, CACHE or RUNTIME. Empty for SYSERR lines.
20
+ * @type {string}
21
+ * @memberof SfvbServerLogEntry
22
+ */
23
+ category?: string;
24
+ /**
25
+ * DEBUG, INFO, WARN, ERROR or SYSERR. SYSERR is an internal logging failure and counts as an error.
26
+ * @type {string}
27
+ * @memberof SfvbServerLogEntry
28
+ */
29
+ level?: string;
30
+ /**
31
+ * 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.
32
+ * @type {string}
33
+ * @memberof SfvbServerLogEntry
34
+ */
35
+ logged_at?: string;
36
+ /**
37
+ * The line's text. A message that spanned several lines keeps its line breaks.
38
+ * @type {string}
39
+ * @memberof SfvbServerLogEntry
40
+ */
41
+ message?: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the SfvbServerLogEntry interface.
45
+ */
46
+ export declare function instanceOfSfvbServerLogEntry(value: object): boolean;
47
+ export declare function SfvbServerLogEntryFromJSON(json: any): SfvbServerLogEntry;
48
+ export declare function SfvbServerLogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbServerLogEntry;
49
+ export declare function SfvbServerLogEntryToJSON(value?: SfvbServerLogEntry | null): any;