ultracart_rest_api_v2_typescript 4.1.215 → 4.1.217
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 +69 -1
- package/dist/apis/SfvbApi.js +147 -0
- package/dist/models/OrderPayment.d.ts +1 -0
- package/dist/models/OrderPayment.js +1 -0
- package/dist/models/SfvbApprovalCreateRequest.d.ts +3 -0
- package/dist/models/SfvbApprovalCreateRequest.js +4 -1
- package/dist/models/SfvbApprovalParams.d.ts +12 -0
- package/dist/models/SfvbApprovalParams.js +4 -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/SfvbSequenceStepDeleteResponse.d.ts +49 -0
- package/dist/models/SfvbSequenceStepDeleteResponse.js +56 -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 +184 -0
- package/src/models/OrderPayment.ts +1 -0
- package/src/models/SfvbApprovalCreateRequest.ts +4 -1
- package/src/models/SfvbApprovalParams.ts +16 -0
- package/src/models/SfvbSequenceStepCreateRequest.ts +107 -0
- package/src/models/SfvbSequenceStepCreateResponse.ts +98 -0
- package/src/models/SfvbSequenceStepDeleteResponse.ts +91 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1200,6 +1200,9 @@ src/models/SfvbSecretSink.ts
|
|
|
1200
1200
|
src/models/SfvbSequence.ts
|
|
1201
1201
|
src/models/SfvbSequenceBranch.ts
|
|
1202
1202
|
src/models/SfvbSequenceStep.ts
|
|
1203
|
+
src/models/SfvbSequenceStepCreateRequest.ts
|
|
1204
|
+
src/models/SfvbSequenceStepCreateResponse.ts
|
|
1205
|
+
src/models/SfvbSequenceStepDeleteResponse.ts
|
|
1203
1206
|
src/models/SfvbSequenceStepUpdateRequest.ts
|
|
1204
1207
|
src/models/SfvbSequenceStepUpdateResponse.ts
|
|
1205
1208
|
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.217
|
|
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.217 --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.217 | 10/29/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.216 | 10/29/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.215 | 10/28/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.214 | 10/28/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.213 | 10/28/2026 | auto order - improve item field descriptions |
|
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, SfvbSequenceStepDeleteResponse, 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;
|
|
@@ -143,6 +143,13 @@ export interface DeleteSfvbRedirectsRequest {
|
|
|
143
143
|
export interface DeleteSfvbSecretRequestRequest {
|
|
144
144
|
requestId: string;
|
|
145
145
|
}
|
|
146
|
+
export interface DeleteSfvbSequenceStepRequest {
|
|
147
|
+
storefrontOid: number;
|
|
148
|
+
sequenceUuid: string;
|
|
149
|
+
stepUuid: string;
|
|
150
|
+
ifMatch: string;
|
|
151
|
+
approvalId?: string;
|
|
152
|
+
}
|
|
146
153
|
export interface DetachSfvbBlogPostImageRequest {
|
|
147
154
|
storefrontOid: number;
|
|
148
155
|
blogPostOid: number;
|
|
@@ -498,6 +505,12 @@ export interface InsertSfvbRedirectRequest {
|
|
|
498
505
|
export interface InsertSfvbSecretRequestRequest {
|
|
499
506
|
secretRequest: SfvbSecretRequestCreate;
|
|
500
507
|
}
|
|
508
|
+
export interface InsertSfvbSequenceStepRequest {
|
|
509
|
+
storefrontOid: number;
|
|
510
|
+
sequenceUuid: string;
|
|
511
|
+
ifMatch: string;
|
|
512
|
+
sequenceStepCreateRequest: SfvbSequenceStepCreateRequest;
|
|
513
|
+
}
|
|
501
514
|
export interface InsertSfvbUpsellOfferRequest {
|
|
502
515
|
storefrontOid: number;
|
|
503
516
|
upsellOffer: SfvbUpsellOffer;
|
|
@@ -1416,6 +1429,24 @@ export interface SfvbApiInterface {
|
|
|
1416
1429
|
* Cancel a pending secret request
|
|
1417
1430
|
*/
|
|
1418
1431
|
deleteSfvbSecretRequest(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
1432
|
+
/**
|
|
1433
|
+
* Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step\'s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step\'s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
|
|
1434
|
+
* @summary Remove one step
|
|
1435
|
+
* @param {number} storefrontOid
|
|
1436
|
+
* @param {string} sequenceUuid
|
|
1437
|
+
* @param {string} stepUuid
|
|
1438
|
+
* @param {string} ifMatch The step\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1439
|
+
* @param {string} [approvalId] When the sequence is live, the approval_id of an approved sequence_step.delete request for this step. See POST /sfvb/approvals.
|
|
1440
|
+
* @param {*} [options] Override http request option.
|
|
1441
|
+
* @throws {RequiredError}
|
|
1442
|
+
* @memberof SfvbApiInterface
|
|
1443
|
+
*/
|
|
1444
|
+
deleteSfvbSequenceStepRaw(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepDeleteResponse>>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step\'s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step\'s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
|
|
1447
|
+
* Remove one step
|
|
1448
|
+
*/
|
|
1449
|
+
deleteSfvbSequenceStep(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepDeleteResponse>;
|
|
1419
1450
|
/**
|
|
1420
1451
|
* Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
|
|
1421
1452
|
* @summary Detach an image from a blog post
|
|
@@ -2751,6 +2782,23 @@ export interface SfvbApiInterface {
|
|
|
2751
2782
|
* Ask a person to enter secret values
|
|
2752
2783
|
*/
|
|
2753
2784
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
2785
|
+
/**
|
|
2786
|
+
* 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. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. 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.
|
|
2787
|
+
* @summary Add an email step, with its new email
|
|
2788
|
+
* @param {number} storefrontOid
|
|
2789
|
+
* @param {string} sequenceUuid
|
|
2790
|
+
* @param {string} ifMatch The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
|
|
2791
|
+
* @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\'s subject and preview text
|
|
2792
|
+
* @param {*} [options] Override http request option.
|
|
2793
|
+
* @throws {RequiredError}
|
|
2794
|
+
* @memberof SfvbApiInterface
|
|
2795
|
+
*/
|
|
2796
|
+
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
2797
|
+
/**
|
|
2798
|
+
* 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. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. 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.
|
|
2799
|
+
* Add an email step, with its new email
|
|
2800
|
+
*/
|
|
2801
|
+
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
2754
2802
|
/**
|
|
2755
2803
|
* 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
2804
|
* @summary Create an upsell offer
|
|
@@ -4466,6 +4514,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4466
4514
|
* Cancel a pending secret request
|
|
4467
4515
|
*/
|
|
4468
4516
|
deleteSfvbSecretRequest(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
4517
|
+
/**
|
|
4518
|
+
* Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step\'s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step\'s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
|
|
4519
|
+
* Remove one step
|
|
4520
|
+
*/
|
|
4521
|
+
deleteSfvbSequenceStepRaw(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepDeleteResponse>>;
|
|
4522
|
+
/**
|
|
4523
|
+
* Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step\'s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step\'s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
|
|
4524
|
+
* Remove one step
|
|
4525
|
+
*/
|
|
4526
|
+
deleteSfvbSequenceStep(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepDeleteResponse>;
|
|
4469
4527
|
/**
|
|
4470
4528
|
* Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
|
|
4471
4529
|
* Detach an image from a blog post
|
|
@@ -5342,6 +5400,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5342
5400
|
* Ask a person to enter secret values
|
|
5343
5401
|
*/
|
|
5344
5402
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
5403
|
+
/**
|
|
5404
|
+
* 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. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. 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.
|
|
5405
|
+
* Add an email step, with its new email
|
|
5406
|
+
*/
|
|
5407
|
+
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
5408
|
+
/**
|
|
5409
|
+
* 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. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. 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.
|
|
5410
|
+
* Add an email step, with its new email
|
|
5411
|
+
*/
|
|
5412
|
+
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
5345
5413
|
/**
|
|
5346
5414
|
* 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
5415
|
* Create an upsell offer
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -1959,6 +1959,80 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
1959
1959
|
});
|
|
1960
1960
|
});
|
|
1961
1961
|
};
|
|
1962
|
+
/**
|
|
1963
|
+
* Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step\'s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step\'s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
|
|
1964
|
+
* Remove one step
|
|
1965
|
+
*/
|
|
1966
|
+
SfvbApi.prototype.deleteSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
|
|
1967
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1968
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
1969
|
+
return __generator(this, function (_c) {
|
|
1970
|
+
switch (_c.label) {
|
|
1971
|
+
case 0:
|
|
1972
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
1973
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling deleteSfvbSequenceStep.');
|
|
1974
|
+
}
|
|
1975
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
1976
|
+
throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling deleteSfvbSequenceStep.');
|
|
1977
|
+
}
|
|
1978
|
+
if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
|
|
1979
|
+
throw new runtime.RequiredError('stepUuid', 'Required parameter requestParameters.stepUuid was null or undefined when calling deleteSfvbSequenceStep.');
|
|
1980
|
+
}
|
|
1981
|
+
if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
|
|
1982
|
+
throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling deleteSfvbSequenceStep.');
|
|
1983
|
+
}
|
|
1984
|
+
queryParameters = {};
|
|
1985
|
+
headerParameters = {};
|
|
1986
|
+
if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
|
|
1987
|
+
headerParameters['If-Match'] = String(requestParameters.ifMatch);
|
|
1988
|
+
}
|
|
1989
|
+
if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
|
|
1990
|
+
headerParameters['Approval-Id'] = String(requestParameters.approvalId);
|
|
1991
|
+
}
|
|
1992
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
1993
|
+
// oauth required
|
|
1994
|
+
_a = headerParameters;
|
|
1995
|
+
_b = "Authorization";
|
|
1996
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
1997
|
+
case 1:
|
|
1998
|
+
// oauth required
|
|
1999
|
+
_a[_b] = _c.sent();
|
|
2000
|
+
_c.label = 2;
|
|
2001
|
+
case 2:
|
|
2002
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
2003
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
2004
|
+
}
|
|
2005
|
+
return [4 /*yield*/, this.request({
|
|
2006
|
+
path: "/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))).replace("{".concat("step_uuid", "}"), encodeURIComponent(String(requestParameters.stepUuid))),
|
|
2007
|
+
method: 'DELETE',
|
|
2008
|
+
headers: headerParameters,
|
|
2009
|
+
query: queryParameters,
|
|
2010
|
+
}, initOverrides)];
|
|
2011
|
+
case 3:
|
|
2012
|
+
response = _c.sent();
|
|
2013
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSequenceStepDeleteResponseFromJSON)(jsonValue); })];
|
|
2014
|
+
}
|
|
2015
|
+
});
|
|
2016
|
+
});
|
|
2017
|
+
};
|
|
2018
|
+
/**
|
|
2019
|
+
* Removes the step from its list and links the step before it to the step after it, in one transaction. An email, experiment or postcard step\'s email or postcard is archived with it. Refused while any customer is waiting on the step, for the begin, end, continue and merge markers, for a condition, split or inboxgeek step with steps on a side, and for a step whose email a resend step re-sends. Send the step\'s hash_sha256 as If-Match. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.delete approval (Approval-Id); a draft or inactive one needs neither. An email or postcard another step still uses is left as it is.
|
|
2020
|
+
* Remove one step
|
|
2021
|
+
*/
|
|
2022
|
+
SfvbApi.prototype.deleteSfvbSequenceStep = function (requestParameters, initOverrides) {
|
|
2023
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
2024
|
+
var response;
|
|
2025
|
+
return __generator(this, function (_a) {
|
|
2026
|
+
switch (_a.label) {
|
|
2027
|
+
case 0: return [4 /*yield*/, this.deleteSfvbSequenceStepRaw(requestParameters, initOverrides)];
|
|
2028
|
+
case 1:
|
|
2029
|
+
response = _a.sent();
|
|
2030
|
+
return [4 /*yield*/, response.value()];
|
|
2031
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
2032
|
+
}
|
|
2033
|
+
});
|
|
2034
|
+
});
|
|
2035
|
+
};
|
|
1962
2036
|
/**
|
|
1963
2037
|
* Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
|
|
1964
2038
|
* Detach an image from a blog post
|
|
@@ -7507,6 +7581,79 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
7507
7581
|
});
|
|
7508
7582
|
});
|
|
7509
7583
|
};
|
|
7584
|
+
/**
|
|
7585
|
+
* 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. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. 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.
|
|
7586
|
+
* Add an email step, with its new email
|
|
7587
|
+
*/
|
|
7588
|
+
SfvbApi.prototype.insertSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
|
|
7589
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
7590
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
7591
|
+
return __generator(this, function (_c) {
|
|
7592
|
+
switch (_c.label) {
|
|
7593
|
+
case 0:
|
|
7594
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
7595
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling insertSfvbSequenceStep.');
|
|
7596
|
+
}
|
|
7597
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
7598
|
+
throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling insertSfvbSequenceStep.');
|
|
7599
|
+
}
|
|
7600
|
+
if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
|
|
7601
|
+
throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling insertSfvbSequenceStep.');
|
|
7602
|
+
}
|
|
7603
|
+
if (requestParameters.sequenceStepCreateRequest === null || requestParameters.sequenceStepCreateRequest === undefined) {
|
|
7604
|
+
throw new runtime.RequiredError('sequenceStepCreateRequest', 'Required parameter requestParameters.sequenceStepCreateRequest was null or undefined when calling insertSfvbSequenceStep.');
|
|
7605
|
+
}
|
|
7606
|
+
queryParameters = {};
|
|
7607
|
+
headerParameters = {};
|
|
7608
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
7609
|
+
if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
|
|
7610
|
+
headerParameters['If-Match'] = String(requestParameters.ifMatch);
|
|
7611
|
+
}
|
|
7612
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
7613
|
+
// oauth required
|
|
7614
|
+
_a = headerParameters;
|
|
7615
|
+
_b = "Authorization";
|
|
7616
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
7617
|
+
case 1:
|
|
7618
|
+
// oauth required
|
|
7619
|
+
_a[_b] = _c.sent();
|
|
7620
|
+
_c.label = 2;
|
|
7621
|
+
case 2:
|
|
7622
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
7623
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
7624
|
+
}
|
|
7625
|
+
return [4 /*yield*/, this.request({
|
|
7626
|
+
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))),
|
|
7627
|
+
method: 'POST',
|
|
7628
|
+
headers: headerParameters,
|
|
7629
|
+
query: queryParameters,
|
|
7630
|
+
body: (0, models_1.SfvbSequenceStepCreateRequestToJSON)(requestParameters.sequenceStepCreateRequest),
|
|
7631
|
+
}, initOverrides)];
|
|
7632
|
+
case 3:
|
|
7633
|
+
response = _c.sent();
|
|
7634
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSequenceStepCreateResponseFromJSON)(jsonValue); })];
|
|
7635
|
+
}
|
|
7636
|
+
});
|
|
7637
|
+
});
|
|
7638
|
+
};
|
|
7639
|
+
/**
|
|
7640
|
+
* 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. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. 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.
|
|
7641
|
+
* Add an email step, with its new email
|
|
7642
|
+
*/
|
|
7643
|
+
SfvbApi.prototype.insertSfvbSequenceStep = function (requestParameters, initOverrides) {
|
|
7644
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
7645
|
+
var response;
|
|
7646
|
+
return __generator(this, function (_a) {
|
|
7647
|
+
switch (_a.label) {
|
|
7648
|
+
case 0: return [4 /*yield*/, this.insertSfvbSequenceStepRaw(requestParameters, initOverrides)];
|
|
7649
|
+
case 1:
|
|
7650
|
+
response = _a.sent();
|
|
7651
|
+
return [4 /*yield*/, response.value()];
|
|
7652
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
7653
|
+
}
|
|
7654
|
+
});
|
|
7655
|
+
});
|
|
7656
|
+
};
|
|
7510
7657
|
/**
|
|
7511
7658
|
* 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
7659
|
* 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";
|
|
@@ -82,6 +82,9 @@ export declare const SfvbApprovalCreateRequestActionEnum: {
|
|
|
82
82
|
readonly UpsellEnable: "upsell.enable";
|
|
83
83
|
readonly ItemAttributeBatch: "item.attribute_batch";
|
|
84
84
|
readonly ItemPricing: "item.pricing";
|
|
85
|
+
readonly TwilioAccountDelete: "twilio_account.delete";
|
|
86
|
+
readonly SendingDomainDelete: "sending_domain.delete";
|
|
87
|
+
readonly SequenceStepDelete: "sequence_step.delete";
|
|
85
88
|
};
|
|
86
89
|
export type SfvbApprovalCreateRequestActionEnum = typeof SfvbApprovalCreateRequestActionEnum[keyof typeof SfvbApprovalCreateRequestActionEnum];
|
|
87
90
|
/**
|
|
@@ -32,7 +32,10 @@ exports.SfvbApprovalCreateRequestActionEnum = {
|
|
|
32
32
|
ExperimentEnd: 'experiment.end',
|
|
33
33
|
UpsellEnable: 'upsell.enable',
|
|
34
34
|
ItemAttributeBatch: 'item.attribute_batch',
|
|
35
|
-
ItemPricing: 'item.pricing'
|
|
35
|
+
ItemPricing: 'item.pricing',
|
|
36
|
+
TwilioAccountDelete: 'twilio_account.delete',
|
|
37
|
+
SendingDomainDelete: 'sending_domain.delete',
|
|
38
|
+
SequenceStepDelete: 'sequence_step.delete'
|
|
36
39
|
};
|
|
37
40
|
/**
|
|
38
41
|
* Check if a given object implements the SfvbApprovalCreateRequest interface.
|
|
@@ -87,12 +87,24 @@ export interface SfvbApprovalParams {
|
|
|
87
87
|
* @memberof SfvbApprovalParams
|
|
88
88
|
*/
|
|
89
89
|
rule_count?: number;
|
|
90
|
+
/**
|
|
91
|
+
* The communication sequence, for sequence_step.delete.
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof SfvbApprovalParams
|
|
94
|
+
*/
|
|
95
|
+
sequence_uuid?: string;
|
|
90
96
|
/**
|
|
91
97
|
* For experiment.start of a page experiment, the page body name. Defaults to body.
|
|
92
98
|
* @type {string}
|
|
93
99
|
* @memberof SfvbApprovalParams
|
|
94
100
|
*/
|
|
95
101
|
slot?: string;
|
|
102
|
+
/**
|
|
103
|
+
* The step to remove, for sequence_step.delete.
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof SfvbApprovalParams
|
|
106
|
+
*/
|
|
107
|
+
step_uuid?: string;
|
|
96
108
|
/**
|
|
97
109
|
* For upsell.enable, what to switch on.
|
|
98
110
|
* @type {string}
|
|
@@ -51,7 +51,9 @@ function SfvbApprovalParamsFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
51
51
|
'request_sha256': !(0, runtime_1.exists)(json, 'request_sha256') ? undefined : json['request_sha256'],
|
|
52
52
|
'rows_sha256': !(0, runtime_1.exists)(json, 'rows_sha256') ? undefined : json['rows_sha256'],
|
|
53
53
|
'rule_count': !(0, runtime_1.exists)(json, 'rule_count') ? undefined : json['rule_count'],
|
|
54
|
+
'sequence_uuid': !(0, runtime_1.exists)(json, 'sequence_uuid') ? undefined : json['sequence_uuid'],
|
|
54
55
|
'slot': !(0, runtime_1.exists)(json, 'slot') ? undefined : json['slot'],
|
|
56
|
+
'step_uuid': !(0, runtime_1.exists)(json, 'step_uuid') ? undefined : json['step_uuid'],
|
|
55
57
|
'upsell_kind': !(0, runtime_1.exists)(json, 'upsell_kind') ? undefined : json['upsell_kind'],
|
|
56
58
|
'upsell_oid': !(0, runtime_1.exists)(json, 'upsell_oid') ? undefined : json['upsell_oid'],
|
|
57
59
|
'version': !(0, runtime_1.exists)(json, 'version') ? undefined : json['version'],
|
|
@@ -80,7 +82,9 @@ function SfvbApprovalParamsToJSON(value) {
|
|
|
80
82
|
'request_sha256': value.request_sha256,
|
|
81
83
|
'rows_sha256': value.rows_sha256,
|
|
82
84
|
'rule_count': value.rule_count,
|
|
85
|
+
'sequence_uuid': value.sequence_uuid,
|
|
83
86
|
'slot': value.slot,
|
|
87
|
+
'step_uuid': value.step_uuid,
|
|
84
88
|
'upsell_kind': value.upsell_kind,
|
|
85
89
|
'upsell_oid': value.upsell_oid,
|
|
86
90
|
'version': value.version,
|
|
@@ -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;
|