conductor-node 14.24.2 → 14.24.4

package/src/resources/qbd/discount-items.ts

@@ -433,6 +433,8 @@ export interface DiscountItemCreateParams {
   /**
    * Body param: The discount item's description that will appear on sales forms that
    * include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -515,6 +517,8 @@ export namespace DiscountItemCreateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -562,6 +566,8 @@ export interface DiscountItemUpdateParams {
   /**
    * Body param: The discount item's description that will appear on sales forms that
    * include this item.
+   *
+   * Maximum length: 4095 characters.
    */
   description?: string;
 
@@ -655,6 +661,8 @@ export namespace DiscountItemUpdateParams {
 
     /**
      * The item's barcode value.
+     *
+     * Maximum length: 50 characters.
      */
     value?: string;
   }
@@ -719,8 +727,17 @@ export interface DiscountItemListParams extends CursorPageParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for discount items whose `name` is alphabetically greater
-   * than or equal to this value.
+   * Query param: Filter for discount items whose `fullName` sorts at or after this
+   * value (inclusive), compared case-insensitively in QuickBooks' sort order:
+   * punctuation first, then digits, then letters.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns discount items sorted by
+   * `fullName` in that order; without either, the order is not guaranteed. To page
+   * through discount items by name, see
+   * [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameFrom?: string;
 
@@ -734,8 +751,16 @@ export interface DiscountItemListParams extends CursorPageParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for discount items whose `name` is alphabetically less than
-   * or equal to this value.
+   * Query param: Filter for discount items whose `fullName` sorts at or before this
+   * value (inclusive), compared case-insensitively in QuickBooks' sort order:
+   * punctuation first, then digits, then letters. If you also set `nameFrom`, it
+   * must not sort after this value, or QuickBooks returns an error.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns discount items sorted by
+   * `fullName` in that order; without either, the order is not guaranteed.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameTo?: string;
 

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;
 
@@ -2329,13 +2405,12 @@ export interface EmployeeListParams {
    * Query param: The maximum number of objects to return.
    *
    * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
-   * employees. This parameter will limit the response size, but you cannot fetch
-   * subsequent results using a cursor. For pagination, use the name-range parameters
-   * instead (e.g., `nameFrom=A&nameTo=B`).
+   * employees, so this parameter only limits the response size. To page through
+   * employees by name, see
+   * [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
    *
    * When this parameter is omitted, the endpoint returns all employees without
-   * limit, unlike paginated endpoints which default to 150 records. This is
-   * acceptable because employees typically have low record counts.
+   * limit, unlike paginated endpoints which default to 150 records.
    */
   limit?: number;
 
@@ -2358,8 +2433,17 @@ export interface EmployeeListParams {
   nameEndsWith?: string;
 
   /**
-   * Query param: Filter for employees whose `name` is alphabetically greater than or
-   * equal to this value.
+   * Query param: Filter for employees whose `name` sorts at or after this value
+   * (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
+   * first, then digits, then letters.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns employees sorted by
+   * `name` in that order; without either, the order is not guaranteed. To page
+   * through employees by name, see
+   * [Paging by name](https://docs.conductor.is/api-ref/pagination#paging-by-name).
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameFrom?: string;
 
@@ -2385,8 +2469,16 @@ export interface EmployeeListParams {
   nameStartsWith?: string;
 
   /**
-   * Query param: Filter for employees whose `name` is alphabetically less than or
-   * equal to this value.
+   * Query param: Filter for employees whose `name` sorts at or before this value
+   * (inclusive), compared case-insensitively in QuickBooks' sort order: punctuation
+   * first, then digits, then letters. If you also set `nameFrom`, it must not sort
+   * after this value, or QuickBooks returns an error.
+   *
+   * When you set `nameFrom` or `nameTo`, QuickBooks returns employees sorted by
+   * `name` in that order; without either, the order is not guaranteed.
+   *
+   * **NOTE**: If you use this parameter, you cannot also use `nameContains`,
+   * `nameStartsWith`, or `nameEndsWith`.
    */
   nameTo?: string;