conductor-node 11.10.0 → 12.0.0-beta.1

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

@@ -0,0 +1,314 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class DateDrivenTerms extends APIResource {
+  /**
+   * Creates a new date-driven term.
+   */
+  create(params: DateDrivenTermCreateParams, options?: Core.RequestOptions): Core.APIPromise<DateDrivenTerm> {
+    const { conductorEndUserId, ...body } = params;
+    return this._client.post('/quickbooks-desktop/date-driven-terms', {
+      body,
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+
+  /**
+   * Retrieves a date-driven term by ID.
+   */
+  retrieve(
+    id: string,
+    params: DateDrivenTermRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DateDrivenTerm> {
+    const { conductorEndUserId } = params;
+    return this._client.get(`/quickbooks-desktop/date-driven-terms/${id}`, {
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+
+  /**
+   * 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.
+   */
+  list(
+    params: DateDrivenTermListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DateDrivenTermListResponse> {
+    const { conductorEndUserId, ...query } = params;
+    return this._client.get('/quickbooks-desktop/date-driven-terms', {
+      query,
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+}
+
+export interface DateDrivenTerm {
+  /**
+   * The unique identifier assigned by QuickBooks to this date-driven term. This ID
+   * is unique across all date-driven terms but not across different QuickBooks
+   * object types.
+   */
+  id: string;
+
+  /**
+   * The date and time when this date-driven term was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
+   * in QuickBooks.
+   */
+  createdAt: string;
+
+  /**
+   * The day of the month within which payment must be received to qualify for the
+   * discount specified by `discountPercentage`.
+   */
+  discountDayOfMonth: number | null;
+
+  /**
+   * The discount percentage applied to the payment if received on or before the
+   * specified `discountDayOfMonth`. The value is between 0 and 100.
+   */
+  discountPercentage: string | null;
+
+  /**
+   * The day of the month when full payment is due without discount.
+   */
+  dueDayOfMonth: number;
+
+  /**
+   * The number of days before `dueDayOfMonth` when an invoice or bill issued within
+   * this threshold is considered due the following month. For example, with
+   * `dueDayOfMonth` set to 15 and `gracePeriodDays` set to 2, an invoice issued on
+   * the 13th would be due on the 15th of the next month, while an invoice issued on
+   * the 12th would be due on the 15th of the current month.
+   */
+  gracePeriodDays: number | null;
+
+  /**
+   * Indicates whether this date-driven term is active. Inactive objects are
+   * typically hidden from views and reports in QuickBooks. Defaults to `true`.
+   */
+  isActive: boolean;
+
+  /**
+   * The case-insensitive unique name of this date-driven term, unique across all
+   * date-driven terms.
+   *
+   * **NOTE**: Date-driven terms do not have a `fullName` field because they are not
+   * hierarchical objects, which is why `name` is unique for them but not for objects
+   * that have parents.
+   */
+  name: string;
+
+  /**
+   * The type of object. This value is always `"qbd_date_driven_term"`.
+   */
+  objectType: 'qbd_date_driven_term';
+
+  /**
+   * The current QuickBooks-assigned revision number of this date-driven term 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 date and time when this date-driven term was last updated, in ISO 8601
+   * format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time
+   * zone in QuickBooks.
+   */
+  updatedAt: string;
+}
+
+export interface DateDrivenTermListResponse {
+  /**
+   * The array of date-driven terms.
+   */
+  data: Array<DateDrivenTerm>;
+
+  /**
+   * The type of object. This value is always `"list"`.
+   */
+  objectType: 'list';
+
+  /**
+   * The endpoint URL where this list can be accessed.
+   */
+  url: string;
+}
+
+export interface DateDrivenTermCreateParams {
+  /**
+   * Body param: The day of the month when full payment is due without discount.
+   */
+  dueDayOfMonth: number;
+
+  /**
+   * Body param: The case-insensitive unique name of this date-driven term, unique
+   * across all date-driven terms.
+   *
+   * **NOTE**: Date-driven terms do not have a `fullName` field because they are not
+   * hierarchical objects, which is why `name` is unique for them but not for objects
+   * that have parents.
+   *
+   * Maximum length: 31 characters.
+   */
+  name: string;
+
+  /**
+   * Header param: The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
+
+  /**
+   * Body param: The day of the month within which payment must be received to
+   * qualify for the discount specified by `discountPercentage`.
+   */
+  discountDayOfMonth?: number;
+
+  /**
+   * Body param: The discount percentage applied to the payment if received on or
+   * before the specified `discountDayOfMonth`. The value is between 0 and 100.
+   */
+  discountPercentage?: string;
+
+  /**
+   * Body param: The number of days before `dueDayOfMonth` when an invoice or bill
+   * issued within this threshold is considered due the following month. For example,
+   * with `dueDayOfMonth` set to 15 and `gracePeriodDays` set to 2, an invoice issued
+   * on the 13th would be due on the 15th of the next month, while an invoice issued
+   * on the 12th would be due on the 15th of the current month.
+   */
+  gracePeriodDays?: number;
+
+  /**
+   * Body param: Indicates whether this date-driven term is active. Inactive objects
+   * are typically hidden from views and reports in QuickBooks. Defaults to `true`.
+   */
+  isActive?: boolean;
+}
+
+export interface DateDrivenTermRetrieveParams {
+  /**
+   * The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
+}
+
+export interface DateDrivenTermListParams {
+  /**
+   * Header param: The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
+
+  /**
+   * Query param: Filter for specific date-driven terms 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
+   * date-driven terms. 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 date-driven terms
+   * without limit, unlike paginated endpoints which default to 150 records. This is
+   * acceptable because date-driven terms typically have low record counts.
+   */
+  limit?: number;
+
+  /**
+   * Query param: Filter for date-driven terms 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 date-driven terms 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 date-driven terms whose `name` is alphabetically greater
+   * than or equal to this value.
+   */
+  nameFrom?: string;
+
+  /**
+   * Query param: Filter for specific date-driven terms by their name(s),
+   * case-insensitive. Like `id`, `name` is a unique identifier for a date-driven
+   * term.
+   *
+   * **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.
+   */
+  names?: Array<string>;
+
+  /**
+   * Query param: Filter for date-driven terms 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 date-driven terms whose `name` is alphabetically less
+   * than or equal to this value.
+   */
+  nameTo?: string;
+
+  /**
+   * Query param: Filter for date-driven terms that are active, inactive, or both.
+   */
+  status?: 'active' | 'all' | 'inactive';
+
+  /**
+   * Query param: Filter for date-driven terms updated on or after this date and
+   * time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date
+   * (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.
+   */
+  updatedAfter?: string;
+
+  /**
+   * Query param: Filter for date-driven terms updated on or before this date and
+   * time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date
+   * (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.
+   */
+  updatedBefore?: string;
+}
+
+export declare namespace DateDrivenTerms {
+  export {
+    type DateDrivenTerm as DateDrivenTerm,
+    type DateDrivenTermListResponse as DateDrivenTermListResponse,
+    type DateDrivenTermCreateParams as DateDrivenTermCreateParams,
+    type DateDrivenTermRetrieveParams as DateDrivenTermRetrieveParams,
+    type DateDrivenTermListParams as DateDrivenTermListParams,
+  };
+}