ultracart_rest_api_v2_typescript 4.1.216 → 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.
@@ -1202,6 +1202,7 @@ src/models/SfvbSequenceBranch.ts
1202
1202
  src/models/SfvbSequenceStep.ts
1203
1203
  src/models/SfvbSequenceStepCreateRequest.ts
1204
1204
  src/models/SfvbSequenceStepCreateResponse.ts
1205
+ src/models/SfvbSequenceStepDeleteResponse.ts
1205
1206
  src/models/SfvbSequenceStepUpdateRequest.ts
1206
1207
  src/models/SfvbSequenceStepUpdateResponse.ts
1207
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.216
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.216 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.217 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,7 @@ 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 |
87
88
  | 4.1.216 | 10/29/2026 | sfvb internal testing |
88
89
  | 4.1.215 | 10/28/2026 | sfvb internal testing |
89
90
  | 4.1.214 | 10/28/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { 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';
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;
@@ -1422,6 +1429,24 @@ export interface SfvbApiInterface {
1422
1429
  * Cancel a pending secret request
1423
1430
  */
1424
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\&#39;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>;
1425
1450
  /**
1426
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.
1427
1452
  * @summary Detach an image from a blog post
@@ -2758,11 +2783,11 @@ export interface SfvbApiInterface {
2758
2783
  */
2759
2784
  insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
2760
2785
  /**
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.
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.
2762
2787
  * @summary Add an email step, with its new email
2763
2788
  * @param {number} storefrontOid
2764
2789
  * @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.
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.
2766
2791
  * @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\&#39;s subject and preview text
2767
2792
  * @param {*} [options] Override http request option.
2768
2793
  * @throws {RequiredError}
@@ -2770,7 +2795,7 @@ export interface SfvbApiInterface {
2770
2795
  */
2771
2796
  insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
2772
2797
  /**
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.
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.
2774
2799
  * Add an email step, with its new email
2775
2800
  */
2776
2801
  insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
@@ -4489,6 +4514,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4489
4514
  * Cancel a pending secret request
4490
4515
  */
4491
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>;
4492
4527
  /**
4493
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.
4494
4529
  * Detach an image from a blog post
@@ -5366,12 +5401,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5366
5401
  */
5367
5402
  insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
5368
5403
  /**
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.
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.
5370
5405
  * Add an email step, with its new email
5371
5406
  */
5372
5407
  insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
5373
5408
  /**
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.
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.
5375
5410
  * Add an email step, with its new email
5376
5411
  */
5377
5412
  insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
@@ -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
@@ -7508,7 +7582,7 @@ var SfvbApi = /** @class */ (function (_super) {
7508
7582
  });
7509
7583
  };
7510
7584
  /**
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.
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.
7512
7586
  * Add an email step, with its new email
7513
7587
  */
7514
7588
  SfvbApi.prototype.insertSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
@@ -7563,7 +7637,7 @@ var SfvbApi = /** @class */ (function (_super) {
7563
7637
  });
7564
7638
  };
7565
7639
  /**
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.
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.
7567
7641
  * Add an email step, with its new email
7568
7642
  */
7569
7643
  SfvbApi.prototype.insertSfvbSequenceStep = function (requestParameters, initOverrides) {
@@ -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,49 @@
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 SfvbSequenceStepDeleteResponse
16
+ */
17
+ export interface SfvbSequenceStepDeleteResponse {
18
+ /**
19
+ * The emails the step sent, now archived.
20
+ * @type {Array<string>}
21
+ * @memberof SfvbSequenceStepDeleteResponse
22
+ */
23
+ archived_email_uuids?: Array<string>;
24
+ /**
25
+ * The postcard the step sent, now archived.
26
+ * @type {Array<string>}
27
+ * @memberof SfvbSequenceStepDeleteResponse
28
+ */
29
+ archived_postcard_uuids?: Array<string>;
30
+ /**
31
+ * What was removed and archived, in words.
32
+ * @type {Array<string>}
33
+ * @memberof SfvbSequenceStepDeleteResponse
34
+ */
35
+ notes?: Array<string>;
36
+ /**
37
+ * The step removed, then any end, continue or merge markers that were on its sides.
38
+ * @type {Array<string>}
39
+ * @memberof SfvbSequenceStepDeleteResponse
40
+ */
41
+ removed_step_uuids?: Array<string>;
42
+ }
43
+ /**
44
+ * Check if a given object implements the SfvbSequenceStepDeleteResponse interface.
45
+ */
46
+ export declare function instanceOfSfvbSequenceStepDeleteResponse(value: object): boolean;
47
+ export declare function SfvbSequenceStepDeleteResponseFromJSON(json: any): SfvbSequenceStepDeleteResponse;
48
+ export declare function SfvbSequenceStepDeleteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepDeleteResponse;
49
+ export declare function SfvbSequenceStepDeleteResponseToJSON(value?: SfvbSequenceStepDeleteResponse | null): any;
@@ -0,0 +1,56 @@
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.SfvbSequenceStepDeleteResponseToJSON = exports.SfvbSequenceStepDeleteResponseFromJSONTyped = exports.SfvbSequenceStepDeleteResponseFromJSON = exports.instanceOfSfvbSequenceStepDeleteResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbSequenceStepDeleteResponse interface.
20
+ */
21
+ function instanceOfSfvbSequenceStepDeleteResponse(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbSequenceStepDeleteResponse = instanceOfSfvbSequenceStepDeleteResponse;
26
+ function SfvbSequenceStepDeleteResponseFromJSON(json) {
27
+ return SfvbSequenceStepDeleteResponseFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbSequenceStepDeleteResponseFromJSON = SfvbSequenceStepDeleteResponseFromJSON;
30
+ function SfvbSequenceStepDeleteResponseFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'archived_email_uuids': !(0, runtime_1.exists)(json, 'archived_email_uuids') ? undefined : json['archived_email_uuids'],
36
+ 'archived_postcard_uuids': !(0, runtime_1.exists)(json, 'archived_postcard_uuids') ? undefined : json['archived_postcard_uuids'],
37
+ 'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
38
+ 'removed_step_uuids': !(0, runtime_1.exists)(json, 'removed_step_uuids') ? undefined : json['removed_step_uuids'],
39
+ };
40
+ }
41
+ exports.SfvbSequenceStepDeleteResponseFromJSONTyped = SfvbSequenceStepDeleteResponseFromJSONTyped;
42
+ function SfvbSequenceStepDeleteResponseToJSON(value) {
43
+ if (value === undefined) {
44
+ return undefined;
45
+ }
46
+ if (value === null) {
47
+ return null;
48
+ }
49
+ return {
50
+ 'archived_email_uuids': value.archived_email_uuids,
51
+ 'archived_postcard_uuids': value.archived_postcard_uuids,
52
+ 'notes': value.notes,
53
+ 'removed_step_uuids': value.removed_step_uuids,
54
+ };
55
+ }
56
+ exports.SfvbSequenceStepDeleteResponseToJSON = SfvbSequenceStepDeleteResponseToJSON;
@@ -1172,6 +1172,7 @@ export * from './SfvbSequenceBranch';
1172
1172
  export * from './SfvbSequenceStep';
1173
1173
  export * from './SfvbSequenceStepCreateRequest';
1174
1174
  export * from './SfvbSequenceStepCreateResponse';
1175
+ export * from './SfvbSequenceStepDeleteResponse';
1175
1176
  export * from './SfvbSequenceStepUpdateRequest';
1176
1177
  export * from './SfvbSequenceStepUpdateResponse';
1177
1178
  export * from './SfvbServerLog';
@@ -1190,6 +1190,7 @@ __exportStar(require("./SfvbSequenceBranch"), exports);
1190
1190
  __exportStar(require("./SfvbSequenceStep"), exports);
1191
1191
  __exportStar(require("./SfvbSequenceStepCreateRequest"), exports);
1192
1192
  __exportStar(require("./SfvbSequenceStepCreateResponse"), exports);
1193
+ __exportStar(require("./SfvbSequenceStepDeleteResponse"), exports);
1193
1194
  __exportStar(require("./SfvbSequenceStepUpdateRequest"), exports);
1194
1195
  __exportStar(require("./SfvbSequenceStepUpdateResponse"), exports);
1195
1196
  __exportStar(require("./SfvbServerLog"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.216",
3
+ "version": "4.1.217",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -438,6 +438,9 @@ import {
438
438
  SfvbSequenceStepCreateResponse,
439
439
  SfvbSequenceStepCreateResponseFromJSON,
440
440
  SfvbSequenceStepCreateResponseToJSON,
441
+ SfvbSequenceStepDeleteResponse,
442
+ SfvbSequenceStepDeleteResponseFromJSON,
443
+ SfvbSequenceStepDeleteResponseToJSON,
441
444
  SfvbSequenceStepUpdateRequest,
442
445
  SfvbSequenceStepUpdateRequestFromJSON,
443
446
  SfvbSequenceStepUpdateRequestToJSON,
@@ -688,6 +691,14 @@ export interface DeleteSfvbSecretRequestRequest {
688
691
  requestId: string;
689
692
  }
690
693
 
694
+ export interface DeleteSfvbSequenceStepRequest {
695
+ storefrontOid: number;
696
+ sequenceUuid: string;
697
+ stepUuid: string;
698
+ ifMatch: string;
699
+ approvalId?: string;
700
+ }
701
+
691
702
  export interface DetachSfvbBlogPostImageRequest {
692
703
  storefrontOid: number;
693
704
  blogPostOid: number;
@@ -2192,6 +2203,26 @@ export interface SfvbApiInterface {
2192
2203
  */
2193
2204
  deleteSfvbSecretRequest(requestParameters: DeleteSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
2194
2205
 
2206
+ /**
2207
+ * 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.
2208
+ * @summary Remove one step
2209
+ * @param {number} storefrontOid
2210
+ * @param {string} sequenceUuid
2211
+ * @param {string} stepUuid
2212
+ * @param {string} ifMatch The step\&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
2213
+ * @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.
2214
+ * @param {*} [options] Override http request option.
2215
+ * @throws {RequiredError}
2216
+ * @memberof SfvbApiInterface
2217
+ */
2218
+ deleteSfvbSequenceStepRaw(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepDeleteResponse>>;
2219
+
2220
+ /**
2221
+ * 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.
2222
+ * Remove one step
2223
+ */
2224
+ deleteSfvbSequenceStep(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepDeleteResponse>;
2225
+
2195
2226
  /**
2196
2227
  * 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.
2197
2228
  * @summary Detach an image from a blog post
@@ -3704,11 +3735,11 @@ export interface SfvbApiInterface {
3704
3735
  insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
3705
3736
 
3706
3737
  /**
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.
3738
+ * 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.
3708
3739
  * @summary Add an email step, with its new email
3709
3740
  * @param {number} storefrontOid
3710
3741
  * @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.
3742
+ * @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.
3712
3743
  * @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\&#39;s subject and preview text
3713
3744
  * @param {*} [options] Override http request option.
3714
3745
  * @throws {RequiredError}
@@ -3717,7 +3748,7 @@ export interface SfvbApiInterface {
3717
3748
  insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
3718
3749
 
3719
3750
  /**
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.
3751
+ * 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.
3721
3752
  * Add an email step, with its new email
3722
3753
  */
3723
3754
  insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
@@ -6757,6 +6788,67 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
6757
6788
  return await response.value();
6758
6789
  }
6759
6790
 
6791
+ /**
6792
+ * 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.
6793
+ * Remove one step
6794
+ */
6795
+ async deleteSfvbSequenceStepRaw(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepDeleteResponse>> {
6796
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
6797
+ throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling deleteSfvbSequenceStep.');
6798
+ }
6799
+
6800
+ if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
6801
+ throw new runtime.RequiredError('sequenceUuid','Required parameter requestParameters.sequenceUuid was null or undefined when calling deleteSfvbSequenceStep.');
6802
+ }
6803
+
6804
+ if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
6805
+ throw new runtime.RequiredError('stepUuid','Required parameter requestParameters.stepUuid was null or undefined when calling deleteSfvbSequenceStep.');
6806
+ }
6807
+
6808
+ if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
6809
+ throw new runtime.RequiredError('ifMatch','Required parameter requestParameters.ifMatch was null or undefined when calling deleteSfvbSequenceStep.');
6810
+ }
6811
+
6812
+ const queryParameters: any = {};
6813
+
6814
+ const headerParameters: runtime.HTTPHeaders = {};
6815
+
6816
+ if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
6817
+ headerParameters['If-Match'] = String(requestParameters.ifMatch);
6818
+ }
6819
+
6820
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
6821
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
6822
+ }
6823
+
6824
+ if (this.configuration && this.configuration.accessToken) {
6825
+ // oauth required
6826
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
6827
+ }
6828
+
6829
+ if (this.configuration && this.configuration.apiKey) {
6830
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
6831
+ }
6832
+
6833
+ const response = await this.request({
6834
+ path: `/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"sequence_uuid"}}`, encodeURIComponent(String(requestParameters.sequenceUuid))).replace(`{${"step_uuid"}}`, encodeURIComponent(String(requestParameters.stepUuid))),
6835
+ method: 'DELETE',
6836
+ headers: headerParameters,
6837
+ query: queryParameters,
6838
+ }, initOverrides);
6839
+
6840
+ return new runtime.JSONApiResponse(response, (jsonValue) => SfvbSequenceStepDeleteResponseFromJSON(jsonValue));
6841
+ }
6842
+
6843
+ /**
6844
+ * 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.
6845
+ * Remove one step
6846
+ */
6847
+ async deleteSfvbSequenceStep(requestParameters: DeleteSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepDeleteResponse> {
6848
+ const response = await this.deleteSfvbSequenceStepRaw(requestParameters, initOverrides);
6849
+ return await response.value();
6850
+ }
6851
+
6760
6852
  /**
6761
6853
  * 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.
6762
6854
  * Detach an image from a blog post
@@ -10849,7 +10941,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
10849
10941
  }
10850
10942
 
10851
10943
  /**
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.
10944
+ * 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.
10853
10945
  * Add an email step, with its new email
10854
10946
  */
10855
10947
  async insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>> {
@@ -10900,7 +10992,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
10900
10992
  }
10901
10993
 
10902
10994
  /**
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.
10995
+ * 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.
10904
10996
  * Add an email step, with its new email
10905
10997
  */
10906
10998
  async insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse> {
@@ -114,7 +114,10 @@ export const SfvbApprovalCreateRequestActionEnum = {
114
114
  ExperimentEnd: 'experiment.end',
115
115
  UpsellEnable: 'upsell.enable',
116
116
  ItemAttributeBatch: 'item.attribute_batch',
117
- ItemPricing: 'item.pricing'
117
+ ItemPricing: 'item.pricing',
118
+ TwilioAccountDelete: 'twilio_account.delete',
119
+ SendingDomainDelete: 'sending_domain.delete',
120
+ SequenceStepDelete: 'sequence_step.delete'
118
121
  } as const;
119
122
  export type SfvbApprovalCreateRequestActionEnum = typeof SfvbApprovalCreateRequestActionEnum[keyof typeof SfvbApprovalCreateRequestActionEnum];
120
123
 
@@ -91,12 +91,24 @@ export interface SfvbApprovalParams {
91
91
  * @memberof SfvbApprovalParams
92
92
  */
93
93
  rule_count?: number;
94
+ /**
95
+ * The communication sequence, for sequence_step.delete.
96
+ * @type {string}
97
+ * @memberof SfvbApprovalParams
98
+ */
99
+ sequence_uuid?: string;
94
100
  /**
95
101
  * For experiment.start of a page experiment, the page body name. Defaults to body.
96
102
  * @type {string}
97
103
  * @memberof SfvbApprovalParams
98
104
  */
99
105
  slot?: string;
106
+ /**
107
+ * The step to remove, for sequence_step.delete.
108
+ * @type {string}
109
+ * @memberof SfvbApprovalParams
110
+ */
111
+ step_uuid?: string;
100
112
  /**
101
113
  * For upsell.enable, what to switch on.
102
114
  * @type {string}
@@ -172,7 +184,9 @@ export function SfvbApprovalParamsFromJSONTyped(json: any, ignoreDiscriminator:
172
184
  'request_sha256': !exists(json, 'request_sha256') ? undefined : json['request_sha256'],
173
185
  'rows_sha256': !exists(json, 'rows_sha256') ? undefined : json['rows_sha256'],
174
186
  'rule_count': !exists(json, 'rule_count') ? undefined : json['rule_count'],
187
+ 'sequence_uuid': !exists(json, 'sequence_uuid') ? undefined : json['sequence_uuid'],
175
188
  'slot': !exists(json, 'slot') ? undefined : json['slot'],
189
+ 'step_uuid': !exists(json, 'step_uuid') ? undefined : json['step_uuid'],
176
190
  'upsell_kind': !exists(json, 'upsell_kind') ? undefined : json['upsell_kind'],
177
191
  'upsell_oid': !exists(json, 'upsell_oid') ? undefined : json['upsell_oid'],
178
192
  'version': !exists(json, 'version') ? undefined : json['version'],
@@ -202,7 +216,9 @@ export function SfvbApprovalParamsToJSON(value?: SfvbApprovalParams | null): any
202
216
  'request_sha256': value.request_sha256,
203
217
  'rows_sha256': value.rows_sha256,
204
218
  'rule_count': value.rule_count,
219
+ 'sequence_uuid': value.sequence_uuid,
205
220
  'slot': value.slot,
221
+ 'step_uuid': value.step_uuid,
206
222
  'upsell_kind': value.upsell_kind,
207
223
  'upsell_oid': value.upsell_oid,
208
224
  'version': value.version,
@@ -0,0 +1,91 @@
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 SfvbSequenceStepDeleteResponse
20
+ */
21
+ export interface SfvbSequenceStepDeleteResponse {
22
+ /**
23
+ * The emails the step sent, now archived.
24
+ * @type {Array<string>}
25
+ * @memberof SfvbSequenceStepDeleteResponse
26
+ */
27
+ archived_email_uuids?: Array<string>;
28
+ /**
29
+ * The postcard the step sent, now archived.
30
+ * @type {Array<string>}
31
+ * @memberof SfvbSequenceStepDeleteResponse
32
+ */
33
+ archived_postcard_uuids?: Array<string>;
34
+ /**
35
+ * What was removed and archived, in words.
36
+ * @type {Array<string>}
37
+ * @memberof SfvbSequenceStepDeleteResponse
38
+ */
39
+ notes?: Array<string>;
40
+ /**
41
+ * The step removed, then any end, continue or merge markers that were on its sides.
42
+ * @type {Array<string>}
43
+ * @memberof SfvbSequenceStepDeleteResponse
44
+ */
45
+ removed_step_uuids?: Array<string>;
46
+ }
47
+
48
+
49
+
50
+ /**
51
+ * Check if a given object implements the SfvbSequenceStepDeleteResponse interface.
52
+ */
53
+ export function instanceOfSfvbSequenceStepDeleteResponse(value: object): boolean {
54
+ let isInstance = true;
55
+
56
+ return isInstance;
57
+ }
58
+
59
+ export function SfvbSequenceStepDeleteResponseFromJSON(json: any): SfvbSequenceStepDeleteResponse {
60
+ return SfvbSequenceStepDeleteResponseFromJSONTyped(json, false);
61
+ }
62
+
63
+ export function SfvbSequenceStepDeleteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepDeleteResponse {
64
+ if ((json === undefined) || (json === null)) {
65
+ return json;
66
+ }
67
+ return {
68
+
69
+ 'archived_email_uuids': !exists(json, 'archived_email_uuids') ? undefined : json['archived_email_uuids'],
70
+ 'archived_postcard_uuids': !exists(json, 'archived_postcard_uuids') ? undefined : json['archived_postcard_uuids'],
71
+ 'notes': !exists(json, 'notes') ? undefined : json['notes'],
72
+ 'removed_step_uuids': !exists(json, 'removed_step_uuids') ? undefined : json['removed_step_uuids'],
73
+ };
74
+ }
75
+
76
+ export function SfvbSequenceStepDeleteResponseToJSON(value?: SfvbSequenceStepDeleteResponse | null): any {
77
+ if (value === undefined) {
78
+ return undefined;
79
+ }
80
+ if (value === null) {
81
+ return null;
82
+ }
83
+ return {
84
+
85
+ 'archived_email_uuids': value.archived_email_uuids,
86
+ 'archived_postcard_uuids': value.archived_postcard_uuids,
87
+ 'notes': value.notes,
88
+ 'removed_step_uuids': value.removed_step_uuids,
89
+ };
90
+ }
91
+
@@ -1174,6 +1174,7 @@ export * from './SfvbSequenceBranch';
1174
1174
  export * from './SfvbSequenceStep';
1175
1175
  export * from './SfvbSequenceStepCreateRequest';
1176
1176
  export * from './SfvbSequenceStepCreateResponse';
1177
+ export * from './SfvbSequenceStepDeleteResponse';
1177
1178
  export * from './SfvbSequenceStepUpdateRequest';
1178
1179
  export * from './SfvbSequenceStepUpdateResponse';
1179
1180
  export * from './SfvbServerLog';