ultracart_rest_api_v2_typescript 4.1.212 → 4.1.214
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 +2 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +44 -9
- package/dist/apis/SfvbApi.js +80 -4
- package/dist/models/AutoOrderItem.d.ts +3 -3
- package/dist/models/SfvbSequenceStep.d.ts +6 -0
- package/dist/models/SfvbSequenceStep.js +2 -0
- package/dist/models/SfvbSequenceStepUpdateRequest.d.ts +37 -0
- package/dist/models/SfvbSequenceStepUpdateRequest.js +52 -0
- package/dist/models/SfvbSequenceStepUpdateResponse.d.ts +38 -0
- package/dist/models/SfvbSequenceStepUpdateResponse.js +53 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +106 -8
- package/src/models/AutoOrderItem.ts +3 -3
- package/src/models/SfvbSequenceStep.ts +8 -0
- package/src/models/SfvbSequenceStepUpdateRequest.ts +75 -0
- package/src/models/SfvbSequenceStepUpdateResponse.ts +82 -0
- package/src/models/index.ts +2 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1199,6 +1199,8 @@ src/models/SfvbSecretSink.ts
|
|
|
1199
1199
|
src/models/SfvbSequence.ts
|
|
1200
1200
|
src/models/SfvbSequenceBranch.ts
|
|
1201
1201
|
src/models/SfvbSequenceStep.ts
|
|
1202
|
+
src/models/SfvbSequenceStepUpdateRequest.ts
|
|
1203
|
+
src/models/SfvbSequenceStepUpdateResponse.ts
|
|
1202
1204
|
src/models/SfvbServerLog.ts
|
|
1203
1205
|
src/models/SfvbServerLogDetail.ts
|
|
1204
1206
|
src/models/SfvbServerLogEntry.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.214
|
|
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.214 --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.214 | 10/28/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.213 | 10/28/2026 | auto order - improve item field descriptions |
|
|
87
89
|
| 4.1.212 | 10/27/2026 | conversation - pbx agent startup activity |
|
|
88
90
|
| 4.1.211 | 10/27/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.210 | 10/27/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { 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, 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, 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;
|
|
@@ -926,6 +926,13 @@ export interface UpdateSfvbRedirectRequest {
|
|
|
926
926
|
ifMatch: string;
|
|
927
927
|
redirectRequest: SfvbRedirectRequest;
|
|
928
928
|
}
|
|
929
|
+
export interface UpdateSfvbSequenceStepRequest {
|
|
930
|
+
storefrontOid: number;
|
|
931
|
+
sequenceUuid: string;
|
|
932
|
+
stepUuid: string;
|
|
933
|
+
ifMatch: string;
|
|
934
|
+
sequenceStepUpdateRequest: SfvbSequenceStepUpdateRequest;
|
|
935
|
+
}
|
|
929
936
|
export interface UpdateSfvbUpsellOfferRequest {
|
|
930
937
|
storefrontOid: number;
|
|
931
938
|
upsellOfferOid: number;
|
|
@@ -2428,7 +2435,7 @@ export interface SfvbApiInterface {
|
|
|
2428
2435
|
*/
|
|
2429
2436
|
getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
|
|
2430
2437
|
/**
|
|
2431
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
2438
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
2432
2439
|
* @summary Get a campaign\'s or flow\'s steps as a tree
|
|
2433
2440
|
* @param {number} storefrontOid
|
|
2434
2441
|
* @param {string} sequenceUuid
|
|
@@ -2439,7 +2446,7 @@ export interface SfvbApiInterface {
|
|
|
2439
2446
|
*/
|
|
2440
2447
|
getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
|
|
2441
2448
|
/**
|
|
2442
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
2449
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
2443
2450
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
2444
2451
|
*/
|
|
2445
2452
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
@@ -3715,7 +3722,7 @@ export interface SfvbApiInterface {
|
|
|
3715
3722
|
*/
|
|
3716
3723
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
3717
3724
|
/**
|
|
3718
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
3725
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
3719
3726
|
* @summary Request a content review of a flow or campaign email
|
|
3720
3727
|
* @param {number} storefrontOid
|
|
3721
3728
|
* @param {string} emailUuid
|
|
@@ -3726,7 +3733,7 @@ export interface SfvbApiInterface {
|
|
|
3726
3733
|
*/
|
|
3727
3734
|
reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
3728
3735
|
/**
|
|
3729
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
3736
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
3730
3737
|
* Request a content review of a flow or campaign email
|
|
3731
3738
|
*/
|
|
3732
3739
|
reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
@@ -4066,6 +4073,24 @@ export interface SfvbApiInterface {
|
|
|
4066
4073
|
* Change a redirect rule
|
|
4067
4074
|
*/
|
|
4068
4075
|
updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
4076
|
+
/**
|
|
4077
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
4078
|
+
* @summary Change one step\'s settings or audience filter
|
|
4079
|
+
* @param {number} storefrontOid
|
|
4080
|
+
* @param {string} sequenceUuid
|
|
4081
|
+
* @param {string} stepUuid
|
|
4082
|
+
* @param {string} ifMatch The step\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
4083
|
+
* @param {SfvbSequenceStepUpdateRequest} sequenceStepUpdateRequest The settings, the filter, or both
|
|
4084
|
+
* @param {*} [options] Override http request option.
|
|
4085
|
+
* @throws {RequiredError}
|
|
4086
|
+
* @memberof SfvbApiInterface
|
|
4087
|
+
*/
|
|
4088
|
+
updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
|
|
4089
|
+
/**
|
|
4090
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
4091
|
+
* Change one step\'s settings or audience filter
|
|
4092
|
+
*/
|
|
4093
|
+
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|
|
4069
4094
|
/**
|
|
4070
4095
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
4071
4096
|
* @summary Update an upsell offer
|
|
@@ -5110,12 +5135,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5110
5135
|
*/
|
|
5111
5136
|
getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
|
|
5112
5137
|
/**
|
|
5113
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
5138
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
5114
5139
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
5115
5140
|
*/
|
|
5116
5141
|
getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
|
|
5117
5142
|
/**
|
|
5118
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
5143
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
5119
5144
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
5120
5145
|
*/
|
|
5121
5146
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
@@ -5906,12 +5931,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5906
5931
|
*/
|
|
5907
5932
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
5908
5933
|
/**
|
|
5909
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
5934
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
5910
5935
|
* Request a content review of a flow or campaign email
|
|
5911
5936
|
*/
|
|
5912
5937
|
reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
5913
5938
|
/**
|
|
5914
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
5939
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
5915
5940
|
* Request a content review of a flow or campaign email
|
|
5916
5941
|
*/
|
|
5917
5942
|
reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
@@ -6125,6 +6150,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6125
6150
|
* Change a redirect rule
|
|
6126
6151
|
*/
|
|
6127
6152
|
updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
6153
|
+
/**
|
|
6154
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
6155
|
+
* Change one step\'s settings or audience filter
|
|
6156
|
+
*/
|
|
6157
|
+
updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
|
|
6158
|
+
/**
|
|
6159
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
6160
|
+
* Change one step\'s settings or audience filter
|
|
6161
|
+
*/
|
|
6162
|
+
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|
|
6128
6163
|
/**
|
|
6129
6164
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
6130
6165
|
* Update an upsell offer
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -6183,7 +6183,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
6183
6183
|
});
|
|
6184
6184
|
};
|
|
6185
6185
|
/**
|
|
6186
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
6186
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
6187
6187
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
6188
6188
|
*/
|
|
6189
6189
|
SfvbApi.prototype.getSfvbSequenceRaw = function (requestParameters, initOverrides) {
|
|
@@ -6230,7 +6230,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
6230
6230
|
});
|
|
6231
6231
|
};
|
|
6232
6232
|
/**
|
|
6233
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
6233
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
6234
6234
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
6235
6235
|
*/
|
|
6236
6236
|
SfvbApi.prototype.getSfvbSequence = function (requestParameters, initOverrides) {
|
|
@@ -11535,7 +11535,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
11535
11535
|
});
|
|
11536
11536
|
};
|
|
11537
11537
|
/**
|
|
11538
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
11538
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
11539
11539
|
* Request a content review of a flow or campaign email
|
|
11540
11540
|
*/
|
|
11541
11541
|
SfvbApi.prototype.reviewSfvbEmailRaw = function (requestParameters, initOverrides) {
|
|
@@ -11584,7 +11584,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
11584
11584
|
});
|
|
11585
11585
|
};
|
|
11586
11586
|
/**
|
|
11587
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
11587
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
11588
11588
|
* Request a content review of a flow or campaign email
|
|
11589
11589
|
*/
|
|
11590
11590
|
SfvbApi.prototype.reviewSfvbEmail = function (requestParameters, initOverrides) {
|
|
@@ -13015,6 +13015,82 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
13015
13015
|
});
|
|
13016
13016
|
});
|
|
13017
13017
|
};
|
|
13018
|
+
/**
|
|
13019
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
13020
|
+
* Change one step\'s settings or audience filter
|
|
13021
|
+
*/
|
|
13022
|
+
SfvbApi.prototype.updateSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
|
|
13023
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
13024
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
13025
|
+
return __generator(this, function (_c) {
|
|
13026
|
+
switch (_c.label) {
|
|
13027
|
+
case 0:
|
|
13028
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
13029
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling updateSfvbSequenceStep.');
|
|
13030
|
+
}
|
|
13031
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
13032
|
+
throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling updateSfvbSequenceStep.');
|
|
13033
|
+
}
|
|
13034
|
+
if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
|
|
13035
|
+
throw new runtime.RequiredError('stepUuid', 'Required parameter requestParameters.stepUuid was null or undefined when calling updateSfvbSequenceStep.');
|
|
13036
|
+
}
|
|
13037
|
+
if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
|
|
13038
|
+
throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling updateSfvbSequenceStep.');
|
|
13039
|
+
}
|
|
13040
|
+
if (requestParameters.sequenceStepUpdateRequest === null || requestParameters.sequenceStepUpdateRequest === undefined) {
|
|
13041
|
+
throw new runtime.RequiredError('sequenceStepUpdateRequest', 'Required parameter requestParameters.sequenceStepUpdateRequest was null or undefined when calling updateSfvbSequenceStep.');
|
|
13042
|
+
}
|
|
13043
|
+
queryParameters = {};
|
|
13044
|
+
headerParameters = {};
|
|
13045
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
13046
|
+
if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
|
|
13047
|
+
headerParameters['If-Match'] = String(requestParameters.ifMatch);
|
|
13048
|
+
}
|
|
13049
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
13050
|
+
// oauth required
|
|
13051
|
+
_a = headerParameters;
|
|
13052
|
+
_b = "Authorization";
|
|
13053
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
13054
|
+
case 1:
|
|
13055
|
+
// oauth required
|
|
13056
|
+
_a[_b] = _c.sent();
|
|
13057
|
+
_c.label = 2;
|
|
13058
|
+
case 2:
|
|
13059
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
13060
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
13061
|
+
}
|
|
13062
|
+
return [4 /*yield*/, this.request({
|
|
13063
|
+
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))),
|
|
13064
|
+
method: 'PUT',
|
|
13065
|
+
headers: headerParameters,
|
|
13066
|
+
query: queryParameters,
|
|
13067
|
+
body: (0, models_1.SfvbSequenceStepUpdateRequestToJSON)(requestParameters.sequenceStepUpdateRequest),
|
|
13068
|
+
}, initOverrides)];
|
|
13069
|
+
case 3:
|
|
13070
|
+
response = _c.sent();
|
|
13071
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSequenceStepUpdateResponseFromJSON)(jsonValue); })];
|
|
13072
|
+
}
|
|
13073
|
+
});
|
|
13074
|
+
});
|
|
13075
|
+
};
|
|
13076
|
+
/**
|
|
13077
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
13078
|
+
* Change one step\'s settings or audience filter
|
|
13079
|
+
*/
|
|
13080
|
+
SfvbApi.prototype.updateSfvbSequenceStep = function (requestParameters, initOverrides) {
|
|
13081
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
13082
|
+
var response;
|
|
13083
|
+
return __generator(this, function (_a) {
|
|
13084
|
+
switch (_a.label) {
|
|
13085
|
+
case 0: return [4 /*yield*/, this.updateSfvbSequenceStepRaw(requestParameters, initOverrides)];
|
|
13086
|
+
case 1:
|
|
13087
|
+
response = _a.sent();
|
|
13088
|
+
return [4 /*yield*/, response.value()];
|
|
13089
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
13090
|
+
}
|
|
13091
|
+
});
|
|
13092
|
+
});
|
|
13093
|
+
};
|
|
13018
13094
|
/**
|
|
13019
13095
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
13020
13096
|
* Update an upsell offer
|
|
@@ -39,7 +39,7 @@ export interface AutoOrderItem {
|
|
|
39
39
|
*/
|
|
40
40
|
arbitrary_percentage_discount?: number;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Quantity to rebill. When set, every rebill uses this quantity instead of original_quantity. Set this field to change the quantity on an active auto order; the merchant auto order editor updates this same field. Each rebill charges the unit price multiplied by this quantity.
|
|
43
43
|
* @type {number}
|
|
44
44
|
* @memberof AutoOrderItem
|
|
45
45
|
*/
|
|
@@ -51,7 +51,7 @@ export interface AutoOrderItem {
|
|
|
51
51
|
*/
|
|
52
52
|
arbitrary_schedule_days?: number;
|
|
53
53
|
/**
|
|
54
|
-
* Arbitrary unit cost that rebills of this item should occur at
|
|
54
|
+
* Arbitrary unit cost that rebills of this item should occur at. This is a price per unit. Each rebill charges it multiplied by the rebill quantity (arbitrary_quantity, or original_quantity when arbitrary_quantity is null).
|
|
55
55
|
* @type {number}
|
|
56
56
|
* @memberof AutoOrderItem
|
|
57
57
|
*/
|
|
@@ -159,7 +159,7 @@ export interface AutoOrderItem {
|
|
|
159
159
|
*/
|
|
160
160
|
original_item_id?: string;
|
|
161
161
|
/**
|
|
162
|
-
* The original quantity
|
|
162
|
+
* The quantity purchased on the original order. Rebills use this quantity only when arbitrary_quantity is null. To change the quantity on future rebills, set arbitrary_quantity instead.
|
|
163
163
|
* @type {number}
|
|
164
164
|
* @memberof AutoOrderItem
|
|
165
165
|
*/
|
|
@@ -58,6 +58,12 @@ export interface SfvbSequenceStep {
|
|
|
58
58
|
* @memberof SfvbSequenceStep
|
|
59
59
|
*/
|
|
60
60
|
filter_profile_equation_json?: string;
|
|
61
|
+
/**
|
|
62
|
+
* The hash of the step's type, stored settings and audience filter. Send it back as If-Match when changing the step.
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof SfvbSequenceStep
|
|
65
|
+
*/
|
|
66
|
+
hash_sha256?: string;
|
|
61
67
|
/**
|
|
62
68
|
* The items it names, for a cart or rate limiter step.
|
|
63
69
|
* @type {Array<string>}
|
|
@@ -40,6 +40,7 @@ function SfvbSequenceStepFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
40
40
|
'disabled': !(0, runtime_1.exists)(json, 'disabled') ? undefined : json['disabled'],
|
|
41
41
|
'email_uuids': !(0, runtime_1.exists)(json, 'email_uuids') ? undefined : json['email_uuids'],
|
|
42
42
|
'filter_profile_equation_json': !(0, runtime_1.exists)(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
|
|
43
|
+
'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
|
|
43
44
|
'item_ids': !(0, runtime_1.exists)(json, 'item_ids') ? undefined : json['item_ids'],
|
|
44
45
|
'label': !(0, runtime_1.exists)(json, 'label') ? undefined : json['label'],
|
|
45
46
|
'list_uuids': !(0, runtime_1.exists)(json, 'list_uuids') ? undefined : json['list_uuids'],
|
|
@@ -68,6 +69,7 @@ function SfvbSequenceStepToJSON(value) {
|
|
|
68
69
|
'disabled': value.disabled,
|
|
69
70
|
'email_uuids': value.email_uuids,
|
|
70
71
|
'filter_profile_equation_json': value.filter_profile_equation_json,
|
|
72
|
+
'hash_sha256': value.hash_sha256,
|
|
71
73
|
'item_ids': value.item_ids,
|
|
72
74
|
'label': value.label,
|
|
73
75
|
'list_uuids': value.list_uuids,
|
|
@@ -0,0 +1,37 @@
|
|
|
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 SfvbSequenceStepUpdateRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbSequenceStepUpdateRequest {
|
|
18
|
+
/**
|
|
19
|
+
* The step's new settings, as a JSON object in the admin's own shape. Replaces the stored settings.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SfvbSequenceStepUpdateRequest
|
|
22
|
+
*/
|
|
23
|
+
config_json?: string;
|
|
24
|
+
/**
|
|
25
|
+
* The step's new audience filter, as a JSON object. Replaces the stored filter.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SfvbSequenceStepUpdateRequest
|
|
28
|
+
*/
|
|
29
|
+
filter_profile_equation_json?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the SfvbSequenceStepUpdateRequest interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfSfvbSequenceStepUpdateRequest(value: object): boolean;
|
|
35
|
+
export declare function SfvbSequenceStepUpdateRequestFromJSON(json: any): SfvbSequenceStepUpdateRequest;
|
|
36
|
+
export declare function SfvbSequenceStepUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepUpdateRequest;
|
|
37
|
+
export declare function SfvbSequenceStepUpdateRequestToJSON(value?: SfvbSequenceStepUpdateRequest | null): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
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.SfvbSequenceStepUpdateRequestToJSON = exports.SfvbSequenceStepUpdateRequestFromJSONTyped = exports.SfvbSequenceStepUpdateRequestFromJSON = exports.instanceOfSfvbSequenceStepUpdateRequest = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the SfvbSequenceStepUpdateRequest interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfSfvbSequenceStepUpdateRequest(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfSfvbSequenceStepUpdateRequest = instanceOfSfvbSequenceStepUpdateRequest;
|
|
26
|
+
function SfvbSequenceStepUpdateRequestFromJSON(json) {
|
|
27
|
+
return SfvbSequenceStepUpdateRequestFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.SfvbSequenceStepUpdateRequestFromJSON = SfvbSequenceStepUpdateRequestFromJSON;
|
|
30
|
+
function SfvbSequenceStepUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'config_json': !(0, runtime_1.exists)(json, 'config_json') ? undefined : json['config_json'],
|
|
36
|
+
'filter_profile_equation_json': !(0, runtime_1.exists)(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
exports.SfvbSequenceStepUpdateRequestFromJSONTyped = SfvbSequenceStepUpdateRequestFromJSONTyped;
|
|
40
|
+
function SfvbSequenceStepUpdateRequestToJSON(value) {
|
|
41
|
+
if (value === undefined) {
|
|
42
|
+
return undefined;
|
|
43
|
+
}
|
|
44
|
+
if (value === null) {
|
|
45
|
+
return null;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'config_json': value.config_json,
|
|
49
|
+
'filter_profile_equation_json': value.filter_profile_equation_json,
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
exports.SfvbSequenceStepUpdateRequestToJSON = SfvbSequenceStepUpdateRequestToJSON;
|
|
@@ -0,0 +1,38 @@
|
|
|
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 SfvbSequenceStepUpdateResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface SfvbSequenceStepUpdateResponse {
|
|
19
|
+
/**
|
|
20
|
+
* Anything worth knowing about the change, such as customers already waiting on the step.
|
|
21
|
+
* @type {Array<string>}
|
|
22
|
+
* @memberof SfvbSequenceStepUpdateResponse
|
|
23
|
+
*/
|
|
24
|
+
notes?: Array<string>;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {SfvbSequenceStep}
|
|
28
|
+
* @memberof SfvbSequenceStepUpdateResponse
|
|
29
|
+
*/
|
|
30
|
+
step?: SfvbSequenceStep;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the SfvbSequenceStepUpdateResponse interface.
|
|
34
|
+
*/
|
|
35
|
+
export declare function instanceOfSfvbSequenceStepUpdateResponse(value: object): boolean;
|
|
36
|
+
export declare function SfvbSequenceStepUpdateResponseFromJSON(json: any): SfvbSequenceStepUpdateResponse;
|
|
37
|
+
export declare function SfvbSequenceStepUpdateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepUpdateResponse;
|
|
38
|
+
export declare function SfvbSequenceStepUpdateResponseToJSON(value?: SfvbSequenceStepUpdateResponse | null): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
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.SfvbSequenceStepUpdateResponseToJSON = exports.SfvbSequenceStepUpdateResponseFromJSONTyped = exports.SfvbSequenceStepUpdateResponseFromJSON = exports.instanceOfSfvbSequenceStepUpdateResponse = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var SfvbSequenceStep_1 = require("./SfvbSequenceStep");
|
|
19
|
+
/**
|
|
20
|
+
* Check if a given object implements the SfvbSequenceStepUpdateResponse interface.
|
|
21
|
+
*/
|
|
22
|
+
function instanceOfSfvbSequenceStepUpdateResponse(value) {
|
|
23
|
+
var isInstance = true;
|
|
24
|
+
return isInstance;
|
|
25
|
+
}
|
|
26
|
+
exports.instanceOfSfvbSequenceStepUpdateResponse = instanceOfSfvbSequenceStepUpdateResponse;
|
|
27
|
+
function SfvbSequenceStepUpdateResponseFromJSON(json) {
|
|
28
|
+
return SfvbSequenceStepUpdateResponseFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
exports.SfvbSequenceStepUpdateResponseFromJSON = SfvbSequenceStepUpdateResponseFromJSON;
|
|
31
|
+
function SfvbSequenceStepUpdateResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if ((json === undefined) || (json === null)) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
|
|
37
|
+
'step': !(0, runtime_1.exists)(json, 'step') ? undefined : (0, SfvbSequenceStep_1.SfvbSequenceStepFromJSON)(json['step']),
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
exports.SfvbSequenceStepUpdateResponseFromJSONTyped = SfvbSequenceStepUpdateResponseFromJSONTyped;
|
|
41
|
+
function SfvbSequenceStepUpdateResponseToJSON(value) {
|
|
42
|
+
if (value === undefined) {
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
if (value === null) {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'notes': value.notes,
|
|
50
|
+
'step': (0, SfvbSequenceStep_1.SfvbSequenceStepToJSON)(value.step),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
exports.SfvbSequenceStepUpdateResponseToJSON = SfvbSequenceStepUpdateResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1169,6 +1169,8 @@ export * from './SfvbSecretSink';
|
|
|
1169
1169
|
export * from './SfvbSequence';
|
|
1170
1170
|
export * from './SfvbSequenceBranch';
|
|
1171
1171
|
export * from './SfvbSequenceStep';
|
|
1172
|
+
export * from './SfvbSequenceStepUpdateRequest';
|
|
1173
|
+
export * from './SfvbSequenceStepUpdateResponse';
|
|
1172
1174
|
export * from './SfvbServerLog';
|
|
1173
1175
|
export * from './SfvbServerLogDetail';
|
|
1174
1176
|
export * from './SfvbServerLogEntry';
|
package/dist/models/index.js
CHANGED
|
@@ -1187,6 +1187,8 @@ __exportStar(require("./SfvbSecretSink"), exports);
|
|
|
1187
1187
|
__exportStar(require("./SfvbSequence"), exports);
|
|
1188
1188
|
__exportStar(require("./SfvbSequenceBranch"), exports);
|
|
1189
1189
|
__exportStar(require("./SfvbSequenceStep"), exports);
|
|
1190
|
+
__exportStar(require("./SfvbSequenceStepUpdateRequest"), exports);
|
|
1191
|
+
__exportStar(require("./SfvbSequenceStepUpdateResponse"), exports);
|
|
1190
1192
|
__exportStar(require("./SfvbServerLog"), exports);
|
|
1191
1193
|
__exportStar(require("./SfvbServerLogDetail"), exports);
|
|
1192
1194
|
__exportStar(require("./SfvbServerLogEntry"), exports);
|
package/package.json
CHANGED
package/src/apis/SfvbApi.ts
CHANGED
|
@@ -432,6 +432,12 @@ import {
|
|
|
432
432
|
SfvbSequence,
|
|
433
433
|
SfvbSequenceFromJSON,
|
|
434
434
|
SfvbSequenceToJSON,
|
|
435
|
+
SfvbSequenceStepUpdateRequest,
|
|
436
|
+
SfvbSequenceStepUpdateRequestFromJSON,
|
|
437
|
+
SfvbSequenceStepUpdateRequestToJSON,
|
|
438
|
+
SfvbSequenceStepUpdateResponse,
|
|
439
|
+
SfvbSequenceStepUpdateResponseFromJSON,
|
|
440
|
+
SfvbSequenceStepUpdateResponseToJSON,
|
|
435
441
|
SfvbServerLogDetail,
|
|
436
442
|
SfvbServerLogDetailFromJSON,
|
|
437
443
|
SfvbServerLogDetailToJSON,
|
|
@@ -1619,6 +1625,14 @@ export interface UpdateSfvbRedirectRequest {
|
|
|
1619
1625
|
redirectRequest: SfvbRedirectRequest;
|
|
1620
1626
|
}
|
|
1621
1627
|
|
|
1628
|
+
export interface UpdateSfvbSequenceStepRequest {
|
|
1629
|
+
storefrontOid: number;
|
|
1630
|
+
sequenceUuid: string;
|
|
1631
|
+
stepUuid: string;
|
|
1632
|
+
ifMatch: string;
|
|
1633
|
+
sequenceStepUpdateRequest: SfvbSequenceStepUpdateRequest;
|
|
1634
|
+
}
|
|
1635
|
+
|
|
1622
1636
|
export interface UpdateSfvbUpsellOfferRequest {
|
|
1623
1637
|
storefrontOid: number;
|
|
1624
1638
|
upsellOfferOid: number;
|
|
@@ -3318,7 +3332,7 @@ export interface SfvbApiInterface {
|
|
|
3318
3332
|
getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
|
|
3319
3333
|
|
|
3320
3334
|
/**
|
|
3321
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
3335
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
3322
3336
|
* @summary Get a campaign\'s or flow\'s steps as a tree
|
|
3323
3337
|
* @param {number} storefrontOid
|
|
3324
3338
|
* @param {string} sequenceUuid
|
|
@@ -3330,7 +3344,7 @@ export interface SfvbApiInterface {
|
|
|
3330
3344
|
getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
|
|
3331
3345
|
|
|
3332
3346
|
/**
|
|
3333
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
3347
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
3334
3348
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
3335
3349
|
*/
|
|
3336
3350
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
@@ -4765,7 +4779,7 @@ export interface SfvbApiInterface {
|
|
|
4765
4779
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
4766
4780
|
|
|
4767
4781
|
/**
|
|
4768
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
4782
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
4769
4783
|
* @summary Request a content review of a flow or campaign email
|
|
4770
4784
|
* @param {number} storefrontOid
|
|
4771
4785
|
* @param {string} emailUuid
|
|
@@ -4777,7 +4791,7 @@ export interface SfvbApiInterface {
|
|
|
4777
4791
|
reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
4778
4792
|
|
|
4779
4793
|
/**
|
|
4780
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
4794
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
4781
4795
|
* Request a content review of a flow or campaign email
|
|
4782
4796
|
*/
|
|
4783
4797
|
reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
@@ -5160,6 +5174,26 @@ export interface SfvbApiInterface {
|
|
|
5160
5174
|
*/
|
|
5161
5175
|
updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
5162
5176
|
|
|
5177
|
+
/**
|
|
5178
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
5179
|
+
* @summary Change one step\'s settings or audience filter
|
|
5180
|
+
* @param {number} storefrontOid
|
|
5181
|
+
* @param {string} sequenceUuid
|
|
5182
|
+
* @param {string} stepUuid
|
|
5183
|
+
* @param {string} ifMatch The step\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
5184
|
+
* @param {SfvbSequenceStepUpdateRequest} sequenceStepUpdateRequest The settings, the filter, or both
|
|
5185
|
+
* @param {*} [options] Override http request option.
|
|
5186
|
+
* @throws {RequiredError}
|
|
5187
|
+
* @memberof SfvbApiInterface
|
|
5188
|
+
*/
|
|
5189
|
+
updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
|
|
5190
|
+
|
|
5191
|
+
/**
|
|
5192
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
5193
|
+
* Change one step\'s settings or audience filter
|
|
5194
|
+
*/
|
|
5195
|
+
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|
|
5196
|
+
|
|
5163
5197
|
/**
|
|
5164
5198
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
5165
5199
|
* @summary Update an upsell offer
|
|
@@ -9804,7 +9838,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
9804
9838
|
}
|
|
9805
9839
|
|
|
9806
9840
|
/**
|
|
9807
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
9841
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
9808
9842
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
9809
9843
|
*/
|
|
9810
9844
|
async getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>> {
|
|
@@ -9844,7 +9878,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
9844
9878
|
}
|
|
9845
9879
|
|
|
9846
9880
|
/**
|
|
9847
|
-
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter,
|
|
9881
|
+
* The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order. Only condition, split and InboxGeek steps branch, and each holds its two sides in branches. Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, the emails, postcard, lists or items it names, and the hash_sha256 to send as If-Match when changing it. waiting adds how many customers are waiting on each step now. Read only.
|
|
9848
9882
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
9849
9883
|
*/
|
|
9850
9884
|
async getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence> {
|
|
@@ -13942,7 +13976,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
13942
13976
|
}
|
|
13943
13977
|
|
|
13944
13978
|
/**
|
|
13945
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
13979
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
13946
13980
|
* Request a content review of a flow or campaign email
|
|
13947
13981
|
*/
|
|
13948
13982
|
async reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>> {
|
|
@@ -13985,7 +14019,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
13985
14019
|
}
|
|
13986
14020
|
|
|
13987
14021
|
/**
|
|
13988
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
14022
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
13989
14023
|
* Request a content review of a flow or campaign email
|
|
13990
14024
|
*/
|
|
13991
14025
|
async reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail> {
|
|
@@ -15094,6 +15128,70 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
15094
15128
|
return await response.value();
|
|
15095
15129
|
}
|
|
15096
15130
|
|
|
15131
|
+
/**
|
|
15132
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
15133
|
+
* Change one step\'s settings or audience filter
|
|
15134
|
+
*/
|
|
15135
|
+
async updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>> {
|
|
15136
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
15137
|
+
throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling updateSfvbSequenceStep.');
|
|
15138
|
+
}
|
|
15139
|
+
|
|
15140
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
15141
|
+
throw new runtime.RequiredError('sequenceUuid','Required parameter requestParameters.sequenceUuid was null or undefined when calling updateSfvbSequenceStep.');
|
|
15142
|
+
}
|
|
15143
|
+
|
|
15144
|
+
if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
|
|
15145
|
+
throw new runtime.RequiredError('stepUuid','Required parameter requestParameters.stepUuid was null or undefined when calling updateSfvbSequenceStep.');
|
|
15146
|
+
}
|
|
15147
|
+
|
|
15148
|
+
if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
|
|
15149
|
+
throw new runtime.RequiredError('ifMatch','Required parameter requestParameters.ifMatch was null or undefined when calling updateSfvbSequenceStep.');
|
|
15150
|
+
}
|
|
15151
|
+
|
|
15152
|
+
if (requestParameters.sequenceStepUpdateRequest === null || requestParameters.sequenceStepUpdateRequest === undefined) {
|
|
15153
|
+
throw new runtime.RequiredError('sequenceStepUpdateRequest','Required parameter requestParameters.sequenceStepUpdateRequest was null or undefined when calling updateSfvbSequenceStep.');
|
|
15154
|
+
}
|
|
15155
|
+
|
|
15156
|
+
const queryParameters: any = {};
|
|
15157
|
+
|
|
15158
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
15159
|
+
|
|
15160
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
15161
|
+
|
|
15162
|
+
if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
|
|
15163
|
+
headerParameters['If-Match'] = String(requestParameters.ifMatch);
|
|
15164
|
+
}
|
|
15165
|
+
|
|
15166
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
15167
|
+
// oauth required
|
|
15168
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
|
|
15169
|
+
}
|
|
15170
|
+
|
|
15171
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
15172
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
15173
|
+
}
|
|
15174
|
+
|
|
15175
|
+
const response = await this.request({
|
|
15176
|
+
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))),
|
|
15177
|
+
method: 'PUT',
|
|
15178
|
+
headers: headerParameters,
|
|
15179
|
+
query: queryParameters,
|
|
15180
|
+
body: SfvbSequenceStepUpdateRequestToJSON(requestParameters.sequenceStepUpdateRequest),
|
|
15181
|
+
}, initOverrides);
|
|
15182
|
+
|
|
15183
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SfvbSequenceStepUpdateResponseFromJSON(jsonValue));
|
|
15184
|
+
}
|
|
15185
|
+
|
|
15186
|
+
/**
|
|
15187
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
15188
|
+
* Change one step\'s settings or audience filter
|
|
15189
|
+
*/
|
|
15190
|
+
async updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse> {
|
|
15191
|
+
const response = await this.updateSfvbSequenceStepRaw(requestParameters, initOverrides);
|
|
15192
|
+
return await response.value();
|
|
15193
|
+
}
|
|
15194
|
+
|
|
15097
15195
|
/**
|
|
15098
15196
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
15099
15197
|
* Update an upsell offer
|
|
@@ -69,7 +69,7 @@ export interface AutoOrderItem {
|
|
|
69
69
|
*/
|
|
70
70
|
arbitrary_percentage_discount?: number;
|
|
71
71
|
/**
|
|
72
|
-
*
|
|
72
|
+
* Quantity to rebill. When set, every rebill uses this quantity instead of original_quantity. Set this field to change the quantity on an active auto order; the merchant auto order editor updates this same field. Each rebill charges the unit price multiplied by this quantity.
|
|
73
73
|
* @type {number}
|
|
74
74
|
* @memberof AutoOrderItem
|
|
75
75
|
*/
|
|
@@ -81,7 +81,7 @@ export interface AutoOrderItem {
|
|
|
81
81
|
*/
|
|
82
82
|
arbitrary_schedule_days?: number;
|
|
83
83
|
/**
|
|
84
|
-
* Arbitrary unit cost that rebills of this item should occur at
|
|
84
|
+
* Arbitrary unit cost that rebills of this item should occur at. This is a price per unit. Each rebill charges it multiplied by the rebill quantity (arbitrary_quantity, or original_quantity when arbitrary_quantity is null).
|
|
85
85
|
* @type {number}
|
|
86
86
|
* @memberof AutoOrderItem
|
|
87
87
|
*/
|
|
@@ -189,7 +189,7 @@ export interface AutoOrderItem {
|
|
|
189
189
|
*/
|
|
190
190
|
original_item_id?: string;
|
|
191
191
|
/**
|
|
192
|
-
* The original quantity
|
|
192
|
+
* The quantity purchased on the original order. Rebills use this quantity only when arbitrary_quantity is null. To change the quantity on future rebills, set arbitrary_quantity instead.
|
|
193
193
|
* @type {number}
|
|
194
194
|
* @memberof AutoOrderItem
|
|
195
195
|
*/
|
|
@@ -68,6 +68,12 @@ export interface SfvbSequenceStep {
|
|
|
68
68
|
* @memberof SfvbSequenceStep
|
|
69
69
|
*/
|
|
70
70
|
filter_profile_equation_json?: string;
|
|
71
|
+
/**
|
|
72
|
+
* The hash of the step's type, stored settings and audience filter. Send it back as If-Match when changing the step.
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof SfvbSequenceStep
|
|
75
|
+
*/
|
|
76
|
+
hash_sha256?: string;
|
|
71
77
|
/**
|
|
72
78
|
* The items it names, for a cart or rate limiter step.
|
|
73
79
|
* @type {Array<string>}
|
|
@@ -158,6 +164,7 @@ export function SfvbSequenceStepFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
158
164
|
'disabled': !exists(json, 'disabled') ? undefined : json['disabled'],
|
|
159
165
|
'email_uuids': !exists(json, 'email_uuids') ? undefined : json['email_uuids'],
|
|
160
166
|
'filter_profile_equation_json': !exists(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
|
|
167
|
+
'hash_sha256': !exists(json, 'hash_sha256') ? undefined : json['hash_sha256'],
|
|
161
168
|
'item_ids': !exists(json, 'item_ids') ? undefined : json['item_ids'],
|
|
162
169
|
'label': !exists(json, 'label') ? undefined : json['label'],
|
|
163
170
|
'list_uuids': !exists(json, 'list_uuids') ? undefined : json['list_uuids'],
|
|
@@ -187,6 +194,7 @@ export function SfvbSequenceStepToJSON(value?: SfvbSequenceStep | null): any {
|
|
|
187
194
|
'disabled': value.disabled,
|
|
188
195
|
'email_uuids': value.email_uuids,
|
|
189
196
|
'filter_profile_equation_json': value.filter_profile_equation_json,
|
|
197
|
+
'hash_sha256': value.hash_sha256,
|
|
190
198
|
'item_ids': value.item_ids,
|
|
191
199
|
'label': value.label,
|
|
192
200
|
'list_uuids': value.list_uuids,
|
|
@@ -0,0 +1,75 @@
|
|
|
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 SfvbSequenceStepUpdateRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface SfvbSequenceStepUpdateRequest {
|
|
22
|
+
/**
|
|
23
|
+
* The step's new settings, as a JSON object in the admin's own shape. Replaces the stored settings.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof SfvbSequenceStepUpdateRequest
|
|
26
|
+
*/
|
|
27
|
+
config_json?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The step's new audience filter, as a JSON object. Replaces the stored filter.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof SfvbSequenceStepUpdateRequest
|
|
32
|
+
*/
|
|
33
|
+
filter_profile_equation_json?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the SfvbSequenceStepUpdateRequest interface.
|
|
40
|
+
*/
|
|
41
|
+
export function instanceOfSfvbSequenceStepUpdateRequest(value: object): boolean {
|
|
42
|
+
let isInstance = true;
|
|
43
|
+
|
|
44
|
+
return isInstance;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export function SfvbSequenceStepUpdateRequestFromJSON(json: any): SfvbSequenceStepUpdateRequest {
|
|
48
|
+
return SfvbSequenceStepUpdateRequestFromJSONTyped(json, false);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function SfvbSequenceStepUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepUpdateRequest {
|
|
52
|
+
if ((json === undefined) || (json === null)) {
|
|
53
|
+
return json;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
|
|
57
|
+
'config_json': !exists(json, 'config_json') ? undefined : json['config_json'],
|
|
58
|
+
'filter_profile_equation_json': !exists(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function SfvbSequenceStepUpdateRequestToJSON(value?: SfvbSequenceStepUpdateRequest | null): any {
|
|
63
|
+
if (value === undefined) {
|
|
64
|
+
return undefined;
|
|
65
|
+
}
|
|
66
|
+
if (value === null) {
|
|
67
|
+
return null;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'config_json': value.config_json,
|
|
72
|
+
'filter_profile_equation_json': value.filter_profile_equation_json,
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
SfvbSequenceStep,
|
|
18
|
+
SfvbSequenceStepFromJSON,
|
|
19
|
+
SfvbSequenceStepFromJSONTyped,
|
|
20
|
+
SfvbSequenceStepToJSON,
|
|
21
|
+
} from './SfvbSequenceStep';
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @export
|
|
26
|
+
* @interface SfvbSequenceStepUpdateResponse
|
|
27
|
+
*/
|
|
28
|
+
export interface SfvbSequenceStepUpdateResponse {
|
|
29
|
+
/**
|
|
30
|
+
* Anything worth knowing about the change, such as customers already waiting on the step.
|
|
31
|
+
* @type {Array<string>}
|
|
32
|
+
* @memberof SfvbSequenceStepUpdateResponse
|
|
33
|
+
*/
|
|
34
|
+
notes?: Array<string>;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {SfvbSequenceStep}
|
|
38
|
+
* @memberof SfvbSequenceStepUpdateResponse
|
|
39
|
+
*/
|
|
40
|
+
step?: SfvbSequenceStep;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Check if a given object implements the SfvbSequenceStepUpdateResponse interface.
|
|
47
|
+
*/
|
|
48
|
+
export function instanceOfSfvbSequenceStepUpdateResponse(value: object): boolean {
|
|
49
|
+
let isInstance = true;
|
|
50
|
+
|
|
51
|
+
return isInstance;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export function SfvbSequenceStepUpdateResponseFromJSON(json: any): SfvbSequenceStepUpdateResponse {
|
|
55
|
+
return SfvbSequenceStepUpdateResponseFromJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function SfvbSequenceStepUpdateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStepUpdateResponse {
|
|
59
|
+
if ((json === undefined) || (json === null)) {
|
|
60
|
+
return json;
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
|
|
64
|
+
'notes': !exists(json, 'notes') ? undefined : json['notes'],
|
|
65
|
+
'step': !exists(json, 'step') ? undefined : SfvbSequenceStepFromJSON(json['step']),
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function SfvbSequenceStepUpdateResponseToJSON(value?: SfvbSequenceStepUpdateResponse | null): any {
|
|
70
|
+
if (value === undefined) {
|
|
71
|
+
return undefined;
|
|
72
|
+
}
|
|
73
|
+
if (value === null) {
|
|
74
|
+
return null;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
'notes': value.notes,
|
|
79
|
+
'step': SfvbSequenceStepToJSON(value.step),
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -1171,6 +1171,8 @@ export * from './SfvbSecretSink';
|
|
|
1171
1171
|
export * from './SfvbSequence';
|
|
1172
1172
|
export * from './SfvbSequenceBranch';
|
|
1173
1173
|
export * from './SfvbSequenceStep';
|
|
1174
|
+
export * from './SfvbSequenceStepUpdateRequest';
|
|
1175
|
+
export * from './SfvbSequenceStepUpdateResponse';
|
|
1174
1176
|
export * from './SfvbServerLog';
|
|
1175
1177
|
export * from './SfvbServerLogDetail';
|
|
1176
1178
|
export * from './SfvbServerLogEntry';
|