import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class Classes extends APIResource {
    /**
     * Creates a new class.
     *
     * @example
     * ```ts
     * const _class = await conductor.qbd.classes.create({
     *   name: 'Marketing',
     *   conductorEndUserId: 'end_usr_1234567abcdefg',
     * });
     * ```
     */
    create(params: ClassCreateParams, options?: RequestOptions): APIPromise<Class>;
    /**
     * Retrieves a class by ID.
     *
     * **IMPORTANT:** If you need to fetch multiple specific classes by ID, use the
     * list endpoint instead with the `ids` parameter. It accepts an array of IDs so
     * you can batch the request into a single call, which is significantly faster.
     *
     * @example
     * ```ts
     * const _class = await conductor.qbd.classes.retrieve(
     *   '80000001-1234567890',
     *   { conductorEndUserId: 'end_usr_1234567abcdefg' },
     * );
     * ```
     */
    retrieve(id: string, params: ClassRetrieveParams, options?: RequestOptions): APIPromise<Class>;
    /**
     * Updates an existing class.
     *
     * @example
     * ```ts
     * const _class = await conductor.qbd.classes.update(
     *   '80000001-1234567890',
     *   {
     *     revisionNumber: '1721172183',
     *     conductorEndUserId: 'end_usr_1234567abcdefg',
     *   },
     * );
     * ```
     */
    update(id: string, params: ClassUpdateParams, options?: RequestOptions): APIPromise<Class>;
    /**
     * Returns a list of classes.
     *
     * **NOTE:** QuickBooks Desktop does not support pagination for classes; hence,
     * there is no `cursor` parameter. Users typically have few classes.
     *
     * @example
     * ```ts
     * const classes = await conductor.qbd.classes.list({
     *   conductorEndUserId: 'end_usr_1234567abcdefg',
     * });
     * ```
     */
    list(params: ClassListParams, options?: RequestOptions): APIPromise<ClassListResponse>;
}
export interface Class {
    /**
     * The unique identifier assigned by QuickBooks to this class. This ID is unique
     * across all classes but not across different QuickBooks object types.
     */
    id: string;
    /**
     * The date and time when this class was created, in ISO 8601 format
     * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
     * timezone of the end-user's computer.
     */
    createdAt: string;
    /**
     * The case-insensitive fully-qualified unique name of this class, formed by
     * combining the names of its hierarchical parent objects with its own `name`,
     * separated by colons. For example, if a class is under "Department" and has the
     * `name` "Marketing", its `fullName` would be "Department:Marketing".
     *
     * **NOTE**: Unlike `name`, `fullName` is guaranteed to be unique across all class
     * objects. However, `fullName` can still be arbitrarily changed by the QuickBooks
     * user when they modify the underlying `name` field.
     */
    fullName: string;
    /**
     * Indicates whether this class is active. Inactive objects are typically hidden
     * from views and reports in QuickBooks. Defaults to `true`.
     */
    isActive: boolean;
    /**
     * The case-insensitive name of this class. Not guaranteed to be unique because it
     * does not include the names of its hierarchical parent objects like `fullName`
     * does. For example, two classes could both have the `name` "Marketing", but they
     * could have unique `fullName` values, such as "Department:Marketing" and
     * "Internal:Marketing".
     */
    name: string;
    /**
     * The type of object. This value is always `"qbd_class"`.
     */
    objectType: 'qbd_class';
    /**
     * The parent class one level above this one in the hierarchy. For example, if this
     * class has a `fullName` of "Department:Marketing", its parent has a `fullName` of
     * "Department". If this class is at the top level, this field will be `null`.
     */
    parent: Class.Parent | null;
    /**
     * The current QuickBooks-assigned revision number of this class object, which
     * changes each time the object is modified. When updating this object, you must
     * provide the most recent `revisionNumber` to ensure you're working with the
     * latest data; otherwise, the update will return an error.
     */
    revisionNumber: string;
    /**
     * The depth level of this class in the hierarchy. A top-level class has a
     * `sublevel` of 0; each subsequent sublevel increases this number by 1. For
     * example, a class with a `fullName` of "Department:Marketing" would have a
     * `sublevel` of 1.
     */
    sublevel: number;
    /**
     * The date and time when this class was last updated, in ISO 8601 format
     * (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
     * timezone of the end-user's computer.
     */
    updatedAt: string;
}
export declare namespace Class {
    /**
     * The parent class one level above this one in the hierarchy. For example, if this
     * class has a `fullName` of "Department:Marketing", its parent has a `fullName` of
     * "Department". If this class is at the top level, this field will be `null`.
     */
    interface Parent {
        /**
         * The unique identifier assigned by QuickBooks to this object. This ID is unique
         * across all objects of the same type, but not across different QuickBooks object
         * types.
         */
        id: string | null;
        /**
         * The fully-qualified unique name for this object, formed by combining the names
         * of its parent objects with its own `name`, separated by colons. Not
         * case-sensitive.
         */
        fullName: string | null;
    }
}
export interface ClassListResponse {
    /**
     * The array of classes.
     */
    data: Array<Class>;
    /**
     * The type of object. This value is always `"list"`.
     */
    objectType: 'list';
    /**
     * The endpoint URL where this list can be accessed.
     */
    url: string;
}
export interface ClassCreateParams {
    /**
     * Body param: The case-insensitive name of this class. Not guaranteed to be unique
     * because it does not include the names of its hierarchical parent objects like
     * `fullName` does. For example, two classes could both have the `name`
     * "Marketing", but they could have unique `fullName` values, such as
     * "Department:Marketing" and "Internal:Marketing".
     *
     * Maximum length: 31 characters.
     */
    name: string;
    /**
     * Header param: The ID of the End-User to receive this request.
     */
    conductorEndUserId: string;
    /**
     * Body param: Indicates whether this class is active. Inactive objects are
     * typically hidden from views and reports in QuickBooks. Defaults to `true`.
     */
    isActive?: boolean;
    /**
     * Body param: The parent class one level above this one in the hierarchy. For
     * example, if this class has a `fullName` of "Department:Marketing", its parent
     * has a `fullName` of "Department". If this class is at the top level, this field
     * will be `null`.
     */
    parentId?: string;
}
export interface ClassRetrieveParams {
    /**
     * The ID of the End-User to receive this request.
     */
    conductorEndUserId: string;
}
export interface ClassUpdateParams {
    /**
     * Body param: The current QuickBooks-assigned revision number of the class object
     * you are updating, which you can get by fetching the object first. Provide the
     * most recent `revisionNumber` to ensure you're working with the latest data;
     * otherwise, the update will return an error.
     */
    revisionNumber: string;
    /**
     * Header param: The ID of the End-User to receive this request.
     */
    conductorEndUserId: string;
    /**
     * Body param: Indicates whether this class is active. Inactive objects are
     * typically hidden from views and reports in QuickBooks. Defaults to `true`.
     */
    isActive?: boolean;
    /**
     * Body param: The case-insensitive name of this class. Not guaranteed to be unique
     * because it does not include the names of its hierarchical parent objects like
     * `fullName` does. For example, two classes could both have the `name`
     * "Marketing", but they could have unique `fullName` values, such as
     * "Department:Marketing" and "Internal:Marketing".
     *
     * Maximum length: 31 characters.
     */
    name?: string;
    /**
     * Body param: The parent class one level above this one in the hierarchy. For
     * example, if this class has a `fullName` of "Department:Marketing", its parent
     * has a `fullName` of "Department". If this class is at the top level, this field
     * will be `null`.
     */
    parentId?: string;
}
export interface ClassListParams {
    /**
     * Header param: The ID of the End-User to receive this request.
     */
    conductorEndUserId: string;
    /**
     * Query param: Filter for specific classes by their full-name(s),
     * case-insensitive. Like `id`, `fullName` is a unique identifier for a class,
     * formed by by combining the names of its parent objects with its own `name`,
     * separated by colons. For example, if a class is under "Department" and has the
     * `name` "Marketing", its `fullName` would be "Department:Marketing".
     *
     * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
     * query parameters for this request.
     *
     * **NOTE**: If any of the values you specify in this parameter are not found, the
     * request will return an error.
     */
    fullNames?: Array<string>;
    /**
     * Query param: Filter for specific classes by their QuickBooks-assigned unique
     * identifier(s).
     *
     * **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
     * query parameters for this request.
     *
     * **NOTE**: If any of the values you specify in this parameter are not found, the
     * request will return an error.
     */
    ids?: Array<string>;
    /**
     * Query param: The maximum number of objects to return.
     *
     * **IMPORTANT**: QuickBooks Desktop does not support cursor-based pagination for
     * classes. 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`).
     *
     * When this parameter is omitted, the endpoint returns all classes without limit,
     * unlike paginated endpoints which default to 150 records. This is acceptable
     * because classes typically have low record counts.
     */
    limit?: number;
    /**
     * Query param: Filter for classes whose `name` contains this substring,
     * case-insensitive.
     *
     * **NOTE**: If you use this parameter, you cannot also use `nameStartsWith` or
     * `nameEndsWith`.
     */
    nameContains?: string;
    /**
     * Query param: Filter for classes whose `name` ends with this substring,
     * case-insensitive.
     *
     * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
     * `nameStartsWith`.
     */
    nameEndsWith?: string;
    /**
     * Query param: Filter for classes whose `name` is alphabetically greater than or
     * equal to this value.
     */
    nameFrom?: string;
    /**
     * Query param: Filter for classes whose `name` starts with this substring,
     * case-insensitive.
     *
     * **NOTE**: If you use this parameter, you cannot also use `nameContains` or
     * `nameEndsWith`.
     */
    nameStartsWith?: string;
    /**
     * Query param: Filter for classes whose `name` is alphabetically less than or
     * equal to this value.
     */
    nameTo?: string;
    /**
     * Query param: Filter for classes that are active, inactive, or both.
     */
    status?: 'active' | 'all' | 'inactive';
    /**
     * Query param: Filter for classes updated on or after this date/time. Accepts the
     * following ISO 8601 formats:
     *
     * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
     *   **start of the specified day** in the local timezone of the end-user's
     *   computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
     * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
     *   interprets the timestamp in the local timezone of the end-user's computer.
     * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
     *   interprets the timestamp using the specified timezone.
     */
    updatedAfter?: string;
    /**
     * Query param: Filter for classes updated on or before this date/time. Accepts the
     * following ISO 8601 formats:
     *
     * - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
     *   **end of the specified day** in the local timezone of the end-user's computer
     *   (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
     * - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
     *   interprets the timestamp in the local timezone of the end-user's computer.
     * - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
     *   interprets the timestamp using the specified timezone.
     */
    updatedBefore?: string;
}
export declare namespace Classes {
    export { type Class as Class, type ClassListResponse as ClassListResponse, type ClassCreateParams as ClassCreateParams, type ClassRetrieveParams as ClassRetrieveParams, type ClassUpdateParams as ClassUpdateParams, type ClassListParams as ClassListParams, };
}
//# sourceMappingURL=classes.d.mts.map