@augno/sdk 0.7.0 → 0.7.1

package/src/resources/messaging/groups/members.ts

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ConversationsAPI from '../conversations/conversations';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Create and manage reusable rosters (named member sets) that seed many conversations.
+ */
+export class Members extends APIResource {
+  /**
+   * Adds a member (a user or an agent) to a reusable roster.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const messagingGroup =
+   *   await client.messaging.groups.members.create(
+   *     'cvgp_018e88072d1320808dc97abc',
+   *     {
+   *       member_type: 'user',
+   *       account_user_id: 'acus_01ea9983ddb41dacc44ecf997c',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    id: string,
+    body: MemberCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.MessagingGroup> {
+    return this._client.post(path`/v1/messaging/groups/${id}/members`, { body, ...options });
+  }
+
+  /**
+   * Removes a member from a reusable roster.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const messagingGroup =
+   *   await client.messaging.groups.members.delete(
+   *     'cvgppt_018e88072d1320808dc9def',
+   *     { id: 'cvgp_018e88072d1320808dc97abc' },
+   *   );
+   * ```
+   */
+  delete(
+    memberID: string,
+    params: MemberDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.MessagingGroup> {
+    const { id } = params;
+    return this._client.delete(path`/v1/messaging/groups/${id}/members/${memberID}`, options);
+  }
+}
+
+/**
+ * Request to add a member to a reusable roster.
+ */
+export interface AddMessagingGroupMemberRequest {
+  /**
+   * The kind of member being added.
+   */
+  member_type: 'user' | 'agent';
+
+  /**
+   * The account user to add (required when `member_type` is `user`).
+   */
+  account_user_id?: string;
+
+  /**
+   * The agent to add (required when `member_type` is `agent`).
+   */
+  agent_config_id?: string;
+}
+
+export interface MemberCreateParams {
+  /**
+   * The kind of member being added.
+   */
+  member_type: 'user' | 'agent';
+
+  /**
+   * The account user to add (required when `member_type` is `user`).
+   */
+  account_user_id?: string;
+
+  /**
+   * The agent to add (required when `member_type` is `agent`).
+   */
+  agent_config_id?: string;
+}
+
+export interface MemberDeleteParams {
+  /**
+   * Messaging group ID.
+   */
+  id: string;
+}
+
+export declare namespace Members {
+  export {
+    type AddMessagingGroupMemberRequest as AddMessagingGroupMemberRequest,
+    type MemberCreateParams as MemberCreateParams,
+    type MemberDeleteParams as MemberDeleteParams,
+  };
+}

package/src/resources/messaging/groups.ts

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

package/src/resources/messaging/index.ts

@@ -0,0 +1,115 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Announcements,
+  type Announcement,
+  type ListAnnouncement,
+  type AnnouncementListParams,
+  type AnnouncementRetrieveParams,
+} from './announcements/index';
+export {
+  Blocks,
+  type AccountUser,
+  type BlockRequest,
+  type Consumption,
+  type Department,
+  type ListConsumption,
+  type ListLocation,
+  type ListMachine,
+  type ListMessagingBlock,
+  type ListProductionStep,
+  type ListScanningStation,
+  type Location,
+  type LocationTypeCode,
+  type Machine,
+  type MessagingBlock,
+  type ProductionOutput,
+  type ProductionStep,
+  type ScanningStation,
+  type User,
+  type BlockDeleteResponse,
+  type BlockCreateParams,
+  type BlockListParams,
+} from './blocks';
+export {
+  Conversations,
+  type AgentAction,
+  type AgentDefinition,
+  type AgentDefinitionConfig,
+  type AgentDefinitionTool,
+  type AgentRun,
+  type AgentRunStep,
+  type AvailableTool,
+  type Conversation,
+  type ConversationParticipant,
+  type CreateConversationRequest,
+  type ListAgentAction,
+  type ListAgentDefinitionTool,
+  type ListAgentRunStep,
+  type ListConversation,
+  type ListConversationParticipant,
+  type ListMessageAttachment,
+  type ListMessagingGroupMember,
+  type Message,
+  type MessageAttachment,
+  type MessagingGroup,
+  type MessagingGroupMember,
+  type TriggerConfig,
+  type UpdateConversationRequest,
+  type ConversationCreateParams,
+  type ConversationListParams,
+  type ConversationRetrieveParams,
+  type ConversationUpdateParams,
+} from './conversations/index';
+export {
+  EmailDomains,
+  type CreateEmailDomainRequest,
+  type EmailDomain,
+  type ListEmailDomain,
+  type EmailDomainCreateParams,
+} from './email-domains/index';
+export {
+  EmailInboxes,
+  type CreateEmailInboxRequest,
+  type EmailInbox,
+  type ListEmailInbox,
+  type UpdateEmailInboxRequest,
+  type EmailInboxDeleteResponse,
+  type EmailInboxCreateParams,
+  type EmailInboxListParams,
+  type EmailInboxRetrieveParams,
+  type EmailInboxUpdateParams,
+} from './email-inboxes';
+export {
+  Groups,
+  type CreateMessagingGroupRequest,
+  type ListMessagingGroup,
+  type UpdateMessagingGroupRequest,
+  type GroupDeleteResponse,
+  type GroupCreateParams,
+  type GroupUpdateParams,
+} from './groups/index';
+export { Messages, type UpdateDraftRequest, type MessageUpdateParams } from './messages/index';
+export { Messaging, type ListActor, type MessagingRetrieveContactsParams } from './messaging';
+export {
+  Notifications,
+  type ListNotification,
+  type ListNotificationUnreadSummaryAccount,
+  type Notification,
+  type NotificationSendResult,
+  type NotificationTargetInput,
+  type NotificationUnreadCount,
+  type NotificationUnreadSummary,
+  type NotificationUnreadSummaryAccount,
+  type SendNotificationRequest,
+  type NotificationCreateParams,
+  type NotificationListParams,
+  type NotificationRetrieveParams,
+} from './notifications/index';
+export {
+  Preferences,
+  type ListNotificationPreference,
+  type NotificationPreference,
+  type UpsertNotificationPreferenceRequest,
+  type PreferenceUpdateParams,
+} from './preferences';

package/src/resources/messaging/messages/actions.ts

@@ -0,0 +1,184 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ConversationsAPI from '../conversations/conversations';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Send, list, edit, and delete chat messages.
+ */
+export class Actions extends APIResource {
+  /**
+   * Approves a customer-reply draft and sends it to the customer, promoting the
+   * draft to a sent customer-visible message in place.
+   *
+   * Idempotent on `client_message_id`.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const message =
+   *   await client.messaging.messages.actions.approveSend(
+   *     'mg_01h9z8q1w2e3r4t5y6u7i8mg',
+   *     { client_message_id: 'client_msg_approve_7b1c' },
+   *   );
+   * ```
+   */
+  approveSend(
+    id: string,
+    params: ActionApproveSendParams,
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.Message> {
+    const { include, ...body } = params;
+    return this._client.post(path`/v1/messaging/messages/${id}/actions/approve-send`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Discards an open customer-reply draft without sending it (status becomes
+   * `rejected`).
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const message =
+   *   await client.messaging.messages.actions.reject(
+   *     'mg_01h9z8q1w2e3r4t5y6u7i8mg',
+   *   );
+   * ```
+   */
+  reject(
+    id: string,
+    params: ActionRejectParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.Message> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/messaging/messages/${id}/actions/reject`, {
+      query: { include },
+      ...options,
+    });
+  }
+
+  /**
+   * Cancels a scheduled message the caller created (status becomes `canceled`).
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const message =
+   *   await client.messaging.messages.actions.cancel(
+   *     'mg_01h9z8q1w2e3r4t5y6u7i8mg',
+   *   );
+   * ```
+   */
+  cancel(
+    id: string,
+    params: ActionCancelParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.Message> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/messaging/messages/${id}/actions/cancel`, {
+      query: { include },
+      ...options,
+    });
+  }
+}
+
+/**
+ * Request to approve a customer-reply draft and send it to the customer.
+ */
+export interface ApproveSendDraftRequest {
+  /**
+   * Client-supplied dedupe key for the resulting customer-visible message.
+   */
+  client_message_id: string;
+}
+
+export interface ActionApproveSendParams {
+  /**
+   * Body param: Client-supplied dedupe key for the resulting customer-visible
+   * message.
+   */
+  client_message_id: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'sender'
+    | 'author'
+    | 'resource'
+    | 'attachments'
+    | 'attachments.resource'
+    | 'conversation'
+    | 'conversation.participants'
+    | 'conversation.last_message'
+    | 'reply_to'
+    | 'reply_to.sender'
+    | 'reply_to.author'
+    | 'reply_to.attachments'
+    | 'agent_run'
+  >;
+}
+
+export interface ActionRejectParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'sender'
+    | 'author'
+    | 'resource'
+    | 'attachments'
+    | 'attachments.resource'
+    | 'conversation'
+    | 'conversation.participants'
+    | 'conversation.last_message'
+    | 'reply_to'
+    | 'reply_to.sender'
+    | 'reply_to.author'
+    | 'reply_to.attachments'
+    | 'agent_run'
+  >;
+}
+
+export interface ActionCancelParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<
+    | 'sender'
+    | 'author'
+    | 'resource'
+    | 'attachments'
+    | 'attachments.resource'
+    | 'conversation'
+    | 'conversation.participants'
+    | 'conversation.last_message'
+    | 'reply_to'
+    | 'reply_to.sender'
+    | 'reply_to.author'
+    | 'reply_to.attachments'
+    | 'agent_run'
+  >;
+}
+
+export declare namespace Actions {
+  export {
+    type ApproveSendDraftRequest as ApproveSendDraftRequest,
+    type ActionApproveSendParams as ActionApproveSendParams,
+    type ActionRejectParams as ActionRejectParams,
+    type ActionCancelParams as ActionCancelParams,
+  };
+}

package/src/resources/messaging/messages/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Actions,
+  type ApproveSendDraftRequest,
+  type ActionApproveSendParams,
+  type ActionRejectParams,
+  type ActionCancelParams,
+} from './actions';
+export { Messages, type UpdateDraftRequest, type MessageUpdateParams } from './messages';

package/src/resources/messaging/messages/messages.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ConversationsAPI from '../conversations/conversations';
+import * as ActionsAPI from './actions';
+import {
+  ActionApproveSendParams,
+  ActionCancelParams,
+  ActionRejectParams,
+  Actions,
+  ApproveSendDraftRequest,
+} from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Send, list, edit, and delete chat messages.
+ */
+export class Messages extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Edits a still-open customer-reply draft.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const message = await client.messaging.messages.update(
+   *   'mg_01h9z8q1w2e3r4t5y6u7i8mg',
+   *   {
+   *     body: 'Hi Joe — good news, your order ships tomorrow.',
+   *   },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    params: MessageUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ConversationsAPI.Message> {
+    const { include, ...body } = params;
+    return this._client.patch(path`/v1/messaging/messages/${id}`, { query: { include }, body, ...options });
+  }
+}
+
+/**
+ * Request to edit a still-open customer-reply draft message.
+ */
+export interface UpdateDraftRequest {
+  /**
+   * The revised reply body.
+   */
+  body: string;
+
+  /**
+   * The revised email subject, for the email channel.
+   */
+  subject?: string;
+}
+
+export interface MessageUpdateParams {
+  /**
+   * Body param: The revised reply body.
+   */
+  body: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<
+    | 'sender'
+    | 'author'
+    | 'resource'
+    | 'attachments'
+    | 'attachments.resource'
+    | 'conversation'
+    | 'conversation.participants'
+    | 'conversation.last_message'
+    | 'reply_to'
+    | 'reply_to.sender'
+    | 'reply_to.author'
+    | 'reply_to.attachments'
+    | 'agent_run'
+  >;
+
+  /**
+   * Body param: The revised email subject, for the email channel.
+   */
+  subject?: string;
+}
+
+Messages.Actions = Actions;
+
+export declare namespace Messages {
+  export { type UpdateDraftRequest as UpdateDraftRequest, type MessageUpdateParams as MessageUpdateParams };
+
+  export {
+    Actions as Actions,
+    type ApproveSendDraftRequest as ApproveSendDraftRequest,
+    type ActionApproveSendParams as ActionApproveSendParams,
+    type ActionRejectParams as ActionRejectParams,
+    type ActionCancelParams as ActionCancelParams,
+  };
+}

package/src/resources/messaging/messages.ts

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