@bcrumbs.net/inbox 0.0.23 → 0.0.24

package/src/graphql.autogenerated.d.ts

@@ -122,145 +122,232 @@ export type AIsPayload = {
     __typename?: 'AIsPayload';
     nodes?: Maybe<Array<Ai>>;
 };
+/** Agent is a user that can be assigned to a conversation. A system user can have only one agent. */
 export type Agent = {
     __typename?: 'Agent';
+    /** The avatar of the agent. We are using Gravatar for the avatar. However it's possible to add here the url of the avatar. */
     avatar?: Maybe<Scalars['String']['output']>;
     createdAt: Scalars['DateTime']['output'];
+    /** The email of the agent. It is the same as the email of the invited user to the workspace. */
     email: Scalars['String']['output'];
     id: Scalars['ID']['output'];
+    /** The name of the agent. */
     name: Scalars['String']['output'];
+    /** The surname of the agent. */
     surname: Scalars['String']['output'];
+    /** The user id of the agent. It is the same as the user id of the invited user to the workspace. */
     userId: Scalars['String']['output'];
     workspaceId: Scalars['Int']['output'];
 };
+/** AgentCreateInput is an input of the agent create mutation. */
 export type AgentCreateInput = {
+    /** The email of the agent. It is the same as the email of the invited user to the workspace. */
     email: Scalars['String']['input'];
+    /** The name of the agent. */
     name: Scalars['String']['input'];
+    /** The surname of the agent. */
     surname: Scalars['String']['input'];
+    /** The user id of the agent. It is the same as the user id of the invited user to the workspace. */
     userId: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** AgentInput is an input of the agent query. */
 export type AgentInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** AgentPatchInput is an input of the agent patch mutation. */
 export type AgentPatchInput = {
     id: Scalars['ID']['input'];
+    /** The name of the agent. */
     name: Scalars['String']['input'];
+    /** The surname of the agent. */
     surname: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** AgentReport is a report of the agent breaked down by day. It is used to understand the agent's performance. */
 export type AgentReport = {
     __typename?: 'AgentReport';
     agentId: Scalars['ID']['output'];
+    /** The number of messages the agent has sent. */
     agentMessagesCount: Scalars['Int']['output'];
+    /** The average time to complete the conversation. It is the time between the first message from the client until the conversation is closed. */
     avgConversationTime: Scalars['Int']['output'];
+    /** The average time to first response. It is the time between the first message from the client and the first message from the agent. */
     avgFirstResponseTime: Scalars['Int']['output'];
+    /** The number of messages the agent has received from the client. */
     clientMessageCount: Scalars['Int']['output'];
+    /** The number of conversations the agent has participated in. */
     conversationCount: Scalars['Int']['output'];
     createdAt: Scalars['DateTime']['output'];
     id: Scalars['ID']['output'];
     workspaceId: Scalars['Int']['output'];
 };
+/** AgentsInput is an input of the agents query. */
 export type AgentsInput = {
+    /** The conversation id. Used to filter the agents by the conversation id. */
     conversationId?: InputMaybe<Scalars['String']['input']>;
+    /** The email of the agent. Used to filter the agents by the email. */
     email?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the agent. Used to filter the agents by the name. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The surname of the agent. Used to filter the agents by the surname. */
     surname?: InputMaybe<Scalars['String']['input']>;
     workspaceId: Scalars['Int']['input'];
 };
+/** AgentsPayload is a payload of the agents query. */
 export type AgentsPayload = {
     __typename?: 'AgentsPayload';
     nodes?: Maybe<Array<Agent>>;
     pageInfo?: Maybe<PageInfo>;
 };
+/** AgentsReportInput is an input of the agents report query. */
 export type AgentsReportInput = {
+    /** The agent id. */
     agentId?: InputMaybe<Scalars['ID']['input']>;
+    /** The end date of the report. */
     endDate: Scalars['DateTime']['input'];
+    /** The start date of the report. */
     startDate: Scalars['DateTime']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** AgentsReportPayload is a payload of the agents report query. */
 export type AgentsReportPayload = {
     __typename?: 'AgentsReportPayload';
     nodes?: Maybe<Array<AgentReport>>;
 };
+/** ApiKey is a key that can be used to authenticate the requests to the API. */
 export type ApiKey = {
     __typename?: 'ApiKey';
+    /** The date and time when the API key was created. */
     createdAt: Scalars['DateTime']['output'];
     id: Scalars['ID']['output'];
+    /** The key of the API key. */
     key: Scalars['String']['output'];
+    /** The label of the API key. */
     label: Scalars['String']['output'];
     workspaceId: Scalars['Int']['output'];
 };
+/** ApiKeyDeleteInput is an input of the api key delete mutation. */
 export type ApiKeyDeleteInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ApiKeyGenInput is an input of the api key generate mutation. */
 export type ApiKeyGenInput = {
+    /** The label of the API key. */
     label: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ApiKeysInput is an input of the api keys query. */
 export type ApiKeysInput = {
+    /** The label of the API key. Used to filter the API keys by the label. */
     label?: InputMaybe<Scalars['String']['input']>;
     workspaceId: Scalars['Int']['input'];
 };
+/** ApiKeysPayload is a payload of the api keys query. */
 export type ApiKeysPayload = {
     __typename?: 'ApiKeysPayload';
     nodes?: Maybe<Array<ApiKey>>;
     pageInfo?: Maybe<PageInfo>;
 };
+/**
+ * Broadcast is entity that represents a broadcast of a template to a set of clients.
+ * When the broadcast is created, it will be in draft state. In order to send the broadcast, you should launch it by using the launchBroadcast mutation.
+ */
 export type Broadcast = {
     __typename?: 'Broadcast';
+    /** The stage of the clients that will receive the broadcast. (Used to target a specific stage of clients) */
     clientStageId?: Maybe<Scalars['String']['output']>;
+    /** The tags of the clients that will receive the broadcast. (Used to target a specific group of clients) */
     clientTags?: Maybe<Array<Scalars['String']['output']>>;
+    /** The date and time when the broadcast was completed. */
     completedAt?: Maybe<Scalars['DateTime']['output']>;
+    /** The date and time when the broadcast was created. */
     createdAt: Scalars['DateTime']['output'];
+    /** The error message if the broadcast failed. */
     error?: Maybe<Scalars['String']['output']>;
+    /** The number of clients that failed to receive the broadcast. */
     failedCount?: Maybe<Scalars['Int']['output']>;
     id: Scalars['ID']['output'];
+    /** The integration/channel id of the broadcast. */
     integrationId: Scalars['ID']['output'];
+    /** The name of the broadcast. */
     name: Scalars['String']['output'];
+    /** The date and time when the broadcast was scheduled. If it's empty, the broadcast will be sent immediately. */
     scheduledAt?: Maybe<Scalars['DateTime']['output']>;
+    /** The date and time when the broadcast was started. */
     startedAt?: Maybe<Scalars['DateTime']['output']>;
+    /** The state of the broadcast. */
     state: BroadcastState;
+    /** The language of the template that will be used to send the broadcast. */
     templateLang?: Maybe<Scalars['String']['output']>;
+    /** The name of the template that will be used to send the broadcast. (It should be the same template name in WhatsApp manager) */
     templateName: Scalars['String']['output'];
+    /** The total number of clients that will receive the broadcast. */
     totalCount?: Maybe<Scalars['Int']['output']>;
     workspaceId: Scalars['Int']['output'];
 };
+/** BroadcastCreateInput is an input of the broadcast create mutation. */
 export type BroadcastCreateInput = {
+    /** The stage of the clients that will receive the broadcast. (Used to target a specific stage of clients) */
     clientStageId?: InputMaybe<Scalars['String']['input']>;
+    /** The tags of the clients that will receive the broadcast. (Used to target a specific group of clients) */
     clientTags?: InputMaybe<Array<Scalars['String']['input']>>;
+    /** The integration/channel id of the broadcast. */
     integrationId: Scalars['ID']['input'];
+    /** The name of the broadcast. */
     name: Scalars['String']['input'];
+    /** The date and time when the broadcast was scheduled. If it's empty, the broadcast will be sent immediately. */
     scheduledAt?: InputMaybe<Scalars['DateTime']['input']>;
+    /** The language of the template that will be used to send the broadcast. */
     templateLang?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the template that will be used to send the broadcast. (It should be the same template name in WhatsApp manager) */
     templateName: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** BroadcastDeleteInput is an input of the broadcast delete mutation. */
 export type BroadcastDeleteInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** BroadcastInput is an input of the broadcast query. */
 export type BroadcastInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** BroadcastLaunchInput is an input of the broadcast launch mutation. */
 export type BroadcastLaunchInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** BroadcastPatchInput is an input of the broadcast patch mutation. */
 export type BroadcastPatchInput = {
+    /** The stage of the clients that will receive the broadcast. (Used to target a specific stage of clients) */
     clientStageId?: InputMaybe<Scalars['String']['input']>;
+    /** The tags of the clients that will receive the broadcast. (Used to target a specific group of clients) */
     clientTags?: InputMaybe<Array<Scalars['String']['input']>>;
     id: Scalars['ID']['input'];
+    /** The integration/channel id of the broadcast. */
     integrationId?: InputMaybe<Scalars['ID']['input']>;
+    /** The name of the broadcast. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The date and time when the broadcast was scheduled. If it's empty, the broadcast will be sent immediately. */
     scheduledAt?: InputMaybe<Scalars['DateTime']['input']>;
+    /** The language of the template that will be used to send the broadcast. */
     templateLang?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the template that will be used to send the broadcast. (It should be the same template name in WhatsApp manager) */
     templateName: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/**
+ * BroadcastState is the state of the broadcast.
+ * - draft: The broadcast is in draft mode.
+ * - scheduled: The broadcast is scheduled to be sent.
+ * - inProgress: The broadcast is in progress (Being sent to the clients).
+ * - completed: The broadcast is completed (All messages are sent to the clients).
+ * - failed: The broadcast is failed (Some messages are not sent to the clients).
+ */
 export declare const BroadcastState: {
     readonly COMPLETED: "completed";
     readonly DRAFT: "draft";
@@ -269,196 +356,365 @@ export declare const BroadcastState: {
     readonly SCHEDULED: "scheduled";
 };
 export type BroadcastState = typeof BroadcastState[keyof typeof BroadcastState];
+/** BroadcastsInput is an input of the broadcasts query. */
 export type BroadcastsInput = {
+    /** The integration/channel id of the broadcast. Used to filter the broadcasts by the integration/channel id. */
     integrationId?: InputMaybe<Scalars['ID']['input']>;
+    /** The name of the broadcast. Used to filter the broadcasts by the name. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The state of the broadcast. Used to filter the broadcasts by the state. */
     state?: InputMaybe<BroadcastState>;
+    /** The name of the template that will be used to send the broadcast. Used to filter the broadcasts by the template name. */
     templateName?: InputMaybe<Scalars['String']['input']>;
     workspaceId: Scalars['Int']['input'];
 };
+/** BroadcastsPayload is a payload of the broadcasts query. */
 export type BroadcastsPayload = {
     __typename?: 'BroadcastsPayload';
     nodes?: Maybe<Array<Broadcast>>;
     pageInfo?: Maybe<PageInfo>;
 };
+/** Client is an entity that represents a client (The contact that is sending messages to a workspace channel). */
 export type Client = {
     __typename?: 'Client';
+    /** The address of the client. It can be modified by the user. */
     address?: Maybe<Scalars['String']['output']>;
+    /** The city of the client. It can be modified by the user. */
     city?: Maybe<Scalars['String']['output']>;
+    /** The code of the client. It can be modified by the user. */
     code?: Maybe<Scalars['String']['output']>;
+    /** The country of the client. It can be modified by the user. */
     country?: Maybe<Scalars['String']['output']>;
+    /** The date and time when the client was created. */
     createdAt: Scalars['DateTime']['output'];
+    /** The email of the client. It can be modified by the user. */
     email?: Maybe<Scalars['String']['output']>;
+    /** The external client id of the client (The id of the client in the external system, it will be the phone number in case of WhatsApp integration). */
     externalClientId?: Maybe<Scalars['String']['output']>;
     id: Scalars['ID']['output'];
+    /** The name of the client. It can be modified by the user. */
     name?: Maybe<Scalars['String']['output']>;
+    /** The phone of the client. It cannot be modified in case of WhatsApp integration. */
     phone?: Maybe<Scalars['String']['output']>;
+    /** The stage of the client. */
     stageId?: Maybe<Scalars['String']['output']>;
+    /** The surname of the client. It can be modified by the user. */
     surname?: Maybe<Scalars['String']['output']>;
+    /** The tags of the client. It can be modified by the user. */
     tags?: Maybe<Array<Scalars['String']['output']>>;
     workspaceId: Scalars['Int']['output'];
 };
+/** ClientCreateInput is an input of the client create mutation. */
 export type ClientCreateInput = {
+    /** The address of the client. */
     address?: InputMaybe<Scalars['String']['input']>;
+    /** The city of the client. */
     city?: InputMaybe<Scalars['String']['input']>;
+    /** The code of the client. */
     code?: InputMaybe<Scalars['String']['input']>;
+    /** The country of the client. */
     country?: InputMaybe<Scalars['String']['input']>;
+    /** The email of the client. */
     email?: InputMaybe<Scalars['String']['input']>;
     /** externalClientId is required, in case of WhatsApp integration this will be the phone number of the client without + and without spaces */
     externalClientId: Scalars['String']['input'];
+    /** The name of the client. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The phone of the client. */
     phone?: InputMaybe<Scalars['String']['input']>;
+    /** The surname of the client. */
     surname?: InputMaybe<Scalars['String']['input']>;
     tags?: InputMaybe<Array<Scalars['String']['input']>>;
     workspaceId: Scalars['Int']['input'];
 };
+/** ClientInput is an input of the client query. */
 export type ClientInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ClientPatchInput is an input of the client patch mutation. */
 export type ClientPatchInput = {
+    /** The address of the client. */
     address?: InputMaybe<Scalars['String']['input']>;
+    /** The city of the client. */
     city?: InputMaybe<Scalars['String']['input']>;
+    /** The code of the client. */
     code?: InputMaybe<Scalars['String']['input']>;
+    /** The country of the client. */
     country?: InputMaybe<Scalars['String']['input']>;
+    /** The email of the client. */
     email?: InputMaybe<Scalars['String']['input']>;
     id: Scalars['ID']['input'];
+    /** The name of the client. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The phone of the client. */
     phone?: InputMaybe<Scalars['String']['input']>;
+    /** The stage of the client. */
     stage?: InputMaybe<Scalars['String']['input']>;
+    /** The surname of the client. */
+    surname?: InputMaybe<Scalars['String']['input']>;
+    workspaceId: Scalars['Int']['input'];
+};
+/** ClientPutInput is an input of the client put mutation. */
+export type ClientPutInput = {
+    /** The address of the client. */
+    address?: InputMaybe<Scalars['String']['input']>;
+    /** The city of the client. */
+    city?: InputMaybe<Scalars['String']['input']>;
+    /** The code of the client. */
+    code?: InputMaybe<Scalars['String']['input']>;
+    /** The country of the client. */
+    country?: InputMaybe<Scalars['String']['input']>;
+    /** The email of the client. */
+    email?: InputMaybe<Scalars['String']['input']>;
+    /** externalClientId is required, in case of WhatsApp integration this will be the phone number of the client without + and without spaces */
+    externalClientId: Scalars['String']['input'];
+    /** The name of the client. */
+    name?: InputMaybe<Scalars['String']['input']>;
+    /** The phone of the client. */
+    phone?: InputMaybe<Scalars['String']['input']>;
+    /** The surname of the client. */
     surname?: InputMaybe<Scalars['String']['input']>;
+    /** The tags of the client. */
+    tags?: InputMaybe<Array<Scalars['String']['input']>>;
     workspaceId: Scalars['Int']['input'];
 };
+/** ClientTagInput is an input of the client tag mutation. */
 export type ClientTagInput = {
     clientId: Scalars['ID']['input'];
+    /** The tag to add to the client. */
     tag: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ClientsInput is an input of the clients query. */
 export type ClientsInput = {
+    /** The city of the client. Used to filter the clients by the city. */
     city?: InputMaybe<Scalars['String']['input']>;
+    /** The code of the client. Used to filter the clients by the code. */
     code?: InputMaybe<Scalars['String']['input']>;
+    /** The conversation id of the client. Used to filter the clients by the conversation id. */
     conversationId?: InputMaybe<Scalars['String']['input']>;
+    /** The country of the client. Used to filter the clients by the country. */
     country?: InputMaybe<Scalars['String']['input']>;
+    /** The email of the client. Used to filter the clients by the email. */
     email?: InputMaybe<Scalars['String']['input']>;
+    /** The external client id of the client. Used to filter the clients by the external client id. */
     externalClientId?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the client. Used to filter the clients by the name. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The phone of the client. Used to filter the clients by the phone. */
     phone?: InputMaybe<Scalars['String']['input']>;
+    /** The stage of the client. Used to filter the clients by the stage. */
     stageId?: InputMaybe<Scalars['String']['input']>;
+    /** The surname of the client. Used to filter the clients by the surname. */
     surname?: InputMaybe<Scalars['String']['input']>;
+    /** The tags of the client. Used to filter the clients by the tags. */
     tags?: InputMaybe<Array<Scalars['String']['input']>>;
     workspaceId: Scalars['Int']['input'];
 };
+/** ClientsPayload is a payload of the clients query. */
 export type ClientsPayload = {
     __typename?: 'ClientsPayload';
     nodes?: Maybe<Array<Client>>;
     pageInfo?: Maybe<PageInfo>;
 };
+/** ConvAssignInput is an input of the conversation assign mutation. */
 export type ConvAssignInput = {
+    /** The agent id to assign to the conversation. */
     agentId?: InputMaybe<Scalars['ID']['input']>;
+    /** The id of the conversation. */
     convId: Scalars['ID']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ConvAssignment is a type of the conversation assignment. */
 export type ConvAssignment = {
     __typename?: 'ConvAssignment';
+    /** The date and time when the conversation was assigned to the agent/AI. */
     assignDate?: Maybe<Scalars['DateTime']['output']>;
+    /** The id of the agent/AI that is assigned to the conversation. */
     assigneeId: Scalars['ID']['output'];
+    /** Whether the conversation is assigned to an AI. */
     isAi?: Maybe<Scalars['Boolean']['output']>;
 };
+/** ConvEndInput is an input of the conversation end mutation. */
 export type ConvEndInput = {
+    /** The id of the conversation. */
     convId: Scalars['ID']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ConvPatchInput is an input of the conversation patch mutation. */
 export type ConvPatchInput = {
+    /** The id of the conversation. */
     convId: Scalars['ID']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
+    /** The order number of the conversation. */
     orderNo?: InputMaybe<Scalars['String']['input']>;
+    /** The stage of the conversation. */
     stage?: InputMaybe<Scalars['String']['input']>;
     workspaceId: Scalars['Int']['input'];
 };
+/**
+ * ConvStartInput is an input of the conversation start mutation.
+ * It is used to start a conversation with a client in case of WhatsApp integration.
+ * Please note: That you cannot send messages to the client afterwards until he replies to the template message.
+ */
 export type ConvStartInput = {
+    /** The client id of the conversation. */
     clientId?: InputMaybe<Scalars['ID']['input']>;
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
+    /** The phone number of the client. */
     phone?: InputMaybe<Scalars['String']['input']>;
+    /** The language of the template. */
     templateLang?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the template. */
     templateName: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ConvTagInput is an input of the conversation tag mutation. */
 export type ConvTagInput = {
+    /** The id of the conversation. */
     convId: Scalars['ID']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
+    /** The tag to add to the conversation. */
     tag: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** Conversation is a type of the conversation. */
 export type Conversation = {
     __typename?: 'Conversation';
+    /** Whether the conversation is assigned to an AI. */
     aiAssigneed?: Maybe<Scalars['Boolean']['output']>;
+    /** The AI id of the conversation. */
     aiId?: Maybe<Scalars['ID']['output']>;
+    /** The assignee of the conversation. */
     assignee?: Maybe<Agent>;
+    /** The assignee id of the conversation. */
     assigneeId?: Maybe<Scalars['ID']['output']>;
+    /** The assignees history of the conversation. */
     assignees?: Maybe<Array<Maybe<ConvAssignment>>>;
+    /** The client of the conversation. */
     client?: Maybe<ConversationClient>;
+    /** The client id of the conversation. */
     clientId: Scalars['ID']['output'];
+    /** The date and time when the conversation was created. */
     createdAt: Scalars['DateTime']['output'];
+    /** Whether the conversation is ended or still open. */
     ended: Scalars['Boolean']['output'];
+    /** The date and time when the conversation was ended. */
     endedAt?: Maybe<Scalars['DateTime']['output']>;
+    /** The external conversation id of the conversation. */
     externalConversationId?: Maybe<Scalars['String']['output']>;
+    /** The id of the conversation. */
     id: Scalars['ID']['output'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['output'];
+    /** The integration type of the conversation. */
     integrationType: IntegrationType;
+    /** The messages of the conversation. */
     messages?: Maybe<Array<Message>>;
+    /** The order number of the conversation. */
     orderNo?: Maybe<Scalars['String']['output']>;
+    /** The stage id of the conversation. */
     stageId?: Maybe<Scalars['String']['output']>;
+    /** The tags of the conversation. */
     tags?: Maybe<Array<Scalars['String']['output']>>;
+    /** The workspace id of the conversation. */
     workspaceId: Scalars['Int']['output'];
 };
+/** ConversationClient is a type of the conversation client, the needed client data coming with the conversation. */
 export type ConversationClient = {
     __typename?: 'ConversationClient';
+    /** The code of the client. */
     code?: Maybe<Scalars['String']['output']>;
+    /** The name of the client. */
     name?: Maybe<Scalars['String']['output']>;
+    /** The phone of the client. */
     phone?: Maybe<Scalars['String']['output']>;
+    /** The surname of the client. */
     surname?: Maybe<Scalars['String']['output']>;
 };
+/** ConversationReport is a report of the workspace breaked down by hour. It is used to understand the workspace performance. */
 export type ConversationReport = {
     __typename?: 'ConversationReport';
+    /** The number of messages sent by the agents in the hour. */
     agentMessagesCount: Scalars['Int']['output'];
+    /** The average time of the conversation in the hour. */
     avgConversationTime: Scalars['Int']['output'];
+    /** The average time to first response in the hour. */
     avgFirstResponseTime: Scalars['Int']['output'];
+    /** The number of messages sent by the clients in the hour. */
     clientMessageCount: Scalars['Int']['output'];
+    /** The number of conversations in the hour. */
     conversationCount: Scalars['Int']['output'];
+    /** The date and time when the conversation report was created. */
     createdAt: Scalars['DateTime']['output'];
+    /** The hour of the conversation report. */
     hour: Scalars['Int']['output'];
+    /** The id of the conversation report. */
     id: Scalars['ID']['output'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['output'];
     workspaceId: Scalars['Int']['output'];
 };
+/**
+ * ConvsInput is an input of the conversations query.
+ * Please note: That if you pass undefined to filters, it will be ignored. If you pass null, it will be considered that you are filtering by null.
+ */
 export type ConvsInput = {
+    /** The assignee id of the conversation. Used to filter the conversations by the assignee id. */
     assigneeId?: InputMaybe<Scalars['ID']['input']>;
+    /** The client id of the conversation. Used to filter the conversations by the client id. */
     clientId?: InputMaybe<Scalars['ID']['input']>;
+    /** Whether the conversation is ended or still open. Used to filter the conversations by the ended status. */
     ended?: InputMaybe<Scalars['Boolean']['input']>;
+    /** The external conversation id of the conversation. Used to filter the conversations by the external conversation id. */
     externalConversationId?: InputMaybe<Scalars['String']['input']>;
+    /** The integration/channel id of the conversation. */
     integrationId?: InputMaybe<Scalars['ID']['input']>;
+    /** The name or phone of the conversation. Used to filter the conversations by the name or phone. */
     nameOrPhone?: InputMaybe<Scalars['String']['input']>;
+    /** The stage id of the conversation. Used to filter the conversations by the stage id. */
     stageId?: InputMaybe<Scalars['String']['input']>;
+    /** The tags of the conversation. Used to filter the conversations by the tags. */
     tags?: InputMaybe<Array<Scalars['String']['input']>>;
     workspaceId: Scalars['Int']['input'];
 };
+/** ConvsPayload is a payload of the conversations query. */
 export type ConvsPayload = {
     __typename?: 'ConvsPayload';
     nodes?: Maybe<Array<Conversation>>;
     pageInfo?: Maybe<PageInfo>;
 };
+/** ConvsReportInput is an input of the conversations report query. */
 export type ConvsReportInput = {
+    /** The end date of the conversations report. */
     endDate: Scalars['DateTime']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId?: InputMaybe<Scalars['ID']['input']>;
+    /** The start date of the conversations report. */
     startDate: Scalars['DateTime']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ConvsReportPayload is a payload of the conversations report query. */
 export type ConvsReportPayload = {
     __typename?: 'ConvsReportPayload';
     nodes?: Maybe<Array<ConversationReport>>;
 };
+/**
+ * ErrorCode is an enum for the error codes.
+ * - UNAUTHENTICATED: The user is not authenticated.
+ * - FILE_UPLOAD_ERROR: a file upload error.
+ * - FORBIDDEN: The user is forbidden to access the resource.
+ * - FILE_NOT_FOUND: The file not found.
+ * - RATE_LIMIT_ERROR: The rate limit error.
+ */
 export declare const ErrorCode: {
     readonly FILE_NOT_FOUND: "FILE_NOT_FOUND";
     readonly FILE_UPLOAD_ERROR: "FILE_UPLOAD_ERROR";
@@ -471,6 +727,7 @@ export type HelloMessage = {
     __typename?: 'HelloMessage';
     message: Scalars['String']['output'];
 };
+/** IdUpdateDTO is data transfer object for the id update (Updating a message with it's external id) */
 export type IdUpdateDto = {
     __typename?: 'IdUpdateDTO';
     conversationId: Scalars['ID']['output'];
@@ -509,44 +766,69 @@ export type InputUploadSignature = {
 export type InputUsersRoles = {
     workspaceId: Scalars['Int']['input'];
 };
+/** Integration is a type for the integration/channel. */
 export type Integration = {
     __typename?: 'Integration';
     createdAt: Scalars['DateTime']['output'];
     deletedAt?: Maybe<Scalars['DateTime']['output']>;
+    /** The id of the integration. */
     id: Scalars['ID']['output'];
+    /** The name of the integration. */
     name: Scalars['String']['output'];
     patchedAt?: Maybe<Scalars['DateTime']['output']>;
+    /** The properties of the integration. */
     properties?: Maybe<Scalars['JSON']['output']>;
+    /** The state of the integration. */
     state: IntegrationState;
+    /** The type of the integration. */
     type: IntegrationType;
+    /** The workspace id of the integration. */
     workspaceId: Scalars['Int']['output'];
 };
+/** IntegrationCreateInput is an input for the integration creation. */
 export type IntegrationCreateInput = {
     integrationProperties: Scalars['JSON']['input'];
     name: Scalars['String']['input'];
     type: IntegrationType;
     workspaceId: Scalars['Int']['input'];
 };
+/** IntegrationDeleteInput is an input for the integration deletion. */
 export type IntegrationDeleteInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** IntegrationInput is an input for the integration. */
 export type IntegrationInput = {
     id: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** IntegrationPatchInput is an input for the integration patching. */
 export type IntegrationPatchInput = {
     id: Scalars['ID']['input'];
     name?: InputMaybe<Scalars['String']['input']>;
     properties?: InputMaybe<Scalars['JSON']['input']>;
     workspaceId: Scalars['Int']['input'];
 };
+/**
+ * IntegrationState is an enum for the integration state.
+ * - ACTIVE: The integration is active.
+ * - PENDING: The integration is pending.
+ * - DELETED: The integration is deleted.
+ */
 export declare const IntegrationState: {
     readonly ACTIVE: "ACTIVE";
     readonly DELETED: "DELETED";
     readonly PENDING: "PENDING";
 };
 export type IntegrationState = typeof IntegrationState[keyof typeof IntegrationState];
+/**
+ * IntegrationType is an enum of the integration types.
+ * It can be:
+ * - WHATSAPP: WhatsApp integration.
+ * - BCWEBCHAT: BC Webchat integration.
+ * - FACEBOOK: Facebook integration.
+ * - INSTAGRAM: Instagram integration.
+ */
 export declare const IntegrationType: {
     readonly BCWEBCHAT: "BCWEBCHAT";
     readonly FACEBOOK: "FACEBOOK";
@@ -554,6 +836,7 @@ export declare const IntegrationType: {
     readonly WHATSAPP: "WHATSAPP";
 };
 export type IntegrationType = typeof IntegrationType[keyof typeof IntegrationType];
+/** IntegrationWithSecrets is a type for the integration/channel with secrets (integrationProperties is included) */
 export type IntegrationWithSecrets = {
     __typename?: 'IntegrationWithSecrets';
     createdAt: Scalars['DateTime']['output'];
@@ -567,14 +850,20 @@ export type IntegrationWithSecrets = {
     type: IntegrationType;
     workspaceId: Scalars['Int']['output'];
 };
+/** IntegrationsInput is an input for the integrations. */
 export type IntegrationsInput = {
+    /** The name of the integration. Used for filtering. */
     name?: InputMaybe<Scalars['String']['input']>;
+    /** The state of the integration. Used for filtering. */
     state?: InputMaybe<IntegrationState>;
+    /** The type of the integration. Used for filtering. */
     type?: InputMaybe<IntegrationType>;
     workspaceId: Scalars['Int']['input'];
 };
+/** IntegrationsPayload is a payload for the integrations. */
 export type IntegrationsPayload = {
     __typename?: 'IntegrationsPayload';
+    /** The nodes of the integrations. */
     nodes?: Maybe<Array<Integration>>;
 };
 export declare const MediaFormat: {
@@ -590,57 +879,110 @@ export declare const MediaType: {
     readonly PDF: "PDF";
 };
 export type MediaType = typeof MediaType[keyof typeof MediaType];
+/** Message is a type of the message. */
 export type Message = {
     __typename?: 'Message';
+    /** The id of the agent that sent the message. */
     agentId?: Maybe<Scalars['ID']['output']>;
+    /**
+     * The content of the message, in case of media messages, it will be the url of the media.
+     * In case of template messages, it will be the template JSON object.
+     */
     content: Scalars['String']['output'];
+    /** The context of the message. */
     context?: Maybe<MessageContext>;
+    /** The date and time when the message was created. */
     createdAt: Scalars['DateTime']['output'];
+    /** The external message id of the message. */
     externalMessageId?: Maybe<Scalars['String']['output']>;
+    /** Whether the message is from an agent or the client. */
     isAgent: Scalars['Boolean']['output'];
+    /** The id of the message. */
     messageId: Scalars['ID']['output'];
+    /** The note type of the message. */
     noteType?: Maybe<NoteType>;
+    /** The status of the message. */
     status?: Maybe<MessageStatus>;
+    /** The tags of the message. */
     tags?: Maybe<Array<Scalars['String']['output']>>;
+    /** The type of the message. */
     type: MessageType;
 };
+/**
+ * MessageContext is a type of the message context.
+ * - replyToId: The id of the message to reply to.
+ * - replyToContent: The content of the message to reply to.
+ * - replyToType: The type of the message to reply to.
+ */
 export type MessageContext = {
     __typename?: 'MessageContext';
     replyToContent: Scalars['String']['output'];
     replyToId?: Maybe<Scalars['ID']['output']>;
     replyToType: MessageType;
 };
+/** MessageDTO is data transfer object for the message. */
 export type MessageDto = {
     __typename?: 'MessageDTO';
+    /** The internal id of the client. */
     clientId?: Maybe<Scalars['ID']['output']>;
+    /** The content of the message. */
     content: Scalars['String']['output'];
+    /** The context of the message. */
     context?: Maybe<Scalars['JSON']['output']>;
+    /** The internal id of the conversation. */
     conversationId?: Maybe<Scalars['ID']['output']>;
     createdAt: Scalars['String']['output'];
     debug?: Maybe<Scalars['Boolean']['output']>;
+    /** The external id of the client. */
     externalClientId: Scalars['String']['output'];
+    /** The external info of the client. */
     externalClientInfo?: Maybe<Scalars['JSON']['output']>;
+    /** The external context of the message. */
     externalContext?: Maybe<Scalars['JSON']['output']>;
+    /** The external id of the conversation. */
     externalConversationId?: Maybe<Scalars['String']['output']>;
+    /** The external id of the message. */
     externalMessageId?: Maybe<Scalars['String']['output']>;
+    /** The integration id of the message. */
     integrationId: Scalars['ID']['output'];
+    /** The integration type of the message. */
     integrationType: IntegrationType;
+    /** If it's an agent message, or client message. */
     isAgent?: Maybe<Scalars['Boolean']['output']>;
+    /** The internal id of the message. */
     messageId?: Maybe<Scalars['ID']['output']>;
     spanId?: Maybe<Scalars['String']['output']>;
+    /** The tags of the message. */
     tags?: Maybe<Array<Scalars['String']['output']>>;
     traceId?: Maybe<Scalars['String']['output']>;
+    /** The type of the message. */
     type: MessageType;
+    /** The workspace id of the message. */
     workspaceId: Scalars['Int']['output'];
 };
+/** MessageInput is an input of the message mutation. */
 export type MessageInput = {
+    /** The content of the message. */
     content: Scalars['String']['input'];
+    /** The id of the conversation. */
     convId: Scalars['ID']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
+    /** The note type of the message. */
     noteType?: InputMaybe<NoteType>;
+    /** The type of the message. */
     type: MessageType;
     workspaceId: Scalars['Int']['input'];
 };
+/**
+ * MessageStatus is an enum of the message statuses.
+ * It can be:
+ * - sent: Message sent to the client (The client didn't receive it yet).
+ * - delivered: Message delivered to the client (The client didn't see it yet).
+ * - read: Message read by the client (The client read it).
+ * - failed: Message failed to be sent.
+ * - pending: Message pending to be sent.
+ */
 export declare const MessageStatus: {
     readonly DELIVERED: "delivered";
     readonly FAILED: "failed";
@@ -649,27 +991,50 @@ export declare const MessageStatus: {
     readonly SENT: "sent";
 };
 export type MessageStatus = typeof MessageStatus[keyof typeof MessageStatus];
+/** MessageTagInput is an input of the message tag mutation. */
 export type MessageTagInput = {
+    /** The id of the conversation. */
     convId: Scalars['ID']['input'];
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
+    /** The id of the message. */
     messageId: Scalars['ID']['input'];
+    /** The tag to add to the message. */
     tag: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** MessageTemplate is a type for the WhatsApp message template. */
 export type MessageTemplate = {
     __typename?: 'MessageTemplate';
+    /** The category of the template. */
     category: Scalars['String']['output'];
     id: Scalars['String']['output'];
+    /** The language of the template. */
     language: Scalars['String']['output'];
     library_template_name?: Maybe<Scalars['String']['output']>;
+    /** The name of the template in WhatsApp manager. */
     name: Scalars['String']['output'];
     parameter_format?: Maybe<Scalars['String']['output']>;
+    /** The status of the template. */
     status: TemplateState;
 };
 export type MessageTemplatesPayload = {
     __typename?: 'MessageTemplatesPayload';
     nodes?: Maybe<Array<MessageTemplate>>;
 };
+/**
+ * MessageType is an enum of the message types.
+ * It can be:
+ * - text: Text message.
+ * - image: Image message.
+ * - audio: Audio message.
+ * - document: Document message (Files, PDFs, etc.).
+ * - video: Video message.
+ * - location: Location message.
+ * - interactive: Interactive message.
+ * - template: Template message (WhatsApp only).
+ * - note: Note message (Internal note).
+ */
 export declare const MessageType: {
     readonly AUDIO: "audio";
     readonly DOCUMENT: "document";
@@ -682,15 +1047,26 @@ export declare const MessageType: {
     readonly VIDEO: "video";
 };
 export type MessageType = typeof MessageType[keyof typeof MessageType];
+/**
+ * MessagesInput is an input of the messages query.
+ * Please note: That if you pass undefined to filters, it will be ignored. If you pass null, it will be considered that you are filtering by null.
+ */
 export type MessagesInput = {
+    /** The assignee id of the conversation. Used to filter the messages by the assignee id. */
     assigneeId?: InputMaybe<Scalars['ID']['input']>;
+    /** The client id of the conversation. Used to filter the messages by the client id. */
     clientId?: InputMaybe<Scalars['ID']['input']>;
+    /** The end date of the messages. */
     endDate?: InputMaybe<Scalars['DateTime']['input']>;
+    /** The start date of the messages. */
     startDate?: InputMaybe<Scalars['DateTime']['input']>;
+    /** The tags of the messages. Used to filter the messages by the tags. */
     tags?: InputMaybe<Array<Scalars['String']['input']>>;
+    /** The type of the messages. Used to filter the messages by the type. */
     type?: InputMaybe<MessageType>;
     workspaceId: Scalars['Int']['input'];
 };
+/** MessagesPayload is a payload of the messages query. */
 export type MessagesPayload = {
     __typename?: 'MessagesPayload';
     nodes?: Maybe<Array<Message>>;
@@ -698,44 +1074,75 @@ export type MessagesPayload = {
 };
 export type Mutation = {
     __typename?: 'Mutation';
+    /** Add a message to the conversation. */
     addMessage: Message;
+    /** Assign a conversation to an agent. If you don't have the MANAGE_CONVS permission, you can only assign the conversation to yourself. */
     assignConv: Conversation;
     assignOwner: UserRole;
     assignUserRole: UserRole;
+    /** Bulk patch tags. You should have the MANAGE_WORKSPACE permission to bulk patch tags. */
     bulkPatchTags: Scalars['Boolean']['output'];
+    /** Create an agent. You should have the MANAGE_WORKSPACE permission to create an agent. */
     createAgent: Agent;
     createAi: Ai;
+    /** Create a broadcast. You should have the MANAGE_CONVS permission to create a broadcast. */
     createBroadcast: Broadcast;
+    /** Create a client. You should have the MANAGE_CLIENTS permission to create a client. */
     createClient: Client;
+    /** Create an integration. You should have the MANAGE_WORKSPACE permission to create an integration. */
     createIntegration: Integration;
+    /** Create a tag. You should have the MANAGE_WORKSPACE permission to create a tag. */
     createTag: Tag;
     createWebhook: Webhook;
+    /** Delete an agent. You should have the MANAGE_WORKSPACE permission to delete an agent. */
     deleteAgent: Agent;
     deleteAi: Ai;
+    /** Delete an API key. You should have the MANAGE_WORKSPACE permission to delete an API key. */
     deleteApiKey: ApiKey;
+    /** Delete a broadcast. You should have the MANAGE_CONVS permission to delete a broadcast. */
     deleteBroadcast: Broadcast;
+    /** Delete an integration. You should have the MANAGE_WORKSPACE permission to delete an integration. */
     deleteIntegration: Integration;
+    /** Delete a tag. You should have the MANAGE_WORKSPACE permission to delete a tag. */
     deleteTag: Tag;
     deleteWebhook: Webhook;
+    /** End a conversation. If you don't have the MANAGE_CONVS permission, you can only end the conversation you are assigned to. */
     endConv: Conversation;
+    /** Generate an API key. You should have the MANAGE_WORKSPACE permission to generate an API key. */
     genApiKey: ApiKey;
     /** Required after the creation of a workspace to take ownership on it */
     initWorkspace: UserRole;
+    /** Launch a broadcast. You should have the MANAGE_CONVS permission to launch a broadcast. */
     launchBroadcast: Broadcast;
+    /** Patch an agent. You should have the MANAGE_WORKSPACE permission to patch an agent. */
     patchAgent: Agent;
     patchAi: Ai;
+    /** Patch a broadcast. You should have the MANAGE_CONVS permission to patch a broadcast. */
     patchBroadcast: Broadcast;
+    /** Patch a client. You should have the MANAGE_CLIENTS permission to patch a client. */
     patchClient: Client;
+    /** Patch a conversation. If you don't have the MANAGE_CONVS permission, you can only patch the conversation you are assigned to. */
     patchConv: Conversation;
+    /** Patch an integration. You should have the MANAGE_WORKSPACE permission to patch an integration. */
     patchIntegration: Integration;
+    /** Put a client (Update a client if it exists, create a new one if it doesn't). You should have the MANAGE_CLIENTS permission to put a client. */
+    putClient: Client;
     say?: Maybe<HelloMessage>;
+    /** Send a notification to a client. (It can be used also for OTP messages) */
     sendNotification: Message;
+    /** Start a conversation. */
     startConv: Conversation;
+    /** Tag a client. You should have the MANAGE_CLIENTS permission to tag a client. */
     tagClient: Client;
+    /** Tag a conversation. */
     tagConv: Conversation;
+    /** Tag a message. */
     tagMessage: Message;
+    /** Untag a client. You should have the MANAGE_CLIENTS permission to untag a client. */
     untagClient: Client;
+    /** Untag a conversation. */
     untagConv: Conversation;
+    /** Untag a message. */
     untagMessage: Message;
 };
 export type MutationAddMessageArgs = {
@@ -825,6 +1232,9 @@ export type MutationPatchConvArgs = {
 export type MutationPatchIntegrationArgs = {
     input: IntegrationPatchInput;
 };
+export type MutationPutClientArgs = {
+    input: ClientPutInput;
+};
 export type MutationSayArgs = {
     input: UserInput;
 };
@@ -852,6 +1262,17 @@ export type MutationUntagConvArgs = {
 export type MutationUntagMessageArgs = {
     input: MessageTagInput;
 };
+/**
+ * NoteType is an enum of the note types.
+ * It can be:
+ * - UNASSIGN: Unassign the conversation.
+ * - ASSIGN: Assign the conversation to an agent.
+ * - TAG: Tag the conversation.
+ * - UNTAG: Untag the conversation.
+ * - STAGE: Stage the conversation.
+ * - UNSTAGE: Unstage the conversation.
+ * - MEMO: Memo message.
+ */
 export declare const NoteType: {
     readonly ASSIGN: "ASSIGN";
     readonly MEMO: "MEMO";
@@ -862,16 +1283,28 @@ export declare const NoteType: {
     readonly UNTAG: "UNTAG";
 };
 export type NoteType = typeof NoteType[keyof typeof NoteType];
+/** PageInfo is a type for the page info. It is used to paginate the results. */
 export type PageInfo = {
     __typename?: 'PageInfo';
+    /** The total count of the results. */
     count?: Maybe<Scalars['Int']['output']>;
+    /** The cursor to the next page. It is used to fetch the next page. */
     endCursor?: Maybe<Scalars['Timestamp']['output']>;
+    /** Indicates if there are more pages to fetch. */
     hasNextPage: Scalars['Boolean']['output'];
 };
+/** PageInfoInput is an input for the page info. It is used to paginate the results. */
 export type PageInfoInput = {
+    /**
+     * Whether to return the total count of the results.
+     * If true, the total count of the results will be returned in the response.
+     */
     count?: InputMaybe<Scalars['Boolean']['input']>;
+    /** The cursor to the next page. It is used to fetch the next page. */
     cursor?: InputMaybe<Scalars['Timestamp']['input']>;
+    /** The limit of the results (Number of items per page, default is 100). */
     limit?: InputMaybe<Scalars['Int']['input']>;
+    /** The query to filter the results. */
     query?: InputMaybe<Scalars['String']['input']>;
 };
 export declare const Permission: {
@@ -883,26 +1316,42 @@ export declare const Permission: {
 export type Permission = typeof Permission[keyof typeof Permission];
 export type Query = {
     __typename?: 'Query';
+    /** Get an agent. */
     agent: Agent;
+    /** Get the agents. */
     agents: AgentsPayload;
+    /** Get the agents report. You should have the MANAGE_CONVS permission to get the agents report. */
     agentsReport: AgentsReportPayload;
     ai: Ai;
     ais: AIsPayload;
+    /** Get the API keys. You should have the MANAGE_WORKSPACE permission to get the API keys. */
     apiKeys: ApiKeysPayload;
+    /** Get a broadcast. You should have the MANAGE_CONVS permission to get a broadcast. */
     broadcast: Broadcast;
+    /** Get the broadcasts. You should have the MANAGE_CONVS permission to get the broadcasts. */
     broadcasts: BroadcastsPayload;
+    /** Get a client. You should have the MANAGE_CLIENTS permission to get a client. */
     client: Client;
+    /** Get the clients. You should have the MANAGE_CLIENTS permission to get the clients. */
     clients: ClientsPayload;
+    /** Get the conversations. If you don't have the MANAGE_CONVS permission, it will return only the conversations assigned to you. */
     convs: ConvsPayload;
+    /** Get the conversations report. You should have the MANAGE_CONVS permission to get the conversations report. */
     convsReport: ConvsReportPayload;
     hello: HelloMessage;
+    /** Get an integration. */
     integration: Integration;
+    /** Get the integrations. */
     integrations: IntegrationsPayload;
     me: UserRole;
+    /** Get the messages of a conversation. */
     messages: MessagesPayload;
+    /** Get tags. */
     tags: TagsPayload;
+    /** Get the upload signature which can be used to upload a file to the cloud storage. */
     uploadSignature: UploadSignatureResult;
     usersRoles: UsersRolesPayload;
+    /** Get the WhatsApp message templates. */
     wabaMessageTemplates: MessageTemplatesPayload;
     webhooks: WebhooksPayload;
 };
@@ -984,27 +1433,76 @@ export declare const Role: {
     readonly OWNER: "OWNER";
 };
 export type Role = typeof Role[keyof typeof Role];
+/** SendNotificationInput is an input of the send notification mutation. */
 export type SendNotificationInput = {
+    /** The client id, either the client id or the phone number must be provided. */
     clientId?: InputMaybe<Scalars['ID']['input']>;
+    /** The integration/channel id of the conversation. */
     integrationId: Scalars['ID']['input'];
+    /** The phone number of the client. (e.g. "+1234567890"), either the client id or the phone number must be provided. */
     phone?: InputMaybe<Scalars['String']['input']>;
+    /**
+     * The components of the template.
+     * The components are the variables that will be replaced in the template.
+     * The components are in the format of an array of JSON objects.
+     * You can refer to the next page for the format of the components: https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates/
+     * The next example is a valid format for OTP with copy button:
+     *
+     * [
+     *     {
+     *         "type": "body",
+     *         "parameters": [
+     *             {
+     *                 "type": "text",
+     *                 "text": "123456"
+     *             }
+     *         ]
+     *     },
+     *     {
+     *         "type": "button",
+     *         "sub_type": "url",
+     *         "index": "0",
+     *         "parameters": [
+     *             {
+     *                 "type": "text",
+     *                 "text": "123456"
+     *             }
+     *         ]
+     *     }
+     * ]
+     */
     templateComponents?: InputMaybe<Scalars['JSON']['input']>;
+    /** The language of the template. (e.g. en, en_US, es_ES, etc.) */
     templateLang?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the template. (e.g. "OTP", "Welcome", "Order Confirmation", etc.) */
     templateName: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** StartByCountryCodeConfig is a configuration for the start with country code. */
 export type StartByCountryCodeConfig = {
     __typename?: 'StartByCountryCodeConfig';
+    /** The assignee id. */
     assigneeId: Scalars['ID']['output'];
+    /** The country code. */
     code: Scalars['String']['output'];
 };
+/**
+ * StartWithType is an enum for the start with configuration.
+ * - AUTO: Auto assignment of the conversation to the agent (Picking the agent with the least number of conversations).
+ * - AI: The conversation is started by AI.
+ * - AGENT: The conversation is started by an agent.
+ * - AI_BY_COUNTRY_CODE: The conversation is started by AI by country code.
+ * - AGENT_BY_COUNTRY_CODE: The conversation is started by an agent by country code.
+ */
 export declare const StartWithType: {
     readonly AGENT: "AGENT";
     readonly AGENT_BY_COUNTRY_CODE: "AGENT_BY_COUNTRY_CODE";
     readonly AI: "AI";
     readonly AI_BY_COUNTRY_CODE: "AI_BY_COUNTRY_CODE";
+    readonly AUTO: "AUTO";
 };
 export type StartWithType = typeof StartWithType[keyof typeof StartWithType];
+/** StatusUpdateDTO is data transfer object for the status update. */
 export type StatusUpdateDto = {
     __typename?: 'StatusUpdateDTO';
     createdAt: Scalars['String']['output'];
@@ -1066,6 +1564,7 @@ export type TagsPayload = {
     __typename?: 'TagsPayload';
     nodes?: Maybe<Array<Tag>>;
 };
+/** TemplateState is an enum for the template state. */
 export declare const TemplateState: {
     readonly APPROVED: "APPROVED";
     readonly DELETED: "DELETED";
@@ -1092,6 +1591,7 @@ export type UsersRolesPayload = {
     __typename?: 'UsersRolesPayload';
     nodes?: Maybe<Array<UserRole>>;
 };
+/** WabaMessageTemplatesInput is an input for the WhatsApp message templates. */
 export type WabaMessageTemplatesInput = {
     integrationId: Scalars['ID']['input'];
     workspaceId: Scalars['Int']['input'];