ultracart_rest_api_v2_typescript 4.1.231 → 4.1.232

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.
Files changed (102) hide show
  1. package/.openapi-generator/FILES +29 -0
  2. package/README.md +3 -2
  3. package/dist/apis/SfvbApi.d.ts +396 -1
  4. package/dist/apis/SfvbApi.js +865 -19
  5. package/dist/models/ItemContentMultimedia.d.ts +6 -0
  6. package/dist/models/ItemContentMultimedia.js +2 -0
  7. package/dist/models/SfvbApprovalCreateRequest.d.ts +24 -0
  8. package/dist/models/SfvbApprovalCreateRequest.js +13 -1
  9. package/dist/models/SfvbCommsBranchStat.d.ts +38 -0
  10. package/dist/models/SfvbCommsBranchStat.js +53 -0
  11. package/dist/models/SfvbCommsChange.d.ts +43 -0
  12. package/dist/models/SfvbCommsChange.js +54 -0
  13. package/dist/models/SfvbCommsClick.d.ts +37 -0
  14. package/dist/models/SfvbCommsClick.js +52 -0
  15. package/dist/models/SfvbCommsClicksResponse.d.ts +56 -0
  16. package/dist/models/SfvbCommsClicksResponse.js +59 -0
  17. package/dist/models/SfvbCommsDailyStat.d.ts +67 -0
  18. package/dist/models/SfvbCommsDailyStat.js +62 -0
  19. package/dist/models/SfvbCommsDashboardResponse.d.ts +51 -0
  20. package/dist/models/SfvbCommsDashboardResponse.js +58 -0
  21. package/dist/models/SfvbCommsDashboardRow.d.ts +62 -0
  22. package/dist/models/SfvbCommsDashboardRow.js +61 -0
  23. package/dist/models/SfvbCommsPlan.d.ts +175 -0
  24. package/dist/models/SfvbCommsPlan.js +98 -0
  25. package/dist/models/SfvbCommsPlanResponse.d.ts +38 -0
  26. package/dist/models/SfvbCommsPlanResponse.js +53 -0
  27. package/dist/models/SfvbCommsProvider.d.ts +62 -0
  28. package/dist/models/SfvbCommsProvider.js +61 -0
  29. package/dist/models/SfvbCommsProviderImportRequest.d.ts +43 -0
  30. package/dist/models/SfvbCommsProviderImportRequest.js +54 -0
  31. package/dist/models/SfvbCommsProviderImportResponse.d.ts +56 -0
  32. package/dist/models/SfvbCommsProviderImportResponse.js +59 -0
  33. package/dist/models/SfvbCommsProviderList.d.ts +37 -0
  34. package/dist/models/SfvbCommsProviderList.js +52 -0
  35. package/dist/models/SfvbCommsProvidersResponse.d.ts +44 -0
  36. package/dist/models/SfvbCommsProvidersResponse.js +55 -0
  37. package/dist/models/SfvbCommsSender.d.ts +49 -0
  38. package/dist/models/SfvbCommsSender.js +56 -0
  39. package/dist/models/SfvbCommsSenderUpdate.d.ts +43 -0
  40. package/dist/models/SfvbCommsSenderUpdate.js +54 -0
  41. package/dist/models/SfvbCommsSequenceStatsResponse.d.ts +57 -0
  42. package/dist/models/SfvbCommsSequenceStatsResponse.js +60 -0
  43. package/dist/models/SfvbCommsSettings.d.ts +81 -0
  44. package/dist/models/SfvbCommsSettings.js +68 -0
  45. package/dist/models/SfvbCommsSettingsResponse.d.ts +51 -0
  46. package/dist/models/SfvbCommsSettingsResponse.js +58 -0
  47. package/dist/models/SfvbCommsSettingsUpdateRequest.d.ts +57 -0
  48. package/dist/models/SfvbCommsSettingsUpdateRequest.js +60 -0
  49. package/dist/models/SfvbCommsStat.d.ts +139 -0
  50. package/dist/models/SfvbCommsStat.js +86 -0
  51. package/dist/models/SfvbCommsStepStat.d.ts +81 -0
  52. package/dist/models/SfvbCommsStepStat.js +68 -0
  53. package/dist/models/SfvbCommsTemplate.d.ts +67 -0
  54. package/dist/models/SfvbCommsTemplate.js +62 -0
  55. package/dist/models/SfvbCommsTemplateResponse.d.ts +50 -0
  56. package/dist/models/SfvbCommsTemplateResponse.js +57 -0
  57. package/dist/models/SfvbCommsTemplatesResponse.d.ts +38 -0
  58. package/dist/models/SfvbCommsTemplatesResponse.js +53 -0
  59. package/dist/models/SfvbCommsTestEmailRequest.d.ts +49 -0
  60. package/dist/models/SfvbCommsTestEmailRequest.js +56 -0
  61. package/dist/models/SfvbCommsTestPostcardRequest.d.ts +85 -0
  62. package/dist/models/SfvbCommsTestPostcardRequest.js +68 -0
  63. package/dist/models/SfvbCommsTestSendResponse.d.ts +73 -0
  64. package/dist/models/SfvbCommsTestSendResponse.js +64 -0
  65. package/dist/models/SfvbCommsTestSmsRequest.d.ts +31 -0
  66. package/dist/models/SfvbCommsTestSmsRequest.js +50 -0
  67. package/dist/models/index.d.ts +29 -0
  68. package/dist/models/index.js +29 -0
  69. package/package.json +1 -1
  70. package/src/apis/SfvbApi.ts +993 -4
  71. package/src/models/ItemContentMultimedia.ts +8 -0
  72. package/src/models/SfvbApprovalCreateRequest.ts +46 -1
  73. package/src/models/SfvbCommsBranchStat.ts +82 -0
  74. package/src/models/SfvbCommsChange.ts +83 -0
  75. package/src/models/SfvbCommsClick.ts +75 -0
  76. package/src/models/SfvbCommsClicksResponse.ts +106 -0
  77. package/src/models/SfvbCommsDailyStat.ts +115 -0
  78. package/src/models/SfvbCommsDashboardResponse.ts +104 -0
  79. package/src/models/SfvbCommsDashboardRow.ts +114 -0
  80. package/src/models/SfvbCommsPlan.ts +259 -0
  81. package/src/models/SfvbCommsPlanResponse.ts +82 -0
  82. package/src/models/SfvbCommsProvider.ts +114 -0
  83. package/src/models/SfvbCommsProviderImportRequest.ts +83 -0
  84. package/src/models/SfvbCommsProviderImportResponse.ts +106 -0
  85. package/src/models/SfvbCommsProviderList.ts +75 -0
  86. package/src/models/SfvbCommsProvidersResponse.ts +90 -0
  87. package/src/models/SfvbCommsSender.ts +91 -0
  88. package/src/models/SfvbCommsSenderUpdate.ts +83 -0
  89. package/src/models/SfvbCommsSequenceStatsResponse.ts +112 -0
  90. package/src/models/SfvbCommsSettings.ts +144 -0
  91. package/src/models/SfvbCommsSettingsResponse.ts +104 -0
  92. package/src/models/SfvbCommsSettingsUpdateRequest.ts +112 -0
  93. package/src/models/SfvbCommsStat.ts +211 -0
  94. package/src/models/SfvbCommsStepStat.ts +144 -0
  95. package/src/models/SfvbCommsTemplate.ts +115 -0
  96. package/src/models/SfvbCommsTemplateResponse.ts +98 -0
  97. package/src/models/SfvbCommsTemplatesResponse.ts +82 -0
  98. package/src/models/SfvbCommsTestEmailRequest.ts +91 -0
  99. package/src/models/SfvbCommsTestPostcardRequest.ts +139 -0
  100. package/src/models/SfvbCommsTestSendResponse.ts +123 -0
  101. package/src/models/SfvbCommsTestSmsRequest.ts +67 -0
  102. package/src/models/index.ts +29 -0
@@ -1017,6 +1017,13 @@ src/models/SfvbCampaignWriteRequest.ts
1017
1017
  src/models/SfvbCampaignsResponse.ts
1018
1018
  src/models/SfvbCodeLibraryEmail.ts
1019
1019
  src/models/SfvbCodeLibraryEmailsResponse.ts
1020
+ src/models/SfvbCommsBranchStat.ts
1021
+ src/models/SfvbCommsChange.ts
1022
+ src/models/SfvbCommsClick.ts
1023
+ src/models/SfvbCommsClicksResponse.ts
1024
+ src/models/SfvbCommsDailyStat.ts
1025
+ src/models/SfvbCommsDashboardResponse.ts
1026
+ src/models/SfvbCommsDashboardRow.ts
1020
1027
  src/models/SfvbCommsDnsRecord.ts
1021
1028
  src/models/SfvbCommsEmail.ts
1022
1029
  src/models/SfvbCommsFolder.ts
@@ -1031,15 +1038,37 @@ src/models/SfvbCommsListWriteRequest.ts
1031
1038
  src/models/SfvbCommsListsResponse.ts
1032
1039
  src/models/SfvbCommsMember.ts
1033
1040
  src/models/SfvbCommsMembersResponse.ts
1041
+ src/models/SfvbCommsPlan.ts
1042
+ src/models/SfvbCommsPlanResponse.ts
1034
1043
  src/models/SfvbCommsPostcard.ts
1044
+ src/models/SfvbCommsProvider.ts
1045
+ src/models/SfvbCommsProviderImportRequest.ts
1046
+ src/models/SfvbCommsProviderImportResponse.ts
1047
+ src/models/SfvbCommsProviderList.ts
1048
+ src/models/SfvbCommsProvidersResponse.ts
1035
1049
  src/models/SfvbCommsSegment.ts
1036
1050
  src/models/SfvbCommsSegmentDetail.ts
1037
1051
  src/models/SfvbCommsSegmentResponse.ts
1038
1052
  src/models/SfvbCommsSegmentUsedBy.ts
1039
1053
  src/models/SfvbCommsSegmentWriteRequest.ts
1040
1054
  src/models/SfvbCommsSegmentsResponse.ts
1055
+ src/models/SfvbCommsSender.ts
1056
+ src/models/SfvbCommsSenderUpdate.ts
1041
1057
  src/models/SfvbCommsSendingDomain.ts
1042
1058
  src/models/SfvbCommsSendingDomainsResponse.ts
1059
+ src/models/SfvbCommsSequenceStatsResponse.ts
1060
+ src/models/SfvbCommsSettings.ts
1061
+ src/models/SfvbCommsSettingsResponse.ts
1062
+ src/models/SfvbCommsSettingsUpdateRequest.ts
1063
+ src/models/SfvbCommsStat.ts
1064
+ src/models/SfvbCommsStepStat.ts
1065
+ src/models/SfvbCommsTemplate.ts
1066
+ src/models/SfvbCommsTemplateResponse.ts
1067
+ src/models/SfvbCommsTemplatesResponse.ts
1068
+ src/models/SfvbCommsTestEmailRequest.ts
1069
+ src/models/SfvbCommsTestPostcardRequest.ts
1070
+ src/models/SfvbCommsTestSendResponse.ts
1071
+ src/models/SfvbCommsTestSmsRequest.ts
1043
1072
  src/models/SfvbCommsTwilioAccount.ts
1044
1073
  src/models/SfvbCommsTwilioAccountResponse.ts
1045
1074
  src/models/SfvbCompileRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.231
2
+ ## ultracart_rest_api_v2_typescript@4.1.232
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.231 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.232 --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.232 | 11/05/2026 | sfvb internal testing |
87
88
  | 4.1.231 | 11/05/2026 | sfvb internal testing |
88
89
  | 4.1.230 | 11/05/2026 | sfvb internal testing |
89
90
  | 4.1.229 | 11/04/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 { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsMembersResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, 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, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, 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, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -306,6 +306,16 @@ export interface GetSfvbCampaignRequest {
306
306
  export interface GetSfvbCjsonUsedElementsRequest {
307
307
  compileRequest: SfvbCompileRequest;
308
308
  }
309
+ export interface GetSfvbCommsDashboardStatsRequest {
310
+ storefrontOid: number;
311
+ days?: number;
312
+ }
313
+ export interface GetSfvbCommsEmailClicksRequest {
314
+ storefrontOid: number;
315
+ commseqUuid: string;
316
+ emailUuid: string;
317
+ days?: number;
318
+ }
309
319
  export interface GetSfvbCommsFolderRequest {
310
320
  storefrontOid: number;
311
321
  folderUuid: string;
@@ -324,6 +334,12 @@ export interface GetSfvbCommsListMembersRequest {
324
334
  pageSize?: number;
325
335
  showCustomerData?: boolean;
326
336
  }
337
+ export interface GetSfvbCommsPlanRequest {
338
+ storefrontOid: number;
339
+ }
340
+ export interface GetSfvbCommsProvidersRequest {
341
+ storefrontOid: number;
342
+ }
327
343
  export interface GetSfvbCommsSegmentRequest {
328
344
  storefrontOid: number;
329
345
  segmentUuid: string;
@@ -338,6 +354,21 @@ export interface GetSfvbCommsSegmentMembersRequest {
338
354
  export interface GetSfvbCommsSendingDomainRequest {
339
355
  domain: string;
340
356
  }
357
+ export interface GetSfvbCommsSequenceStatsRequest {
358
+ storefrontOid: number;
359
+ commseqUuid: string;
360
+ days?: number;
361
+ }
362
+ export interface GetSfvbCommsSettingsRequest {
363
+ storefrontOid: number;
364
+ }
365
+ export interface GetSfvbCommsTemplateRequest {
366
+ storefrontOid: number;
367
+ emailTemplateOid: number;
368
+ }
369
+ export interface GetSfvbCommsTemplatesRequest {
370
+ storefrontOid: number;
371
+ }
341
372
  export interface GetSfvbContainerRequest {
342
373
  storefrontOid: number;
343
374
  ownerType: string;
@@ -621,6 +652,11 @@ export interface IgnoreSfvbNotFoundEntryRequest {
621
652
  storefrontOid: number;
622
653
  notFoundId: string;
623
654
  }
655
+ export interface ImportSfvbCommsProviderListsRequest {
656
+ storefrontOid: number;
657
+ providerImportRequest: SfvbCommsProviderImportRequest;
658
+ approvalId?: string;
659
+ }
624
660
  export interface ImportSfvbRedirectsRequest {
625
661
  storefrontOid: number;
626
662
  redirectImportRequest: SfvbRedirectImportRequest;
@@ -1052,6 +1088,25 @@ export interface StartSfvbExperimentRequest {
1052
1088
  experimentStartRequest: SfvbExperimentStartRequest;
1053
1089
  approvalId?: string;
1054
1090
  }
1091
+ export interface TestSfvbCommsEmailRequest {
1092
+ storefrontOid: number;
1093
+ commseqUuid: string;
1094
+ stepUuid: string;
1095
+ testEmailRequest: SfvbCommsTestEmailRequest;
1096
+ }
1097
+ export interface TestSfvbCommsPostcardRequest {
1098
+ storefrontOid: number;
1099
+ commseqUuid: string;
1100
+ stepUuid: string;
1101
+ testPostcardRequest: SfvbCommsTestPostcardRequest;
1102
+ approvalId?: string;
1103
+ }
1104
+ export interface TestSfvbCommsSmsRequest {
1105
+ storefrontOid: number;
1106
+ commseqUuid: string;
1107
+ stepUuid: string;
1108
+ testSmsRequest: SfvbCommsTestSmsRequest;
1109
+ }
1055
1110
  export interface UnarchiveSfvbUpsellPathRequest {
1056
1111
  storefrontOid: number;
1057
1112
  upsellPathOid: number;
@@ -1115,6 +1170,12 @@ export interface UpdateSfvbCommsSendingDomainRequest {
1115
1170
  domain: string;
1116
1171
  sendingDomain: SfvbCommsSendingDomain;
1117
1172
  }
1173
+ export interface UpdateSfvbCommsSettingsRequest {
1174
+ storefrontOid: number;
1175
+ ifMatch: string;
1176
+ commsSettingsUpdateRequest: SfvbCommsSettingsUpdateRequest;
1177
+ approvalId?: string;
1178
+ }
1118
1179
  export interface UpdateSfvbCommsTwilioAccountRequest {
1119
1180
  twilioAccount: SfvbCommsTwilioAccount;
1120
1181
  }
@@ -2264,6 +2325,38 @@ export interface SfvbApiInterface {
2264
2325
  * Element types used by a container
2265
2326
  */
2266
2327
  getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
2328
+ /**
2329
+ * rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account\'s last 31 days of sending, whatever the window. Read only.
2330
+ * @summary Read every flow\'s and campaign\'s counts over a window, with the account\'s daily sending
2331
+ * @param {number} storefrontOid
2332
+ * @param {number} [days] The window for the rows, 1 to 365 days (default 30).
2333
+ * @param {*} [options] Override http request option.
2334
+ * @throws {RequiredError}
2335
+ * @memberof SfvbApiInterface
2336
+ */
2337
+ getSfvbCommsDashboardStatsRaw(requestParameters: GetSfvbCommsDashboardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsDashboardResponse>>;
2338
+ /**
2339
+ * rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account\'s last 31 days of sending, whatever the window. Read only.
2340
+ * Read every flow\'s and campaign\'s counts over a window, with the account\'s daily sending
2341
+ */
2342
+ getSfvbCommsDashboardStats(requestParameters: GetSfvbCommsDashboardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsDashboardResponse>;
2343
+ /**
2344
+ * The email must be sent by an email or experiment step of this flow\'s or campaign\'s sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
2345
+ * @summary Read each link in one email and how often it was clicked
2346
+ * @param {number} storefrontOid
2347
+ * @param {string} commseqUuid
2348
+ * @param {string} emailUuid
2349
+ * @param {number} [days] The window, 1 to 365 days (default 30).
2350
+ * @param {*} [options] Override http request option.
2351
+ * @throws {RequiredError}
2352
+ * @memberof SfvbApiInterface
2353
+ */
2354
+ getSfvbCommsEmailClicksRaw(requestParameters: GetSfvbCommsEmailClicksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsClicksResponse>>;
2355
+ /**
2356
+ * The email must be sent by an email or experiment step of this flow\'s or campaign\'s sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
2357
+ * Read each link in one email and how often it was clicked
2358
+ */
2359
+ getSfvbCommsEmailClicks(requestParameters: GetSfvbCommsEmailClicksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsClicksResponse>;
2267
2360
  /**
2268
2361
  * The folder, with the name and uuid of each list and segment filed in it.
2269
2362
  * @summary Read one list and segment folder
@@ -2326,6 +2419,34 @@ export interface SfvbApiInterface {
2326
2419
  * Read one page of a list\'s members
2327
2420
  */
2328
2421
  getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
2422
+ /**
2423
+ * The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
2424
+ * @summary Read the account\'s communications plan and sending health
2425
+ * @param {number} storefrontOid
2426
+ * @param {*} [options] Override http request option.
2427
+ * @throws {RequiredError}
2428
+ * @memberof SfvbApiInterface
2429
+ */
2430
+ getSfvbCommsPlanRaw(requestParameters: GetSfvbCommsPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsPlanResponse>>;
2431
+ /**
2432
+ * The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
2433
+ * Read the account\'s communications plan and sending health
2434
+ */
2435
+ getSfvbCommsPlan(requestParameters: GetSfvbCommsPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsPlanResponse>;
2436
+ /**
2437
+ * Each provider that can share list members, connected or not, with a connected one\'s lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
2438
+ * @summary List the email providers the account can import lists from
2439
+ * @param {number} storefrontOid
2440
+ * @param {*} [options] Override http request option.
2441
+ * @throws {RequiredError}
2442
+ * @memberof SfvbApiInterface
2443
+ */
2444
+ getSfvbCommsProvidersRaw(requestParameters: GetSfvbCommsProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsProvidersResponse>>;
2445
+ /**
2446
+ * Each provider that can share list members, connected or not, with a connected one\'s lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
2447
+ * List the email providers the account can import lists from
2448
+ */
2449
+ getSfvbCommsProviders(requestParameters: GetSfvbCommsProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsProvidersResponse>;
2329
2450
  /**
2330
2451
  * The segment\'s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
2331
2452
  * @summary Read one segment, with its rule
@@ -2386,6 +2507,65 @@ export interface SfvbApiInterface {
2386
2507
  * List the sending domains
2387
2508
  */
2388
2509
  getSfvbCommsSendingDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomainsResponse>;
2510
+ /**
2511
+ * overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
2512
+ * @summary Read a flow\'s or campaign\'s counts, overall and step by step
2513
+ * @param {number} storefrontOid
2514
+ * @param {string} commseqUuid
2515
+ * @param {number} [days] The window for the step counts, 1 to 365 days (default 30).
2516
+ * @param {*} [options] Override http request option.
2517
+ * @throws {RequiredError}
2518
+ * @memberof SfvbApiInterface
2519
+ */
2520
+ getSfvbCommsSequenceStatsRaw(requestParameters: GetSfvbCommsSequenceStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSequenceStatsResponse>>;
2521
+ /**
2522
+ * overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
2523
+ * Read a flow\'s or campaign\'s counts, overall and step by step
2524
+ */
2525
+ getSfvbCommsSequenceStats(requestParameters: GetSfvbCommsSequenceStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSequenceStatsResponse>;
2526
+ /**
2527
+ * The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
2528
+ * @summary Read a storefront\'s communications settings
2529
+ * @param {number} storefrontOid
2530
+ * @param {*} [options] Override http request option.
2531
+ * @throws {RequiredError}
2532
+ * @memberof SfvbApiInterface
2533
+ */
2534
+ getSfvbCommsSettingsRaw(requestParameters: GetSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSettingsResponse>>;
2535
+ /**
2536
+ * The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
2537
+ * Read a storefront\'s communications settings
2538
+ */
2539
+ getSfvbCommsSettings(requestParameters: GetSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSettingsResponse>;
2540
+ /**
2541
+ * A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
2542
+ * @summary Read one saved email template\'s body
2543
+ * @param {number} storefrontOid
2544
+ * @param {number} emailTemplateOid
2545
+ * @param {*} [options] Override http request option.
2546
+ * @throws {RequiredError}
2547
+ * @memberof SfvbApiInterface
2548
+ */
2549
+ getSfvbCommsTemplateRaw(requestParameters: GetSfvbCommsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTemplateResponse>>;
2550
+ /**
2551
+ * A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
2552
+ * Read one saved email template\'s body
2553
+ */
2554
+ getSfvbCommsTemplate(requestParameters: GetSfvbCommsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTemplateResponse>;
2555
+ /**
2556
+ * One list: UltraCart\'s system templates and this storefront\'s saved ones (each with email_template_oid), then base templates, the active theme\'s files an email renders inside (each with path). Read only.
2557
+ * @summary List the email templates a new email can start from
2558
+ * @param {number} storefrontOid
2559
+ * @param {*} [options] Override http request option.
2560
+ * @throws {RequiredError}
2561
+ * @memberof SfvbApiInterface
2562
+ */
2563
+ getSfvbCommsTemplatesRaw(requestParameters: GetSfvbCommsTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTemplatesResponse>>;
2564
+ /**
2565
+ * One list: UltraCart\'s system templates and this storefront\'s saved ones (each with email_template_oid), then base templates, the active theme\'s files an email renders inside (each with path). Read only.
2566
+ * List the email templates a new email can start from
2567
+ */
2568
+ getSfvbCommsTemplates(requestParameters: GetSfvbCommsTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTemplatesResponse>;
2389
2569
  /**
2390
2570
  * 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.
2391
2571
  * @summary Read the Twilio account
@@ -3437,6 +3617,22 @@ export interface SfvbApiInterface {
3437
3617
  * Ignore a 404 path
3438
3618
  */
3439
3619
  ignoreSfvbNotFoundEntry(requestParameters: IgnoreSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundEntry>;
3620
+ /**
3621
+ * Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
3622
+ * @summary Import lists from another email provider
3623
+ * @param {number} storefrontOid
3624
+ * @param {SfvbCommsProviderImportRequest} providerImportRequest The provider and lists to import
3625
+ * @param {string} [approvalId] The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals.
3626
+ * @param {*} [options] Override http request option.
3627
+ * @throws {RequiredError}
3628
+ * @memberof SfvbApiInterface
3629
+ */
3630
+ importSfvbCommsProviderListsRaw(requestParameters: ImportSfvbCommsProviderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsProviderImportResponse>>;
3631
+ /**
3632
+ * Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
3633
+ * Import lists from another email provider
3634
+ */
3635
+ importSfvbCommsProviderLists(requestParameters: ImportSfvbCommsProviderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsProviderImportResponse>;
3440
3636
  /**
3441
3637
  * Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront\'s rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
3442
3638
  * @summary Apply a reviewed redirect import
@@ -4795,6 +4991,58 @@ export interface SfvbApiInterface {
4795
4991
  * Start an experiment
4796
4992
  */
4797
4993
  startSfvbExperiment(requestParameters: StartSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
4994
+ /**
4995
+ * to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan\'s email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
4996
+ * @summary Send one test of an email step\'s email to a user on this account
4997
+ * @param {number} storefrontOid
4998
+ * @param {string} commseqUuid
4999
+ * @param {string} stepUuid
5000
+ * @param {SfvbCommsTestEmailRequest} testEmailRequest The email and the recipient
5001
+ * @param {*} [options] Override http request option.
5002
+ * @throws {RequiredError}
5003
+ * @memberof SfvbApiInterface
5004
+ */
5005
+ testSfvbCommsEmailRaw(requestParameters: TestSfvbCommsEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTestSendResponse>>;
5006
+ /**
5007
+ * to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan\'s email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
5008
+ * Send one test of an email step\'s email to a user on this account
5009
+ */
5010
+ testSfvbCommsEmail(requestParameters: TestSfvbCommsEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTestSendResponse>;
5011
+ /**
5012
+ * It is printed and mailed at the account\'s cost and can\'t be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
5013
+ * @summary Print and mail one real test postcard
5014
+ * @param {number} storefrontOid
5015
+ * @param {string} commseqUuid
5016
+ * @param {string} stepUuid
5017
+ * @param {SfvbCommsTestPostcardRequest} testPostcardRequest The address and mail_card
5018
+ * @param {string} [approvalId] The approval_id of an approved postcard.test_mail request for exactly this card and address. See POST /sfvb/approvals.
5019
+ * @param {*} [options] Override http request option.
5020
+ * @throws {RequiredError}
5021
+ * @memberof SfvbApiInterface
5022
+ */
5023
+ testSfvbCommsPostcardRaw(requestParameters: TestSfvbCommsPostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTestSendResponse>>;
5024
+ /**
5025
+ * It is printed and mailed at the account\'s cost and can\'t be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
5026
+ * Print and mail one real test postcard
5027
+ */
5028
+ testSfvbCommsPostcard(requestParameters: TestSfvbCommsPostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTestSendResponse>;
5029
+ /**
5030
+ * to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account\'s Twilio account, from the flow\'s or campaign\'s SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
5031
+ * @summary Send one test of an SMS step to a user on this account
5032
+ * @param {number} storefrontOid
5033
+ * @param {string} commseqUuid
5034
+ * @param {string} stepUuid
5035
+ * @param {SfvbCommsTestSmsRequest} testSmsRequest The recipient
5036
+ * @param {*} [options] Override http request option.
5037
+ * @throws {RequiredError}
5038
+ * @memberof SfvbApiInterface
5039
+ */
5040
+ testSfvbCommsSmsRaw(requestParameters: TestSfvbCommsSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTestSendResponse>>;
5041
+ /**
5042
+ * to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account\'s Twilio account, from the flow\'s or campaign\'s SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
5043
+ * Send one test of an SMS step to a user on this account
5044
+ */
5045
+ testSfvbCommsSms(requestParameters: TestSfvbCommsSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTestSendResponse>;
4798
5046
  /**
4799
5047
  * Brings the path back into the default list. A path that is switched on is refused, because unarchiving it would start it without approval - disable it, unarchive it, then enable it.
4800
5048
  * @summary Unarchive an upsell path
@@ -4990,6 +5238,23 @@ export interface SfvbApiInterface {
4990
5238
  * Update a sending domain
4991
5239
  */
4992
5240
  updateSfvbCommsSendingDomain(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
5241
+ /**
5242
+ * A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
5243
+ * @summary Change a storefront\'s communications settings
5244
+ * @param {number} storefrontOid
5245
+ * @param {string} ifMatch The settings\&#39; hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
5246
+ * @param {SfvbCommsSettingsUpdateRequest} commsSettingsUpdateRequest The settings to change
5247
+ * @param {string} [approvalId] The approval_id of an approved comms_settings.update request for exactly this change, when a sender or the SMS number changes. See POST /sfvb/approvals.
5248
+ * @param {*} [options] Override http request option.
5249
+ * @throws {RequiredError}
5250
+ * @memberof SfvbApiInterface
5251
+ */
5252
+ updateSfvbCommsSettingsRaw(requestParameters: UpdateSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSettingsResponse>>;
5253
+ /**
5254
+ * A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
5255
+ * Change a storefront\'s communications settings
5256
+ */
5257
+ updateSfvbCommsSettings(requestParameters: UpdateSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSettingsResponse>;
4993
5258
  /**
4994
5259
  * 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.
4995
5260
  * @summary Update the Twilio account
@@ -6004,6 +6269,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6004
6269
  * Element types used by a container
6005
6270
  */
6006
6271
  getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
6272
+ /**
6273
+ * rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account\'s last 31 days of sending, whatever the window. Read only.
6274
+ * Read every flow\'s and campaign\'s counts over a window, with the account\'s daily sending
6275
+ */
6276
+ getSfvbCommsDashboardStatsRaw(requestParameters: GetSfvbCommsDashboardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsDashboardResponse>>;
6277
+ /**
6278
+ * rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account\'s last 31 days of sending, whatever the window. Read only.
6279
+ * Read every flow\'s and campaign\'s counts over a window, with the account\'s daily sending
6280
+ */
6281
+ getSfvbCommsDashboardStats(requestParameters: GetSfvbCommsDashboardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsDashboardResponse>;
6282
+ /**
6283
+ * The email must be sent by an email or experiment step of this flow\'s or campaign\'s sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
6284
+ * Read each link in one email and how often it was clicked
6285
+ */
6286
+ getSfvbCommsEmailClicksRaw(requestParameters: GetSfvbCommsEmailClicksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsClicksResponse>>;
6287
+ /**
6288
+ * The email must be sent by an email or experiment step of this flow\'s or campaign\'s sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
6289
+ * Read each link in one email and how often it was clicked
6290
+ */
6291
+ getSfvbCommsEmailClicks(requestParameters: GetSfvbCommsEmailClicksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsClicksResponse>;
6007
6292
  /**
6008
6293
  * The folder, with the name and uuid of each list and segment filed in it.
6009
6294
  * Read one list and segment folder
@@ -6044,6 +6329,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6044
6329
  * Read one page of a list\'s members
6045
6330
  */
6046
6331
  getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
6332
+ /**
6333
+ * The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
6334
+ * Read the account\'s communications plan and sending health
6335
+ */
6336
+ getSfvbCommsPlanRaw(requestParameters: GetSfvbCommsPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsPlanResponse>>;
6337
+ /**
6338
+ * The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
6339
+ * Read the account\'s communications plan and sending health
6340
+ */
6341
+ getSfvbCommsPlan(requestParameters: GetSfvbCommsPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsPlanResponse>;
6342
+ /**
6343
+ * Each provider that can share list members, connected or not, with a connected one\'s lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
6344
+ * List the email providers the account can import lists from
6345
+ */
6346
+ getSfvbCommsProvidersRaw(requestParameters: GetSfvbCommsProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsProvidersResponse>>;
6347
+ /**
6348
+ * Each provider that can share list members, connected or not, with a connected one\'s lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
6349
+ * List the email providers the account can import lists from
6350
+ */
6351
+ getSfvbCommsProviders(requestParameters: GetSfvbCommsProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsProvidersResponse>;
6047
6352
  /**
6048
6353
  * The segment\'s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
6049
6354
  * Read one segment, with its rule
@@ -6084,6 +6389,46 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6084
6389
  * List the sending domains
6085
6390
  */
6086
6391
  getSfvbCommsSendingDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomainsResponse>;
6392
+ /**
6393
+ * overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
6394
+ * Read a flow\'s or campaign\'s counts, overall and step by step
6395
+ */
6396
+ getSfvbCommsSequenceStatsRaw(requestParameters: GetSfvbCommsSequenceStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSequenceStatsResponse>>;
6397
+ /**
6398
+ * overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
6399
+ * Read a flow\'s or campaign\'s counts, overall and step by step
6400
+ */
6401
+ getSfvbCommsSequenceStats(requestParameters: GetSfvbCommsSequenceStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSequenceStatsResponse>;
6402
+ /**
6403
+ * The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
6404
+ * Read a storefront\'s communications settings
6405
+ */
6406
+ getSfvbCommsSettingsRaw(requestParameters: GetSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSettingsResponse>>;
6407
+ /**
6408
+ * The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
6409
+ * Read a storefront\'s communications settings
6410
+ */
6411
+ getSfvbCommsSettings(requestParameters: GetSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSettingsResponse>;
6412
+ /**
6413
+ * A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
6414
+ * Read one saved email template\'s body
6415
+ */
6416
+ getSfvbCommsTemplateRaw(requestParameters: GetSfvbCommsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTemplateResponse>>;
6417
+ /**
6418
+ * A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
6419
+ * Read one saved email template\'s body
6420
+ */
6421
+ getSfvbCommsTemplate(requestParameters: GetSfvbCommsTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTemplateResponse>;
6422
+ /**
6423
+ * One list: UltraCart\'s system templates and this storefront\'s saved ones (each with email_template_oid), then base templates, the active theme\'s files an email renders inside (each with path). Read only.
6424
+ * List the email templates a new email can start from
6425
+ */
6426
+ getSfvbCommsTemplatesRaw(requestParameters: GetSfvbCommsTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTemplatesResponse>>;
6427
+ /**
6428
+ * One list: UltraCart\'s system templates and this storefront\'s saved ones (each with email_template_oid), then base templates, the active theme\'s files an email renders inside (each with path). Read only.
6429
+ * List the email templates a new email can start from
6430
+ */
6431
+ getSfvbCommsTemplates(requestParameters: GetSfvbCommsTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTemplatesResponse>;
6087
6432
  /**
6088
6433
  * 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.
6089
6434
  * Read the Twilio account
@@ -6772,6 +7117,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6772
7117
  * Ignore a 404 path
6773
7118
  */
6774
7119
  ignoreSfvbNotFoundEntry(requestParameters: IgnoreSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundEntry>;
7120
+ /**
7121
+ * Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
7122
+ * Import lists from another email provider
7123
+ */
7124
+ importSfvbCommsProviderListsRaw(requestParameters: ImportSfvbCommsProviderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsProviderImportResponse>>;
7125
+ /**
7126
+ * Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
7127
+ * Import lists from another email provider
7128
+ */
7129
+ importSfvbCommsProviderLists(requestParameters: ImportSfvbCommsProviderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsProviderImportResponse>;
6775
7130
  /**
6776
7131
  * Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront\'s rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
6777
7132
  * Apply a reviewed redirect import
@@ -7610,6 +7965,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
7610
7965
  * Start an experiment
7611
7966
  */
7612
7967
  startSfvbExperiment(requestParameters: StartSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
7968
+ /**
7969
+ * to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan\'s email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
7970
+ * Send one test of an email step\'s email to a user on this account
7971
+ */
7972
+ testSfvbCommsEmailRaw(requestParameters: TestSfvbCommsEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTestSendResponse>>;
7973
+ /**
7974
+ * to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan\'s email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
7975
+ * Send one test of an email step\'s email to a user on this account
7976
+ */
7977
+ testSfvbCommsEmail(requestParameters: TestSfvbCommsEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTestSendResponse>;
7978
+ /**
7979
+ * It is printed and mailed at the account\'s cost and can\'t be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
7980
+ * Print and mail one real test postcard
7981
+ */
7982
+ testSfvbCommsPostcardRaw(requestParameters: TestSfvbCommsPostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTestSendResponse>>;
7983
+ /**
7984
+ * It is printed and mailed at the account\'s cost and can\'t be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
7985
+ * Print and mail one real test postcard
7986
+ */
7987
+ testSfvbCommsPostcard(requestParameters: TestSfvbCommsPostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTestSendResponse>;
7988
+ /**
7989
+ * to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account\'s Twilio account, from the flow\'s or campaign\'s SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
7990
+ * Send one test of an SMS step to a user on this account
7991
+ */
7992
+ testSfvbCommsSmsRaw(requestParameters: TestSfvbCommsSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTestSendResponse>>;
7993
+ /**
7994
+ * to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account\'s Twilio account, from the flow\'s or campaign\'s SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
7995
+ * Send one test of an SMS step to a user on this account
7996
+ */
7997
+ testSfvbCommsSms(requestParameters: TestSfvbCommsSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTestSendResponse>;
7613
7998
  /**
7614
7999
  * Brings the path back into the default list. A path that is switched on is refused, because unarchiving it would start it without approval - disable it, unarchive it, then enable it.
7615
8000
  * Unarchive an upsell path
@@ -7730,6 +8115,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
7730
8115
  * Update a sending domain
7731
8116
  */
7732
8117
  updateSfvbCommsSendingDomain(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
8118
+ /**
8119
+ * A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
8120
+ * Change a storefront\'s communications settings
8121
+ */
8122
+ updateSfvbCommsSettingsRaw(requestParameters: UpdateSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSettingsResponse>>;
8123
+ /**
8124
+ * A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
8125
+ * Change a storefront\'s communications settings
8126
+ */
8127
+ updateSfvbCommsSettings(requestParameters: UpdateSfvbCommsSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSettingsResponse>;
7733
8128
  /**
7734
8129
  * 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.
7735
8130
  * Update the Twilio account