ultracart_rest_api_v2_typescript 4.1.200 → 4.1.201
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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +3 -2
- package/dist/apis/SfvbApi.d.ts +73 -13
- package/dist/apis/SfvbApi.js +134 -6
- package/dist/models/SfvbContainerVersion.d.ts +1 -1
- package/dist/models/SfvbEvent.d.ts +61 -0
- package/dist/models/SfvbEvent.js +60 -0
- package/dist/models/SfvbEventsAuthRequest.d.ts +31 -0
- package/dist/models/SfvbEventsAuthRequest.js +50 -0
- package/dist/models/SfvbEventsAuthResponse.d.ts +43 -0
- package/dist/models/SfvbEventsAuthResponse.js +54 -0
- package/dist/models/SfvbEventsResponse.d.ts +44 -0
- package/dist/models/SfvbEventsResponse.js +55 -0
- package/dist/models/SfvbI18nMessageValue.d.ts +1 -1
- package/dist/models/SfvbThemeJobResponse.d.ts +3 -3
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +160 -12
- package/src/models/SfvbContainerVersion.ts +1 -1
- package/src/models/SfvbEvent.ts +107 -0
- package/src/models/SfvbEventsAuthRequest.ts +67 -0
- package/src/models/SfvbEventsAuthResponse.ts +83 -0
- package/src/models/SfvbEventsResponse.ts +90 -0
- package/src/models/SfvbI18nMessageValue.ts +1 -1
- package/src/models/SfvbThemeJobResponse.ts +3 -3
- package/src/models/index.ts +4 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1018,6 +1018,10 @@ src/models/SfvbElement.ts
|
|
|
1018
1018
|
src/models/SfvbElementSchemaResponse.ts
|
|
1019
1019
|
src/models/SfvbElementsResponse.ts
|
|
1020
1020
|
src/models/SfvbErrorDetail.ts
|
|
1021
|
+
src/models/SfvbEvent.ts
|
|
1022
|
+
src/models/SfvbEventsAuthRequest.ts
|
|
1023
|
+
src/models/SfvbEventsAuthResponse.ts
|
|
1024
|
+
src/models/SfvbEventsResponse.ts
|
|
1021
1025
|
src/models/SfvbExperiment.ts
|
|
1022
1026
|
src/models/SfvbExperimentEndRequest.ts
|
|
1023
1027
|
src/models/SfvbExperimentObjective.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.201
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.201 --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.201 | 10/12/2026 | sfvb internal testing |
|
|
87
88
|
| 4.1.200 | 10/09/2026 | sfvb internal testing |
|
|
88
89
|
| 4.1.199 | 10/08/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.198 | 10/08/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, 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, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, 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;
|
|
@@ -214,6 +214,14 @@ export interface GetSfvbContainerVersionRequest {
|
|
|
214
214
|
export interface GetSfvbElementRequest {
|
|
215
215
|
elementType: string;
|
|
216
216
|
}
|
|
217
|
+
export interface GetSfvbEventsRequest {
|
|
218
|
+
after?: string;
|
|
219
|
+
storefrontOid?: number;
|
|
220
|
+
limit?: number;
|
|
221
|
+
}
|
|
222
|
+
export interface GetSfvbEventsAuthorizationRequest {
|
|
223
|
+
eventsAuthRequest?: SfvbEventsAuthRequest;
|
|
224
|
+
}
|
|
217
225
|
export interface GetSfvbExperimentRequest {
|
|
218
226
|
storefrontOid: number;
|
|
219
227
|
experimentOid: number;
|
|
@@ -298,6 +306,7 @@ export interface GetSfvbNotFoundRequest {
|
|
|
298
306
|
includeTokens?: boolean;
|
|
299
307
|
q?: string;
|
|
300
308
|
limit?: number;
|
|
309
|
+
redirected?: boolean;
|
|
301
310
|
}
|
|
302
311
|
export interface GetSfvbNotFoundEntryRequest {
|
|
303
312
|
storefrontOid: number;
|
|
@@ -1362,7 +1371,7 @@ export interface SfvbApiInterface {
|
|
|
1362
1371
|
*/
|
|
1363
1372
|
enableSfvbUpsellPath(requestParameters: EnableSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
1364
1373
|
/**
|
|
1365
|
-
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
1374
|
+
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person\'s approval session (see POST /sfvb/approvals).
|
|
1366
1375
|
* @summary End an experiment
|
|
1367
1376
|
* @param {number} storefrontOid
|
|
1368
1377
|
* @param {number} experimentOid
|
|
@@ -1374,7 +1383,7 @@ export interface SfvbApiInterface {
|
|
|
1374
1383
|
*/
|
|
1375
1384
|
endSfvbExperimentRaw(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbExperiment>>;
|
|
1376
1385
|
/**
|
|
1377
|
-
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
1386
|
+
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person\'s approval session (see POST /sfvb/approvals).
|
|
1378
1387
|
* End an experiment
|
|
1379
1388
|
*/
|
|
1380
1389
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
@@ -1497,6 +1506,36 @@ export interface SfvbApiInterface {
|
|
|
1497
1506
|
* Configuration schema and field card for one element type
|
|
1498
1507
|
*/
|
|
1499
1508
|
getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
|
|
1509
|
+
/**
|
|
1510
|
+
* The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
1511
|
+
* @summary Replay events
|
|
1512
|
+
* @param {string} [after] Return events after this event_id. Leave it out for every event kept.
|
|
1513
|
+
* @param {number} [storefrontOid] Only events about this storefront, plus merchant-level ones.
|
|
1514
|
+
* @param {number} [limit] At most this many events, 1 to 500.
|
|
1515
|
+
* @param {*} [options] Override http request option.
|
|
1516
|
+
* @throws {RequiredError}
|
|
1517
|
+
* @memberof SfvbApiInterface
|
|
1518
|
+
*/
|
|
1519
|
+
getSfvbEventsRaw(requestParameters: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsResponse>>;
|
|
1520
|
+
/**
|
|
1521
|
+
* The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
1522
|
+
* Replay events
|
|
1523
|
+
*/
|
|
1524
|
+
getSfvbEvents(requestParameters: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsResponse>;
|
|
1525
|
+
/**
|
|
1526
|
+
* Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person\'s event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
1527
|
+
* @summary Open the event stream
|
|
1528
|
+
* @param {SfvbEventsAuthRequest} [eventsAuthRequest] Optional storefront filter
|
|
1529
|
+
* @param {*} [options] Override http request option.
|
|
1530
|
+
* @throws {RequiredError}
|
|
1531
|
+
* @memberof SfvbApiInterface
|
|
1532
|
+
*/
|
|
1533
|
+
getSfvbEventsAuthorizationRaw(requestParameters: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsAuthResponse>>;
|
|
1534
|
+
/**
|
|
1535
|
+
* Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person\'s event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
1536
|
+
* Open the event stream
|
|
1537
|
+
*/
|
|
1538
|
+
getSfvbEventsAuthorization(requestParameters: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsAuthResponse>;
|
|
1500
1539
|
/**
|
|
1501
1540
|
* The experiment, its variations and their statistics, and with daily=true each variation\'s daily rows. p95_sessions_needed is estimated only after 1000 sessions, and sessions_needed_computed_dts says when. For a url experiment, router_url is the address visitors must enter through.
|
|
1502
1541
|
* @summary Read one experiment and its statistics
|
|
@@ -1772,7 +1811,7 @@ export interface SfvbApiInterface {
|
|
|
1772
1811
|
*/
|
|
1773
1812
|
getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
|
|
1774
1813
|
/**
|
|
1775
|
-
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
1814
|
+
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
1776
1815
|
* @summary List the paths that answered 404
|
|
1777
1816
|
* @param {number} storefrontOid
|
|
1778
1817
|
* @param {string} [since]
|
|
@@ -1781,13 +1820,14 @@ export interface SfvbApiInterface {
|
|
|
1781
1820
|
* @param {boolean} [includeTokens]
|
|
1782
1821
|
* @param {string} [q]
|
|
1783
1822
|
* @param {number} [limit]
|
|
1823
|
+
* @param {boolean} [redirected]
|
|
1784
1824
|
* @param {*} [options] Override http request option.
|
|
1785
1825
|
* @throws {RequiredError}
|
|
1786
1826
|
* @memberof SfvbApiInterface
|
|
1787
1827
|
*/
|
|
1788
1828
|
getSfvbNotFoundRaw(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundResponse>>;
|
|
1789
1829
|
/**
|
|
1790
|
-
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
1830
|
+
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
1791
1831
|
* List the paths that answered 404
|
|
1792
1832
|
*/
|
|
1793
1833
|
getSfvbNotFound(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundResponse>;
|
|
@@ -2634,7 +2674,7 @@ export interface SfvbApiInterface {
|
|
|
2634
2674
|
*/
|
|
2635
2675
|
putSfvbI18nGlossary(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
2636
2676
|
/**
|
|
2637
|
-
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
2677
|
+
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language\'s translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can\'t be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
2638
2678
|
* @summary Change one built-in message
|
|
2639
2679
|
* @param {number} storefrontOid
|
|
2640
2680
|
* @param {string} key
|
|
@@ -2647,7 +2687,7 @@ export interface SfvbApiInterface {
|
|
|
2647
2687
|
*/
|
|
2648
2688
|
putSfvbI18nMessageRaw(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
2649
2689
|
/**
|
|
2650
|
-
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
2690
|
+
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language\'s translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can\'t be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
2651
2691
|
* Change one built-in message
|
|
2652
2692
|
*/
|
|
2653
2693
|
putSfvbI18nMessage(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
@@ -3733,12 +3773,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3733
3773
|
*/
|
|
3734
3774
|
enableSfvbUpsellPath(requestParameters: EnableSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
3735
3775
|
/**
|
|
3736
|
-
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
3776
|
+
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person\'s approval session (see POST /sfvb/approvals).
|
|
3737
3777
|
* End an experiment
|
|
3738
3778
|
*/
|
|
3739
3779
|
endSfvbExperimentRaw(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbExperiment>>;
|
|
3740
3780
|
/**
|
|
3741
|
-
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
3781
|
+
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person\'s approval session (see POST /sfvb/approvals).
|
|
3742
3782
|
* End an experiment
|
|
3743
3783
|
*/
|
|
3744
3784
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
@@ -3820,6 +3860,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3820
3860
|
* Configuration schema and field card for one element type
|
|
3821
3861
|
*/
|
|
3822
3862
|
getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
|
|
3863
|
+
/**
|
|
3864
|
+
* The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
3865
|
+
* Replay events
|
|
3866
|
+
*/
|
|
3867
|
+
getSfvbEventsRaw(requestParameters: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsResponse>>;
|
|
3868
|
+
/**
|
|
3869
|
+
* The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
3870
|
+
* Replay events
|
|
3871
|
+
*/
|
|
3872
|
+
getSfvbEvents(requestParameters?: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsResponse>;
|
|
3873
|
+
/**
|
|
3874
|
+
* Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person\'s event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
3875
|
+
* Open the event stream
|
|
3876
|
+
*/
|
|
3877
|
+
getSfvbEventsAuthorizationRaw(requestParameters: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsAuthResponse>>;
|
|
3878
|
+
/**
|
|
3879
|
+
* Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person\'s event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
3880
|
+
* Open the event stream
|
|
3881
|
+
*/
|
|
3882
|
+
getSfvbEventsAuthorization(requestParameters?: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsAuthResponse>;
|
|
3823
3883
|
/**
|
|
3824
3884
|
* The experiment, its variations and their statistics, and with daily=true each variation\'s daily rows. p95_sessions_needed is estimated only after 1000 sessions, and sessions_needed_computed_dts says when. For a url experiment, router_url is the address visitors must enter through.
|
|
3825
3885
|
* Read one experiment and its statistics
|
|
@@ -4001,12 +4061,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4001
4061
|
*/
|
|
4002
4062
|
getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
|
|
4003
4063
|
/**
|
|
4004
|
-
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
4064
|
+
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
4005
4065
|
* List the paths that answered 404
|
|
4006
4066
|
*/
|
|
4007
4067
|
getSfvbNotFoundRaw(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundResponse>>;
|
|
4008
4068
|
/**
|
|
4009
|
-
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
4069
|
+
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
4010
4070
|
* List the paths that answered 404
|
|
4011
4071
|
*/
|
|
4012
4072
|
getSfvbNotFound(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundResponse>;
|
|
@@ -4537,12 +4597,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4537
4597
|
*/
|
|
4538
4598
|
putSfvbI18nGlossary(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
4539
4599
|
/**
|
|
4540
|
-
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
4600
|
+
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language\'s translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can\'t be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
4541
4601
|
* Change one built-in message
|
|
4542
4602
|
*/
|
|
4543
4603
|
putSfvbI18nMessageRaw(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
4544
4604
|
/**
|
|
4545
|
-
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
4605
|
+
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language\'s translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can\'t be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
4546
4606
|
* Change one built-in message
|
|
4547
4607
|
*/
|
|
4548
4608
|
putSfvbI18nMessage(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -2421,7 +2421,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2421
2421
|
});
|
|
2422
2422
|
};
|
|
2423
2423
|
/**
|
|
2424
|
-
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
2424
|
+
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person\'s approval session (see POST /sfvb/approvals).
|
|
2425
2425
|
* End an experiment
|
|
2426
2426
|
*/
|
|
2427
2427
|
SfvbApi.prototype.endSfvbExperimentRaw = function (requestParameters, initOverrides) {
|
|
@@ -2470,7 +2470,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2470
2470
|
});
|
|
2471
2471
|
};
|
|
2472
2472
|
/**
|
|
2473
|
-
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner
|
|
2473
|
+
* Ends a running experiment. With winner_variation_number the winner gets every visitor, including visitors already assigned to another variation, and a page experiment\'s winning content is promoted into the page by the completion job on its next run, which also emails the merchant. Without a winner a page experiment\'s id is cleared from its page body so the page shows variation 0, and a url experiment sends everyone to variation 0. Always needs sfvb_publish, and the approval of the person who signed in the CLI - an approved experiment.end request for this experiment and winner. An end with a winner always needs a fresh authenticator code; an end without a winner can be covered by the person\'s approval session (see POST /sfvb/approvals).
|
|
2474
2474
|
* End an experiment
|
|
2475
2475
|
*/
|
|
2476
2476
|
SfvbApi.prototype.endSfvbExperiment = function (requestParameters, initOverrides) {
|
|
@@ -2981,6 +2981,131 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
2981
2981
|
});
|
|
2982
2982
|
});
|
|
2983
2983
|
};
|
|
2984
|
+
/**
|
|
2985
|
+
* The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
2986
|
+
* Replay events
|
|
2987
|
+
*/
|
|
2988
|
+
SfvbApi.prototype.getSfvbEventsRaw = function (requestParameters, initOverrides) {
|
|
2989
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2990
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
2991
|
+
return __generator(this, function (_c) {
|
|
2992
|
+
switch (_c.label) {
|
|
2993
|
+
case 0:
|
|
2994
|
+
queryParameters = {};
|
|
2995
|
+
if (requestParameters.after !== undefined) {
|
|
2996
|
+
queryParameters['after'] = requestParameters.after;
|
|
2997
|
+
}
|
|
2998
|
+
if (requestParameters.storefrontOid !== undefined) {
|
|
2999
|
+
queryParameters['storefront_oid'] = requestParameters.storefrontOid;
|
|
3000
|
+
}
|
|
3001
|
+
if (requestParameters.limit !== undefined) {
|
|
3002
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
3003
|
+
}
|
|
3004
|
+
headerParameters = {};
|
|
3005
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
3006
|
+
// oauth required
|
|
3007
|
+
_a = headerParameters;
|
|
3008
|
+
_b = "Authorization";
|
|
3009
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
3010
|
+
case 1:
|
|
3011
|
+
// oauth required
|
|
3012
|
+
_a[_b] = _c.sent();
|
|
3013
|
+
_c.label = 2;
|
|
3014
|
+
case 2:
|
|
3015
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
3016
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
3017
|
+
}
|
|
3018
|
+
return [4 /*yield*/, this.request({
|
|
3019
|
+
path: "/sfvb/events",
|
|
3020
|
+
method: 'GET',
|
|
3021
|
+
headers: headerParameters,
|
|
3022
|
+
query: queryParameters,
|
|
3023
|
+
}, initOverrides)];
|
|
3024
|
+
case 3:
|
|
3025
|
+
response = _c.sent();
|
|
3026
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbEventsResponseFromJSON)(jsonValue); })];
|
|
3027
|
+
}
|
|
3028
|
+
});
|
|
3029
|
+
});
|
|
3030
|
+
};
|
|
3031
|
+
/**
|
|
3032
|
+
* The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
|
|
3033
|
+
* Replay events
|
|
3034
|
+
*/
|
|
3035
|
+
SfvbApi.prototype.getSfvbEvents = function (requestParameters, initOverrides) {
|
|
3036
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
3037
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3038
|
+
var response;
|
|
3039
|
+
return __generator(this, function (_a) {
|
|
3040
|
+
switch (_a.label) {
|
|
3041
|
+
case 0: return [4 /*yield*/, this.getSfvbEventsRaw(requestParameters, initOverrides)];
|
|
3042
|
+
case 1:
|
|
3043
|
+
response = _a.sent();
|
|
3044
|
+
return [4 /*yield*/, response.value()];
|
|
3045
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
3046
|
+
}
|
|
3047
|
+
});
|
|
3048
|
+
});
|
|
3049
|
+
};
|
|
3050
|
+
/**
|
|
3051
|
+
* Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person\'s event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
3052
|
+
* Open the event stream
|
|
3053
|
+
*/
|
|
3054
|
+
SfvbApi.prototype.getSfvbEventsAuthorizationRaw = function (requestParameters, initOverrides) {
|
|
3055
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3056
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
3057
|
+
return __generator(this, function (_c) {
|
|
3058
|
+
switch (_c.label) {
|
|
3059
|
+
case 0:
|
|
3060
|
+
queryParameters = {};
|
|
3061
|
+
headerParameters = {};
|
|
3062
|
+
headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
|
|
3063
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
3064
|
+
// oauth required
|
|
3065
|
+
_a = headerParameters;
|
|
3066
|
+
_b = "Authorization";
|
|
3067
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
3068
|
+
case 1:
|
|
3069
|
+
// oauth required
|
|
3070
|
+
_a[_b] = _c.sent();
|
|
3071
|
+
_c.label = 2;
|
|
3072
|
+
case 2:
|
|
3073
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
3074
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
3075
|
+
}
|
|
3076
|
+
return [4 /*yield*/, this.request({
|
|
3077
|
+
path: "/sfvb/events/auth",
|
|
3078
|
+
method: 'PUT',
|
|
3079
|
+
headers: headerParameters,
|
|
3080
|
+
query: queryParameters,
|
|
3081
|
+
body: (0, models_1.SfvbEventsAuthRequestToJSON)(requestParameters.eventsAuthRequest),
|
|
3082
|
+
}, initOverrides)];
|
|
3083
|
+
case 3:
|
|
3084
|
+
response = _c.sent();
|
|
3085
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbEventsAuthResponseFromJSON)(jsonValue); })];
|
|
3086
|
+
}
|
|
3087
|
+
});
|
|
3088
|
+
});
|
|
3089
|
+
};
|
|
3090
|
+
/**
|
|
3091
|
+
* Returns a websocket URL and a single-use token, valid for 5 minutes, for the signed-in person\'s event stream. Events are thin hints, type and ids only, and the stream is at most once. Re-read the object before acting, and after every reconnect replay from the last event_id with GET events. Send ping messages to keep the connection open, and reconnect with a new token before two hours. Requires a token that resolves to a user, so use the device authorization flow.
|
|
3092
|
+
* Open the event stream
|
|
3093
|
+
*/
|
|
3094
|
+
SfvbApi.prototype.getSfvbEventsAuthorization = function (requestParameters, initOverrides) {
|
|
3095
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
3096
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3097
|
+
var response;
|
|
3098
|
+
return __generator(this, function (_a) {
|
|
3099
|
+
switch (_a.label) {
|
|
3100
|
+
case 0: return [4 /*yield*/, this.getSfvbEventsAuthorizationRaw(requestParameters, initOverrides)];
|
|
3101
|
+
case 1:
|
|
3102
|
+
response = _a.sent();
|
|
3103
|
+
return [4 /*yield*/, response.value()];
|
|
3104
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
3105
|
+
}
|
|
3106
|
+
});
|
|
3107
|
+
});
|
|
3108
|
+
};
|
|
2984
3109
|
/**
|
|
2985
3110
|
* The experiment, its variations and their statistics, and with daily=true each variation\'s daily rows. p95_sessions_needed is estimated only after 1000 sessions, and sessions_needed_computed_dts says when. For a url experiment, router_url is the address visitors must enter through.
|
|
2986
3111
|
* Read one experiment and its statistics
|
|
@@ -4110,7 +4235,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
4110
4235
|
});
|
|
4111
4236
|
};
|
|
4112
4237
|
/**
|
|
4113
|
-
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
4238
|
+
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
4114
4239
|
* List the paths that answered 404
|
|
4115
4240
|
*/
|
|
4116
4241
|
SfvbApi.prototype.getSfvbNotFoundRaw = function (requestParameters, initOverrides) {
|
|
@@ -4141,6 +4266,9 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
4141
4266
|
if (requestParameters.limit !== undefined) {
|
|
4142
4267
|
queryParameters['limit'] = requestParameters.limit;
|
|
4143
4268
|
}
|
|
4269
|
+
if (requestParameters.redirected !== undefined) {
|
|
4270
|
+
queryParameters['redirected'] = requestParameters.redirected;
|
|
4271
|
+
}
|
|
4144
4272
|
headerParameters = {};
|
|
4145
4273
|
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
4146
4274
|
// oauth required
|
|
@@ -4169,7 +4297,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
4169
4297
|
});
|
|
4170
4298
|
};
|
|
4171
4299
|
/**
|
|
4172
|
-
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. limit is 1 to 100, default 50.
|
|
4300
|
+
* The paths shoppers asked for that answered 404, most hits first or by last_seen. Paths only, never query strings. Bots are left out unless include_bots. Token-like path segments show as {token} unless include_tokens. A path stays listed after a redirect rule catches it, with redirected_to set. redirected=false lists only paths no rule catches yet, and redirected=true only those one does. limit is 1 to 100, default 50.
|
|
4173
4301
|
* List the paths that answered 404
|
|
4174
4302
|
*/
|
|
4175
4303
|
SfvbApi.prototype.getSfvbNotFound = function (requestParameters, initOverrides) {
|
|
@@ -7662,7 +7790,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
7662
7790
|
});
|
|
7663
7791
|
};
|
|
7664
7792
|
/**
|
|
7665
|
-
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
7793
|
+
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language\'s translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can\'t be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
7666
7794
|
* Change one built-in message
|
|
7667
7795
|
*/
|
|
7668
7796
|
SfvbApi.prototype.putSfvbI18nMessageRaw = function (requestParameters, initOverrides) {
|
|
@@ -7720,7 +7848,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
7720
7848
|
});
|
|
7721
7849
|
};
|
|
7722
7850
|
/**
|
|
7723
|
-
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone;
|
|
7851
|
+
* Sets one message in any number of languages. ENG replaces the English, which drops its machine translations so they regenerate. Any other language becomes a hand translation. Languages not named are left alone. Empty text removes that language\'s translation so machine translation fills it again (not allowed for ENG); it is the undo for an imported message, which can\'t be reset. Shoppers see it at once. Always needs sfvb_publish.
|
|
7724
7852
|
* Change one built-in message
|
|
7725
7853
|
*/
|
|
7726
7854
|
SfvbApi.prototype.putSfvbI18nMessage = function (requestParameters, initOverrides) {
|
|
@@ -0,0 +1,61 @@
|
|
|
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 SfvbEvent
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbEvent {
|
|
18
|
+
/**
|
|
19
|
+
* When it happened, ISO 8601.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SfvbEvent
|
|
22
|
+
*/
|
|
23
|
+
event_dts?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Time-ordered id. Pass the last one seen as after to replay what came since.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SfvbEvent
|
|
28
|
+
*/
|
|
29
|
+
event_id?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The id of what changed, such as the approval_id.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SfvbEvent
|
|
34
|
+
*/
|
|
35
|
+
object_id?: string;
|
|
36
|
+
/**
|
|
37
|
+
* What changed, such as approval.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof SfvbEvent
|
|
40
|
+
*/
|
|
41
|
+
object_type?: string;
|
|
42
|
+
/**
|
|
43
|
+
* The storefront it concerns. Empty for merchant-level objects.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof SfvbEvent
|
|
46
|
+
*/
|
|
47
|
+
storefront_oid?: number;
|
|
48
|
+
/**
|
|
49
|
+
* approval.decided (approved, denied, cancelled or refused by the script review) or approval.ready (the review finished and the person can decide).
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof SfvbEvent
|
|
52
|
+
*/
|
|
53
|
+
type?: string;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Check if a given object implements the SfvbEvent interface.
|
|
57
|
+
*/
|
|
58
|
+
export declare function instanceOfSfvbEvent(value: object): boolean;
|
|
59
|
+
export declare function SfvbEventFromJSON(json: any): SfvbEvent;
|
|
60
|
+
export declare function SfvbEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbEvent;
|
|
61
|
+
export declare function SfvbEventToJSON(value?: SfvbEvent | 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.SfvbEventToJSON = exports.SfvbEventFromJSONTyped = exports.SfvbEventFromJSON = exports.instanceOfSfvbEvent = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the SfvbEvent interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfSfvbEvent(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfSfvbEvent = instanceOfSfvbEvent;
|
|
26
|
+
function SfvbEventFromJSON(json) {
|
|
27
|
+
return SfvbEventFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.SfvbEventFromJSON = SfvbEventFromJSON;
|
|
30
|
+
function SfvbEventFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'event_dts': !(0, runtime_1.exists)(json, 'event_dts') ? undefined : json['event_dts'],
|
|
36
|
+
'event_id': !(0, runtime_1.exists)(json, 'event_id') ? undefined : json['event_id'],
|
|
37
|
+
'object_id': !(0, runtime_1.exists)(json, 'object_id') ? undefined : json['object_id'],
|
|
38
|
+
'object_type': !(0, runtime_1.exists)(json, 'object_type') ? undefined : json['object_type'],
|
|
39
|
+
'storefront_oid': !(0, runtime_1.exists)(json, 'storefront_oid') ? undefined : json['storefront_oid'],
|
|
40
|
+
'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
exports.SfvbEventFromJSONTyped = SfvbEventFromJSONTyped;
|
|
44
|
+
function SfvbEventToJSON(value) {
|
|
45
|
+
if (value === undefined) {
|
|
46
|
+
return undefined;
|
|
47
|
+
}
|
|
48
|
+
if (value === null) {
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'event_dts': value.event_dts,
|
|
53
|
+
'event_id': value.event_id,
|
|
54
|
+
'object_id': value.object_id,
|
|
55
|
+
'object_type': value.object_type,
|
|
56
|
+
'storefront_oid': value.storefront_oid,
|
|
57
|
+
'type': value.type,
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
exports.SfvbEventToJSON = SfvbEventToJSON;
|
|
@@ -0,0 +1,31 @@
|
|
|
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 SfvbEventsAuthRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbEventsAuthRequest {
|
|
18
|
+
/**
|
|
19
|
+
* Only events about these storefronts, plus merchant-level ones. Leave it out for every storefront.
|
|
20
|
+
* @type {Array<number>}
|
|
21
|
+
* @memberof SfvbEventsAuthRequest
|
|
22
|
+
*/
|
|
23
|
+
storefront_oids?: Array<number>;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the SfvbEventsAuthRequest interface.
|
|
27
|
+
*/
|
|
28
|
+
export declare function instanceOfSfvbEventsAuthRequest(value: object): boolean;
|
|
29
|
+
export declare function SfvbEventsAuthRequestFromJSON(json: any): SfvbEventsAuthRequest;
|
|
30
|
+
export declare function SfvbEventsAuthRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbEventsAuthRequest;
|
|
31
|
+
export declare function SfvbEventsAuthRequestToJSON(value?: SfvbEventsAuthRequest | null): any;
|