intercom-client 7.0.1 → 7.0.3

package/dist/esm/api/resources/unstable/resources/workflows/client/Client.d.mts

@@ -0,0 +1,39 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Intercom from "../../../../../index.mjs";
+export declare namespace WorkflowsClient {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Export workflow configurations from your workspace.
+ */
+export declare class WorkflowsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<WorkflowsClient.Options>;
+    constructor(options?: WorkflowsClient.Options);
+    /**
+     * Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.
+     *
+     * This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.
+     *
+     * {% admonition type="warning" name="Unstable API" %}
+     *   This API is currently in the Unstable version. Its behavior may change in future releases.
+     * {% /admonition %}
+     *
+     * @param {Intercom.unstable.ExportWorkflowRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.ForbiddenError}
+     * @throws {@link Intercom.unstable.NotFoundError}
+     *
+     * @example
+     *     await client.unstable.workflows.exportWorkflow({
+     *         id: "12345"
+     *     })
+     */
+    exportWorkflow(request: Intercom.unstable.ExportWorkflowRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<Intercom.unstable.WorkflowExport>;
+    private __exportWorkflow;
+}

package/dist/esm/api/resources/unstable/resources/workflows/client/Client.mjs

@@ -0,0 +1,85 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { normalizeClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as environments from "../../../../../../environments.mjs";
+import { handleNonStatusCodeError } from "../../../../../../errors/handleNonStatusCodeError.mjs";
+import * as errors from "../../../../../../errors/index.mjs";
+import * as Intercom from "../../../../../index.mjs";
+/**
+ * Export workflow configurations from your workspace.
+ */
+export class WorkflowsClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Export a workflow configuration by its ID. This endpoint returns the complete workflow definition including its steps, targeting rules, and attributes.
+     *
+     * This endpoint is designed for EU Data Act compliance, allowing customers to export their workflow configurations.
+     *
+     * {% admonition type="warning" name="Unstable API" %}
+     *   This API is currently in the Unstable version. Its behavior may change in future releases.
+     * {% /admonition %}
+     *
+     * @param {Intercom.unstable.ExportWorkflowRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.ForbiddenError}
+     * @throws {@link Intercom.unstable.NotFoundError}
+     *
+     * @example
+     *     await client.unstable.workflows.exportWorkflow({
+     *         id: "12345"
+     *     })
+     */
+    exportWorkflow(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__exportWorkflow(request, requestOptions));
+    }
+    __exportWorkflow(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const { id } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "Intercom-Version": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.version }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.IntercomEnvironment.UsProduction, `export/workflows/${core.url.encodePathParam(id)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 20) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 403:
+                        throw new Intercom.unstable.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Intercom.unstable.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.IntercomError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/export/workflows/{id}");
+        });
+    }
+}

package/dist/esm/api/resources/unstable/resources/workflows/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/unstable/resources/workflows/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/unstable/resources/workflows/client/requests/ExportWorkflowRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         id: "12345"
+ *     }
+ */
+export interface ExportWorkflowRequest {
+    /** The unique identifier for the workflow */
+    id: string;
+}

package/dist/esm/api/resources/unstable/resources/workflows/client/requests/ExportWorkflowRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/resources/workflows/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { ExportWorkflowRequest } from "./ExportWorkflowRequest.mjs";

package/dist/esm/api/resources/unstable/resources/workflows/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/unstable/resources/workflows/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/unstable/resources/workflows/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/unstable/types/ConversationAttributeUpdatedByAdmin.d.mts

@@ -11,7 +11,9 @@ export declare namespace ConversationAttributeUpdatedByAdmin {
         name?: string;
     }
     interface Value {
-        /** Value of the CDA updated */
+        /** Current value of the CDA updated */
         name?: string;
+        /** Previous value of the CDA */
+        previous?: string;
     }
 }

package/dist/esm/api/resources/unstable/types/ConversationAttributeUpdatedByUser.d.mts

@@ -0,0 +1,19 @@
+/**
+ * Contains details about Custom Data Attributes (CDAs) that were modified by a user for conversation part type <code>conversation_attribute_updated_by_user</code>.
+ */
+export interface ConversationAttributeUpdatedByUser {
+    attribute?: ConversationAttributeUpdatedByUser.Attribute;
+    value?: ConversationAttributeUpdatedByUser.Value;
+}
+export declare namespace ConversationAttributeUpdatedByUser {
+    interface Attribute {
+        /** Name of the CDA updated */
+        name?: string;
+    }
+    interface Value {
+        /** Current value of the CDA updated */
+        name?: string;
+        /** Previous value of the CDA (null for older events) */
+        previous?: string;
+    }
+}

package/dist/esm/api/resources/unstable/types/ConversationAttributeUpdatedByUser.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByRule.d.mts

@@ -0,0 +1,24 @@
+/**
+ * Contains details about SLA applied by modern Operator workflows for conversation part type <code>conversation_sla_applied_by_rule</code>.
+ */
+export interface ConversationSlaAppliedByRule {
+    /** Name of the SLA that was applied */
+    sla_name?: string;
+    /** Target times configured for the SLA (in seconds) */
+    sla_definition?: ConversationSlaAppliedByRule.SlaDefinition;
+}
+export declare namespace ConversationSlaAppliedByRule {
+    /**
+     * Target times configured for the SLA (in seconds)
+     */
+    interface SlaDefinition {
+        /** First response time target in seconds */
+        first_reply_time?: number;
+        /** Next reply time target in seconds */
+        next_reply_time?: number;
+        /** Resolution time target in seconds */
+        resolution_time?: number;
+        /** Time to close target in seconds */
+        time_to_close?: number;
+    }
+}

package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByRule.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByWorkflow.d.mts

@@ -0,0 +1,24 @@
+/**
+ * Contains details about SLA applied by legacy Inbox Rules for conversation part type <code>conversation_sla_applied_by_workflow</code>.
+ */
+export interface ConversationSlaAppliedByWorkflow {
+    /** Name of the SLA that was applied */
+    sla_name?: string;
+    /** Target times configured for the SLA (in seconds) */
+    sla_definition?: ConversationSlaAppliedByWorkflow.SlaDefinition;
+}
+export declare namespace ConversationSlaAppliedByWorkflow {
+    /**
+     * Target times configured for the SLA (in seconds)
+     */
+    interface SlaDefinition {
+        /** First response time target in seconds */
+        first_reply_time?: number;
+        /** Next reply time target in seconds */
+        next_reply_time?: number;
+        /** Resolution time target in seconds */
+        resolution_time?: number;
+        /** Time to close target in seconds */
+        time_to_close?: number;
+    }
+}

package/dist/esm/api/resources/unstable/types/ConversationSlaAppliedByWorkflow.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/ConversationSlaPaused.d.mts

@@ -0,0 +1,29 @@
+/**
+ * Contains SLA status at the moment of pausing for conversation part type <code>conversation_sla_paused</code>.
+ */
+export interface ConversationSlaPaused {
+    /** Name of the SLA being paused */
+    sla_name?: string;
+    /** Overall SLA status at pause time */
+    current_sla_status?: ConversationSlaPaused.CurrentSlaStatus;
+    /** Status of all SLA targets at pause time */
+    sla_states?: Record<string, ConversationSlaPaused.SlaStates.Value>;
+}
+export declare namespace ConversationSlaPaused {
+    /** Overall SLA status at pause time */
+    const CurrentSlaStatus: {
+        readonly Active: "active";
+        readonly Hit: "hit";
+        readonly Missed: "missed";
+        readonly Canceled: "canceled";
+    };
+    type CurrentSlaStatus = (typeof CurrentSlaStatus)[keyof typeof CurrentSlaStatus];
+    namespace SlaStates {
+        interface Value {
+            /** Status of this specific target (always paused) */
+            status?: "paused";
+            /** Time remaining when paused */
+            seconds_remaining?: number;
+        }
+    }
+}

package/dist/esm/api/resources/unstable/types/ConversationSlaPaused.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ConversationSlaPaused;
+(function (ConversationSlaPaused) {
+    /** Overall SLA status at pause time */
+    ConversationSlaPaused.CurrentSlaStatus = {
+        Active: "active",
+        Hit: "hit",
+        Missed: "missed",
+        Canceled: "canceled",
+    };
+})(ConversationSlaPaused || (ConversationSlaPaused = {}));

package/dist/esm/api/resources/unstable/types/ConversationSlaRemoved.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Contains basic SLA information when removed for conversation part type <code>conversation_sla_removed</code>.
+ */
+export interface ConversationSlaRemoved {
+    /** Name of the SLA that was removed */
+    sla_name?: string;
+}

package/dist/esm/api/resources/unstable/types/ConversationSlaRemoved.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/ConversationSlaTargetMissed.d.mts

@@ -0,0 +1,50 @@
+/**
+ * Contains complete status of all SLA targets when a breach occurs for conversation part type <code>conversation_sla_target_missed</code>.
+ */
+export interface ConversationSlaTargetMissed {
+    /** Name of the SLA */
+    sla_name?: string;
+    /** Which specific target was missed */
+    sla_target_type?: ConversationSlaTargetMissed.SlaTargetType;
+    /** Overall SLA status */
+    current_sla_status?: ConversationSlaTargetMissed.CurrentSlaStatus;
+    /** Status of all SLA targets at the time of breach */
+    sla_states?: Record<string, ConversationSlaTargetMissed.SlaStates.Value>;
+}
+export declare namespace ConversationSlaTargetMissed {
+    /** Which specific target was missed */
+    const SlaTargetType: {
+        readonly FirstReplyTime: "first_reply_time";
+        readonly NextReplyTime: "next_reply_time";
+        readonly ResolutionTime: "resolution_time";
+        readonly TimeToClose: "time_to_close";
+    };
+    type SlaTargetType = (typeof SlaTargetType)[keyof typeof SlaTargetType];
+    /** Overall SLA status */
+    const CurrentSlaStatus: {
+        readonly Hit: "hit";
+        readonly Missed: "missed";
+        readonly Active: "active";
+        readonly Paused: "paused";
+        readonly Canceled: "canceled";
+    };
+    type CurrentSlaStatus = (typeof CurrentSlaStatus)[keyof typeof CurrentSlaStatus];
+    namespace SlaStates {
+        interface Value {
+            /** Status of this specific target */
+            status?: Value.Status;
+            /** Time remaining for active/paused targets (null for hit/missed) */
+            seconds_remaining?: number;
+        }
+        namespace Value {
+            /** Status of this specific target */
+            const Status: {
+                readonly Hit: "hit";
+                readonly Missed: "missed";
+                readonly Active: "active";
+                readonly Paused: "paused";
+            };
+            type Status = (typeof Status)[keyof typeof Status];
+        }
+    }
+}

package/dist/esm/api/resources/unstable/types/ConversationSlaTargetMissed.mjs

@@ -0,0 +1,32 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ConversationSlaTargetMissed;
+(function (ConversationSlaTargetMissed) {
+    /** Which specific target was missed */
+    ConversationSlaTargetMissed.SlaTargetType = {
+        FirstReplyTime: "first_reply_time",
+        NextReplyTime: "next_reply_time",
+        ResolutionTime: "resolution_time",
+        TimeToClose: "time_to_close",
+    };
+    /** Overall SLA status */
+    ConversationSlaTargetMissed.CurrentSlaStatus = {
+        Hit: "hit",
+        Missed: "missed",
+        Active: "active",
+        Paused: "paused",
+        Canceled: "canceled",
+    };
+    let SlaStates;
+    (function (SlaStates) {
+        let Value;
+        (function (Value) {
+            /** Status of this specific target */
+            Value.Status = {
+                Hit: "hit",
+                Missed: "missed",
+                Active: "active",
+                Paused: "paused",
+            };
+        })(Value = SlaStates.Value || (SlaStates.Value = {}));
+    })(SlaStates = ConversationSlaTargetMissed.SlaStates || (ConversationSlaTargetMissed.SlaStates = {}));
+})(ConversationSlaTargetMissed || (ConversationSlaTargetMissed = {}));

package/dist/esm/api/resources/unstable/types/ConversationSlaUnpaused.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Contains basic SLA information when unpaused for conversation part type <code>conversation_sla_unpaused</code>.
+ */
+export interface ConversationSlaUnpaused {
+    /** Name of the SLA being unpaused */
+    sla_name?: string;
+}

package/dist/esm/api/resources/unstable/types/ConversationSlaUnpaused.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/ConversationTagsUpdated.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Contains details about tags that were added or removed from a conversation for conversation part type <code>conversation_tags_updated</code>.
+ */
+export interface ConversationTagsUpdated {
+    /** Array of tag names that were added */
+    tags_added?: string[];
+    /** Array of tag names that were removed */
+    tags_removed?: string[];
+}

package/dist/esm/api/resources/unstable/types/ConversationTagsUpdated.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/EventDetails.d.mts

@@ -1,2 +1,2 @@
 import type * as Intercom from "../../../index.mjs";
-export type EventDetails = Intercom.unstable.ConversationAttributeUpdatedByWorkflow | Intercom.unstable.ConversationAttributeUpdatedByAdmin | Intercom.unstable.CustomActionStarted | Intercom.unstable.CustomActionFinished | Intercom.unstable.OperatorWorkflowEvent;
+export type EventDetails = Intercom.unstable.ConversationAttributeUpdatedByWorkflow | Intercom.unstable.ConversationAttributeUpdatedByAdmin | Intercom.unstable.ConversationAttributeUpdatedByUser | Intercom.unstable.CustomActionStarted | Intercom.unstable.CustomActionFinished | Intercom.unstable.OperatorWorkflowEvent | Intercom.unstable.ConversationTagsUpdated | Intercom.unstable.Snoozed | Intercom.unstable.PriorityChanged | Intercom.unstable.ConversationSlaAppliedByRule | Intercom.unstable.ConversationSlaAppliedByWorkflow | Intercom.unstable.ConversationSlaTargetMissed | Intercom.unstable.ConversationSlaPaused | Intercom.unstable.ConversationSlaUnpaused | Intercom.unstable.ConversationSlaRemoved;

package/dist/esm/api/resources/unstable/types/HandlingEvent.d.mts

@@ -0,0 +1,21 @@
+import type * as Intercom from "../../../index.mjs";
+/**
+ * A pause or resume event for a conversation
+ */
+export interface HandlingEvent {
+    teammate: Intercom.unstable.TeammateReference;
+    /** The type of handling event */
+    type: HandlingEvent.Type;
+    /** ISO8601 timestamp when the event occurred */
+    timestamp: string;
+    /** Optional reason for the event (e.g., "Paused", "Away") */
+    reason?: string;
+}
+export declare namespace HandlingEvent {
+    /** The type of handling event */
+    const Type: {
+        readonly Paused: "paused";
+        readonly Resumed: "resumed";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/esm/api/resources/unstable/types/HandlingEvent.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var HandlingEvent;
+(function (HandlingEvent) {
+    /** The type of handling event */
+    HandlingEvent.Type = {
+        Paused: "paused",
+        Resumed: "resumed",
+    };
+})(HandlingEvent || (HandlingEvent = {}));

package/dist/esm/api/resources/unstable/types/HandlingEventList.d.mts

@@ -0,0 +1,8 @@
+import type * as Intercom from "../../../index.mjs";
+/**
+ * A list of handling events for a conversation
+ */
+export interface HandlingEventList {
+    /** Array of handling events */
+    handling_events?: Intercom.unstable.HandlingEvent[];
+}

package/dist/esm/api/resources/unstable/types/HandlingEventList.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/PriorityChanged.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Contains details about priority changes for conversation part type <code>priority_changed</code>.
+ */
+export interface PriorityChanged {
+    /** Current priority state */
+    current_priority?: PriorityChanged.CurrentPriority;
+    /** Previous priority state */
+    previous_priority?: PriorityChanged.PreviousPriority;
+}
+export declare namespace PriorityChanged {
+    /** Current priority state */
+    const CurrentPriority: {
+        readonly Priority: "priority";
+        readonly NotPriority: "not_priority";
+    };
+    type CurrentPriority = (typeof CurrentPriority)[keyof typeof CurrentPriority];
+    /** Previous priority state */
+    const PreviousPriority: {
+        readonly Priority: "priority";
+        readonly NotPriority: "not_priority";
+    };
+    type PreviousPriority = (typeof PreviousPriority)[keyof typeof PreviousPriority];
+}

package/dist/esm/api/resources/unstable/types/PriorityChanged.mjs

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+export var PriorityChanged;
+(function (PriorityChanged) {
+    /** Current priority state */
+    PriorityChanged.CurrentPriority = {
+        Priority: "priority",
+        NotPriority: "not_priority",
+    };
+    /** Previous priority state */
+    PriorityChanged.PreviousPriority = {
+        Priority: "priority",
+        NotPriority: "not_priority",
+    };
+})(PriorityChanged || (PriorityChanged = {}));

package/dist/esm/api/resources/unstable/types/Snoozed.d.mts

@@ -0,0 +1,9 @@
+/**
+ * Contains details about conversation snooze timing for conversation part type <code>snoozed</code>.
+ */
+export interface Snoozed {
+    /** Human-readable description of snooze duration */
+    until?: string;
+    /** ISO timestamp for custom snooze times (null for general snoozes) */
+    custom_until_time?: string;
+}

package/dist/esm/api/resources/unstable/types/Snoozed.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/unstable/types/TeammateReference.d.mts

@@ -0,0 +1,22 @@
+/**
+ * A reference to a teammate (admin, team, or bot)
+ */
+export interface TeammateReference {
+    /** The type of teammate */
+    type: TeammateReference.Type;
+    /** The unique identifier of the teammate */
+    id: number;
+    /** The display name of the teammate */
+    name: string;
+    /** The email address of the teammate (optional for teams/bots) */
+    email?: string;
+}
+export declare namespace TeammateReference {
+    /** The type of teammate */
+    const Type: {
+        readonly Admin: "admin";
+        readonly Team: "team";
+        readonly Bot: "bot";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

package/dist/esm/api/resources/unstable/types/TeammateReference.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export var TeammateReference;
+(function (TeammateReference) {
+    /** The type of teammate */
+    TeammateReference.Type = {
+        Admin: "admin",
+        Team: "team",
+        Bot: "bot",
+    };
+})(TeammateReference || (TeammateReference = {}));

package/dist/esm/api/resources/unstable/types/WorkflowExport.d.mts

@@ -0,0 +1,55 @@
+/**
+ * A workflow export containing the complete workflow configuration.
+ */
+export interface WorkflowExport {
+    /** The version of the export format. */
+    export_version?: string;
+    /** The timestamp when the export was generated. */
+    exported_at?: string;
+    /** The workspace identifier. */
+    app_id?: number;
+    /** The workflow configuration. */
+    workflow?: WorkflowExport.Workflow;
+}
+export declare namespace WorkflowExport {
+    /**
+     * The workflow configuration.
+     */
+    interface Workflow {
+        /** The unique identifier for the workflow. */
+        id?: string;
+        /** The title of the workflow. */
+        title?: string;
+        /** The description of the workflow. */
+        description?: string;
+        /** The type of trigger that starts this workflow. */
+        trigger_type?: string;
+        /** The current state of the workflow. */
+        state?: Workflow.State;
+        /** The channels this workflow targets. */
+        target_channels?: string[];
+        /** The preferred devices for this workflow. */
+        preferred_devices?: string[];
+        /** When the workflow was created. */
+        created_at?: string;
+        /** When the workflow was last updated. */
+        updated_at?: string;
+        /** The targeting rules for this workflow. */
+        targeting?: Record<string, unknown>;
+        /** The current snapshot of workflow steps and configuration. */
+        snapshot?: Record<string, unknown>;
+        /** Custom attributes defined for this workflow. */
+        attributes?: Record<string, unknown>[];
+        /** Rules embedded within the workflow steps. */
+        embedded_rules?: Record<string, unknown>[];
+    }
+    namespace Workflow {
+        /** The current state of the workflow. */
+        const State: {
+            readonly Live: "live";
+            readonly Draft: "draft";
+            readonly Paused: "paused";
+        };
+        type State = (typeof State)[keyof typeof State];
+    }
+}

package/dist/esm/api/resources/unstable/types/WorkflowExport.mjs

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+export var WorkflowExport;
+(function (WorkflowExport) {
+    let Workflow;
+    (function (Workflow) {
+        /** The current state of the workflow. */
+        Workflow.State = {
+            Live: "live",
+            Draft: "draft",
+            Paused: "paused",
+        };
+    })(Workflow = WorkflowExport.Workflow || (WorkflowExport.Workflow = {}));
+})(WorkflowExport || (WorkflowExport = {}));