ultracart_rest_api_v2_typescript 4.1.177 → 4.1.179

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.
Files changed (39) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +127 -1
  4. package/dist/apis/SfvbApi.js +263 -0
  5. package/dist/models/SfvbRecording.d.ts +159 -0
  6. package/dist/models/SfvbRecording.js +94 -0
  7. package/dist/models/SfvbRecordingEvent.d.ts +50 -0
  8. package/dist/models/SfvbRecordingEvent.js +57 -0
  9. package/dist/models/SfvbRecordingEventsResponse.d.ts +49 -0
  10. package/dist/models/SfvbRecordingEventsResponse.js +56 -0
  11. package/dist/models/SfvbRecordingPageView.d.ts +105 -0
  12. package/dist/models/SfvbRecordingPageView.js +76 -0
  13. package/dist/models/SfvbRecordingParameter.d.ts +37 -0
  14. package/dist/models/SfvbRecordingParameter.js +52 -0
  15. package/dist/models/SfvbRecordingResponse.d.ts +32 -0
  16. package/dist/models/SfvbRecordingResponse.js +51 -0
  17. package/dist/models/SfvbServerLog.d.ts +91 -0
  18. package/dist/models/SfvbServerLog.js +70 -0
  19. package/dist/models/SfvbServerLogDetail.d.ts +57 -0
  20. package/dist/models/SfvbServerLogDetail.js +60 -0
  21. package/dist/models/SfvbServerLogEntry.d.ts +49 -0
  22. package/dist/models/SfvbServerLogEntry.js +56 -0
  23. package/dist/models/SfvbServerLogsResponse.d.ts +56 -0
  24. package/dist/models/SfvbServerLogsResponse.js +59 -0
  25. package/dist/models/index.d.ts +10 -0
  26. package/dist/models/index.js +10 -0
  27. package/package.json +1 -1
  28. package/src/apis/SfvbApi.ts +310 -0
  29. package/src/models/SfvbRecording.ts +248 -0
  30. package/src/models/SfvbRecordingEvent.ts +98 -0
  31. package/src/models/SfvbRecordingEventsResponse.ts +91 -0
  32. package/src/models/SfvbRecordingPageView.ts +176 -0
  33. package/src/models/SfvbRecordingParameter.ts +75 -0
  34. package/src/models/SfvbRecordingResponse.ts +74 -0
  35. package/src/models/SfvbServerLog.ts +147 -0
  36. package/src/models/SfvbServerLogDetail.ts +112 -0
  37. package/src/models/SfvbServerLogEntry.ts +91 -0
  38. package/src/models/SfvbServerLogsResponse.ts +106 -0
  39. package/src/models/index.ts +10 -0
@@ -1075,8 +1075,18 @@ src/models/SfvbPreviewAccessResponse.ts
1075
1075
  src/models/SfvbPreviewSessionRequest.ts
1076
1076
  src/models/SfvbPreviewSessionResponse.ts
1077
1077
  src/models/SfvbPreviewUrlResponse.ts
1078
+ src/models/SfvbRecording.ts
1079
+ src/models/SfvbRecordingEvent.ts
1080
+ src/models/SfvbRecordingEventsResponse.ts
1081
+ src/models/SfvbRecordingPageView.ts
1082
+ src/models/SfvbRecordingParameter.ts
1083
+ src/models/SfvbRecordingResponse.ts
1078
1084
  src/models/SfvbRenderRequest.ts
1079
1085
  src/models/SfvbRenderResponse.ts
1086
+ src/models/SfvbServerLog.ts
1087
+ src/models/SfvbServerLogDetail.ts
1088
+ src/models/SfvbServerLogEntry.ts
1089
+ src/models/SfvbServerLogsResponse.ts
1080
1090
  src/models/SfvbSiteAttribute.ts
1081
1091
  src/models/SfvbSiteAttributeUpdate.ts
1082
1092
  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.179
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.179 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.179 | 10/01/2026 | sfvb internal testing |
88
+ | 4.1.178 | 09/30/2026 | sfvb internal testing |
87
89
  | 4.1.177 | 09/30/2026 | sfvb internal testing |
88
90
  | 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
89
91
  | 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, SfvbRecordingEventsResponse, SfvbRecordingResponse, 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,20 @@ export interface GetSfvbPreviewUrlRequest {
189
189
  previewSessionId: string;
190
190
  path?: string;
191
191
  }
192
+ export interface GetSfvbRecordingRequest {
193
+ storefrontOid: number;
194
+ screenRecordingUuid: string;
195
+ }
196
+ export interface GetSfvbRecordingPageViewEventsRequest {
197
+ storefrontOid: number;
198
+ screenRecordingUuid: string;
199
+ screenRecordingPageViewUuid: string;
200
+ }
201
+ export interface GetSfvbServerLogRequest {
202
+ storefrontOid: number;
203
+ logId: string;
204
+ minLevel?: string;
205
+ }
192
206
  export interface GetSfvbSiteAttributesRequest {
193
207
  storefrontOid: number;
194
208
  }
@@ -281,6 +295,13 @@ export interface ListSfvbPagesRequest {
281
295
  storefrontOid: number;
282
296
  under?: string;
283
297
  }
298
+ export interface ListSfvbServerLogsRequest {
299
+ storefrontOid: number;
300
+ uri?: string;
301
+ since?: string;
302
+ errorsOnly?: boolean;
303
+ limit?: number;
304
+ }
284
305
  export interface ListSfvbTemplatesRequest {
285
306
  storefrontOid: number;
286
307
  pageType?: string;
@@ -1111,6 +1132,53 @@ export interface SfvbApiInterface {
1111
1132
  * URL that renders a preview session
1112
1133
  */
1113
1134
  getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
1135
+ /**
1136
+ * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
1137
+ * @summary Get a screen recording
1138
+ * @param {number} storefrontOid
1139
+ * @param {string} screenRecordingUuid
1140
+ * @param {*} [options] Override http request option.
1141
+ * @throws {RequiredError}
1142
+ * @memberof SfvbApiInterface
1143
+ */
1144
+ getSfvbRecordingRaw(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingResponse>>;
1145
+ /**
1146
+ * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
1147
+ * Get a screen recording
1148
+ */
1149
+ getSfvbRecording(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingResponse>;
1150
+ /**
1151
+ * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
1152
+ * @summary Get one recorded page view\'s replay events
1153
+ * @param {number} storefrontOid
1154
+ * @param {string} screenRecordingUuid
1155
+ * @param {string} screenRecordingPageViewUuid
1156
+ * @param {*} [options] Override http request option.
1157
+ * @throws {RequiredError}
1158
+ * @memberof SfvbApiInterface
1159
+ */
1160
+ getSfvbRecordingPageViewEventsRaw(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingEventsResponse>>;
1161
+ /**
1162
+ * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
1163
+ * Get one recorded page view\'s replay events
1164
+ */
1165
+ getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
1166
+ /**
1167
+ * 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.
1168
+ * @summary Get one storefront render log
1169
+ * @param {number} storefrontOid
1170
+ * @param {string} logId
1171
+ * @param {string} [minLevel]
1172
+ * @param {*} [options] Override http request option.
1173
+ * @throws {RequiredError}
1174
+ * @memberof SfvbApiInterface
1175
+ */
1176
+ getSfvbServerLogRaw(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogDetail>>;
1177
+ /**
1178
+ * 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.
1179
+ * Get one storefront render log
1180
+ */
1181
+ getSfvbServerLog(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogDetail>;
1114
1182
  /**
1115
1183
  * 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
1184
  * @summary Read a storefront\'s site attributes
@@ -1439,6 +1507,24 @@ export interface SfvbApiInterface {
1439
1507
  * List the storefront\'s pages
1440
1508
  */
1441
1509
  listSfvbPages(requestParameters: ListSfvbPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageListResponse>;
1510
+ /**
1511
+ * 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.
1512
+ * @summary List recent storefront render logs
1513
+ * @param {number} storefrontOid
1514
+ * @param {string} [uri]
1515
+ * @param {string} [since]
1516
+ * @param {boolean} [errorsOnly]
1517
+ * @param {number} [limit]
1518
+ * @param {*} [options] Override http request option.
1519
+ * @throws {RequiredError}
1520
+ * @memberof SfvbApiInterface
1521
+ */
1522
+ listSfvbServerLogsRaw(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogsResponse>>;
1523
+ /**
1524
+ * 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.
1525
+ * List recent storefront render logs
1526
+ */
1527
+ listSfvbServerLogs(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogsResponse>;
1442
1528
  /**
1443
1529
  *
1444
1530
  * @summary List storefronts
@@ -2478,6 +2564,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2478
2564
  * URL that renders a preview session
2479
2565
  */
2480
2566
  getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
2567
+ /**
2568
+ * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
2569
+ * Get a screen recording
2570
+ */
2571
+ getSfvbRecordingRaw(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingResponse>>;
2572
+ /**
2573
+ * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
2574
+ * Get a screen recording
2575
+ */
2576
+ getSfvbRecording(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingResponse>;
2577
+ /**
2578
+ * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
2579
+ * Get one recorded page view\'s replay events
2580
+ */
2581
+ getSfvbRecordingPageViewEventsRaw(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingEventsResponse>>;
2582
+ /**
2583
+ * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
2584
+ * Get one recorded page view\'s replay events
2585
+ */
2586
+ getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
2587
+ /**
2588
+ * 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.
2589
+ * Get one storefront render log
2590
+ */
2591
+ getSfvbServerLogRaw(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogDetail>>;
2592
+ /**
2593
+ * 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.
2594
+ * Get one storefront render log
2595
+ */
2596
+ getSfvbServerLog(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogDetail>;
2481
2597
  /**
2482
2598
  * 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
2599
  * Read a storefront\'s site attributes
@@ -2686,6 +2802,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2686
2802
  * List the storefront\'s pages
2687
2803
  */
2688
2804
  listSfvbPages(requestParameters: ListSfvbPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageListResponse>;
2805
+ /**
2806
+ * 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.
2807
+ * List recent storefront render logs
2808
+ */
2809
+ listSfvbServerLogsRaw(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogsResponse>>;
2810
+ /**
2811
+ * 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.
2812
+ * List recent storefront render logs
2813
+ */
2814
+ listSfvbServerLogs(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogsResponse>;
2689
2815
  /**
2690
2816
  * List storefronts
2691
2817
  */
@@ -2639,6 +2639,198 @@ var SfvbApi = /** @class */ (function (_super) {
2639
2639
  });
2640
2640
  });
2641
2641
  };
2642
+ /**
2643
+ * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
2644
+ * Get a screen recording
2645
+ */
2646
+ SfvbApi.prototype.getSfvbRecordingRaw = 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 getSfvbRecording.');
2654
+ }
2655
+ if (requestParameters.screenRecordingUuid === null || requestParameters.screenRecordingUuid === undefined) {
2656
+ throw new runtime.RequiredError('screenRecordingUuid', 'Required parameter requestParameters.screenRecordingUuid was null or undefined when calling getSfvbRecording.');
2657
+ }
2658
+ queryParameters = {};
2659
+ headerParameters = {};
2660
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2661
+ // oauth required
2662
+ _a = headerParameters;
2663
+ _b = "Authorization";
2664
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2665
+ case 1:
2666
+ // oauth required
2667
+ _a[_b] = _c.sent();
2668
+ _c.label = 2;
2669
+ case 2:
2670
+ if (this.configuration && this.configuration.apiKey) {
2671
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2672
+ }
2673
+ return [4 /*yield*/, this.request({
2674
+ path: "/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("screen_recording_uuid", "}"), encodeURIComponent(String(requestParameters.screenRecordingUuid))),
2675
+ method: 'GET',
2676
+ headers: headerParameters,
2677
+ query: queryParameters,
2678
+ }, initOverrides)];
2679
+ case 3:
2680
+ response = _c.sent();
2681
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbRecordingResponseFromJSON)(jsonValue); })];
2682
+ }
2683
+ });
2684
+ });
2685
+ };
2686
+ /**
2687
+ * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view\'s replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
2688
+ * Get a screen recording
2689
+ */
2690
+ SfvbApi.prototype.getSfvbRecording = function (requestParameters, initOverrides) {
2691
+ return __awaiter(this, void 0, void 0, function () {
2692
+ var response;
2693
+ return __generator(this, function (_a) {
2694
+ switch (_a.label) {
2695
+ case 0: return [4 /*yield*/, this.getSfvbRecordingRaw(requestParameters, initOverrides)];
2696
+ case 1:
2697
+ response = _a.sent();
2698
+ return [4 /*yield*/, response.value()];
2699
+ case 2: return [2 /*return*/, _a.sent()];
2700
+ }
2701
+ });
2702
+ });
2703
+ };
2704
+ /**
2705
+ * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
2706
+ * Get one recorded page view\'s replay events
2707
+ */
2708
+ SfvbApi.prototype.getSfvbRecordingPageViewEventsRaw = function (requestParameters, initOverrides) {
2709
+ return __awaiter(this, void 0, void 0, function () {
2710
+ var queryParameters, headerParameters, _a, _b, response;
2711
+ return __generator(this, function (_c) {
2712
+ switch (_c.label) {
2713
+ case 0:
2714
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2715
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbRecordingPageViewEvents.');
2716
+ }
2717
+ if (requestParameters.screenRecordingUuid === null || requestParameters.screenRecordingUuid === undefined) {
2718
+ throw new runtime.RequiredError('screenRecordingUuid', 'Required parameter requestParameters.screenRecordingUuid was null or undefined when calling getSfvbRecordingPageViewEvents.');
2719
+ }
2720
+ if (requestParameters.screenRecordingPageViewUuid === null || requestParameters.screenRecordingPageViewUuid === undefined) {
2721
+ throw new runtime.RequiredError('screenRecordingPageViewUuid', 'Required parameter requestParameters.screenRecordingPageViewUuid was null or undefined when calling getSfvbRecordingPageViewEvents.');
2722
+ }
2723
+ queryParameters = {};
2724
+ headerParameters = {};
2725
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2726
+ // oauth required
2727
+ _a = headerParameters;
2728
+ _b = "Authorization";
2729
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2730
+ case 1:
2731
+ // oauth required
2732
+ _a[_b] = _c.sent();
2733
+ _c.label = 2;
2734
+ case 2:
2735
+ if (this.configuration && this.configuration.apiKey) {
2736
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2737
+ }
2738
+ return [4 /*yield*/, this.request({
2739
+ path: "/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("screen_recording_uuid", "}"), encodeURIComponent(String(requestParameters.screenRecordingUuid))).replace("{".concat("screen_recording_page_view_uuid", "}"), encodeURIComponent(String(requestParameters.screenRecordingPageViewUuid))),
2740
+ method: 'GET',
2741
+ headers: headerParameters,
2742
+ query: queryParameters,
2743
+ }, initOverrides)];
2744
+ case 3:
2745
+ response = _c.sent();
2746
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbRecordingEventsResponseFromJSON)(jsonValue); })];
2747
+ }
2748
+ });
2749
+ });
2750
+ };
2751
+ /**
2752
+ * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
2753
+ * Get one recorded page view\'s replay events
2754
+ */
2755
+ SfvbApi.prototype.getSfvbRecordingPageViewEvents = function (requestParameters, initOverrides) {
2756
+ return __awaiter(this, void 0, void 0, function () {
2757
+ var response;
2758
+ return __generator(this, function (_a) {
2759
+ switch (_a.label) {
2760
+ case 0: return [4 /*yield*/, this.getSfvbRecordingPageViewEventsRaw(requestParameters, initOverrides)];
2761
+ case 1:
2762
+ response = _a.sent();
2763
+ return [4 /*yield*/, response.value()];
2764
+ case 2: return [2 /*return*/, _a.sent()];
2765
+ }
2766
+ });
2767
+ });
2768
+ };
2769
+ /**
2770
+ * 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.
2771
+ * Get one storefront render log
2772
+ */
2773
+ SfvbApi.prototype.getSfvbServerLogRaw = function (requestParameters, initOverrides) {
2774
+ return __awaiter(this, void 0, void 0, function () {
2775
+ var queryParameters, headerParameters, _a, _b, response;
2776
+ return __generator(this, function (_c) {
2777
+ switch (_c.label) {
2778
+ case 0:
2779
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2780
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbServerLog.');
2781
+ }
2782
+ if (requestParameters.logId === null || requestParameters.logId === undefined) {
2783
+ throw new runtime.RequiredError('logId', 'Required parameter requestParameters.logId was null or undefined when calling getSfvbServerLog.');
2784
+ }
2785
+ queryParameters = {};
2786
+ if (requestParameters.minLevel !== undefined) {
2787
+ queryParameters['min_level'] = requestParameters.minLevel;
2788
+ }
2789
+ headerParameters = {};
2790
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2791
+ // oauth required
2792
+ _a = headerParameters;
2793
+ _b = "Authorization";
2794
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2795
+ case 1:
2796
+ // oauth required
2797
+ _a[_b] = _c.sent();
2798
+ _c.label = 2;
2799
+ case 2:
2800
+ if (this.configuration && this.configuration.apiKey) {
2801
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2802
+ }
2803
+ return [4 /*yield*/, this.request({
2804
+ path: "/sfvb/storefronts/{storefront_oid}/logs/{log_id}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("log_id", "}"), encodeURIComponent(String(requestParameters.logId))),
2805
+ method: 'GET',
2806
+ headers: headerParameters,
2807
+ query: queryParameters,
2808
+ }, initOverrides)];
2809
+ case 3:
2810
+ response = _c.sent();
2811
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbServerLogDetailFromJSON)(jsonValue); })];
2812
+ }
2813
+ });
2814
+ });
2815
+ };
2816
+ /**
2817
+ * 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.
2818
+ * Get one storefront render log
2819
+ */
2820
+ SfvbApi.prototype.getSfvbServerLog = function (requestParameters, initOverrides) {
2821
+ return __awaiter(this, void 0, void 0, function () {
2822
+ var response;
2823
+ return __generator(this, function (_a) {
2824
+ switch (_a.label) {
2825
+ case 0: return [4 /*yield*/, this.getSfvbServerLogRaw(requestParameters, initOverrides)];
2826
+ case 1:
2827
+ response = _a.sent();
2828
+ return [4 /*yield*/, response.value()];
2829
+ case 2: return [2 /*return*/, _a.sent()];
2830
+ }
2831
+ });
2832
+ });
2833
+ };
2642
2834
  /**
2643
2835
  * 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
2836
  * Read a storefront\'s site attributes
@@ -3989,6 +4181,77 @@ var SfvbApi = /** @class */ (function (_super) {
3989
4181
  });
3990
4182
  });
3991
4183
  };
4184
+ /**
4185
+ * 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.
4186
+ * List recent storefront render logs
4187
+ */
4188
+ SfvbApi.prototype.listSfvbServerLogsRaw = function (requestParameters, initOverrides) {
4189
+ return __awaiter(this, void 0, void 0, function () {
4190
+ var queryParameters, headerParameters, _a, _b, response;
4191
+ return __generator(this, function (_c) {
4192
+ switch (_c.label) {
4193
+ case 0:
4194
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
4195
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling listSfvbServerLogs.');
4196
+ }
4197
+ queryParameters = {};
4198
+ if (requestParameters.uri !== undefined) {
4199
+ queryParameters['uri'] = requestParameters.uri;
4200
+ }
4201
+ if (requestParameters.since !== undefined) {
4202
+ queryParameters['since'] = requestParameters.since;
4203
+ }
4204
+ if (requestParameters.errorsOnly !== undefined) {
4205
+ queryParameters['errors_only'] = requestParameters.errorsOnly;
4206
+ }
4207
+ if (requestParameters.limit !== undefined) {
4208
+ queryParameters['limit'] = requestParameters.limit;
4209
+ }
4210
+ headerParameters = {};
4211
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
4212
+ // oauth required
4213
+ _a = headerParameters;
4214
+ _b = "Authorization";
4215
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
4216
+ case 1:
4217
+ // oauth required
4218
+ _a[_b] = _c.sent();
4219
+ _c.label = 2;
4220
+ case 2:
4221
+ if (this.configuration && this.configuration.apiKey) {
4222
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
4223
+ }
4224
+ return [4 /*yield*/, this.request({
4225
+ path: "/sfvb/storefronts/{storefront_oid}/logs".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
4226
+ method: 'GET',
4227
+ headers: headerParameters,
4228
+ query: queryParameters,
4229
+ }, initOverrides)];
4230
+ case 3:
4231
+ response = _c.sent();
4232
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbServerLogsResponseFromJSON)(jsonValue); })];
4233
+ }
4234
+ });
4235
+ });
4236
+ };
4237
+ /**
4238
+ * 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.
4239
+ * List recent storefront render logs
4240
+ */
4241
+ SfvbApi.prototype.listSfvbServerLogs = function (requestParameters, initOverrides) {
4242
+ return __awaiter(this, void 0, void 0, function () {
4243
+ var response;
4244
+ return __generator(this, function (_a) {
4245
+ switch (_a.label) {
4246
+ case 0: return [4 /*yield*/, this.listSfvbServerLogsRaw(requestParameters, initOverrides)];
4247
+ case 1:
4248
+ response = _a.sent();
4249
+ return [4 /*yield*/, response.value()];
4250
+ case 2: return [2 /*return*/, _a.sent()];
4251
+ }
4252
+ });
4253
+ });
4254
+ };
3992
4255
  /**
3993
4256
  * List storefronts
3994
4257
  */