@augno/sdk 0.1.9 → 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

@@ -26,25 +26,26 @@ export class Carriers extends APIResource {
   serviceLevels: ServiceLevelsAPI.ServiceLevels = new ServiceLevelsAPI.ServiceLevels(this._client);
 
   /**
-   * Creates a carrier. If a Shippo-supported carrier code is provided, the carrier
-   * will be registered with Shippo and service levels will be auto-synced as
-   * options.
+   * Returns a paginated list of carriers for the current account.
+   *
+   * This endpoint requires the permissions: `carriers:read`, `customers:read`,
+   * `suppliers:read`.
    *
    * @example
    * ```ts
-   * const carrier = await client.operations.carriers.create({
-   *   name: 'FedEx',
-   * });
+   * const listCarrier = await client.operations.carriers.list();
    * ```
    */
-  create(params: CarrierCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Carrier> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/operations/carriers', { query: { include }, body, ...options });
+  list(query: CarrierListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListCarrier> {
+    return this._client.get('/v1/operations/carriers', { query, ...options });
   }
 
   /**
    * 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(
@@ -60,13 +61,40 @@ export class Carriers extends APIResource {
     return this._client.get(path`/v1/operations/carriers/${id}`, { query, ...options });
   }
 
+  /**
+   * Creates a carrier.
+   *
+   * If a Shippo-supported code (`fedex`, `ups`, `usps`) is provided, the carrier is
+   * 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({
+   *   name: 'FedEx',
+   *   account_number: '1234567890',
+   *   code: 'fedex',
+   *   customer_portal_visibility: 'visible',
+   * });
+   * ```
+   */
+  create(params: CarrierCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.Carrier> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/operations/carriers', { query: { include }, body, ...options });
+  }
+
   /**
    * 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(
    *   'cr_01784fd54c9ba197bb4e42f0e6',
+   *   { name: 'FedEx Express' },
    * );
    * ```
    */
@@ -80,20 +108,12 @@ export class Carriers extends APIResource {
   }
 
   /**
-   * Returns a paginated list of carriers for the current account.
+   * Deletes a carrier and all of its service levels.
    *
-   * @example
-   * ```ts
-   * const listCarrier = await client.operations.carriers.list();
-   * ```
-   */
-  list(query: CarrierListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListCarrier> {
-    return this._client.get('/v1/operations/carriers', { query, ...options });
-  }
-
-  /**
-   * Deletes a carrier and cascades to remove all options. If the carrier is managed
-   * by Shippo, the Shippo account is deactivated.
+   * 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
@@ -112,26 +132,33 @@ export class Carriers extends APIResource {
  */
 export interface CreateCarrierRequest {
   /**
-   * Display name.
+   * Human-readable name for the carrier.
+   *
+   * Must be unique among your account's carriers.
    */
   name: string;
 
   /**
-   * Carrier account number. Required for UPS and USPS carriers.
+   * Your account number with this carrier.
+   *
+   * Required when `code` is `ups` or `usps`, which connect to Shippo using this
+   * number; FedEx connects via OAuth instead.
    */
   account_number?: string;
 
   /**
-   * Carrier code.
+   * Well-known carrier code.
+   *
+   * Omit for a custom carrier. Providing a Shippo-supported code (`fedex`, `ups`,
+   * `usps`) connects the carrier through Shippo and auto-syncs its service levels.
    */
   code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
 
   /**
    * 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. New carriers are visible unless set to `hidden`.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 }
@@ -163,50 +190,46 @@ 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';
 
   /**
-   * Display name.
+   * Human-readable name for the carrier, unique among your account's carriers.
    */
   name?: string;
 }
 
 export interface CarrierDeleteResponse {}
 
-export interface CarrierCreateParams {
+export interface CarrierListParams {
   /**
-   * Body param: Display name.
+   * Opaque cursor token identifying where the page of results starts.
+   *
+   * Use the `cursor` value embedded in a previous response's `next_page_url` or
+   * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+   * page.
    */
-  name: string;
+  cursor?: string;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
   include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Body param: Carrier account number. Required for UPS and USPS carriers.
+   * Maximum number of results to return in a single page.
    */
-  account_number?: string;
-
-  /**
-   * Body param: Carrier code.
-   */
-  code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
+  limit?: number;
 
   /**
-   * Body param: Carrier visibility in the customer portal.
+   * Free-text search term used to filter results.
    *
-   * 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.
+   * Which fields are matched against the term varies by endpoint.
    */
-  customer_portal_visibility?: 'visible' | 'hidden';
+  q?: string;
 }
 
 export interface CarrierRetrieveParams {
@@ -217,7 +240,14 @@ export interface CarrierRetrieveParams {
   include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 }
 
-export interface CarrierUpdateParams {
+export interface CarrierCreateParams {
+  /**
+   * Body param: Human-readable name for the carrier.
+   *
+   * Must be unique among your account's carriers.
+   */
+  name: string;
+
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
@@ -225,41 +255,50 @@ export interface CarrierUpdateParams {
   include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Body param: Carrier visibility in the customer portal.
+   * Body param: Your account number with this carrier.
    *
-   * 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.
+   * Required when `code` is `ups` or `usps`, which connect to Shippo using this
+   * number; FedEx connects via OAuth instead.
    */
-  customer_portal_visibility?: 'visible' | 'hidden';
+  account_number?: string;
 
   /**
-   * Body param: Display name.
+   * Body param: Well-known carrier code.
+   *
+   * Omit for a custom carrier. Providing a Shippo-supported code (`fedex`, `ups`,
+   * `usps`) connects the carrier through Shippo and auto-syncs its service levels.
    */
-  name?: string;
-}
+  code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
 
-export interface CarrierListParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Body param: Carrier visibility in the customer portal.
+   *
+   * A `visible` carrier can be selected by your customers at checkout; a `hidden`
+   * carrier is not offered there. New carriers are visible unless set to `hidden`.
    */
-  cursor?: string;
+  customer_portal_visibility?: 'visible' | 'hidden';
+}
 
+export interface CarrierUpdateParams {
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
   include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: Carrier visibility in the customer portal.
+   *
+   * A `visible` carrier can be selected by your customers at checkout; a `hidden`
+   * carrier is not offered there.
    */
-  limit?: number;
+  customer_portal_visibility?: 'visible' | 'hidden';
 
   /**
-   * Search query used to filter results.
+   * Body param: Human-readable name for the carrier, unique among your account's
+   * carriers.
    */
-  q?: string;
+  name?: string;
 }
 
 Carriers.ServiceLevels = ServiceLevels;
@@ -270,10 +309,10 @@ export declare namespace Carriers {
     type ListCarrier as ListCarrier,
     type UpdateCarrierRequest as UpdateCarrierRequest,
     type CarrierDeleteResponse as CarrierDeleteResponse,
-    type CarrierCreateParams as CarrierCreateParams,
+    type CarrierListParams as CarrierListParams,
     type CarrierRetrieveParams as CarrierRetrieveParams,
+    type CarrierCreateParams as CarrierCreateParams,
     type CarrierUpdateParams as CarrierUpdateParams,
-    type CarrierListParams as CarrierListParams,
   };
 
   export {
@@ -281,10 +320,10 @@ export declare namespace Carriers {
     type CreateServiceLevelRequest as CreateServiceLevelRequest,
     type UpdateServiceLevelRequest as UpdateServiceLevelRequest,
     type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse,
-    type ServiceLevelCreateParams as ServiceLevelCreateParams,
+    type ServiceLevelListParams as ServiceLevelListParams,
     type ServiceLevelRetrieveParams as ServiceLevelRetrieveParams,
+    type ServiceLevelCreateParams as ServiceLevelCreateParams,
     type ServiceLevelUpdateParams as ServiceLevelUpdateParams,
-    type ServiceLevelListParams as ServiceLevelListParams,
     type ServiceLevelDeleteParams as ServiceLevelDeleteParams,
   };
 }

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

@@ -6,19 +6,19 @@ export {
   type ListCarrier,
   type UpdateCarrierRequest,
   type CarrierDeleteResponse,
-  type CarrierCreateParams,
+  type CarrierListParams,
   type CarrierRetrieveParams,
+  type CarrierCreateParams,
   type CarrierUpdateParams,
-  type CarrierListParams,
 } from './carriers';
 export {
   ServiceLevels,
   type CreateServiceLevelRequest,
   type UpdateServiceLevelRequest,
   type ServiceLevelDeleteResponse,
-  type ServiceLevelCreateParams,
+  type ServiceLevelListParams,
   type ServiceLevelRetrieveParams,
+  type ServiceLevelCreateParams,
   type ServiceLevelUpdateParams,
-  type ServiceLevelListParams,
   type ServiceLevelDeleteParams,
 } from './service-levels';