@augno/sdk 0.7.0 → 0.9.0

package/src/resources/messaging/conversations/participants/actions.ts

@@ -0,0 +1,92 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as ConversationsAPI from '../conversations';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * Add, remove, and manage participants (including agents) in a conversation.
+ */
+export class Actions extends APIResource {
+  /**
+   * Changes a participant's role within a group conversation.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const conversation =
+   *   await client.messaging.conversations.participants.actions.setRole(
+   *     'cvpt_01h9z8q1w2e3r4t5y6u7cvpt',
+   *     { id: 'cv_01h9z8q1w2e3r4t5y6u7i8cv', role: 'admin' },
+   *   );
+   * ```
+   */
+  setRole(
+    pid: string,
+    params: ActionSetRoleParams,
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.Conversation> {
+    const { id, include, ...body } = params;
+    return this._client.post(path`/v1/messaging/conversations/${id}/participants/${pid}/actions/set-role`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+}
+
+/**
+ * Request to change a participant's role (owner only).
+ */
+export interface UpdateParticipantRoleRequest {
+  /**
+   * The role to assign to the participant.
+   *
+   * - `owner`: can rename or delete the conversation and manage members and roles.
+   * - `admin`: can add and remove members and rename the conversation.
+   * - `member`: can post, leave, mute, and react.
+   * - `viewer`: read-only access.
+   */
+  role: 'owner' | 'admin' | 'member' | 'viewer';
+}
+
+export interface ActionSetRoleParams {
+  /**
+   * Path param: Conversation ID.
+   */
+  id: string;
+
+  /**
+   * Body param: The role to assign to the participant.
+   *
+   * - `owner`: can rename or delete the conversation and manage members and roles.
+   * - `admin`: can add and remove members and rename the conversation.
+   * - `member`: can post, leave, mute, and react.
+   * - `viewer`: read-only access.
+   */
+  role: 'owner' | 'admin' | 'member' | 'viewer';
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'participants'
+    | 'topic'
+    | 'last_message'
+    | 'last_message.sender'
+    | 'last_message.author'
+    | 'last_message.resource'
+    | 'last_message.attachments'
+  >;
+}
+
+export declare namespace Actions {
+  export {
+    type UpdateParticipantRoleRequest as UpdateParticipantRoleRequest,
+    type ActionSetRoleParams as ActionSetRoleParams,
+  };
+}

package/src/resources/messaging/conversations/participants/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type UpdateParticipantRoleRequest, type ActionSetRoleParams } from './actions';
+export {
+  Participants,
+  type AddParticipantRequest,
+  type ParticipantDeleteResponse,
+  type ParticipantCreateParams,
+  type ParticipantDeleteParams,
+} from './participants';

package/src/resources/messaging/conversations/participants/participants.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as ConversationsAPI from '../conversations';
+import * as ActionsAPI from './actions';
+import { ActionSetRoleParams, Actions, UpdateParticipantRoleRequest } from './actions';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * Add, remove, and manage participants (including agents) in a conversation.
+ */
+export class Participants extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Adds (or reactivates) a participant in a group conversation.
+   *
+   * This endpoint requires the permission: `messaging:create`.
+   *
+   * @example
+   * ```ts
+   * const conversation =
+   *   await client.messaging.conversations.participants.create(
+   *     'cv_01h9z8q1w2e3r4t5y6u7i8cv',
+   *     {
+   *       account_user_id: 'acus_01ea9983ddb41dacc44ecf997c',
+   *       role: 'member',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    id: string,
+    params: ParticipantCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.Conversation> {
+    const { include, ...body } = params;
+    return this._client.post(path`/v1/messaging/conversations/${id}/participants`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Removes a participant from a group conversation.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const participant =
+   *   await client.messaging.conversations.participants.delete(
+   *     'cvpt_01h9z8q1w2e3r4t5y6u7cvpt',
+   *     { id: 'cv_01h9z8q1w2e3r4t5y6u7i8cv' },
+   *   );
+   * ```
+   */
+  delete(
+    pid: string,
+    params: ParticipantDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ParticipantDeleteResponse> {
+    const { id } = params;
+    return this._client.delete(path`/v1/messaging/conversations/${id}/participants/${pid}`, options);
+  }
+}
+
+/**
+ * Request to add a participant to a group (owner/admin).
+ */
+export interface AddParticipantRequest {
+  /**
+   * The account user to add.
+   */
+  account_user_id: string;
+
+  /**
+   * Role to grant the new participant.
+   *
+   * - `admin`: can add and remove members and rename the conversation.
+   * - `member`: can post, leave, mute, and react.
+   * - `viewer`: read-only access.
+   *
+   * `owner` is not accepted here; ownership can only be transferred via the set-role
+   * endpoint.
+   */
+  role?: 'owner' | 'admin' | 'member' | 'viewer';
+}
+
+export interface ParticipantDeleteResponse {}
+
+export interface ParticipantCreateParams {
+  /**
+   * Body param: The account user to add.
+   */
+  account_user_id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'participants'
+    | 'topic'
+    | 'last_message'
+    | 'last_message.sender'
+    | 'last_message.author'
+    | 'last_message.resource'
+    | 'last_message.attachments'
+  >;
+
+  /**
+   * Body param: Role to grant the new participant.
+   *
+   * - `admin`: can add and remove members and rename the conversation.
+   * - `member`: can post, leave, mute, and react.
+   * - `viewer`: read-only access.
+   *
+   * `owner` is not accepted here; ownership can only be transferred via the set-role
+   * endpoint.
+   */
+  role?: 'owner' | 'admin' | 'member' | 'viewer';
+}
+
+export interface ParticipantDeleteParams {
+  /**
+   * Conversation ID.
+   */
+  id: string;
+}
+
+Participants.Actions = Actions;
+
+export declare namespace Participants {
+  export {
+    type AddParticipantRequest as AddParticipantRequest,
+    type ParticipantDeleteResponse as ParticipantDeleteResponse,
+    type ParticipantCreateParams as ParticipantCreateParams,
+    type ParticipantDeleteParams as ParticipantDeleteParams,
+  };
+
+  export {
+    Actions as Actions,
+    type UpdateParticipantRoleRequest as UpdateParticipantRoleRequest,
+    type ActionSetRoleParams as ActionSetRoleParams,
+  };
+}

package/src/resources/messaging/conversations/participants.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './participants/index';

package/src/resources/messaging/conversations.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './conversations/index';

package/src/resources/messaging/email-domains/actions.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as EmailDomainsAPI from './email-domains';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Register customer-owned domains with the email bridge and verify them for sending and receiving mail.
+ */
+export class Actions extends APIResource {
+  /**
+   * Re-polls the provider and flips the domain to `verified` once its DKIM records
+   * are confirmed.
+   *
+   * Returns the updated domain (still `pending` if not yet confirmed).
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const emailDomain =
+   *   await client.messaging.emailDomains.actions.verify(
+   *     'emdom_018e88072d1320808dc9aaa01',
+   *   );
+   * ```
+   */
+  verify(id: string, options?: RequestOptions): APIPromise<EmailDomainsAPI.EmailDomain> {
+    return this._client.post(path`/v1/messaging/email-domains/${id}/actions/verify`, options);
+  }
+}

package/src/resources/messaging/email-domains/email-domains.ts

@@ -0,0 +1,170 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as APIKeysAPI from '../../auth/api-keys/api-keys';
+import * as ActionsAPI from './actions';
+import { Actions } from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Register customer-owned domains with the email bridge and verify them for sending and receiving mail.
+ */
+export class EmailDomains extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Registers a customer-owned domain with the email bridge and returns the DKIM
+   * records to publish.
+   *
+   * The domain starts in `pending` until verified.
+   *
+   * This endpoint requires the permission: `messaging:create`.
+   *
+   * @example
+   * ```ts
+   * const emailDomain =
+   *   await client.messaging.emailDomains.create({
+   *     domain: 'support.acme.com',
+   *   });
+   * ```
+   */
+  create(body: EmailDomainCreateParams, options?: RequestOptions): APIPromise<EmailDomain> {
+    return this._client.post('/v1/messaging/email-domains', { body, ...options });
+  }
+
+  /**
+   * Returns the account's registered email domains.
+   *
+   * This endpoint requires the permission: `messaging:read`.
+   *
+   * @example
+   * ```ts
+   * const listEmailDomain =
+   *   await client.messaging.emailDomains.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ListEmailDomain> {
+    return this._client.get('/v1/messaging/email-domains', options);
+  }
+
+  /**
+   * Returns a single email domain owned by the account.
+   *
+   * This endpoint requires the permission: `messaging:read`.
+   *
+   * @example
+   * ```ts
+   * const emailDomain =
+   *   await client.messaging.emailDomains.retrieve(
+   *     'emdom_018e88072d1320808dc9aaa01',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EmailDomain> {
+    return this._client.get(path`/v1/messaging/email-domains/${id}`, options);
+  }
+}
+
+/**
+ * Request to register a sending/receiving domain with the email bridge.
+ */
+export interface CreateEmailDomainRequest {
+  /**
+   * The fully-qualified domain name to register (e.g. `support.acme.com`).
+   */
+  domain: string;
+}
+
+/**
+ * A domain registered with the email bridge for sending and receiving mail.
+ *
+ * After registration the domain starts in `pending`; publish the returned DKIM
+ * records, then poll the verify action until it flips to `verified`.
+ */
+export interface EmailDomain {
+  /**
+   * Email domain ID.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * The DKIM CNAME tokens the customer must publish in DNS to verify the domain.
+   */
+  dkim_tokens: Array<string>;
+
+  /**
+   * The fully-qualified domain name (e.g. `support.acme.com`).
+   */
+  domain: string;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'email_domain';
+
+  /**
+   * Verification status.
+   *
+   * - `pending`: registered and awaiting DKIM confirmation.
+   * - `verified`: DKIM confirmed; the domain can send and receive mail.
+   * - `failed`: verification could not be completed.
+   */
+  status: string;
+
+  /**
+   * Last updated timestamp.
+   */
+  updated_at: string;
+
+  /**
+   * When the domain's DKIM verification was confirmed.
+   */
+  verified_at: string | null;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListEmailDomain {
+  /**
+   * Resources in this page.
+   */
+  data: Array<EmailDomain>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+export interface EmailDomainCreateParams {
+  /**
+   * The fully-qualified domain name to register (e.g. `support.acme.com`).
+   */
+  domain: string;
+}
+
+EmailDomains.Actions = Actions;
+
+export declare namespace EmailDomains {
+  export {
+    type CreateEmailDomainRequest as CreateEmailDomainRequest,
+    type EmailDomain as EmailDomain,
+    type ListEmailDomain as ListEmailDomain,
+    type EmailDomainCreateParams as EmailDomainCreateParams,
+  };
+
+  export { Actions as Actions };
+}

package/src/resources/messaging/email-domains/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions } from './actions';
+export {
+  EmailDomains,
+  type CreateEmailDomainRequest,
+  type EmailDomain,
+  type ListEmailDomain,
+  type EmailDomainCreateParams,
+} from './email-domains';

package/src/resources/messaging/email-domains.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './email-domains/index';