@augno/sdk 0.1.6

package/src/resources/identity/identity.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RolesAPI from './roles';
+import {
+  CreateRoleRequest,
+  ListRole,
+  RoleCreateParams,
+  RoleDeleteResponse,
+  RoleListParams,
+  RoleRetrieveParams,
+  RoleUpdateParams,
+  Roles,
+  UpdateRoleRequest,
+} from './roles';
+import * as AccountUsersAPI from './account-users/account-users';
+import {
+  AccountUserCreateParams,
+  AccountUserListParams,
+  AccountUserRetrieveParams,
+  AccountUserUpdateParams,
+  AccountUsers,
+  CreateAccountUserRequest,
+  ListAccountUser,
+  NotificationPreferenceItem,
+  UpdateAccountUserRequest,
+} from './account-users/account-users';
+
+export class Identity extends APIResource {
+  accountUsers: AccountUsersAPI.AccountUsers = new AccountUsersAPI.AccountUsers(this._client);
+  roles: RolesAPI.Roles = new RolesAPI.Roles(this._client);
+}
+
+Identity.AccountUsers = AccountUsers;
+Identity.Roles = Roles;
+
+export declare namespace Identity {
+  export {
+    AccountUsers as AccountUsers,
+    type CreateAccountUserRequest as CreateAccountUserRequest,
+    type ListAccountUser as ListAccountUser,
+    type NotificationPreferenceItem as NotificationPreferenceItem,
+    type UpdateAccountUserRequest as UpdateAccountUserRequest,
+    type AccountUserCreateParams as AccountUserCreateParams,
+    type AccountUserRetrieveParams as AccountUserRetrieveParams,
+    type AccountUserUpdateParams as AccountUserUpdateParams,
+    type AccountUserListParams as AccountUserListParams,
+  };
+
+  export {
+    Roles as Roles,
+    type CreateRoleRequest as CreateRoleRequest,
+    type ListRole as ListRole,
+    type UpdateRoleRequest as UpdateRoleRequest,
+    type RoleDeleteResponse as RoleDeleteResponse,
+    type RoleCreateParams as RoleCreateParams,
+    type RoleRetrieveParams as RoleRetrieveParams,
+    type RoleUpdateParams as RoleUpdateParams,
+    type RoleListParams as RoleListParams,
+  };
+}

package/src/resources/identity/index.ts

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AccountUsers,
+  type CreateAccountUserRequest,
+  type ListAccountUser,
+  type NotificationPreferenceItem,
+  type UpdateAccountUserRequest,
+  type AccountUserCreateParams,
+  type AccountUserRetrieveParams,
+  type AccountUserUpdateParams,
+  type AccountUserListParams,
+} from './account-users/index';
+export { Identity } from './identity';
+export {
+  Roles,
+  type CreateRoleRequest,
+  type ListRole,
+  type UpdateRoleRequest,
+  type RoleDeleteResponse,
+  type RoleCreateParams,
+  type RoleRetrieveParams,
+  type RoleUpdateParams,
+  type RoleListParams,
+} from './roles';

package/src/resources/identity/roles.ts

@@ -0,0 +1,241 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+/**
+ * List and manage roles.
+ */
+export class Roles extends APIResource {
+  /**
+   * Creates a new role with the specified permissions.
+   *
+   * @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 });
+  }
+
+  /**
+   * Returns a role by ID, including its structured permissions.
+   *
+   * @example
+   * ```ts
+   * const role = await client.identity.roles.retrieve(
+   *   'rl_01c16d2eb637c0d1f3a372937c',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: RoleRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<APIKeysAPI.Role> {
+    return this._client.get(path`/v1/identity/roles/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a custom role's name or permissions. Provided permissions
+   * replace all existing ones; global roles cannot be modified.
+   *
+   * @example
+   * ```ts
+   * const role = await client.identity.roles.update(
+   *   'rl_01c16d2eb637c0d1f3a372937c',
+   *   {
+   *     name: 'Updated Manager',
+   *     permissions: ['customers:read', 'customers:update'],
+   *   },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    params: RoleUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<APIKeysAPI.Role> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/identity/roles/${id}`, { query: { include }, body, ...options });
+  }
+
+  /**
+   * 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.
+   *
+   * @example
+   * ```ts
+   * const role = await client.identity.roles.delete(
+   *   'rl_01c16d2eb637c0d1f3a372937c',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<RoleDeleteResponse> {
+    return this._client.delete(path`/v1/identity/roles/${id}`, options);
+  }
+}
+
+/**
+ * CreateRoleRequest is a request to create a role.
+ */
+export interface CreateRoleRequest {
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Permissions to attach in `<domain>:<action>` format.
+   */
+  permissions: Array<string>;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListRole {
+  /**
+   * Resources in this page.
+   */
+  data: Array<APIKeysAPI.Role>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * UpdateRoleRequest is a request to update a role.
+ */
+export interface UpdateRoleRequest {
+  /**
+   * Display name.
+   */
+  name?: string;
+
+  /**
+   * Permissions in `<domain>:<action>` format. Replaces all existing permissions;
+   * omit to leave unchanged.
+   */
+  permissions?: Array<string>;
+}
+
+export interface RoleDeleteResponse {}
+
+export interface RoleCreateParams {
+  /**
+   * Body param: Display name.
+   */
+  name: string;
+
+  /**
+   * Body param: Permissions to attach in `<domain>:<action>` format.
+   */
+  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'>;
+}
+
+export interface RoleRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'permissions'>;
+}
+
+export interface RoleUpdateParams {
+  /**
+   * 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: Display name.
+   */
+  name?: string;
+
+  /**
+   * Body param: Permissions in `<domain>:<action>` format. Replaces all existing
+   * permissions; omit to leave unchanged.
+   */
+  permissions?: Array<string>;
+}
+
+export interface RoleListParams {
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * 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).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Filter by role types.
+   */
+  types?: Array<'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent'>;
+}
+
+export declare namespace Roles {
+  export {
+    type CreateRoleRequest as CreateRoleRequest,
+    type ListRole as ListRole,
+    type UpdateRoleRequest as UpdateRoleRequest,
+    type RoleDeleteResponse as RoleDeleteResponse,
+    type RoleCreateParams as RoleCreateParams,
+    type RoleRetrieveParams as RoleRetrieveParams,
+    type RoleUpdateParams as RoleUpdateParams,
+    type RoleListParams as RoleListParams,
+  };
+}

package/src/resources/identity.ts

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

package/src/resources/index.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Auth } from './auth/auth';
+export { Catalog } from './catalog/catalog';
+export { Core } from './core/core';
+export {
+  Finance,
+  type AdjustmentType,
+  type ListAdjustmentType,
+  type ListTransactionMethod,
+  type ListTransactionType,
+  type TransactionMethod,
+  type TransactionType,
+  type FinanceRetrieveAdjustmentTypesParams,
+  type FinanceRetrieveTransactionMethodsParams,
+  type FinanceRetrieveTransactionTypesParams,
+} from './finance/finance';
+export { Identity } from './identity/identity';
+export { Operations } from './operations/operations';
+export { Sales } from './sales/sales';

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

@@ -0,0 +1,282 @@
+// 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 * as ServiceLevelsAPI from './service-levels';
+import {
+  CreateServiceLevelRequest,
+  ServiceLevelCreateParams,
+  ServiceLevelDeleteParams,
+  ServiceLevelDeleteResponse,
+  ServiceLevelListParams,
+  ServiceLevelRetrieveParams,
+  ServiceLevelUpdateParams,
+  ServiceLevels,
+  UpdateServiceLevelRequest,
+} from './service-levels';
+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';
+
+/**
+ * List and manage carriers and their Shippo integrations.
+ */
+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.
+   *
+   * @example
+   * ```ts
+   * const carrier = await client.operations.carriers.create({
+   *   account_number: '1234567890',
+   *   code: 'fedex',
+   *   name: '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 });
+  }
+
+  /**
+   * Returns a carrier by ID.
+   *
+   * @example
+   * ```ts
+   * const carrier = await client.operations.carriers.retrieve(
+   *   'cr_01784fd54c9ba197bb4e42f0e6',
+   * );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: CarrierRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.Carrier> {
+    return this._client.get(path`/v1/operations/carriers/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a carrier's name and portal visibility.
+   *
+   * @example
+   * ```ts
+   * const carrier = await client.operations.carriers.update(
+   *   'cr_01784fd54c9ba197bb4e42f0e6',
+   *   { name: 'FedEx Express' },
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    params: CarrierUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.Carrier> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/operations/carriers/${id}`, { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a paginated list of carriers for the current account.
+   *
+   * @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.
+   *
+   * @example
+   * ```ts
+   * const carrier = await client.operations.carriers.delete(
+   *   'cr_01784fd54c9ba197bb4e42f0e6',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<CarrierDeleteResponse> {
+    return this._client.delete(path`/v1/operations/carriers/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a carrier.
+ */
+export interface CreateCarrierRequest {
+  /**
+   * Carrier account number. Required for UPS and USPS carriers.
+   */
+  account_number: string | null;
+
+  /**
+   * Carrier code.
+   */
+  code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
+
+  /**
+   * Display name.
+   */
+  name: string;
+
+  /**
+   * Whether this carrier will be available for customers to select in the customer
+   * portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListCarrier {
+  /**
+   * Resources in this page.
+   */
+  data: Array<CustomersAPI.Carrier>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Request to update a carrier.
+ */
+export interface UpdateCarrierRequest {
+  /**
+   * Whether this carrier will be available for customers to select in the customer
+   * portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Display name.
+   */
+  name?: string;
+}
+
+export interface CarrierDeleteResponse {}
+
+export interface CarrierCreateParams {
+  /**
+   * Body param: Carrier account number. Required for UPS and USPS carriers.
+   */
+  account_number: string | null;
+
+  /**
+   * Body param: Carrier code.
+   */
+  code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
+
+  /**
+   * Body param: Display name.
+   */
+  name: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
+
+  /**
+   * Body param: Whether this carrier will be available for customers to select in
+   * the customer portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+}
+
+export interface CarrierRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
+}
+
+export interface CarrierUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
+
+  /**
+   * Body param: Whether this carrier will be available for customers to select in
+   * the customer portal.
+   */
+  customer_portal_visibility?: 'visible' | 'hidden';
+
+  /**
+   * Body param: Display name.
+   */
+  name?: string;
+}
+
+export interface CarrierListParams {
+  /**
+   * Cursor token used to retrieve the next or previous page of results.
+   */
+  cursor?: string;
+
+  /**
+   * 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).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+Carriers.ServiceLevels = ServiceLevels;
+
+export declare namespace Carriers {
+  export {
+    type CreateCarrierRequest as CreateCarrierRequest,
+    type ListCarrier as ListCarrier,
+    type UpdateCarrierRequest as UpdateCarrierRequest,
+    type CarrierDeleteResponse as CarrierDeleteResponse,
+    type CarrierCreateParams as CarrierCreateParams,
+    type CarrierRetrieveParams as CarrierRetrieveParams,
+    type CarrierUpdateParams as CarrierUpdateParams,
+    type CarrierListParams as CarrierListParams,
+  };
+
+  export {
+    ServiceLevels as ServiceLevels,
+    type CreateServiceLevelRequest as CreateServiceLevelRequest,
+    type UpdateServiceLevelRequest as UpdateServiceLevelRequest,
+    type ServiceLevelDeleteResponse as ServiceLevelDeleteResponse,
+    type ServiceLevelCreateParams as ServiceLevelCreateParams,
+    type ServiceLevelRetrieveParams as ServiceLevelRetrieveParams,
+    type ServiceLevelUpdateParams as ServiceLevelUpdateParams,
+    type ServiceLevelListParams as ServiceLevelListParams,
+    type ServiceLevelDeleteParams as ServiceLevelDeleteParams,
+  };
+}

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

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Carriers,
+  type CreateCarrierRequest,
+  type ListCarrier,
+  type UpdateCarrierRequest,
+  type CarrierDeleteResponse,
+  type CarrierCreateParams,
+  type CarrierRetrieveParams,
+  type CarrierUpdateParams,
+  type CarrierListParams,
+} from './carriers';
+export {
+  ServiceLevels,
+  type CreateServiceLevelRequest,
+  type UpdateServiceLevelRequest,
+  type ServiceLevelDeleteResponse,
+  type ServiceLevelCreateParams,
+  type ServiceLevelRetrieveParams,
+  type ServiceLevelUpdateParams,
+  type ServiceLevelListParams,
+  type ServiceLevelDeleteParams,
+} from './service-levels';