@pidgeon-ai/sdk 1.0.0 → 1.1.0

package/dist/index.d.cts

@@ -366,12 +366,18 @@ type AgentVerified = {
     address: string;
     identity_id: string;
     sign_in_url: string;
+    api_key: string;
+    api_key_id: string;
 };
 type Identity = {
     id: string;
     email: string;
     local_part: string;
     domain: string;
+    /**
+     * Pass this to POST /identities to add another address here.
+     */
+    domain_id: string;
     display_name: string | null;
     /**
      * human, team, application, workflow or agent.
@@ -984,7 +990,7 @@ type Replayed = {
     status: 'pending';
 };
 type Mailbox = {
-    folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash';
+    folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
     /**
      * Null where the product does not count that folder. Not zero — zero is a claim.
      */
@@ -1273,6 +1279,9 @@ type IdentitiesListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         tenant_id?: string;
     };
@@ -1309,8 +1318,10 @@ type IdentitiesListResponses = {
 type IdentitiesListResponse = IdentitiesListResponses[keyof IdentitiesListResponses];
 type IdentitiesCreateData = {
     body: {
-        domain_id: string;
-        local_part: string;
+        domain_id?: string;
+        domain?: string;
+        address?: string;
+        local_part?: string;
         display_name?: string | null;
         type?: 'human' | 'team' | 'application' | 'workflow' | 'agent';
         mode?: 'human' | 'automated' | 'hybrid';
@@ -2045,6 +2056,9 @@ type MessagesListInThreadData = {
     path?: never;
     query: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         thread_id: string;
     };
@@ -2125,7 +2139,7 @@ type MessagesSearchData = {
     query: {
         identity_id: string;
         q?: string;
-        in?: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash';
+        in?: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
         from?: string;
         to?: string;
         has_attachment?: string;
@@ -2450,7 +2464,17 @@ type ThreadsListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
+        identity_id?: string;
+        status?: 'open' | 'waiting' | 'resolved' | 'human_review';
+        owner_type?: 'human' | 'automation' | 'agent';
+        /**
+         * A person’s id, or `unassigned` for the queue nobody has taken.
+         */
+        assignee_id?: string | 'unassigned';
     };
     url: '/threads';
 };
@@ -2556,6 +2580,9 @@ type DomainsListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
     };
     url: '/domains';
@@ -3086,6 +3113,9 @@ type MailboxesListFolderData = {
     query: {
         identity_id: string;
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         label_id?: string;
     };
@@ -3460,6 +3490,9 @@ type EventsListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         type?: string;
         identity_id?: string;
@@ -3533,6 +3566,9 @@ type WebhooksListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
     };
     url: '/webhooks';
@@ -3956,6 +3992,9 @@ type CalendarListEventsData = {
     };
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
     };
     url: '/identities/{id}/calendar/events';
@@ -4753,7 +4792,7 @@ declare const agentAttachHuman: <ThrowOnError extends boolean = false>(options:
 /**
  * Verify an agent with the human’s code
  *
- * Creates the account and the address. Ten wrong codes spend the signup, whatever comes next. It returns no key: the agent asks for one through the account it now belongs to, which is how every other key is made.
+ * Creates the account, the address and a workspace-scoped API key. Ten wrong codes spend the signup, whatever comes next. The key is returned once and never again — store it before doing anything else. It is minted here rather than at signup because this is the call a human has vouched for.
  */
 declare const agentVerify: <ThrowOnError extends boolean = false>(options: Options<AgentVerifyData, ThrowOnError>) => RequestResult<AgentVerifyResponses, AgentVerifyErrors, ThrowOnError>;
 /**

package/dist/index.d.ts

@@ -366,12 +366,18 @@ type AgentVerified = {
     address: string;
     identity_id: string;
     sign_in_url: string;
+    api_key: string;
+    api_key_id: string;
 };
 type Identity = {
     id: string;
     email: string;
     local_part: string;
     domain: string;
+    /**
+     * Pass this to POST /identities to add another address here.
+     */
+    domain_id: string;
     display_name: string | null;
     /**
      * human, team, application, workflow or agent.
@@ -984,7 +990,7 @@ type Replayed = {
     status: 'pending';
 };
 type Mailbox = {
-    folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash';
+    folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
     /**
      * Null where the product does not count that folder. Not zero — zero is a claim.
      */
@@ -1273,6 +1279,9 @@ type IdentitiesListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         tenant_id?: string;
     };
@@ -1309,8 +1318,10 @@ type IdentitiesListResponses = {
 type IdentitiesListResponse = IdentitiesListResponses[keyof IdentitiesListResponses];
 type IdentitiesCreateData = {
     body: {
-        domain_id: string;
-        local_part: string;
+        domain_id?: string;
+        domain?: string;
+        address?: string;
+        local_part?: string;
         display_name?: string | null;
         type?: 'human' | 'team' | 'application' | 'workflow' | 'agent';
         mode?: 'human' | 'automated' | 'hybrid';
@@ -2045,6 +2056,9 @@ type MessagesListInThreadData = {
     path?: never;
     query: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         thread_id: string;
     };
@@ -2125,7 +2139,7 @@ type MessagesSearchData = {
     query: {
         identity_id: string;
         q?: string;
-        in?: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash';
+        in?: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
         from?: string;
         to?: string;
         has_attachment?: string;
@@ -2450,7 +2464,17 @@ type ThreadsListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
+        identity_id?: string;
+        status?: 'open' | 'waiting' | 'resolved' | 'human_review';
+        owner_type?: 'human' | 'automation' | 'agent';
+        /**
+         * A person’s id, or `unassigned` for the queue nobody has taken.
+         */
+        assignee_id?: string | 'unassigned';
     };
     url: '/threads';
 };
@@ -2556,6 +2580,9 @@ type DomainsListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
     };
     url: '/domains';
@@ -3086,6 +3113,9 @@ type MailboxesListFolderData = {
     query: {
         identity_id: string;
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         label_id?: string;
     };
@@ -3460,6 +3490,9 @@ type EventsListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
         type?: string;
         identity_id?: string;
@@ -3533,6 +3566,9 @@ type WebhooksListData = {
     path?: never;
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
     };
     url: '/webhooks';
@@ -3956,6 +3992,9 @@ type CalendarListEventsData = {
     };
     query?: {
         limit?: number;
+        /**
+         * From a previous page’s `next_cursor`. Opaque — do not parse it.
+         */
         cursor?: string;
     };
     url: '/identities/{id}/calendar/events';
@@ -4753,7 +4792,7 @@ declare const agentAttachHuman: <ThrowOnError extends boolean = false>(options:
 /**
  * Verify an agent with the human’s code
  *
- * Creates the account and the address. Ten wrong codes spend the signup, whatever comes next. It returns no key: the agent asks for one through the account it now belongs to, which is how every other key is made.
+ * Creates the account, the address and a workspace-scoped API key. Ten wrong codes spend the signup, whatever comes next. The key is returned once and never again — store it before doing anything else. It is minted here rather than at signup because this is the call a human has vouched for.
  */
 declare const agentVerify: <ThrowOnError extends boolean = false>(options: Options<AgentVerifyData, ThrowOnError>) => RequestResult<AgentVerifyResponses, AgentVerifyErrors, ThrowOnError>;
 /**