@augno/sdk 0.7.0 → 0.7.1

package/src/resources/messaging/notifications.ts

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

package/src/resources/messaging/preferences.ts

@@ -0,0 +1,215 @@
+// 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 { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Manage per-category notification channel preferences (in-app, email, push).
+ */
+export class Preferences extends APIResource {
+  /**
+   * Lists the caller's notification channel preferences (global default +
+   * per-category overrides).
+   *
+   * This endpoint requires the permission: `messaging:read`.
+   *
+   * @example
+   * ```ts
+   * const listNotificationPreference =
+   *   await client.messaging.preferences.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ListNotificationPreference> {
+    return this._client.get('/v1/messaging/preferences', options);
+  }
+
+  /**
+   * Creates or replaces a notification channel preference for the caller.
+   *
+   * This endpoint requires the permission: `messaging:update`.
+   *
+   * @example
+   * ```ts
+   * const notificationPreference =
+   *   await client.messaging.preferences.update({
+   *     email_enabled: false,
+   *     in_app_enabled: true,
+   *     push_enabled: false,
+   *     category: 'chat.message',
+   *     digest: 'instant',
+   *   });
+   * ```
+   */
+  update(body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<NotificationPreference> {
+    return this._client.put('/v1/messaging/preferences', { body, ...options });
+  }
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListNotificationPreference {
+  /**
+   * Resources in this page.
+   */
+  data: Array<NotificationPreference>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * A per-(user, category) notification channel preference.
+ *
+ * A preference with a `null` category is the user's global default; a
+ * category-specific preference overrides it.
+ */
+export interface NotificationPreference {
+  /**
+   * Preference ID.
+   */
+  id: string;
+
+  /**
+   * The notification category this preference applies to.
+   *
+   * `null` for the global default that applies to all categories without a specific
+   * preference.
+   */
+  category: string | null;
+
+  /**
+   * Creation timestamp.
+   */
+  created_at: string;
+
+  /**
+   * How email delivery for this category is batched.
+   *
+   * - `instant`: send an email as soon as an eligible notification occurs.
+   * - `hourly`: batch eligible notifications into a single hourly email.
+   * - `daily`: batch eligible notifications into a single daily email.
+   * - `off`: never send email for this category, even when email delivery is
+   *   otherwise enabled.
+   */
+  digest: 'instant' | 'hourly' | 'daily' | 'off';
+
+  /**
+   * Whether email notifications are delivered for this category.
+   */
+  email_enabled: boolean;
+
+  /**
+   * Whether in-app (bell) notifications are delivered for this category.
+   */
+  in_app_enabled: boolean;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'notification_preference';
+
+  /**
+   * Whether push notifications are delivered for this category.
+   */
+  push_enabled: boolean;
+
+  /**
+   * Last update timestamp.
+   */
+  updated_at: string;
+}
+
+/**
+ * Request to create or replace a notification preference for the caller.
+ *
+ * The preference is keyed by (caller, category), so repeating the request with the
+ * same category replaces the existing preference.
+ */
+export interface UpsertNotificationPreferenceRequest {
+  /**
+   * Whether email notifications are delivered for this category.
+   */
+  email_enabled: boolean;
+
+  /**
+   * Whether in-app (bell) notifications are delivered for this category.
+   */
+  in_app_enabled: boolean;
+
+  /**
+   * Whether push notifications are delivered for this category.
+   */
+  push_enabled: boolean;
+
+  /**
+   * The notification category this preference applies to.
+   *
+   * Omit (or `null`) to set the caller's global default.
+   */
+  category?: string | null;
+
+  /**
+   * How email delivery for this category is batched.
+   *
+   * - `instant`: send an email as soon as an eligible notification occurs.
+   * - `hourly`: batch eligible notifications into a single hourly email.
+   * - `daily`: batch eligible notifications into a single daily email.
+   * - `off`: never send email for this category, even when email delivery is
+   *   otherwise enabled.
+   */
+  digest?: 'instant' | 'hourly' | 'daily' | 'off';
+}
+
+export interface PreferenceUpdateParams {
+  /**
+   * Whether email notifications are delivered for this category.
+   */
+  email_enabled: boolean;
+
+  /**
+   * Whether in-app (bell) notifications are delivered for this category.
+   */
+  in_app_enabled: boolean;
+
+  /**
+   * Whether push notifications are delivered for this category.
+   */
+  push_enabled: boolean;
+
+  /**
+   * The notification category this preference applies to.
+   *
+   * Omit (or `null`) to set the caller's global default.
+   */
+  category?: string | null;
+
+  /**
+   * How email delivery for this category is batched.
+   *
+   * - `instant`: send an email as soon as an eligible notification occurs.
+   * - `hourly`: batch eligible notifications into a single hourly email.
+   * - `daily`: batch eligible notifications into a single daily email.
+   * - `off`: never send email for this category, even when email delivery is
+   *   otherwise enabled.
+   */
+  digest?: 'instant' | 'hourly' | 'daily' | 'off';
+}
+
+export declare namespace Preferences {
+  export {
+    type ListNotificationPreference as ListNotificationPreference,
+    type NotificationPreference as NotificationPreference,
+    type UpsertNotificationPreferenceRequest as UpsertNotificationPreferenceRequest,
+    type PreferenceUpdateParams as PreferenceUpdateParams,
+  };
+}

package/src/resources/messaging.ts

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

package/src/resources/operations/carriers/carriers.ts

@@ -28,6 +28,9 @@ export class Carriers extends APIResource {
   /**
    * Returns a paginated list of carriers for the current account.
    *
+   * This endpoint requires the permissions: `carriers:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listCarrier = await client.operations.carriers.list();
@@ -40,6 +43,9 @@ export class Carriers extends APIResource {
   /**
    * Returns a carrier by ID.
    *
+   * This endpoint requires the permissions: `carriers:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const carrier = await client.operations.carriers.retrieve(
@@ -62,6 +68,8 @@ export class Carriers extends APIResource {
    * connected through Shippo and its service levels are auto-synced, initially
    * hidden from the customer portal. Sandbox accounts skip the Shippo connection.
    *
+   * This endpoint requires the permission: `carriers:create`.
+   *
    * @example
    * ```ts
    * const carrier = await client.operations.carriers.create({
@@ -80,6 +88,8 @@ export class Carriers extends APIResource {
   /**
    * Partially updates a carrier's name and portal visibility.
    *
+   * This endpoint requires the permission: `carriers:update`.
+   *
    * @example
    * ```ts
    * const carrier = await client.operations.carriers.update(
@@ -103,6 +113,8 @@ export class Carriers extends APIResource {
    * If the carrier is connected through Shippo, its Shippo carrier account is
    * deactivated. System-owned carriers cannot be deleted.
    *
+   * This endpoint requires the permission: `carriers:delete`.
+   *
    * @example
    * ```ts
    * const carrier = await client.operations.carriers.delete(
@@ -178,9 +190,8 @@ export interface UpdateCarrierRequest {
   /**
    * Carrier visibility in the customer portal.
    *
-   * If `visible`, this carrier will be available for your customers to utilize when
-   * they go to checkout. If `hidden`, this carrier will not be an option on
-   * checkout.
+   * A `visible` carrier can be selected by your customers at checkout; a `hidden`
+   * carrier is not offered there.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 
@@ -278,9 +289,8 @@ export interface CarrierUpdateParams {
   /**
    * Body param: Carrier visibility in the customer portal.
    *
-   * If `visible`, this carrier will be available for your customers to utilize when
-   * they go to checkout. If `hidden`, this carrier will not be an option on
-   * checkout.
+   * A `visible` carrier can be selected by your customers at checkout; a `hidden`
+   * carrier is not offered there.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 

package/src/resources/operations/carriers/service-levels.ts

@@ -13,6 +13,9 @@ export class ServiceLevels extends APIResource {
   /**
    * Returns a paginated list of service levels for a carrier.
    *
+   * This endpoint requires the permissions: `carriers:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const listServiceLevel =
@@ -32,6 +35,9 @@ export class ServiceLevels extends APIResource {
   /**
    * Returns a service level by ID.
    *
+   * This endpoint requires the permissions: `carriers:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const serviceLevel =
@@ -56,6 +62,8 @@ export class ServiceLevels extends APIResource {
   /**
    * Creates a service level for a carrier.
    *
+   * This endpoint requires the permission: `carriers:create`.
+   *
    * @example
    * ```ts
    * const serviceLevel =
@@ -87,6 +95,8 @@ export class ServiceLevels extends APIResource {
    *
    * System-owned service levels cannot be updated.
    *
+   * This endpoint requires the permission: `carriers:update`.
+   *
    * @example
    * ```ts
    * const serviceLevel =
@@ -118,6 +128,8 @@ export class ServiceLevels extends APIResource {
    * System-owned service levels and the carrier's default service level cannot be
    * deleted; unset `is_default` first to delete a default.
    *
+   * This endpoint requires the permission: `carriers:delete`.
+   *
    * @example
    * ```ts
    * const serviceLevel =

package/src/resources/operations/location-types.ts

@@ -1,8 +1,8 @@
 // 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 CustomersAPI from '../sales/customers/customers';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -14,6 +14,8 @@ export class LocationTypes extends APIResource {
   /**
    * Returns a paginated list of location types.
    *
+   * This endpoint requires the permission: `locations:read`.
+   *
    * @example
    * ```ts
    * const listLocationType =
@@ -30,6 +32,8 @@ export class LocationTypes extends APIResource {
   /**
    * Returns a location type by ID or code.
    *
+   * This endpoint requires the permission: `locations:read`.
+   *
    * @example
    * ```ts
    * const locationType =
@@ -83,7 +87,7 @@ export interface LocationType {
    * - `shelf`: a shelf within a rack.
    * - `bin`: a bin within a shelf.
    */
-  code: CustomersAPI.LocationTypeCode;
+  code: BlocksAPI.LocationTypeCode;
 
   /**
    * Creation timestamp.

package/src/resources/operations/locations.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as CustomersAPI from '../sales/customers/customers';
+import * as BlocksAPI from '../messaging/blocks';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -13,6 +13,8 @@ export class Locations extends APIResource {
   /**
    * Returns a paginated list of locations in your account.
    *
+   * This endpoint requires the permission: `locations:read`.
+   *
    * @example
    * ```ts
    * const listLocation =
@@ -22,13 +24,15 @@ export class Locations extends APIResource {
   list(
     query: LocationListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ListLocation> {
+  ): APIPromise<BlocksAPI.ListLocation> {
     return this._client.get('/v1/operations/locations', { query, ...options });
   }
 
   /**
    * Returns a location by ID.
    *
+   * This endpoint requires the permission: `locations:read`.
+   *
    * @example
    * ```ts
    * const location = await client.operations.locations.retrieve(
@@ -40,13 +44,15 @@ export class Locations extends APIResource {
     id: string,
     query: LocationRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.Location> {
+  ): APIPromise<BlocksAPI.Location> {
     return this._client.get(path`/v1/operations/locations/${id}`, { query, ...options });
   }
 
   /**
    * Creates a storage location, optionally placing it in the location hierarchy.
    *
+   * This endpoint requires the permission: `locations:create`.
+   *
    * @example
    * ```ts
    * const location = await client.operations.locations.create({
@@ -55,7 +61,7 @@ export class Locations extends APIResource {
    * });
    * ```
    */
-  create(params: LocationCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Location> {
+  create(params: LocationCreateParams, options?: RequestOptions): APIPromise<BlocksAPI.Location> {
     const { include, ...body } = params;
     return this._client.post('/v1/operations/locations', { query: { include }, body, ...options });
   }
@@ -63,6 +69,8 @@ export class Locations extends APIResource {
   /**
    * Partially updates a location.
    *
+   * This endpoint requires the permission: `locations:update`.
+   *
    * @example
    * ```ts
    * const location = await client.operations.locations.update(
@@ -75,7 +83,7 @@ export class Locations extends APIResource {
     id: string,
     params: LocationUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.Location> {
+  ): APIPromise<BlocksAPI.Location> {
     const { include, ...body } = params ?? {};
     return this._client.patch(path`/v1/operations/locations/${id}`, { query: { include }, body, ...options });
   }
@@ -86,6 +94,8 @@ export class Locations extends APIResource {
    * Fails if the location has child locations; remove or reassign the children
    * first.
    *
+   * This endpoint requires the permission: `locations:delete`.
+   *
    * @example
    * ```ts
    * const location = await client.operations.locations.delete(
@@ -119,7 +129,7 @@ export interface CreateLocationRequest {
    * - `shelf`: a shelf within a rack.
    * - `bin`: a bin within a shelf.
    */
-  type: CustomersAPI.LocationTypeCode;
+  type: BlocksAPI.LocationTypeCode;
 
   /**
    * IDs of existing locations to attach as children of the new location.
@@ -173,7 +183,7 @@ export interface UpdateLocationRequest {
    * - `shelf`: a shelf within a rack.
    * - `bin`: a bin within a shelf.
    */
-  type?: CustomersAPI.LocationTypeCode;
+  type?: BlocksAPI.LocationTypeCode;
 }
 
 export interface LocationDeleteResponse {}
@@ -234,7 +244,7 @@ export interface LocationCreateParams {
    * - `shelf`: a shelf within a rack.
    * - `bin`: a bin within a shelf.
    */
-  type: CustomersAPI.LocationTypeCode;
+  type: BlocksAPI.LocationTypeCode;
 
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
@@ -298,7 +308,7 @@ export interface LocationUpdateParams {
    * - `shelf`: a shelf within a rack.
    * - `bin`: a bin within a shelf.
    */
-  type?: CustomersAPI.LocationTypeCode;
+  type?: BlocksAPI.LocationTypeCode;
 }
 
 export declare namespace Locations {

package/src/resources/operations/scanning-stations.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as CustomersAPI from '../sales/customers/customers';
+import * as BlocksAPI from '../messaging/blocks';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -13,6 +13,8 @@ export class ScanningStations extends APIResource {
   /**
    * Returns a paginated list of scanning stations in your account.
    *
+   * This endpoint requires the permission: `scanners:read`.
+   *
    * @example
    * ```ts
    * const listScanningStation =
@@ -22,13 +24,15 @@ export class ScanningStations extends APIResource {
   list(
     query: ScanningStationListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ListScanningStation> {
+  ): APIPromise<BlocksAPI.ListScanningStation> {
     return this._client.get('/v1/operations/scanning-stations', { query, ...options });
   }
 
   /**
    * Returns a scanning station by ID.
    *
+   * This endpoint requires the permission: `scanners:read`.
+   *
    * @example
    * ```ts
    * const scanningStation =
@@ -41,7 +45,7 @@ export class ScanningStations extends APIResource {
     id: string,
     query: ScanningStationRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ScanningStation> {
+  ): APIPromise<BlocksAPI.ScanningStation> {
     return this._client.get(path`/v1/operations/scanning-stations/${id}`, { query, ...options });
   }
 
@@ -51,6 +55,8 @@ export class ScanningStations extends APIResource {
    * Returns a conflict error if a scanning station with the same name already
    * exists.
    *
+   * This endpoint requires the permission: `scanners:create`.
+   *
    * @example
    * ```ts
    * const scanningStation =
@@ -67,7 +73,7 @@ export class ScanningStations extends APIResource {
   create(
     params: ScanningStationCreateParams,
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ScanningStation> {
+  ): APIPromise<BlocksAPI.ScanningStation> {
     const { include, ...body } = params;
     return this._client.post('/v1/operations/scanning-stations', { query: { include }, body, ...options });
   }
@@ -78,6 +84,8 @@ export class ScanningStations extends APIResource {
    * Only the fields provided in the request are changed. Returns a conflict error if
    * the new name is already in use by another scanning station.
    *
+   * This endpoint requires the permission: `scanners:update`.
+   *
    * @example
    * ```ts
    * const scanningStation =
@@ -91,7 +99,7 @@ export class ScanningStations extends APIResource {
     id: string,
     params: ScanningStationUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.ScanningStation> {
+  ): APIPromise<BlocksAPI.ScanningStation> {
     const { include, ...body } = params ?? {};
     return this._client.patch(path`/v1/operations/scanning-stations/${id}`, {
       query: { include },
@@ -103,6 +111,8 @@ export class ScanningStations extends APIResource {
   /**
    * Deletes a scanning station.
    *
+   * This endpoint requires the permission: `scanners:delete`.
+   *
    * @example
    * ```ts
    * const scanningStation =

package/src/resources/operations/shipping-terms.ts

@@ -15,6 +15,8 @@ export class ShippingTerms extends APIResource {
    * Returns a paginated list of shipping terms for the account, including default
    * system shipping terms.
    *
+   * This endpoint requires the permission: `shipping_terms:read`.
+   *
    * @example
    * ```ts
    * const listShippingTerm =
@@ -31,6 +33,8 @@ export class ShippingTerms extends APIResource {
   /**
    * Returns a shipping term by ID.
    *
+   * This endpoint requires the permission: `shipping_terms:read`.
+   *
    * @example
    * ```ts
    * const shippingTerm =
@@ -50,6 +54,8 @@ export class ShippingTerms extends APIResource {
   /**
    * Creates an account-owned shipping term.
    *
+   * This endpoint requires the permission: `shipping_terms:create`.
+   *
    * @example
    * ```ts
    * const shippingTerm =
@@ -69,6 +75,8 @@ export class ShippingTerms extends APIResource {
    *
    * System-provided default shipping terms cannot be updated.
    *
+   * This endpoint requires the permission: `shipping_terms:update`.
+   *
    * @example
    * ```ts
    * const shippingTerm =
@@ -96,6 +104,8 @@ export class ShippingTerms extends APIResource {
    *
    * System-provided default shipping terms cannot be deleted.
    *
+   * This endpoint requires the permission: `shipping_terms:delete`.
+   *
    * @example
    * ```ts
    * const shippingTerm =

package/src/resources/sales/account-groups.ts

@@ -13,6 +13,8 @@ export class AccountGroups extends APIResource {
   /**
    * Returns a paginated list of account groups.
    *
+   * This endpoint requires the permission: `customer_groups:read`.
+   *
    * @example
    * ```ts
    * const listAccountGroup =
@@ -29,6 +31,8 @@ export class AccountGroups extends APIResource {
   /**
    * Returns an account group by ID.
    *
+   * This endpoint requires the permission: `customer_groups:read`.
+   *
    * @example
    * ```ts
    * const accountGroup =
@@ -46,6 +50,8 @@ export class AccountGroups extends APIResource {
    *
    * Returns a conflict error if an account group with the same name already exists.
    *
+   * This endpoint requires the permission: `customer_groups:create`.
+   *
    * @example
    * ```ts
    * const accountGroup =
@@ -65,6 +71,8 @@ export class AccountGroups extends APIResource {
    * Only the provided fields are changed. The account group's `type` cannot be
    * changed after creation.
    *
+   * This endpoint requires the permission: `customer_groups:update`.
+   *
    * @example
    * ```ts
    * const accountGroup =
@@ -89,6 +97,8 @@ export class AccountGroups extends APIResource {
    * for example by customer records, product line access, volume discounts, pricing
    * assignments, or an active registration flow.
    *
+   * This endpoint requires the permission: `customer_groups:delete`.
+   *
    * @example
    * ```ts
    * const accountGroup =

package/src/resources/sales/account-statuses.ts

@@ -79,7 +79,7 @@ export interface AccountStatus {
   created_at: string;
 
   /**
-   * Display name.
+   * Human-readable label for the status.
    */
   name: string;