pipedrive 24.2.0 → 26.0.0

package/dist/esm/versions/v1/api/webhooks-api.js

@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI } from '../base';
 export const WebhooksApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
+         * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
          * @summary Create a new Webhook
          * @param {AddWebhookRequest} [AddWebhookRequest]
 
@@ -139,7 +139,7 @@ export const WebhooksApiFp = function (configuration) {
     const localVarAxiosParamCreator = WebhooksApiAxiosParamCreator(configuration);
     return {
         /**
-         * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
+         * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
          * @summary Create a new Webhook
          * @param {AddWebhookRequest} [AddWebhookRequest]
 
@@ -186,7 +186,7 @@ export const WebhooksApiFactory = function (configuration, basePath, axios) {
     const localVarFp = WebhooksApiFp(configuration);
     return {
         /**
-         * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
+         * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
          * @summary Create a new Webhook
          * @param {WebhooksApiAddWebhookRequest} requestParameters Request parameters.
 
@@ -224,7 +224,7 @@ export const WebhooksApiFactory = function (configuration, basePath, axios) {
  */
 export class WebhooksApi extends BaseAPI {
     /**
-     * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
+     * Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
      * @summary Create a new Webhook
      * @param {WebhooksApiAddWebhookRequest} requestParameters Request parameters.
 

package/dist/esm/versions/v1/base.d.ts

@@ -10,8 +10,7 @@
  * Do not edit the class manually.
  */
 import type { Configuration } from './configuration';
-import type { AxiosError, AxiosResponse, AxiosRequestConfig, InternalAxiosRequestConfig } from 'axios';
-import axios from 'axios';
+import type { AxiosError, AxiosResponse, AxiosRequestConfig, InternalAxiosRequestConfig, AxiosInstance } from 'axios';
 export declare const BASE_PATH: string;
 /**
  *
@@ -43,7 +42,7 @@ export declare const errorInterceptor: (error: AxiosError) => Promise<never>;
 export declare class BaseAPI {
     protected configuration: Configuration | undefined;
     protected basePath: string;
-    protected axios: axios.AxiosInstance;
+    protected axios: AxiosInstance;
     constructor(configuration: Configuration);
 }
 /**

package/dist/esm/versions/v1/configuration.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import axios from "axios";
+import { AxiosResponse } from "axios";
 export type TokenResponse = {
     access_token: string;
     refresh_token: string;
@@ -54,7 +54,7 @@ export declare class OAuth2Configuration {
         * Revoke Refresh Token aka marking an app uninstalled or revoke the Access Token.
         * @param {String} tokenTypeHint values can be: 'access_token' or 'refresh_token'.
     */
-    revokeToken(tokenTypeHint?: 'access_token' | 'refresh_token'): Promise<axios.AxiosResponse<any, any>>;
+    revokeToken(tokenTypeHint?: 'access_token' | 'refresh_token'): Promise<AxiosResponse<any, any>>;
     private validateParam;
 }
 export interface ConfigurationParameters {

package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts

@@ -21,23 +21,28 @@ export interface AddNoteRequestAllOf {
     */
     'content': string;
     /**
-    * The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id`) is specified.
+    * The ID of the lead the note will be attached to. This property is required unless one of (`deal_id/person_id/org_id/project_id`) is specified.
     * @type {string}
     */
     'lead_id'?: string;
     /**
-    * The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id`) is specified.
+    * The ID of the deal the note will be attached to. This property is required unless one of (`lead_id/person_id/org_id/project_id`) is specified.
     * @type {number}
     */
     'deal_id'?: number;
     /**
-    * The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified.
+    * The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id/project_id`) is specified.
     * @type {number}
     */
     'person_id'?: number;
     /**
-    * The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified.
+    * The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id/project_id`) is specified.
     * @type {number}
     */
     'org_id'?: number;
+    /**
+    * The ID of the project the note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id/org_id`) is specified.
+    * @type {number}
+    */
+    'project_id'?: number;
 }

package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts

@@ -45,6 +45,11 @@ export interface AddNoteRequestAllOf1 {
     * @type {number}
     */
     'pinned_to_person_flag'?: AddNoteRequestAllOf1PinnedToPersonFlagConst;
+    /**
+    *
+    * @type {number}
+    */
+    'pinned_to_project_flag'?: AddNoteRequestAllOf1PinnedToProjectFlagConst;
 }
 export declare const AddNoteRequestAllOf1PinnedToLeadFlagConst: {
     readonly NUMBER_0: 0;
@@ -66,3 +71,8 @@ export declare const AddNoteRequestAllOf1PinnedToPersonFlagConst: {
     readonly NUMBER_1: 1;
 };
 export type AddNoteRequestAllOf1PinnedToPersonFlagConst = typeof AddNoteRequestAllOf1PinnedToPersonFlagConst[keyof typeof AddNoteRequestAllOf1PinnedToPersonFlagConst];
+export declare const AddNoteRequestAllOf1PinnedToProjectFlagConst: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+};
+export type AddNoteRequestAllOf1PinnedToProjectFlagConst = typeof AddNoteRequestAllOf1PinnedToProjectFlagConst[keyof typeof AddNoteRequestAllOf1PinnedToProjectFlagConst];

package/dist/esm/versions/v1/models/add-note-request-all-of1.js

@@ -27,3 +27,7 @@ export const AddNoteRequestAllOf1PinnedToPersonFlagConst = {
     NUMBER_0: 0,
     NUMBER_1: 1
 };
+export const AddNoteRequestAllOf1PinnedToProjectFlagConst = {
+    NUMBER_0: 0,
+    NUMBER_1: 1
+};

package/dist/esm/versions/v1/models/add-webhook-request.d.ts

@@ -46,23 +46,22 @@ export interface AddWebhookRequest {
     */
     'http_auth_password'?: string;
     /**
-    * The webhook\'s version. NB! Webhooks v2 will become the default from March 17th, 2025. See <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details.
+    * The webhook\'s version. NB! Webhooks v2 is the default from March 17th, 2025. See <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details.
     * @type {string}
     */
     'version'?: AddWebhookRequestVersionConst;
 }
 export declare const AddWebhookRequestEventActionConst: {
-    readonly added: "added";
-    readonly updated: "updated";
-    readonly merged: "merged";
-    readonly deleted: "deleted";
+    readonly create: "create";
+    readonly change: "change";
+    readonly delete: "delete";
     readonly Star: "*";
 };
 export type AddWebhookRequestEventActionConst = typeof AddWebhookRequestEventActionConst[keyof typeof AddWebhookRequestEventActionConst];
 export declare const AddWebhookRequestEventObjectConst: {
     readonly activity: "activity";
-    readonly activityType: "activityType";
     readonly deal: "deal";
+    readonly lead: "lead";
     readonly note: "note";
     readonly organization: "organization";
     readonly person: "person";

package/dist/esm/versions/v1/models/add-webhook-request.js

@@ -12,16 +12,15 @@
  * Do not edit the class manually.
  */
 export const AddWebhookRequestEventActionConst = {
-    added: 'added',
-    updated: 'updated',
-    merged: 'merged',
-    deleted: 'deleted',
+    create: 'create',
+    change: 'change',
+    delete: 'delete',
     Star: '*'
 };
 export const AddWebhookRequestEventObjectConst = {
     activity: 'activity',
-    activityType: 'activityType',
     deal: 'deal',
+    lead: 'lead',
     note: 'note',
     organization: 'organization',
     person: 'person',

package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts

@@ -84,4 +84,9 @@ export interface GetDealSearchResponseAllOfDataItemsInnerItem {
     * @type {Array<string>}
     */
     'notes'?: Array<string>;
+    /**
+    * A flag indicating whether the deal is archived or not
+    * @type {boolean}
+    */
+    'is_archived'?: boolean;
 }

package/dist/esm/versions/v1/models/index.d.ts

@@ -619,6 +619,7 @@ export * from './note';
 export * from './note-deal';
 export * from './note-organization';
 export * from './note-person';
+export * from './note-project';
 export * from './note-request';
 export * from './note-request-all-of';
 export * from './note-request-all-of1';

package/dist/esm/versions/v1/models/index.js

@@ -619,6 +619,7 @@ export * from './note';
 export * from './note-deal';
 export * from './note-organization';
 export * from './note-person';
+export * from './note-project';
 export * from './note-request';
 export * from './note-request-all-of';
 export * from './note-request-all-of1';

package/dist/esm/versions/v1/models/note-project.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+* The project the note is attached to
+* @export
+* @interface NoteProject
+*/
+export interface NoteProject {
+    /**
+    * The title of the project the note is attached to
+    * @type {string}
+    */
+    'title'?: string;
+}

package/dist/esm/versions/v1/models/note-project.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/versions/v1/models/note-request-all-of1.d.ts

@@ -35,4 +35,9 @@ export interface NoteRequestAllOf1 {
     * @type {number}
     */
     'org_id'?: number;
+    /**
+    * The ID of the project the note will be attached to
+    * @type {number}
+    */
+    'project_id'?: number;
 }

package/dist/esm/versions/v1/models/note.d.ts

@@ -12,6 +12,7 @@
 import { NoteDeal } from './note-deal';
 import { NoteOrganization } from './note-organization';
 import { NotePerson } from './note-person';
+import { NoteProject } from './note-project';
 import { NoteUser } from './note-user';
 /**
 *
@@ -80,6 +81,16 @@ export interface Note {
     */
     'person_id'?: number;
     /**
+    * The ID of the project the note is attached to
+    * @type {number}
+    */
+    'project_id'?: number;
+    /**
+    *
+    * @type {NoteProject}
+    */
+    'project'?: NoteProject;
+    /**
     * If true, the results are filtered by note to deal pinning state
     * @type {boolean}
     */
@@ -95,6 +106,11 @@ export interface Note {
     */
     'pinned_to_person_flag'?: boolean;
     /**
+    * If true, the results are filtered by note to project pinning state
+    * @type {boolean}
+    */
+    'pinned_to_project_flag'?: boolean;
+    /**
     * The last updated date and time of the note
     * @type {string}
     */

package/dist/esm/versions/v1/models/user-access.d.ts

@@ -32,10 +32,11 @@ export interface UserAccess {
     'permission_set_id'?: string;
 }
 export declare const UserAccessAppConst: {
+    readonly global: "global";
     readonly sales: "sales";
-    readonly projects: "projects";
     readonly campaigns: "campaigns";
-    readonly global: "global";
+    readonly projects: "projects";
     readonly account_settings: "account_settings";
+    readonly partnership: "partnership";
 };
 export type UserAccessAppConst = typeof UserAccessAppConst[keyof typeof UserAccessAppConst];

package/dist/esm/versions/v1/models/user-access.js

@@ -12,9 +12,10 @@
  * Do not edit the class manually.
  */
 export const UserAccessAppConst = {
+    global: 'global',
     sales: 'sales',
-    projects: 'projects',
     campaigns: 'campaigns',
-    global: 'global',
-    account_settings: 'account_settings'
+    projects: 'projects',
+    account_settings: 'account_settings',
+    partnership: 'partnership'
 };

package/dist/esm/versions/v1/models/user-access1.d.ts

@@ -32,10 +32,11 @@ export interface UserAccess1 {
     'permission_set_id'?: string;
 }
 export declare const UserAccess1AppConst: {
+    readonly global: "global";
     readonly sales: "sales";
-    readonly projects: "projects";
     readonly campaigns: "campaigns";
-    readonly global: "global";
+    readonly projects: "projects";
     readonly account_settings: "account_settings";
+    readonly partnership: "partnership";
 };
 export type UserAccess1AppConst = typeof UserAccess1AppConst[keyof typeof UserAccess1AppConst];

package/dist/esm/versions/v1/models/user-access1.js

@@ -12,9 +12,10 @@
  * Do not edit the class manually.
  */
 export const UserAccess1AppConst = {
+    global: 'global',
     sales: 'sales',
-    projects: 'projects',
     campaigns: 'campaigns',
-    global: 'global',
-    account_settings: 'account_settings'
+    projects: 'projects',
+    account_settings: 'account_settings',
+    partnership: 'partnership'
 };

package/dist/esm/versions/v2/api/activities-api.d.ts

@@ -47,9 +47,10 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
      * @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
      * @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
+     * @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
      * @param {string} [updated_since] If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-     * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
+     * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
      * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
      * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
@@ -57,7 +58,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
 
      * @throws {RequiredError}
      */
-    getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific activity.
      * @summary Get details of an activity
@@ -108,9 +109,10 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
      * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
      * @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
      * @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
+     * @param {boolean} [done] If supplied, only activities with specified \&#39;done\&#39; flag value are returned
      * @param {string} [updated_since] If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-     * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
+     * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
      * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
      * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
      * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
@@ -118,7 +120,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
 
      * @throws {RequiredError}
      */
-    getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
+    getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
     /**
      * Returns the details of a specific activity.
      * @summary Get details of an activity
@@ -258,6 +260,12 @@ export interface ActivitiesApiGetActivitiesRequest {
      * @memberof ActivitiesApiGetActivities
      */
     readonly org_id?: number;
+    /**
+     * If supplied, only activities with specified \&#39;done\&#39; flag value are returned
+     * @type {boolean}
+     * @memberof ActivitiesApiGetActivities
+     */
+    readonly done?: boolean;
     /**
      * If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @type {string}
@@ -271,11 +279,11 @@ export interface ActivitiesApiGetActivitiesRequest {
      */
     readonly updated_until?: string;
     /**
-     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
-     * @type {'id' | 'update_time' | 'add_time'}
+     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;, &#x60;due_date&#x60;.
+     * @type {'id' | 'update_time' | 'add_time' | 'due_date'}
      * @memberof ActivitiesApiGetActivities
      */
-    readonly sort_by?: 'id' | 'update_time' | 'add_time';
+    readonly sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date';
     /**
      * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
      * @type {'asc' | 'desc'}

package/dist/esm/versions/v2/api/activities-api.js

@@ -109,9 +109,10 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
          * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
          * @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
          * @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
+         * @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
          * @param {string} [updated_since] If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
          * @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-         * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
+         * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
          * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
@@ -119,7 +120,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
 
          * @throws {RequiredError}
          */
-        getActivities: (filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+        getActivities: (filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, done, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/activities`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -156,6 +157,9 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
             if (org_id !== undefined) {
                 localVarQueryParameter['org_id'] = org_id;
             }
+            if (done !== undefined) {
+                localVarQueryParameter['done'] = done;
+            }
             if (updated_since !== undefined) {
                 localVarQueryParameter['updated_since'] = updated_since;
             }
@@ -305,9 +309,10 @@ export const ActivitiesApiFp = function (configuration) {
          * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
          * @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
          * @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
+         * @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
          * @param {string} [updated_since] If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
          * @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
-         * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
+         * @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
          * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
          * @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
          * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
@@ -315,9 +320,9 @@ export const ActivitiesApiFp = function (configuration) {
 
          * @throws {RequiredError}
          */
-        getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) {
+        getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, done, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, done, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -386,7 +391,7 @@ export const ActivitiesApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getActivities(requestParameters = {}) {
-            return localVarFp.getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+            return localVarFp.getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.done, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
         /**
          * Returns the details of a specific activity.
@@ -448,7 +453,7 @@ export class ActivitiesApi extends BaseAPI {
      * @memberof ActivitiesApi
      */
     getActivities(requestParameters = {}) {
-        return ActivitiesApiFp(this.configuration).getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+        return ActivitiesApiFp(this.configuration).getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.done, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Returns the details of a specific activity.