@naturalpay/sdk 0.2.0 → 0.2.1

package/src/resources/invitations.ts

@@ -0,0 +1,414 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Party invitation management
+ */
+export class Invitations extends APIResource {
+  /**
+   * Create one or more invitations to join the authenticated user's party.
+   *
+   * @example
+   * ```ts
+   * const invitation = await client.invitations.create({
+   *   invitations: [
+   *     { email: 'dev@stainless.com', role: 'OWNER' },
+   *   ],
+   * });
+   * ```
+   */
+  create(params: InvitationCreateParams, options?: RequestOptions): APIPromise<InvitationCreateResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...body } = params;
+    return this._client.post('/party-invitations', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * List invitations with optional filters by party, email, or status.
+   *
+   * @example
+   * ```ts
+   * const invitations = await client.invitations.list();
+   * ```
+   */
+  list(
+    params: InvitationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InvitationListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+    return this._client.get('/party-invitations', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Revoke a pending invitation so it can no longer be accepted.
+   *
+   * @example
+   * ```ts
+   * const response = await client.invitations.revoke(
+   *   'invitationId',
+   * );
+   * ```
+   */
+  revoke(
+    invitationID: string,
+    params: InvitationRevokeParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InvitationRevokeResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.post(path`/party-invitations/${invitationID}/revoke`, {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface InvitationCreateResponse {
+  /**
+   * Successfully created invitation resources
+   */
+  data: Array<InvitationCreateResponse.Data>;
+
+  /**
+   * Batch invitation metadata
+   */
+  meta: InvitationCreateResponse.Meta;
+}
+
+export namespace InvitationCreateResponse {
+  export interface Data {
+    /**
+     * Invitation ID (inv_xxx)
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * When this invitation was accepted
+       */
+      acceptedAt: string | null;
+
+      /**
+       * When this invitation was created
+       */
+      createdAt: string;
+
+      /**
+       * Invitee email address
+       */
+      email: string;
+
+      /**
+       * When this invitation expires
+       */
+      expiresAt: string;
+
+      /**
+       * Role assigned on acceptance
+       */
+      role: 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER';
+
+      /**
+       * Invitation status
+       */
+      status: 'PENDING' | 'ACCEPTED' | 'REVOKED';
+    }
+  }
+
+  /**
+   * Batch invitation metadata
+   */
+  export interface Meta {
+    /**
+     * Failed invitation attempts with error details
+     */
+    failed: Array<Meta.Failed>;
+  }
+
+  export namespace Meta {
+    /**
+     * Failed invitation result
+     */
+    export interface Failed {
+      /**
+       * Email address that was invited
+       */
+      email: string;
+
+      /**
+       * Error message for failed invitation
+       */
+      error: string;
+    }
+  }
+}
+
+export interface InvitationListResponse {
+  data: Array<InvitationListResponse.Data>;
+
+  meta: InvitationListResponse.Meta;
+}
+
+export namespace InvitationListResponse {
+  export interface Data {
+    /**
+     * Invitation ID (inv_xxx)
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * When this invitation was accepted
+       */
+      acceptedAt: string | null;
+
+      /**
+       * When this invitation was created
+       */
+      createdAt: string;
+
+      /**
+       * Invitee email address
+       */
+      email: string;
+
+      /**
+       * When this invitation expires
+       */
+      expiresAt: string;
+
+      /**
+       * Role assigned on acceptance
+       */
+      role: 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER';
+
+      /**
+       * Invitation status
+       */
+      status: 'PENDING' | 'ACCEPTED' | 'REVOKED';
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface InvitationRevokeResponse {
+  data: InvitationRevokeResponse.Data;
+}
+
+export namespace InvitationRevokeResponse {
+  export interface Data {
+    /**
+     * Invitation ID (inv_xxx)
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * When this invitation was accepted
+       */
+      acceptedAt: string | null;
+
+      /**
+       * When this invitation was created
+       */
+      createdAt: string;
+
+      /**
+       * Invitee email address
+       */
+      email: string;
+
+      /**
+       * When this invitation expires
+       */
+      expiresAt: string;
+
+      /**
+       * Role assigned on acceptance
+       */
+      role: 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER';
+
+      /**
+       * Invitation status
+       */
+      status: 'PENDING' | 'ACCEPTED' | 'REVOKED';
+    }
+  }
+}
+
+export interface InvitationCreateParams {
+  /**
+   * Body param: List of invitations to create (max 100)
+   */
+  invitations: Array<InvitationCreateParams.Invitation>;
+
+  /**
+   * Body param: Days until invitation expires (1-30)
+   */
+  expiresInDays?: number;
+
+  /**
+   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Required when X-Agent-ID is present. Session or conversation ID
+   * for agent observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export namespace InvitationCreateParams {
+  /**
+   * Single invitation in batch request
+   */
+  export interface Invitation {
+    /**
+     * Email address to invite
+     */
+    email: string;
+
+    /**
+     * Role to assign on acceptance
+     */
+    role: 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER';
+  }
+}
+
+export interface InvitationListParams {
+  /**
+   * Query param: Filter by email
+   */
+  email?: string;
+
+  /**
+   * Query param: Filter by party
+   */
+  partyId?: string;
+
+  /**
+   * Query param: Filter by status
+   */
+  status?: 'PENDING' | 'ACCEPTED' | 'REVOKED';
+
+  /**
+   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Required when X-Agent-ID is present. Session or conversation ID
+   * for agent observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export interface InvitationRevokeParams {
+  /**
+   * Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Required when X-Agent-ID is present. Session or conversation ID for agent
+   * observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export declare namespace Invitations {
+  export {
+    type InvitationCreateResponse as InvitationCreateResponse,
+    type InvitationListResponse as InvitationListResponse,
+    type InvitationRevokeResponse as InvitationRevokeResponse,
+    type InvitationCreateParams as InvitationCreateParams,
+    type InvitationListParams as InvitationListParams,
+    type InvitationRevokeParams as InvitationRevokeParams,
+  };
+}