ultracart_rest_api_v2_typescript 4.1.236 → 4.1.238
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 +10 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +191 -1
- package/dist/apis/SfvbApi.js +405 -0
- package/dist/models/SfvbApprovalCreateRequest.d.ts +15 -0
- package/dist/models/SfvbApprovalCreateRequest.js +7 -0
- package/dist/models/SfvbDocsGap.d.ts +71 -0
- package/dist/models/SfvbDocsGap.js +69 -0
- package/dist/models/SfvbDocsGapReport.d.ts +50 -0
- package/dist/models/SfvbDocsGapReport.js +57 -0
- package/dist/models/SfvbDocsGapReportGap.d.ts +55 -0
- package/dist/models/SfvbDocsGapReportGap.js +58 -0
- package/dist/models/SfvbItemPreorder.d.ts +96 -0
- package/dist/models/SfvbItemPreorder.js +78 -0
- package/dist/models/SfvbItemPreorderChange.d.ts +49 -0
- package/dist/models/SfvbItemPreorderChange.js +56 -0
- package/dist/models/SfvbItemPreorderChildRow.d.ts +37 -0
- package/dist/models/SfvbItemPreorderChildRow.js +52 -0
- package/dist/models/SfvbItemPreorderChildrenRequest.d.ts +50 -0
- package/dist/models/SfvbItemPreorderChildrenRequest.js +57 -0
- package/dist/models/SfvbItemPreorderListResponse.d.ts +38 -0
- package/dist/models/SfvbItemPreorderListResponse.js +53 -0
- package/dist/models/SfvbItemPreorderOption.d.ts +37 -0
- package/dist/models/SfvbItemPreorderOption.js +52 -0
- package/dist/models/SfvbItemPreorderRequest.d.ts +43 -0
- package/dist/models/SfvbItemPreorderRequest.js +54 -0
- package/dist/models/SfvbWhoamiResponse.d.ts +12 -0
- package/dist/models/SfvbWhoamiResponse.js +4 -0
- package/dist/models/TaxJarConfig.d.ts +6 -0
- package/dist/models/TaxJarConfig.js +2 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +481 -0
- package/src/models/SfvbApprovalCreateRequest.ts +29 -0
- package/src/models/SfvbDocsGap.ts +119 -0
- package/src/models/SfvbDocsGapReport.ts +98 -0
- package/src/models/SfvbDocsGapReportGap.ts +99 -0
- package/src/models/SfvbItemPreorder.ts +163 -0
- package/src/models/SfvbItemPreorderChange.ts +91 -0
- package/src/models/SfvbItemPreorderChildRow.ts +75 -0
- package/src/models/SfvbItemPreorderChildrenRequest.ts +98 -0
- package/src/models/SfvbItemPreorderListResponse.ts +82 -0
- package/src/models/SfvbItemPreorderOption.ts +75 -0
- package/src/models/SfvbItemPreorderRequest.ts +83 -0
- package/src/models/SfvbWhoamiResponse.ts +16 -0
- package/src/models/TaxJarConfig.ts +8 -0
- package/src/models/index.ts +10 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1088,6 +1088,9 @@ src/models/SfvbContainerRevertRequest.ts
|
|
|
1088
1088
|
src/models/SfvbContainerVersion.ts
|
|
1089
1089
|
src/models/SfvbContainerVersionsResponse.ts
|
|
1090
1090
|
src/models/SfvbContainerWriteRequest.ts
|
|
1091
|
+
src/models/SfvbDocsGap.ts
|
|
1092
|
+
src/models/SfvbDocsGapReport.ts
|
|
1093
|
+
src/models/SfvbDocsGapReportGap.ts
|
|
1091
1094
|
src/models/SfvbElement.ts
|
|
1092
1095
|
src/models/SfvbElementSchemaResponse.ts
|
|
1093
1096
|
src/models/SfvbElementsResponse.ts
|
|
@@ -1152,6 +1155,13 @@ src/models/SfvbItemContentRequest.ts
|
|
|
1152
1155
|
src/models/SfvbItemMultimedia.ts
|
|
1153
1156
|
src/models/SfvbItemMultimediaDescriptionRequest.ts
|
|
1154
1157
|
src/models/SfvbItemMultimediaRequest.ts
|
|
1158
|
+
src/models/SfvbItemPreorder.ts
|
|
1159
|
+
src/models/SfvbItemPreorderChange.ts
|
|
1160
|
+
src/models/SfvbItemPreorderChildRow.ts
|
|
1161
|
+
src/models/SfvbItemPreorderChildrenRequest.ts
|
|
1162
|
+
src/models/SfvbItemPreorderListResponse.ts
|
|
1163
|
+
src/models/SfvbItemPreorderOption.ts
|
|
1164
|
+
src/models/SfvbItemPreorderRequest.ts
|
|
1155
1165
|
src/models/SfvbItemPricing.ts
|
|
1156
1166
|
src/models/SfvbItemPricingRequest.ts
|
|
1157
1167
|
src/models/SfvbItemRelated.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.238
|
|
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.238 --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.238 | 11/10/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.237 | 11/10/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.236 | 11/09/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.235 | 11/09/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.234 | 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, 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, 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, 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';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -420,6 +420,9 @@ export interface GetSfvbContainerVersionRequest {
|
|
|
420
420
|
ownerObjectId?: string;
|
|
421
421
|
containerName?: string;
|
|
422
422
|
}
|
|
423
|
+
export interface GetSfvbDocsGapRequest {
|
|
424
|
+
reportId: string;
|
|
425
|
+
}
|
|
423
426
|
export interface GetSfvbElementRequest {
|
|
424
427
|
elementType: string;
|
|
425
428
|
}
|
|
@@ -483,6 +486,16 @@ export interface GetSfvbItemRequest {
|
|
|
483
486
|
merchantItemId?: string;
|
|
484
487
|
merchantItemOid?: number;
|
|
485
488
|
}
|
|
489
|
+
export interface GetSfvbItemPreorderRequest {
|
|
490
|
+
storefrontOid: number;
|
|
491
|
+
merchantItemId?: string;
|
|
492
|
+
merchantItemOid?: number;
|
|
493
|
+
}
|
|
494
|
+
export interface GetSfvbItemPreorderChildrenRequest {
|
|
495
|
+
storefrontOid: number;
|
|
496
|
+
merchantItemId?: string;
|
|
497
|
+
merchantItemOid?: number;
|
|
498
|
+
}
|
|
486
499
|
export interface GetSfvbItemPricingRequest {
|
|
487
500
|
storefrontOid: number;
|
|
488
501
|
merchantItemId?: string;
|
|
@@ -746,6 +759,10 @@ export interface InsertSfvbCommsSendingDomainRequest {
|
|
|
746
759
|
export interface InsertSfvbCommsTwilioAccountRequest {
|
|
747
760
|
twilioAccount: SfvbCommsTwilioAccount;
|
|
748
761
|
}
|
|
762
|
+
export interface InsertSfvbDocsGapRequest {
|
|
763
|
+
docsGapReport: SfvbDocsGapReport;
|
|
764
|
+
storefrontOid?: number;
|
|
765
|
+
}
|
|
749
766
|
export interface InsertSfvbPageRequest {
|
|
750
767
|
storefrontOid: number;
|
|
751
768
|
pageCreateRequest: SfvbPageCreateRequest;
|
|
@@ -972,6 +989,21 @@ export interface PutSfvbItemMultimediaDescriptionRequest {
|
|
|
972
989
|
merchantItemId?: string;
|
|
973
990
|
merchantItemOid?: number;
|
|
974
991
|
}
|
|
992
|
+
export interface PutSfvbItemPreorderRequest {
|
|
993
|
+
storefrontOid: number;
|
|
994
|
+
ifMatch: string;
|
|
995
|
+
itemPreorderRequest: SfvbItemPreorderRequest;
|
|
996
|
+
merchantItemId?: string;
|
|
997
|
+
merchantItemOid?: number;
|
|
998
|
+
approvalId?: string;
|
|
999
|
+
}
|
|
1000
|
+
export interface PutSfvbItemPreorderChildrenRequest {
|
|
1001
|
+
storefrontOid: number;
|
|
1002
|
+
itemPreorderChildrenRequest: SfvbItemPreorderChildrenRequest;
|
|
1003
|
+
merchantItemId?: string;
|
|
1004
|
+
merchantItemOid?: number;
|
|
1005
|
+
approvalId?: string;
|
|
1006
|
+
}
|
|
975
1007
|
export interface PutSfvbItemPricingRequest {
|
|
976
1008
|
storefrontOid: number;
|
|
977
1009
|
ifMatch: string;
|
|
@@ -2831,6 +2863,20 @@ export interface SfvbApiInterface {
|
|
|
2831
2863
|
* Read the CJSON stored in one container history entry
|
|
2832
2864
|
*/
|
|
2833
2865
|
getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
|
|
2866
|
+
/**
|
|
2867
|
+
* The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
|
|
2868
|
+
* @summary Get a documentation-gap report\'s status
|
|
2869
|
+
* @param {string} reportId
|
|
2870
|
+
* @param {*} [options] Override http request option.
|
|
2871
|
+
* @throws {RequiredError}
|
|
2872
|
+
* @memberof SfvbApiInterface
|
|
2873
|
+
*/
|
|
2874
|
+
getSfvbDocsGapRaw(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
|
|
2875
|
+
/**
|
|
2876
|
+
* The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
|
|
2877
|
+
* Get a documentation-gap report\'s status
|
|
2878
|
+
*/
|
|
2879
|
+
getSfvbDocsGap(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
|
|
2834
2880
|
/**
|
|
2835
2881
|
* schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
|
|
2836
2882
|
* @summary Configuration schema and field card for one element type
|
|
@@ -3059,6 +3105,38 @@ export interface SfvbApiInterface {
|
|
|
3059
3105
|
* Read an item\'s storefront facing content
|
|
3060
3106
|
*/
|
|
3061
3107
|
getSfvbItem(requestParameters: GetSfvbItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
3108
|
+
/**
|
|
3109
|
+
* 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
|
+
* @summary Read an item\'s pre-order flag and ETA
|
|
3111
|
+
* @param {number} storefrontOid
|
|
3112
|
+
* @param {string} [merchantItemId]
|
|
3113
|
+
* @param {number} [merchantItemOid]
|
|
3114
|
+
* @param {*} [options] Override http request option.
|
|
3115
|
+
* @throws {RequiredError}
|
|
3116
|
+
* @memberof SfvbApiInterface
|
|
3117
|
+
*/
|
|
3118
|
+
getSfvbItemPreorderRaw(requestParameters: GetSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorder>>;
|
|
3119
|
+
/**
|
|
3120
|
+
* 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.
|
|
3121
|
+
* Read an item\'s pre-order flag and ETA
|
|
3122
|
+
*/
|
|
3123
|
+
getSfvbItemPreorder(requestParameters: GetSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorder>;
|
|
3124
|
+
/**
|
|
3125
|
+
* The parent\'s own values and each variation\'s, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
|
|
3126
|
+
* @summary Read the pre-order flag and ETA of a parent item\'s variations
|
|
3127
|
+
* @param {number} storefrontOid
|
|
3128
|
+
* @param {string} [merchantItemId]
|
|
3129
|
+
* @param {number} [merchantItemOid]
|
|
3130
|
+
* @param {*} [options] Override http request option.
|
|
3131
|
+
* @throws {RequiredError}
|
|
3132
|
+
* @memberof SfvbApiInterface
|
|
3133
|
+
*/
|
|
3134
|
+
getSfvbItemPreorderChildrenRaw(requestParameters: GetSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorderListResponse>>;
|
|
3135
|
+
/**
|
|
3136
|
+
* The parent\'s own values and each variation\'s, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
|
|
3137
|
+
* Read the pre-order flag and ETA of a parent item\'s variations
|
|
3138
|
+
*/
|
|
3139
|
+
getSfvbItemPreorderChildren(requestParameters: GetSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorderListResponse>;
|
|
3062
3140
|
/**
|
|
3063
3141
|
* Price, sale (with whether it applies now), MSRP and retail volume pricing - what itemprice, itemsale, itemmsrp, itemsavings and itemvolumediscounts render - with a hash_sha256 to send as If-Match when changing it. Wholesale pricing tiers are not shown. Address by merchant_item_id or merchant_item_oid.
|
|
3064
3142
|
* @summary Read what an item charges
|
|
@@ -4033,6 +4111,21 @@ export interface SfvbApiInterface {
|
|
|
4033
4111
|
* Connect the Twilio account
|
|
4034
4112
|
*/
|
|
4035
4113
|
insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
4114
|
+
/**
|
|
4115
|
+
* Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
|
|
4116
|
+
* @summary Send UltraCart a documentation-gap report
|
|
4117
|
+
* @param {SfvbDocsGapReport} docsGapReport The report
|
|
4118
|
+
* @param {number} [storefrontOid] The storefront the agent was working on, recorded for context. Leave it out when none applies.
|
|
4119
|
+
* @param {*} [options] Override http request option.
|
|
4120
|
+
* @throws {RequiredError}
|
|
4121
|
+
* @memberof SfvbApiInterface
|
|
4122
|
+
*/
|
|
4123
|
+
insertSfvbDocsGapRaw(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
|
|
4124
|
+
/**
|
|
4125
|
+
* Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
|
|
4126
|
+
* Send UltraCart a documentation-gap report
|
|
4127
|
+
*/
|
|
4128
|
+
insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
|
|
4036
4129
|
/**
|
|
4037
4130
|
* 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.
|
|
4038
4131
|
* @summary Create a page
|
|
@@ -4724,6 +4817,43 @@ export interface SfvbApiInterface {
|
|
|
4724
4817
|
* Change an item image\'s description
|
|
4725
4818
|
*/
|
|
4726
4819
|
putSfvbItemMultimediaDescription(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
4820
|
+
/**
|
|
4821
|
+
* Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
|
|
4822
|
+
* @summary Change an item\'s pre-order flag or ETA
|
|
4823
|
+
* @param {number} storefrontOid
|
|
4824
|
+
* @param {string} ifMatch hash_sha256 from the pre-order read. Required; 428 when absent, 412 when stale.
|
|
4825
|
+
* @param {SfvbItemPreorderRequest} itemPreorderRequest The change
|
|
4826
|
+
* @param {string} [merchantItemId]
|
|
4827
|
+
* @param {number} [merchantItemOid]
|
|
4828
|
+
* @param {string} [approvalId] The approval_id of an approved item.preorder request for this item and change. Required when the change puts the item on or off pre-order. See POST /sfvb/approvals.
|
|
4829
|
+
* @param {*} [options] Override http request option.
|
|
4830
|
+
* @throws {RequiredError}
|
|
4831
|
+
* @memberof SfvbApiInterface
|
|
4832
|
+
*/
|
|
4833
|
+
putSfvbItemPreorderRaw(requestParameters: PutSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorder>>;
|
|
4834
|
+
/**
|
|
4835
|
+
* Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
|
|
4836
|
+
* Change an item\'s pre-order flag or ETA
|
|
4837
|
+
*/
|
|
4838
|
+
putSfvbItemPreorder(requestParameters: PutSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorder>;
|
|
4839
|
+
/**
|
|
4840
|
+
* The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
|
|
4841
|
+
* @summary Change the pre-order flag or ETA of several variations of one parent
|
|
4842
|
+
* @param {number} storefrontOid
|
|
4843
|
+
* @param {SfvbItemPreorderChildrenRequest} itemPreorderChildrenRequest The change and the variations
|
|
4844
|
+
* @param {string} [merchantItemId]
|
|
4845
|
+
* @param {number} [merchantItemOid]
|
|
4846
|
+
* @param {string} [approvalId] The approval_id of an approved item.preorder request for the parent and this change. Required when the change puts any variation on or off pre-order. See POST /sfvb/approvals.
|
|
4847
|
+
* @param {*} [options] Override http request option.
|
|
4848
|
+
* @throws {RequiredError}
|
|
4849
|
+
* @memberof SfvbApiInterface
|
|
4850
|
+
*/
|
|
4851
|
+
putSfvbItemPreorderChildrenRaw(requestParameters: PutSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorderListResponse>>;
|
|
4852
|
+
/**
|
|
4853
|
+
* The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
|
|
4854
|
+
* Change the pre-order flag or ETA of several variations of one parent
|
|
4855
|
+
*/
|
|
4856
|
+
putSfvbItemPreorderChildren(requestParameters: PutSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorderListResponse>;
|
|
4727
4857
|
/**
|
|
4728
4858
|
* Partial - a field left out is untouched. A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it. msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it. volume_discounts replaces the retail quantity breaks. Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change. A change that sets every field to what it already is returns the pricing unchanged and uses no approval.
|
|
4729
4859
|
* @summary Change what an item charges
|
|
@@ -6896,6 +7026,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6896
7026
|
* Read the CJSON stored in one container history entry
|
|
6897
7027
|
*/
|
|
6898
7028
|
getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
|
|
7029
|
+
/**
|
|
7030
|
+
* The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
|
|
7031
|
+
* Get a documentation-gap report\'s status
|
|
7032
|
+
*/
|
|
7033
|
+
getSfvbDocsGapRaw(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
|
|
7034
|
+
/**
|
|
7035
|
+
* The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
|
|
7036
|
+
* Get a documentation-gap report\'s status
|
|
7037
|
+
*/
|
|
7038
|
+
getSfvbDocsGap(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
|
|
6899
7039
|
/**
|
|
6900
7040
|
* schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
|
|
6901
7041
|
* Configuration schema and field card for one element type
|
|
@@ -7046,6 +7186,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7046
7186
|
* Read an item\'s storefront facing content
|
|
7047
7187
|
*/
|
|
7048
7188
|
getSfvbItem(requestParameters: GetSfvbItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
7189
|
+
/**
|
|
7190
|
+
* 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
|
+
* Read an item\'s pre-order flag and ETA
|
|
7192
|
+
*/
|
|
7193
|
+
getSfvbItemPreorderRaw(requestParameters: GetSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorder>>;
|
|
7194
|
+
/**
|
|
7195
|
+
* 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.
|
|
7196
|
+
* Read an item\'s pre-order flag and ETA
|
|
7197
|
+
*/
|
|
7198
|
+
getSfvbItemPreorder(requestParameters: GetSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorder>;
|
|
7199
|
+
/**
|
|
7200
|
+
* The parent\'s own values and each variation\'s, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
|
|
7201
|
+
* Read the pre-order flag and ETA of a parent item\'s variations
|
|
7202
|
+
*/
|
|
7203
|
+
getSfvbItemPreorderChildrenRaw(requestParameters: GetSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorderListResponse>>;
|
|
7204
|
+
/**
|
|
7205
|
+
* The parent\'s own values and each variation\'s, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
|
|
7206
|
+
* Read the pre-order flag and ETA of a parent item\'s variations
|
|
7207
|
+
*/
|
|
7208
|
+
getSfvbItemPreorderChildren(requestParameters: GetSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorderListResponse>;
|
|
7049
7209
|
/**
|
|
7050
7210
|
* Price, sale (with whether it applies now), MSRP and retail volume pricing - what itemprice, itemsale, itemmsrp, itemsavings and itemvolumediscounts render - with a hash_sha256 to send as If-Match when changing it. Wholesale pricing tiers are not shown. Address by merchant_item_id or merchant_item_oid.
|
|
7051
7211
|
* Read what an item charges
|
|
@@ -7684,6 +7844,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7684
7844
|
* Connect the Twilio account
|
|
7685
7845
|
*/
|
|
7686
7846
|
insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
7847
|
+
/**
|
|
7848
|
+
* Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
|
|
7849
|
+
* Send UltraCart a documentation-gap report
|
|
7850
|
+
*/
|
|
7851
|
+
insertSfvbDocsGapRaw(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
|
|
7852
|
+
/**
|
|
7853
|
+
* Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
|
|
7854
|
+
* Send UltraCart a documentation-gap report
|
|
7855
|
+
*/
|
|
7856
|
+
insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
|
|
7687
7857
|
/**
|
|
7688
7858
|
* 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.
|
|
7689
7859
|
* Create a page
|
|
@@ -8102,6 +8272,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
8102
8272
|
* Change an item image\'s description
|
|
8103
8273
|
*/
|
|
8104
8274
|
putSfvbItemMultimediaDescription(requestParameters: PutSfvbItemMultimediaDescriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemResponse>;
|
|
8275
|
+
/**
|
|
8276
|
+
* Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
|
|
8277
|
+
* Change an item\'s pre-order flag or ETA
|
|
8278
|
+
*/
|
|
8279
|
+
putSfvbItemPreorderRaw(requestParameters: PutSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorder>>;
|
|
8280
|
+
/**
|
|
8281
|
+
* Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
|
|
8282
|
+
* Change an item\'s pre-order flag or ETA
|
|
8283
|
+
*/
|
|
8284
|
+
putSfvbItemPreorder(requestParameters: PutSfvbItemPreorderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorder>;
|
|
8285
|
+
/**
|
|
8286
|
+
* The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
|
|
8287
|
+
* Change the pre-order flag or ETA of several variations of one parent
|
|
8288
|
+
*/
|
|
8289
|
+
putSfvbItemPreorderChildrenRaw(requestParameters: PutSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbItemPreorderListResponse>>;
|
|
8290
|
+
/**
|
|
8291
|
+
* The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
|
|
8292
|
+
* Change the pre-order flag or ETA of several variations of one parent
|
|
8293
|
+
*/
|
|
8294
|
+
putSfvbItemPreorderChildren(requestParameters: PutSfvbItemPreorderChildrenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbItemPreorderListResponse>;
|
|
8105
8295
|
/**
|
|
8106
8296
|
* Partial - a field left out is untouched. A sale needs sale_cost, sale_start and sale_end together, the end after the start; clear_sale removes it. msrp must be more than 0 (0 only when the price is 0); clear_msrp removes it. volume_discounts replaces the retail quantity breaks. Shoppers pay the new price at once, so this needs sfvb_publish, If-Match with the pricing hash_sha256, and the approval of the person who signed in the CLI - an approved item.pricing request for this item and exactly this change. A change that sets every field to what it already is returns the pricing unchanged and uses no approval.
|
|
8107
8297
|
* Change what an item charges
|