ultracart_rest_api_v2_typescript 4.1.238 → 4.1.240
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 +18 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +189 -1
- package/dist/apis/SfvbApi.js +404 -0
- package/dist/models/SfvbApprovalCreateRequest.d.ts +16 -0
- package/dist/models/SfvbApprovalCreateRequest.js +8 -0
- package/dist/models/SfvbItemChildCreateRequest.d.ts +55 -0
- package/dist/models/SfvbItemChildCreateRequest.js +58 -0
- package/dist/models/SfvbItemChildCreateResponse.d.ts +86 -0
- package/dist/models/SfvbItemChildCreateResponse.js +69 -0
- package/dist/models/SfvbItemDefaultPageRequest.d.ts +38 -0
- package/dist/models/SfvbItemDefaultPageRequest.js +53 -0
- package/dist/models/SfvbItemDefaultPageResponse.d.ts +86 -0
- package/dist/models/SfvbItemDefaultPageResponse.js +69 -0
- package/dist/models/SfvbItemDefaultPageResult.d.ts +97 -0
- package/dist/models/SfvbItemDefaultPageResult.js +72 -0
- package/dist/models/SfvbItemDefaultPageRow.d.ts +61 -0
- package/dist/models/SfvbItemDefaultPageRow.js +60 -0
- package/dist/models/SfvbItemPageAssignment.d.ts +61 -0
- package/dist/models/SfvbItemPageAssignment.js +60 -0
- package/dist/models/SfvbItemPages.d.ts +62 -0
- package/dist/models/SfvbItemPages.js +61 -0
- package/dist/models/SfvbItemVariationAxis.d.ts +44 -0
- package/dist/models/SfvbItemVariationAxis.js +55 -0
- package/dist/models/SfvbItemVariationChange.d.ts +98 -0
- package/dist/models/SfvbItemVariationChange.js +73 -0
- package/dist/models/SfvbItemVariationChangeResult.d.ts +49 -0
- package/dist/models/SfvbItemVariationChangeResult.js +56 -0
- package/dist/models/SfvbItemVariationChild.d.ts +43 -0
- package/dist/models/SfvbItemVariationChild.js +54 -0
- package/dist/models/SfvbItemVariationCombination.d.ts +51 -0
- package/dist/models/SfvbItemVariationCombination.js +58 -0
- package/dist/models/SfvbItemVariationOption.d.ts +43 -0
- package/dist/models/SfvbItemVariationOption.js +54 -0
- package/dist/models/SfvbItemVariationValue.d.ts +37 -0
- package/dist/models/SfvbItemVariationValue.js +52 -0
- package/dist/models/SfvbItemVariations.d.ts +69 -0
- package/dist/models/SfvbItemVariations.js +64 -0
- package/dist/models/SfvbItemVariationsRequest.d.ts +38 -0
- package/dist/models/SfvbItemVariationsRequest.js +53 -0
- package/dist/models/SfvbItemVariationsResponse.d.ts +94 -0
- package/dist/models/SfvbItemVariationsResponse.js +73 -0
- package/dist/models/SfvbTrackingProviderSecrets.d.ts +6 -0
- package/dist/models/SfvbTrackingProviderSecrets.js +2 -0
- package/dist/models/index.d.ts +18 -0
- package/dist/models/index.js +18 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +484 -0
- package/src/models/SfvbApprovalCreateRequest.ts +30 -0
- package/src/models/SfvbItemChildCreateRequest.ts +99 -0
- package/src/models/SfvbItemChildCreateResponse.ts +146 -0
- package/src/models/SfvbItemDefaultPageRequest.ts +82 -0
- package/src/models/SfvbItemDefaultPageResponse.ts +146 -0
- package/src/models/SfvbItemDefaultPageResult.ts +155 -0
- package/src/models/SfvbItemDefaultPageRow.ts +107 -0
- package/src/models/SfvbItemPageAssignment.ts +107 -0
- package/src/models/SfvbItemPages.ts +114 -0
- package/src/models/SfvbItemVariationAxis.ts +90 -0
- package/src/models/SfvbItemVariationChange.ts +162 -0
- package/src/models/SfvbItemVariationChangeResult.ts +91 -0
- package/src/models/SfvbItemVariationChild.ts +83 -0
- package/src/models/SfvbItemVariationCombination.ts +104 -0
- package/src/models/SfvbItemVariationOption.ts +83 -0
- package/src/models/SfvbItemVariationValue.ts +75 -0
- package/src/models/SfvbItemVariations.ts +128 -0
- package/src/models/SfvbItemVariationsRequest.ts +82 -0
- package/src/models/SfvbItemVariationsResponse.ts +166 -0
- package/src/models/SfvbTrackingProviderSecrets.ts +8 -0
- package/src/models/index.ts +18 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1149,12 +1149,20 @@ src/models/SfvbItemAttributeBatchRow.ts
|
|
|
1149
1149
|
src/models/SfvbItemAttributeBatchRowResult.ts
|
|
1150
1150
|
src/models/SfvbItemAttributeUpdate.ts
|
|
1151
1151
|
src/models/SfvbItemAttributeUpdateRequest.ts
|
|
1152
|
+
src/models/SfvbItemChildCreateRequest.ts
|
|
1153
|
+
src/models/SfvbItemChildCreateResponse.ts
|
|
1152
1154
|
src/models/SfvbItemContainer.ts
|
|
1153
1155
|
src/models/SfvbItemContainersResponse.ts
|
|
1154
1156
|
src/models/SfvbItemContentRequest.ts
|
|
1157
|
+
src/models/SfvbItemDefaultPageRequest.ts
|
|
1158
|
+
src/models/SfvbItemDefaultPageResponse.ts
|
|
1159
|
+
src/models/SfvbItemDefaultPageResult.ts
|
|
1160
|
+
src/models/SfvbItemDefaultPageRow.ts
|
|
1155
1161
|
src/models/SfvbItemMultimedia.ts
|
|
1156
1162
|
src/models/SfvbItemMultimediaDescriptionRequest.ts
|
|
1157
1163
|
src/models/SfvbItemMultimediaRequest.ts
|
|
1164
|
+
src/models/SfvbItemPageAssignment.ts
|
|
1165
|
+
src/models/SfvbItemPages.ts
|
|
1158
1166
|
src/models/SfvbItemPreorder.ts
|
|
1159
1167
|
src/models/SfvbItemPreorderChange.ts
|
|
1160
1168
|
src/models/SfvbItemPreorderChildRow.ts
|
|
@@ -1171,6 +1179,16 @@ src/models/SfvbItemResponse.ts
|
|
|
1171
1179
|
src/models/SfvbItemSeo.ts
|
|
1172
1180
|
src/models/SfvbItemSeoRequest.ts
|
|
1173
1181
|
src/models/SfvbItemTags.ts
|
|
1182
|
+
src/models/SfvbItemVariationAxis.ts
|
|
1183
|
+
src/models/SfvbItemVariationChange.ts
|
|
1184
|
+
src/models/SfvbItemVariationChangeResult.ts
|
|
1185
|
+
src/models/SfvbItemVariationChild.ts
|
|
1186
|
+
src/models/SfvbItemVariationCombination.ts
|
|
1187
|
+
src/models/SfvbItemVariationOption.ts
|
|
1188
|
+
src/models/SfvbItemVariationValue.ts
|
|
1189
|
+
src/models/SfvbItemVariations.ts
|
|
1190
|
+
src/models/SfvbItemVariationsRequest.ts
|
|
1191
|
+
src/models/SfvbItemVariationsResponse.ts
|
|
1174
1192
|
src/models/SfvbItemVolumeDiscount.ts
|
|
1175
1193
|
src/models/SfvbLibraryAiReview.ts
|
|
1176
1194
|
src/models/SfvbLibraryContentManifest.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.240
|
|
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.240 --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.240 | 11/10/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.239 | 11/10/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.238 | 11/10/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.237 | 11/10/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.236 | 11/09/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 { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsLookupResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsRulerValidateRequest, SfvbCommsRulerValidateResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceFolderResponse, SfvbCommsSequenceFoldersResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCommsUnreferencedResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbDocsGap, SfvbDocsGapReport, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowBackfillRequest, SfvbFlowBackfillResponse, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPreorder, SfvbItemPreorderChildrenRequest, SfvbItemPreorderListResponse, SfvbItemPreorderRequest, 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, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewTrackingHtmlRequest, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingCheckPlan, SfvbTrackingHtml, SfvbTrackingHtmlRenderRequest, SfvbTrackingHtmlRenderResponse, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsLookupResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsRulerValidateRequest, SfvbCommsRulerValidateResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceFolderResponse, SfvbCommsSequenceFoldersResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCommsUnreferencedResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbDocsGap, SfvbDocsGapReport, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowBackfillRequest, SfvbFlowBackfillResponse, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemChildCreateRequest, SfvbItemChildCreateResponse, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemDefaultPageRequest, SfvbItemDefaultPageResponse, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPages, SfvbItemPreorder, SfvbItemPreorderChildrenRequest, SfvbItemPreorderListResponse, SfvbItemPreorderRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbItemVariations, SfvbItemVariationsRequest, SfvbItemVariationsResponse, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewTrackingHtmlRequest, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingCheckPlan, SfvbTrackingHtml, SfvbTrackingHtmlRenderRequest, SfvbTrackingHtmlRenderResponse, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -234,6 +234,10 @@ export interface DryRunSfvbItemAttributeBatchRequest {
|
|
|
234
234
|
storefrontOid: number;
|
|
235
235
|
itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
|
|
236
236
|
}
|
|
237
|
+
export interface DryRunSfvbItemDefaultPageRequest {
|
|
238
|
+
storefrontOid: number;
|
|
239
|
+
itemDefaultPageRequest: SfvbItemDefaultPageRequest;
|
|
240
|
+
}
|
|
237
241
|
export interface DryRunSfvbRedirectDeleteRequest {
|
|
238
242
|
storefrontOid: number;
|
|
239
243
|
redirectDeleteRequest: SfvbRedirectDeleteRequest;
|
|
@@ -486,6 +490,11 @@ export interface GetSfvbItemRequest {
|
|
|
486
490
|
merchantItemId?: string;
|
|
487
491
|
merchantItemOid?: number;
|
|
488
492
|
}
|
|
493
|
+
export interface GetSfvbItemPagesRequest {
|
|
494
|
+
storefrontOid: number;
|
|
495
|
+
merchantItemId?: string;
|
|
496
|
+
merchantItemOid?: number;
|
|
497
|
+
}
|
|
489
498
|
export interface GetSfvbItemPreorderRequest {
|
|
490
499
|
storefrontOid: number;
|
|
491
500
|
merchantItemId?: string;
|
|
@@ -506,6 +515,11 @@ export interface GetSfvbItemRelatedRequest {
|
|
|
506
515
|
merchantItemId?: string;
|
|
507
516
|
merchantItemOid?: number;
|
|
508
517
|
}
|
|
518
|
+
export interface GetSfvbItemVariationsRequest {
|
|
519
|
+
storefrontOid: number;
|
|
520
|
+
merchantItemId?: string;
|
|
521
|
+
merchantItemOid?: number;
|
|
522
|
+
}
|
|
509
523
|
export interface GetSfvbLibraryEntryRequest {
|
|
510
524
|
storefrontOid: number;
|
|
511
525
|
libraryOid: number;
|
|
@@ -763,6 +777,10 @@ export interface InsertSfvbDocsGapRequest {
|
|
|
763
777
|
docsGapReport: SfvbDocsGapReport;
|
|
764
778
|
storefrontOid?: number;
|
|
765
779
|
}
|
|
780
|
+
export interface InsertSfvbItemChildRequest {
|
|
781
|
+
storefrontOid: number;
|
|
782
|
+
itemChildRequest: SfvbItemChildCreateRequest;
|
|
783
|
+
}
|
|
766
784
|
export interface InsertSfvbPageRequest {
|
|
767
785
|
storefrontOid: number;
|
|
768
786
|
pageCreateRequest: SfvbPageCreateRequest;
|
|
@@ -1025,6 +1043,14 @@ export interface PutSfvbItemSeoRequest {
|
|
|
1025
1043
|
merchantItemId?: string;
|
|
1026
1044
|
merchantItemOid?: number;
|
|
1027
1045
|
}
|
|
1046
|
+
export interface PutSfvbItemVariationsRequest {
|
|
1047
|
+
storefrontOid: number;
|
|
1048
|
+
ifMatch: string;
|
|
1049
|
+
itemVariationsRequest: SfvbItemVariationsRequest;
|
|
1050
|
+
merchantItemId?: string;
|
|
1051
|
+
merchantItemOid?: number;
|
|
1052
|
+
approvalId?: string;
|
|
1053
|
+
}
|
|
1028
1054
|
export interface PutSfvbMenuRequest {
|
|
1029
1055
|
storefrontOid: number;
|
|
1030
1056
|
code: string;
|
|
@@ -1310,6 +1336,11 @@ export interface UpdateSfvbItemAttributeBatchRequest {
|
|
|
1310
1336
|
itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
|
|
1311
1337
|
approvalId?: string;
|
|
1312
1338
|
}
|
|
1339
|
+
export interface UpdateSfvbItemDefaultPageRequest {
|
|
1340
|
+
storefrontOid: number;
|
|
1341
|
+
itemDefaultPageRequest: SfvbItemDefaultPageRequest;
|
|
1342
|
+
approvalId?: string;
|
|
1343
|
+
}
|
|
1313
1344
|
export interface UpdateSfvbLibraryEntryRequest {
|
|
1314
1345
|
storefrontOid: number;
|
|
1315
1346
|
libraryOid: number;
|
|
@@ -2155,6 +2186,21 @@ export interface SfvbApiInterface {
|
|
|
2155
2186
|
* Check attribute changes across many items without writing them
|
|
2156
2187
|
*/
|
|
2157
2188
|
dryRunSfvbItemAttributeBatch(requestParameters: DryRunSfvbItemAttributeBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemAttributeBatchResponse>;
|
|
2189
|
+
/**
|
|
2190
|
+
* Checks up to 2,000 rows on up to 200 items, each naming an item and a page it is already on, and saves nothing. Each row answers ready, already_default, target_not_found, target_not_on_host, target_not_assigned, target_hidden (refused - a hidden page isn\'t served to shoppers), item_not_found, invalid or stale, with the item\'s current default and current_sha256. rows_sha256 covers the ready rows - request item.default_page with exactly those rows, then apply them.
|
|
2191
|
+
* @summary Check moving items\' default (canonical) pages
|
|
2192
|
+
* @param {number} storefrontOid
|
|
2193
|
+
* @param {SfvbItemDefaultPageRequest} itemDefaultPageRequest The rows
|
|
2194
|
+
* @param {*} [options] Override http request option.
|
|
2195
|
+
* @throws {RequiredError}
|
|
2196
|
+
* @memberof SfvbApiInterface
|
|
2197
|
+
*/
|
|
2198
|
+
dryRunSfvbItemDefaultPageRaw(requestParameters: DryRunSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemDefaultPageResponse>>;
|
|
2199
|
+
/**
|
|
2200
|
+
* Checks up to 2,000 rows on up to 200 items, each naming an item and a page it is already on, and saves nothing. Each row answers ready, already_default, target_not_found, target_not_on_host, target_not_assigned, target_hidden (refused - a hidden page isn\'t served to shoppers), item_not_found, invalid or stale, with the item\'s current default and current_sha256. rows_sha256 covers the ready rows - request item.default_page with exactly those rows, then apply them.
|
|
2201
|
+
* Check moving items\' default (canonical) pages
|
|
2202
|
+
*/
|
|
2203
|
+
dryRunSfvbItemDefaultPage(requestParameters: DryRunSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemDefaultPageResponse>;
|
|
2158
2204
|
/**
|
|
2159
2205
|
* Checks up to 5,000 rules by redirect_id and returns each one as deletable, stale (its hash_sha256 differs from the one sent) or not_found, with its current hash, source, target, status, type and note, and a plan_hash. Writes nothing. Rows may leave out hash_sha256; the result carries the current one to send when deleting.
|
|
2160
2206
|
* @summary Check a batch delete of redirect rules without writing it
|
|
@@ -3105,6 +3151,22 @@ export interface SfvbApiInterface {
|
|
|
3105
3151
|
* Read an item\'s storefront facing content
|
|
3106
3152
|
*/
|
|
3107
3153
|
getSfvbItem(requestParameters: GetSfvbItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
3154
|
+
/**
|
|
3155
|
+
* Every page the item is assigned to on this storefront, whether each is visible, and which is the default - the page the item\'s canonical link uses. Another storefront\'s pages aren\'t listed. hash_sha256 is the same value the default-page dry run reports as current_sha256. Address the item by merchant_item_id or merchant_item_oid.
|
|
3156
|
+
* @summary Read the pages an item is on and its default page
|
|
3157
|
+
* @param {number} storefrontOid
|
|
3158
|
+
* @param {string} [merchantItemId]
|
|
3159
|
+
* @param {number} [merchantItemOid]
|
|
3160
|
+
* @param {*} [options] Override http request option.
|
|
3161
|
+
* @throws {RequiredError}
|
|
3162
|
+
* @memberof SfvbApiInterface
|
|
3163
|
+
*/
|
|
3164
|
+
getSfvbItemPagesRaw(requestParameters: GetSfvbItemPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPages>>;
|
|
3165
|
+
/**
|
|
3166
|
+
* Every page the item is assigned to on this storefront, whether each is visible, and which is the default - the page the item\'s canonical link uses. Another storefront\'s pages aren\'t listed. hash_sha256 is the same value the default-page dry run reports as current_sha256. Address the item by merchant_item_id or merchant_item_oid.
|
|
3167
|
+
* Read the pages an item is on and its default page
|
|
3168
|
+
*/
|
|
3169
|
+
getSfvbItemPages(requestParameters: GetSfvbItemPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPages>;
|
|
3108
3170
|
/**
|
|
3109
3171
|
* Whether the item is on pre-order, its ETA, and what itempreorder shows shoppers because of them, with a hash_sha256 to send as If-Match when changing them. A variation is an item of its own and can be read here; read a parent\'s variations together with GET items/preorder/children. Address by merchant_item_id or merchant_item_oid.
|
|
3110
3172
|
* @summary Read an item\'s pre-order flag and ETA
|
|
@@ -3169,6 +3231,22 @@ export interface SfvbApiInterface {
|
|
|
3169
3231
|
* Read an item\'s related items
|
|
3170
3232
|
*/
|
|
3171
3233
|
getSfvbItemRelated(requestParameters: GetSfvbItemRelatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemRelated>;
|
|
3234
|
+
/**
|
|
3235
|
+
* The variation axes, such as Size, with their options in the order shoppers see them, and every filled combination with the child item it sells and its quantity. A combination not listed has no child, and storefronts show it as unavailable. hash_sha256 goes back as If-Match on the update. Address the parent by merchant_item_id or merchant_item_oid.
|
|
3236
|
+
* @summary Read an item\'s variations
|
|
3237
|
+
* @param {number} storefrontOid
|
|
3238
|
+
* @param {string} [merchantItemId]
|
|
3239
|
+
* @param {number} [merchantItemOid]
|
|
3240
|
+
* @param {*} [options] Override http request option.
|
|
3241
|
+
* @throws {RequiredError}
|
|
3242
|
+
* @memberof SfvbApiInterface
|
|
3243
|
+
*/
|
|
3244
|
+
getSfvbItemVariationsRaw(requestParameters: GetSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemVariations>>;
|
|
3245
|
+
/**
|
|
3246
|
+
* The variation axes, such as Size, with their options in the order shoppers see them, and every filled combination with the child item it sells and its quantity. A combination not listed has no child, and storefronts show it as unavailable. hash_sha256 goes back as If-Match on the update. Address the parent by merchant_item_id or merchant_item_oid.
|
|
3247
|
+
* Read an item\'s variations
|
|
3248
|
+
*/
|
|
3249
|
+
getSfvbItemVariations(requestParameters: GetSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemVariations>;
|
|
3172
3250
|
/**
|
|
3173
3251
|
* The owner gets the draft with its hash_sha256, which an update, delete or publish sends back as If-Match. Everyone else gets the latest published revision. Pin a published revision with revision_number. Read content_manifest before installing. If the fragment references images or other storefront files those paths will not resolve on this storefront until the entry is installed, so use install rather than this when the intent is to place the fragment.
|
|
3174
3252
|
* @summary Read one library entry including its CJSON
|
|
@@ -4126,6 +4204,21 @@ export interface SfvbApiInterface {
|
|
|
4126
4204
|
* Send UltraCart a documentation-gap report
|
|
4127
4205
|
*/
|
|
4128
4206
|
insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
|
|
4207
|
+
/**
|
|
4208
|
+
* Creates a new item copying the parent\'s description, cost, weight, dimensions and item folder, so it can be assigned to a combination with the variations update. It is not assigned here and nothing else is copied. merchant_item_id may use letters, digits, dot, underscore and dash, at most 20 characters; an id already on the account is 409 sfvb.item_exists. Needs sfvb_publish when items are live. dry_run checks without creating.
|
|
4209
|
+
* @summary Create a child item for a parent\'s variations
|
|
4210
|
+
* @param {number} storefrontOid
|
|
4211
|
+
* @param {SfvbItemChildCreateRequest} itemChildRequest The child to create
|
|
4212
|
+
* @param {*} [options] Override http request option.
|
|
4213
|
+
* @throws {RequiredError}
|
|
4214
|
+
* @memberof SfvbApiInterface
|
|
4215
|
+
*/
|
|
4216
|
+
insertSfvbItemChildRaw(requestParameters: InsertSfvbItemChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemChildCreateResponse>>;
|
|
4217
|
+
/**
|
|
4218
|
+
* Creates a new item copying the parent\'s description, cost, weight, dimensions and item folder, so it can be assigned to a combination with the variations update. It is not assigned here and nothing else is copied. merchant_item_id may use letters, digits, dot, underscore and dash, at most 20 characters; an id already on the account is 409 sfvb.item_exists. Needs sfvb_publish when items are live. dry_run checks without creating.
|
|
4219
|
+
* Create a child item for a parent\'s variations
|
|
4220
|
+
*/
|
|
4221
|
+
insertSfvbItemChild(requestParameters: InsertSfvbItemChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemChildCreateResponse>;
|
|
4129
4222
|
/**
|
|
4130
4223
|
* Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
|
|
4131
4224
|
* @summary Create a page
|
|
@@ -4908,6 +5001,25 @@ export interface SfvbApiInterface {
|
|
|
4908
5001
|
* Change an item\'s search metadata
|
|
4909
5002
|
*/
|
|
4910
5003
|
putSfvbItemSeo(requestParameters: PutSfvbItemSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
5004
|
+
/**
|
|
5005
|
+
* A list of changes applied in order - add_axis, remove_axis, rename_axis, add_option, remove_option, rename_option, reorder_options, set_default, set_default_text, set_option_multimedia and set_combination. Every change is checked before anything is saved, and nothing the list doesn\'t mention changes. Child items must already exist; create one with POST items/children. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Removing an axis, removing an option whose combinations sell a child, or re-pointing or clearing a combination shoppers can buy today also needs the approval of the person who signed in the CLI - an approved item.variations request for this item and exactly this list. Adding never does. dry_run returns the planned variations, what each change does, and whether approval is needed.
|
|
5006
|
+
* @summary Change an item\'s variations
|
|
5007
|
+
* @param {number} storefrontOid
|
|
5008
|
+
* @param {string} ifMatch hash_sha256 from the variations read. Required; 428 when absent, 412 when stale.
|
|
5009
|
+
* @param {SfvbItemVariationsRequest} itemVariationsRequest The changes
|
|
5010
|
+
* @param {string} [merchantItemId]
|
|
5011
|
+
* @param {number} [merchantItemOid]
|
|
5012
|
+
* @param {string} [approvalId] The approval_id of an approved item.variations request for this item and list. Required when the list removes or re-points something shoppers can buy. See POST /sfvb/approvals.
|
|
5013
|
+
* @param {*} [options] Override http request option.
|
|
5014
|
+
* @throws {RequiredError}
|
|
5015
|
+
* @memberof SfvbApiInterface
|
|
5016
|
+
*/
|
|
5017
|
+
putSfvbItemVariationsRaw(requestParameters: PutSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemVariationsResponse>>;
|
|
5018
|
+
/**
|
|
5019
|
+
* A list of changes applied in order - add_axis, remove_axis, rename_axis, add_option, remove_option, rename_option, reorder_options, set_default, set_default_text, set_option_multimedia and set_combination. Every change is checked before anything is saved, and nothing the list doesn\'t mention changes. Child items must already exist; create one with POST items/children. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Removing an axis, removing an option whose combinations sell a child, or re-pointing or clearing a combination shoppers can buy today also needs the approval of the person who signed in the CLI - an approved item.variations request for this item and exactly this list. Adding never does. dry_run returns the planned variations, what each change does, and whether approval is needed.
|
|
5020
|
+
* Change an item\'s variations
|
|
5021
|
+
*/
|
|
5022
|
+
putSfvbItemVariations(requestParameters: PutSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemVariationsResponse>;
|
|
4911
5023
|
/**
|
|
4912
5024
|
* A whole menu replace, not a merge - what you send is what the menu holds afterwards, so read it, change the tree and send it back. Omitting items changes only the title; sending an empty array empties the menu. Writing a code that does not exist creates it. Every entry is checked before any of it is written, including that a merchant_item_id and a page_path actually resolve, so a tree with one bad entry changes nothing. Always needs sfvb_publish, because a menu is shared by every theme and there is no dormant copy to change instead.
|
|
4913
5025
|
* @summary Replace a store menu\'s entries
|
|
@@ -5798,6 +5910,22 @@ export interface SfvbApiInterface {
|
|
|
5798
5910
|
* Change attributes across many items in one call
|
|
5799
5911
|
*/
|
|
5800
5912
|
updateSfvbItemAttributeBatch(requestParameters: UpdateSfvbItemAttributeBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemAttributeBatchResponse>;
|
|
5913
|
+
/**
|
|
5914
|
+
* Applies the dry run\'s ready rows with their rows_sha256 under an approved item.default_page request for exactly those rows. Each item\'s default moves to the named page on this storefront only; every page assignment stays, and nothing else on the item changes. A row whose pages changed since the dry run is skipped as stale, and one failed row doesn\'t stop the others. Each row is read back; it answers updated with previous_default_path, so the change can be undone, or failed. Needs sfvb_publish when items are live.
|
|
5915
|
+
* @summary Move items\' default (canonical) pages
|
|
5916
|
+
* @param {number} storefrontOid
|
|
5917
|
+
* @param {SfvbItemDefaultPageRequest} itemDefaultPageRequest The dry run\'s ready rows and rows_sha256
|
|
5918
|
+
* @param {string} [approvalId] The approval_id of an approved item.default_page request for exactly these rows. Required. See POST /sfvb/approvals.
|
|
5919
|
+
* @param {*} [options] Override http request option.
|
|
5920
|
+
* @throws {RequiredError}
|
|
5921
|
+
* @memberof SfvbApiInterface
|
|
5922
|
+
*/
|
|
5923
|
+
updateSfvbItemDefaultPageRaw(requestParameters: UpdateSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemDefaultPageResponse>>;
|
|
5924
|
+
/**
|
|
5925
|
+
* Applies the dry run\'s ready rows with their rows_sha256 under an approved item.default_page request for exactly those rows. Each item\'s default moves to the named page on this storefront only; every page assignment stays, and nothing else on the item changes. A row whose pages changed since the dry run is skipped as stale, and one failed row doesn\'t stop the others. Each row is read back; it answers updated with previous_default_path, so the change can be undone, or failed. Needs sfvb_publish when items are live.
|
|
5926
|
+
* Move items\' default (canonical) pages
|
|
5927
|
+
*/
|
|
5928
|
+
updateSfvbItemDefaultPage(requestParameters: UpdateSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemDefaultPageResponse>;
|
|
5801
5929
|
/**
|
|
5802
5930
|
* A full replace of the draft\'s fields. Owner only. Send the hash_sha256 you read as If-Match. Every save increments revision_number; nothing other merchants see changes until the draft is published. A changed fragment is re-scanned and its images copied again, and screenshot_stale tells you to retake the screenshot.
|
|
5803
5931
|
* @summary Update a library entry\'s draft
|
|
@@ -6558,6 +6686,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6558
6686
|
* Check attribute changes across many items without writing them
|
|
6559
6687
|
*/
|
|
6560
6688
|
dryRunSfvbItemAttributeBatch(requestParameters: DryRunSfvbItemAttributeBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemAttributeBatchResponse>;
|
|
6689
|
+
/**
|
|
6690
|
+
* Checks up to 2,000 rows on up to 200 items, each naming an item and a page it is already on, and saves nothing. Each row answers ready, already_default, target_not_found, target_not_on_host, target_not_assigned, target_hidden (refused - a hidden page isn\'t served to shoppers), item_not_found, invalid or stale, with the item\'s current default and current_sha256. rows_sha256 covers the ready rows - request item.default_page with exactly those rows, then apply them.
|
|
6691
|
+
* Check moving items\' default (canonical) pages
|
|
6692
|
+
*/
|
|
6693
|
+
dryRunSfvbItemDefaultPageRaw(requestParameters: DryRunSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemDefaultPageResponse>>;
|
|
6694
|
+
/**
|
|
6695
|
+
* Checks up to 2,000 rows on up to 200 items, each naming an item and a page it is already on, and saves nothing. Each row answers ready, already_default, target_not_found, target_not_on_host, target_not_assigned, target_hidden (refused - a hidden page isn\'t served to shoppers), item_not_found, invalid or stale, with the item\'s current default and current_sha256. rows_sha256 covers the ready rows - request item.default_page with exactly those rows, then apply them.
|
|
6696
|
+
* Check moving items\' default (canonical) pages
|
|
6697
|
+
*/
|
|
6698
|
+
dryRunSfvbItemDefaultPage(requestParameters: DryRunSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemDefaultPageResponse>;
|
|
6561
6699
|
/**
|
|
6562
6700
|
* Checks up to 5,000 rules by redirect_id and returns each one as deletable, stale (its hash_sha256 differs from the one sent) or not_found, with its current hash, source, target, status, type and note, and a plan_hash. Writes nothing. Rows may leave out hash_sha256; the result carries the current one to send when deleting.
|
|
6563
6701
|
* Check a batch delete of redirect rules without writing it
|
|
@@ -7186,6 +7324,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7186
7324
|
* Read an item\'s storefront facing content
|
|
7187
7325
|
*/
|
|
7188
7326
|
getSfvbItem(requestParameters: GetSfvbItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
7327
|
+
/**
|
|
7328
|
+
* Every page the item is assigned to on this storefront, whether each is visible, and which is the default - the page the item\'s canonical link uses. Another storefront\'s pages aren\'t listed. hash_sha256 is the same value the default-page dry run reports as current_sha256. Address the item by merchant_item_id or merchant_item_oid.
|
|
7329
|
+
* Read the pages an item is on and its default page
|
|
7330
|
+
*/
|
|
7331
|
+
getSfvbItemPagesRaw(requestParameters: GetSfvbItemPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPages>>;
|
|
7332
|
+
/**
|
|
7333
|
+
* Every page the item is assigned to on this storefront, whether each is visible, and which is the default - the page the item\'s canonical link uses. Another storefront\'s pages aren\'t listed. hash_sha256 is the same value the default-page dry run reports as current_sha256. Address the item by merchant_item_id or merchant_item_oid.
|
|
7334
|
+
* Read the pages an item is on and its default page
|
|
7335
|
+
*/
|
|
7336
|
+
getSfvbItemPages(requestParameters: GetSfvbItemPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPages>;
|
|
7189
7337
|
/**
|
|
7190
7338
|
* Whether the item is on pre-order, its ETA, and what itempreorder shows shoppers because of them, with a hash_sha256 to send as If-Match when changing them. A variation is an item of its own and can be read here; read a parent\'s variations together with GET items/preorder/children. Address by merchant_item_id or merchant_item_oid.
|
|
7191
7339
|
* Read an item\'s pre-order flag and ETA
|
|
@@ -7226,6 +7374,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7226
7374
|
* Read an item\'s related items
|
|
7227
7375
|
*/
|
|
7228
7376
|
getSfvbItemRelated(requestParameters: GetSfvbItemRelatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemRelated>;
|
|
7377
|
+
/**
|
|
7378
|
+
* The variation axes, such as Size, with their options in the order shoppers see them, and every filled combination with the child item it sells and its quantity. A combination not listed has no child, and storefronts show it as unavailable. hash_sha256 goes back as If-Match on the update. Address the parent by merchant_item_id or merchant_item_oid.
|
|
7379
|
+
* Read an item\'s variations
|
|
7380
|
+
*/
|
|
7381
|
+
getSfvbItemVariationsRaw(requestParameters: GetSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemVariations>>;
|
|
7382
|
+
/**
|
|
7383
|
+
* The variation axes, such as Size, with their options in the order shoppers see them, and every filled combination with the child item it sells and its quantity. A combination not listed has no child, and storefronts show it as unavailable. hash_sha256 goes back as If-Match on the update. Address the parent by merchant_item_id or merchant_item_oid.
|
|
7384
|
+
* Read an item\'s variations
|
|
7385
|
+
*/
|
|
7386
|
+
getSfvbItemVariations(requestParameters: GetSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemVariations>;
|
|
7229
7387
|
/**
|
|
7230
7388
|
* The owner gets the draft with its hash_sha256, which an update, delete or publish sends back as If-Match. Everyone else gets the latest published revision. Pin a published revision with revision_number. Read content_manifest before installing. If the fragment references images or other storefront files those paths will not resolve on this storefront until the entry is installed, so use install rather than this when the intent is to place the fragment.
|
|
7231
7389
|
* Read one library entry including its CJSON
|
|
@@ -7854,6 +8012,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7854
8012
|
* Send UltraCart a documentation-gap report
|
|
7855
8013
|
*/
|
|
7856
8014
|
insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
|
|
8015
|
+
/**
|
|
8016
|
+
* Creates a new item copying the parent\'s description, cost, weight, dimensions and item folder, so it can be assigned to a combination with the variations update. It is not assigned here and nothing else is copied. merchant_item_id may use letters, digits, dot, underscore and dash, at most 20 characters; an id already on the account is 409 sfvb.item_exists. Needs sfvb_publish when items are live. dry_run checks without creating.
|
|
8017
|
+
* Create a child item for a parent\'s variations
|
|
8018
|
+
*/
|
|
8019
|
+
insertSfvbItemChildRaw(requestParameters: InsertSfvbItemChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemChildCreateResponse>>;
|
|
8020
|
+
/**
|
|
8021
|
+
* Creates a new item copying the parent\'s description, cost, weight, dimensions and item folder, so it can be assigned to a combination with the variations update. It is not assigned here and nothing else is copied. merchant_item_id may use letters, digits, dot, underscore and dash, at most 20 characters; an id already on the account is 409 sfvb.item_exists. Needs sfvb_publish when items are live. dry_run checks without creating.
|
|
8022
|
+
* Create a child item for a parent\'s variations
|
|
8023
|
+
*/
|
|
8024
|
+
insertSfvbItemChild(requestParameters: InsertSfvbItemChildRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemChildCreateResponse>;
|
|
7857
8025
|
/**
|
|
7858
8026
|
* Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
|
|
7859
8027
|
* Create a page
|
|
@@ -8322,6 +8490,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
8322
8490
|
* Change an item\'s search metadata
|
|
8323
8491
|
*/
|
|
8324
8492
|
putSfvbItemSeo(requestParameters: PutSfvbItemSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
8493
|
+
/**
|
|
8494
|
+
* A list of changes applied in order - add_axis, remove_axis, rename_axis, add_option, remove_option, rename_option, reorder_options, set_default, set_default_text, set_option_multimedia and set_combination. Every change is checked before anything is saved, and nothing the list doesn\'t mention changes. Child items must already exist; create one with POST items/children. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Removing an axis, removing an option whose combinations sell a child, or re-pointing or clearing a combination shoppers can buy today also needs the approval of the person who signed in the CLI - an approved item.variations request for this item and exactly this list. Adding never does. dry_run returns the planned variations, what each change does, and whether approval is needed.
|
|
8495
|
+
* Change an item\'s variations
|
|
8496
|
+
*/
|
|
8497
|
+
putSfvbItemVariationsRaw(requestParameters: PutSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemVariationsResponse>>;
|
|
8498
|
+
/**
|
|
8499
|
+
* A list of changes applied in order - add_axis, remove_axis, rename_axis, add_option, remove_option, rename_option, reorder_options, set_default, set_default_text, set_option_multimedia and set_combination. Every change is checked before anything is saved, and nothing the list doesn\'t mention changes. Child items must already exist; create one with POST items/children. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Removing an axis, removing an option whose combinations sell a child, or re-pointing or clearing a combination shoppers can buy today also needs the approval of the person who signed in the CLI - an approved item.variations request for this item and exactly this list. Adding never does. dry_run returns the planned variations, what each change does, and whether approval is needed.
|
|
8500
|
+
* Change an item\'s variations
|
|
8501
|
+
*/
|
|
8502
|
+
putSfvbItemVariations(requestParameters: PutSfvbItemVariationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemVariationsResponse>;
|
|
8325
8503
|
/**
|
|
8326
8504
|
* A whole menu replace, not a merge - what you send is what the menu holds afterwards, so read it, change the tree and send it back. Omitting items changes only the title; sending an empty array empties the menu. Writing a code that does not exist creates it. Every entry is checked before any of it is written, including that a merchant_item_id and a page_path actually resolve, so a tree with one bad entry changes nothing. Always needs sfvb_publish, because a menu is shared by every theme and there is no dormant copy to change instead.
|
|
8327
8505
|
* Replace a store menu\'s entries
|
|
@@ -8872,6 +9050,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
8872
9050
|
* Change attributes across many items in one call
|
|
8873
9051
|
*/
|
|
8874
9052
|
updateSfvbItemAttributeBatch(requestParameters: UpdateSfvbItemAttributeBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemAttributeBatchResponse>;
|
|
9053
|
+
/**
|
|
9054
|
+
* Applies the dry run\'s ready rows with their rows_sha256 under an approved item.default_page request for exactly those rows. Each item\'s default moves to the named page on this storefront only; every page assignment stays, and nothing else on the item changes. A row whose pages changed since the dry run is skipped as stale, and one failed row doesn\'t stop the others. Each row is read back; it answers updated with previous_default_path, so the change can be undone, or failed. Needs sfvb_publish when items are live.
|
|
9055
|
+
* Move items\' default (canonical) pages
|
|
9056
|
+
*/
|
|
9057
|
+
updateSfvbItemDefaultPageRaw(requestParameters: UpdateSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemDefaultPageResponse>>;
|
|
9058
|
+
/**
|
|
9059
|
+
* Applies the dry run\'s ready rows with their rows_sha256 under an approved item.default_page request for exactly those rows. Each item\'s default moves to the named page on this storefront only; every page assignment stays, and nothing else on the item changes. A row whose pages changed since the dry run is skipped as stale, and one failed row doesn\'t stop the others. Each row is read back; it answers updated with previous_default_path, so the change can be undone, or failed. Needs sfvb_publish when items are live.
|
|
9060
|
+
* Move items\' default (canonical) pages
|
|
9061
|
+
*/
|
|
9062
|
+
updateSfvbItemDefaultPage(requestParameters: UpdateSfvbItemDefaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemDefaultPageResponse>;
|
|
8875
9063
|
/**
|
|
8876
9064
|
* A full replace of the draft\'s fields. Owner only. Send the hash_sha256 you read as If-Match. Every save increments revision_number; nothing other merchants see changes until the draft is published. A changed fragment is re-scanned and its images copied again, and screenshot_stale tells you to retake the screenshot.
|
|
8877
9065
|
* Update a library entry\'s draft
|