ultracart_rest_api_v2_typescript 4.1.203 → 4.1.204

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.
@@ -1007,6 +1007,11 @@ src/models/SfvbBlogPostImage.ts
1007
1007
  src/models/SfvbBlogPostImageRequest.ts
1008
1008
  src/models/SfvbBlogPostRequest.ts
1009
1009
  src/models/SfvbBlogPostsResponse.ts
1010
+ src/models/SfvbCommsDnsRecord.ts
1011
+ src/models/SfvbCommsSendingDomain.ts
1012
+ src/models/SfvbCommsSendingDomainsResponse.ts
1013
+ src/models/SfvbCommsTwilioAccount.ts
1014
+ src/models/SfvbCommsTwilioAccountResponse.ts
1010
1015
  src/models/SfvbCompileRequest.ts
1011
1016
  src/models/SfvbCompileResponse.ts
1012
1017
  src/models/SfvbContainerResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.203
2
+ ## ultracart_rest_api_v2_typescript@4.1.204
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.203 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.204 --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.204 | 10/15/2026 | sfvb internal testing |
87
88
  | 4.1.203 | 10/15/2026 | sfvb internal testing |
88
89
  | 4.1.202 | 10/13/2026 | sfvb internal testing |
89
90
  | 4.1.201 | 10/12/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, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, 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, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, 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, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, 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;
@@ -61,6 +61,13 @@ export interface DeleteSfvbBlogPostRequest {
61
61
  blogPostOid: number;
62
62
  approvalId?: string;
63
63
  }
64
+ export interface DeleteSfvbCommsSendingDomainRequest {
65
+ domain: string;
66
+ approvalId?: string;
67
+ }
68
+ export interface DeleteSfvbCommsTwilioAccountRequest {
69
+ approvalId?: string;
70
+ }
64
71
  export interface DeleteSfvbFileRequest {
65
72
  storefrontOid: number;
66
73
  ifMatch: string;
@@ -201,6 +208,9 @@ export interface GetSfvbBlogPostRequest {
201
208
  export interface GetSfvbCjsonUsedElementsRequest {
202
209
  compileRequest: SfvbCompileRequest;
203
210
  }
211
+ export interface GetSfvbCommsSendingDomainRequest {
212
+ domain: string;
213
+ }
204
214
  export interface GetSfvbContainerRequest {
205
215
  storefrontOid: number;
206
216
  ownerType: string;
@@ -423,6 +433,12 @@ export interface InsertSfvbBlogPostRequest {
423
433
  storefrontOid: number;
424
434
  blogPostRequest: SfvbBlogPostRequest;
425
435
  }
436
+ export interface InsertSfvbCommsSendingDomainRequest {
437
+ sendingDomain: SfvbCommsSendingDomain;
438
+ }
439
+ export interface InsertSfvbCommsTwilioAccountRequest {
440
+ twilioAccount: SfvbCommsTwilioAccount;
441
+ }
426
442
  export interface InsertSfvbPageRequest {
427
443
  storefrontOid: number;
428
444
  pageCreateRequest: SfvbPageCreateRequest;
@@ -667,6 +683,9 @@ export interface PutSfvbThemeAttributesRequest {
667
683
  themeOid: number;
668
684
  attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
669
685
  }
686
+ export interface RefreshSfvbCommsSendingDomainStatusRequest {
687
+ domain: string;
688
+ }
670
689
  export interface RefreshSfvbPageRequest {
671
690
  storefrontOid: number;
672
691
  pageRefreshRequest: SfvbPageRefreshRequest;
@@ -776,6 +795,13 @@ export interface UpdateSfvbBlogPostRequest {
776
795
  blogPostOid: number;
777
796
  blogPostRequest: SfvbBlogPostRequest;
778
797
  }
798
+ export interface UpdateSfvbCommsSendingDomainRequest {
799
+ domain: string;
800
+ sendingDomain: SfvbCommsSendingDomain;
801
+ }
802
+ export interface UpdateSfvbCommsTwilioAccountRequest {
803
+ twilioAccount: SfvbCommsTwilioAccount;
804
+ }
779
805
  export interface UpdateSfvbItemAttributeBatchRequest {
780
806
  storefrontOid: number;
781
807
  itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
@@ -1007,6 +1033,35 @@ export interface SfvbApiInterface {
1007
1033
  * Delete a blog post
1008
1034
  */
1009
1035
  deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1036
+ /**
1037
+ * Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
1038
+ * @summary Remove a sending domain
1039
+ * @param {string} domain
1040
+ * @param {string} [approvalId] The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals.
1041
+ * @param {*} [options] Override http request option.
1042
+ * @throws {RequiredError}
1043
+ * @memberof SfvbApiInterface
1044
+ */
1045
+ deleteSfvbCommsSendingDomainRaw(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1046
+ /**
1047
+ * Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
1048
+ * Remove a sending domain
1049
+ */
1050
+ deleteSfvbCommsSendingDomain(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1051
+ /**
1052
+ * Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
1053
+ * @summary Remove the Twilio account
1054
+ * @param {string} [approvalId] The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals.
1055
+ * @param {*} [options] Override http request option.
1056
+ * @throws {RequiredError}
1057
+ * @memberof SfvbApiInterface
1058
+ */
1059
+ deleteSfvbCommsTwilioAccountRaw(requestParameters: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1060
+ /**
1061
+ * Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
1062
+ * Remove the Twilio account
1063
+ */
1064
+ deleteSfvbCommsTwilioAccount(requestParameters: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1010
1065
  /**
1011
1066
  * Recoverable from the recycle bin.
1012
1067
  * @summary Delete a storefront file
@@ -1489,6 +1544,46 @@ export interface SfvbApiInterface {
1489
1544
  * Element types used by a container
1490
1545
  */
1491
1546
  getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
1547
+ /**
1548
+ * One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
1549
+ * @summary Read a sending domain
1550
+ * @param {string} domain
1551
+ * @param {*} [options] Override http request option.
1552
+ * @throws {RequiredError}
1553
+ * @memberof SfvbApiInterface
1554
+ */
1555
+ getSfvbCommsSendingDomainRaw(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
1556
+ /**
1557
+ * One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
1558
+ * Read a sending domain
1559
+ */
1560
+ getSfvbCommsSendingDomain(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
1561
+ /**
1562
+ * Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
1563
+ * @summary List the sending domains
1564
+ * @param {*} [options] Override http request option.
1565
+ * @throws {RequiredError}
1566
+ * @memberof SfvbApiInterface
1567
+ */
1568
+ getSfvbCommsSendingDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomainsResponse>>;
1569
+ /**
1570
+ * Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
1571
+ * List the sending domains
1572
+ */
1573
+ getSfvbCommsSendingDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomainsResponse>;
1574
+ /**
1575
+ * The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
1576
+ * @summary Read the Twilio account
1577
+ * @param {*} [options] Override http request option.
1578
+ * @throws {RequiredError}
1579
+ * @memberof SfvbApiInterface
1580
+ */
1581
+ getSfvbCommsTwilioAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
1582
+ /**
1583
+ * The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
1584
+ * Read the Twilio account
1585
+ */
1586
+ getSfvbCommsTwilioAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
1492
1587
  /**
1493
1588
  * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
1494
1589
  * @summary Read a container stored outside the file system
@@ -2301,6 +2396,34 @@ export interface SfvbApiInterface {
2301
2396
  * Create a blog post
2302
2397
  */
2303
2398
  insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
2399
+ /**
2400
+ * Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
2401
+ * @summary Add a sending domain
2402
+ * @param {SfvbCommsSendingDomain} sendingDomain The sending domain
2403
+ * @param {*} [options] Override http request option.
2404
+ * @throws {RequiredError}
2405
+ * @memberof SfvbApiInterface
2406
+ */
2407
+ insertSfvbCommsSendingDomainRaw(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
2408
+ /**
2409
+ * Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
2410
+ * Add a sending domain
2411
+ */
2412
+ insertSfvbCommsSendingDomain(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
2413
+ /**
2414
+ * Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
2415
+ * @summary Connect the Twilio account
2416
+ * @param {SfvbCommsTwilioAccount} twilioAccount The Twilio account
2417
+ * @param {*} [options] Override http request option.
2418
+ * @throws {RequiredError}
2419
+ * @memberof SfvbApiInterface
2420
+ */
2421
+ insertSfvbCommsTwilioAccountRaw(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
2422
+ /**
2423
+ * Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
2424
+ * Connect the Twilio account
2425
+ */
2426
+ insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
2304
2427
  /**
2305
2428
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
2306
2429
  * @summary Create a page
@@ -3043,6 +3166,20 @@ export interface SfvbApiInterface {
3043
3166
  * Change a theme\'s colors, fonts and settings
3044
3167
  */
3045
3168
  putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
3169
+ /**
3170
+ * Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
3171
+ * @summary Check a sending domain\'s verification
3172
+ * @param {string} domain
3173
+ * @param {*} [options] Override http request option.
3174
+ * @throws {RequiredError}
3175
+ * @memberof SfvbApiInterface
3176
+ */
3177
+ refreshSfvbCommsSendingDomainStatusRaw(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
3178
+ /**
3179
+ * Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
3180
+ * Check a sending domain\'s verification
3181
+ */
3182
+ refreshSfvbCommsSendingDomainStatus(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
3046
3183
  /**
3047
3184
  * The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
3048
3185
  * @summary Drop one page\'s cached copy
@@ -3394,6 +3531,35 @@ export interface SfvbApiInterface {
3394
3531
  * Change a blog post
3395
3532
  */
3396
3533
  updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
3534
+ /**
3535
+ * Only a mailgun domain\'s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
3536
+ * @summary Update a sending domain
3537
+ * @param {string} domain
3538
+ * @param {SfvbCommsSendingDomain} sendingDomain The changes
3539
+ * @param {*} [options] Override http request option.
3540
+ * @throws {RequiredError}
3541
+ * @memberof SfvbApiInterface
3542
+ */
3543
+ updateSfvbCommsSendingDomainRaw(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
3544
+ /**
3545
+ * Only a mailgun domain\'s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
3546
+ * Update a sending domain
3547
+ */
3548
+ updateSfvbCommsSendingDomain(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
3549
+ /**
3550
+ * Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
3551
+ * @summary Update the Twilio account
3552
+ * @param {SfvbCommsTwilioAccount} twilioAccount The changes
3553
+ * @param {*} [options] Override http request option.
3554
+ * @throws {RequiredError}
3555
+ * @memberof SfvbApiInterface
3556
+ */
3557
+ updateSfvbCommsTwilioAccountRaw(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
3558
+ /**
3559
+ * Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
3560
+ * Update the Twilio account
3561
+ */
3562
+ updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
3397
3563
  /**
3398
3564
  * Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256. Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others. Only the named attributes change. Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
3399
3565
  * @summary Change attributes across many items in one call
@@ -3649,6 +3815,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3649
3815
  * Delete a blog post
3650
3816
  */
3651
3817
  deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3818
+ /**
3819
+ * Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
3820
+ * Remove a sending domain
3821
+ */
3822
+ deleteSfvbCommsSendingDomainRaw(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
3823
+ /**
3824
+ * Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
3825
+ * Remove a sending domain
3826
+ */
3827
+ deleteSfvbCommsSendingDomain(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3828
+ /**
3829
+ * Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
3830
+ * Remove the Twilio account
3831
+ */
3832
+ deleteSfvbCommsTwilioAccountRaw(requestParameters: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
3833
+ /**
3834
+ * Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
3835
+ * Remove the Twilio account
3836
+ */
3837
+ deleteSfvbCommsTwilioAccount(requestParameters?: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3652
3838
  /**
3653
3839
  * Recoverable from the recycle bin.
3654
3840
  * Delete a storefront file
@@ -3957,6 +4143,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3957
4143
  * Element types used by a container
3958
4144
  */
3959
4145
  getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
4146
+ /**
4147
+ * One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
4148
+ * Read a sending domain
4149
+ */
4150
+ getSfvbCommsSendingDomainRaw(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
4151
+ /**
4152
+ * One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
4153
+ * Read a sending domain
4154
+ */
4155
+ getSfvbCommsSendingDomain(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
4156
+ /**
4157
+ * Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
4158
+ * List the sending domains
4159
+ */
4160
+ getSfvbCommsSendingDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomainsResponse>>;
4161
+ /**
4162
+ * Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
4163
+ * List the sending domains
4164
+ */
4165
+ getSfvbCommsSendingDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomainsResponse>;
4166
+ /**
4167
+ * The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
4168
+ * Read the Twilio account
4169
+ */
4170
+ getSfvbCommsTwilioAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
4171
+ /**
4172
+ * The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
4173
+ * Read the Twilio account
4174
+ */
4175
+ getSfvbCommsTwilioAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
3960
4176
  /**
3961
4177
  * owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
3962
4178
  * Read a container stored outside the file system
@@ -4485,6 +4701,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4485
4701
  * Create a blog post
4486
4702
  */
4487
4703
  insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
4704
+ /**
4705
+ * Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
4706
+ * Add a sending domain
4707
+ */
4708
+ insertSfvbCommsSendingDomainRaw(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
4709
+ /**
4710
+ * Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
4711
+ * Add a sending domain
4712
+ */
4713
+ insertSfvbCommsSendingDomain(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
4714
+ /**
4715
+ * Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
4716
+ * Connect the Twilio account
4717
+ */
4718
+ insertSfvbCommsTwilioAccountRaw(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
4719
+ /**
4720
+ * Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
4721
+ * Connect the Twilio account
4722
+ */
4723
+ insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
4488
4724
  /**
4489
4725
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
4490
4726
  * Create a page
@@ -4933,6 +5169,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4933
5169
  * Change a theme\'s colors, fonts and settings
4934
5170
  */
4935
5171
  putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
5172
+ /**
5173
+ * Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
5174
+ * Check a sending domain\'s verification
5175
+ */
5176
+ refreshSfvbCommsSendingDomainStatusRaw(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
5177
+ /**
5178
+ * Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
5179
+ * Check a sending domain\'s verification
5180
+ */
5181
+ refreshSfvbCommsSendingDomainStatus(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
4936
5182
  /**
4937
5183
  * The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
4938
5184
  * Drop one page\'s cached copy
@@ -5153,6 +5399,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5153
5399
  * Change a blog post
5154
5400
  */
5155
5401
  updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
5402
+ /**
5403
+ * Only a mailgun domain\'s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
5404
+ * Update a sending domain
5405
+ */
5406
+ updateSfvbCommsSendingDomainRaw(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
5407
+ /**
5408
+ * Only a mailgun domain\'s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
5409
+ * Update a sending domain
5410
+ */
5411
+ updateSfvbCommsSendingDomain(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
5412
+ /**
5413
+ * Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
5414
+ * Update the Twilio account
5415
+ */
5416
+ updateSfvbCommsTwilioAccountRaw(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
5417
+ /**
5418
+ * Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
5419
+ * Update the Twilio account
5420
+ */
5421
+ updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
5156
5422
  /**
5157
5423
  * Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256. Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others. Only the named attributes change. Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
5158
5424
  * Change attributes across many items in one call