ultracart_rest_api_v2_typescript 4.1.210 → 4.1.212

package/.openapi-generator/FILES

@@ -1196,6 +1196,9 @@ src/models/SfvbSecretRequest.ts
 src/models/SfvbSecretRequestCreate.ts
 src/models/SfvbSecretRequestsResponse.ts
 src/models/SfvbSecretSink.ts
+src/models/SfvbSequence.ts
+src/models/SfvbSequenceBranch.ts
+src/models/SfvbSequenceStep.ts
 src/models/SfvbServerLog.ts
 src/models/SfvbServerLogDetail.ts
 src/models/SfvbServerLogEntry.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.210
+## ultracart_rest_api_v2_typescript@4.1.212
 
 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.210 --save
+npm install ultracart_rest_api_v2_typescript@4.1.212 --save
 ```
 
 ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.212 | 10/27/2026 | conversation - pbx agent startup activity |
+| 4.1.211 | 10/27/2026 | sfvb internal testing |
 | 4.1.210 | 10/27/2026 | sfvb internal testing |
 | 4.1.209 | 10/27/2026 | sfvb internal testing |
 | 4.1.208 | 10/26/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, 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, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -415,6 +415,11 @@ export interface GetSfvbRedirectsRequest {
 export interface GetSfvbSecretRequestRequest {
     requestId: string;
 }
+export interface GetSfvbSequenceRequest {
+    storefrontOid: number;
+    sequenceUuid: string;
+    waiting?: boolean;
+}
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -2422,6 +2427,22 @@ export interface SfvbApiInterface {
      * List this sign-in\'s secret requests
      */
     getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * @summary Get a campaign\'s or flow\'s steps as a tree
+     * @param {number} storefrontOid
+     * @param {string} sequenceUuid
+     * @param {boolean} [waiting] Include how many customers are waiting on each step
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * @summary Get one storefront render log
@@ -5088,6 +5109,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * List this sign-in\'s secret requests
      */
     getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log

package/dist/apis/SfvbApi.js

@@ -6182,6 +6182,71 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    SfvbApi.prototype.getSfvbSequenceRaw = 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 getSfvbSequence.');
+                        }
+                        if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
+                            throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling getSfvbSequence.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.waiting !== undefined) {
+                            queryParameters['waiting'] = requestParameters.waiting;
+                        }
+                        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}/sequences/{sequence_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))),
+                                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.SfvbSequenceFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    SfvbApi.prototype.getSfvbSequence = 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.getSfvbSequenceRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log

package/dist/models/ConversationAgentAuth.d.ts

@@ -95,6 +95,12 @@ export interface ConversationAgentAuth {
      * @memberof ConversationAgentAuth
      */
     pbx_jwt?: string;
+    /**
+     * Status the agent starts in when the CRM loads
+     * @type {string}
+     * @memberof ConversationAgentAuth
+     */
+    pbx_startup_activity?: ConversationAgentAuthPbxStartupActivityEnum;
     /**
      *
      * @type {boolean}
@@ -150,6 +156,14 @@ export interface ConversationAgentAuth {
      */
     websocket_url?: string;
 }
+/**
+ * @export
+ */
+export declare const ConversationAgentAuthPbxStartupActivityEnum: {
+    readonly Available: "available";
+    readonly Unavailable: "unavailable";
+};
+export type ConversationAgentAuthPbxStartupActivityEnum = typeof ConversationAgentAuthPbxStartupActivityEnum[keyof typeof ConversationAgentAuthPbxStartupActivityEnum];
 /**
  * Check if a given object implements the ConversationAgentAuth interface.
  */

package/dist/models/ConversationAgentAuth.js

@@ -13,10 +13,17 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationAgentAuthToJSON = exports.ConversationAgentAuthFromJSONTyped = exports.ConversationAgentAuthFromJSON = exports.instanceOfConversationAgentAuth = void 0;
+exports.ConversationAgentAuthToJSON = exports.ConversationAgentAuthFromJSONTyped = exports.ConversationAgentAuthFromJSON = exports.instanceOfConversationAgentAuth = exports.ConversationAgentAuthPbxStartupActivityEnum = void 0;
 var runtime_1 = require("../runtime");
 var ConversationAgentAuthMerchant_1 = require("./ConversationAgentAuthMerchant");
 var ConversationTwilioAccount_1 = require("./ConversationTwilioAccount");
+/**
+ * @export
+ */
+exports.ConversationAgentAuthPbxStartupActivityEnum = {
+    Available: 'available',
+    Unavailable: 'unavailable'
+};
 /**
  * Check if a given object implements the ConversationAgentAuth interface.
  */
@@ -47,6 +54,7 @@ function ConversationAgentAuthFromJSONTyped(json, ignoreDiscriminator) {
         'parent_merchant_id': !(0, runtime_1.exists)(json, 'parent_merchant_id') ? undefined : json['parent_merchant_id'],
         'pbx_admin': !(0, runtime_1.exists)(json, 'pbx_admin') ? undefined : json['pbx_admin'],
         'pbx_jwt': !(0, runtime_1.exists)(json, 'pbx_jwt') ? undefined : json['pbx_jwt'],
+        'pbx_startup_activity': !(0, runtime_1.exists)(json, 'pbx_startup_activity') ? undefined : json['pbx_startup_activity'],
         'pbx_supervisor': !(0, runtime_1.exists)(json, 'pbx_supervisor') ? undefined : json['pbx_supervisor'],
         'pbx_user': !(0, runtime_1.exists)(json, 'pbx_user') ? undefined : json['pbx_user'],
         'pbx_voice_identity': !(0, runtime_1.exists)(json, 'pbx_voice_identity') ? undefined : json['pbx_voice_identity'],
@@ -80,6 +88,7 @@ function ConversationAgentAuthToJSON(value) {
         'parent_merchant_id': value.parent_merchant_id,
         'pbx_admin': value.pbx_admin,
         'pbx_jwt': value.pbx_jwt,
+        'pbx_startup_activity': value.pbx_startup_activity,
         'pbx_supervisor': value.pbx_supervisor,
         'pbx_user': value.pbx_user,
         'pbx_voice_identity': value.pbx_voice_identity,

package/dist/models/ConversationPbxAgent.d.ts

@@ -105,6 +105,12 @@ export interface ConversationPbxAgent {
      * @memberof ConversationPbxAgent
      */
     shared_conversation_pbx_voicemail_mailbox_uuid?: string;
+    /**
+     * Status the agent starts in when the CRM loads. Missing means available.
+     * @type {string}
+     * @memberof ConversationPbxAgent
+     */
+    startup_activity?: ConversationPbxAgentStartupActivityEnum;
     /**
      * Twilio taskrouter worker Id
      * @type {string}
@@ -163,6 +169,14 @@ export declare const ConversationPbxAgentCallRoutingPreferenceEnum: {
     readonly Cellphone: "cellphone";
 };
 export type ConversationPbxAgentCallRoutingPreferenceEnum = typeof ConversationPbxAgentCallRoutingPreferenceEnum[keyof typeof ConversationPbxAgentCallRoutingPreferenceEnum];
+/**
+ * @export
+ */
+export declare const ConversationPbxAgentStartupActivityEnum: {
+    readonly Available: "available";
+    readonly Unavailable: "unavailable";
+};
+export type ConversationPbxAgentStartupActivityEnum = typeof ConversationPbxAgentStartupActivityEnum[keyof typeof ConversationPbxAgentStartupActivityEnum];
 /**
  * @export
  */

package/dist/models/ConversationPbxAgent.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationPbxAgentToJSON = exports.ConversationPbxAgentFromJSONTyped = exports.ConversationPbxAgentFromJSON = exports.instanceOfConversationPbxAgent = exports.ConversationPbxAgentUnavailableSayVoiceEnum = exports.ConversationPbxAgentCallRoutingPreferenceEnum = void 0;
+exports.ConversationPbxAgentToJSON = exports.ConversationPbxAgentFromJSONTyped = exports.ConversationPbxAgentFromJSON = exports.instanceOfConversationPbxAgent = exports.ConversationPbxAgentUnavailableSayVoiceEnum = exports.ConversationPbxAgentStartupActivityEnum = exports.ConversationPbxAgentCallRoutingPreferenceEnum = void 0;
 var runtime_1 = require("../runtime");
 /**
  * @export
@@ -23,6 +23,13 @@ exports.ConversationPbxAgentCallRoutingPreferenceEnum = {
     HardwarePhone: 'hardware_phone',
     Cellphone: 'cellphone'
 };
+/**
+ * @export
+ */
+exports.ConversationPbxAgentStartupActivityEnum = {
+    Available: 'available',
+    Unavailable: 'unavailable'
+};
 /**
  * @export
  */
@@ -62,6 +69,7 @@ function ConversationPbxAgentFromJSONTyped(json, ignoreDiscriminator) {
         'preferred_hardware_phone_uuid': !(0, runtime_1.exists)(json, 'preferred_hardware_phone_uuid') ? undefined : json['preferred_hardware_phone_uuid'],
         'record_outgoing_automatically': !(0, runtime_1.exists)(json, 'record_outgoing_automatically') ? undefined : json['record_outgoing_automatically'],
         'shared_conversation_pbx_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'shared_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['shared_conversation_pbx_voicemail_mailbox_uuid'],
+        'startup_activity': !(0, runtime_1.exists)(json, 'startup_activity') ? undefined : json['startup_activity'],
         'twilio_taskrouter_worker_id': !(0, runtime_1.exists)(json, 'twilio_taskrouter_worker_id') ? undefined : json['twilio_taskrouter_worker_id'],
         'unavailable_play_audio_uuid': !(0, runtime_1.exists)(json, 'unavailable_play_audio_uuid') ? undefined : json['unavailable_play_audio_uuid'],
         'unavailable_say': !(0, runtime_1.exists)(json, 'unavailable_say') ? undefined : json['unavailable_say'],
@@ -96,6 +104,7 @@ function ConversationPbxAgentToJSON(value) {
         'preferred_hardware_phone_uuid': value.preferred_hardware_phone_uuid,
         'record_outgoing_automatically': value.record_outgoing_automatically,
         'shared_conversation_pbx_voicemail_mailbox_uuid': value.shared_conversation_pbx_voicemail_mailbox_uuid,
+        'startup_activity': value.startup_activity,
         'twilio_taskrouter_worker_id': value.twilio_taskrouter_worker_id,
         'unavailable_play_audio_uuid': value.unavailable_play_audio_uuid,
         'unavailable_say': value.unavailable_say,

package/dist/models/SfvbSequence.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { SfvbSequenceStep } from './SfvbSequenceStep';
+/**
+ *
+ * @export
+ * @interface SfvbSequence
+ */
+export interface SfvbSequence {
+    /**
+     * The sequence uuid.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    communication_sequence_uuid?: string;
+    /**
+     * True when its emails and postcards reach customers now.
+     * @type {boolean}
+     * @memberof SfvbSequence
+     */
+    live?: boolean;
+    /**
+     * Anything the read could not do, such as waiting counts that were unavailable.
+     * @type {Array<string>}
+     * @memberof SfvbSequence
+     */
+    notes?: Array<string>;
+    /**
+     * The campaign or flow name.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_name?: string;
+    /**
+     * The campaign or flow status.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_status?: string;
+    /**
+     * campaign or flow.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_type?: string;
+    /**
+     * The campaign or flow uuid.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_uuid?: string;
+    /**
+     * The steps from the start, in order.  A branching step holds its sides in branches.
+     * @type {Array<SfvbSequenceStep>}
+     * @memberof SfvbSequence
+     */
+    steps?: Array<SfvbSequenceStep>;
+    /**
+     * True when number_waiting was filled in.
+     * @type {boolean}
+     * @memberof SfvbSequence
+     */
+    waiting_included?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbSequence interface.
+ */
+export declare function instanceOfSfvbSequence(value: object): boolean;
+export declare function SfvbSequenceFromJSON(json: any): SfvbSequence;
+export declare function SfvbSequenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequence;
+export declare function SfvbSequenceToJSON(value?: SfvbSequence | null): any;

package/dist/models/SfvbSequence.js

@@ -0,0 +1,67 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbSequenceToJSON = exports.SfvbSequenceFromJSONTyped = exports.SfvbSequenceFromJSON = exports.instanceOfSfvbSequence = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSequenceStep_1 = require("./SfvbSequenceStep");
+/**
+ * Check if a given object implements the SfvbSequence interface.
+ */
+function instanceOfSfvbSequence(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSequence = instanceOfSfvbSequence;
+function SfvbSequenceFromJSON(json) {
+    return SfvbSequenceFromJSONTyped(json, false);
+}
+exports.SfvbSequenceFromJSON = SfvbSequenceFromJSON;
+function SfvbSequenceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'communication_sequence_uuid': !(0, runtime_1.exists)(json, 'communication_sequence_uuid') ? undefined : json['communication_sequence_uuid'],
+        'live': !(0, runtime_1.exists)(json, 'live') ? undefined : json['live'],
+        'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
+        'owner_name': !(0, runtime_1.exists)(json, 'owner_name') ? undefined : json['owner_name'],
+        'owner_status': !(0, runtime_1.exists)(json, 'owner_status') ? undefined : json['owner_status'],
+        'owner_type': !(0, runtime_1.exists)(json, 'owner_type') ? undefined : json['owner_type'],
+        'owner_uuid': !(0, runtime_1.exists)(json, 'owner_uuid') ? undefined : json['owner_uuid'],
+        'steps': !(0, runtime_1.exists)(json, 'steps') ? undefined : (json['steps'].map(SfvbSequenceStep_1.SfvbSequenceStepFromJSON)),
+        'waiting_included': !(0, runtime_1.exists)(json, 'waiting_included') ? undefined : json['waiting_included'],
+    };
+}
+exports.SfvbSequenceFromJSONTyped = SfvbSequenceFromJSONTyped;
+function SfvbSequenceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'communication_sequence_uuid': value.communication_sequence_uuid,
+        'live': value.live,
+        'notes': value.notes,
+        'owner_name': value.owner_name,
+        'owner_status': value.owner_status,
+        'owner_type': value.owner_type,
+        'owner_uuid': value.owner_uuid,
+        'steps': value.steps === undefined ? undefined : (value.steps.map(SfvbSequenceStep_1.SfvbSequenceStepToJSON)),
+        'waiting_included': value.waiting_included,
+    };
+}
+exports.SfvbSequenceToJSON = SfvbSequenceToJSON;

package/dist/models/SfvbSequenceBranch.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { SfvbSequenceStep } from './SfvbSequenceStep';
+/**
+ *
+ * @export
+ * @interface SfvbSequenceBranch
+ */
+export interface SfvbSequenceBranch {
+    /**
+     * yes or no for a condition, left or right for a split or an InboxGeek step.
+     * @type {string}
+     * @memberof SfvbSequenceBranch
+     */
+    label?: string;
+    /**
+     * The steps on this side, in order.
+     * @type {Array<SfvbSequenceStep>}
+     * @memberof SfvbSequenceBranch
+     */
+    steps?: Array<SfvbSequenceStep>;
+}
+/**
+ * Check if a given object implements the SfvbSequenceBranch interface.
+ */
+export declare function instanceOfSfvbSequenceBranch(value: object): boolean;
+export declare function SfvbSequenceBranchFromJSON(json: any): SfvbSequenceBranch;
+export declare function SfvbSequenceBranchFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceBranch;
+export declare function SfvbSequenceBranchToJSON(value?: SfvbSequenceBranch | null): any;

package/dist/models/SfvbSequenceBranch.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbSequenceBranchToJSON = exports.SfvbSequenceBranchFromJSONTyped = exports.SfvbSequenceBranchFromJSON = exports.instanceOfSfvbSequenceBranch = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSequenceStep_1 = require("./SfvbSequenceStep");
+/**
+ * Check if a given object implements the SfvbSequenceBranch interface.
+ */
+function instanceOfSfvbSequenceBranch(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSequenceBranch = instanceOfSfvbSequenceBranch;
+function SfvbSequenceBranchFromJSON(json) {
+    return SfvbSequenceBranchFromJSONTyped(json, false);
+}
+exports.SfvbSequenceBranchFromJSON = SfvbSequenceBranchFromJSON;
+function SfvbSequenceBranchFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'label': !(0, runtime_1.exists)(json, 'label') ? undefined : json['label'],
+        'steps': !(0, runtime_1.exists)(json, 'steps') ? undefined : (json['steps'].map(SfvbSequenceStep_1.SfvbSequenceStepFromJSON)),
+    };
+}
+exports.SfvbSequenceBranchFromJSONTyped = SfvbSequenceBranchFromJSONTyped;
+function SfvbSequenceBranchToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'label': value.label,
+        'steps': value.steps === undefined ? undefined : (value.steps.map(SfvbSequenceStep_1.SfvbSequenceStepToJSON)),
+    };
+}
+exports.SfvbSequenceBranchToJSON = SfvbSequenceBranchToJSON;