conductor-node 14.24.1 → 14.24.3

package/src/resources/qbd/employees.ts

@@ -917,6 +917,8 @@ export interface EmployeeCreateParams {
    * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
    * the account number may not be visible in the user interface, but it can still be
    * set and retrieved through the API.
+   *
+   * Maximum length: 99 characters.
    */
   accountNumber?: string;
 
@@ -968,17 +970,23 @@ export interface EmployeeCreateParams {
   /**
    * Body param: The employee's department. Found in the "employment job details"
    * section of the employee's record in QuickBooks.
+   *
+   * Maximum length: 31 characters.
    */
   department?: string;
 
   /**
    * Body param: A description of this employee. Found in the "employment job
    * details" section of the employee's record in QuickBooks.
+   *
+   * Maximum length: 64 characters.
    */
   description?: string;
 
   /**
    * Body param: A description of this employee's disability.
+   *
+   * Maximum length: 25 characters.
    */
   disabilityDescription?: string;
 
@@ -989,6 +997,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's email address.
+   *
+   * Maximum length: 1023 characters.
    */
   email?: string;
 
@@ -1068,6 +1078,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's job title.
+   *
+   * Maximum length: 41 characters.
    */
   jobTitle?: string;
 
@@ -1104,6 +1116,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: A note or comment about this employee.
+   *
+   * Maximum length: 4095 characters.
    */
   note?: string;
 
@@ -1128,6 +1142,8 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's pager PIN.
+   *
+   * Maximum length: 10 characters.
    */
   pagerPin?: string;
 
@@ -1141,12 +1157,16 @@ export interface EmployeeCreateParams {
   /**
    * Body param: The name to use when printing this employee from QuickBooks. By
    * default, this is the same as the `name` field.
+   *
+   * Maximum length: 41 characters.
    */
   printAs?: string;
 
   /**
    * Body param: The employee's formal salutation title that precedes their name,
    * such as "Mr.", "Ms.", or "Dr.".
+   *
+   * Maximum length: 15 characters.
    */
   salutation?: string;
 
@@ -1155,6 +1175,8 @@ export interface EmployeeCreateParams {
    * without dashes.
    *
    * **NOTE**: This field cannot be changed after the employee is created.
+   *
+   * Maximum length: 15 characters.
    */
   ssn?: string;
 
@@ -1168,6 +1190,9 @@ export interface EmployeeCreateParams {
    * Body param: The target bonus for this employee, represented as a decimal string.
    * Found in the "employment job details" section of the employee's record in
    * QuickBooks.
+   *
+   * Decimal string format: exactly 2 decimal places when cents are included and up
+   * to 13 digits before the decimal point (for example, "123.45").
    */
   targetBonus?: string;
 
@@ -1199,6 +1224,8 @@ export namespace EmployeeCreateParams {
   export interface AdditionalNote {
     /**
      * The text of this note.
+     *
+     * Maximum length: 4095 characters.
      */
     note: string;
   }
@@ -1341,11 +1368,15 @@ export namespace EmployeeCreateParams {
   export interface CustomContactField {
     /**
      * The name of the contact field (e.g., "old address", "secondary phone").
+     *
+     * Maximum length: 40 characters.
      */
     name: string;
 
     /**
      * The value of the contact field.
+     *
+     * Maximum length: 255 characters.
      */
     value: string;
   }
@@ -1372,11 +1403,15 @@ export namespace EmployeeCreateParams {
     export interface PrimaryContact {
       /**
        * The name of the contact field (e.g., "old address", "secondary phone").
+       *
+       * Maximum length: 40 characters.
        */
       name: string;
 
       /**
        * The value of the contact field.
+       *
+       * Maximum length: 255 characters.
        */
       value: string;
 
@@ -1402,11 +1437,15 @@ export namespace EmployeeCreateParams {
     export interface SecondaryContact {
       /**
        * The name of the contact field (e.g., "old address", "secondary phone").
+       *
+       * Maximum length: 40 characters.
        */
       name: string;
 
       /**
        * The value of the contact field.
+       *
+       * Maximum length: 255 characters.
        */
       value: string;
 
@@ -1621,6 +1660,8 @@ export interface EmployeeUpdateParams {
    * Note that if the "Use Account Numbers" preference is turned off in QuickBooks,
    * the account number may not be visible in the user interface, but it can still be
    * set and retrieved through the API.
+   *
+   * Maximum length: 99 characters.
    */
   accountNumber?: string;
 
@@ -1672,17 +1713,23 @@ export interface EmployeeUpdateParams {
   /**
    * Body param: The employee's department. Found in the "employment job details"
    * section of the employee's record in QuickBooks.
+   *
+   * Maximum length: 31 characters.
    */
   department?: string;
 
   /**
    * Body param: A description of this employee. Found in the "employment job
    * details" section of the employee's record in QuickBooks.
+   *
+   * Maximum length: 64 characters.
    */
   description?: string;
 
   /**
    * Body param: A description of this employee's disability.
+   *
+   * Maximum length: 25 characters.
    */
   disabilityDescription?: string;
 
@@ -1693,6 +1740,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's email address.
+   *
+   * Maximum length: 1023 characters.
    */
   email?: string;
 
@@ -1765,6 +1814,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's job title.
+   *
+   * Maximum length: 41 characters.
    */
   jobTitle?: string;
 
@@ -1801,6 +1852,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: A note or comment about this employee.
+   *
+   * Maximum length: 4095 characters.
    */
   note?: string;
 
@@ -1825,6 +1878,8 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's pager PIN.
+   *
+   * Maximum length: 10 characters.
    */
   pagerPin?: string;
 
@@ -1838,12 +1893,16 @@ export interface EmployeeUpdateParams {
   /**
    * Body param: The name to use when printing this employee from QuickBooks. By
    * default, this is the same as the `name` field.
+   *
+   * Maximum length: 41 characters.
    */
   printAs?: string;
 
   /**
    * Body param: The employee's formal salutation title that precedes their name,
    * such as "Mr.", "Ms.", or "Dr.".
+   *
+   * Maximum length: 15 characters.
    */
   salutation?: string;
 
@@ -1857,6 +1916,9 @@ export interface EmployeeUpdateParams {
    * Body param: The target bonus for this employee, represented as a decimal string.
    * Found in the "employment job details" section of the employee's record in
    * QuickBooks.
+   *
+   * Decimal string format: exactly 2 decimal places when cents are included and up
+   * to 13 digits before the decimal point (for example, "123.45").
    */
   targetBonus?: string;
 
@@ -1893,6 +1955,8 @@ export namespace EmployeeUpdateParams {
 
     /**
      * The text of this note.
+     *
+     * Maximum length: 4095 characters.
      */
     note: string;
   }
@@ -2035,11 +2099,15 @@ export namespace EmployeeUpdateParams {
   export interface CustomContactField {
     /**
      * The name of the contact field (e.g., "old address", "secondary phone").
+     *
+     * Maximum length: 40 characters.
      */
     name: string;
 
     /**
      * The value of the contact field.
+     *
+     * Maximum length: 255 characters.
      */
     value: string;
   }
@@ -2066,11 +2134,15 @@ export namespace EmployeeUpdateParams {
     export interface PrimaryContact {
       /**
        * The name of the contact field (e.g., "old address", "secondary phone").
+       *
+       * Maximum length: 40 characters.
        */
       name: string;
 
       /**
        * The value of the contact field.
+       *
+       * Maximum length: 255 characters.
        */
       value: string;
 
@@ -2096,11 +2168,15 @@ export namespace EmployeeUpdateParams {
     export interface SecondaryContact {
       /**
        * The name of the contact field (e.g., "old address", "secondary phone").
+       *
+       * Maximum length: 40 characters.
        */
       name: string;
 
       /**
        * The value of the contact field.
+       *
+       * Maximum length: 255 characters.
        */
       value: string;
 
@@ -2360,6 +2436,9 @@ export interface EmployeeListParams {
   /**
    * Query param: Filter for employees whose `name` is alphabetically greater than or
    * equal to this value.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameFrom?: string;
 
@@ -2387,6 +2466,9 @@ export interface EmployeeListParams {
   /**
    * Query param: Filter for employees whose `name` is alphabetically less than or
    * equal to this value.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameTo?: string;
 

package/src/resources/qbd/estimates.ts

@@ -769,7 +769,8 @@ export namespace Estimate {
 
       /**
        * The markup that will be passed on to the customer for this item on this estimate
-       * line. `amount = (quantity * rate) * (1 + markupRate)`
+       * line, represented as a decimal string.
+       * `amount = (quantity * rate) * (1 + markupRate)`
        */
       markupRate: string | null;
 
@@ -1133,7 +1134,8 @@ export namespace Estimate {
 
     /**
      * The markup that will be passed on to the customer for this item on this estimate
-     * line. `amount = (quantity * rate) * (1 + markupRate)`
+     * line, represented as a decimal string.
+     * `amount = (quantity * rate) * (1 + markupRate)`
      */
     markupRate: string | null;
 
@@ -1743,6 +1745,8 @@ export interface EstimateCreateParams {
   /**
    * Body param: A memo or note for this estimate that appears in reports, but not on
    * the estimate. Use `customerMessage` to add a note to this estimate.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -1754,6 +1758,8 @@ export interface EstimateCreateParams {
    * other standard QuickBooks fields. Unlike `otherCustomField1` and
    * `otherCustomField2`, which are line item fields, this exists at the transaction
    * level. Hidden by default in the QuickBooks UI.
+   *
+   * Maximum length: 29 characters.
    */
   otherCustomField?: string;
 
@@ -1840,6 +1846,8 @@ export namespace EstimateCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -1882,6 +1890,8 @@ export namespace EstimateCreateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -1938,6 +1948,8 @@ export namespace EstimateCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line group. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -1947,6 +1959,8 @@ export namespace EstimateCreateParams {
       /**
        * The name of the custom field, unique for the specified `ownerId`. For public
        * custom fields, this name is visible as a label in the QuickBooks UI.
+       *
+       * Maximum length: 31 characters.
        */
       name: string;
 
@@ -2002,6 +2016,8 @@ export namespace EstimateCreateParams {
 
     /**
      * A description of this estimate line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2027,7 +2043,11 @@ export namespace EstimateCreateParams {
 
     /**
      * The markup that will be passed on to the customer for this item on this estimate
-     * line. `amount = (quantity * rate) * (1 + markupRate)`
+     * line, represented as a decimal string.
+     * `amount = (quantity * rate) * (1 + markupRate)`
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     markupRate?: string;
 
@@ -2044,6 +2064,8 @@ export namespace EstimateCreateParams {
      * standard QuickBooks field that exists for all estimate lines for convenience.
      * Developers often use this field for tracking information that doesn't fit into
      * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField1?: string;
 
@@ -2054,6 +2076,8 @@ export namespace EstimateCreateParams {
      * convenience. Like `otherCustomField1`, developers often use this field for
      * tracking information that doesn't fit into other standard QuickBooks fields.
      * Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField2?: string;
 
@@ -2117,6 +2141,8 @@ export namespace EstimateCreateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2126,6 +2152,8 @@ export namespace EstimateCreateParams {
       /**
        * The name of the custom field, unique for the specified `ownerId`. For public
        * custom fields, this name is visible as a label in the QuickBooks UI.
+       *
+       * Maximum length: 31 characters.
        */
       name: string;
 
@@ -2161,6 +2189,8 @@ export namespace EstimateCreateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2203,6 +2233,8 @@ export namespace EstimateCreateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -2346,6 +2378,8 @@ export interface EstimateUpdateParams {
   /**
    * Body param: A memo or note for this estimate that appears in reports, but not on
    * the estimate. Use `customerMessage` to add a note to this estimate.
+   *
+   * Maximum length: 4095 characters.
    */
   memo?: string;
 
@@ -2357,6 +2391,8 @@ export interface EstimateUpdateParams {
    * other standard QuickBooks fields. Unlike `otherCustomField1` and
    * `otherCustomField2`, which are line item fields, this exists at the transaction
    * level. Hidden by default in the QuickBooks UI.
+   *
+   * Maximum length: 29 characters.
    */
   otherCustomField?: string;
 
@@ -2446,6 +2482,8 @@ export namespace EstimateUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2488,6 +2526,8 @@ export namespace EstimateUpdateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -2568,6 +2608,8 @@ export namespace EstimateUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line group. Must be
      * a valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2608,6 +2650,8 @@ export namespace EstimateUpdateParams {
 
       /**
        * A description of this estimate line.
+       *
+       * Maximum length: 4095 characters.
        */
       description?: string;
 
@@ -2633,7 +2677,11 @@ export namespace EstimateUpdateParams {
 
       /**
        * The markup that will be passed on to the customer for this item on this estimate
-       * line. `amount = (quantity * rate) * (1 + markupRate)`
+       * line, represented as a decimal string.
+       * `amount = (quantity * rate) * (1 + markupRate)`
+       *
+       * Decimal string format: up to 5 decimal places and up to 10 digits before the
+       * decimal point (for example, "123.45").
        */
       markupRate?: string;
 
@@ -2650,6 +2698,8 @@ export namespace EstimateUpdateParams {
        * standard QuickBooks field that exists for all estimate lines for convenience.
        * Developers often use this field for tracking information that doesn't fit into
        * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
+       *
+       * Maximum length: 29 characters.
        */
       otherCustomField1?: string;
 
@@ -2660,6 +2710,8 @@ export namespace EstimateUpdateParams {
        * convenience. Like `otherCustomField1`, developers often use this field for
        * tracking information that doesn't fit into other standard QuickBooks fields.
        * Hidden by default in the QuickBooks UI.
+       *
+       * Maximum length: 29 characters.
        */
       otherCustomField2?: string;
 
@@ -2732,6 +2784,8 @@ export namespace EstimateUpdateParams {
       /**
        * The unit-of-measure used for the `quantity` in this estimate line. Must be a
        * valid unit within the item's available units of measure.
+       *
+       * Maximum length: 31 characters.
        */
       unitOfMeasure?: string;
     }
@@ -2772,6 +2826,8 @@ export namespace EstimateUpdateParams {
 
     /**
      * A description of this estimate line.
+     *
+     * Maximum length: 4095 characters.
      */
     description?: string;
 
@@ -2797,7 +2853,11 @@ export namespace EstimateUpdateParams {
 
     /**
      * The markup that will be passed on to the customer for this item on this estimate
-     * line. `amount = (quantity * rate) * (1 + markupRate)`
+     * line, represented as a decimal string.
+     * `amount = (quantity * rate) * (1 + markupRate)`
+     *
+     * Decimal string format: up to 5 decimal places and up to 10 digits before the
+     * decimal point (for example, "123.45").
      */
     markupRate?: string;
 
@@ -2814,6 +2874,8 @@ export namespace EstimateUpdateParams {
      * standard QuickBooks field that exists for all estimate lines for convenience.
      * Developers often use this field for tracking information that doesn't fit into
      * other standard QuickBooks fields. Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField1?: string;
 
@@ -2824,6 +2886,8 @@ export namespace EstimateUpdateParams {
      * convenience. Like `otherCustomField1`, developers often use this field for
      * tracking information that doesn't fit into other standard QuickBooks fields.
      * Hidden by default in the QuickBooks UI.
+     *
+     * Maximum length: 29 characters.
      */
     otherCustomField2?: string;
 
@@ -2896,6 +2960,8 @@ export namespace EstimateUpdateParams {
     /**
      * The unit-of-measure used for the `quantity` in this estimate line. Must be a
      * valid unit within the item's available units of measure.
+     *
+     * Maximum length: 31 characters.
      */
     unitOfMeasure?: string;
   }
@@ -2913,6 +2979,8 @@ export namespace EstimateUpdateParams {
 
     /**
      * The country name of the address.
+     *
+     * Maximum length: 31 characters.
      */
     country?: string;
 
@@ -2955,6 +3023,8 @@ export namespace EstimateUpdateParams {
     /**
      * A note written at the bottom of the address in the form in which it appears,
      * such as the invoice form.
+     *
+     * Maximum length: 41 characters.
      */
     note?: string;
 
@@ -3039,6 +3109,9 @@ export interface EstimateListParams extends CursorPageParams {
    * this value. If omitted, the range will begin with the first number of the list.
    * Uses a numerical comparison for values that contain only digits; otherwise, uses
    * a lexicographical comparison.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `refNumberContains`,
+   * `refNumberStartsWith`, or `refNumberEndsWith`.
    */
   refNumberFrom?: string;
 
@@ -3068,6 +3141,9 @@ export interface EstimateListParams extends CursorPageParams {
    * this value. If omitted, the range will end with the last number of the list.
    * Uses a numerical comparison for values that contain only digits; otherwise, uses
    * a lexicographical comparison.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `refNumberContains`,
+   * `refNumberStartsWith`, or `refNumberEndsWith`.
    */
   refNumberTo?: string;