@augno/sdk 0.1.6 → 0.7.0

package/src/resources/identity/roles.ts

@@ -11,28 +11,20 @@ import { path } from '../../internal/utils/path';
  */
 export class Roles extends APIResource {
   /**
-   * Creates a new role with the specified permissions.
+   * Returns a paginated list of roles for the target account, including global
+   * roles.
    *
    * @example
    * ```ts
-   * const role = await client.identity.roles.create({
-   *   name: 'Warehouse Manager',
-   *   permissions: [
-   *     'customers:create',
-   *     'customers:read',
-   *     'customers:update',
-   *     'invoices:read',
-   *   ],
-   * });
+   * const listRole = await client.identity.roles.list();
    * ```
    */
-  create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/identity/roles', { query: { include }, body, ...options });
+  list(query: RoleListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListRole> {
+    return this._client.get('/v1/identity/roles', { query, ...options });
   }
 
   /**
-   * Returns a role by ID, including its structured permissions.
+   * Returns a role by ID, including its permissions.
    *
    * @example
    * ```ts
@@ -49,6 +41,28 @@ export class Roles extends APIResource {
     return this._client.get(path`/v1/identity/roles/${id}`, { query, ...options });
   }
 
+  /**
+   * Creates a custom role with the specified permissions. Roles created through the
+   * API always have type `user`.
+   *
+   * @example
+   * ```ts
+   * const role = await client.identity.roles.create({
+   *   name: 'Warehouse Manager',
+   *   permissions: [
+   *     'customers:create',
+   *     'customers:read',
+   *     'customers:update',
+   *     'invoices:read',
+   *   ],
+   * });
+   * ```
+   */
+  create(params: RoleCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Role> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/identity/roles', { query: { include }, body, ...options });
+  }
+
   /**
    * Partially updates a custom role's name or permissions. Provided permissions
    * replace all existing ones; global roles cannot be modified.
@@ -74,20 +88,8 @@ export class Roles extends APIResource {
   }
 
   /**
-   * Returns a paginated list of roles for the target account, including global
-   * roles.
-   *
-   * @example
-   * ```ts
-   * const listRole = await client.identity.roles.list();
-   * ```
-   */
-  list(query: RoleListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ListRole> {
-    return this._client.get('/v1/identity/roles', { query, ...options });
-  }
-
-  /**
-   * Deletes a role and its associated permissions. Global roles cannot be deleted.
+   * Deletes a role and its associated permissions. Global roles and roles currently
+   * assigned to one or more users cannot be deleted.
    *
    * @example
    * ```ts
@@ -106,12 +108,15 @@ export class Roles extends APIResource {
  */
 export interface CreateRoleRequest {
   /**
-   * Display name.
+   * Display name for the role, unique within the account.
    */
   name: string;
 
   /**
-   * Permissions to attach in `<domain>:<action>` format.
+   * Permissions to grant, in `{domain}:{action}` format, such as `customers:read`.
+   *
+   * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
+   * create a role with no permissions.
    */
   permissions: Array<string>;
 }
@@ -141,35 +146,55 @@ export interface ListRole {
  */
 export interface UpdateRoleRequest {
   /**
-   * Display name.
+   * New display name for the role, unique within the account. Omit to leave
+   * unchanged.
    */
   name?: string;
 
   /**
-   * Permissions in `<domain>:<action>` format. Replaces all existing permissions;
-   * omit to leave unchanged.
+   * Full replacement set of permissions, in `{domain}:{action}` format, such as
+   * `customers:read`.
+   *
+   * Replaces all existing permissions on the role. Pass an empty array to remove all
+   * permissions, or omit to leave them unchanged.
    */
   permissions?: Array<string>;
 }
 
 export interface RoleDeleteResponse {}
 
-export interface RoleCreateParams {
+export interface RoleListParams {
+  /**
+   * 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.
+   */
+  cursor?: string;
+
   /**
-   * Body param: Display name.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  name: string;
+  include?: Array<'owner' | 'owner.account' | 'permissions'>;
 
   /**
-   * Body param: Permissions to attach in `<domain>:<action>` format.
+   * Maximum number of results to return in a single page.
    */
-  permissions: Array<string>;
+  limit?: number;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  include?: Array<'owner' | 'owner.account' | 'permissions'>;
+  q?: string;
+
+  /**
+   * Filter results to roles whose type matches any of the given values.
+   */
+  types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
 }
 
 export interface RoleRetrieveParams {
@@ -180,51 +205,49 @@ export interface RoleRetrieveParams {
   include?: Array<'owner' | 'owner.account' | 'permissions'>;
 }
 
-export interface RoleUpdateParams {
+export interface RoleCreateParams {
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Body param: Display name for the role, unique within the account.
    */
-  include?: Array<'owner' | 'owner.account' | 'permissions'>;
+  name: string;
 
   /**
-   * Body param: Display name.
+   * Body param: Permissions to grant, in `{domain}:{action}` format, such as
+   * `customers:read`.
+   *
+   * The action must be one of `create`, `read`, `update`, or `delete`. Omit to
+   * create a role with no permissions.
    */
-  name?: string;
+  permissions: Array<string>;
 
   /**
-   * Body param: Permissions in `<domain>:<action>` format. Replaces all existing
-   * permissions; omit to leave unchanged.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  permissions?: Array<string>;
+  include?: Array<'owner' | 'owner.account' | 'permissions'>;
 }
 
-export interface RoleListParams {
-  /**
-   * Cursor token used to retrieve the next or previous page of results.
-   */
-  cursor?: string;
-
+export interface RoleUpdateParams {
   /**
-   * 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' | 'permissions'>;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: New display name for the role, unique within the account. Omit to
+   * leave unchanged.
    */
-  limit?: number;
-
-  /**
-   * Search query used to filter results.
-   */
-  q?: string;
+  name?: string;
 
   /**
-   * Filter by role types.
+   * Body param: Full replacement set of permissions, in `{domain}:{action}` format,
+   * such as `customers:read`.
+   *
+   * Replaces all existing permissions on the role. Pass an empty array to remove all
+   * permissions, or omit to leave them unchanged.
    */
-  types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
+  permissions?: Array<string>;
 }
 
 export declare namespace Roles {
@@ -233,9 +256,9 @@ export declare namespace Roles {
     type ListRole as ListRole,
     type UpdateRoleRequest as UpdateRoleRequest,
     type RoleDeleteResponse as RoleDeleteResponse,
-    type RoleCreateParams as RoleCreateParams,
+    type RoleListParams as RoleListParams,
     type RoleRetrieveParams as RoleRetrieveParams,
+    type RoleCreateParams as RoleCreateParams,
     type RoleUpdateParams as RoleUpdateParams,
-    type RoleListParams as RoleListParams,
   };
 }

package/src/resources/index.ts

@@ -11,10 +11,11 @@ export {
   type ListTransactionType,
   type TransactionMethod,
   type TransactionType,
-  type FinanceRetrieveAdjustmentTypesParams,
-  type FinanceRetrieveTransactionMethodsParams,
   type FinanceRetrieveTransactionTypesParams,
+  type FinanceRetrieveTransactionMethodsParams,
+  type FinanceRetrieveAdjustmentTypesParams,
 } from './finance/finance';
 export { Identity } from './identity/identity';
 export { Operations } from './operations/operations';
 export { Sales } from './sales/sales';
+export { Settings } from './settings/settings';

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

@@ -26,23 +26,15 @@ 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.
    *
    * @example
    * ```ts
-   * const carrier = await client.operations.carriers.create({
-   *   account_number: '1234567890',
-   *   code: 'fedex',
-   *   name: 'FedEx',
-   *   customer_portal_visibility: 'visible',
-   * });
+   * 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 });
   }
 
   /**
@@ -63,6 +55,28 @@ 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.
+   *
+   * @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.
    *
@@ -84,20 +98,10 @@ 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.
    *
    * @example
    * ```ts
@@ -116,23 +120,33 @@ export class Carriers extends APIResource {
  */
 export interface CreateCarrierRequest {
   /**
-   * Carrier account number. Required for UPS and USPS carriers.
+   * Human-readable name for the carrier.
+   *
+   * Must be unique among your account's carriers.
    */
-  account_number: string | null;
+  name: string;
 
   /**
-   * Carrier code.
+   * 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.
    */
-  code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
+  account_number?: string;
 
   /**
-   * Display name.
+   * 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';
 
   /**
-   * Whether this carrier will be available for customers to select in the customer
-   * portal.
+   * 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`.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 }
@@ -162,46 +176,49 @@ export interface ListCarrier {
  */
 export interface UpdateCarrierRequest {
   /**
-   * Whether this carrier will be available for customers to select in the customer
-   * portal.
+   * 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.
    */
   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 {
-  /**
-   * Body param: Carrier account number. Required for UPS and USPS carriers.
-   */
-  account_number: string | null;
-
+export interface CarrierListParams {
   /**
-   * Body param: Carrier code.
+   * 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.
    */
-  code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
+  cursor?: string;
 
   /**
-   * Body param: Display name.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  name: string;
+  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Maximum number of results to return in a single page.
    */
-  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
+  limit?: number;
 
   /**
-   * Body param: Whether this carrier will be available for customers to select in
-   * the customer portal.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  customer_portal_visibility?: 'visible' | 'hidden';
+  q?: string;
 }
 
 export interface CarrierRetrieveParams {
@@ -212,7 +229,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`.
@@ -220,38 +244,51 @@ export interface CarrierUpdateParams {
   include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Body param: Whether this carrier will be available for customers to select in
-   * the customer portal.
+   * Body param: 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.
    */
-  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.
+   *
+   * 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.
    */
-  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;
@@ -262,10 +299,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 {
@@ -273,10 +310,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';