@joinskips/brand 9.0.0-develop.148 → 9.0.0-develop.149

package/chat/chat/generated/skips-app/types.gen.d.ts

@@ -0,0 +1,733 @@
+export type ClientOptions = {
+    baseUrl: string;
+};
+export type PublicContact = {
+    /**
+     * Id of the contact
+     */
+    id?: number;
+    /**
+     * The session identifier of the contact
+     */
+    source_id?: string;
+    /**
+     * Name of the contact when available
+     */
+    name?: string | null;
+    /**
+     * Email of the contact
+     */
+    email?: string | null;
+    /**
+     * Phone number of the contact
+     */
+    phone_number?: string | null;
+    /**
+     * The token to be used to connect to skips websocket
+     */
+    pubsub_token?: string;
+};
+/**
+ * Full serialized contact record returned when the public API renders a Contact model directly.
+ */
+export type PublicContactRecord = {
+    /**
+     * Id of the contact
+     */
+    id?: number;
+    /**
+     * Name of the contact when available
+     */
+    name?: string | null;
+    /**
+     * Email of the contact
+     */
+    email?: string | null;
+    /**
+     * Phone number of the contact
+     */
+    phone_number?: string | null;
+    /**
+     * Identifier of the contact
+     */
+    identifier?: string | null;
+    /**
+     * Whether the contact is blocked
+     */
+    blocked?: boolean;
+    /**
+     * Additional attributes of the contact when present
+     */
+    additional_attributes?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Custom attributes of the contact when present
+     */
+    custom_attributes?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Contact type of the contact when available
+     */
+    contact_type?: string | null;
+    /**
+     * Country code of the contact
+     */
+    country_code?: string | null;
+    /**
+     * Last activity timestamp of the contact in ISO 8601 format
+     */
+    last_activity_at?: string | null;
+    /**
+     * Created timestamp of the contact in ISO 8601 format
+     */
+    created_at?: string | null;
+    /**
+     * Updated timestamp of the contact in ISO 8601 format
+     */
+    updated_at?: string | null;
+    /**
+     * Last name of the contact
+     */
+    last_name?: string | null;
+    /**
+     * Middle name of the contact
+     */
+    middle_name?: string | null;
+    /**
+     * Location of the contact
+     */
+    location?: string | null;
+    /**
+     * Account id of the contact
+     */
+    account_id?: number;
+    /**
+     * Company id of the contact
+     */
+    company_id?: number | null;
+    /**
+     * Labels applied to the contact
+     */
+    label_list?: Array<string>;
+    [key: string]: unknown;
+};
+export type PublicConversation = {
+    /**
+     * Id of the conversation
+     */
+    id?: number;
+    /**
+     * UUID of the conversation
+     */
+    uuid?: string;
+    /**
+     * The inbox id of the conversation
+     */
+    inbox_id?: number;
+    /**
+     * Timestamp of when the contact last seen the conversation (Unix timestamp)
+     */
+    contact_last_seen_at?: number;
+    /**
+     * The status of the conversation
+     */
+    status?: 'open' | 'resolved' | 'pending' | 'snoozed';
+    /**
+     * Timestamp of when the agent last seen the conversation (Unix timestamp)
+     */
+    agent_last_seen_at?: number;
+    /**
+     * Messages in the conversation
+     */
+    messages?: Array<PublicMessage>;
+    contact?: PublicContactRecord;
+};
+export type PublicMessage = {
+    /**
+     * Id of the message
+     */
+    id?: number;
+    /**
+     * Text content of the message. Can be null for attachment-only messages.
+     */
+    content?: string | null;
+    /**
+     * Denotes the message type. Possible values: 0 (incoming), 1 (outgoing), 2 (activity), 3 (template)
+     */
+    message_type?: number;
+    /**
+     * Content type of the message
+     */
+    content_type?: string;
+    /**
+     * Additional content attributes of the message
+     */
+    content_attributes?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Created at Unix timestamp of the message
+     */
+    created_at?: number;
+    /**
+     * Display Id of the conversation the message belongs to
+     */
+    conversation_id?: number;
+    /**
+     * Attachments if any
+     */
+    attachments?: Array<PublicMessageAttachment>;
+    sender?: PublicMessageSender;
+};
+/**
+ * Attachment payload. Available fields vary by attachment file_type.
+ */
+export type PublicMessageAttachment = {
+    /**
+     * Id of the attachment
+     */
+    id?: number;
+    /**
+     * Id of the parent message
+     */
+    message_id?: number;
+    /**
+     * Type of the attached file
+     */
+    file_type?: 'image' | 'audio' | 'video' | 'file' | 'location' | 'fallback' | 'share' | 'story_mention' | 'contact' | 'ig_reel' | 'ig_post' | 'ig_story' | 'embed';
+    /**
+     * Id of the account
+     */
+    account_id?: number;
+    /**
+     * File extension
+     */
+    extension?: string | null;
+    /**
+     * URL of the file. Can be null when an attachment variant has no external URL.
+     */
+    data_url?: string | null;
+    /**
+     * URL of the file thumbnail
+     */
+    thumb_url?: string;
+    /**
+     * File size in bytes
+     */
+    file_size?: number;
+    /**
+     * Width of the attachment when available
+     */
+    width?: number | null;
+    /**
+     * Height of the attachment when available
+     */
+    height?: number | null;
+    /**
+     * Latitude for location attachments
+     */
+    coordinates_lat?: number;
+    /**
+     * Longitude for location attachments
+     */
+    coordinates_long?: number;
+    /**
+     * Fallback title for location, fallback, and contact attachments when available
+     */
+    fallback_title?: string | null;
+    /**
+     * Metadata for contact attachments
+     */
+    meta?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Transcribed text for audio attachments
+     */
+    transcribed_text?: string;
+    [key: string]: unknown;
+};
+/**
+ * Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.
+ */
+export type PublicMessageSender = {
+    /**
+     * Id of the sender
+     */
+    id?: number;
+    /**
+     * Name of the sender when available
+     */
+    name?: string | null;
+    /**
+     * Avatar URL of the sender. Present for senders of type user, agent_bot, and captain_assistant. Not present for contact senders (use thumbnail instead).
+     */
+    avatar_url?: string;
+    /**
+     * Avatar/thumbnail URL of the sender. Contact senders use this field; user senders may also include it.
+     */
+    thumbnail?: string;
+    /**
+     * Type of the sender
+     */
+    type?: 'contact' | 'user' | 'agent_bot' | 'captain_assistant';
+    /**
+     * Display name for user senders
+     */
+    available_name?: string | null;
+    /**
+     * Availability status for user senders
+     */
+    availability_status?: string | null;
+    /**
+     * Email of the sender when the sender is a contact
+     */
+    email?: string | null;
+    /**
+     * Phone number of the sender when the sender is a contact
+     */
+    phone_number?: string | null;
+    /**
+     * Identifier of the sender when the sender is a contact
+     */
+    identifier?: string | null;
+    /**
+     * Whether the sender is blocked when the sender is a contact
+     */
+    blocked?: boolean;
+    /**
+     * Additional attributes when the sender is a contact and available
+     */
+    additional_attributes?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Custom attributes when the sender is a contact and available
+     */
+    custom_attributes?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * Description when the sender is a captain assistant
+     */
+    description?: string | null;
+    /**
+     * Created timestamp in ISO 8601 format when the sender is a captain assistant
+     */
+    created_at?: string | null;
+    [key: string]: unknown;
+};
+export type PublicInbox = {
+    /**
+     * Inbox identifier
+     */
+    identifier?: string;
+    /**
+     * Name of the inbox
+     */
+    name?: string;
+    /**
+     * The timezone defined on the inbox
+     */
+    timezone?: string;
+    /**
+     * The working hours defined on the inbox
+     */
+    working_hours?: Array<{
+        /**
+         * Day of the week as a number. Sunday -> 0, Saturday -> 6
+         */
+        day_of_week?: number;
+        /**
+         * Whether or not the business is open the whole day
+         */
+        open_all_day?: boolean;
+        /**
+         * Whether or not the business is closed the whole day
+         */
+        closed_all_day?: boolean;
+        /**
+         * Opening hour. Can be null if closed all day
+         */
+        open_hour?: number;
+        /**
+         * Opening minute. Can be null if closed all day
+         */
+        open_minutes?: number;
+        /**
+         * Closing hour. Can be null if closed all day
+         */
+        close_hour?: number;
+        /**
+         * Closing minute. Can be null if closed all day
+         */
+        close_minutes?: number;
+    }>;
+    /**
+     * Whether of not the working hours are enabled on the inbox
+     */
+    working_hours_enabled?: boolean;
+    /**
+     * Whether of not the Customer Satisfaction survey is enabled on the inbox
+     */
+    csat_survey_enabled?: boolean;
+    /**
+     * Whether of not the Greeting Message is enabled on the inbox
+     */
+    greeting_enabled?: boolean;
+    /**
+     * Whether of not the User Identity Validation is enforced on the inbox
+     */
+    identity_validation_enabled?: boolean;
+};
+export type PublicContactCreateUpdatePayload = {
+    /**
+     * External identifier of the contact
+     */
+    identifier?: string;
+    /**
+     * Identifier hash prepared for HMAC authentication
+     */
+    identifier_hash?: string;
+    /**
+     * Email of the contact
+     */
+    email?: string;
+    /**
+     * Name of the contact
+     */
+    name?: string;
+    /**
+     * Phone number of the contact
+     */
+    phone_number?: string;
+    /**
+     * Send the form data with the avatar image binary or use the avatar_url
+     */
+    avatar?: Blob | File;
+    /**
+     * Custom attributes of the customer
+     */
+    custom_attributes?: {
+        [key: string]: unknown;
+    };
+};
+export type PublicMessageCreatePayload = {
+    /**
+     * Content for the message
+     */
+    content?: string;
+    /**
+     * Temporary identifier which will be passed back via websockets
+     */
+    echo_id?: string;
+};
+export type PublicMessageUpdatePayload = {
+    /**
+     * Replies to the Bot Message Types: the values chosen or entered in an input_select or form message, or the answer to an input_csat message
+     */
+    submitted_values?: Array<{
+        /**
+         * The name of the submitted value
+         */
+        name?: string;
+        /**
+         * The title of the submitted value
+         */
+        title?: string;
+        /**
+         * The value of the submitted value
+         */
+        value?: string;
+    }> | {
+        /**
+         * The CSAT survey response
+         */
+        csat_survey_response?: {
+            /**
+             * The feedback message of the CSAT survey response
+             */
+            feedback_message?: string;
+            /**
+             * The rating of the CSAT survey response
+             */
+            rating?: number;
+        };
+    };
+};
+export type PublicConversationCreatePayload = {
+    /**
+     * The page the conversation started on, which the care team sees as where it began
+     */
+    referer_url?: string;
+    /**
+     * Custom attributes of the conversation
+     */
+    custom_attributes?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * data
+ */
+export type BadRequestError = {
+    description?: string;
+    errors?: Array<RequestError>;
+};
+export type RequestError = {
+    field?: string;
+    message?: string;
+    code?: string;
+};
+/**
+ * The numeric ID of the account
+ */
+export type AccountId = number;
+/**
+ * The ID of the agentbot to be updated
+ */
+export type AgentBotId = number;
+/**
+ * The ID of the team to be updated
+ */
+export type TeamId = number;
+/**
+ * The ID of the Inbox
+ */
+export type InboxId = number;
+/**
+ * The numeric ID of the integration hook
+ */
+export type HookId = number;
+/**
+ * Id of the session for which the conversation is created.
+ *
+ *
+ *
+ * Source Ids can be obtained through contactable inboxes API or via generated.<br/><br/>Website: Skips generated string which can be obtained from webhook events. <br/> Phone Channels(Twilio): Phone number in e164 format <br/> Email Channels: Contact Email address <br/> API Channel: Any Random String
+ */
+export type SourceId = string;
+/**
+ * The attribute by which list should be sorted
+ */
+export type ContactSortParam = 'name' | 'email' | 'phone_number' | 'last_activity_at' | '-name' | '-email' | '-phone_number' | '-last_activity_at';
+/**
+ * The numeric ID of the conversation
+ */
+export type ConversationId = number;
+/**
+ * The uuid of the conversation
+ */
+export type ConversationUuid = number;
+/**
+ * The numeric ID of the custom filter
+ */
+export type CustomFilterId = number;
+/**
+ * The numeric ID of the webhook
+ */
+export type WebhookId = number;
+/**
+ * The numeric ID of the message
+ */
+export type MessageId = number;
+/**
+ * The page parameter
+ */
+export type Page = number;
+/**
+ * The numeric ID of the user on the platform
+ */
+export type PlatformUserId = number;
+/**
+ * Type of report
+ */
+export type ReportType = 'account' | 'agent' | 'inbox' | 'label' | 'team';
+/**
+ * The type of metric
+ */
+export type ReportMetric = 'conversations_count' | 'incoming_messages_count' | 'outgoing_messages_count' | 'avg_first_response_time' | 'avg_resolution_time' | 'resolutions_count';
+/**
+ * The identifier obtained from API inbox channel
+ */
+export type PublicInboxIdentifier = string;
+/**
+ * The source id of contact obtained on contact create
+ */
+export type PublicContactIdentifier = string;
+/**
+ * The slug of the portal. The numeric portal ID is not accepted.
+ */
+export type PortalSlug = string;
+export type CreateAContactData = {
+    body: PublicContactCreateUpdatePayload;
+    path: {
+        /**
+         * The identifier obtained from API inbox channel
+         */
+        inbox_identifier: string;
+    };
+    query?: never;
+    url: '/public/api/v1/inboxes/{inbox_identifier}/contacts';
+};
+export type CreateAContactErrors = {
+    /**
+     * Unauthorized
+     */
+    401: BadRequestError;
+};
+export type CreateAContactError = CreateAContactErrors[keyof CreateAContactErrors];
+export type CreateAContactResponses = {
+    /**
+     * Success
+     */
+    200: PublicContact;
+};
+export type CreateAContactResponse = CreateAContactResponses[keyof CreateAContactResponses];
+export type CreateAConversationData = {
+    body: PublicConversationCreatePayload;
+    path: {
+        /**
+         * The identifier obtained from API inbox channel
+         */
+        inbox_identifier: string;
+        /**
+         * The source id of contact obtained on contact create
+         */
+        contact_identifier: string;
+    };
+    query?: never;
+    url: '/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations';
+};
+export type CreateAConversationErrors = {
+    /**
+     * Unauthorized
+     */
+    401: BadRequestError;
+};
+export type CreateAConversationError = CreateAConversationErrors[keyof CreateAConversationErrors];
+export type CreateAConversationResponses = {
+    /**
+     * Success
+     */
+    200: PublicConversation;
+};
+export type CreateAConversationResponse = CreateAConversationResponses[keyof CreateAConversationResponses];
+export type ToggleTypingStatusData = {
+    body: {
+        /**
+         * The typing status to set
+         */
+        typing_status?: 'on' | 'off';
+    };
+    path: {
+        /**
+         * The identifier obtained from API inbox channel
+         */
+        inbox_identifier: string;
+        /**
+         * The source id of contact obtained on contact create
+         */
+        contact_identifier: string;
+        /**
+         * The numeric ID of the conversation
+         */
+        conversation_id: number;
+    };
+    query: {
+        /**
+         * Typing status, either 'on' or 'off'
+         */
+        typing_status: string;
+    };
+    url: '/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing';
+};
+export type ToggleTypingStatusErrors = {
+    /**
+     * Unauthorized
+     */
+    401: BadRequestError;
+    /**
+     * Conversation not found
+     */
+    404: BadRequestError;
+};
+export type ToggleTypingStatusError = ToggleTypingStatusErrors[keyof ToggleTypingStatusErrors];
+export type ToggleTypingStatusResponses = {
+    /**
+     * Typing status toggled successfully
+     */
+    200: unknown;
+};
+export type CreateAMessageData = {
+    body: PublicMessageCreatePayload;
+    path: {
+        /**
+         * The identifier obtained from API inbox channel
+         */
+        inbox_identifier: string;
+        /**
+         * The source id of contact obtained on contact create
+         */
+        contact_identifier: string;
+        /**
+         * The numeric ID of the conversation
+         */
+        conversation_id: number;
+    };
+    query?: never;
+    url: '/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages';
+};
+export type CreateAMessageErrors = {
+    /**
+     * Unauthorized
+     */
+    401: BadRequestError;
+};
+export type CreateAMessageError = CreateAMessageErrors[keyof CreateAMessageErrors];
+export type CreateAMessageResponses = {
+    /**
+     * Success
+     */
+    200: PublicMessage;
+};
+export type CreateAMessageResponse = CreateAMessageResponses[keyof CreateAMessageResponses];
+export type UpdateAMessageData = {
+    body: PublicMessageUpdatePayload;
+    path: {
+        /**
+         * The identifier obtained from API inbox channel
+         */
+        inbox_identifier: string;
+        /**
+         * The source id of contact obtained on contact create
+         */
+        contact_identifier: string;
+        /**
+         * The numeric ID of the conversation
+         */
+        conversation_id: number;
+        /**
+         * The numeric ID of the message
+         */
+        message_id: number;
+    };
+    query?: never;
+    url: '/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}';
+};
+export type UpdateAMessageErrors = {
+    /**
+     * Unauthorized
+     */
+    401: BadRequestError;
+};
+export type UpdateAMessageError = UpdateAMessageErrors[keyof UpdateAMessageErrors];
+export type UpdateAMessageResponses = {
+    /**
+     * Success
+     */
+    200: PublicMessage;
+};
+export type UpdateAMessageResponse = UpdateAMessageResponses[keyof UpdateAMessageResponses];