conductor-node 14.10.0 → 14.12.0

package/src/resources/qbd/credit-card-credits.ts

@@ -62,6 +62,10 @@ export class CreditCardCredits extends APIResource {
   /**
    * Updates an existing credit card credit.
    *
+   * **NOTE:** If you include `expenseLines`, `itemLines`, or `itemGroupLines`,
+   * QuickBooks Desktop replaces each included line list with the array you send, so
+   * include unchanged lines you want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const creditCardCredit =
@@ -1653,6 +1657,8 @@ export interface CreditCardCreditCreateParams {
    * value is not required to be unique and can be arbitrarily changed by the
    * QuickBooks user. When left blank in this create request, this field will be left
    * blank in QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -1682,6 +1688,9 @@ export namespace CreditCardCreditCreateParams {
 
     /**
      * The monetary amount of this expense line, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -1838,6 +1847,9 @@ export namespace CreditCardCreditCreateParams {
      * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
      * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
      * suggested `cost`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -1859,6 +1871,9 @@ export namespace CreditCardCreditCreateParams {
      * The cost of this item line, represented as a decimal string. If both `quantity`
      * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
      * `cost`.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     cost?: string;
 
@@ -2184,6 +2199,8 @@ export interface CreditCardCreditUpdateParams {
    * card credit, which can be used to identify the transaction in QuickBooks. This
    * value is not required to be unique and can be arbitrarily changed by the
    * QuickBooks user.
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -2227,6 +2244,9 @@ export namespace CreditCardCreditUpdateParams {
 
     /**
      * The monetary amount of this expense line, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2351,6 +2371,9 @@ export namespace CreditCardCreditUpdateParams {
        * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
        * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
        * suggested `cost`. This field cannot be cleared.
+       *
+       * Decimal string format: exactly 2 decimal places when cents are included and up
+       * to 13 digits before the decimal point (for example, "123.45").
        */
       amount?: string;
 
@@ -2372,6 +2395,9 @@ export namespace CreditCardCreditUpdateParams {
        * The cost of this item line, represented as a decimal string. If both `quantity`
        * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
        * `cost`.
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       cost?: string;
 
@@ -2491,6 +2517,9 @@ export namespace CreditCardCreditUpdateParams {
      * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
      * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
      * suggested `cost`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2512,6 +2541,9 @@ export namespace CreditCardCreditUpdateParams {
      * The cost of this item line, represented as a decimal string. If both `quantity`
      * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
      * `cost`.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     cost?: string;
 

package/src/resources/qbd/credit-card-refunds.ts

@@ -878,6 +878,8 @@ export interface CreditCardRefundCreateParams {
    * value is not required to be unique and can be arbitrarily changed by the
    * QuickBooks user. When left blank in this create request, this field will be left
    * blank in QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -894,6 +896,9 @@ export namespace CreditCardRefundCreateParams {
     /**
      * The monetary amount to refund from the linked credit transaction within this
      * credit transaction, represented as a decimal string.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     refundAmount: string;
 

package/src/resources/qbd/credit-memos.ts

@@ -57,6 +57,10 @@ export class CreditMemos extends APIResource {
   /**
    * Updates an existing credit memo.
    *
+   * **NOTE:** If you include `lines` or `lineGroups`, QuickBooks Desktop replaces
+   * each included line list with the array you send, so include unchanged lines you
+   * want to keep and use `id: "-1"` for new lines.
+   *
    * @example
    * ```ts
    * const creditMemo = await conductor.qbd.creditMemos.update(
@@ -1926,6 +1930,8 @@ export interface CreditMemoCreateParams {
    * not required to be unique and can be arbitrarily changed by the QuickBooks user.
    * When left blank in this create request, this field will be left blank in
    * QuickBooks (i.e., it does _not_ auto-increment).
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -1960,6 +1966,8 @@ export interface CreditMemoCreateParams {
    * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
    * for this field, which stands for "freight on board". This field is informational
    * and has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2144,6 +2152,9 @@ export namespace CreditMemoCreateParams {
      * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
      * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
      * `1` and the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -2238,6 +2249,9 @@ export namespace CreditMemoCreateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 
@@ -2538,6 +2552,8 @@ export interface CreditMemoUpdateParams {
    * Body param: The case-sensitive user-defined reference number for this credit
    * memo, which can be used to identify the transaction in QuickBooks. This value is
    * not required to be unique and can be arbitrarily changed by the QuickBooks user.
+   *
+   * Maximum length: 11 characters.
    */
   refNumber?: string;
 
@@ -2572,6 +2588,8 @@ export interface CreditMemoUpdateParams {
    * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
    * for this field, which stands for "freight on board". This field is informational
    * and has no accounting implications.
+   *
+   * Maximum length: 13 characters.
    */
   shipmentOrigin?: string;
 
@@ -2756,6 +2774,9 @@ export namespace CreditMemoUpdateParams {
        * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
        * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
        * `1` and the suggested `rate`. This field cannot be cleared.
+       *
+       * Decimal string format: exactly 2 decimal places when cents are included and up
+       * to 13 digits before the decimal point (for example, "123.45").
        */
       amount?: string;
 
@@ -2855,6 +2876,9 @@ export namespace CreditMemoUpdateParams {
        * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
        * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
        * decimal string. This field cannot be cleared.
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       rate?: string;
 
@@ -2912,6 +2936,9 @@ export namespace CreditMemoUpdateParams {
      * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
      * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
      * `1` and the suggested `rate`. This field cannot be cleared.
+     *
+     * Decimal string format: exactly 2 decimal places when cents are included and up
+     * to 13 digits before the decimal point (for example, "123.45").
      */
     amount?: string;
 
@@ -3011,6 +3038,9 @@ export namespace CreditMemoUpdateParams {
      * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
      * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
      * decimal string. This field cannot be cleared.
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     rate?: string;
 

package/src/resources/qbd/currencies.ts

@@ -79,9 +79,10 @@ export class Currencies extends APIResource {
   }
 
   /**
-   * Returns a list of currencies. NOTE: QuickBooks Desktop does not support
-   * pagination for currencies; hence, there is no `cursor` parameter. Users
-   * typically have few currencies.
+   * Returns a list of currencies.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for currencies; hence,
+   * there is no `cursor` parameter. Users typically have few currencies.
    *
    * @example
    * ```ts

package/src/resources/qbd/customer-types.ts

@@ -57,9 +57,10 @@ export class CustomerTypes extends APIResource {
   }
 
   /**
-   * Returns a list of customer types. NOTE: QuickBooks Desktop does not support
-   * pagination for customer types; hence, there is no `cursor` parameter. Users
-   * typically have few customer types.
+   * Returns a list of customer types.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for customer types;
+   * hence, there is no `cursor` parameter. Users typically have few customer types.
    *
    * @example
    * ```ts

package/src/resources/qbd/customers.ts

@@ -80,6 +80,7 @@ export class Customers extends APIResource {
    *
    * **IMPORTANT**: If this request times out or is slow, set
    * `excludeAlternateShippingAddresses=true` to significantly improve performance.
+   * Use the `cursor` parameter to paginate through the results.
    *
    * @example
    * ```ts
@@ -1123,6 +1124,8 @@ export interface CustomerCreateParams {
 
   /**
    * Body param: The customer's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -1210,6 +1213,8 @@ export interface CustomerCreateParams {
 
   /**
    * Body param: The customer's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -1309,6 +1314,8 @@ export interface CustomerCreateParams {
 
   /**
    * Body param: The customer's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 
@@ -1787,6 +1794,8 @@ export interface CustomerUpdateParams {
 
   /**
    * Body param: The customer's alternate telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   alternatePhone?: string;
 
@@ -1864,6 +1873,8 @@ export interface CustomerUpdateParams {
 
   /**
    * Body param: The customer's fax number.
+   *
+   * Maximum length: 21 characters.
    */
   fax?: string;
 
@@ -1963,6 +1974,8 @@ export interface CustomerUpdateParams {
 
   /**
    * Body param: The customer's primary telephone number.
+   *
+   * Maximum length: 21 characters.
    */
   phone?: string;
 

package/src/resources/qbd/date-driven-terms.ts

@@ -62,9 +62,11 @@ export class DateDrivenTerms extends APIResource {
   }
 
   /**
-   * Returns a list of date-driven terms. NOTE: QuickBooks Desktop does not support
-   * pagination for date-driven terms; hence, there is no `cursor` parameter. Users
-   * typically have few date-driven terms.
+   * Returns a list of date-driven terms.
+   *
+   * **NOTE:** QuickBooks Desktop does not support pagination for date-driven terms;
+   * hence, there is no `cursor` parameter. Users typically have few date-driven
+   * terms.
    *
    * @example
    * ```ts

package/src/resources/qbd/deleted-list-objects.ts

@@ -12,6 +12,10 @@ export class DeletedListObjects extends APIResource {
    * ordered by actual delete time (ascending). For deleted transactions (e.g.,
    * invoices, bills, estimates), see the deleted-transactions endpoint.
    *
+   * **NOTE:** QuickBooks Desktop does not support pagination for deleted
+   * list-objects; hence, there is no `cursor` parameter. Users typically have few
+   * deleted list-objects.
+   *
    * @example
    * ```ts
    * const deletedListObjects =

package/src/resources/qbd/deleted-transactions.ts

@@ -13,6 +13,10 @@ export class DeletedTransactions extends APIResource {
    * list-objects (e.g., customer, vendor, employee), see the deleted-list-objects
    * endpoint.
    *
+   * **NOTE:** QuickBooks Desktop does not support pagination for deleted
+   * transactions; hence, there is no `cursor` parameter. Users typically have few
+   * deleted transactions.
+   *
    * @example
    * ```ts
    * const deletedTransactions =