@lessly/sdk-app 78.0.0 → 79.0.0

package/dist/_types/gen/types.gen.d.ts

@@ -97404,6 +97404,30 @@ export interface SupportLabelCreateOutput {
      */
     createdAt: string;
 }
+export interface SupportLabelGetInput {
+    /**
+     * Label id
+     */
+    id: string;
+}
+export interface SupportLabelGetOutput {
+    /**
+     * Label id
+     */
+    id: string;
+    /**
+     * Label name, unique within the product
+     */
+    name: string;
+    /**
+     * Display colour as a hex string, or null if uncoloured
+     */
+    color: (string | null);
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+}
 export interface SupportLabelListInput {
 }
 export interface SupportLabelListOutput {
@@ -97515,10 +97539,95 @@ export interface SupportMessageCreateOutput {
          */
         downloadUrl: string;
     }[];
+    /**
+     * The same files as a flat list of ids, in the order attachments[] has them. This is the value support_message_create takes back; attachments.0.id names only the first file
+     */
+    attachmentIds: string[];
+    /**
+     * The agent author, or null when the external end user wrote the message
+     */
+    authorAgentId: (string | null);
+    /**
+     * How many files this message carries, 0 when it carries none. A dot-path has no length, so this is the only way a step can branch on whether there are files at all — and a message may carry a file and no body, so it is what tells those two messages apart
+     */
+    attachmentCount: number;
+    /**
+     * The external author, or null when an agent wrote the message
+     */
+    authorExternalId: (string | null);
+}
+export interface SupportMessageGetInput {
+    /**
+     * Message id
+     */
+    id: string;
+}
+export interface SupportMessageGetOutput {
+    /**
+     * Message id
+     */
+    id: string;
+    /**
+     * The message text, byte-identical to what was stored
+     */
+    body: string;
+    /**
+     * Thread this message belongs to
+     */
+    threadId: string;
+    /**
+     * ISO-8601 creation timestamp
+     */
+    createdAt: string;
+    /**
+     * inbound: written by the external end user. outbound: written by support, going out to them
+     */
+    direction: ("inbound" | "outbound");
+    /**
+     * public: part of the conversation the external end user sees. internal: a note between agents that never leaves the support contour
+     */
+    visibility: ("public" | "internal");
+    /**
+     * Files this message carries, each with a freshly signed download URL. Empty when there are none. Attachments whose upload was never confirmed are never listed here
+     */
+    attachments: {
+        /**
+         * Attachment id
+         */
+        id: string;
+        /**
+         * Display name of the file
+         */
+        fileName: string;
+        /**
+         * ISO-8601 timestamp of when the attachment was created
+         */
+        createdAt: string;
+        /**
+         * Size in bytes as reported by storage
+         */
+        sizeBytes: number;
+        /**
+         * MIME type of the file
+         */
+        contentType: string;
+        /**
+         * Short-lived signed URL to read the file. Re-read the message to get a fresh one
+         */
+        downloadUrl: string;
+    }[];
+    /**
+     * The same files as a flat list of ids, in the order attachments[] has them. This is the value support_message_create takes back; attachments.0.id names only the first file
+     */
+    attachmentIds: string[];
     /**
      * The agent author, or null when the external end user wrote the message
      */
     authorAgentId: (string | null);
+    /**
+     * How many files this message carries, 0 when it carries none. A dot-path has no length, so this is the only way a step can branch on whether there are files at all — and a message may carry a file and no body, so it is what tells those two messages apart
+     */
+    attachmentCount: number;
     /**
      * The external author, or null when an agent wrote the message
      */
@@ -97620,10 +97729,18 @@ export interface SupportMessageListOutput {
              */
             downloadUrl: string;
         }[];
+        /**
+         * The same files as a flat list of ids, in the order attachments[] has them. This is the value support_message_create takes back; attachments.0.id names only the first file
+         */
+        attachmentIds: string[];
         /**
          * The agent author, or null when the external end user wrote the message
          */
         authorAgentId: (string | null);
+        /**
+         * How many files this message carries, 0 when it carries none. A dot-path has no length, so this is the only way a step can branch on whether there are files at all — and a message may carry a file and no body, so it is what tells those two messages apart
+         */
+        attachmentCount: number;
         /**
          * The external author, or null when an agent wrote the message
          */
@@ -97711,6 +97828,10 @@ export interface SupportResponseEscalateOutput {
              */
             category: ("open" | "pending" | "resolved" | "closed");
         };
+        /**
+         * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+         */
+        labelIds: string[];
         /**
          * Free-form client-owned JSON
          */
@@ -97733,6 +97854,10 @@ export interface SupportResponseEscalateOutput {
          * ISO-8601 last-modification timestamp
          */
         updatedAt: string;
+        /**
+         * The same labels as a flat list of names, in the order labels[] has them
+         */
+        labelNames: string[];
         /**
          * ISO-8601 timestamp of the last reply, or null while there are none
          */
@@ -97958,14 +98083,23 @@ export interface SupportRuleCreateInput {
      * When to show the survey once the page matches
      */
     trigger: ({
+        /**
+         * An immediate trigger, with nothing else to set
+         */
         kind: "immediate";
     } | {
+        /**
+         * A delayed trigger, which needs seconds
+         */
         kind: "delay";
         /**
          * How long to wait after the page matched, in seconds (at most a day)
          */
         seconds: number;
     } | {
+        /**
+         * An event trigger, which needs the event name
+         */
         kind: "event";
         /**
          * An event in the client’s own runtime. This toolkit never sees it
@@ -100969,6 +101103,9 @@ export interface SupportRuleCreateInput {
         }
     ];
 }
+/**
+ * One delivery rule: which pages get which survey, when, how often, and to whom
+ */
 export interface SupportRuleCreateOutput {
     /**
      * Rule id
@@ -100982,6 +101119,9 @@ export interface SupportRuleCreateOutput {
      * Whether the rule is live
      */
     enabled: boolean;
+    /**
+     * When the client’s runtime shows the survey once the page matches: immediately, after a delay, or on an event of its own
+     */
     trigger: {
         /**
          * Which kind of trigger this is
@@ -101008,13 +101148,22 @@ export interface SupportRuleCreateOutput {
          * exact: the whole URL, character for character. prefix: the URL starts with the value. contains: the value appears anywhere in the URL. regex: a JavaScript regular expression, applied unanchored — write ^ yourself if you mean the start
          */
         kind: ("exact" | "prefix" | "contains" | "regex");
+        /**
+         * What the URL is compared against, read according to kind
+         */
         value: string;
     };
     /**
      * ISO-8601 creation timestamp
      */
     createdAt: string;
+    /**
+     * How often the same person may see this survey. The client’s runtime enforces it — this toolkit never sees the end user
+     */
     frequency: {
+        /**
+         * once: show it a single time, ever. until_answered: keep showing it until they respond. always: show it every time the rule matches
+         */
         kind: ("once" | "until_answered" | "always");
         /**
          * Days between showings, when set
@@ -104014,6 +104163,9 @@ export interface SupportRuleGetInput {
      */
     id: string;
 }
+/**
+ * One delivery rule: which pages get which survey, when, how often, and to whom
+ */
 export interface SupportRuleGetOutput {
     /**
      * Rule id
@@ -104027,6 +104179,9 @@ export interface SupportRuleGetOutput {
      * Whether the rule is live
      */
     enabled: boolean;
+    /**
+     * When the client’s runtime shows the survey once the page matches: immediately, after a delay, or on an event of its own
+     */
     trigger: {
         /**
          * Which kind of trigger this is
@@ -104053,13 +104208,22 @@ export interface SupportRuleGetOutput {
          * exact: the whole URL, character for character. prefix: the URL starts with the value. contains: the value appears anywhere in the URL. regex: a JavaScript regular expression, applied unanchored — write ^ yourself if you mean the start
          */
         kind: ("exact" | "prefix" | "contains" | "regex");
+        /**
+         * What the URL is compared against, read according to kind
+         */
         value: string;
     };
     /**
      * ISO-8601 creation timestamp
      */
     createdAt: string;
+    /**
+     * How often the same person may see this survey. The client’s runtime enforces it — this toolkit never sees the end user
+     */
     frequency: {
+        /**
+         * once: show it a single time, ever. until_answered: keep showing it until they respond. always: show it every time the rule matches
+         */
         kind: ("once" | "until_answered" | "always");
         /**
          * Days between showings, when set
@@ -107084,6 +107248,9 @@ export interface SupportRuleListOutput {
          * Whether the rule is live
          */
         enabled: boolean;
+        /**
+         * When the client’s runtime shows the survey once the page matches: immediately, after a delay, or on an event of its own
+         */
         trigger: {
             /**
              * Which kind of trigger this is
@@ -107110,13 +107277,22 @@ export interface SupportRuleListOutput {
              * exact: the whole URL, character for character. prefix: the URL starts with the value. contains: the value appears anywhere in the URL. regex: a JavaScript regular expression, applied unanchored — write ^ yourself if you mean the start
              */
             kind: ("exact" | "prefix" | "contains" | "regex");
+            /**
+             * What the URL is compared against, read according to kind
+             */
             value: string;
         };
         /**
          * ISO-8601 creation timestamp
          */
         createdAt: string;
+        /**
+         * How often the same person may see this survey. The client’s runtime enforces it — this toolkit never sees the end user
+         */
         frequency: {
+            /**
+             * once: show it a single time, ever. until_answered: keep showing it until they respond. always: show it every time the rule matches
+             */
             kind: ("once" | "until_answered" | "always");
             /**
              * Days between showings, when set
@@ -110116,14 +110292,23 @@ export interface SupportRuleUpdateInput {
      * The new trigger, replacing the old one
      */
     trigger?: ({
+        /**
+         * An immediate trigger, with nothing else to set
+         */
         kind: "immediate";
     } | {
+        /**
+         * A delayed trigger, which needs seconds
+         */
         kind: "delay";
         /**
          * How long to wait after the page matched, in seconds (at most a day)
          */
         seconds: number;
     } | {
+        /**
+         * An event trigger, which needs the event name
+         */
         kind: "event";
         /**
          * An event in the client’s own runtime. This toolkit never sees it
@@ -113123,6 +113308,9 @@ export interface SupportRuleUpdateInput {
         }
     ];
 }
+/**
+ * One delivery rule: which pages get which survey, when, how often, and to whom
+ */
 export interface SupportRuleUpdateOutput {
     /**
      * Rule id
@@ -113136,6 +113324,9 @@ export interface SupportRuleUpdateOutput {
      * Whether the rule is live
      */
     enabled: boolean;
+    /**
+     * When the client’s runtime shows the survey once the page matches: immediately, after a delay, or on an event of its own
+     */
     trigger: {
         /**
          * Which kind of trigger this is
@@ -113162,13 +113353,22 @@ export interface SupportRuleUpdateOutput {
          * exact: the whole URL, character for character. prefix: the URL starts with the value. contains: the value appears anywhere in the URL. regex: a JavaScript regular expression, applied unanchored — write ^ yourself if you mean the start
          */
         kind: ("exact" | "prefix" | "contains" | "regex");
+        /**
+         * What the URL is compared against, read according to kind
+         */
         value: string;
     };
     /**
      * ISO-8601 creation timestamp
      */
     createdAt: string;
+    /**
+     * How often the same person may see this survey. The client’s runtime enforces it — this toolkit never sees the end user
+     */
     frequency: {
+        /**
+         * once: show it a single time, ever. until_answered: keep showing it until they respond. always: show it every time the rule matches
+         */
         kind: ("once" | "until_answered" | "always");
         /**
          * Days between showings, when set
@@ -116226,6 +116426,38 @@ export interface SupportStatusCreateOutput {
      */
     category: ("open" | "pending" | "resolved" | "closed");
 }
+export interface SupportStatusGetInput {
+    /**
+     * Status id
+     */
+    id: string;
+}
+export interface SupportStatusGetOutput {
+    /**
+     * Status id
+     */
+    id: string;
+    /**
+     * Status name, unique within the product
+     */
+    name: string;
+    /**
+     * Display colour as a hex string
+     */
+    color: string;
+    /**
+     * Sort order within the status dictionary
+     */
+    order: number;
+    /**
+     * Archived statuses stay readable but are not offered as targets
+     */
+    archived: boolean;
+    /**
+     * Lifecycle bucket the status belongs to
+     */
+    category: ("open" | "pending" | "resolved" | "closed");
+}
 export interface SupportStatusListInput {
     /**
      * Also return archived statuses (default false)
@@ -116406,6 +116638,14 @@ export interface SupportSurveyArchiveOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same questions as a flat list of ids, in the order they are asked
+     */
+    questionIds: string[];
+    /**
+     * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+     */
+    questionCount: number;
 }
 export interface SupportSurveyCreateInput {
     /**
@@ -116572,6 +116812,14 @@ export interface SupportSurveyCreateOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same questions as a flat list of ids, in the order they are asked
+     */
+    questionIds: string[];
+    /**
+     * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+     */
+    questionCount: number;
 }
 export interface SupportSurveyGetInput {
     /**
@@ -116668,6 +116916,14 @@ export interface SupportSurveyGetOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same questions as a flat list of ids, in the order they are asked
+     */
+    questionIds: string[];
+    /**
+     * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+     */
+    questionCount: number;
 }
 export interface SupportSurveyListInput {
     /**
@@ -116784,6 +117040,14 @@ export interface SupportSurveyListOutput {
          * ISO-8601 last-modification timestamp
          */
         updatedAt: string;
+        /**
+         * The same questions as a flat list of ids, in the order they are asked
+         */
+        questionIds: string[];
+        /**
+         * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+         */
+        questionCount: number;
     }[];
 }
 export interface SupportSurveyPublishInput {
@@ -116881,6 +117145,14 @@ export interface SupportSurveyPublishOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same questions as a flat list of ids, in the order they are asked
+     */
+    questionIds: string[];
+    /**
+     * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+     */
+    questionCount: number;
 }
 export interface SupportSurveyStatsInput {
     /**
@@ -117102,6 +117374,14 @@ export interface SupportSurveyUnpublishOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same questions as a flat list of ids, in the order they are asked
+     */
+    questionIds: string[];
+    /**
+     * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+     */
+    questionCount: number;
 }
 export interface SupportSurveyUpdateInput {
     /**
@@ -117272,6 +117552,14 @@ export interface SupportSurveyUpdateOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same questions as a flat list of ids, in the order they are asked
+     */
+    questionIds: string[];
+    /**
+     * How many questions this survey asks — the same field support/survey.published carries, so a workflow built from the trigger and one built from a get-step bind one shape
+     */
+    questionCount: number;
 }
 export interface SupportThreadAssignInput {
     /**
@@ -117350,6 +117638,10 @@ export interface SupportThreadAssignOutput {
          */
         category: ("open" | "pending" | "resolved" | "closed");
     };
+    /**
+     * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+     */
+    labelIds: string[];
     /**
      * Free-form client-owned JSON
      */
@@ -117372,6 +117664,10 @@ export interface SupportThreadAssignOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same labels as a flat list of names, in the order labels[] has them
+     */
+    labelNames: string[];
     /**
      * ISO-8601 timestamp of the last reply, or null while there are none
      */
@@ -117490,6 +117786,10 @@ export interface SupportThreadCreateOutput {
          */
         category: ("open" | "pending" | "resolved" | "closed");
     };
+    /**
+     * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+     */
+    labelIds: string[];
     /**
      * Free-form client-owned JSON
      */
@@ -117512,6 +117812,10 @@ export interface SupportThreadCreateOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same labels as a flat list of names, in the order labels[] has them
+     */
+    labelNames: string[];
     /**
      * ISO-8601 timestamp of the last reply, or null while there are none
      */
@@ -117602,6 +117906,10 @@ export interface SupportThreadGetOutput {
          */
         category: ("open" | "pending" | "resolved" | "closed");
     };
+    /**
+     * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+     */
+    labelIds: string[];
     /**
      * Free-form client-owned JSON
      */
@@ -117624,6 +117932,10 @@ export interface SupportThreadGetOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same labels as a flat list of names, in the order labels[] has them
+     */
+    labelNames: string[];
     /**
      * ISO-8601 timestamp of the last reply, or null while there are none
      */
@@ -117774,6 +118086,10 @@ export interface SupportThreadListOutput {
              */
             category: ("open" | "pending" | "resolved" | "closed");
         };
+        /**
+         * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+         */
+        labelIds: string[];
         /**
          * Free-form client-owned JSON
          */
@@ -117796,6 +118112,10 @@ export interface SupportThreadListOutput {
          * ISO-8601 last-modification timestamp
          */
         updatedAt: string;
+        /**
+         * The same labels as a flat list of names, in the order labels[] has them
+         */
+        labelNames: string[];
         /**
          * ISO-8601 timestamp of the last reply, or null while there are none
          */
@@ -117891,6 +118211,10 @@ export interface SupportThreadStatusSetOutput {
          */
         category: ("open" | "pending" | "resolved" | "closed");
     };
+    /**
+     * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+     */
+    labelIds: string[];
     /**
      * Free-form client-owned JSON
      */
@@ -117913,6 +118237,10 @@ export interface SupportThreadStatusSetOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same labels as a flat list of names, in the order labels[] has them
+     */
+    labelNames: string[];
     /**
      * ISO-8601 timestamp of the last reply, or null while there are none
      */
@@ -118023,6 +118351,10 @@ export interface SupportThreadUpdateOutput {
          */
         category: ("open" | "pending" | "resolved" | "closed");
     };
+    /**
+     * The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
+     */
+    labelIds: string[];
     /**
      * Free-form client-owned JSON
      */
@@ -118045,6 +118377,10 @@ export interface SupportThreadUpdateOutput {
      * ISO-8601 last-modification timestamp
      */
     updatedAt: string;
+    /**
+     * The same labels as a flat list of names, in the order labels[] has them
+     */
+    labelNames: string[];
     /**
      * ISO-8601 timestamp of the last reply, or null while there are none
      */