@augno/sdk 0.1.6

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

@@ -0,0 +1,217 @@
+// 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 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 payment terms.
+ */
+export class PaymentTerms extends APIResource {
+  /**
+   * Creates a payment term.
+   *
+   * @example
+   * ```ts
+   * const paymentTerm =
+   *   await client.finance.paymentTerms.create({
+   *     name: 'Net 30',
+   *   });
+   * ```
+   */
+  create(params: PaymentTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.PaymentTerm> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/finance/payment-terms', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns a payment term by ID.
+   *
+   * @example
+   * ```ts
+   * const paymentTerm =
+   *   await client.finance.paymentTerms.retrieve(
+   *     'pytm_018694d6601ea771cd1b52e890',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: PaymentTermRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.PaymentTerm> {
+    return this._client.get(path`/v1/finance/payment-terms/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates a payment term. Default payment terms cannot be updated.
+   *
+   * @example
+   * ```ts
+   * const paymentTerm =
+   *   await client.finance.paymentTerms.update(
+   *     'pytm_018694d6601ea771cd1b52e890',
+   *     { name: 'Net 60' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: PaymentTermUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.PaymentTerm> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/finance/payment-terms/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a paginated list of payment terms. Includes both account-specific and
+   * system default payment terms.
+   *
+   * @example
+   * ```ts
+   * const listPaymentTerm =
+   *   await client.finance.paymentTerms.list();
+   * ```
+   */
+  list(
+    query: PaymentTermListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListPaymentTerm> {
+    return this._client.get('/v1/finance/payment-terms', { query, ...options });
+  }
+
+  /**
+   * Deletes a payment term. Default payment terms cannot be deleted.
+   *
+   * @example
+   * ```ts
+   * const paymentTerm =
+   *   await client.finance.paymentTerms.delete(
+   *     'pytm_018694d6601ea771cd1b52e890',
+   *   );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<PaymentTermDeleteResponse> {
+    return this._client.delete(path`/v1/finance/payment-terms/${id}`, options);
+  }
+}
+
+/**
+ * Request to create a payment term.
+ */
+export interface CreatePaymentTermRequest {
+  /**
+   * Display name (e.g. "Net 30").
+   */
+  name: string;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListPaymentTerm {
+  /**
+   * Resources in this page.
+   */
+  data: Array<CustomersAPI.PaymentTerm>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * Request to partially update a payment term.
+ */
+export interface UpdatePaymentTermRequest {
+  /**
+   * Display name.
+   */
+  name?: string;
+}
+
+export interface PaymentTermDeleteResponse {}
+
+export interface PaymentTermCreateParams {
+  /**
+   * Body param: Display name (e.g. "Net 30").
+   */
+  name: string;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account'>;
+}
+
+export interface PaymentTermRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'owner' | 'owner.account'>;
+}
+
+export interface PaymentTermUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'owner' | 'owner.account'>;
+
+  /**
+   * Body param: Display name.
+   */
+  name?: string;
+}
+
+export interface PaymentTermListParams {
+  /**
+   * 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'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+}
+
+export declare namespace PaymentTerms {
+  export {
+    type CreatePaymentTermRequest as CreatePaymentTermRequest,
+    type ListPaymentTerm as ListPaymentTerm,
+    type UpdatePaymentTermRequest as UpdatePaymentTermRequest,
+    type PaymentTermDeleteResponse as PaymentTermDeleteResponse,
+    type PaymentTermCreateParams as PaymentTermCreateParams,
+    type PaymentTermRetrieveParams as PaymentTermRetrieveParams,
+    type PaymentTermUpdateParams as PaymentTermUpdateParams,
+    type PaymentTermListParams as PaymentTermListParams,
+  };
+}

package/src/resources/finance.ts

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

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

@@ -0,0 +1,360 @@
+// 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 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';
+
+/**
+ * List and manage account users.
+ */
+export class AccountUsers extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Creates a new account user and invites them to the target account.
+   *
+   * @example
+   * ```ts
+   * const accountUser =
+   *   await client.identity.accountUsers.create({
+   *     email: 'jdoe@augno.com',
+   *     name: 'John Doe',
+   *     password: 'QgS7Z8Hhj3&1',
+   *     username: 'jdoe',
+   *     preferences: [
+   *       {
+   *         notification_type: 'order_acknowledgement',
+   *         enabled: true,
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  create(params: AccountUserCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.AccountUser> {
+    const { include, ...body } = params;
+    return this._client.post('/v1/identity/account-users', { query: { include }, body, ...options });
+  }
+
+  /**
+   * Returns an account user by ID.
+   *
+   * @example
+   * ```ts
+   * const accountUser =
+   *   await client.identity.accountUsers.retrieve(
+   *     'acus_01ea9983ddb41dacc44ecf997c',
+   *   );
+   * ```
+   */
+  retrieve(
+    id: string,
+    query: AccountUserRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.AccountUser> {
+    return this._client.get(path`/v1/identity/account-users/${id}`, { query, ...options });
+  }
+
+  /**
+   * Partially updates an account user.
+   *
+   * @example
+   * ```ts
+   * const accountUser =
+   *   await client.identity.accountUsers.update(
+   *     'acus_01ea9983ddb41dacc44ecf997c',
+   *     { name: 'John Doe' },
+   *   );
+   * ```
+   */
+  update(
+    id: string,
+    params: AccountUserUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.AccountUser> {
+    const { include, ...body } = params ?? {};
+    return this._client.patch(path`/v1/identity/account-users/${id}`, {
+      query: { include },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns a paginated list of account users for the current account.
+   *
+   * @example
+   * ```ts
+   * const listAccountUser =
+   *   await client.identity.accountUsers.list();
+   * ```
+   */
+  list(
+    query: AccountUserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListAccountUser> {
+    return this._client.get('/v1/identity/account-users', { query, ...options });
+  }
+}
+
+/**
+ * Request to create an account user.
+ */
+export interface CreateAccountUserRequest {
+  /**
+   * User email address.
+   */
+  email: string | null;
+
+  /**
+   * User display name.
+   */
+  name: string | null;
+
+  /**
+   * Password. Only used for scanner-role users (scanning stations). Must be 8–72
+   * chars and include upper, lower, number, and special character.
+   */
+  password: string | null;
+
+  /**
+   * Unique username (3–255 chars; letters, numbers, underscores, hyphens).
+   */
+  username: string | null;
+
+  /**
+   * Department assigned to the user.
+   */
+  department_id?: string | null;
+
+  /**
+   * Notification preferences for the user (external targets only).
+   */
+  preferences?: Array<NotificationPreferenceItem>;
+
+  /**
+   * Role assigned to the user.
+   */
+  role_id?: string | null;
+}
+
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListAccountUser {
+  /**
+   * Resources in this page.
+   */
+  data: Array<CustomersAPI.AccountUser>;
+
+  /**
+   * Resource type identifier.
+   */
+  object: 'list';
+
+  /**
+   * PageInfo contains URL-based pagination metadata.
+   */
+  page_info: APIKeysAPI.PageInfo;
+}
+
+/**
+ * NotificationPreferenceItem toggles a single account-relation notification type.
+ */
+export interface NotificationPreferenceItem {
+  /**
+   * Whether this notification type is enabled for the account user.
+   */
+  enabled: boolean;
+
+  /**
+   * Notification type.
+   */
+  notification_type: 'invoice' | 'order_acknowledgement' | 'purchase_order_submission';
+}
+
+/**
+ * Request to partially update an account user.
+ */
+export interface UpdateAccountUserRequest {
+  /**
+   * Department assigned to the user.
+   */
+  department_id?: string | null;
+
+  /**
+   * User email address.
+   */
+  email?: string;
+
+  /**
+   * User display name.
+   */
+  name?: string;
+
+  /**
+   * Notification preferences to update (external targets only).
+   */
+  preferences?: Array<NotificationPreferenceItem>;
+
+  /**
+   * Role assigned to the user.
+   */
+  role_id?: string | null;
+
+  /**
+   * Unique username (3–255 chars; letters, numbers, underscores, hyphens).
+   */
+  username?: string;
+}
+
+export interface AccountUserCreateParams {
+  /**
+   * Body param: User email address.
+   */
+  email: string | null;
+
+  /**
+   * Body param: User display name.
+   */
+  name: string | null;
+
+  /**
+   * Body param: Password. Only used for scanner-role users (scanning stations). Must
+   * be 8–72 chars and include upper, lower, number, and special character.
+   */
+  password: string | null;
+
+  /**
+   * Body param: Unique username (3–255 chars; letters, numbers, underscores,
+   * hyphens).
+   */
+  username: string | null;
+
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'role' | 'department'>;
+
+  /**
+   * Body param: Department assigned to the user.
+   */
+  department_id?: string | null;
+
+  /**
+   * Body param: Notification preferences for the user (external targets only).
+   */
+  preferences?: Array<NotificationPreferenceItem>;
+
+  /**
+   * Body param: Role assigned to the user.
+   */
+  role_id?: string | null;
+}
+
+export interface AccountUserRetrieveParams {
+  /**
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'role' | 'department'>;
+}
+
+export interface AccountUserUpdateParams {
+  /**
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
+   */
+  include?: Array<'role' | 'department'>;
+
+  /**
+   * Body param: Department assigned to the user.
+   */
+  department_id?: string | null;
+
+  /**
+   * Body param: User email address.
+   */
+  email?: string;
+
+  /**
+   * Body param: User display name.
+   */
+  name?: string;
+
+  /**
+   * Body param: Notification preferences to update (external targets only).
+   */
+  preferences?: Array<NotificationPreferenceItem>;
+
+  /**
+   * Body param: Role assigned to the user.
+   */
+  role_id?: string | null;
+
+  /**
+   * Body param: Unique username (3–255 chars; letters, numbers, underscores,
+   * hyphens).
+   */
+  username?: string;
+}
+
+export interface AccountUserListParams {
+  /**
+   * 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<'role' | 'department'>;
+
+  /**
+   * Maximum number of results per page (default: 100, max: 1000).
+   */
+  limit?: number;
+
+  /**
+   * Search query used to filter results.
+   */
+  q?: string;
+
+  /**
+   * Controls whether removed account users are included.
+   */
+  removed_scope?: 'excluded' | 'included';
+
+  /**
+   * Filter by role type code.
+   */
+  role_type?: 'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent';
+}
+
+AccountUsers.Actions = Actions;
+
+export declare namespace AccountUsers {
+  export {
+    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 {
+    Actions as Actions,
+    type ActionActivateResponse as ActionActivateResponse,
+    type ActionDisableResponse as ActionDisableResponse,
+    type ActionRemoveResponse as ActionRemoveResponse,
+  };
+}

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

@@ -0,0 +1,71 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * List and manage account users.
+ */
+export class Actions extends APIResource {
+  /**
+   * Activates a disabled or removed account user.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.identity.accountUsers.actions.activate(
+   *     'acus_01ea9983ddb41dacc44ecf997c',
+   *   );
+   * ```
+   */
+  activate(id: string, options?: RequestOptions): APIPromise<ActionActivateResponse> {
+    return this._client.put(path`/v1/identity/account-users/${id}/actions/activate`, options);
+  }
+
+  /**
+   * Disables an account user. Disabled users will not be able to access the target
+   * account.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.identity.accountUsers.actions.disable(
+   *     'acus_01ea9983ddb41dacc44ecf997c',
+   *   );
+   * ```
+   */
+  disable(id: string, options?: RequestOptions): APIPromise<ActionDisableResponse> {
+    return this._client.put(path`/v1/identity/account-users/${id}/actions/disable`, options);
+  }
+
+  /**
+   * Removes a user from the target account.
+   *
+   * @example
+   * ```ts
+   * const action =
+   *   await client.identity.accountUsers.actions.remove(
+   *     'acus_01ea9983ddb41dacc44ecf997c',
+   *   );
+   * ```
+   */
+  remove(id: string, options?: RequestOptions): APIPromise<ActionRemoveResponse> {
+    return this._client.put(path`/v1/identity/account-users/${id}/actions/remove`, options);
+  }
+}
+
+export interface ActionActivateResponse {}
+
+export interface ActionDisableResponse {}
+
+export interface ActionRemoveResponse {}
+
+export declare namespace Actions {
+  export {
+    type ActionActivateResponse as ActionActivateResponse,
+    type ActionDisableResponse as ActionDisableResponse,
+    type ActionRemoveResponse as ActionRemoveResponse,
+  };
+}

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

@@ -0,0 +1,19 @@
+// 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';
+export {
+  Actions,
+  type ActionActivateResponse,
+  type ActionDisableResponse,
+  type ActionRemoveResponse,
+} from './actions';

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

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