ultracart_rest_api_v2_typescript 4.1.200 → 4.1.202
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 +5 -0
- package/README.md +4 -2
- package/dist/apis/OauthApi.d.ts +1 -1
- package/dist/apis/SfvbApi.d.ts +106 -13
- package/dist/apis/SfvbApi.js +204 -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/SfvbItemMultimedia.d.ts +34 -1
- package/dist/models/SfvbItemMultimedia.js +17 -1
- package/dist/models/SfvbItemMultimediaDescriptionRequest.d.ts +55 -0
- package/dist/models/SfvbItemMultimediaDescriptionRequest.js +58 -0
- package/dist/models/SfvbThemeJobResponse.d.ts +3 -3
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/package.json +1 -1
- package/src/apis/OauthApi.ts +1 -1
- package/src/apis/SfvbApi.ts +245 -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/SfvbItemMultimedia.ts +43 -1
- package/src/models/SfvbItemMultimediaDescriptionRequest.ts +99 -0
- package/src/models/SfvbThemeJobResponse.ts +3 -3
- package/src/models/index.ts +5 -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
|
|
@@ -1061,6 +1065,7 @@ src/models/SfvbItemContainer.ts
|
|
|
1061
1065
|
src/models/SfvbItemContainersResponse.ts
|
|
1062
1066
|
src/models/SfvbItemContentRequest.ts
|
|
1063
1067
|
src/models/SfvbItemMultimedia.ts
|
|
1068
|
+
src/models/SfvbItemMultimediaDescriptionRequest.ts
|
|
1064
1069
|
src/models/SfvbItemMultimediaRequest.ts
|
|
1065
1070
|
src/models/SfvbItemPricing.ts
|
|
1066
1071
|
src/models/SfvbItemPricingRequest.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.202
|
|
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.202 --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.202 | 10/13/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.201 | 10/12/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.200 | 10/09/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.199 | 10/08/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.198 | 10/08/2026 | sfvb internal testing |
|
package/dist/apis/OauthApi.d.ts
CHANGED
|
@@ -85,7 +85,7 @@ export interface OauthApiInterface {
|
|
|
85
85
|
* Revokes the OAuth application associated with the specified client_id and token.
|
|
86
86
|
* @summary Revoke this OAuth application.
|
|
87
87
|
* @param {string} clientId The OAuth application client_id.
|
|
88
|
-
* @param {string} token The OAuth access token that is to be revoked
|
|
88
|
+
* @param {string} token The OAuth access token or refresh token that is to be revoked.
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
* @memberof OauthApiInterface
|
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, SfvbItemMultimediaDescriptionRequest, 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;
|
|
@@ -577,6 +586,12 @@ export interface PutSfvbItemMultimediaRequest {
|
|
|
577
586
|
merchantItemId?: string;
|
|
578
587
|
merchantItemOid?: number;
|
|
579
588
|
}
|
|
589
|
+
export interface PutSfvbItemMultimediaDescriptionRequest {
|
|
590
|
+
storefrontOid: number;
|
|
591
|
+
itemMultimediaDescriptionRequest: SfvbItemMultimediaDescriptionRequest;
|
|
592
|
+
merchantItemId?: string;
|
|
593
|
+
merchantItemOid?: number;
|
|
594
|
+
}
|
|
580
595
|
export interface PutSfvbItemPricingRequest {
|
|
581
596
|
storefrontOid: number;
|
|
582
597
|
ifMatch: string;
|
|
@@ -1362,7 +1377,7 @@ export interface SfvbApiInterface {
|
|
|
1362
1377
|
*/
|
|
1363
1378
|
enableSfvbUpsellPath(requestParameters: EnableSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
1364
1379
|
/**
|
|
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
|
|
1380
|
+
* 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
1381
|
* @summary End an experiment
|
|
1367
1382
|
* @param {number} storefrontOid
|
|
1368
1383
|
* @param {number} experimentOid
|
|
@@ -1374,7 +1389,7 @@ export interface SfvbApiInterface {
|
|
|
1374
1389
|
*/
|
|
1375
1390
|
endSfvbExperimentRaw(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbExperiment>>;
|
|
1376
1391
|
/**
|
|
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
|
|
1392
|
+
* 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
1393
|
* End an experiment
|
|
1379
1394
|
*/
|
|
1380
1395
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
@@ -1497,6 +1512,36 @@ export interface SfvbApiInterface {
|
|
|
1497
1512
|
* Configuration schema and field card for one element type
|
|
1498
1513
|
*/
|
|
1499
1514
|
getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
|
|
1515
|
+
/**
|
|
1516
|
+
* 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.
|
|
1517
|
+
* @summary Replay events
|
|
1518
|
+
* @param {string} [after] Return events after this event_id. Leave it out for every event kept.
|
|
1519
|
+
* @param {number} [storefrontOid] Only events about this storefront, plus merchant-level ones.
|
|
1520
|
+
* @param {number} [limit] At most this many events, 1 to 500.
|
|
1521
|
+
* @param {*} [options] Override http request option.
|
|
1522
|
+
* @throws {RequiredError}
|
|
1523
|
+
* @memberof SfvbApiInterface
|
|
1524
|
+
*/
|
|
1525
|
+
getSfvbEventsRaw(requestParameters: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsResponse>>;
|
|
1526
|
+
/**
|
|
1527
|
+
* 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.
|
|
1528
|
+
* Replay events
|
|
1529
|
+
*/
|
|
1530
|
+
getSfvbEvents(requestParameters: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsResponse>;
|
|
1531
|
+
/**
|
|
1532
|
+
* 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.
|
|
1533
|
+
* @summary Open the event stream
|
|
1534
|
+
* @param {SfvbEventsAuthRequest} [eventsAuthRequest] Optional storefront filter
|
|
1535
|
+
* @param {*} [options] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
* @memberof SfvbApiInterface
|
|
1538
|
+
*/
|
|
1539
|
+
getSfvbEventsAuthorizationRaw(requestParameters: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsAuthResponse>>;
|
|
1540
|
+
/**
|
|
1541
|
+
* 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.
|
|
1542
|
+
* Open the event stream
|
|
1543
|
+
*/
|
|
1544
|
+
getSfvbEventsAuthorization(requestParameters: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsAuthResponse>;
|
|
1500
1545
|
/**
|
|
1501
1546
|
* 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
1547
|
* @summary Read one experiment and its statistics
|
|
@@ -1772,7 +1817,7 @@ export interface SfvbApiInterface {
|
|
|
1772
1817
|
*/
|
|
1773
1818
|
getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
|
|
1774
1819
|
/**
|
|
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.
|
|
1820
|
+
* 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
1821
|
* @summary List the paths that answered 404
|
|
1777
1822
|
* @param {number} storefrontOid
|
|
1778
1823
|
* @param {string} [since]
|
|
@@ -1781,13 +1826,14 @@ export interface SfvbApiInterface {
|
|
|
1781
1826
|
* @param {boolean} [includeTokens]
|
|
1782
1827
|
* @param {string} [q]
|
|
1783
1828
|
* @param {number} [limit]
|
|
1829
|
+
* @param {boolean} [redirected]
|
|
1784
1830
|
* @param {*} [options] Override http request option.
|
|
1785
1831
|
* @throws {RequiredError}
|
|
1786
1832
|
* @memberof SfvbApiInterface
|
|
1787
1833
|
*/
|
|
1788
1834
|
getSfvbNotFoundRaw(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundResponse>>;
|
|
1789
1835
|
/**
|
|
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.
|
|
1836
|
+
* 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
1837
|
* List the paths that answered 404
|
|
1792
1838
|
*/
|
|
1793
1839
|
getSfvbNotFound(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundResponse>;
|
|
@@ -2634,7 +2680,7 @@ export interface SfvbApiInterface {
|
|
|
2634
2680
|
*/
|
|
2635
2681
|
putSfvbI18nGlossary(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
2636
2682
|
/**
|
|
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;
|
|
2683
|
+
* 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
2684
|
* @summary Change one built-in message
|
|
2639
2685
|
* @param {number} storefrontOid
|
|
2640
2686
|
* @param {string} key
|
|
@@ -2647,7 +2693,7 @@ export interface SfvbApiInterface {
|
|
|
2647
2693
|
*/
|
|
2648
2694
|
putSfvbI18nMessageRaw(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
2649
2695
|
/**
|
|
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;
|
|
2696
|
+
* 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
2697
|
* Change one built-in message
|
|
2652
2698
|
*/
|
|
2653
2699
|
putSfvbI18nMessage(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
@@ -2702,6 +2748,23 @@ export interface SfvbApiInterface {
|
|
|
2702
2748
|
* Attach an image to an item
|
|
2703
2749
|
*/
|
|
2704
2750
|
putSfvbItemMultimedia(requestParameters: PutSfvbItemMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
2751
|
+
/**
|
|
2752
|
+
* Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
2753
|
+
* @summary Change an item image\'s description
|
|
2754
|
+
* @param {number} storefrontOid
|
|
2755
|
+
* @param {SfvbItemMultimediaDescriptionRequest} itemMultimediaDescriptionRequest The image and its new description
|
|
2756
|
+
* @param {string} [merchantItemId]
|
|
2757
|
+
* @param {number} [merchantItemOid]
|
|
2758
|
+
* @param {*} [options] Override http request option.
|
|
2759
|
+
* @throws {RequiredError}
|
|
2760
|
+
* @memberof SfvbApiInterface
|
|
2761
|
+
*/
|
|
2762
|
+
putSfvbItemMultimediaDescriptionRaw(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemResponse>>;
|
|
2763
|
+
/**
|
|
2764
|
+
* Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
2765
|
+
* Change an item image\'s description
|
|
2766
|
+
*/
|
|
2767
|
+
putSfvbItemMultimediaDescription(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
2705
2768
|
/**
|
|
2706
2769
|
* Partial - a field left out is untouched. A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it. msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it. volume_discounts replaces the retail quantity breaks. Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change. A change that sets every field to what it already is returns the pricing unchanged and uses no approval.
|
|
2707
2770
|
* @summary Change what an item charges
|
|
@@ -3733,12 +3796,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3733
3796
|
*/
|
|
3734
3797
|
enableSfvbUpsellPath(requestParameters: EnableSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
3735
3798
|
/**
|
|
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
|
|
3799
|
+
* 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
3800
|
* End an experiment
|
|
3738
3801
|
*/
|
|
3739
3802
|
endSfvbExperimentRaw(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbExperiment>>;
|
|
3740
3803
|
/**
|
|
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
|
|
3804
|
+
* 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
3805
|
* End an experiment
|
|
3743
3806
|
*/
|
|
3744
3807
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
@@ -3820,6 +3883,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3820
3883
|
* Configuration schema and field card for one element type
|
|
3821
3884
|
*/
|
|
3822
3885
|
getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
|
|
3886
|
+
/**
|
|
3887
|
+
* 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.
|
|
3888
|
+
* Replay events
|
|
3889
|
+
*/
|
|
3890
|
+
getSfvbEventsRaw(requestParameters: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsResponse>>;
|
|
3891
|
+
/**
|
|
3892
|
+
* 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.
|
|
3893
|
+
* Replay events
|
|
3894
|
+
*/
|
|
3895
|
+
getSfvbEvents(requestParameters?: GetSfvbEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsResponse>;
|
|
3896
|
+
/**
|
|
3897
|
+
* 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.
|
|
3898
|
+
* Open the event stream
|
|
3899
|
+
*/
|
|
3900
|
+
getSfvbEventsAuthorizationRaw(requestParameters: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEventsAuthResponse>>;
|
|
3901
|
+
/**
|
|
3902
|
+
* 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.
|
|
3903
|
+
* Open the event stream
|
|
3904
|
+
*/
|
|
3905
|
+
getSfvbEventsAuthorization(requestParameters?: GetSfvbEventsAuthorizationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEventsAuthResponse>;
|
|
3823
3906
|
/**
|
|
3824
3907
|
* 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
3908
|
* Read one experiment and its statistics
|
|
@@ -4001,12 +4084,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4001
4084
|
*/
|
|
4002
4085
|
getSfvbMenus(requestParameters: GetSfvbMenusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbMenusResponse>;
|
|
4003
4086
|
/**
|
|
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.
|
|
4087
|
+
* 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
4088
|
* List the paths that answered 404
|
|
4006
4089
|
*/
|
|
4007
4090
|
getSfvbNotFoundRaw(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundResponse>>;
|
|
4008
4091
|
/**
|
|
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.
|
|
4092
|
+
* 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
4093
|
* List the paths that answered 404
|
|
4011
4094
|
*/
|
|
4012
4095
|
getSfvbNotFound(requestParameters: GetSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundResponse>;
|
|
@@ -4537,12 +4620,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4537
4620
|
*/
|
|
4538
4621
|
putSfvbI18nGlossary(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
4539
4622
|
/**
|
|
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;
|
|
4623
|
+
* 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
4624
|
* Change one built-in message
|
|
4542
4625
|
*/
|
|
4543
4626
|
putSfvbI18nMessageRaw(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
4544
4627
|
/**
|
|
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;
|
|
4628
|
+
* 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
4629
|
* Change one built-in message
|
|
4547
4630
|
*/
|
|
4548
4631
|
putSfvbI18nMessage(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
@@ -4576,6 +4659,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4576
4659
|
* Attach an image to an item
|
|
4577
4660
|
*/
|
|
4578
4661
|
putSfvbItemMultimedia(requestParameters: PutSfvbItemMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
4662
|
+
/**
|
|
4663
|
+
* Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
4664
|
+
* Change an item image\'s description
|
|
4665
|
+
*/
|
|
4666
|
+
putSfvbItemMultimediaDescriptionRaw(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemResponse>>;
|
|
4667
|
+
/**
|
|
4668
|
+
* Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
4669
|
+
* Change an item image\'s description
|
|
4670
|
+
*/
|
|
4671
|
+
putSfvbItemMultimediaDescription(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
4579
4672
|
/**
|
|
4580
4673
|
* Partial - a field left out is untouched. A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it. msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it. volume_discounts replaces the retail quantity breaks. Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change. A change that sets every field to what it already is returns the pricing unchanged and uses no approval.
|
|
4581
4674
|
* Change what an item charges
|
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) {
|
|
@@ -7947,6 +8075,76 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
7947
8075
|
});
|
|
7948
8076
|
});
|
|
7949
8077
|
};
|
|
8078
|
+
/**
|
|
8079
|
+
* Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
8080
|
+
* Change an item image\'s description
|
|
8081
|
+
*/
|
|
8082
|
+
SfvbApi.prototype.putSfvbItemMultimediaDescriptionRaw = function (requestParameters, initOverrides) {
|
|
8083
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
8084
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
8085
|
+
return __generator(this, function (_c) {
|
|
8086
|
+
switch (_c.label) {
|
|
8087
|
+
case 0:
|
|
8088
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
8089
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbItemMultimediaDescription.');
|
|
8090
|
+
}
|
|
8091
|
+
if (requestParameters.itemMultimediaDescriptionRequest === null || requestParameters.itemMultimediaDescriptionRequest === undefined) {
|
|
8092
|
+
throw new runtime.RequiredError('itemMultimediaDescriptionRequest', 'Required parameter requestParameters.itemMultimediaDescriptionRequest was null or undefined when calling putSfvbItemMultimediaDescription.');
|
|
8093
|
+
}
|
|
8094
|
+
queryParameters = {};
|
|
8095
|
+
if (requestParameters.merchantItemId !== undefined) {
|
|
8096
|
+
queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
|
|
8097
|
+
}
|
|
8098
|
+
if (requestParameters.merchantItemOid !== undefined) {
|
|
8099
|
+
queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
|
|
8100
|
+
}
|
|
8101
|
+
headerParameters = {};
|
|
8102
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
8103
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
8104
|
+
// oauth required
|
|
8105
|
+
_a = headerParameters;
|
|
8106
|
+
_b = "Authorization";
|
|
8107
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
8108
|
+
case 1:
|
|
8109
|
+
// oauth required
|
|
8110
|
+
_a[_b] = _c.sent();
|
|
8111
|
+
_c.label = 2;
|
|
8112
|
+
case 2:
|
|
8113
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
8114
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
8115
|
+
}
|
|
8116
|
+
return [4 /*yield*/, this.request({
|
|
8117
|
+
path: "/sfvb/storefronts/{storefront_oid}/items/multimedia/description".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
|
|
8118
|
+
method: 'PUT',
|
|
8119
|
+
headers: headerParameters,
|
|
8120
|
+
query: queryParameters,
|
|
8121
|
+
body: (0, models_1.SfvbItemMultimediaDescriptionRequestToJSON)(requestParameters.itemMultimediaDescriptionRequest),
|
|
8122
|
+
}, initOverrides)];
|
|
8123
|
+
case 3:
|
|
8124
|
+
response = _c.sent();
|
|
8125
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbItemResponseFromJSON)(jsonValue); })];
|
|
8126
|
+
}
|
|
8127
|
+
});
|
|
8128
|
+
});
|
|
8129
|
+
};
|
|
8130
|
+
/**
|
|
8131
|
+
* Changes the description (alt text) of one image already attached to the item, in place. The image is not touched. Name it by merchant_item_multimedia_oid, or by exactly one of code or default; gallery images often have no code. An empty description clears it, so the render falls back again. Send the description_sha256 you read as current_sha256 so a change made since is not overwritten. A description written here takes the place of the machine description, and image recognition never overwrites it.
|
|
8132
|
+
* Change an item image\'s description
|
|
8133
|
+
*/
|
|
8134
|
+
SfvbApi.prototype.putSfvbItemMultimediaDescription = function (requestParameters, initOverrides) {
|
|
8135
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
8136
|
+
var response;
|
|
8137
|
+
return __generator(this, function (_a) {
|
|
8138
|
+
switch (_a.label) {
|
|
8139
|
+
case 0: return [4 /*yield*/, this.putSfvbItemMultimediaDescriptionRaw(requestParameters, initOverrides)];
|
|
8140
|
+
case 1:
|
|
8141
|
+
response = _a.sent();
|
|
8142
|
+
return [4 /*yield*/, response.value()];
|
|
8143
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
8144
|
+
}
|
|
8145
|
+
});
|
|
8146
|
+
});
|
|
8147
|
+
};
|
|
7950
8148
|
/**
|
|
7951
8149
|
* Partial - a field left out is untouched. A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it. msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it. volume_discounts replaces the retail quantity breaks. Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change. A change that sets every field to what it already is returns the pricing unchanged and uses no approval.
|
|
7952
8150
|
* Change what an item charges
|