@augno/sdk 0.1.6 → 0.7.0

package/src/resources/finance/finance.ts

@@ -24,19 +24,19 @@ export class Finance extends APIResource {
   paymentTerms: PaymentTermsAPI.PaymentTerms = new PaymentTermsAPI.PaymentTerms(this._client);
 
   /**
-   * Returns a paginated list of adjustment types.
+   * Returns a paginated list of transaction types.
    *
    * @example
    * ```ts
-   * const listAdjustmentType =
-   *   await client.finance.retrieveAdjustmentTypes();
+   * const listTransactionType =
+   *   await client.finance.retrieveTransactionTypes();
    * ```
    */
-  retrieveAdjustmentTypes(
-    query: FinanceRetrieveAdjustmentTypesParams | null | undefined = {},
+  retrieveTransactionTypes(
+    query: FinanceRetrieveTransactionTypesParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ListAdjustmentType> {
-    return this._client.get('/v1/finance/adjustment-types', { query, ...options });
+  ): APIPromise<ListTransactionType> {
+    return this._client.get('/v1/finance/transaction-types', { query, ...options });
   }
 
   /**
@@ -56,33 +56,44 @@ export class Finance extends APIResource {
   }
 
   /**
-   * Returns a paginated list of transaction types.
+   * Returns a paginated list of adjustment types.
    *
    * @example
    * ```ts
-   * const listTransactionType =
-   *   await client.finance.retrieveTransactionTypes();
+   * const listAdjustmentType =
+   *   await client.finance.retrieveAdjustmentTypes();
    * ```
    */
-  retrieveTransactionTypes(
-    query: FinanceRetrieveTransactionTypesParams | null | undefined = {},
+  retrieveAdjustmentTypes(
+    query: FinanceRetrieveAdjustmentTypesParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ListTransactionType> {
-    return this._client.get('/v1/finance/transaction-types', { query, ...options });
+  ): APIPromise<ListAdjustmentType> {
+    return this._client.get('/v1/finance/adjustment-types', { query, ...options });
   }
 }
 
 /**
- * Adjustment type resource.
+ * A category of financial adjustment, such as a discount, fee, or write-off.
+ *
+ * Adjustment types classify adjustment transactions recorded against customer
+ * invoices.
  */
 export interface AdjustmentType {
   /**
-   * Adjustment ID.
+   * Adjustment type ID.
    */
   id: string;
 
   /**
-   * Machine-readable code.
+   * Machine-readable code identifying what kind of adjustment this is.
+   *
+   * - `discount`: a price reduction.
+   * - `shipping_discrepancy`: corrects a difference between quoted and actual
+   *   freight.
+   * - `short_payment`: reconciles an invoice paid for less than the amount due.
+   * - `write_off`: cancels an uncollectible balance.
+   * - `fee`: an additional charge.
+   * - `refund`: returns money to the customer.
    */
   code: 'discount' | 'shipping_discrepancy' | 'short_payment' | 'write_off' | 'fee' | 'refund';
 
@@ -92,7 +103,7 @@ export interface AdjustmentType {
   created_at: string;
 
   /**
-   * Display name.
+   * Human-readable name of the adjustment type (e.g. "Discount").
    */
   name: string;
 
@@ -173,7 +184,7 @@ export interface ListTransactionType {
 }
 
 /**
- * Transaction method resource.
+ * The payment method used to make a transaction, such as cash or check.
  */
 export interface TransactionMethod {
   /**
@@ -182,7 +193,7 @@ export interface TransactionMethod {
   id: string;
 
   /**
-   * Machine-readable code.
+   * Machine-readable code identifying how the transaction was made.
    */
   code: 'cash' | 'check' | 'credit_card' | 'gift_card' | 'ach';
 
@@ -198,16 +209,21 @@ export interface TransactionMethod {
 }
 
 /**
- * Transaction type resource.
+ * The category of a financial transaction, such as a payment or credit memo.
  */
 export interface TransactionType {
   /**
-   * Transaction ID.
+   * Transaction type ID.
    */
   id: string;
 
   /**
-   * Machine-readable code.
+   * Machine-readable code identifying the kind of transaction.
+   *
+   * - `payment`: money received from the customer.
+   * - `credit_memo`: a credit issued to the customer.
+   * - `adjustment`: a manual correction (see the transaction's `adjustment_type`).
+   * - `rebate`: a rebate granted to the customer.
    */
   code: 'payment' | 'credit_memo' | 'adjustment' | 'rebate';
 
@@ -222,59 +238,77 @@ export interface TransactionType {
   object: 'transaction_type';
 }
 
-export interface FinanceRetrieveAdjustmentTypesParams {
+export interface FinanceRetrieveTransactionTypesParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * 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;
 
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
-   */
-  include?: Array<'owner'>;
-
-  /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Maximum number of results to return in a single page.
    */
   limit?: number;
 
   /**
-   * Search query used to filter results.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
   q?: string;
 }
 
 export interface FinanceRetrieveTransactionMethodsParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * 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;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Maximum number of results to return in a single page.
    */
   limit?: number;
 
   /**
-   * Search query used to filter results.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
   q?: string;
 }
 
-export interface FinanceRetrieveTransactionTypesParams {
+export interface FinanceRetrieveAdjustmentTypesParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * 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;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
+   */
+  include?: Array<'owner'>;
+
+  /**
+   * Maximum number of results to return in a single page.
    */
   limit?: number;
 
   /**
-   * Search query used to filter results.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
   q?: string;
 }
@@ -289,9 +323,9 @@ export declare namespace Finance {
     type ListTransactionType as ListTransactionType,
     type TransactionMethod as TransactionMethod,
     type TransactionType as TransactionType,
-    type FinanceRetrieveAdjustmentTypesParams as FinanceRetrieveAdjustmentTypesParams,
-    type FinanceRetrieveTransactionMethodsParams as FinanceRetrieveTransactionMethodsParams,
     type FinanceRetrieveTransactionTypesParams as FinanceRetrieveTransactionTypesParams,
+    type FinanceRetrieveTransactionMethodsParams as FinanceRetrieveTransactionMethodsParams,
+    type FinanceRetrieveAdjustmentTypesParams as FinanceRetrieveAdjustmentTypesParams,
   };
 
   export {
@@ -300,9 +334,9 @@ export declare namespace Finance {
     type ListPaymentTerm as ListPaymentTerm,
     type UpdatePaymentTermRequest as UpdatePaymentTermRequest,
     type PaymentTermDeleteResponse as PaymentTermDeleteResponse,
-    type PaymentTermCreateParams as PaymentTermCreateParams,
+    type PaymentTermListParams as PaymentTermListParams,
     type PaymentTermRetrieveParams as PaymentTermRetrieveParams,
+    type PaymentTermCreateParams as PaymentTermCreateParams,
     type PaymentTermUpdateParams as PaymentTermUpdateParams,
-    type PaymentTermListParams as PaymentTermListParams,
   };
 }

package/src/resources/finance/index.ts

@@ -8,9 +8,9 @@ export {
   type ListTransactionType,
   type TransactionMethod,
   type TransactionType,
-  type FinanceRetrieveAdjustmentTypesParams,
-  type FinanceRetrieveTransactionMethodsParams,
   type FinanceRetrieveTransactionTypesParams,
+  type FinanceRetrieveTransactionMethodsParams,
+  type FinanceRetrieveAdjustmentTypesParams,
 } from './finance';
 export {
   PaymentTerms,
@@ -18,8 +18,8 @@ export {
   type ListPaymentTerm,
   type UpdatePaymentTermRequest,
   type PaymentTermDeleteResponse,
-  type PaymentTermCreateParams,
+  type PaymentTermListParams,
   type PaymentTermRetrieveParams,
+  type PaymentTermCreateParams,
   type PaymentTermUpdateParams,
-  type PaymentTermListParams,
 } from './payment-terms';

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

@@ -12,19 +12,22 @@ import { path } from '../../internal/utils/path';
  */
 export class PaymentTerms extends APIResource {
   /**
-   * Creates a payment term.
+   * Returns a paginated list of payment terms.
+   *
+   * The list includes both payment terms created by your account and Augno-provided
+   * system defaults.
    *
    * @example
    * ```ts
-   * const paymentTerm =
-   *   await client.finance.paymentTerms.create({
-   *     name: 'Net 30',
-   *   });
+   * const listPaymentTerm =
+   *   await client.finance.paymentTerms.list();
    * ```
    */
-  create(params: PaymentTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.PaymentTerm> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/finance/payment-terms', { query: { include }, body, ...options });
+  list(
+    query: PaymentTermListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListPaymentTerm> {
+    return this._client.get('/v1/finance/payment-terms', { query, ...options });
   }
 
   /**
@@ -47,7 +50,28 @@ export class PaymentTerms extends APIResource {
   }
 
   /**
-   * Partially updates a payment term. Default payment terms cannot be updated.
+   * Creates a payment term.
+   *
+   * The new term is owned by your account and starts with status `active`.
+   *
+   * @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 });
+  }
+
+  /**
+   * Partially updates a payment term.
+   *
+   * Only payment terms created by your account can be updated; system-owned default
+   * terms cannot be.
    *
    * @example
    * ```ts
@@ -72,24 +96,10 @@ export class PaymentTerms extends APIResource {
   }
 
   /**
-   * Returns a paginated list of payment terms. Includes both account-specific and
-   * system default payment terms.
+   * Deletes a payment term.
    *
-   * @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.
+   * Only payment terms created by your account can be deleted; system-owned default
+   * terms cannot be.
    *
    * @example
    * ```ts
@@ -109,7 +119,10 @@ export class PaymentTerms extends APIResource {
  */
 export interface CreatePaymentTermRequest {
   /**
-   * Display name (e.g. "Net 30").
+   * Display name (e.g. `Net 30`).
+   *
+   * Must be unique among the payment terms visible to your account, including system
+   * defaults.
    */
   name: string;
 }
@@ -139,68 +152,83 @@ export interface ListPaymentTerm {
  */
 export interface UpdatePaymentTermRequest {
   /**
-   * Display name.
+   * New display name for the payment term.
+   *
+   * Must be unique among the payment terms visible to your account, including system
+   * defaults.
    */
   name?: string;
 }
 
 export interface PaymentTermDeleteResponse {}
 
-export interface PaymentTermCreateParams {
+export interface PaymentTermListParams {
   /**
-   * Body param: Display name (e.g. "Net 30").
+   * 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'>;
-}
 
-export interface PaymentTermRetrieveParams {
   /**
-   * 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'>;
-}
+  limit?: number;
 
-export interface PaymentTermUpdateParams {
   /**
-   * 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'>;
+  q?: string;
+}
 
+export interface PaymentTermRetrieveParams {
   /**
-   * 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'>;
 }
 
-export interface PaymentTermListParams {
+export interface PaymentTermCreateParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Body param: Display name (e.g. `Net 30`).
+   *
+   * Must be unique among the payment terms visible to your account, including system
+   * defaults.
    */
-  cursor?: string;
+  name: string;
 
   /**
-   * 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'>;
+}
 
+export interface PaymentTermUpdateParams {
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  limit?: number;
+  include?: Array<'owner' | 'owner.account'>;
 
   /**
-   * Search query used to filter results.
+   * Body param: New display name for the payment term.
+   *
+   * Must be unique among the payment terms visible to your account, including system
+   * defaults.
    */
-  q?: string;
+  name?: string;
 }
 
 export declare namespace PaymentTerms {
@@ -209,9 +237,9 @@ export declare namespace PaymentTerms {
     type ListPaymentTerm as ListPaymentTerm,
     type UpdatePaymentTermRequest as UpdatePaymentTermRequest,
     type PaymentTermDeleteResponse as PaymentTermDeleteResponse,
-    type PaymentTermCreateParams as PaymentTermCreateParams,
+    type PaymentTermListParams as PaymentTermListParams,
     type PaymentTermRetrieveParams as PaymentTermRetrieveParams,
+    type PaymentTermCreateParams as PaymentTermCreateParams,
     type PaymentTermUpdateParams as PaymentTermUpdateParams,
-    type PaymentTermListParams as PaymentTermListParams,
   };
 }