@bcrumbs.net/inbox 0.0.58 → 0.0.60

package/src/graphql.autogenerated.d.ts

@@ -87,6 +87,7 @@ export type Ai = {
     id: Scalars['ID']['output'];
     integrationProperties?: Maybe<IntegrationProperties>;
     name: Scalars['String']['output'];
+    subType?: Maybe<AiSubType>;
     type: AiType;
     workspaceId: Scalars['Int']['output'];
 };
@@ -94,6 +95,7 @@ export type AiCreateInput = {
     configuration?: InputMaybe<ConfigurationsInput>;
     integrationProperties: Scalars['JSON']['input'];
     name: Scalars['String']['input'];
+    subType?: InputMaybe<AiSubType>;
     type: AiType;
     workspaceId: Scalars['Int']['input'];
 };
@@ -110,8 +112,15 @@ export type AiPatchInput = {
     id: Scalars['ID']['input'];
     integrationProperties?: InputMaybe<Scalars['JSON']['input']>;
     name?: InputMaybe<Scalars['String']['input']>;
+    subType?: InputMaybe<AiSubType>;
     workspaceId: Scalars['Int']['input'];
 };
+export declare const AiSubType: {
+    readonly PROFILE: "profile";
+    readonly QA: "qa";
+    readonly RATING: "rating";
+};
+export type AiSubType = typeof AiSubType[keyof typeof AiSubType];
 export declare const AiType: {
     readonly BC_AI: "bc_ai";
     readonly BC_FLOW: "bc_flow";
@@ -122,6 +131,7 @@ export declare const AiType: {
 export type AiType = typeof AiType[keyof typeof AiType];
 export type AIsInput = {
     name?: InputMaybe<Scalars['String']['input']>;
+    subType?: InputMaybe<AiSubType>;
     type?: InputMaybe<AiType>;
     workspaceId: Scalars['Int']['input'];
 };
@@ -139,6 +149,8 @@ export type Agent = {
     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'];
+    /** An optional message automatically sent to the customer at the start of every new conversation assigned to this agent. */
+    greetingMessage?: Maybe<Scalars['String']['output']>;
     id: Scalars['ID']['output'];
     /** The name of the agent. */
     name: Scalars['String']['output'];
@@ -195,6 +207,8 @@ export type AgentInput = {
 export type AgentPatchInput = {
     /** When false, this agent is excluded from automatic assignment. */
     assignable: Scalars['Boolean']['input'];
+    /** An optional message automatically sent to the customer at the start of every new conversation assigned to this agent. Pass null to clear. */
+    greetingMessage?: InputMaybe<Scalars['String']['input']>;
     id: Scalars['ID']['input'];
     /** The name of the agent. */
     name: Scalars['String']['input'];
@@ -935,6 +949,7 @@ export type Configurations = {
     emptyResponseFallbackMessage?: Maybe<Scalars['String']['output']>;
     endEnabled?: Maybe<Scalars['Boolean']['output']>;
     handoverEnabled?: Maybe<Scalars['Boolean']['output']>;
+    instructionsVersion?: Maybe<Scalars['String']['output']>;
     personaPrompt?: Maybe<Scalars['String']['output']>;
     rolePrompt?: Maybe<Scalars['String']['output']>;
 };
@@ -952,6 +967,7 @@ export type ConfigurationsInput = {
     emptyResponseFallbackMessage?: InputMaybe<Scalars['String']['input']>;
     endEnabled?: InputMaybe<Scalars['Boolean']['input']>;
     handoverEnabled?: InputMaybe<Scalars['Boolean']['input']>;
+    instructionsVersion?: InputMaybe<Scalars['String']['input']>;
     personaPrompt?: InputMaybe<Scalars['String']['input']>;
     rolePrompt?: InputMaybe<Scalars['String']['input']>;
 };
@@ -1192,6 +1208,57 @@ export type ConvTagInput = {
     tag: Scalars['String']['input'];
     workspaceId: Scalars['Int']['input'];
 };
+/** ConvTagReport is a report of conversations breaked down by tag per day. It is used to understand tag performance. */
+export type ConvTagReport = {
+    __typename?: 'ConvTagReport';
+    /** The number of messages sent by the agents. */
+    agentMessagesCount: Scalars['Int']['output'];
+    /** The average rating for rated conversations. */
+    averageRating: Scalars['Float']['output'];
+    /** The average time of the conversation. */
+    avgConversationTime: Scalars['Int']['output'];
+    /** The average time to first response. */
+    avgFirstResponseTime: Scalars['Int']['output'];
+    /** The number of messages sent by the clients. */
+    clientMessageCount: Scalars['Int']['output'];
+    /** The number of conversations with this tag. */
+    conversationCount: Scalars['Int']['output'];
+    /** The date and time when the tag report was created. */
+    createdAt: Scalars['DateTime']['output'];
+    /** The CSAT percentage (4 and 5 ratings over rated conversations). */
+    csat: Scalars['Float']['output'];
+    /** Conversations included in avgFirstResponseTime (client messaged before the agent replied). */
+    firstResponseConversationCount: Scalars['Int']['output'];
+    id: Scalars['ID']['output'];
+    /** The integration (channel) id. */
+    integrationId: Scalars['ID']['output'];
+    /** The number of new client conversations. */
+    newClientConvCount?: Maybe<Scalars['Int']['output']>;
+    /** The percentage of conversations that received a rating. */
+    responseRate: Scalars['Float']['output'];
+    /** The tag name. */
+    tag: Scalars['String']['output'];
+    workspaceId: Scalars['Int']['output'];
+};
+/** ConvTagsReportInput is an input of the conversation tags report query. */
+export type ConvTagsReportInput = {
+    /** The end date of the report. */
+    endDate: Scalars['DateTime']['input'];
+    /** The integration/channel id of the conversation. */
+    integrationId?: InputMaybe<Scalars['ID']['input']>;
+    /** The start date of the report. */
+    startDate: Scalars['DateTime']['input'];
+    /** Filter by a single tag name. */
+    tag?: InputMaybe<Scalars['String']['input']>;
+    /** Filter by multiple tag names (OR). When non-empty, takes precedence over tag. */
+    tags?: InputMaybe<Array<Scalars['String']['input']>>;
+    workspaceId: Scalars['Int']['input'];
+};
+/** ConvTagsReportPayload is a payload of the conversation tags report query. */
+export type ConvTagsReportPayload = {
+    __typename?: 'ConvTagsReportPayload';
+    nodes?: Maybe<Array<ConvTagReport>>;
+};
 /** Conversation is a type of the conversation. */
 export type Conversation = {
     __typename?: 'Conversation';
@@ -1600,6 +1667,8 @@ export type MediaType = typeof MediaType[keyof typeof MediaType];
 /** Message is a type of the message. */
 export type Message = {
     __typename?: 'Message';
+    /** When the message record was persisted in the database. Null for legacy rows. */
+    addedAt?: Maybe<Scalars['DateTime']['output']>;
     /** The id of the agent that sent the message. */
     agentId?: Maybe<Scalars['ID']['output']>;
     /**
@@ -1609,7 +1678,7 @@ export type Message = {
     content: Scalars['String']['output'];
     /** The context of the message. */
     context?: Maybe<MessageContext>;
-    /** The date and time when the message was created. */
+    /** When the message was sent or received on the channel (e.g. WhatsApp timestamp). */
     createdAt: Scalars['DateTime']['output'];
     /** The external message id of the message. */
     externalMessageId?: Maybe<Scalars['String']['output']>;
@@ -1946,7 +2015,10 @@ export type Mutation = {
      * (It can be used also for OTP messages)
      */
     sendNotificationAndWait: Message;
-    /** Start a conversation. */
+    /**
+     * Start a conversation. Agents without MANAGE_CONVS may start conversations;
+     * the new conversation is assigned to the starting agent when applicable.
+     */
     startConv: Conversation;
     /** Tag a client. You should have the MANAGE_CLIENTS permission to tag a client. */
     tagClient: Client;
@@ -2257,6 +2329,8 @@ export type Query = {
     convLastMessage?: Maybe<Message>;
     /** Get an AI summary for conversation messages. */
     convSummary: ConvAssistPayload;
+    /** Get the conversation tags report. You should have the MANAGE_CONVS permission to get the tags report. */
+    convTagsReport: ConvTagsReportPayload;
     /** 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. */
@@ -2274,7 +2348,7 @@ export type Query = {
      */
     isWorkspaceNameAvailable: Scalars['Boolean']['output'];
     me: UserRole;
-    /** Get messages with optional filters. */
+    /** Get messages with optional filters. If you don't have the MANAGE_CONVS permission, it will return only messages for conversations assigned to you. */
     messages: MessagesPayload;
     /** Get the count of open conversations that have recent client messages (conversations that need a response). */
     openConversationsNeedResponseCount: Scalars['Int']['output'];
@@ -2287,7 +2361,10 @@ export type Query = {
     tokenUsageLogs: TokenUsageLogsPayload;
     /** Get total token usage between two dates. */
     tokenUsageTotal: TokenUsageTotal;
-    /** Get the upload signature which can be used to upload a file to the cloud storage. */
+    /**
+     * Get the upload signature which can be used to upload a file to the cloud storage.
+     * Requires MANAGE_WORKSPACE permission. Blob path must be scoped to the workspace.
+     */
     uploadSignature: UploadSignatureResult;
     usersRoles: UsersRolesPayload;
     /** Validate a bulk import contacts CSV file before importing. Returns validation errors for each row. You should have the MANAGE_CLIENTS permission to validate files. */
@@ -2372,6 +2449,9 @@ export type QueryConvLastMessageArgs = {
 export type QueryConvSummaryArgs = {
     input: ConvAssistInput;
 };
+export type QueryConvTagsReportArgs = {
+    input: ConvTagsReportInput;
+};
 export type QueryConvsArgs = {
     input: ConvsInput;
     pageInfo?: InputMaybe<PageInfoInput>;
@@ -2582,6 +2662,8 @@ export type StartByCountryCodeConfig = {
     __typename?: 'StartByCountryCodeConfig';
     /** The assignee id. */
     assigneeId: Scalars['ID']['output'];
+    /** Multiple assignee ids for agent pool distribution. */
+    assigneeIds?: Maybe<Array<Scalars['ID']['output']>>;
     /** The country code. */
     code: Scalars['String']['output'];
 };
@@ -2992,6 +3074,7 @@ export type AiFragment = {
     id: string;
     name: string;
     type: AiType;
+    subType?: AiSubType | null;
     createdAt: any;
     deletedAt?: any | null;
     integrationProperties?: {
@@ -3002,6 +3085,7 @@ export type AiFragment = {
     } | null;
     configuration?: {
         __typename?: 'Configurations';
+        instructionsVersion?: string | null;
         askForName?: boolean | null;
         askForSurname?: boolean | null;
         askForEmail?: boolean | null;
@@ -3038,6 +3122,7 @@ export type AiQuery = {
         id: string;
         name: string;
         type: AiType;
+        subType?: AiSubType | null;
         createdAt: any;
         deletedAt?: any | null;
         integrationProperties?: {
@@ -3048,6 +3133,7 @@ export type AiQuery = {
         } | null;
         configuration?: {
             __typename?: 'Configurations';
+            instructionsVersion?: string | null;
             askForName?: boolean | null;
             askForSurname?: boolean | null;
             askForEmail?: boolean | null;
@@ -3087,6 +3173,7 @@ export type AisQuery = {
             id: string;
             name: string;
             type: AiType;
+            subType?: AiSubType | null;
             createdAt: any;
             deletedAt?: any | null;
             integrationProperties?: {
@@ -3097,6 +3184,7 @@ export type AisQuery = {
             } | null;
             configuration?: {
                 __typename?: 'Configurations';
+                instructionsVersion?: string | null;
                 askForName?: boolean | null;
                 askForSurname?: boolean | null;
                 askForEmail?: boolean | null;
@@ -3135,6 +3223,7 @@ export type CreateAiMutation = {
         id: string;
         name: string;
         type: AiType;
+        subType?: AiSubType | null;
         createdAt: any;
         deletedAt?: any | null;
         integrationProperties?: {
@@ -3145,6 +3234,7 @@ export type CreateAiMutation = {
         } | null;
         configuration?: {
             __typename?: 'Configurations';
+            instructionsVersion?: string | null;
             askForName?: boolean | null;
             askForSurname?: boolean | null;
             askForEmail?: boolean | null;
@@ -3197,6 +3287,7 @@ export type DeleteAiMutation = {
         id: string;
         name: string;
         type: AiType;
+        subType?: AiSubType | null;
         createdAt: any;
         deletedAt?: any | null;
         integrationProperties?: {
@@ -3207,6 +3298,7 @@ export type DeleteAiMutation = {
         } | null;
         configuration?: {
             __typename?: 'Configurations';
+            instructionsVersion?: string | null;
             askForName?: boolean | null;
             askForSurname?: boolean | null;
             askForEmail?: boolean | null;
@@ -3259,6 +3351,7 @@ export type PatchAiMutation = {
         id: string;
         name: string;
         type: AiType;
+        subType?: AiSubType | null;
         createdAt: any;
         deletedAt?: any | null;
         integrationProperties?: {
@@ -3269,6 +3362,7 @@ export type PatchAiMutation = {
         } | null;
         configuration?: {
             __typename?: 'Configurations';
+            instructionsVersion?: string | null;
             askForName?: boolean | null;
             askForSurname?: boolean | null;
             askForEmail?: boolean | null;
@@ -3877,6 +3971,24 @@ export type AgentReportFragment = {
     csat: number;
     createdAt: any;
 };
+export type ConvTagReportFragment = {
+    __typename?: 'ConvTagReport';
+    workspaceId: number;
+    id: string;
+    tag: string;
+    integrationId: string;
+    conversationCount: number;
+    agentMessagesCount: number;
+    clientMessageCount: number;
+    avgFirstResponseTime: number;
+    firstResponseConversationCount: number;
+    avgConversationTime: number;
+    newClientConvCount?: number | null;
+    responseRate: number;
+    averageRating: number;
+    csat: number;
+    createdAt: any;
+};
 export type ConversationReportFragment = {
     __typename?: 'ConversationReport';
     workspaceId: number;
@@ -3921,6 +4033,33 @@ export type AgentsReportQuery = {
         }> | null;
     };
 };
+export type ConvTagsReportQueryVariables = Exact<{
+    input: ConvTagsReportInput;
+}>;
+export type ConvTagsReportQuery = {
+    __typename?: 'Query';
+    convTagsReport: {
+        __typename?: 'ConvTagsReportPayload';
+        nodes?: Array<{
+            __typename?: 'ConvTagReport';
+            workspaceId: number;
+            id: string;
+            tag: string;
+            integrationId: string;
+            conversationCount: number;
+            agentMessagesCount: number;
+            clientMessageCount: number;
+            avgFirstResponseTime: number;
+            firstResponseConversationCount: number;
+            avgConversationTime: number;
+            newClientConvCount?: number | null;
+            responseRate: number;
+            averageRating: number;
+            csat: number;
+            createdAt: any;
+        }> | null;
+    };
+};
 export type ConvsReportQueryVariables = Exact<{
     input: ConvsReportInput;
 }>;
@@ -3974,6 +4113,7 @@ export type AgentFragment = {
     email: string;
     avatar?: string | null;
     assignable: boolean;
+    greetingMessage?: string | null;
     createdAt: any;
 };
 export type ConversationFragment = {
@@ -4130,6 +4270,7 @@ export type AgentQuery = {
         email: string;
         avatar?: string | null;
         assignable: boolean;
+        greetingMessage?: string | null;
         createdAt: any;
     };
 };
@@ -4151,6 +4292,7 @@ export type AgentsQuery = {
             email: string;
             avatar?: string | null;
             assignable: boolean;
+            greetingMessage?: string | null;
             createdAt: any;
         }> | null;
         pageInfo?: {
@@ -4432,6 +4574,7 @@ export type CreateAgentMutation = {
         email: string;
         avatar?: string | null;
         assignable: boolean;
+        greetingMessage?: string | null;
         createdAt: any;
     };
 };
@@ -4450,6 +4593,7 @@ export type DeleteAgentMutation = {
         email: string;
         avatar?: string | null;
         assignable: boolean;
+        greetingMessage?: string | null;
         createdAt: any;
     };
 };
@@ -4653,6 +4797,7 @@ export type PatchAgentMutation = {
         email: string;
         avatar?: string | null;
         assignable: boolean;
+        greetingMessage?: string | null;
         createdAt: any;
     };
 };
@@ -5539,6 +5684,7 @@ export type CreateAgentWithApiKeyMutation = {
             email: string;
             avatar?: string | null;
             assignable: boolean;
+            greetingMessage?: string | null;
             createdAt: any;
         };
         apiKey: {
@@ -5875,6 +6021,7 @@ export declare const UserRoleFragmentDoc: Apollo.DocumentNode;
 export declare const BroadcastFragmentDoc: Apollo.DocumentNode;
 export declare const BroadcastReportFragmentDoc: Apollo.DocumentNode;
 export declare const AgentReportFragmentDoc: Apollo.DocumentNode;
+export declare const ConvTagReportFragmentDoc: Apollo.DocumentNode;
 export declare const ConversationReportFragmentDoc: Apollo.DocumentNode;
 export declare const PageInfoFragmentDoc: Apollo.DocumentNode;
 export declare const AgentFragmentDoc: Apollo.DocumentNode;
@@ -6935,6 +7082,47 @@ export declare function refetchAgentsReportQuery(variables: AgentsReportQueryVar
         input: AgentsReportInput;
     }>;
 };
+export declare const ConvTagsReportDocument: Apollo.DocumentNode;
+/**
+ * __useConvTagsReportQuery__
+ *
+ * To run a query within a React component, call `useConvTagsReportQuery` and pass it any options that fit your needs.
+ * When your component renders, `useConvTagsReportQuery` returns an object from Apollo Client that contains loading, error, and data properties
+ * you can use to render your UI.
+ *
+ * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options;
+ *
+ * @example
+ * const { data, loading, error } = useConvTagsReportQuery({
+ *   variables: {
+ *      input: // value for 'input'
+ *   },
+ * });
+ */
+export declare function useConvTagsReportQuery(baseOptions: Apollo.QueryHookOptions<ConvTagsReportQuery, ConvTagsReportQueryVariables> & ({
+    variables: ConvTagsReportQueryVariables;
+    skip?: boolean;
+} | {
+    skip: boolean;
+})): Apollo.QueryResult<ConvTagsReportQuery, Exact<{
+    input: ConvTagsReportInput;
+}>>;
+export declare function useConvTagsReportLazyQuery(baseOptions?: Apollo.LazyQueryHookOptions<ConvTagsReportQuery, ConvTagsReportQueryVariables>): Apollo.LazyQueryResultTuple<ConvTagsReportQuery, Exact<{
+    input: ConvTagsReportInput;
+}>>;
+export declare function useConvTagsReportSuspenseQuery(baseOptions?: Apollo.SkipToken | Apollo.SuspenseQueryHookOptions<ConvTagsReportQuery, ConvTagsReportQueryVariables>): Apollo.UseSuspenseQueryResult<ConvTagsReportQuery | undefined, Exact<{
+    input: ConvTagsReportInput;
+}>>;
+export type ConvTagsReportQueryHookResult = ReturnType<typeof useConvTagsReportQuery>;
+export type ConvTagsReportLazyQueryHookResult = ReturnType<typeof useConvTagsReportLazyQuery>;
+export type ConvTagsReportSuspenseQueryHookResult = ReturnType<typeof useConvTagsReportSuspenseQuery>;
+export type ConvTagsReportQueryResult = Apollo.QueryResult<ConvTagsReportQuery, ConvTagsReportQueryVariables>;
+export declare function refetchConvTagsReportQuery(variables: ConvTagsReportQueryVariables): {
+    query: Apollo.DocumentNode;
+    variables: Exact<{
+        input: ConvTagsReportInput;
+    }>;
+};
 export declare const ConvsReportDocument: Apollo.DocumentNode;
 /**
  * __useConvsReportQuery__