ultracart_rest_api_v2_typescript 4.1.217 → 4.1.218

package/.openapi-generator/FILES

@@ -1018,6 +1018,10 @@ src/models/SfvbCommsList.ts
 src/models/SfvbCommsListsResponse.ts
 src/models/SfvbCommsPostcard.ts
 src/models/SfvbCommsSegment.ts
+src/models/SfvbCommsSegmentDetail.ts
+src/models/SfvbCommsSegmentResponse.ts
+src/models/SfvbCommsSegmentUsedBy.ts
+src/models/SfvbCommsSegmentWriteRequest.ts
 src/models/SfvbCommsSegmentsResponse.ts
 src/models/SfvbCommsSendingDomain.ts
 src/models/SfvbCommsSendingDomainsResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.217
+## ultracart_rest_api_v2_typescript@4.1.218
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.217 --save
+npm install ultracart_rest_api_v2_typescript@4.1.218 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.218 | 10/30/2026 | svfb internal testing |
 | 4.1.217 | 10/29/2026 | sfvb internal testing |
 | 4.1.216 | 10/29/2026 | sfvb internal testing |
 | 4.1.215 | 10/28/2026 | sfvb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCommsListsResponse, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCommsListsResponse, 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, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -247,6 +247,10 @@ export interface GetSfvbCampaignRequest {
 export interface GetSfvbCjsonUsedElementsRequest {
     compileRequest: SfvbCompileRequest;
 }
+export interface GetSfvbCommsSegmentRequest {
+    storefrontOid: number;
+    segmentUuid: string;
+}
 export interface GetSfvbCommsSendingDomainRequest {
     domain: string;
 }
@@ -488,6 +492,10 @@ export interface InsertSfvbBlogPostRequest {
     storefrontOid: number;
     blogPostRequest: SfvbBlogPostRequest;
 }
+export interface InsertSfvbCommsSegmentRequest {
+    storefrontOid: number;
+    segmentWriteRequest: SfvbCommsSegmentWriteRequest;
+}
 export interface InsertSfvbCommsSendingDomainRequest {
     sendingDomain: SfvbCommsSendingDomain;
 }
@@ -897,6 +905,13 @@ export interface UpdateSfvbCampaignRequest {
     ifMatch: string;
     campaignWriteRequest: SfvbCampaignWriteRequest;
 }
+export interface UpdateSfvbCommsSegmentRequest {
+    storefrontOid: number;
+    segmentUuid: string;
+    ifMatch: string;
+    segmentWriteRequest: SfvbCommsSegmentWriteRequest;
+    approvalId?: string;
+}
 export interface UpdateSfvbCommsSendingDomainRequest {
     domain: string;
     sendingDomain: SfvbCommsSendingDomain;
@@ -1798,6 +1813,21 @@ export interface SfvbApiInterface {
      * Element types used by a container
      */
     getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
+    /**
+     * 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.
+     * @summary Read one segment, with its rule
+     * @param {number} storefrontOid
+     * @param {string} segmentUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbCommsSegmentRaw(requestParameters: GetSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
+    /**
+     * 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.
+     * Read one segment, with its rule
+     */
+    getSfvbCommsSegment(requestParameters: GetSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
     /**
      * One sending domain as stored.  To check an amazon domain\'s DNS again, use the status call.
      * @summary Read a sending domain
@@ -2710,6 +2740,21 @@ export interface SfvbApiInterface {
      * Create a blog post
      */
     insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
+    /**
+     * A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
+     * @summary Create a segment
+     * @param {number} storefrontOid
+     * @param {SfvbCommsSegmentWriteRequest} segmentWriteRequest The new segment\&#39;s name, rule and folder
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    insertSfvbCommsSegmentRaw(requestParameters: InsertSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
+    /**
+     * A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
+     * Create a segment
+     */
+    insertSfvbCommsSegment(requestParameters: InsertSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
     /**
      * 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.
      * @summary Add a sending domain
@@ -3991,6 +4036,24 @@ export interface SfvbApiInterface {
      * Change a campaign
      */
     updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A field left out stays as it is.  Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
+     * @summary Change a segment\'s name, rule or folder
+     * @param {number} storefrontOid
+     * @param {string} segmentUuid
+     * @param {string} ifMatch The segment\&#39;s hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+     * @param {SfvbCommsSegmentWriteRequest} segmentWriteRequest The fields to change
+     * @param {string} [approvalId] When the rule changes and a live campaign or flow uses the segment, the approval_id of an approved segment.update request for this change.  See POST /sfvb/approvals.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    updateSfvbCommsSegmentRaw(requestParameters: UpdateSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
+    /**
+     * A field left out stays as it is.  Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
+     * Change a segment\'s name, rule or folder
+     */
+    updateSfvbCommsSegment(requestParameters: UpdateSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
     /**
      * 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.
      * @summary Update a sending domain
@@ -4752,6 +4815,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Element types used by a container
      */
     getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
+    /**
+     * 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.
+     * Read one segment, with its rule
+     */
+    getSfvbCommsSegmentRaw(requestParameters: GetSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
+    /**
+     * 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.
+     * Read one segment, with its rule
+     */
+    getSfvbCommsSegment(requestParameters: GetSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
     /**
      * One sending domain as stored.  To check an amazon domain\'s DNS again, use the status call.
      * Read a sending domain
@@ -5350,6 +5423,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Create a blog post
      */
     insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
+    /**
+     * A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
+     * Create a segment
+     */
+    insertSfvbCommsSegmentRaw(requestParameters: InsertSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
+    /**
+     * A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
+     * Create a segment
+     */
+    insertSfvbCommsSegment(requestParameters: InsertSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
     /**
      * 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.
      * Add a sending domain
@@ -6138,6 +6221,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Change a campaign
      */
     updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A field left out stays as it is.  Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
+     * Change a segment\'s name, rule or folder
+     */
+    updateSfvbCommsSegmentRaw(requestParameters: UpdateSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
+    /**
+     * A field left out stays as it is.  Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
+     * Change a segment\'s name, rule or folder
+     */
+    updateSfvbCommsSegment(requestParameters: UpdateSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
     /**
      * 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.
      * Update a sending domain

package/dist/apis/SfvbApi.js

@@ -3494,6 +3494,68 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Read one segment, with its rule
+     */
+    SfvbApi.prototype.getSfvbCommsSegmentRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbCommsSegment.');
+                        }
+                        if (requestParameters.segmentUuid === null || requestParameters.segmentUuid === undefined) {
+                            throw new runtime.RequiredError('segmentUuid', 'Required parameter requestParameters.segmentUuid was null or undefined when calling getSfvbCommsSegment.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("segment_uuid", "}"), encodeURIComponent(String(requestParameters.segmentUuid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbCommsSegmentResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Read one segment, with its rule
+     */
+    SfvbApi.prototype.getSfvbCommsSegment = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbCommsSegmentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * One sending domain as stored.  To check an amazon domain\'s DNS again, use the status call.
      * Read a sending domain
@@ -7270,6 +7332,70 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
+     * Create a segment
+     */
+    SfvbApi.prototype.insertSfvbCommsSegmentRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling insertSfvbCommsSegment.');
+                        }
+                        if (requestParameters.segmentWriteRequest === null || requestParameters.segmentWriteRequest === undefined) {
+                            throw new runtime.RequiredError('segmentWriteRequest', 'Required parameter requestParameters.segmentWriteRequest was null or undefined when calling insertSfvbCommsSegment.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/segments".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbCommsSegmentWriteRequestToJSON)(requestParameters.segmentWriteRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbCommsSegmentResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
+     * Create a segment
+     */
+    SfvbApi.prototype.insertSfvbCommsSegment = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.insertSfvbCommsSegmentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * 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.
      * Add a sending domain
@@ -12605,6 +12731,82 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * A field left out stays as it is.  Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
+     * Change a segment\'s name, rule or folder
+     */
+    SfvbApi.prototype.updateSfvbCommsSegmentRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling updateSfvbCommsSegment.');
+                        }
+                        if (requestParameters.segmentUuid === null || requestParameters.segmentUuid === undefined) {
+                            throw new runtime.RequiredError('segmentUuid', 'Required parameter requestParameters.segmentUuid was null or undefined when calling updateSfvbCommsSegment.');
+                        }
+                        if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
+                            throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling updateSfvbCommsSegment.');
+                        }
+                        if (requestParameters.segmentWriteRequest === null || requestParameters.segmentWriteRequest === undefined) {
+                            throw new runtime.RequiredError('segmentWriteRequest', 'Required parameter requestParameters.segmentWriteRequest was null or undefined when calling updateSfvbCommsSegment.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
+                            headerParameters['If-Match'] = String(requestParameters.ifMatch);
+                        }
+                        if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
+                            headerParameters['Approval-Id'] = String(requestParameters.approvalId);
+                        }
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("segment_uuid", "}"), encodeURIComponent(String(requestParameters.segmentUuid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbCommsSegmentWriteRequestToJSON)(requestParameters.segmentWriteRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbCommsSegmentResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * A field left out stays as it is.  Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
+     * Change a segment\'s name, rule or folder
+     */
+    SfvbApi.prototype.updateSfvbCommsSegment = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateSfvbCommsSegmentRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * 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.
      * Update a sending domain

package/dist/models/SfvbApprovalCreateRequest.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { SfvbApprovalParams } from './SfvbApprovalParams';
+import { SfvbCommsSegmentWriteRequest } from './SfvbCommsSegmentWriteRequest';
 import { SfvbExperimentStartRequest } from './SfvbExperimentStartRequest';
 import { SfvbItemAttributeBatchRow } from './SfvbItemAttributeBatchRow';
 import { SfvbItemPricingRequest } from './SfvbItemPricingRequest';
@@ -68,6 +69,12 @@ export interface SfvbApprovalCreateRequest {
      * @memberof SfvbApprovalCreateRequest
      */
     redirect_rows?: Array<SfvbRedirectDeleteRow>;
+    /**
+     *
+     * @type {SfvbCommsSegmentWriteRequest}
+     * @memberof SfvbApprovalCreateRequest
+     */
+    segment_update?: SfvbCommsSegmentWriteRequest;
 }
 /**
  * @export
@@ -85,6 +92,7 @@ export declare const SfvbApprovalCreateRequestActionEnum: {
     readonly TwilioAccountDelete: "twilio_account.delete";
     readonly SendingDomainDelete: "sending_domain.delete";
     readonly SequenceStepDelete: "sequence_step.delete";
+    readonly SegmentUpdate: "segment.update";
 };
 export type SfvbApprovalCreateRequestActionEnum = typeof SfvbApprovalCreateRequestActionEnum[keyof typeof SfvbApprovalCreateRequestActionEnum];
 /**

package/dist/models/SfvbApprovalCreateRequest.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SfvbApprovalCreateRequestToJSON = exports.SfvbApprovalCreateRequestFromJSONTyped = exports.SfvbApprovalCreateRequestFromJSON = exports.instanceOfSfvbApprovalCreateRequest = exports.SfvbApprovalCreateRequestActionEnum = void 0;
 var runtime_1 = require("../runtime");
 var SfvbApprovalParams_1 = require("./SfvbApprovalParams");
+var SfvbCommsSegmentWriteRequest_1 = require("./SfvbCommsSegmentWriteRequest");
 var SfvbExperimentStartRequest_1 = require("./SfvbExperimentStartRequest");
 var SfvbItemAttributeBatchRow_1 = require("./SfvbItemAttributeBatchRow");
 var SfvbItemPricingRequest_1 = require("./SfvbItemPricingRequest");
@@ -35,7 +36,8 @@ exports.SfvbApprovalCreateRequestActionEnum = {
     ItemPricing: 'item.pricing',
     TwilioAccountDelete: 'twilio_account.delete',
     SendingDomainDelete: 'sending_domain.delete',
-    SequenceStepDelete: 'sequence_step.delete'
+    SequenceStepDelete: 'sequence_step.delete',
+    SegmentUpdate: 'segment.update'
 };
 /**
  * Check if a given object implements the SfvbApprovalCreateRequest interface.
@@ -62,6 +64,7 @@ function SfvbApprovalCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
         'params': !(0, runtime_1.exists)(json, 'params') ? undefined : (0, SfvbApprovalParams_1.SfvbApprovalParamsFromJSON)(json['params']),
         'reason': !(0, runtime_1.exists)(json, 'reason') ? undefined : json['reason'],
         'redirect_rows': !(0, runtime_1.exists)(json, 'redirect_rows') ? undefined : (json['redirect_rows'].map(SfvbRedirectDeleteRow_1.SfvbRedirectDeleteRowFromJSON)),
+        'segment_update': !(0, runtime_1.exists)(json, 'segment_update') ? undefined : (0, SfvbCommsSegmentWriteRequest_1.SfvbCommsSegmentWriteRequestFromJSON)(json['segment_update']),
     };
 }
 exports.SfvbApprovalCreateRequestFromJSONTyped = SfvbApprovalCreateRequestFromJSONTyped;
@@ -81,6 +84,7 @@ function SfvbApprovalCreateRequestToJSON(value) {
         'params': (0, SfvbApprovalParams_1.SfvbApprovalParamsToJSON)(value.params),
         'reason': value.reason,
         'redirect_rows': value.redirect_rows === undefined ? undefined : (value.redirect_rows.map(SfvbRedirectDeleteRow_1.SfvbRedirectDeleteRowToJSON)),
+        'segment_update': (0, SfvbCommsSegmentWriteRequest_1.SfvbCommsSegmentWriteRequestToJSON)(value.segment_update),
     };
 }
 exports.SfvbApprovalCreateRequestToJSON = SfvbApprovalCreateRequestToJSON;

package/dist/models/SfvbApprovalParams.d.ts

@@ -87,6 +87,12 @@ export interface SfvbApprovalParams {
      * @memberof SfvbApprovalParams
      */
     rule_count?: number;
+    /**
+     * The segment whose rule changes, for segment.update.
+     * @type {string}
+     * @memberof SfvbApprovalParams
+     */
+    segment_uuid?: string;
     /**
      * The communication sequence, for sequence_step.delete.
      * @type {string}

package/dist/models/SfvbApprovalParams.js

@@ -51,6 +51,7 @@ function SfvbApprovalParamsFromJSONTyped(json, ignoreDiscriminator) {
         'request_sha256': !(0, runtime_1.exists)(json, 'request_sha256') ? undefined : json['request_sha256'],
         'rows_sha256': !(0, runtime_1.exists)(json, 'rows_sha256') ? undefined : json['rows_sha256'],
         'rule_count': !(0, runtime_1.exists)(json, 'rule_count') ? undefined : json['rule_count'],
+        'segment_uuid': !(0, runtime_1.exists)(json, 'segment_uuid') ? undefined : json['segment_uuid'],
         'sequence_uuid': !(0, runtime_1.exists)(json, 'sequence_uuid') ? undefined : json['sequence_uuid'],
         'slot': !(0, runtime_1.exists)(json, 'slot') ? undefined : json['slot'],
         'step_uuid': !(0, runtime_1.exists)(json, 'step_uuid') ? undefined : json['step_uuid'],
@@ -82,6 +83,7 @@ function SfvbApprovalParamsToJSON(value) {
         'request_sha256': value.request_sha256,
         'rows_sha256': value.rows_sha256,
         'rule_count': value.rule_count,
+        'segment_uuid': value.segment_uuid,
         'sequence_uuid': value.sequence_uuid,
         'slot': value.slot,
         'step_uuid': value.step_uuid,

package/dist/models/SfvbCommsSegmentDetail.d.ts

@@ -0,0 +1,92 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SfvbCommsSegmentUsedBy } from './SfvbCommsSegmentUsedBy';
+/**
+ *
+ * @export
+ * @interface SfvbCommsSegmentDetail
+ */
+export interface SfvbCommsSegmentDetail {
+    /**
+     * When it was created (ISO 8601, UTC).
+     * @type {string}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    created_dts?: string;
+    /**
+     * The rule, as JSON text in the admin editor's shape.  Every entry in groups must hold, and inside a group one function is enough.
+     * @type {string}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    filter_profile_equation_json?: string;
+    /**
+     * The list and segment folder it is filed in, or absent.
+     * @type {string}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    folder_uuid?: string;
+    /**
+     * Send as If-Match on an update.  Covers the name, the rule and the folder.
+     * @type {string}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    hash_sha256?: string;
+    /**
+     * How many customers it held at its last rebuild.  Out of date while rebuild_required is true.
+     * @type {number}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    member_count?: number;
+    /**
+     * The segment name.
+     * @type {string}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    name?: string;
+    /**
+     * True when the rule has a date range, so the segment is also rebuilt every night.
+     * @type {boolean}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    rebuild_nightly?: boolean;
+    /**
+     * How far the current rebuild has got, when one is running.
+     * @type {number}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    rebuild_percentage?: number;
+    /**
+     * True when the rule changed and the segment has not finished rebuilding.
+     * @type {boolean}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    rebuild_required?: boolean;
+    /**
+     * The segment uuid.
+     * @type {string}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    segment_uuid?: string;
+    /**
+     * The campaigns that send to it and the flows it starts.
+     * @type {Array<SfvbCommsSegmentUsedBy>}
+     * @memberof SfvbCommsSegmentDetail
+     */
+    used_by?: Array<SfvbCommsSegmentUsedBy>;
+}
+/**
+ * Check if a given object implements the SfvbCommsSegmentDetail interface.
+ */
+export declare function instanceOfSfvbCommsSegmentDetail(value: object): boolean;
+export declare function SfvbCommsSegmentDetailFromJSON(json: any): SfvbCommsSegmentDetail;
+export declare function SfvbCommsSegmentDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbCommsSegmentDetail;
+export declare function SfvbCommsSegmentDetailToJSON(value?: SfvbCommsSegmentDetail | null): any;