@naturalpay/sdk 0.2.0 → 0.2.1

package/src/resources/parties.ts

@@ -0,0 +1,493 @@
+// 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';
+
+/**
+ * Party and organization management
+ */
+export class Parties extends APIResource {
+  /**
+   * Update the authenticated caller's party details.
+   *
+   * @example
+   * ```ts
+   * const party = await client.parties.update();
+   * ```
+   */
+  update(params: PartyUpdateParams, options?: RequestOptions): APIPromise<PartyUpdateResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...body } = params;
+    return this._client.put('/parties/me', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieve the authenticated caller's party details.
+   *
+   * @example
+   * ```ts
+   * const party = await client.parties.get();
+   * ```
+   */
+  get(
+    params: PartyGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PartyGetResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID } = params ?? {};
+    return this._client.get('/parties/me', {
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * List members and pending invitations.
+   *
+   * @example
+   * ```ts
+   * const response = await client.parties.listMembers();
+   * ```
+   */
+  listMembers(
+    params: PartyListMembersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PartyListMembersResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+    return this._client.get('/parties/me/members', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface PartyUpdateResponse {
+  data: PartyUpdateResponse.Data;
+}
+
+export namespace PartyUpdateResponse {
+  export interface Data {
+    /**
+     * Unique party identifier
+     */
+    id: string;
+
+    /**
+     * Party attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Party attributes
+     */
+    export interface Attributes {
+      /**
+       * City
+       */
+      addressCity: string | null;
+
+      /**
+       * Country code (e.g., US)
+       */
+      addressCountry: string | null;
+
+      /**
+       * Street address line 1
+       */
+      addressLine1: string | null;
+
+      /**
+       * Postal or ZIP code
+       */
+      addressPostalCode: string | null;
+
+      /**
+       * State or province
+       */
+      addressState: string | null;
+
+      /**
+       * When the party was created
+       */
+      createdAt: string;
+
+      /**
+       * User who created this party (usr\_\*)
+       */
+      createdBy: string | null;
+
+      /**
+       * Display name for the party
+       */
+      displayName: string | null;
+
+      /**
+       * Party's primary contact email
+       */
+      email: string | null;
+
+      /**
+       * Legal first name for PERSON parties
+       */
+      firstName: string | null;
+
+      /**
+       * Legal last name for PERSON parties
+       */
+      lastName: string | null;
+
+      /**
+       * Legal business name for ORG parties
+       */
+      legalName: string | null;
+
+      /**
+       * Party type: individual or organization
+       */
+      partyType: 'PERSON' | 'ORG';
+
+      /**
+       * Party persona: INDIVIDUAL, DEVELOPER, or null during upstream rollout
+       */
+      persona: 'INDIVIDUAL' | 'DEVELOPER' | null;
+
+      /**
+       * Party's primary phone number
+       */
+      primaryPhone: string | null;
+
+      /**
+       * Party status (e.g., ACTIVE, SUSPENDED)
+       */
+      status: 'PROVISIONAL' | 'ACTIVE' | 'SUSPENDED' | 'INACTIVE';
+
+      /**
+       * When the party was last updated
+       */
+      updatedAt: string;
+    }
+  }
+}
+
+export interface PartyGetResponse {
+  data: PartyGetResponse.Data;
+}
+
+export namespace PartyGetResponse {
+  export interface Data {
+    /**
+     * Unique party identifier
+     */
+    id: string;
+
+    /**
+     * Party attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Party attributes
+     */
+    export interface Attributes {
+      /**
+       * City
+       */
+      addressCity: string | null;
+
+      /**
+       * Country code (e.g., US)
+       */
+      addressCountry: string | null;
+
+      /**
+       * Street address line 1
+       */
+      addressLine1: string | null;
+
+      /**
+       * Postal or ZIP code
+       */
+      addressPostalCode: string | null;
+
+      /**
+       * State or province
+       */
+      addressState: string | null;
+
+      /**
+       * When the party was created
+       */
+      createdAt: string;
+
+      /**
+       * User who created this party (usr\_\*)
+       */
+      createdBy: string | null;
+
+      /**
+       * Display name for the party
+       */
+      displayName: string | null;
+
+      /**
+       * Party's primary contact email
+       */
+      email: string | null;
+
+      /**
+       * Legal first name for PERSON parties
+       */
+      firstName: string | null;
+
+      /**
+       * Legal last name for PERSON parties
+       */
+      lastName: string | null;
+
+      /**
+       * Legal business name for ORG parties
+       */
+      legalName: string | null;
+
+      /**
+       * Party type: individual or organization
+       */
+      partyType: 'PERSON' | 'ORG';
+
+      /**
+       * Party persona: INDIVIDUAL, DEVELOPER, or null during upstream rollout
+       */
+      persona: 'INDIVIDUAL' | 'DEVELOPER' | null;
+
+      /**
+       * Party's primary phone number
+       */
+      primaryPhone: string | null;
+
+      /**
+       * Party status (e.g., ACTIVE, SUSPENDED)
+       */
+      status: 'PROVISIONAL' | 'ACTIVE' | 'SUSPENDED' | 'INACTIVE';
+
+      /**
+       * When the party was last updated
+       */
+      updatedAt: string;
+    }
+  }
+}
+
+export interface PartyListMembersResponse {
+  data: Array<PartyListMembersResponse.Data>;
+
+  meta: PartyListMembersResponse.Meta;
+}
+
+export namespace PartyListMembersResponse {
+  export interface Data {
+    /**
+     * Member id: a user id (usr_xxx), or an invitation id (inv_xxx) for pending
+     * invitations
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * When the membership was created
+       */
+      createdAt: string;
+
+      /**
+       * Email address of the user
+       */
+      email: string | null;
+
+      /**
+       * First name of the user
+       */
+      firstName: string | null;
+
+      /**
+       * Invitation ID (only for type='invitation')
+       */
+      invitationId: string | null;
+
+      /**
+       * User ID who sent the invitation
+       */
+      invitedBy: string | null;
+
+      /**
+       * Last name of the user
+       */
+      lastName: string | null;
+
+      /**
+       * ID of the party this membership belongs to
+       */
+      partyId: string;
+
+      /**
+       * User's role in the party (OWNER, ADMIN, MEMBER)
+       */
+      role: 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER';
+
+      /**
+       * Membership status
+       */
+      status: 'ACTIVE' | 'REVOKED' | 'DELETED';
+
+      /**
+       * Whether this is an active member or pending invitation
+       */
+      type: 'member' | 'invitation';
+
+      /**
+       * When the membership was last updated
+       */
+      updatedAt: string;
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface PartyUpdateParams {
+  /**
+   * Body param: Updated display name. Pass null to clear; empty string is rejected
+   * (use null to clear instead).
+   */
+  displayName?: string | null;
+
+  /**
+   * Body param: Updated party persona: INDIVIDUAL or DEVELOPER. Clearing persona to
+   * null is not supported.
+   */
+  persona?: 'INDIVIDUAL' | 'DEVELOPER';
+
+  /**
+   * 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 PartyGetParams {
+  /**
+   * 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 interface PartyListMembersParams {
+  /**
+   * Query param: Cursor for pagination
+   */
+  cursor?: string;
+
+  /**
+   * Query param: Include pending invitations alongside active members. Defaults to
+   * false.
+   */
+  includeInvitations?: boolean;
+
+  /**
+   * Query param: Max items per page
+   */
+  limit?: 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 declare namespace Parties {
+  export {
+    type PartyUpdateResponse as PartyUpdateResponse,
+    type PartyGetResponse as PartyGetResponse,
+    type PartyListMembersResponse as PartyListMembersResponse,
+    type PartyUpdateParams as PartyUpdateParams,
+    type PartyGetParams as PartyGetParams,
+    type PartyListMembersParams as PartyListMembersParams,
+  };
+}