ultracart_rest_api_v2_typescript 4.1.189 → 4.1.191
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 +12 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +352 -1
- package/dist/apis/SfvbApi.js +766 -18
- package/dist/models/SfvbI18nGlossary.d.ts +49 -0
- package/dist/models/SfvbI18nGlossary.js +56 -0
- package/dist/models/SfvbI18nGlossaryRequest.d.ts +31 -0
- package/dist/models/SfvbI18nGlossaryRequest.js +50 -0
- package/dist/models/SfvbI18nLanguage.d.ts +67 -0
- package/dist/models/SfvbI18nLanguage.js +62 -0
- package/dist/models/SfvbI18nLanguageEnableRequest.d.ts +31 -0
- package/dist/models/SfvbI18nLanguageEnableRequest.js +50 -0
- package/dist/models/SfvbI18nLanguagesResponse.d.ts +74 -0
- package/dist/models/SfvbI18nLanguagesResponse.js +65 -0
- package/dist/models/SfvbI18nMachineTranslationsResponse.d.ts +62 -0
- package/dist/models/SfvbI18nMachineTranslationsResponse.js +61 -0
- package/dist/models/SfvbI18nMessage.d.ts +68 -0
- package/dist/models/SfvbI18nMessage.js +63 -0
- package/dist/models/SfvbI18nMessageValue.d.ts +37 -0
- package/dist/models/SfvbI18nMessageValue.js +52 -0
- package/dist/models/SfvbI18nMessageWriteRequest.d.ts +32 -0
- package/dist/models/SfvbI18nMessageWriteRequest.js +51 -0
- package/dist/models/SfvbI18nMessagesResponse.d.ts +62 -0
- package/dist/models/SfvbI18nMessagesResponse.js +61 -0
- package/dist/models/SfvbI18nResetResponse.d.ts +43 -0
- package/dist/models/SfvbI18nResetResponse.js +54 -0
- package/dist/models/SfvbI18nTranslation.d.ts +43 -0
- package/dist/models/SfvbI18nTranslation.js +54 -0
- package/dist/models/SfvbRenderRequest.d.ts +1 -1
- package/dist/models/index.d.ts +12 -0
- package/dist/models/index.js +12 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +885 -0
- package/src/models/SfvbI18nGlossary.ts +91 -0
- package/src/models/SfvbI18nGlossaryRequest.ts +67 -0
- package/src/models/SfvbI18nLanguage.ts +115 -0
- package/src/models/SfvbI18nLanguageEnableRequest.ts +67 -0
- package/src/models/SfvbI18nLanguagesResponse.ts +130 -0
- package/src/models/SfvbI18nMachineTranslationsResponse.ts +114 -0
- package/src/models/SfvbI18nMessage.ts +122 -0
- package/src/models/SfvbI18nMessageValue.ts +75 -0
- package/src/models/SfvbI18nMessageWriteRequest.ts +74 -0
- package/src/models/SfvbI18nMessagesResponse.ts +114 -0
- package/src/models/SfvbI18nResetResponse.ts +83 -0
- package/src/models/SfvbI18nTranslation.ts +83 -0
- package/src/models/SfvbRenderRequest.ts +1 -1
- package/src/models/index.ts +12 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1032,6 +1032,18 @@ src/models/SfvbFileVersionsResponse.ts
|
|
|
1032
1032
|
src/models/SfvbFileWriteRequest.ts
|
|
1033
1033
|
src/models/SfvbFileWriteResponse.ts
|
|
1034
1034
|
src/models/SfvbFilesResponse.ts
|
|
1035
|
+
src/models/SfvbI18nGlossary.ts
|
|
1036
|
+
src/models/SfvbI18nGlossaryRequest.ts
|
|
1037
|
+
src/models/SfvbI18nLanguage.ts
|
|
1038
|
+
src/models/SfvbI18nLanguageEnableRequest.ts
|
|
1039
|
+
src/models/SfvbI18nLanguagesResponse.ts
|
|
1040
|
+
src/models/SfvbI18nMachineTranslationsResponse.ts
|
|
1041
|
+
src/models/SfvbI18nMessage.ts
|
|
1042
|
+
src/models/SfvbI18nMessageValue.ts
|
|
1043
|
+
src/models/SfvbI18nMessageWriteRequest.ts
|
|
1044
|
+
src/models/SfvbI18nMessagesResponse.ts
|
|
1045
|
+
src/models/SfvbI18nResetResponse.ts
|
|
1046
|
+
src/models/SfvbI18nTranslation.ts
|
|
1035
1047
|
src/models/SfvbItemAttribute.ts
|
|
1036
1048
|
src/models/SfvbItemAttributeUpdate.ts
|
|
1037
1049
|
src/models/SfvbItemAttributeUpdateRequest.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.191
|
|
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.191 --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.191 | 10/06/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.190 | 10/06/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.189 | 10/06/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.188 | 10/05/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.187 | 10/05/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -91,6 +91,11 @@ export interface DetachSfvbBlogPostImageRequest {
|
|
|
91
91
|
blogPostOid: number;
|
|
92
92
|
blogPostImageRequest: SfvbBlogPostImageRequest;
|
|
93
93
|
}
|
|
94
|
+
export interface DisableSfvbI18nLanguageRequest {
|
|
95
|
+
storefrontOid: number;
|
|
96
|
+
code: string;
|
|
97
|
+
ifMatch: string;
|
|
98
|
+
}
|
|
94
99
|
export interface DisableSfvbUpsellOfferRequest {
|
|
95
100
|
storefrontOid: number;
|
|
96
101
|
upsellOfferOid: number;
|
|
@@ -126,6 +131,12 @@ export interface DuplicateSfvbUpsellPathRequest {
|
|
|
126
131
|
upsellPathOid: number;
|
|
127
132
|
duplicateRequest?: SfvbUpsellPathDuplicateRequest;
|
|
128
133
|
}
|
|
134
|
+
export interface EnableSfvbI18nLanguageRequest {
|
|
135
|
+
storefrontOid: number;
|
|
136
|
+
code: string;
|
|
137
|
+
ifMatch: string;
|
|
138
|
+
languageEnableRequest: SfvbI18nLanguageEnableRequest;
|
|
139
|
+
}
|
|
129
140
|
export interface EndSfvbExperimentRequest {
|
|
130
141
|
storefrontOid: number;
|
|
131
142
|
experimentOid: number;
|
|
@@ -175,6 +186,28 @@ export interface GetSfvbFileUploadUrlRequest {
|
|
|
175
186
|
storefrontOid: number;
|
|
176
187
|
extension: string;
|
|
177
188
|
}
|
|
189
|
+
export interface GetSfvbI18nGlossaryRequest {
|
|
190
|
+
storefrontOid: number;
|
|
191
|
+
}
|
|
192
|
+
export interface GetSfvbI18nLanguagesRequest {
|
|
193
|
+
storefrontOid: number;
|
|
194
|
+
}
|
|
195
|
+
export interface GetSfvbI18nMachineTranslationsRequest {
|
|
196
|
+
storefrontOid: number;
|
|
197
|
+
themeOid?: number;
|
|
198
|
+
widgetId?: string;
|
|
199
|
+
property?: string;
|
|
200
|
+
}
|
|
201
|
+
export interface GetSfvbI18nMessageRequest {
|
|
202
|
+
storefrontOid: number;
|
|
203
|
+
key: string;
|
|
204
|
+
themeOid?: number;
|
|
205
|
+
}
|
|
206
|
+
export interface GetSfvbI18nMessageMachineTranslationsRequest {
|
|
207
|
+
storefrontOid: number;
|
|
208
|
+
key: string;
|
|
209
|
+
themeOid?: number;
|
|
210
|
+
}
|
|
178
211
|
export interface GetSfvbItemRequest {
|
|
179
212
|
storefrontOid: number;
|
|
180
213
|
merchantItemId?: string;
|
|
@@ -321,6 +354,15 @@ export interface ListSfvbFilesRequest {
|
|
|
321
354
|
themeOid?: number;
|
|
322
355
|
maxEntries?: number;
|
|
323
356
|
}
|
|
357
|
+
export interface ListSfvbI18nMessagesRequest {
|
|
358
|
+
storefrontOid: number;
|
|
359
|
+
themeOid?: number;
|
|
360
|
+
q?: string;
|
|
361
|
+
language?: string;
|
|
362
|
+
overridden?: boolean;
|
|
363
|
+
offset?: number;
|
|
364
|
+
limit?: number;
|
|
365
|
+
}
|
|
324
366
|
export interface ListSfvbItemContainersRequest {
|
|
325
367
|
storefrontOid: number;
|
|
326
368
|
merchantItemId?: string;
|
|
@@ -400,6 +442,18 @@ export interface PutSfvbFileContentRequest {
|
|
|
400
442
|
fileWriteRequest: SfvbFileWriteRequest;
|
|
401
443
|
path?: string;
|
|
402
444
|
}
|
|
445
|
+
export interface PutSfvbI18nGlossaryRequest {
|
|
446
|
+
storefrontOid: number;
|
|
447
|
+
glossaryRequest: SfvbI18nGlossaryRequest;
|
|
448
|
+
ifMatch?: string;
|
|
449
|
+
}
|
|
450
|
+
export interface PutSfvbI18nMessageRequest {
|
|
451
|
+
storefrontOid: number;
|
|
452
|
+
key: string;
|
|
453
|
+
ifMatch: string;
|
|
454
|
+
messageWriteRequest: SfvbI18nMessageWriteRequest;
|
|
455
|
+
themeOid?: number;
|
|
456
|
+
}
|
|
403
457
|
export interface PutSfvbItemAttributesRequest {
|
|
404
458
|
storefrontOid: number;
|
|
405
459
|
itemAttributeUpdateRequest: SfvbItemAttributeUpdateRequest;
|
|
@@ -492,6 +546,12 @@ export interface ReserveSfvbWidgetIdsRequest {
|
|
|
492
546
|
storefrontOid: number;
|
|
493
547
|
count?: number;
|
|
494
548
|
}
|
|
549
|
+
export interface ResetSfvbI18nMessageRequest {
|
|
550
|
+
storefrontOid: number;
|
|
551
|
+
key: string;
|
|
552
|
+
ifMatch: string;
|
|
553
|
+
themeOid?: number;
|
|
554
|
+
}
|
|
495
555
|
export interface ResolveSfvbTemplateRequest {
|
|
496
556
|
storefrontOid: number;
|
|
497
557
|
name: string;
|
|
@@ -864,6 +924,22 @@ export interface SfvbApiInterface {
|
|
|
864
924
|
* Detach an image from a blog post
|
|
865
925
|
*/
|
|
866
926
|
detachSfvbBlogPostImage(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
927
|
+
/**
|
|
928
|
+
* Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
|
|
929
|
+
* @summary Disable a language
|
|
930
|
+
* @param {number} storefrontOid
|
|
931
|
+
* @param {string} code
|
|
932
|
+
* @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
933
|
+
* @param {*} [options] Override http request option.
|
|
934
|
+
* @throws {RequiredError}
|
|
935
|
+
* @memberof SfvbApiInterface
|
|
936
|
+
*/
|
|
937
|
+
disableSfvbI18nLanguageRaw(requestParameters: DisableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nLanguagesResponse>>;
|
|
938
|
+
/**
|
|
939
|
+
* Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
|
|
940
|
+
* Disable a language
|
|
941
|
+
*/
|
|
942
|
+
disableSfvbI18nLanguage(requestParameters: DisableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nLanguagesResponse>;
|
|
867
943
|
/**
|
|
868
944
|
* Switches the offer off. Disabling one that is switched on is a live change and needs sfvb_publish. An offer that is already off is returned unchanged. There is no delete.
|
|
869
945
|
* @summary Disable an upsell offer
|
|
@@ -987,6 +1063,23 @@ export interface SfvbApiInterface {
|
|
|
987
1063
|
* Duplicate an upsell path or one of its variations
|
|
988
1064
|
*/
|
|
989
1065
|
duplicateSfvbUpsellPath(requestParameters: DuplicateSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
1066
|
+
/**
|
|
1067
|
+
* Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
|
|
1068
|
+
* @summary Enable a language
|
|
1069
|
+
* @param {number} storefrontOid
|
|
1070
|
+
* @param {string} code
|
|
1071
|
+
* @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1072
|
+
* @param {SfvbI18nLanguageEnableRequest} languageEnableRequest The cost acknowledgement
|
|
1073
|
+
* @param {*} [options] Override http request option.
|
|
1074
|
+
* @throws {RequiredError}
|
|
1075
|
+
* @memberof SfvbApiInterface
|
|
1076
|
+
*/
|
|
1077
|
+
enableSfvbI18nLanguageRaw(requestParameters: EnableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nLanguagesResponse>>;
|
|
1078
|
+
/**
|
|
1079
|
+
* Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
|
|
1080
|
+
* Enable a language
|
|
1081
|
+
*/
|
|
1082
|
+
enableSfvbI18nLanguage(requestParameters: EnableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nLanguagesResponse>;
|
|
990
1083
|
/**
|
|
991
1084
|
* 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.
|
|
992
1085
|
* @summary End an experiment
|
|
@@ -1156,6 +1249,83 @@ export interface SfvbApiInterface {
|
|
|
1156
1249
|
* Get a URL to upload a binary asset to
|
|
1157
1250
|
*/
|
|
1158
1251
|
getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
|
|
1252
|
+
/**
|
|
1253
|
+
* The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
1254
|
+
* @summary Read the storefront\'s translation glossary
|
|
1255
|
+
* @param {number} storefrontOid
|
|
1256
|
+
* @param {*} [options] Override http request option.
|
|
1257
|
+
* @throws {RequiredError}
|
|
1258
|
+
* @memberof SfvbApiInterface
|
|
1259
|
+
*/
|
|
1260
|
+
getSfvbI18nGlossaryRaw(requestParameters: GetSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nGlossary>>;
|
|
1261
|
+
/**
|
|
1262
|
+
* The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
1263
|
+
* Read the storefront\'s translation glossary
|
|
1264
|
+
*/
|
|
1265
|
+
getSfvbI18nGlossary(requestParameters: GetSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
1266
|
+
/**
|
|
1267
|
+
* Every language the storefront can be translated into, with UltraCart\'s three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
|
|
1268
|
+
* @summary List a storefront\'s languages
|
|
1269
|
+
* @param {number} storefrontOid
|
|
1270
|
+
* @param {*} [options] Override http request option.
|
|
1271
|
+
* @throws {RequiredError}
|
|
1272
|
+
* @memberof SfvbApiInterface
|
|
1273
|
+
*/
|
|
1274
|
+
getSfvbI18nLanguagesRaw(requestParameters: GetSfvbI18nLanguagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nLanguagesResponse>>;
|
|
1275
|
+
/**
|
|
1276
|
+
* Every language the storefront can be translated into, with UltraCart\'s three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
|
|
1277
|
+
* List a storefront\'s languages
|
|
1278
|
+
*/
|
|
1279
|
+
getSfvbI18nLanguages(requestParameters: GetSfvbI18nLanguagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nLanguagesResponse>;
|
|
1280
|
+
/**
|
|
1281
|
+
* For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language\'s text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
|
|
1282
|
+
* @summary Read where a widget setting\'s translations come from
|
|
1283
|
+
* @param {number} storefrontOid
|
|
1284
|
+
* @param {number} [themeOid]
|
|
1285
|
+
* @param {string} [widgetId]
|
|
1286
|
+
* @param {string} [property]
|
|
1287
|
+
* @param {*} [options] Override http request option.
|
|
1288
|
+
* @throws {RequiredError}
|
|
1289
|
+
* @memberof SfvbApiInterface
|
|
1290
|
+
*/
|
|
1291
|
+
getSfvbI18nMachineTranslationsRaw(requestParameters: GetSfvbI18nMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMachineTranslationsResponse>>;
|
|
1292
|
+
/**
|
|
1293
|
+
* For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language\'s text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
|
|
1294
|
+
* Read where a widget setting\'s translations come from
|
|
1295
|
+
*/
|
|
1296
|
+
getSfvbI18nMachineTranslations(requestParameters: GetSfvbI18nMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMachineTranslationsResponse>;
|
|
1297
|
+
/**
|
|
1298
|
+
* One message by key, with the hash_sha256 a set or reset sends back.
|
|
1299
|
+
* @summary Read one built-in message
|
|
1300
|
+
* @param {number} storefrontOid
|
|
1301
|
+
* @param {string} key
|
|
1302
|
+
* @param {number} [themeOid]
|
|
1303
|
+
* @param {*} [options] Override http request option.
|
|
1304
|
+
* @throws {RequiredError}
|
|
1305
|
+
* @memberof SfvbApiInterface
|
|
1306
|
+
*/
|
|
1307
|
+
getSfvbI18nMessageRaw(requestParameters: GetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
1308
|
+
/**
|
|
1309
|
+
* One message by key, with the hash_sha256 a set or reset sends back.
|
|
1310
|
+
* Read one built-in message
|
|
1311
|
+
*/
|
|
1312
|
+
getSfvbI18nMessage(requestParameters: GetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
1313
|
+
/**
|
|
1314
|
+
* For one message, each enabled language\'s text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
|
|
1315
|
+
* @summary Read where a message\'s translations come from
|
|
1316
|
+
* @param {number} storefrontOid
|
|
1317
|
+
* @param {string} key
|
|
1318
|
+
* @param {number} [themeOid]
|
|
1319
|
+
* @param {*} [options] Override http request option.
|
|
1320
|
+
* @throws {RequiredError}
|
|
1321
|
+
* @memberof SfvbApiInterface
|
|
1322
|
+
*/
|
|
1323
|
+
getSfvbI18nMessageMachineTranslationsRaw(requestParameters: GetSfvbI18nMessageMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMachineTranslationsResponse>>;
|
|
1324
|
+
/**
|
|
1325
|
+
* For one message, each enabled language\'s text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
|
|
1326
|
+
* Read where a message\'s translations come from
|
|
1327
|
+
*/
|
|
1328
|
+
getSfvbI18nMessageMachineTranslations(requestParameters: GetSfvbI18nMessageMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMachineTranslationsResponse>;
|
|
1159
1329
|
/**
|
|
1160
1330
|
* The attributes, images, title, description and search metadata a StoreFront element can render, reconciled against the templates behind the pages this item sits on. An attribute a template declares but nothing has set comes back present with an empty value, which is how you discover what the page is asking for. Pricing, shipping, inventory, tax, variants and kit structure are not here because no element reads them; use the item API for those. Address by merchant_item_id, the value data-context-item-id carries, or by merchant_item_oid.
|
|
1161
1331
|
* @summary Read an item\'s storefront facing content
|
|
@@ -1692,6 +1862,26 @@ export interface SfvbApiInterface {
|
|
|
1692
1862
|
* List a storefront directory
|
|
1693
1863
|
*/
|
|
1694
1864
|
listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
|
|
1865
|
+
/**
|
|
1866
|
+
* The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
1867
|
+
* @summary List built-in messages
|
|
1868
|
+
* @param {number} storefrontOid
|
|
1869
|
+
* @param {number} [themeOid]
|
|
1870
|
+
* @param {string} [q]
|
|
1871
|
+
* @param {string} [language]
|
|
1872
|
+
* @param {boolean} [overridden]
|
|
1873
|
+
* @param {number} [offset]
|
|
1874
|
+
* @param {number} [limit]
|
|
1875
|
+
* @param {*} [options] Override http request option.
|
|
1876
|
+
* @throws {RequiredError}
|
|
1877
|
+
* @memberof SfvbApiInterface
|
|
1878
|
+
*/
|
|
1879
|
+
listSfvbI18nMessagesRaw(requestParameters: ListSfvbI18nMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessagesResponse>>;
|
|
1880
|
+
/**
|
|
1881
|
+
* The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
1882
|
+
* List built-in messages
|
|
1883
|
+
*/
|
|
1884
|
+
listSfvbI18nMessages(requestParameters: ListSfvbI18nMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessagesResponse>;
|
|
1695
1885
|
/**
|
|
1696
1886
|
* An itemcontainer element renders nothing of its own. It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers. This says which of them exist. Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has. Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist. Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first. Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
|
|
1697
1887
|
* @summary List the item containers on the account
|
|
@@ -1926,6 +2116,40 @@ export interface SfvbApiInterface {
|
|
|
1926
2116
|
* Write a storefront file
|
|
1927
2117
|
*/
|
|
1928
2118
|
putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
2119
|
+
/**
|
|
2120
|
+
* Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
|
|
2121
|
+
* @summary Replace the storefront\'s translation glossary
|
|
2122
|
+
* @param {number} storefrontOid
|
|
2123
|
+
* @param {SfvbI18nGlossaryRequest} glossaryRequest The glossary
|
|
2124
|
+
* @param {string} [ifMatch] hash_sha256 from the last read. Not needed for the first save; otherwise 428 when absent, 412 when stale.
|
|
2125
|
+
* @param {*} [options] Override http request option.
|
|
2126
|
+
* @throws {RequiredError}
|
|
2127
|
+
* @memberof SfvbApiInterface
|
|
2128
|
+
*/
|
|
2129
|
+
putSfvbI18nGlossaryRaw(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nGlossary>>;
|
|
2130
|
+
/**
|
|
2131
|
+
* Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
|
|
2132
|
+
* Replace the storefront\'s translation glossary
|
|
2133
|
+
*/
|
|
2134
|
+
putSfvbI18nGlossary(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
2135
|
+
/**
|
|
2136
|
+
* 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 is refused. Shoppers see it at once. Always needs sfvb_publish.
|
|
2137
|
+
* @summary Change one built-in message
|
|
2138
|
+
* @param {number} storefrontOid
|
|
2139
|
+
* @param {string} key
|
|
2140
|
+
* @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
2141
|
+
* @param {SfvbI18nMessageWriteRequest} messageWriteRequest The languages to change
|
|
2142
|
+
* @param {number} [themeOid]
|
|
2143
|
+
* @param {*} [options] Override http request option.
|
|
2144
|
+
* @throws {RequiredError}
|
|
2145
|
+
* @memberof SfvbApiInterface
|
|
2146
|
+
*/
|
|
2147
|
+
putSfvbI18nMessageRaw(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
2148
|
+
/**
|
|
2149
|
+
* 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 is refused. Shoppers see it at once. Always needs sfvb_publish.
|
|
2150
|
+
* Change one built-in message
|
|
2151
|
+
*/
|
|
2152
|
+
putSfvbI18nMessage(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
1929
2153
|
/**
|
|
1930
2154
|
* Partial - only the attributes named change, and an empty value empties one but keeps it on the item. To remove an attribute no template declares, use the attribute DELETE. Every entry is validated before any is written, so a refusal leaves the item untouched. The list types are checked against the shape their renderer actually parses, which matters more than it sounds: a definition list is a bare array with one letter keys, a video list is a wrapper object with keys spelled out, and an item set is comma separated text rather than JSON. A shape the renderer cannot read is not reported at render time - it renders exactly like an attribute nobody ever set.
|
|
1931
2155
|
* @summary Change some of an item\'s attributes
|
|
@@ -2216,6 +2440,23 @@ export interface SfvbApiInterface {
|
|
|
2216
2440
|
* Reserve a block of widget ids
|
|
2217
2441
|
*/
|
|
2218
2442
|
reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
|
|
2443
|
+
/**
|
|
2444
|
+
* Puts a message back to the template\'s text. The merchant\'s English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme\'s locale file is refused. Always needs sfvb_publish.
|
|
2445
|
+
* @summary Reset one built-in message
|
|
2446
|
+
* @param {number} storefrontOid
|
|
2447
|
+
* @param {string} key
|
|
2448
|
+
* @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
2449
|
+
* @param {number} [themeOid]
|
|
2450
|
+
* @param {*} [options] Override http request option.
|
|
2451
|
+
* @throws {RequiredError}
|
|
2452
|
+
* @memberof SfvbApiInterface
|
|
2453
|
+
*/
|
|
2454
|
+
resetSfvbI18nMessageRaw(requestParameters: ResetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nResetResponse>>;
|
|
2455
|
+
/**
|
|
2456
|
+
* Puts a message back to the template\'s text. The merchant\'s English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme\'s locale file is refused. Always needs sfvb_publish.
|
|
2457
|
+
* Reset one built-in message
|
|
2458
|
+
*/
|
|
2459
|
+
resetSfvbI18nMessage(requestParameters: ResetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nResetResponse>;
|
|
2219
2460
|
/**
|
|
2220
2461
|
* A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
2221
2462
|
* @summary Resolve a template name to the file a page renders
|
|
@@ -2698,6 +2939,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2698
2939
|
* Detach an image from a blog post
|
|
2699
2940
|
*/
|
|
2700
2941
|
detachSfvbBlogPostImage(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
2942
|
+
/**
|
|
2943
|
+
* Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
|
|
2944
|
+
* Disable a language
|
|
2945
|
+
*/
|
|
2946
|
+
disableSfvbI18nLanguageRaw(requestParameters: DisableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nLanguagesResponse>>;
|
|
2947
|
+
/**
|
|
2948
|
+
* Stops serving a language. Its hand and machine translations are kept and come back when it is enabled again. The default language cannot be disabled. Already disabled answers changed false. Always needs sfvb_publish.
|
|
2949
|
+
* Disable a language
|
|
2950
|
+
*/
|
|
2951
|
+
disableSfvbI18nLanguage(requestParameters: DisableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nLanguagesResponse>;
|
|
2701
2952
|
/**
|
|
2702
2953
|
* Switches the offer off. Disabling one that is switched on is a live change and needs sfvb_publish. An offer that is already off is returned unchanged. There is no delete.
|
|
2703
2954
|
* Disable an upsell offer
|
|
@@ -2778,6 +3029,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2778
3029
|
* Duplicate an upsell path or one of its variations
|
|
2779
3030
|
*/
|
|
2780
3031
|
duplicateSfvbUpsellPath(requestParameters: DuplicateSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
3032
|
+
/**
|
|
3033
|
+
* Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
|
|
3034
|
+
* Enable a language
|
|
3035
|
+
*/
|
|
3036
|
+
enableSfvbI18nLanguageRaw(requestParameters: EnableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nLanguagesResponse>>;
|
|
3037
|
+
/**
|
|
3038
|
+
* Turns a language on. It is served to shoppers and machine translated, which is billed per character, so acknowledge_cost must be true and the caller must be a person (device authorization). Records the same billing note as the merchant admin. Already enabled answers changed false. Always needs sfvb_publish.
|
|
3039
|
+
* Enable a language
|
|
3040
|
+
*/
|
|
3041
|
+
enableSfvbI18nLanguage(requestParameters: EnableSfvbI18nLanguageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nLanguagesResponse>;
|
|
2781
3042
|
/**
|
|
2782
3043
|
* 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.
|
|
2783
3044
|
* End an experiment
|
|
@@ -2886,6 +3147,56 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2886
3147
|
* Get a URL to upload a binary asset to
|
|
2887
3148
|
*/
|
|
2888
3149
|
getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
|
|
3150
|
+
/**
|
|
3151
|
+
* The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
3152
|
+
* Read the storefront\'s translation glossary
|
|
3153
|
+
*/
|
|
3154
|
+
getSfvbI18nGlossaryRaw(requestParameters: GetSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nGlossary>>;
|
|
3155
|
+
/**
|
|
3156
|
+
* The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
3157
|
+
* Read the storefront\'s translation glossary
|
|
3158
|
+
*/
|
|
3159
|
+
getSfvbI18nGlossary(requestParameters: GetSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
3160
|
+
/**
|
|
3161
|
+
* Every language the storefront can be translated into, with UltraCart\'s three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
|
|
3162
|
+
* List a storefront\'s languages
|
|
3163
|
+
*/
|
|
3164
|
+
getSfvbI18nLanguagesRaw(requestParameters: GetSfvbI18nLanguagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nLanguagesResponse>>;
|
|
3165
|
+
/**
|
|
3166
|
+
* Every language the storefront can be translated into, with UltraCart\'s three-letter code (ESP for Spanish), the other spellings accepted, whether it is enabled, the default and right to left. Language maps in CJSON and render take the code. English is the source of every string. Also gives the machine translation estimate for one more language, and the hash_sha256 an enable or disable sends back.
|
|
3167
|
+
* List a storefront\'s languages
|
|
3168
|
+
*/
|
|
3169
|
+
getSfvbI18nLanguages(requestParameters: GetSfvbI18nLanguagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nLanguagesResponse>;
|
|
3170
|
+
/**
|
|
3171
|
+
* For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language\'s text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
|
|
3172
|
+
* Read where a widget setting\'s translations come from
|
|
3173
|
+
*/
|
|
3174
|
+
getSfvbI18nMachineTranslationsRaw(requestParameters: GetSfvbI18nMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMachineTranslationsResponse>>;
|
|
3175
|
+
/**
|
|
3176
|
+
* For one multilingual widget setting, named by widget_id and property on a theme (the active theme unless theme_oid is given), each enabled language\'s text and whether a shopper sees a hand translation from the language map, a machine translation, one still queued (pending) or none yet. The setting is registered when its container is saved. Nothing is generated by reading it.
|
|
3177
|
+
* Read where a widget setting\'s translations come from
|
|
3178
|
+
*/
|
|
3179
|
+
getSfvbI18nMachineTranslations(requestParameters: GetSfvbI18nMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMachineTranslationsResponse>;
|
|
3180
|
+
/**
|
|
3181
|
+
* One message by key, with the hash_sha256 a set or reset sends back.
|
|
3182
|
+
* Read one built-in message
|
|
3183
|
+
*/
|
|
3184
|
+
getSfvbI18nMessageRaw(requestParameters: GetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
3185
|
+
/**
|
|
3186
|
+
* One message by key, with the hash_sha256 a set or reset sends back.
|
|
3187
|
+
* Read one built-in message
|
|
3188
|
+
*/
|
|
3189
|
+
getSfvbI18nMessage(requestParameters: GetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
3190
|
+
/**
|
|
3191
|
+
* For one message, each enabled language\'s text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
|
|
3192
|
+
* Read where a message\'s translations come from
|
|
3193
|
+
*/
|
|
3194
|
+
getSfvbI18nMessageMachineTranslationsRaw(requestParameters: GetSfvbI18nMessageMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMachineTranslationsResponse>>;
|
|
3195
|
+
/**
|
|
3196
|
+
* For one message, each enabled language\'s text and whether a shopper sees a hand translation, a machine translation, one still queued (pending) or none yet. Nothing is generated by reading it.
|
|
3197
|
+
* Read where a message\'s translations come from
|
|
3198
|
+
*/
|
|
3199
|
+
getSfvbI18nMessageMachineTranslations(requestParameters: GetSfvbI18nMessageMachineTranslationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMachineTranslationsResponse>;
|
|
2889
3200
|
/**
|
|
2890
3201
|
* The attributes, images, title, description and search metadata a StoreFront element can render, reconciled against the templates behind the pages this item sits on. An attribute a template declares but nothing has set comes back present with an empty value, which is how you discover what the page is asking for. Pricing, shipping, inventory, tax, variants and kit structure are not here because no element reads them; use the item API for those. Address by merchant_item_id, the value data-context-item-id carries, or by merchant_item_oid.
|
|
2891
3202
|
* Read an item\'s storefront facing content
|
|
@@ -3234,6 +3545,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3234
3545
|
* List a storefront directory
|
|
3235
3546
|
*/
|
|
3236
3547
|
listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
|
|
3548
|
+
/**
|
|
3549
|
+
* The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
3550
|
+
* List built-in messages
|
|
3551
|
+
*/
|
|
3552
|
+
listSfvbI18nMessagesRaw(requestParameters: ListSfvbI18nMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessagesResponse>>;
|
|
3553
|
+
/**
|
|
3554
|
+
* The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
3555
|
+
* List built-in messages
|
|
3556
|
+
*/
|
|
3557
|
+
listSfvbI18nMessages(requestParameters: ListSfvbI18nMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessagesResponse>;
|
|
3237
3558
|
/**
|
|
3238
3559
|
* An itemcontainer element renders nothing of its own. It names a slot, and a separate container is resolved per item for that slot, so a catalog of five hundred products with three slots is fifteen hundred containers. This says which of them exist. Filter by container_name to find every item carrying one slot, or by merchant_item_id to see what one item has. Which items are missing a slot is a set difference against pages/items, because a listing can only report containers that exist. Each row carries hash_sha256, so a listing is enough to start an If-Match write without reading the container first. Item containers are stored per account rather than per storefront, so storefront_oid identifies the caller\'s storefront but does not narrow the result.
|
|
3239
3560
|
* List the item containers on the account
|
|
@@ -3372,6 +3693,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3372
3693
|
* Write a storefront file
|
|
3373
3694
|
*/
|
|
3374
3695
|
putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
3696
|
+
/**
|
|
3697
|
+
* Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
|
|
3698
|
+
* Replace the storefront\'s translation glossary
|
|
3699
|
+
*/
|
|
3700
|
+
putSfvbI18nGlossaryRaw(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nGlossary>>;
|
|
3701
|
+
/**
|
|
3702
|
+
* Replaces the whole glossary, plain markdown up to 64 KB. The server stores it and never interprets it; the agent follows it. Send the hash_sha256 you read as If-Match, except for the first save. Always needs sfvb_publish.
|
|
3703
|
+
* Replace the storefront\'s translation glossary
|
|
3704
|
+
*/
|
|
3705
|
+
putSfvbI18nGlossary(requestParameters: PutSfvbI18nGlossaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nGlossary>;
|
|
3706
|
+
/**
|
|
3707
|
+
* 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 is refused. Shoppers see it at once. Always needs sfvb_publish.
|
|
3708
|
+
* Change one built-in message
|
|
3709
|
+
*/
|
|
3710
|
+
putSfvbI18nMessageRaw(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nMessage>>;
|
|
3711
|
+
/**
|
|
3712
|
+
* 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 is refused. Shoppers see it at once. Always needs sfvb_publish.
|
|
3713
|
+
* Change one built-in message
|
|
3714
|
+
*/
|
|
3715
|
+
putSfvbI18nMessage(requestParameters: PutSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nMessage>;
|
|
3375
3716
|
/**
|
|
3376
3717
|
* Partial - only the attributes named change, and an empty value empties one but keeps it on the item. To remove an attribute no template declares, use the attribute DELETE. Every entry is validated before any is written, so a refusal leaves the item untouched. The list types are checked against the shape their renderer actually parses, which matters more than it sounds: a definition list is a bare array with one letter keys, a video list is a wrapper object with keys spelled out, and an item set is comma separated text rather than JSON. A shape the renderer cannot read is not reported at render time - it renders exactly like an attribute nobody ever set.
|
|
3377
3718
|
* Change some of an item\'s attributes
|
|
@@ -3552,6 +3893,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3552
3893
|
* Reserve a block of widget ids
|
|
3553
3894
|
*/
|
|
3554
3895
|
reserveSfvbWidgetIds(requestParameters: ReserveSfvbWidgetIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWidgetIdsResponse>;
|
|
3896
|
+
/**
|
|
3897
|
+
* Puts a message back to the template\'s text. The merchant\'s English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme\'s locale file is refused. Always needs sfvb_publish.
|
|
3898
|
+
* Reset one built-in message
|
|
3899
|
+
*/
|
|
3900
|
+
resetSfvbI18nMessageRaw(requestParameters: ResetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbI18nResetResponse>>;
|
|
3901
|
+
/**
|
|
3902
|
+
* Puts a message back to the template\'s text. The merchant\'s English edit and hand translations stop serving at once and every language falls back to machine translation; the message comes back the next time a page renders it. A message imported from an older theme\'s locale file is refused. Always needs sfvb_publish.
|
|
3903
|
+
* Reset one built-in message
|
|
3904
|
+
*/
|
|
3905
|
+
resetSfvbI18nMessage(requestParameters: ResetSfvbI18nMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbI18nResetResponse>;
|
|
3555
3906
|
/**
|
|
3556
3907
|
* A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
3557
3908
|
* Resolve a template name to the file a page renders
|