ultracart_rest_api_v2_typescript 4.1.214 → 4.1.216
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 +3 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +34 -1
- package/dist/apis/SfvbApi.js +73 -0
- package/dist/models/OrderPayment.d.ts +1 -0
- package/dist/models/OrderPayment.js +1 -0
- package/dist/models/SfvbItemResponse.d.ts +7 -0
- package/dist/models/SfvbItemResponse.js +3 -0
- package/dist/models/SfvbItemTags.d.ts +43 -0
- package/dist/models/SfvbItemTags.js +54 -0
- package/dist/models/SfvbSequenceStepCreateRequest.d.ts +61 -0
- package/dist/models/SfvbSequenceStepCreateRequest.js +60 -0
- package/dist/models/SfvbSequenceStepCreateResponse.d.ts +50 -0
- package/dist/models/SfvbSequenceStepCreateResponse.js +57 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +92 -0
- package/src/models/OrderPayment.ts +1 -0
- package/src/models/SfvbItemResponse.ts +14 -0
- package/src/models/SfvbItemTags.ts +83 -0
- package/src/models/SfvbSequenceStepCreateRequest.ts +107 -0
- package/src/models/SfvbSequenceStepCreateResponse.ts +98 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1100,6 +1100,7 @@ src/models/SfvbItemRelatedRequest.ts
|
|
|
1100
1100
|
src/models/SfvbItemResponse.ts
|
|
1101
1101
|
src/models/SfvbItemSeo.ts
|
|
1102
1102
|
src/models/SfvbItemSeoRequest.ts
|
|
1103
|
+
src/models/SfvbItemTags.ts
|
|
1103
1104
|
src/models/SfvbItemVolumeDiscount.ts
|
|
1104
1105
|
src/models/SfvbLibraryAiReview.ts
|
|
1105
1106
|
src/models/SfvbLibraryContentManifest.ts
|
|
@@ -1199,6 +1200,8 @@ src/models/SfvbSecretSink.ts
|
|
|
1199
1200
|
src/models/SfvbSequence.ts
|
|
1200
1201
|
src/models/SfvbSequenceBranch.ts
|
|
1201
1202
|
src/models/SfvbSequenceStep.ts
|
|
1203
|
+
src/models/SfvbSequenceStepCreateRequest.ts
|
|
1204
|
+
src/models/SfvbSequenceStepCreateResponse.ts
|
|
1202
1205
|
src/models/SfvbSequenceStepUpdateRequest.ts
|
|
1203
1206
|
src/models/SfvbSequenceStepUpdateResponse.ts
|
|
1204
1207
|
src/models/SfvbServerLog.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.216
|
|
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.216 --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.216 | 10/29/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.215 | 10/28/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.214 | 10/28/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.213 | 10/28/2026 | auto order - improve item field descriptions |
|
|
89
91
|
| 4.1.212 | 10/27/2026 | conversation - pbx agent startup activity |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCommsListsResponse, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, 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, 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, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCommsListsResponse, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, 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, 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, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -498,6 +498,12 @@ export interface InsertSfvbRedirectRequest {
|
|
|
498
498
|
export interface InsertSfvbSecretRequestRequest {
|
|
499
499
|
secretRequest: SfvbSecretRequestCreate;
|
|
500
500
|
}
|
|
501
|
+
export interface InsertSfvbSequenceStepRequest {
|
|
502
|
+
storefrontOid: number;
|
|
503
|
+
sequenceUuid: string;
|
|
504
|
+
ifMatch: string;
|
|
505
|
+
sequenceStepCreateRequest: SfvbSequenceStepCreateRequest;
|
|
506
|
+
}
|
|
501
507
|
export interface InsertSfvbUpsellOfferRequest {
|
|
502
508
|
storefrontOid: number;
|
|
503
509
|
upsellOffer: SfvbUpsellOffer;
|
|
@@ -2751,6 +2757,23 @@ export interface SfvbApiInterface {
|
|
|
2751
2757
|
* Ask a person to enter secret values
|
|
2752
2758
|
*/
|
|
2753
2759
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
2760
|
+
/**
|
|
2761
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
2762
|
+
* @summary Add an email step, with its new email
|
|
2763
|
+
* @param {number} storefrontOid
|
|
2764
|
+
* @param {string} sequenceUuid
|
|
2765
|
+
* @param {string} ifMatch The hash_sha256 of the step it goes after, or of the branching step. Required; 428 when absent, 412 when stale.
|
|
2766
|
+
* @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\'s subject and preview text
|
|
2767
|
+
* @param {*} [options] Override http request option.
|
|
2768
|
+
* @throws {RequiredError}
|
|
2769
|
+
* @memberof SfvbApiInterface
|
|
2770
|
+
*/
|
|
2771
|
+
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
2772
|
+
/**
|
|
2773
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
2774
|
+
* Add an email step, with its new email
|
|
2775
|
+
*/
|
|
2776
|
+
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
2754
2777
|
/**
|
|
2755
2778
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
2756
2779
|
* @summary Create an upsell offer
|
|
@@ -5342,6 +5365,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5342
5365
|
* Ask a person to enter secret values
|
|
5343
5366
|
*/
|
|
5344
5367
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
5368
|
+
/**
|
|
5369
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
5370
|
+
* Add an email step, with its new email
|
|
5371
|
+
*/
|
|
5372
|
+
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
5373
|
+
/**
|
|
5374
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
5375
|
+
* Add an email step, with its new email
|
|
5376
|
+
*/
|
|
5377
|
+
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
5345
5378
|
/**
|
|
5346
5379
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
5347
5380
|
* Create an upsell offer
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -7507,6 +7507,79 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
7507
7507
|
});
|
|
7508
7508
|
});
|
|
7509
7509
|
};
|
|
7510
|
+
/**
|
|
7511
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
7512
|
+
* Add an email step, with its new email
|
|
7513
|
+
*/
|
|
7514
|
+
SfvbApi.prototype.insertSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
|
|
7515
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
7516
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
7517
|
+
return __generator(this, function (_c) {
|
|
7518
|
+
switch (_c.label) {
|
|
7519
|
+
case 0:
|
|
7520
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
7521
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling insertSfvbSequenceStep.');
|
|
7522
|
+
}
|
|
7523
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
7524
|
+
throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling insertSfvbSequenceStep.');
|
|
7525
|
+
}
|
|
7526
|
+
if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
|
|
7527
|
+
throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling insertSfvbSequenceStep.');
|
|
7528
|
+
}
|
|
7529
|
+
if (requestParameters.sequenceStepCreateRequest === null || requestParameters.sequenceStepCreateRequest === undefined) {
|
|
7530
|
+
throw new runtime.RequiredError('sequenceStepCreateRequest', 'Required parameter requestParameters.sequenceStepCreateRequest was null or undefined when calling insertSfvbSequenceStep.');
|
|
7531
|
+
}
|
|
7532
|
+
queryParameters = {};
|
|
7533
|
+
headerParameters = {};
|
|
7534
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
7535
|
+
if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
|
|
7536
|
+
headerParameters['If-Match'] = String(requestParameters.ifMatch);
|
|
7537
|
+
}
|
|
7538
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
7539
|
+
// oauth required
|
|
7540
|
+
_a = headerParameters;
|
|
7541
|
+
_b = "Authorization";
|
|
7542
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
7543
|
+
case 1:
|
|
7544
|
+
// oauth required
|
|
7545
|
+
_a[_b] = _c.sent();
|
|
7546
|
+
_c.label = 2;
|
|
7547
|
+
case 2:
|
|
7548
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
7549
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
7550
|
+
}
|
|
7551
|
+
return [4 /*yield*/, this.request({
|
|
7552
|
+
path: "/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))),
|
|
7553
|
+
method: 'POST',
|
|
7554
|
+
headers: headerParameters,
|
|
7555
|
+
query: queryParameters,
|
|
7556
|
+
body: (0, models_1.SfvbSequenceStepCreateRequestToJSON)(requestParameters.sequenceStepCreateRequest),
|
|
7557
|
+
}, initOverrides)];
|
|
7558
|
+
case 3:
|
|
7559
|
+
response = _c.sent();
|
|
7560
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSequenceStepCreateResponseFromJSON)(jsonValue); })];
|
|
7561
|
+
}
|
|
7562
|
+
});
|
|
7563
|
+
});
|
|
7564
|
+
};
|
|
7565
|
+
/**
|
|
7566
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
7567
|
+
* Add an email step, with its new email
|
|
7568
|
+
*/
|
|
7569
|
+
SfvbApi.prototype.insertSfvbSequenceStep = function (requestParameters, initOverrides) {
|
|
7570
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
7571
|
+
var response;
|
|
7572
|
+
return __generator(this, function (_a) {
|
|
7573
|
+
switch (_a.label) {
|
|
7574
|
+
case 0: return [4 /*yield*/, this.insertSfvbSequenceStepRaw(requestParameters, initOverrides)];
|
|
7575
|
+
case 1:
|
|
7576
|
+
response = _a.sent();
|
|
7577
|
+
return [4 /*yield*/, response.value()];
|
|
7578
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
7579
|
+
}
|
|
7580
|
+
});
|
|
7581
|
+
});
|
|
7582
|
+
};
|
|
7510
7583
|
/**
|
|
7511
7584
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
7512
7585
|
* Create an upsell offer
|
|
@@ -175,6 +175,7 @@ export declare const OrderPaymentPaymentMethodEnum: {
|
|
|
175
175
|
readonly Walmart: "Walmart";
|
|
176
176
|
readonly ShopCom: "Shop.com";
|
|
177
177
|
readonly Sezzle: "Sezzle";
|
|
178
|
+
readonly Truemed: "Truemed";
|
|
178
179
|
readonly Venmo: "Venmo";
|
|
179
180
|
readonly ApplePay: "Apple Pay";
|
|
180
181
|
readonly GooglePay: "Google Pay";
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { SfvbItemAttribute } from './SfvbItemAttribute';
|
|
13
13
|
import { SfvbItemMultimedia } from './SfvbItemMultimedia';
|
|
14
14
|
import { SfvbItemSeo } from './SfvbItemSeo';
|
|
15
|
+
import { SfvbItemTags } from './SfvbItemTags';
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
17
18
|
* @export
|
|
@@ -60,6 +61,12 @@ export interface SfvbItemResponse {
|
|
|
60
61
|
* @memberof SfvbItemResponse
|
|
61
62
|
*/
|
|
62
63
|
seo?: SfvbItemSeo;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {SfvbItemTags}
|
|
67
|
+
* @memberof SfvbItemResponse
|
|
68
|
+
*/
|
|
69
|
+
tags?: SfvbItemTags;
|
|
63
70
|
/**
|
|
64
71
|
* What an itemtitle element renders. This is the item's short description in the catalog, not a storefront only field, so changing it changes the item everywhere.
|
|
65
72
|
* @type {string}
|
|
@@ -18,6 +18,7 @@ var runtime_1 = require("../runtime");
|
|
|
18
18
|
var SfvbItemAttribute_1 = require("./SfvbItemAttribute");
|
|
19
19
|
var SfvbItemMultimedia_1 = require("./SfvbItemMultimedia");
|
|
20
20
|
var SfvbItemSeo_1 = require("./SfvbItemSeo");
|
|
21
|
+
var SfvbItemTags_1 = require("./SfvbItemTags");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the SfvbItemResponse interface.
|
|
23
24
|
*/
|
|
@@ -42,6 +43,7 @@ function SfvbItemResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
42
43
|
'merchant_item_oid': !(0, runtime_1.exists)(json, 'merchant_item_oid') ? undefined : json['merchant_item_oid'],
|
|
43
44
|
'multimedia': !(0, runtime_1.exists)(json, 'multimedia') ? undefined : (json['multimedia'].map(SfvbItemMultimedia_1.SfvbItemMultimediaFromJSON)),
|
|
44
45
|
'seo': !(0, runtime_1.exists)(json, 'seo') ? undefined : (0, SfvbItemSeo_1.SfvbItemSeoFromJSON)(json['seo']),
|
|
46
|
+
'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : (0, SfvbItemTags_1.SfvbItemTagsFromJSON)(json['tags']),
|
|
45
47
|
'title': !(0, runtime_1.exists)(json, 'title') ? undefined : json['title'],
|
|
46
48
|
};
|
|
47
49
|
}
|
|
@@ -61,6 +63,7 @@ function SfvbItemResponseToJSON(value) {
|
|
|
61
63
|
'merchant_item_oid': value.merchant_item_oid,
|
|
62
64
|
'multimedia': value.multimedia === undefined ? undefined : (value.multimedia.map(SfvbItemMultimedia_1.SfvbItemMultimediaToJSON)),
|
|
63
65
|
'seo': (0, SfvbItemSeo_1.SfvbItemSeoToJSON)(value.seo),
|
|
66
|
+
'tags': (0, SfvbItemTags_1.SfvbItemTagsToJSON)(value.tags),
|
|
64
67
|
'title': value.title,
|
|
65
68
|
};
|
|
66
69
|
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SfvbItemTags
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbItemTags {
|
|
18
|
+
/**
|
|
19
|
+
* Tags put on the customer when this item is bought, in stored order.
|
|
20
|
+
* @type {Array<string>}
|
|
21
|
+
* @memberof SfvbItemTags
|
|
22
|
+
*/
|
|
23
|
+
customer?: Array<string>;
|
|
24
|
+
/**
|
|
25
|
+
* The item's own tags, in stored order. These are what the item in cart with tag conditions and itemcondition check.
|
|
26
|
+
* @type {Array<string>}
|
|
27
|
+
* @memberof SfvbItemTags
|
|
28
|
+
*/
|
|
29
|
+
item?: Array<string>;
|
|
30
|
+
/**
|
|
31
|
+
* Tags put on the order when this item is bought, in stored order.
|
|
32
|
+
* @type {Array<string>}
|
|
33
|
+
* @memberof SfvbItemTags
|
|
34
|
+
*/
|
|
35
|
+
order?: Array<string>;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the SfvbItemTags interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfSfvbItemTags(value: object): boolean;
|
|
41
|
+
export declare function SfvbItemTagsFromJSON(json: any): SfvbItemTags;
|
|
42
|
+
export declare function SfvbItemTagsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbItemTags;
|
|
43
|
+
export declare function SfvbItemTagsToJSON(value?: SfvbItemTags | null): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SfvbItemTagsToJSON = exports.SfvbItemTagsFromJSONTyped = exports.SfvbItemTagsFromJSON = exports.instanceOfSfvbItemTags = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the SfvbItemTags interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfSfvbItemTags(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfSfvbItemTags = instanceOfSfvbItemTags;
|
|
26
|
+
function SfvbItemTagsFromJSON(json) {
|
|
27
|
+
return SfvbItemTagsFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.SfvbItemTagsFromJSON = SfvbItemTagsFromJSON;
|
|
30
|
+
function SfvbItemTagsFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'customer': !(0, runtime_1.exists)(json, 'customer') ? undefined : json['customer'],
|
|
36
|
+
'item': !(0, runtime_1.exists)(json, 'item') ? undefined : json['item'],
|
|
37
|
+
'order': !(0, runtime_1.exists)(json, 'order') ? undefined : json['order'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
exports.SfvbItemTagsFromJSONTyped = SfvbItemTagsFromJSONTyped;
|
|
41
|
+
function SfvbItemTagsToJSON(value) {
|
|
42
|
+
if (value === undefined) {
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
if (value === null) {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'customer': value.customer,
|
|
50
|
+
'item': value.item,
|
|
51
|
+
'order': value.order,
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.SfvbItemTagsToJSON = SfvbItemTagsToJSON;
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SfvbSequenceStepCreateRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbSequenceStepCreateRequest {
|
|
18
|
+
/**
|
|
19
|
+
* The step the new step follows, in the same list. Not an end, continue or merge step.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
22
|
+
*/
|
|
23
|
+
after_step_uuid?: string;
|
|
24
|
+
/**
|
|
25
|
+
* A condition, split or inboxgeek step. With side, the new step goes first on that side.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
28
|
+
*/
|
|
29
|
+
branch_step_uuid?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The new email's preview text, 5 to 150 characters.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
34
|
+
*/
|
|
35
|
+
preview_text?: string;
|
|
36
|
+
/**
|
|
37
|
+
* With branch_step_uuid, the side's label from the sequence read. yes or no for a condition, left or right for a split or inboxgeek step.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
40
|
+
*/
|
|
41
|
+
side?: string;
|
|
42
|
+
/**
|
|
43
|
+
* The new email's subject line, 5 to 150 characters.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
46
|
+
*/
|
|
47
|
+
subject?: string;
|
|
48
|
+
/**
|
|
49
|
+
* The kind of step. Only email for now.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
52
|
+
*/
|
|
53
|
+
type?: string;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Check if a given object implements the SfvbSequenceStepCreateRequest interface.
|
|
57
|
+
*/
|
|
58
|
+
export declare function instanceOfSfvbSequenceStepCreateRequest(value: object): boolean;
|
|
59
|
+
export declare function SfvbSequenceStepCreateRequestFromJSON(json: any): SfvbSequenceStepCreateRequest;
|
|
60
|
+
export declare function SfvbSequenceStepCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepCreateRequest;
|
|
61
|
+
export declare function SfvbSequenceStepCreateRequestToJSON(value?: SfvbSequenceStepCreateRequest | null): any;
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SfvbSequenceStepCreateRequestToJSON = exports.SfvbSequenceStepCreateRequestFromJSONTyped = exports.SfvbSequenceStepCreateRequestFromJSON = exports.instanceOfSfvbSequenceStepCreateRequest = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the SfvbSequenceStepCreateRequest interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfSfvbSequenceStepCreateRequest(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfSfvbSequenceStepCreateRequest = instanceOfSfvbSequenceStepCreateRequest;
|
|
26
|
+
function SfvbSequenceStepCreateRequestFromJSON(json) {
|
|
27
|
+
return SfvbSequenceStepCreateRequestFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.SfvbSequenceStepCreateRequestFromJSON = SfvbSequenceStepCreateRequestFromJSON;
|
|
30
|
+
function SfvbSequenceStepCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'after_step_uuid': !(0, runtime_1.exists)(json, 'after_step_uuid') ? undefined : json['after_step_uuid'],
|
|
36
|
+
'branch_step_uuid': !(0, runtime_1.exists)(json, 'branch_step_uuid') ? undefined : json['branch_step_uuid'],
|
|
37
|
+
'preview_text': !(0, runtime_1.exists)(json, 'preview_text') ? undefined : json['preview_text'],
|
|
38
|
+
'side': !(0, runtime_1.exists)(json, 'side') ? undefined : json['side'],
|
|
39
|
+
'subject': !(0, runtime_1.exists)(json, 'subject') ? undefined : json['subject'],
|
|
40
|
+
'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
exports.SfvbSequenceStepCreateRequestFromJSONTyped = SfvbSequenceStepCreateRequestFromJSONTyped;
|
|
44
|
+
function SfvbSequenceStepCreateRequestToJSON(value) {
|
|
45
|
+
if (value === undefined) {
|
|
46
|
+
return undefined;
|
|
47
|
+
}
|
|
48
|
+
if (value === null) {
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'after_step_uuid': value.after_step_uuid,
|
|
53
|
+
'branch_step_uuid': value.branch_step_uuid,
|
|
54
|
+
'preview_text': value.preview_text,
|
|
55
|
+
'side': value.side,
|
|
56
|
+
'subject': value.subject,
|
|
57
|
+
'type': value.type,
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
exports.SfvbSequenceStepCreateRequestToJSON = SfvbSequenceStepCreateRequestToJSON;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { SfvbSequenceStep } from './SfvbSequenceStep';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface SfvbSequenceStepCreateResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface SfvbSequenceStepCreateResponse {
|
|
19
|
+
/**
|
|
20
|
+
* The new email's uuid. Its body is the email container with this owner id.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
23
|
+
*/
|
|
24
|
+
email_uuid?: string;
|
|
25
|
+
/**
|
|
26
|
+
* What to do next, such as writing the body, and customers already waiting on the step before it.
|
|
27
|
+
* @type {Array<string>}
|
|
28
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
29
|
+
*/
|
|
30
|
+
notes?: Array<string>;
|
|
31
|
+
/**
|
|
32
|
+
* True when the new email must pass content review before it sends.
|
|
33
|
+
* @type {boolean}
|
|
34
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
35
|
+
*/
|
|
36
|
+
requires_review?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {SfvbSequenceStep}
|
|
40
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
41
|
+
*/
|
|
42
|
+
step?: SfvbSequenceStep;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the SfvbSequenceStepCreateResponse interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfSfvbSequenceStepCreateResponse(value: object): boolean;
|
|
48
|
+
export declare function SfvbSequenceStepCreateResponseFromJSON(json: any): SfvbSequenceStepCreateResponse;
|
|
49
|
+
export declare function SfvbSequenceStepCreateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepCreateResponse;
|
|
50
|
+
export declare function SfvbSequenceStepCreateResponseToJSON(value?: SfvbSequenceStepCreateResponse | null): any;
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SfvbSequenceStepCreateResponseToJSON = exports.SfvbSequenceStepCreateResponseFromJSONTyped = exports.SfvbSequenceStepCreateResponseFromJSON = exports.instanceOfSfvbSequenceStepCreateResponse = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var SfvbSequenceStep_1 = require("./SfvbSequenceStep");
|
|
19
|
+
/**
|
|
20
|
+
* Check if a given object implements the SfvbSequenceStepCreateResponse interface.
|
|
21
|
+
*/
|
|
22
|
+
function instanceOfSfvbSequenceStepCreateResponse(value) {
|
|
23
|
+
var isInstance = true;
|
|
24
|
+
return isInstance;
|
|
25
|
+
}
|
|
26
|
+
exports.instanceOfSfvbSequenceStepCreateResponse = instanceOfSfvbSequenceStepCreateResponse;
|
|
27
|
+
function SfvbSequenceStepCreateResponseFromJSON(json) {
|
|
28
|
+
return SfvbSequenceStepCreateResponseFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
exports.SfvbSequenceStepCreateResponseFromJSON = SfvbSequenceStepCreateResponseFromJSON;
|
|
31
|
+
function SfvbSequenceStepCreateResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if ((json === undefined) || (json === null)) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'email_uuid': !(0, runtime_1.exists)(json, 'email_uuid') ? undefined : json['email_uuid'],
|
|
37
|
+
'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
|
|
38
|
+
'requires_review': !(0, runtime_1.exists)(json, 'requires_review') ? undefined : json['requires_review'],
|
|
39
|
+
'step': !(0, runtime_1.exists)(json, 'step') ? undefined : (0, SfvbSequenceStep_1.SfvbSequenceStepFromJSON)(json['step']),
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
exports.SfvbSequenceStepCreateResponseFromJSONTyped = SfvbSequenceStepCreateResponseFromJSONTyped;
|
|
43
|
+
function SfvbSequenceStepCreateResponseToJSON(value) {
|
|
44
|
+
if (value === undefined) {
|
|
45
|
+
return undefined;
|
|
46
|
+
}
|
|
47
|
+
if (value === null) {
|
|
48
|
+
return null;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'email_uuid': value.email_uuid,
|
|
52
|
+
'notes': value.notes,
|
|
53
|
+
'requires_review': value.requires_review,
|
|
54
|
+
'step': (0, SfvbSequenceStep_1.SfvbSequenceStepToJSON)(value.step),
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
exports.SfvbSequenceStepCreateResponseToJSON = SfvbSequenceStepCreateResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1070,6 +1070,7 @@ export * from './SfvbItemRelatedRequest';
|
|
|
1070
1070
|
export * from './SfvbItemResponse';
|
|
1071
1071
|
export * from './SfvbItemSeo';
|
|
1072
1072
|
export * from './SfvbItemSeoRequest';
|
|
1073
|
+
export * from './SfvbItemTags';
|
|
1073
1074
|
export * from './SfvbItemVolumeDiscount';
|
|
1074
1075
|
export * from './SfvbLibraryAiReview';
|
|
1075
1076
|
export * from './SfvbLibraryContentManifest';
|
|
@@ -1169,6 +1170,8 @@ export * from './SfvbSecretSink';
|
|
|
1169
1170
|
export * from './SfvbSequence';
|
|
1170
1171
|
export * from './SfvbSequenceBranch';
|
|
1171
1172
|
export * from './SfvbSequenceStep';
|
|
1173
|
+
export * from './SfvbSequenceStepCreateRequest';
|
|
1174
|
+
export * from './SfvbSequenceStepCreateResponse';
|
|
1172
1175
|
export * from './SfvbSequenceStepUpdateRequest';
|
|
1173
1176
|
export * from './SfvbSequenceStepUpdateResponse';
|
|
1174
1177
|
export * from './SfvbServerLog';
|
package/dist/models/index.js
CHANGED
|
@@ -1088,6 +1088,7 @@ __exportStar(require("./SfvbItemRelatedRequest"), exports);
|
|
|
1088
1088
|
__exportStar(require("./SfvbItemResponse"), exports);
|
|
1089
1089
|
__exportStar(require("./SfvbItemSeo"), exports);
|
|
1090
1090
|
__exportStar(require("./SfvbItemSeoRequest"), exports);
|
|
1091
|
+
__exportStar(require("./SfvbItemTags"), exports);
|
|
1091
1092
|
__exportStar(require("./SfvbItemVolumeDiscount"), exports);
|
|
1092
1093
|
__exportStar(require("./SfvbLibraryAiReview"), exports);
|
|
1093
1094
|
__exportStar(require("./SfvbLibraryContentManifest"), exports);
|
|
@@ -1187,6 +1188,8 @@ __exportStar(require("./SfvbSecretSink"), exports);
|
|
|
1187
1188
|
__exportStar(require("./SfvbSequence"), exports);
|
|
1188
1189
|
__exportStar(require("./SfvbSequenceBranch"), exports);
|
|
1189
1190
|
__exportStar(require("./SfvbSequenceStep"), exports);
|
|
1191
|
+
__exportStar(require("./SfvbSequenceStepCreateRequest"), exports);
|
|
1192
|
+
__exportStar(require("./SfvbSequenceStepCreateResponse"), exports);
|
|
1190
1193
|
__exportStar(require("./SfvbSequenceStepUpdateRequest"), exports);
|
|
1191
1194
|
__exportStar(require("./SfvbSequenceStepUpdateResponse"), exports);
|
|
1192
1195
|
__exportStar(require("./SfvbServerLog"), exports);
|
package/package.json
CHANGED
package/src/apis/SfvbApi.ts
CHANGED
|
@@ -432,6 +432,12 @@ import {
|
|
|
432
432
|
SfvbSequence,
|
|
433
433
|
SfvbSequenceFromJSON,
|
|
434
434
|
SfvbSequenceToJSON,
|
|
435
|
+
SfvbSequenceStepCreateRequest,
|
|
436
|
+
SfvbSequenceStepCreateRequestFromJSON,
|
|
437
|
+
SfvbSequenceStepCreateRequestToJSON,
|
|
438
|
+
SfvbSequenceStepCreateResponse,
|
|
439
|
+
SfvbSequenceStepCreateResponseFromJSON,
|
|
440
|
+
SfvbSequenceStepCreateResponseToJSON,
|
|
435
441
|
SfvbSequenceStepUpdateRequest,
|
|
436
442
|
SfvbSequenceStepUpdateRequestFromJSON,
|
|
437
443
|
SfvbSequenceStepUpdateRequestToJSON,
|
|
@@ -1118,6 +1124,13 @@ export interface InsertSfvbSecretRequestRequest {
|
|
|
1118
1124
|
secretRequest: SfvbSecretRequestCreate;
|
|
1119
1125
|
}
|
|
1120
1126
|
|
|
1127
|
+
export interface InsertSfvbSequenceStepRequest {
|
|
1128
|
+
storefrontOid: number;
|
|
1129
|
+
sequenceUuid: string;
|
|
1130
|
+
ifMatch: string;
|
|
1131
|
+
sequenceStepCreateRequest: SfvbSequenceStepCreateRequest;
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1121
1134
|
export interface InsertSfvbUpsellOfferRequest {
|
|
1122
1135
|
storefrontOid: number;
|
|
1123
1136
|
upsellOffer: SfvbUpsellOffer;
|
|
@@ -3690,6 +3703,25 @@ export interface SfvbApiInterface {
|
|
|
3690
3703
|
*/
|
|
3691
3704
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
3692
3705
|
|
|
3706
|
+
/**
|
|
3707
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
3708
|
+
* @summary Add an email step, with its new email
|
|
3709
|
+
* @param {number} storefrontOid
|
|
3710
|
+
* @param {string} sequenceUuid
|
|
3711
|
+
* @param {string} ifMatch The hash_sha256 of the step it goes after, or of the branching step. Required; 428 when absent, 412 when stale.
|
|
3712
|
+
* @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\'s subject and preview text
|
|
3713
|
+
* @param {*} [options] Override http request option.
|
|
3714
|
+
* @throws {RequiredError}
|
|
3715
|
+
* @memberof SfvbApiInterface
|
|
3716
|
+
*/
|
|
3717
|
+
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
3718
|
+
|
|
3719
|
+
/**
|
|
3720
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
3721
|
+
* Add an email step, with its new email
|
|
3722
|
+
*/
|
|
3723
|
+
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
3724
|
+
|
|
3693
3725
|
/**
|
|
3694
3726
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
3695
3727
|
* @summary Create an upsell offer
|
|
@@ -10816,6 +10848,66 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
10816
10848
|
return await response.value();
|
|
10817
10849
|
}
|
|
10818
10850
|
|
|
10851
|
+
/**
|
|
10852
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
10853
|
+
* Add an email step, with its new email
|
|
10854
|
+
*/
|
|
10855
|
+
async insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>> {
|
|
10856
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
10857
|
+
throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling insertSfvbSequenceStep.');
|
|
10858
|
+
}
|
|
10859
|
+
|
|
10860
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
10861
|
+
throw new runtime.RequiredError('sequenceUuid','Required parameter requestParameters.sequenceUuid was null or undefined when calling insertSfvbSequenceStep.');
|
|
10862
|
+
}
|
|
10863
|
+
|
|
10864
|
+
if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
|
|
10865
|
+
throw new runtime.RequiredError('ifMatch','Required parameter requestParameters.ifMatch was null or undefined when calling insertSfvbSequenceStep.');
|
|
10866
|
+
}
|
|
10867
|
+
|
|
10868
|
+
if (requestParameters.sequenceStepCreateRequest === null || requestParameters.sequenceStepCreateRequest === undefined) {
|
|
10869
|
+
throw new runtime.RequiredError('sequenceStepCreateRequest','Required parameter requestParameters.sequenceStepCreateRequest was null or undefined when calling insertSfvbSequenceStep.');
|
|
10870
|
+
}
|
|
10871
|
+
|
|
10872
|
+
const queryParameters: any = {};
|
|
10873
|
+
|
|
10874
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
10875
|
+
|
|
10876
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
10877
|
+
|
|
10878
|
+
if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
|
|
10879
|
+
headerParameters['If-Match'] = String(requestParameters.ifMatch);
|
|
10880
|
+
}
|
|
10881
|
+
|
|
10882
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
10883
|
+
// oauth required
|
|
10884
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
|
|
10885
|
+
}
|
|
10886
|
+
|
|
10887
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
10888
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
10889
|
+
}
|
|
10890
|
+
|
|
10891
|
+
const response = await this.request({
|
|
10892
|
+
path: `/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"sequence_uuid"}}`, encodeURIComponent(String(requestParameters.sequenceUuid))),
|
|
10893
|
+
method: 'POST',
|
|
10894
|
+
headers: headerParameters,
|
|
10895
|
+
query: queryParameters,
|
|
10896
|
+
body: SfvbSequenceStepCreateRequestToJSON(requestParameters.sequenceStepCreateRequest),
|
|
10897
|
+
}, initOverrides);
|
|
10898
|
+
|
|
10899
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SfvbSequenceStepCreateResponseFromJSON(jsonValue));
|
|
10900
|
+
}
|
|
10901
|
+
|
|
10902
|
+
/**
|
|
10903
|
+
* Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
10904
|
+
* Add an email step, with its new email
|
|
10905
|
+
*/
|
|
10906
|
+
async insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse> {
|
|
10907
|
+
const response = await this.insertSfvbSequenceStepRaw(requestParameters, initOverrides);
|
|
10908
|
+
return await response.value();
|
|
10909
|
+
}
|
|
10910
|
+
|
|
10819
10911
|
/**
|
|
10820
10912
|
* Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
|
|
10821
10913
|
* Create an upsell offer
|
|
@@ -31,6 +31,12 @@ import {
|
|
|
31
31
|
SfvbItemSeoFromJSONTyped,
|
|
32
32
|
SfvbItemSeoToJSON,
|
|
33
33
|
} from './SfvbItemSeo';
|
|
34
|
+
import {
|
|
35
|
+
SfvbItemTags,
|
|
36
|
+
SfvbItemTagsFromJSON,
|
|
37
|
+
SfvbItemTagsFromJSONTyped,
|
|
38
|
+
SfvbItemTagsToJSON,
|
|
39
|
+
} from './SfvbItemTags';
|
|
34
40
|
|
|
35
41
|
/**
|
|
36
42
|
*
|
|
@@ -80,6 +86,12 @@ export interface SfvbItemResponse {
|
|
|
80
86
|
* @memberof SfvbItemResponse
|
|
81
87
|
*/
|
|
82
88
|
seo?: SfvbItemSeo;
|
|
89
|
+
/**
|
|
90
|
+
*
|
|
91
|
+
* @type {SfvbItemTags}
|
|
92
|
+
* @memberof SfvbItemResponse
|
|
93
|
+
*/
|
|
94
|
+
tags?: SfvbItemTags;
|
|
83
95
|
/**
|
|
84
96
|
* What an itemtitle element renders. This is the item's short description in the catalog, not a storefront only field, so changing it changes the item everywhere.
|
|
85
97
|
* @type {string}
|
|
@@ -116,6 +128,7 @@ export function SfvbItemResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
116
128
|
'merchant_item_oid': !exists(json, 'merchant_item_oid') ? undefined : json['merchant_item_oid'],
|
|
117
129
|
'multimedia': !exists(json, 'multimedia') ? undefined : ((json['multimedia'] as Array<any>).map(SfvbItemMultimediaFromJSON)),
|
|
118
130
|
'seo': !exists(json, 'seo') ? undefined : SfvbItemSeoFromJSON(json['seo']),
|
|
131
|
+
'tags': !exists(json, 'tags') ? undefined : SfvbItemTagsFromJSON(json['tags']),
|
|
119
132
|
'title': !exists(json, 'title') ? undefined : json['title'],
|
|
120
133
|
};
|
|
121
134
|
}
|
|
@@ -136,6 +149,7 @@ export function SfvbItemResponseToJSON(value?: SfvbItemResponse | null): any {
|
|
|
136
149
|
'merchant_item_oid': value.merchant_item_oid,
|
|
137
150
|
'multimedia': value.multimedia === undefined ? undefined : ((value.multimedia as Array<any>).map(SfvbItemMultimediaToJSON)),
|
|
138
151
|
'seo': SfvbItemSeoToJSON(value.seo),
|
|
152
|
+
'tags': SfvbItemTagsToJSON(value.tags),
|
|
139
153
|
'title': value.title,
|
|
140
154
|
};
|
|
141
155
|
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface SfvbItemTags
|
|
20
|
+
*/
|
|
21
|
+
export interface SfvbItemTags {
|
|
22
|
+
/**
|
|
23
|
+
* Tags put on the customer when this item is bought, in stored order.
|
|
24
|
+
* @type {Array<string>}
|
|
25
|
+
* @memberof SfvbItemTags
|
|
26
|
+
*/
|
|
27
|
+
customer?: Array<string>;
|
|
28
|
+
/**
|
|
29
|
+
* The item's own tags, in stored order. These are what the item in cart with tag conditions and itemcondition check.
|
|
30
|
+
* @type {Array<string>}
|
|
31
|
+
* @memberof SfvbItemTags
|
|
32
|
+
*/
|
|
33
|
+
item?: Array<string>;
|
|
34
|
+
/**
|
|
35
|
+
* Tags put on the order when this item is bought, in stored order.
|
|
36
|
+
* @type {Array<string>}
|
|
37
|
+
* @memberof SfvbItemTags
|
|
38
|
+
*/
|
|
39
|
+
order?: Array<string>;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the SfvbItemTags interface.
|
|
46
|
+
*/
|
|
47
|
+
export function instanceOfSfvbItemTags(value: object): boolean {
|
|
48
|
+
let isInstance = true;
|
|
49
|
+
|
|
50
|
+
return isInstance;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export function SfvbItemTagsFromJSON(json: any): SfvbItemTags {
|
|
54
|
+
return SfvbItemTagsFromJSONTyped(json, false);
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export function SfvbItemTagsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbItemTags {
|
|
58
|
+
if ((json === undefined) || (json === null)) {
|
|
59
|
+
return json;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
|
|
63
|
+
'customer': !exists(json, 'customer') ? undefined : json['customer'],
|
|
64
|
+
'item': !exists(json, 'item') ? undefined : json['item'],
|
|
65
|
+
'order': !exists(json, 'order') ? undefined : json['order'],
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function SfvbItemTagsToJSON(value?: SfvbItemTags | null): any {
|
|
70
|
+
if (value === undefined) {
|
|
71
|
+
return undefined;
|
|
72
|
+
}
|
|
73
|
+
if (value === null) {
|
|
74
|
+
return null;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
'customer': value.customer,
|
|
79
|
+
'item': value.item,
|
|
80
|
+
'order': value.order,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface SfvbSequenceStepCreateRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface SfvbSequenceStepCreateRequest {
|
|
22
|
+
/**
|
|
23
|
+
* The step the new step follows, in the same list. Not an end, continue or merge step.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
26
|
+
*/
|
|
27
|
+
after_step_uuid?: string;
|
|
28
|
+
/**
|
|
29
|
+
* A condition, split or inboxgeek step. With side, the new step goes first on that side.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
32
|
+
*/
|
|
33
|
+
branch_step_uuid?: string;
|
|
34
|
+
/**
|
|
35
|
+
* The new email's preview text, 5 to 150 characters.
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
38
|
+
*/
|
|
39
|
+
preview_text?: string;
|
|
40
|
+
/**
|
|
41
|
+
* With branch_step_uuid, the side's label from the sequence read. yes or no for a condition, left or right for a split or inboxgeek step.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
44
|
+
*/
|
|
45
|
+
side?: string;
|
|
46
|
+
/**
|
|
47
|
+
* The new email's subject line, 5 to 150 characters.
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
50
|
+
*/
|
|
51
|
+
subject?: string;
|
|
52
|
+
/**
|
|
53
|
+
* The kind of step. Only email for now.
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof SfvbSequenceStepCreateRequest
|
|
56
|
+
*/
|
|
57
|
+
type?: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Check if a given object implements the SfvbSequenceStepCreateRequest interface.
|
|
64
|
+
*/
|
|
65
|
+
export function instanceOfSfvbSequenceStepCreateRequest(value: object): boolean {
|
|
66
|
+
let isInstance = true;
|
|
67
|
+
|
|
68
|
+
return isInstance;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function SfvbSequenceStepCreateRequestFromJSON(json: any): SfvbSequenceStepCreateRequest {
|
|
72
|
+
return SfvbSequenceStepCreateRequestFromJSONTyped(json, false);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function SfvbSequenceStepCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepCreateRequest {
|
|
76
|
+
if ((json === undefined) || (json === null)) {
|
|
77
|
+
return json;
|
|
78
|
+
}
|
|
79
|
+
return {
|
|
80
|
+
|
|
81
|
+
'after_step_uuid': !exists(json, 'after_step_uuid') ? undefined : json['after_step_uuid'],
|
|
82
|
+
'branch_step_uuid': !exists(json, 'branch_step_uuid') ? undefined : json['branch_step_uuid'],
|
|
83
|
+
'preview_text': !exists(json, 'preview_text') ? undefined : json['preview_text'],
|
|
84
|
+
'side': !exists(json, 'side') ? undefined : json['side'],
|
|
85
|
+
'subject': !exists(json, 'subject') ? undefined : json['subject'],
|
|
86
|
+
'type': !exists(json, 'type') ? undefined : json['type'],
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function SfvbSequenceStepCreateRequestToJSON(value?: SfvbSequenceStepCreateRequest | null): any {
|
|
91
|
+
if (value === undefined) {
|
|
92
|
+
return undefined;
|
|
93
|
+
}
|
|
94
|
+
if (value === null) {
|
|
95
|
+
return null;
|
|
96
|
+
}
|
|
97
|
+
return {
|
|
98
|
+
|
|
99
|
+
'after_step_uuid': value.after_step_uuid,
|
|
100
|
+
'branch_step_uuid': value.branch_step_uuid,
|
|
101
|
+
'preview_text': value.preview_text,
|
|
102
|
+
'side': value.side,
|
|
103
|
+
'subject': value.subject,
|
|
104
|
+
'type': value.type,
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
SfvbSequenceStep,
|
|
18
|
+
SfvbSequenceStepFromJSON,
|
|
19
|
+
SfvbSequenceStepFromJSONTyped,
|
|
20
|
+
SfvbSequenceStepToJSON,
|
|
21
|
+
} from './SfvbSequenceStep';
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @export
|
|
26
|
+
* @interface SfvbSequenceStepCreateResponse
|
|
27
|
+
*/
|
|
28
|
+
export interface SfvbSequenceStepCreateResponse {
|
|
29
|
+
/**
|
|
30
|
+
* The new email's uuid. Its body is the email container with this owner id.
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
33
|
+
*/
|
|
34
|
+
email_uuid?: string;
|
|
35
|
+
/**
|
|
36
|
+
* What to do next, such as writing the body, and customers already waiting on the step before it.
|
|
37
|
+
* @type {Array<string>}
|
|
38
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
39
|
+
*/
|
|
40
|
+
notes?: Array<string>;
|
|
41
|
+
/**
|
|
42
|
+
* True when the new email must pass content review before it sends.
|
|
43
|
+
* @type {boolean}
|
|
44
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
45
|
+
*/
|
|
46
|
+
requires_review?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {SfvbSequenceStep}
|
|
50
|
+
* @memberof SfvbSequenceStepCreateResponse
|
|
51
|
+
*/
|
|
52
|
+
step?: SfvbSequenceStep;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Check if a given object implements the SfvbSequenceStepCreateResponse interface.
|
|
59
|
+
*/
|
|
60
|
+
export function instanceOfSfvbSequenceStepCreateResponse(value: object): boolean {
|
|
61
|
+
let isInstance = true;
|
|
62
|
+
|
|
63
|
+
return isInstance;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function SfvbSequenceStepCreateResponseFromJSON(json: any): SfvbSequenceStepCreateResponse {
|
|
67
|
+
return SfvbSequenceStepCreateResponseFromJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function SfvbSequenceStepCreateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepCreateResponse {
|
|
71
|
+
if ((json === undefined) || (json === null)) {
|
|
72
|
+
return json;
|
|
73
|
+
}
|
|
74
|
+
return {
|
|
75
|
+
|
|
76
|
+
'email_uuid': !exists(json, 'email_uuid') ? undefined : json['email_uuid'],
|
|
77
|
+
'notes': !exists(json, 'notes') ? undefined : json['notes'],
|
|
78
|
+
'requires_review': !exists(json, 'requires_review') ? undefined : json['requires_review'],
|
|
79
|
+
'step': !exists(json, 'step') ? undefined : SfvbSequenceStepFromJSON(json['step']),
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function SfvbSequenceStepCreateResponseToJSON(value?: SfvbSequenceStepCreateResponse | null): any {
|
|
84
|
+
if (value === undefined) {
|
|
85
|
+
return undefined;
|
|
86
|
+
}
|
|
87
|
+
if (value === null) {
|
|
88
|
+
return null;
|
|
89
|
+
}
|
|
90
|
+
return {
|
|
91
|
+
|
|
92
|
+
'email_uuid': value.email_uuid,
|
|
93
|
+
'notes': value.notes,
|
|
94
|
+
'requires_review': value.requires_review,
|
|
95
|
+
'step': SfvbSequenceStepToJSON(value.step),
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -1072,6 +1072,7 @@ export * from './SfvbItemRelatedRequest';
|
|
|
1072
1072
|
export * from './SfvbItemResponse';
|
|
1073
1073
|
export * from './SfvbItemSeo';
|
|
1074
1074
|
export * from './SfvbItemSeoRequest';
|
|
1075
|
+
export * from './SfvbItemTags';
|
|
1075
1076
|
export * from './SfvbItemVolumeDiscount';
|
|
1076
1077
|
export * from './SfvbLibraryAiReview';
|
|
1077
1078
|
export * from './SfvbLibraryContentManifest';
|
|
@@ -1171,6 +1172,8 @@ export * from './SfvbSecretSink';
|
|
|
1171
1172
|
export * from './SfvbSequence';
|
|
1172
1173
|
export * from './SfvbSequenceBranch';
|
|
1173
1174
|
export * from './SfvbSequenceStep';
|
|
1175
|
+
export * from './SfvbSequenceStepCreateRequest';
|
|
1176
|
+
export * from './SfvbSequenceStepCreateResponse';
|
|
1174
1177
|
export * from './SfvbSequenceStepUpdateRequest';
|
|
1175
1178
|
export * from './SfvbSequenceStepUpdateResponse';
|
|
1176
1179
|
export * from './SfvbServerLog';
|