ultracart_rest_api_v2_typescript 4.1.237 → 4.1.239

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.
Files changed (42) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +135 -1
  4. package/dist/apis/SfvbApi.js +282 -0
  5. package/dist/models/SfvbApprovalCreateRequest.d.ts +15 -0
  6. package/dist/models/SfvbApprovalCreateRequest.js +7 -0
  7. package/dist/models/SfvbItemPreorder.d.ts +96 -0
  8. package/dist/models/SfvbItemPreorder.js +78 -0
  9. package/dist/models/SfvbItemPreorderChange.d.ts +49 -0
  10. package/dist/models/SfvbItemPreorderChange.js +56 -0
  11. package/dist/models/SfvbItemPreorderChildRow.d.ts +37 -0
  12. package/dist/models/SfvbItemPreorderChildRow.js +52 -0
  13. package/dist/models/SfvbItemPreorderChildrenRequest.d.ts +50 -0
  14. package/dist/models/SfvbItemPreorderChildrenRequest.js +57 -0
  15. package/dist/models/SfvbItemPreorderListResponse.d.ts +38 -0
  16. package/dist/models/SfvbItemPreorderListResponse.js +53 -0
  17. package/dist/models/SfvbItemPreorderOption.d.ts +37 -0
  18. package/dist/models/SfvbItemPreorderOption.js +52 -0
  19. package/dist/models/SfvbItemPreorderRequest.d.ts +43 -0
  20. package/dist/models/SfvbItemPreorderRequest.js +54 -0
  21. package/dist/models/SfvbTrackingProviderSecrets.d.ts +6 -0
  22. package/dist/models/SfvbTrackingProviderSecrets.js +2 -0
  23. package/dist/models/SfvbWhoamiResponse.d.ts +12 -0
  24. package/dist/models/SfvbWhoamiResponse.js +4 -0
  25. package/dist/models/TaxJarConfig.d.ts +6 -0
  26. package/dist/models/TaxJarConfig.js +2 -0
  27. package/dist/models/index.d.ts +7 -0
  28. package/dist/models/index.js +7 -0
  29. package/package.json +1 -1
  30. package/src/apis/SfvbApi.ts +344 -0
  31. package/src/models/SfvbApprovalCreateRequest.ts +29 -0
  32. package/src/models/SfvbItemPreorder.ts +163 -0
  33. package/src/models/SfvbItemPreorderChange.ts +91 -0
  34. package/src/models/SfvbItemPreorderChildRow.ts +75 -0
  35. package/src/models/SfvbItemPreorderChildrenRequest.ts +98 -0
  36. package/src/models/SfvbItemPreorderListResponse.ts +82 -0
  37. package/src/models/SfvbItemPreorderOption.ts +75 -0
  38. package/src/models/SfvbItemPreorderRequest.ts +83 -0
  39. package/src/models/SfvbTrackingProviderSecrets.ts +8 -0
  40. package/src/models/SfvbWhoamiResponse.ts +16 -0
  41. package/src/models/TaxJarConfig.ts +8 -0
  42. package/src/models/index.ts +7 -0
@@ -1155,6 +1155,13 @@ src/models/SfvbItemContentRequest.ts
1155
1155
  src/models/SfvbItemMultimedia.ts
1156
1156
  src/models/SfvbItemMultimediaDescriptionRequest.ts
1157
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
1158
1165
  src/models/SfvbItemPricing.ts
1159
1166
  src/models/SfvbItemPricingRequest.ts
1160
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.237
2
+ ## ultracart_rest_api_v2_typescript@4.1.239
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.237 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.239 --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.239 | 11/10/2026 | sfvb internal testing |
88
+ | 4.1.238 | 11/10/2026 | sfvb internal testing |
87
89
  | 4.1.237 | 11/10/2026 | sfvb internal testing |
88
90
  | 4.1.236 | 11/09/2026 | sfvb internal testing |
89
91
  | 4.1.235 | 11/09/2026 | sfvb internal testing |
@@ -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, 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;
@@ -486,6 +486,16 @@ export interface GetSfvbItemRequest {
486
486
  merchantItemId?: string;
487
487
  merchantItemOid?: number;
488
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
+ }
489
499
  export interface GetSfvbItemPricingRequest {
490
500
  storefrontOid: number;
491
501
  merchantItemId?: string;
@@ -979,6 +989,21 @@ export interface PutSfvbItemMultimediaDescriptionRequest {
979
989
  merchantItemId?: string;
980
990
  merchantItemOid?: number;
981
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
+ }
982
1007
  export interface PutSfvbItemPricingRequest {
983
1008
  storefrontOid: number;
984
1009
  ifMatch: string;
@@ -3080,6 +3105,38 @@ export interface SfvbApiInterface {
3080
3105
  * Read an item\'s storefront facing content
3081
3106
  */
3082
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>;
3083
3140
  /**
3084
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.
3085
3142
  * @summary Read what an item charges
@@ -4760,6 +4817,43 @@ export interface SfvbApiInterface {
4760
4817
  * Change an item image\'s description
4761
4818
  */
4762
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>;
4763
4857
  /**
4764
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.
4765
4859
  * @summary Change what an item charges
@@ -7092,6 +7186,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
7092
7186
  * Read an item\'s storefront facing content
7093
7187
  */
7094
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>;
7095
7209
  /**
7096
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.
7097
7211
  * Read what an item charges
@@ -8158,6 +8272,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
8158
8272
  * Change an item image\'s description
8159
8273
  */
8160
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>;
8161
8295
  /**
8162
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.
8163
8297
  * Change what an item charges
@@ -7101,6 +7101,136 @@ var SfvbApi = /** @class */ (function (_super) {
7101
7101
  });
7102
7102
  });
7103
7103
  };
7104
+ /**
7105
+ * 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.
7106
+ * Read an item\'s pre-order flag and ETA
7107
+ */
7108
+ SfvbApi.prototype.getSfvbItemPreorderRaw = function (requestParameters, initOverrides) {
7109
+ return __awaiter(this, void 0, void 0, function () {
7110
+ var queryParameters, headerParameters, _a, _b, response;
7111
+ return __generator(this, function (_c) {
7112
+ switch (_c.label) {
7113
+ case 0:
7114
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
7115
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbItemPreorder.');
7116
+ }
7117
+ queryParameters = {};
7118
+ if (requestParameters.merchantItemId !== undefined) {
7119
+ queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
7120
+ }
7121
+ if (requestParameters.merchantItemOid !== undefined) {
7122
+ queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
7123
+ }
7124
+ headerParameters = {};
7125
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
7126
+ // oauth required
7127
+ _a = headerParameters;
7128
+ _b = "Authorization";
7129
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
7130
+ case 1:
7131
+ // oauth required
7132
+ _a[_b] = _c.sent();
7133
+ _c.label = 2;
7134
+ case 2:
7135
+ if (this.configuration && this.configuration.apiKey) {
7136
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
7137
+ }
7138
+ return [4 /*yield*/, this.request({
7139
+ path: "/sfvb/storefronts/{storefront_oid}/items/preorder".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
7140
+ method: 'GET',
7141
+ headers: headerParameters,
7142
+ query: queryParameters,
7143
+ }, initOverrides)];
7144
+ case 3:
7145
+ response = _c.sent();
7146
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbItemPreorderFromJSON)(jsonValue); })];
7147
+ }
7148
+ });
7149
+ });
7150
+ };
7151
+ /**
7152
+ * 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.
7153
+ * Read an item\'s pre-order flag and ETA
7154
+ */
7155
+ SfvbApi.prototype.getSfvbItemPreorder = function (requestParameters, initOverrides) {
7156
+ return __awaiter(this, void 0, void 0, function () {
7157
+ var response;
7158
+ return __generator(this, function (_a) {
7159
+ switch (_a.label) {
7160
+ case 0: return [4 /*yield*/, this.getSfvbItemPreorderRaw(requestParameters, initOverrides)];
7161
+ case 1:
7162
+ response = _a.sent();
7163
+ return [4 /*yield*/, response.value()];
7164
+ case 2: return [2 /*return*/, _a.sent()];
7165
+ }
7166
+ });
7167
+ });
7168
+ };
7169
+ /**
7170
+ * 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.
7171
+ * Read the pre-order flag and ETA of a parent item\'s variations
7172
+ */
7173
+ SfvbApi.prototype.getSfvbItemPreorderChildrenRaw = function (requestParameters, initOverrides) {
7174
+ return __awaiter(this, void 0, void 0, function () {
7175
+ var queryParameters, headerParameters, _a, _b, response;
7176
+ return __generator(this, function (_c) {
7177
+ switch (_c.label) {
7178
+ case 0:
7179
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
7180
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbItemPreorderChildren.');
7181
+ }
7182
+ queryParameters = {};
7183
+ if (requestParameters.merchantItemId !== undefined) {
7184
+ queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
7185
+ }
7186
+ if (requestParameters.merchantItemOid !== undefined) {
7187
+ queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
7188
+ }
7189
+ headerParameters = {};
7190
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
7191
+ // oauth required
7192
+ _a = headerParameters;
7193
+ _b = "Authorization";
7194
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
7195
+ case 1:
7196
+ // oauth required
7197
+ _a[_b] = _c.sent();
7198
+ _c.label = 2;
7199
+ case 2:
7200
+ if (this.configuration && this.configuration.apiKey) {
7201
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
7202
+ }
7203
+ return [4 /*yield*/, this.request({
7204
+ path: "/sfvb/storefronts/{storefront_oid}/items/preorder/children".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
7205
+ method: 'GET',
7206
+ headers: headerParameters,
7207
+ query: queryParameters,
7208
+ }, initOverrides)];
7209
+ case 3:
7210
+ response = _c.sent();
7211
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbItemPreorderListResponseFromJSON)(jsonValue); })];
7212
+ }
7213
+ });
7214
+ });
7215
+ };
7216
+ /**
7217
+ * 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.
7218
+ * Read the pre-order flag and ETA of a parent item\'s variations
7219
+ */
7220
+ SfvbApi.prototype.getSfvbItemPreorderChildren = function (requestParameters, initOverrides) {
7221
+ return __awaiter(this, void 0, void 0, function () {
7222
+ var response;
7223
+ return __generator(this, function (_a) {
7224
+ switch (_a.label) {
7225
+ case 0: return [4 /*yield*/, this.getSfvbItemPreorderChildrenRaw(requestParameters, initOverrides)];
7226
+ case 1:
7227
+ response = _a.sent();
7228
+ return [4 /*yield*/, response.value()];
7229
+ case 2: return [2 /*return*/, _a.sent()];
7230
+ }
7231
+ });
7232
+ });
7233
+ };
7104
7234
  /**
7105
7235
  * 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.
7106
7236
  * Read what an item charges
@@ -14060,6 +14190,158 @@ var SfvbApi = /** @class */ (function (_super) {
14060
14190
  });
14061
14191
  });
14062
14192
  };
14193
+ /**
14194
+ * 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.
14195
+ * Change an item\'s pre-order flag or ETA
14196
+ */
14197
+ SfvbApi.prototype.putSfvbItemPreorderRaw = function (requestParameters, initOverrides) {
14198
+ return __awaiter(this, void 0, void 0, function () {
14199
+ var queryParameters, headerParameters, _a, _b, response;
14200
+ return __generator(this, function (_c) {
14201
+ switch (_c.label) {
14202
+ case 0:
14203
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
14204
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbItemPreorder.');
14205
+ }
14206
+ if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
14207
+ throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling putSfvbItemPreorder.');
14208
+ }
14209
+ if (requestParameters.itemPreorderRequest === null || requestParameters.itemPreorderRequest === undefined) {
14210
+ throw new runtime.RequiredError('itemPreorderRequest', 'Required parameter requestParameters.itemPreorderRequest was null or undefined when calling putSfvbItemPreorder.');
14211
+ }
14212
+ queryParameters = {};
14213
+ if (requestParameters.merchantItemId !== undefined) {
14214
+ queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
14215
+ }
14216
+ if (requestParameters.merchantItemOid !== undefined) {
14217
+ queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
14218
+ }
14219
+ headerParameters = {};
14220
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
14221
+ if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
14222
+ headerParameters['If-Match'] = String(requestParameters.ifMatch);
14223
+ }
14224
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
14225
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
14226
+ }
14227
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
14228
+ // oauth required
14229
+ _a = headerParameters;
14230
+ _b = "Authorization";
14231
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
14232
+ case 1:
14233
+ // oauth required
14234
+ _a[_b] = _c.sent();
14235
+ _c.label = 2;
14236
+ case 2:
14237
+ if (this.configuration && this.configuration.apiKey) {
14238
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
14239
+ }
14240
+ return [4 /*yield*/, this.request({
14241
+ path: "/sfvb/storefronts/{storefront_oid}/items/preorder".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
14242
+ method: 'PUT',
14243
+ headers: headerParameters,
14244
+ query: queryParameters,
14245
+ body: (0, models_1.SfvbItemPreorderRequestToJSON)(requestParameters.itemPreorderRequest),
14246
+ }, initOverrides)];
14247
+ case 3:
14248
+ response = _c.sent();
14249
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbItemPreorderFromJSON)(jsonValue); })];
14250
+ }
14251
+ });
14252
+ });
14253
+ };
14254
+ /**
14255
+ * 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.
14256
+ * Change an item\'s pre-order flag or ETA
14257
+ */
14258
+ SfvbApi.prototype.putSfvbItemPreorder = function (requestParameters, initOverrides) {
14259
+ return __awaiter(this, void 0, void 0, function () {
14260
+ var response;
14261
+ return __generator(this, function (_a) {
14262
+ switch (_a.label) {
14263
+ case 0: return [4 /*yield*/, this.putSfvbItemPreorderRaw(requestParameters, initOverrides)];
14264
+ case 1:
14265
+ response = _a.sent();
14266
+ return [4 /*yield*/, response.value()];
14267
+ case 2: return [2 /*return*/, _a.sent()];
14268
+ }
14269
+ });
14270
+ });
14271
+ };
14272
+ /**
14273
+ * 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.
14274
+ * Change the pre-order flag or ETA of several variations of one parent
14275
+ */
14276
+ SfvbApi.prototype.putSfvbItemPreorderChildrenRaw = function (requestParameters, initOverrides) {
14277
+ return __awaiter(this, void 0, void 0, function () {
14278
+ var queryParameters, headerParameters, _a, _b, response;
14279
+ return __generator(this, function (_c) {
14280
+ switch (_c.label) {
14281
+ case 0:
14282
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
14283
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbItemPreorderChildren.');
14284
+ }
14285
+ if (requestParameters.itemPreorderChildrenRequest === null || requestParameters.itemPreorderChildrenRequest === undefined) {
14286
+ throw new runtime.RequiredError('itemPreorderChildrenRequest', 'Required parameter requestParameters.itemPreorderChildrenRequest was null or undefined when calling putSfvbItemPreorderChildren.');
14287
+ }
14288
+ queryParameters = {};
14289
+ if (requestParameters.merchantItemId !== undefined) {
14290
+ queryParameters['merchant_item_id'] = requestParameters.merchantItemId;
14291
+ }
14292
+ if (requestParameters.merchantItemOid !== undefined) {
14293
+ queryParameters['merchant_item_oid'] = requestParameters.merchantItemOid;
14294
+ }
14295
+ headerParameters = {};
14296
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
14297
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
14298
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
14299
+ }
14300
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
14301
+ // oauth required
14302
+ _a = headerParameters;
14303
+ _b = "Authorization";
14304
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
14305
+ case 1:
14306
+ // oauth required
14307
+ _a[_b] = _c.sent();
14308
+ _c.label = 2;
14309
+ case 2:
14310
+ if (this.configuration && this.configuration.apiKey) {
14311
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
14312
+ }
14313
+ return [4 /*yield*/, this.request({
14314
+ path: "/sfvb/storefronts/{storefront_oid}/items/preorder/children".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
14315
+ method: 'PUT',
14316
+ headers: headerParameters,
14317
+ query: queryParameters,
14318
+ body: (0, models_1.SfvbItemPreorderChildrenRequestToJSON)(requestParameters.itemPreorderChildrenRequest),
14319
+ }, initOverrides)];
14320
+ case 3:
14321
+ response = _c.sent();
14322
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbItemPreorderListResponseFromJSON)(jsonValue); })];
14323
+ }
14324
+ });
14325
+ });
14326
+ };
14327
+ /**
14328
+ * 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.
14329
+ * Change the pre-order flag or ETA of several variations of one parent
14330
+ */
14331
+ SfvbApi.prototype.putSfvbItemPreorderChildren = function (requestParameters, initOverrides) {
14332
+ return __awaiter(this, void 0, void 0, function () {
14333
+ var response;
14334
+ return __generator(this, function (_a) {
14335
+ switch (_a.label) {
14336
+ case 0: return [4 /*yield*/, this.putSfvbItemPreorderChildrenRaw(requestParameters, initOverrides)];
14337
+ case 1:
14338
+ response = _a.sent();
14339
+ return [4 /*yield*/, response.value()];
14340
+ case 2: return [2 /*return*/, _a.sent()];
14341
+ }
14342
+ });
14343
+ });
14344
+ };
14063
14345
  /**
14064
14346
  * 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.
14065
14347
  * Change what an item charges
@@ -18,6 +18,8 @@ import { SfvbCommsTestPostcardRequest } from './SfvbCommsTestPostcardRequest';
18
18
  import { SfvbExperimentStartRequest } from './SfvbExperimentStartRequest';
19
19
  import { SfvbFlowBackfillRequest } from './SfvbFlowBackfillRequest';
20
20
  import { SfvbItemAttributeBatchRow } from './SfvbItemAttributeBatchRow';
21
+ import { SfvbItemPreorderChildrenRequest } from './SfvbItemPreorderChildrenRequest';
22
+ import { SfvbItemPreorderRequest } from './SfvbItemPreorderRequest';
21
23
  import { SfvbItemPricingRequest } from './SfvbItemPricingRequest';
22
24
  import { SfvbRedirectDeleteRow } from './SfvbRedirectDeleteRow';
23
25
  import { SfvbSiteSeoRequest } from './SfvbSiteSeoRequest';
@@ -78,6 +80,18 @@ export interface SfvbApprovalCreateRequest {
78
80
  * @memberof SfvbApprovalCreateRequest
79
81
  */
80
82
  item_attribute_rows?: Array<SfvbItemAttributeBatchRow>;
83
+ /**
84
+ *
85
+ * @type {SfvbItemPreorderRequest}
86
+ * @memberof SfvbApprovalCreateRequest
87
+ */
88
+ item_preorder?: SfvbItemPreorderRequest;
89
+ /**
90
+ *
91
+ * @type {SfvbItemPreorderChildrenRequest}
92
+ * @memberof SfvbApprovalCreateRequest
93
+ */
94
+ item_preorder_children?: SfvbItemPreorderChildrenRequest;
81
95
  /**
82
96
  *
83
97
  * @type {SfvbItemPricingRequest}
@@ -152,6 +166,7 @@ export declare const SfvbApprovalCreateRequestActionEnum: {
152
166
  readonly UpsellEnable: "upsell.enable";
153
167
  readonly ItemAttributeBatch: "item.attribute_batch";
154
168
  readonly ItemPricing: "item.pricing";
169
+ readonly ItemPreorder: "item.preorder";
155
170
  readonly TwilioAccountDelete: "twilio_account.delete";
156
171
  readonly SendingDomainDelete: "sending_domain.delete";
157
172
  readonly SequenceStepDelete: "sequence_step.delete";
@@ -24,6 +24,8 @@ var SfvbCommsTestPostcardRequest_1 = require("./SfvbCommsTestPostcardRequest");
24
24
  var SfvbExperimentStartRequest_1 = require("./SfvbExperimentStartRequest");
25
25
  var SfvbFlowBackfillRequest_1 = require("./SfvbFlowBackfillRequest");
26
26
  var SfvbItemAttributeBatchRow_1 = require("./SfvbItemAttributeBatchRow");
27
+ var SfvbItemPreorderChildrenRequest_1 = require("./SfvbItemPreorderChildrenRequest");
28
+ var SfvbItemPreorderRequest_1 = require("./SfvbItemPreorderRequest");
27
29
  var SfvbItemPricingRequest_1 = require("./SfvbItemPricingRequest");
28
30
  var SfvbRedirectDeleteRow_1 = require("./SfvbRedirectDeleteRow");
29
31
  var SfvbSiteSeoRequest_1 = require("./SfvbSiteSeoRequest");
@@ -43,6 +45,7 @@ exports.SfvbApprovalCreateRequestActionEnum = {
43
45
  UpsellEnable: 'upsell.enable',
44
46
  ItemAttributeBatch: 'item.attribute_batch',
45
47
  ItemPricing: 'item.pricing',
48
+ ItemPreorder: 'item.preorder',
46
49
  TwilioAccountDelete: 'twilio_account.delete',
47
50
  SendingDomainDelete: 'sending_domain.delete',
48
51
  SequenceStepDelete: 'sequence_step.delete',
@@ -88,6 +91,8 @@ function SfvbApprovalCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
88
91
  'experiment_start': !(0, runtime_1.exists)(json, 'experiment_start') ? undefined : (0, SfvbExperimentStartRequest_1.SfvbExperimentStartRequestFromJSON)(json['experiment_start']),
89
92
  'flow_backfill': !(0, runtime_1.exists)(json, 'flow_backfill') ? undefined : (0, SfvbFlowBackfillRequest_1.SfvbFlowBackfillRequestFromJSON)(json['flow_backfill']),
90
93
  'item_attribute_rows': !(0, runtime_1.exists)(json, 'item_attribute_rows') ? undefined : (json['item_attribute_rows'].map(SfvbItemAttributeBatchRow_1.SfvbItemAttributeBatchRowFromJSON)),
94
+ 'item_preorder': !(0, runtime_1.exists)(json, 'item_preorder') ? undefined : (0, SfvbItemPreorderRequest_1.SfvbItemPreorderRequestFromJSON)(json['item_preorder']),
95
+ 'item_preorder_children': !(0, runtime_1.exists)(json, 'item_preorder_children') ? undefined : (0, SfvbItemPreorderChildrenRequest_1.SfvbItemPreorderChildrenRequestFromJSON)(json['item_preorder_children']),
91
96
  'item_pricing': !(0, runtime_1.exists)(json, 'item_pricing') ? undefined : (0, SfvbItemPricingRequest_1.SfvbItemPricingRequestFromJSON)(json['item_pricing']),
92
97
  'params': !(0, runtime_1.exists)(json, 'params') ? undefined : (0, SfvbApprovalParams_1.SfvbApprovalParamsFromJSON)(json['params']),
93
98
  'postcard_test_mail': !(0, runtime_1.exists)(json, 'postcard_test_mail') ? undefined : (0, SfvbCommsTestPostcardRequest_1.SfvbCommsTestPostcardRequestFromJSON)(json['postcard_test_mail']),
@@ -117,6 +122,8 @@ function SfvbApprovalCreateRequestToJSON(value) {
117
122
  'experiment_start': (0, SfvbExperimentStartRequest_1.SfvbExperimentStartRequestToJSON)(value.experiment_start),
118
123
  'flow_backfill': (0, SfvbFlowBackfillRequest_1.SfvbFlowBackfillRequestToJSON)(value.flow_backfill),
119
124
  'item_attribute_rows': value.item_attribute_rows === undefined ? undefined : (value.item_attribute_rows.map(SfvbItemAttributeBatchRow_1.SfvbItemAttributeBatchRowToJSON)),
125
+ 'item_preorder': (0, SfvbItemPreorderRequest_1.SfvbItemPreorderRequestToJSON)(value.item_preorder),
126
+ 'item_preorder_children': (0, SfvbItemPreorderChildrenRequest_1.SfvbItemPreorderChildrenRequestToJSON)(value.item_preorder_children),
120
127
  'item_pricing': (0, SfvbItemPricingRequest_1.SfvbItemPricingRequestToJSON)(value.item_pricing),
121
128
  'params': (0, SfvbApprovalParams_1.SfvbApprovalParamsToJSON)(value.params),
122
129
  'postcard_test_mail': (0, SfvbCommsTestPostcardRequest_1.SfvbCommsTestPostcardRequestToJSON)(value.postcard_test_mail),