ultracart_rest_api_v2_typescript 4.1.201 → 4.1.203
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 +8 -0
- package/README.md +4 -2
- package/dist/apis/OauthApi.d.ts +1 -1
- package/dist/apis/SfvbApi.d.ts +192 -5
- package/dist/apis/SfvbApi.js +422 -2
- package/dist/models/SfvbEvent.d.ts +2 -2
- 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/SfvbSecretHandle.d.ts +85 -0
- package/dist/models/SfvbSecretHandle.js +75 -0
- package/dist/models/SfvbSecretKind.d.ts +67 -0
- package/dist/models/SfvbSecretKind.js +62 -0
- package/dist/models/SfvbSecretKindsResponse.d.ts +39 -0
- package/dist/models/SfvbSecretKindsResponse.js +54 -0
- package/dist/models/SfvbSecretRequest.d.ts +150 -0
- package/dist/models/SfvbSecretRequest.js +96 -0
- package/dist/models/SfvbSecretRequestCreate.d.ts +67 -0
- package/dist/models/SfvbSecretRequestCreate.js +62 -0
- package/dist/models/SfvbSecretRequestsResponse.d.ts +32 -0
- package/dist/models/SfvbSecretRequestsResponse.js +51 -0
- package/dist/models/SfvbSecretSink.d.ts +49 -0
- package/dist/models/SfvbSecretSink.js +56 -0
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/package.json +1 -1
- package/src/apis/OauthApi.ts +1 -1
- package/src/apis/SfvbApi.ts +452 -4
- package/src/models/SfvbEvent.ts +2 -2
- package/src/models/SfvbItemMultimedia.ts +43 -1
- package/src/models/SfvbItemMultimediaDescriptionRequest.ts +99 -0
- package/src/models/SfvbSecretHandle.ts +137 -0
- package/src/models/SfvbSecretKind.ts +115 -0
- package/src/models/SfvbSecretKindsResponse.ts +88 -0
- package/src/models/SfvbSecretRequest.ts +230 -0
- package/src/models/SfvbSecretRequestCreate.ts +115 -0
- package/src/models/SfvbSecretRequestsResponse.ts +74 -0
- package/src/models/SfvbSecretSink.ts +91 -0
- package/src/models/index.ts +8 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1065,6 +1065,7 @@ src/models/SfvbItemContainer.ts
|
|
|
1065
1065
|
src/models/SfvbItemContainersResponse.ts
|
|
1066
1066
|
src/models/SfvbItemContentRequest.ts
|
|
1067
1067
|
src/models/SfvbItemMultimedia.ts
|
|
1068
|
+
src/models/SfvbItemMultimediaDescriptionRequest.ts
|
|
1068
1069
|
src/models/SfvbItemMultimediaRequest.ts
|
|
1069
1070
|
src/models/SfvbItemPricing.ts
|
|
1070
1071
|
src/models/SfvbItemPricingRequest.ts
|
|
@@ -1163,6 +1164,13 @@ src/models/SfvbRedirectResponse.ts
|
|
|
1163
1164
|
src/models/SfvbRedirectsResponse.ts
|
|
1164
1165
|
src/models/SfvbRenderRequest.ts
|
|
1165
1166
|
src/models/SfvbRenderResponse.ts
|
|
1167
|
+
src/models/SfvbSecretHandle.ts
|
|
1168
|
+
src/models/SfvbSecretKind.ts
|
|
1169
|
+
src/models/SfvbSecretKindsResponse.ts
|
|
1170
|
+
src/models/SfvbSecretRequest.ts
|
|
1171
|
+
src/models/SfvbSecretRequestCreate.ts
|
|
1172
|
+
src/models/SfvbSecretRequestsResponse.ts
|
|
1173
|
+
src/models/SfvbSecretSink.ts
|
|
1166
1174
|
src/models/SfvbServerLog.ts
|
|
1167
1175
|
src/models/SfvbServerLogDetail.ts
|
|
1168
1176
|
src/models/SfvbServerLogEntry.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.203
|
|
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.203 --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.203 | 10/15/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.202 | 10/13/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.201 | 10/12/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.200 | 10/09/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.199 | 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, 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';
|
|
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, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, 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;
|
|
@@ -105,6 +105,9 @@ export interface DeleteSfvbRedirectsRequest {
|
|
|
105
105
|
redirectDeleteRequest: SfvbRedirectDeleteRequest;
|
|
106
106
|
approvalId?: string;
|
|
107
107
|
}
|
|
108
|
+
export interface DeleteSfvbSecretRequestRequest {
|
|
109
|
+
requestId: string;
|
|
110
|
+
}
|
|
108
111
|
export interface DetachSfvbBlogPostImageRequest {
|
|
109
112
|
storefrontOid: number;
|
|
110
113
|
blogPostOid: number;
|
|
@@ -359,6 +362,9 @@ export interface GetSfvbRedirectsRequest {
|
|
|
359
362
|
type?: string;
|
|
360
363
|
status?: string;
|
|
361
364
|
}
|
|
365
|
+
export interface GetSfvbSecretRequestRequest {
|
|
366
|
+
requestId: string;
|
|
367
|
+
}
|
|
362
368
|
export interface GetSfvbServerLogRequest {
|
|
363
369
|
storefrontOid: number;
|
|
364
370
|
logId: string;
|
|
@@ -425,6 +431,9 @@ export interface InsertSfvbRedirectRequest {
|
|
|
425
431
|
storefrontOid: number;
|
|
426
432
|
redirectRequest: SfvbRedirectRequest;
|
|
427
433
|
}
|
|
434
|
+
export interface InsertSfvbSecretRequestRequest {
|
|
435
|
+
secretRequest: SfvbSecretRequestCreate;
|
|
436
|
+
}
|
|
428
437
|
export interface InsertSfvbUpsellOfferRequest {
|
|
429
438
|
storefrontOid: number;
|
|
430
439
|
upsellOffer: SfvbUpsellOffer;
|
|
@@ -586,6 +595,12 @@ export interface PutSfvbItemMultimediaRequest {
|
|
|
586
595
|
merchantItemId?: string;
|
|
587
596
|
merchantItemOid?: number;
|
|
588
597
|
}
|
|
598
|
+
export interface PutSfvbItemMultimediaDescriptionRequest {
|
|
599
|
+
storefrontOid: number;
|
|
600
|
+
itemMultimediaDescriptionRequest: SfvbItemMultimediaDescriptionRequest;
|
|
601
|
+
merchantItemId?: string;
|
|
602
|
+
merchantItemOid?: number;
|
|
603
|
+
}
|
|
589
604
|
export interface PutSfvbItemPricingRequest {
|
|
590
605
|
storefrontOid: number;
|
|
591
606
|
ifMatch: string;
|
|
@@ -704,6 +719,9 @@ export interface RevertSfvbFileRequest {
|
|
|
704
719
|
fileRevertRequest: SfvbFileRevertRequest;
|
|
705
720
|
approvalId?: string;
|
|
706
721
|
}
|
|
722
|
+
export interface RevokeSfvbSecretRequestRequest {
|
|
723
|
+
requestId: string;
|
|
724
|
+
}
|
|
707
725
|
export interface SearchSfvbFilesRequest {
|
|
708
726
|
storefrontOid: number;
|
|
709
727
|
searchRequest: SfvbFileSearchRequest;
|
|
@@ -931,7 +949,7 @@ export interface SfvbApiInterface {
|
|
|
931
949
|
*/
|
|
932
950
|
createSfvbLibraryEntry(requestParameters: CreateSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
933
951
|
/**
|
|
934
|
-
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use.
|
|
952
|
+
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
|
|
935
953
|
* @summary One time link that opens a preview in a browser with no UltraCart login
|
|
936
954
|
* @param {number} storefrontOid
|
|
937
955
|
* @param {SfvbPreviewAccessRequest} [previewAccess] What the browser should see
|
|
@@ -941,7 +959,7 @@ export interface SfvbApiInterface {
|
|
|
941
959
|
*/
|
|
942
960
|
createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
|
|
943
961
|
/**
|
|
944
|
-
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use.
|
|
962
|
+
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
|
|
945
963
|
* One time link that opens a preview in a browser with no UltraCart login
|
|
946
964
|
*/
|
|
947
965
|
createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
|
|
@@ -1121,6 +1139,20 @@ export interface SfvbApiInterface {
|
|
|
1121
1139
|
* Delete up to 5,000 redirect rules in one call
|
|
1122
1140
|
*/
|
|
1123
1141
|
deleteSfvbRedirects(requestParameters: DeleteSfvbRedirectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectDeleteResponse>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
|
|
1144
|
+
* @summary Cancel a pending secret request
|
|
1145
|
+
* @param {string} requestId
|
|
1146
|
+
* @param {*} [options] Override http request option.
|
|
1147
|
+
* @throws {RequiredError}
|
|
1148
|
+
* @memberof SfvbApiInterface
|
|
1149
|
+
*/
|
|
1150
|
+
deleteSfvbSecretRequestRaw(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
1151
|
+
/**
|
|
1152
|
+
* Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
|
|
1153
|
+
* Cancel a pending secret request
|
|
1154
|
+
*/
|
|
1155
|
+
deleteSfvbSecretRequest(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
1124
1156
|
/**
|
|
1125
1157
|
* Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
|
|
1126
1158
|
* @summary Detach an image from a blog post
|
|
@@ -2014,6 +2046,46 @@ export interface SfvbApiInterface {
|
|
|
2014
2046
|
* List the storefront\'s redirect rules
|
|
2015
2047
|
*/
|
|
2016
2048
|
getSfvbRedirects(requestParameters: GetSfvbRedirectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectsResponse>;
|
|
2049
|
+
/**
|
|
2050
|
+
* The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
|
|
2051
|
+
* @summary List the secrets this server collects
|
|
2052
|
+
* @param {*} [options] Override http request option.
|
|
2053
|
+
* @throws {RequiredError}
|
|
2054
|
+
* @memberof SfvbApiInterface
|
|
2055
|
+
*/
|
|
2056
|
+
getSfvbSecretKindsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretKindsResponse>>;
|
|
2057
|
+
/**
|
|
2058
|
+
* The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
|
|
2059
|
+
* List the secrets this server collects
|
|
2060
|
+
*/
|
|
2061
|
+
getSfvbSecretKinds(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretKindsResponse>;
|
|
2062
|
+
/**
|
|
2063
|
+
* Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
|
|
2064
|
+
* @summary Read one secret request
|
|
2065
|
+
* @param {string} requestId
|
|
2066
|
+
* @param {*} [options] Override http request option.
|
|
2067
|
+
* @throws {RequiredError}
|
|
2068
|
+
* @memberof SfvbApiInterface
|
|
2069
|
+
*/
|
|
2070
|
+
getSfvbSecretRequestRaw(requestParameters: GetSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
2071
|
+
/**
|
|
2072
|
+
* Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
|
|
2073
|
+
* Read one secret request
|
|
2074
|
+
*/
|
|
2075
|
+
getSfvbSecretRequest(requestParameters: GetSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
2076
|
+
/**
|
|
2077
|
+
* Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
|
|
2078
|
+
* @summary List this sign-in\'s secret requests
|
|
2079
|
+
* @param {*} [options] Override http request option.
|
|
2080
|
+
* @throws {RequiredError}
|
|
2081
|
+
* @memberof SfvbApiInterface
|
|
2082
|
+
*/
|
|
2083
|
+
getSfvbSecretRequestsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequestsResponse>>;
|
|
2084
|
+
/**
|
|
2085
|
+
* Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
|
|
2086
|
+
* List this sign-in\'s secret requests
|
|
2087
|
+
*/
|
|
2088
|
+
getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
|
|
2017
2089
|
/**
|
|
2018
2090
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2019
2091
|
* @summary Get one storefront render log
|
|
@@ -2259,6 +2331,20 @@ export interface SfvbApiInterface {
|
|
|
2259
2331
|
* Create a 301 redirect rule
|
|
2260
2332
|
*/
|
|
2261
2333
|
insertSfvbRedirect(requestParameters: InsertSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
2334
|
+
/**
|
|
2335
|
+
* Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
|
|
2336
|
+
* @summary Ask a person to enter secret values
|
|
2337
|
+
* @param {SfvbSecretRequestCreate} secretRequest The request
|
|
2338
|
+
* @param {*} [options] Override http request option.
|
|
2339
|
+
* @throws {RequiredError}
|
|
2340
|
+
* @memberof SfvbApiInterface
|
|
2341
|
+
*/
|
|
2342
|
+
insertSfvbSecretRequestRaw(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
2343
|
+
/**
|
|
2344
|
+
* Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
|
|
2345
|
+
* Ask a person to enter secret values
|
|
2346
|
+
*/
|
|
2347
|
+
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
2262
2348
|
/**
|
|
2263
2349
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
2264
2350
|
* @summary Create an upsell offer
|
|
@@ -2742,6 +2828,23 @@ export interface SfvbApiInterface {
|
|
|
2742
2828
|
* Attach an image to an item
|
|
2743
2829
|
*/
|
|
2744
2830
|
putSfvbItemMultimedia(requestParameters: PutSfvbItemMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
2831
|
+
/**
|
|
2832
|
+
* 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.
|
|
2833
|
+
* @summary Change an item image\'s description
|
|
2834
|
+
* @param {number} storefrontOid
|
|
2835
|
+
* @param {SfvbItemMultimediaDescriptionRequest} itemMultimediaDescriptionRequest The image and its new description
|
|
2836
|
+
* @param {string} [merchantItemId]
|
|
2837
|
+
* @param {number} [merchantItemOid]
|
|
2838
|
+
* @param {*} [options] Override http request option.
|
|
2839
|
+
* @throws {RequiredError}
|
|
2840
|
+
* @memberof SfvbApiInterface
|
|
2841
|
+
*/
|
|
2842
|
+
putSfvbItemMultimediaDescriptionRaw(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemResponse>>;
|
|
2843
|
+
/**
|
|
2844
|
+
* 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.
|
|
2845
|
+
* Change an item image\'s description
|
|
2846
|
+
*/
|
|
2847
|
+
putSfvbItemMultimediaDescription(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
2745
2848
|
/**
|
|
2746
2849
|
* 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.
|
|
2747
2850
|
* @summary Change what an item charges
|
|
@@ -3102,6 +3205,20 @@ export interface SfvbApiInterface {
|
|
|
3102
3205
|
* Revert a storefront file to an earlier version
|
|
3103
3206
|
*/
|
|
3104
3207
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
3208
|
+
/**
|
|
3209
|
+
* Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
|
|
3210
|
+
* @summary Revoke a fulfilled request\'s unused handles
|
|
3211
|
+
* @param {string} requestId
|
|
3212
|
+
* @param {*} [options] Override http request option.
|
|
3213
|
+
* @throws {RequiredError}
|
|
3214
|
+
* @memberof SfvbApiInterface
|
|
3215
|
+
*/
|
|
3216
|
+
revokeSfvbSecretRequestRaw(requestParameters: RevokeSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
3217
|
+
/**
|
|
3218
|
+
* Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
|
|
3219
|
+
* Revoke a fulfilled request\'s unused handles
|
|
3220
|
+
*/
|
|
3221
|
+
revokeSfvbSecretRequest(requestParameters: RevokeSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
3105
3222
|
/**
|
|
3106
3223
|
* Searches names and, when text is supplied, file contents. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported.
|
|
3107
3224
|
* @summary Search storefront files
|
|
@@ -3493,12 +3610,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3493
3610
|
*/
|
|
3494
3611
|
createSfvbLibraryEntry(requestParameters: CreateSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
|
|
3495
3612
|
/**
|
|
3496
|
-
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use.
|
|
3613
|
+
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
|
|
3497
3614
|
* One time link that opens a preview in a browser with no UltraCart login
|
|
3498
3615
|
*/
|
|
3499
3616
|
createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
|
|
3500
3617
|
/**
|
|
3501
|
-
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use.
|
|
3618
|
+
* The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
|
|
3502
3619
|
* One time link that opens a preview in a browser with no UltraCart login
|
|
3503
3620
|
*/
|
|
3504
3621
|
createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
|
|
@@ -3612,6 +3729,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3612
3729
|
* Delete up to 5,000 redirect rules in one call
|
|
3613
3730
|
*/
|
|
3614
3731
|
deleteSfvbRedirects(requestParameters: DeleteSfvbRedirectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectDeleteResponse>;
|
|
3732
|
+
/**
|
|
3733
|
+
* Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
|
|
3734
|
+
* Cancel a pending secret request
|
|
3735
|
+
*/
|
|
3736
|
+
deleteSfvbSecretRequestRaw(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
3737
|
+
/**
|
|
3738
|
+
* Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
|
|
3739
|
+
* Cancel a pending secret request
|
|
3740
|
+
*/
|
|
3741
|
+
deleteSfvbSecretRequest(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
3615
3742
|
/**
|
|
3616
3743
|
* Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
|
|
3617
3744
|
* Detach an image from a blog post
|
|
@@ -4190,6 +4317,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4190
4317
|
* List the storefront\'s redirect rules
|
|
4191
4318
|
*/
|
|
4192
4319
|
getSfvbRedirects(requestParameters: GetSfvbRedirectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectsResponse>;
|
|
4320
|
+
/**
|
|
4321
|
+
* The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
|
|
4322
|
+
* List the secrets this server collects
|
|
4323
|
+
*/
|
|
4324
|
+
getSfvbSecretKindsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretKindsResponse>>;
|
|
4325
|
+
/**
|
|
4326
|
+
* The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
|
|
4327
|
+
* List the secrets this server collects
|
|
4328
|
+
*/
|
|
4329
|
+
getSfvbSecretKinds(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretKindsResponse>;
|
|
4330
|
+
/**
|
|
4331
|
+
* Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
|
|
4332
|
+
* Read one secret request
|
|
4333
|
+
*/
|
|
4334
|
+
getSfvbSecretRequestRaw(requestParameters: GetSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
4335
|
+
/**
|
|
4336
|
+
* Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
|
|
4337
|
+
* Read one secret request
|
|
4338
|
+
*/
|
|
4339
|
+
getSfvbSecretRequest(requestParameters: GetSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
4340
|
+
/**
|
|
4341
|
+
* Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
|
|
4342
|
+
* List this sign-in\'s secret requests
|
|
4343
|
+
*/
|
|
4344
|
+
getSfvbSecretRequestsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequestsResponse>>;
|
|
4345
|
+
/**
|
|
4346
|
+
* Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
|
|
4347
|
+
* List this sign-in\'s secret requests
|
|
4348
|
+
*/
|
|
4349
|
+
getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
|
|
4193
4350
|
/**
|
|
4194
4351
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
4195
4352
|
* Get one storefront render log
|
|
@@ -4348,6 +4505,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4348
4505
|
* Create a 301 redirect rule
|
|
4349
4506
|
*/
|
|
4350
4507
|
insertSfvbRedirect(requestParameters: InsertSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
4508
|
+
/**
|
|
4509
|
+
* Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
|
|
4510
|
+
* Ask a person to enter secret values
|
|
4511
|
+
*/
|
|
4512
|
+
insertSfvbSecretRequestRaw(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
4513
|
+
/**
|
|
4514
|
+
* Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
|
|
4515
|
+
* Ask a person to enter secret values
|
|
4516
|
+
*/
|
|
4517
|
+
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
4351
4518
|
/**
|
|
4352
4519
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
4353
4520
|
* Create an upsell offer
|
|
@@ -4636,6 +4803,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4636
4803
|
* Attach an image to an item
|
|
4637
4804
|
*/
|
|
4638
4805
|
putSfvbItemMultimedia(requestParameters: PutSfvbItemMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
4806
|
+
/**
|
|
4807
|
+
* 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.
|
|
4808
|
+
* Change an item image\'s description
|
|
4809
|
+
*/
|
|
4810
|
+
putSfvbItemMultimediaDescriptionRaw(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemResponse>>;
|
|
4811
|
+
/**
|
|
4812
|
+
* 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.
|
|
4813
|
+
* Change an item image\'s description
|
|
4814
|
+
*/
|
|
4815
|
+
putSfvbItemMultimediaDescription(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
4639
4816
|
/**
|
|
4640
4817
|
* 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.
|
|
4641
4818
|
* Change what an item charges
|
|
@@ -4856,6 +5033,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4856
5033
|
* Revert a storefront file to an earlier version
|
|
4857
5034
|
*/
|
|
4858
5035
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
5036
|
+
/**
|
|
5037
|
+
* Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
|
|
5038
|
+
* Revoke a fulfilled request\'s unused handles
|
|
5039
|
+
*/
|
|
5040
|
+
revokeSfvbSecretRequestRaw(requestParameters: RevokeSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSecretRequest>>;
|
|
5041
|
+
/**
|
|
5042
|
+
* Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
|
|
5043
|
+
* Revoke a fulfilled request\'s unused handles
|
|
5044
|
+
*/
|
|
5045
|
+
revokeSfvbSecretRequest(requestParameters: RevokeSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
4859
5046
|
/**
|
|
4860
5047
|
* Searches names and, when text is supplied, file contents. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported.
|
|
4861
5048
|
* Search storefront files
|