@augno/sdk 0.7.0 → 0.7.1

package/src/resources/core/request-logs.ts

@@ -13,6 +13,8 @@ export class RequestLogs extends APIResource {
   /**
    * Returns a paginated list of request logs for the current account.
    *
+   * This endpoint requires the permission: `request_logs:read`.
+   *
    * @example
    * ```ts
    * const listRequestLog = await client.core.requestLogs.list();
@@ -28,6 +30,8 @@ export class RequestLogs extends APIResource {
   /**
    * Returns a request log by ID.
    *
+   * This endpoint requires the permission: `request_logs:read`.
+   *
    * @example
    * ```ts
    * const requestLog = await client.core.requestLogs.retrieve(
@@ -45,21 +49,29 @@ export class RequestLogs extends APIResource {
 }
 
 /**
- * Reference to an actor (user, API key, or agent).
+ * Reference to an actor — the user, API key, agent, or group identity associated
+ * with an action.
  */
 export interface Actor {
   /**
-   * Actor ID.
+   * Unique identifier of the actor.
    */
   id: string;
 
+  /**
+   * URL of the actor's profile photo, if one is set.
+   *
+   * Only populated for `user` actors.
+   */
+  avatar_url: string | null;
+
   /**
    * Human-readable handle identifying the actor.
    *
    * - For `user` actors: the user's email address.
    * - For `api_key` actors: the redacted key value.
    *
-   * Agent actors carry no handle.
+   * Other actor types carry no handle.
    */
   handle: string | null;
 
@@ -85,8 +97,10 @@ export interface Actor {
    * - `user`: a human user account.
    * - `api_key`: a programmatic caller authenticating with an API key.
    * - `agent`: an automated agent acting on the account's behalf.
+   * - `group`: a shared group identity, such as a "Customer Service" persona, rather
+   *   than a single individual.
    */
-  type: 'user' | 'api_key' | 'agent';
+  type: 'user' | 'api_key' | 'agent' | 'group';
 }
 
 /**
@@ -124,7 +138,8 @@ export interface RequestLog {
   account: APIKeysAPI.Account | null;
 
   /**
-   * Reference to an actor (user, API key, or agent).
+   * Reference to an actor — the user, API key, agent, or group identity associated
+   * with an action.
    */
   actor: Actor | null;
 
@@ -200,7 +215,7 @@ export interface RequestLog {
   occurred_at: string;
 
   /**
-   * Non-normalized request path.
+   * The exact path the request was made to, including path parameter values.
    */
   path: string;
 
@@ -261,7 +276,7 @@ export interface RequestLogListParams {
   /**
    * Filter by the actor type.
    */
-  actor_types?: Array<'user' | 'api_key' | 'agent'>;
+  actor_types?: Array<'user' | 'api_key' | 'agent' | 'group'>;
 
   /**
    * Opaque cursor token identifying where the page of results starts.

package/src/resources/core/sandboxes.ts

@@ -13,6 +13,8 @@ export class Sandboxes extends APIResource {
   /**
    * Returns a paginated list of sandboxes.
    *
+   * This endpoint requires the permission: `sandboxes:read`.
+   *
    * @example
    * ```ts
    * const listSandbox = await client.core.sandboxes.list();
@@ -25,6 +27,8 @@ export class Sandboxes extends APIResource {
   /**
    * Returns a sandbox by ID.
    *
+   * This endpoint requires the permission: `sandboxes:read`.
+   *
    * @example
    * ```ts
    * const sandbox = await client.core.sandboxes.retrieve(
@@ -47,6 +51,8 @@ export class Sandboxes extends APIResource {
    * available immediately after the sandbox is created. Sandboxes cannot be created
    * while acting in a sandbox.
    *
+   * This endpoint requires the permission: `sandboxes:create`.
+   *
    * @example
    * ```ts
    * const sandbox = await client.core.sandboxes.create({
@@ -66,6 +72,8 @@ export class Sandboxes extends APIResource {
    * The sandbox's data is purged asynchronously, so it may persist briefly after
    * this call returns.
    *
+   * This endpoint requires the permission: `sandboxes:delete`.
+   *
    * @example
    * ```ts
    * const sandbox = await client.core.sandboxes.delete(
@@ -83,7 +91,7 @@ export class Sandboxes extends APIResource {
  */
 export interface CreateSandboxRequest {
   /**
-   * Display name.
+   * Display name of the sandbox.
    */
   name: string;
 
@@ -132,7 +140,7 @@ export interface Sandbox {
   created_at: string;
 
   /**
-   * Display name.
+   * Display name of the sandbox.
    */
   name: string;
 
@@ -193,7 +201,7 @@ export interface SandboxRetrieveParams {
 
 export interface SandboxCreateParams {
   /**
-   * Body param: Display name.
+   * Body param: Display name of the sandbox.
    */
   name: string;
 

package/src/resources/finance/payment-terms.ts

@@ -17,6 +17,8 @@ export class PaymentTerms extends APIResource {
    * The list includes both payment terms created by your account and Augno-provided
    * system defaults.
    *
+   * This endpoint requires the permission: `payment_terms:read`.
+   *
    * @example
    * ```ts
    * const listPaymentTerm =
@@ -33,6 +35,8 @@ export class PaymentTerms extends APIResource {
   /**
    * Returns a payment term by ID.
    *
+   * This endpoint requires the permission: `payment_terms:read`.
+   *
    * @example
    * ```ts
    * const paymentTerm =
@@ -54,6 +58,8 @@ export class PaymentTerms extends APIResource {
    *
    * The new term is owned by your account and starts with status `active`.
    *
+   * This endpoint requires the permission: `payment_terms:create`.
+   *
    * @example
    * ```ts
    * const paymentTerm =
@@ -73,6 +79,8 @@ export class PaymentTerms extends APIResource {
    * Only payment terms created by your account can be updated; system-owned default
    * terms cannot be.
    *
+   * This endpoint requires the permission: `payment_terms:update`.
+   *
    * @example
    * ```ts
    * const paymentTerm =
@@ -101,6 +109,8 @@ export class PaymentTerms extends APIResource {
    * Only payment terms created by your account can be deleted; system-owned default
    * terms cannot be.
    *
+   * This endpoint requires the permission: `payment_terms:delete`.
+   *
    * @example
    * ```ts
    * const paymentTerm =

package/src/resources/identity/account-users/account-users.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
+import * as BlocksAPI from '../../messaging/blocks';
 import * as APIKeysAPI from '../../auth/api-keys/api-keys';
 import * as ActionsAPI from './actions';
 import { ActionActivateResponse, ActionDisableResponse, ActionRemoveResponse, Actions } from './actions';
-import * as CustomersAPI from '../../sales/customers/customers';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -18,6 +18,9 @@ export class AccountUsers extends APIResource {
   /**
    * Returns a paginated list of account users for the current account.
    *
+   * This endpoint requires the permissions: `team:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listAccountUser =
@@ -34,6 +37,9 @@ export class AccountUsers extends APIResource {
   /**
    * Returns an account user by ID.
    *
+   * This endpoint requires the permissions: `team:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const accountUser =
@@ -46,7 +52,7 @@ export class AccountUsers extends APIResource {
     id: string,
     query: AccountUserRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.AccountUser> {
+  ): APIPromise<BlocksAPI.AccountUser> {
     return this._client.get(path`/v1/identity/account-users/${id}`, { query, ...options });
   }
 
@@ -57,6 +63,9 @@ export class AccountUsers extends APIResource {
    * sent a welcome email containing a generated password. If a matching user already
    * exists, that user is added to the account instead.
    *
+   * This endpoint requires the permissions: `team:create`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const accountUser =
@@ -78,7 +87,7 @@ export class AccountUsers extends APIResource {
   create(
     params: AccountUserCreateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.AccountUser> {
+  ): APIPromise<BlocksAPI.AccountUser> {
     const { include, ...body } = params ?? {};
     return this._client.post('/v1/identity/account-users', { query: { include }, body, ...options });
   }
@@ -90,6 +99,9 @@ export class AccountUsers extends APIResource {
    * update the underlying user, which is shared across every account the user
    * belongs to.
    *
+   * This endpoint requires the permissions: `team:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const accountUser =
@@ -107,7 +119,7 @@ export class AccountUsers extends APIResource {
     id: string,
     params: AccountUserUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.AccountUser> {
+  ): APIPromise<BlocksAPI.AccountUser> {
     const { include, ...body } = params ?? {};
     return this._client.patch(path`/v1/identity/account-users/${id}`, {
       query: { include },
@@ -181,7 +193,7 @@ export interface ListAccountUser {
   /**
    * Resources in this page.
    */
-  data: Array<CustomersAPI.AccountUser>;
+  data: Array<BlocksAPI.AccountUser>;
 
   /**
    * Resource type identifier.

package/src/resources/identity/account-users/actions.ts

@@ -16,6 +16,9 @@ export class Actions extends APIResource {
    * Reactivation consumes a seat, so the request fails if the account is at its seat
    * limit. Activating an already-active user is a no-op.
    *
+   * This endpoint requires the permissions: `team:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const response =
@@ -35,6 +38,9 @@ export class Actions extends APIResource {
    * revoked. Admin users cannot be disabled, you cannot disable yourself, and
    * removed users must be activated before they can be disabled.
    *
+   * This endpoint requires the permissions: `team:update`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const response =
@@ -53,6 +59,9 @@ export class Actions extends APIResource {
    * Removal is a soft delete: removed users are excluded from listings unless
    * requested via `removed_scope`, and can be restored with the activate action.
    *
+   * This endpoint requires the permissions: `team:delete`, `customers:update`,
+   * `suppliers:update`.
+   *
    * @example
    * ```ts
    * const action =

package/src/resources/identity/roles.ts

@@ -14,6 +14,8 @@ export class Roles extends APIResource {
    * Returns a paginated list of roles for the target account, including global
    * roles.
    *
+   * This endpoint requires the permission: `roles:read`.
+   *
    * @example
    * ```ts
    * const listRole = await client.identity.roles.list();
@@ -26,6 +28,8 @@ export class Roles extends APIResource {
   /**
    * Returns a role by ID, including its permissions.
    *
+   * This endpoint requires the permission: `roles:read`.
+   *
    * @example
    * ```ts
    * const role = await client.identity.roles.retrieve(
@@ -42,8 +46,11 @@ export class Roles extends APIResource {
   }
 
   /**
-   * Creates a custom role with the specified permissions. Roles created through the
-   * API always have type `user`.
+   * Creates a custom role with the specified permissions.
+   *
+   * Roles created through the API always have type `user`.
+   *
+   * This endpoint requires the permission: `roles:create`.
    *
    * @example
    * ```ts
@@ -64,8 +71,11 @@ export class Roles extends APIResource {
   }
 
   /**
-   * Partially updates a custom role's name or permissions. Provided permissions
-   * replace all existing ones; global roles cannot be modified.
+   * Partially updates a custom role's name or permissions.
+   *
+   * Provided permissions replace all existing ones; global roles cannot be modified.
+   *
+   * This endpoint requires the permission: `roles:update`.
    *
    * @example
    * ```ts
@@ -88,8 +98,12 @@ export class Roles extends APIResource {
   }
 
   /**
-   * Deletes a role and its associated permissions. Global roles and roles currently
-   * assigned to one or more users cannot be deleted.
+   * Deletes a role and its associated permissions.
+   *
+   * Global roles and roles currently assigned to one or more users cannot be
+   * deleted.
+   *
+   * This endpoint requires the permission: `roles:delete`.
    *
    * @example
    * ```ts
@@ -118,7 +132,7 @@ export interface CreateRoleRequest {
    * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
    * create a role with no permissions.
    */
-  permissions: Array<string>;
+  permissions?: Array<string>;
 }
 
 /**
@@ -146,8 +160,9 @@ export interface ListRole {
  */
 export interface UpdateRoleRequest {
   /**
-   * New display name for the role, unique within the account. Omit to leave
-   * unchanged.
+   * New display name for the role, unique within the account.
+   *
+   * Omit to leave unchanged.
    */
   name?: string;
 
@@ -211,6 +226,12 @@ export interface RoleCreateParams {
    */
   name: string;
 
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'permissions'>;
+
   /**
    * Body param: Permissions to grant, in `{domain}:{action}` format, such as
    * `customers:read`.
@@ -218,13 +239,7 @@ export interface RoleCreateParams {
    * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
    * create a role with no permissions.
    */
-  permissions: Array<string>;
-
-  /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
-   */
-  include?: Array<'owner' | 'owner.account' | 'permissions'>;
+  permissions?: Array<string>;
 }
 
 export interface RoleUpdateParams {
@@ -235,8 +250,9 @@ export interface RoleUpdateParams {
   include?: Array<'owner' | 'owner.account' | 'permissions'>;
 
   /**
-   * Body param: New display name for the role, unique within the account. Omit to
-   * leave unchanged.
+   * Body param: New display name for the role, unique within the account.
+   *
+   * Omit to leave unchanged.
    */
   name?: string;
 

package/src/resources/index.ts

@@ -2,7 +2,7 @@
 
 export { Auth } from './auth/auth';
 export { Catalog } from './catalog/catalog';
-export { Core } from './core/core';
+export { Core, type Entity, type ListEntity, type CoreRetrieveSearchParams } from './core/core';
 export {
   Finance,
   type AdjustmentType,
@@ -16,6 +16,7 @@ export {
   type FinanceRetrieveAdjustmentTypesParams,
 } from './finance/finance';
 export { Identity } from './identity/identity';
+export { Messaging, type ListActor, type MessagingRetrieveContactsParams } from './messaging/messaging';
 export { Operations } from './operations/operations';
 export { Sales } from './sales/sales';
 export { Settings } from './settings/settings';

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

@@ -0,0 +1,119 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AnnouncementsAPI from './announcements';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List, read, and manage broadcast announcements.
+ */
+export class Actions extends APIResource {
+  /**
+   * Marks an announcement as seen for the calling actor.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const announcement =
+   *   await client.messaging.announcements.actions.seen(
+   *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+   *   );
+   * ```
+   */
+  seen(
+    id: string,
+    params: ActionSeenParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AnnouncementsAPI.Announcement> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/messaging/announcements/${id}/actions/seen`, {
+      query: { include },
+      ...options,
+    });
+  }
+
+  /**
+   * Marks an announcement as read for the calling actor.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const announcement =
+   *   await client.messaging.announcements.actions.read(
+   *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+   *   );
+   * ```
+   */
+  read(
+    id: string,
+    params: ActionReadParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AnnouncementsAPI.Announcement> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/messaging/announcements/${id}/actions/read`, {
+      query: { include },
+      ...options,
+    });
+  }
+
+  /**
+   * Marks an announcement as dismissed for the calling actor.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const announcement =
+   *   await client.messaging.announcements.actions.dismiss(
+   *     'an_01c4d5e6f7a8b9c0d1e2f3a4',
+   *   );
+   * ```
+   */
+  dismiss(
+    id: string,
+    params: ActionDismissParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AnnouncementsAPI.Announcement> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/messaging/announcements/${id}/actions/dismiss`, {
+      query: { include },
+      ...options,
+    });
+  }
+}
+
+export interface ActionSeenParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'resource'>;
+}
+
+export interface ActionReadParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'resource'>;
+}
+
+export interface ActionDismissParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'resource'>;
+}
+
+export declare namespace Actions {
+  export {
+    type ActionSeenParams as ActionSeenParams,
+    type ActionReadParams as ActionReadParams,
+    type ActionDismissParams as ActionDismissParams,
+  };
+}