pipedrive 32.2.0 → 33.0.0

package/dist/versions/v2/models/add-project-field-request-required-fields.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/versions/v2/models/add-project-field-request-ui-visibility.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+/**
+* UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.
+* @export
+* @interface AddProjectFieldRequestUiVisibility
+*/
+export interface AddProjectFieldRequestUiVisibility {
+    [key: string]: any | any;
+    /**
+    * Whether the field is shown in the add project modal. Default is false.
+    * @type {boolean}
+    */
+    'add_visible_flag'?: boolean;
+    /**
+    * Whether the field is shown in the project details view. Default is true.
+    * @type {boolean}
+    */
+    'details_visible_flag'?: boolean;
+}

package/dist/versions/v2/models/add-project-field-request-ui-visibility.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/versions/v2/models/add-project-field-request.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+import { AddDealFieldRequestOptionsInner } from './add-deal-field-request-options-inner';
+import { AddProjectFieldRequestImportantFields } from './add-project-field-request-important-fields';
+import { AddProjectFieldRequestRequiredFields } from './add-project-field-request-required-fields';
+import { AddProjectFieldRequestUiVisibility } from './add-project-field-request-ui-visibility';
+/**
+*
+* @export
+* @interface AddProjectFieldRequest
+*/
+export interface AddProjectFieldRequest {
+    /**
+    * Field name
+    * @type {string}
+    */
+    'field_name': string;
+    /**
+    * The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>
+    * @type {string}
+    */
+    'field_type': AddProjectFieldRequestFieldTypeConst;
+    /**
+    * Field options (required for enum and set field types)
+    * @type {Array<AddDealFieldRequestOptionsInner>}
+    */
+    'options'?: Array<AddDealFieldRequestOptionsInner>;
+    /**
+    *
+    * @type {AddProjectFieldRequestUiVisibility}
+    */
+    'ui_visibility'?: AddProjectFieldRequestUiVisibility;
+    /**
+    *
+    * @type {AddProjectFieldRequestImportantFields}
+    */
+    'important_fields'?: AddProjectFieldRequestImportantFields;
+    /**
+    *
+    * @type {AddProjectFieldRequestRequiredFields}
+    */
+    'required_fields'?: AddProjectFieldRequestRequiredFields;
+}
+export declare const AddProjectFieldRequestFieldTypeConst: {
+    readonly varchar: "varchar";
+    readonly text: "text";
+    readonly double: "double";
+    readonly phone: "phone";
+    readonly date: "date";
+    readonly daterange: "daterange";
+    readonly time: "time";
+    readonly timerange: "timerange";
+    readonly set: "set";
+    readonly enum: "enum";
+    readonly varchar_auto: "varchar_auto";
+    readonly address: "address";
+    readonly monetary: "monetary";
+    readonly org: "org";
+    readonly people: "people";
+    readonly user: "user";
+};
+export type AddProjectFieldRequestFieldTypeConst = typeof AddProjectFieldRequestFieldTypeConst[keyof typeof AddProjectFieldRequestFieldTypeConst];

package/dist/versions/v2/models/add-project-field-request.js

@@ -0,0 +1,34 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddProjectFieldRequestFieldTypeConst = void 0;
+exports.AddProjectFieldRequestFieldTypeConst = {
+    varchar: 'varchar',
+    text: 'text',
+    double: 'double',
+    phone: 'phone',
+    date: 'date',
+    daterange: 'daterange',
+    time: 'time',
+    timerange: 'timerange',
+    set: 'set',
+    enum: 'enum',
+    varchar_auto: 'varchar_auto',
+    address: 'address',
+    monetary: 'monetary',
+    org: 'org',
+    people: 'people',
+    user: 'user'
+};

package/dist/versions/v2/models/add-project-field200-response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+import { GetProjectFields200ResponseDataInner } from './get-project-fields200-response-data-inner';
+/**
+*
+* @export
+* @interface AddProjectField200Response
+*/
+export interface AddProjectField200Response {
+    /**
+    * Whether the request was successful
+    * @type {boolean}
+    */
+    'success'?: boolean;
+    /**
+    *
+    * @type {GetProjectFields200ResponseDataInner}
+    */
+    'data'?: GetProjectFields200ResponseDataInner;
+}

package/dist/versions/v2/models/add-project-field200-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/versions/v2/models/add-project-phase-request.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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
+* @interface AddProjectPhaseRequest
+*/
+export interface AddProjectPhaseRequest {
+    /**
+    * The name of the project phase
+    * @type {string}
+    */
+    'name': string;
+    /**
+    * The ID of the project board to add the phase to
+    * @type {number}
+    */
+    'board_id': number;
+    /**
+    * The order of the phase within its board. Must be between 1 and the total number of phases on the board + 1.
+    * @type {number}
+    */
+    'order_nr'?: number;
+}

package/dist/versions/v2/models/add-project-phase-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/versions/v2/models/add-project-request.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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
+* @interface AddProjectRequest
+*/
+export interface AddProjectRequest {
+    /**
+    * The title of the project
+    * @type {string}
+    */
+    'title': string;
+    /**
+    * The description of the project
+    * @type {string}
+    */
+    'description'?: string;
+    /**
+    * The status of the project
+    * @type {string}
+    */
+    'status'?: string;
+    /**
+    * The ID of the board this project is associated with
+    * @type {number}
+    */
+    'board_id'?: number;
+    /**
+    * The ID of the phase this project is associated with
+    * @type {number}
+    */
+    'phase_id'?: number;
+    /**
+    * The ID of the user who owns the project
+    * @type {number}
+    */
+    'owner_id'?: number;
+    /**
+    * The start date of the project. Format: YYYY-MM-DD
+    * @type {string}
+    */
+    'start_date'?: string;
+    /**
+    * The end date of the project. Format: YYYY-MM-DD
+    * @type {string}
+    */
+    'end_date'?: string;
+    /**
+    * An array of IDs of the deals this project is associated with
+    * @type {Array<number>}
+    */
+    'deal_ids'?: Array<number>;
+    /**
+    * An array of IDs of the persons this project is associated with
+    * @type {Array<number>}
+    */
+    'person_ids'?: Array<number>;
+    /**
+    * An array of IDs of the organizations this project is associated with
+    * @type {Array<number>}
+    */
+    'org_ids'?: Array<number>;
+    /**
+    * An array of IDs of the labels this project has
+    * @type {Array<number>}
+    */
+    'label_ids'?: Array<number>;
+    /**
+    * The ID of the template the project will be based on. Only used when creating a new project.
+    * @type {number}
+    */
+    'template_id'?: number;
+    /**
+    * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
+    * @type {{ [key: string]: any | undefined; }}
+    */
+    'custom_fields'?: {
+        [key: string]: any | undefined;
+    };
+}

package/dist/versions/v2/models/add-project-request.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/versions/v2/models/add-task-request.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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
+* @interface AddTaskRequest
+*/
+export interface AddTaskRequest {
+    /**
+    * The title of the task
+    * @type {string}
+    */
+    'title': string;
+    /**
+    * The ID of the project this task is associated with
+    * @type {number}
+    */
+    'project_id': number;
+    /**
+    * The ID of the parent task. Cannot be the ID of a task that is already a subtask.
+    * @type {number}
+    */
+    'parent_task_id'?: number | null;
+    /**
+    * The description of the task
+    * @type {string}
+    */
+    'description'?: string | null;
+    /**
+    * Whether the task is done or not. `0` = Not done, `1` = Done.
+    * @type {number}
+    */
+    'done'?: AddTaskRequestDoneConst;
+    /**
+    * Whether the task is a milestone or not. `0` = Not a milestone, `1` = Milestone.
+    * @type {number}
+    */
+    'milestone'?: AddTaskRequestMilestoneConst;
+    /**
+    * The due date of the task. Format: YYYY-MM-DD.
+    * @type {string}
+    */
+    'due_date'?: string | null;
+    /**
+    * The start date of the task. Format: YYYY-MM-DD.
+    * @type {string}
+    */
+    'start_date'?: string | null;
+    /**
+    * The ID of the user assigned to the task. When set, the `assignee_ids` field will be overwritten with this value.
+    * @type {number}
+    */
+    'assignee_id'?: number | null;
+    /**
+    * The IDs of users assigned to the task. When set, the `assignee_id` field will be set to the first value in this array, or `null` if empty.
+    * @type {Array<number>}
+    */
+    'assignee_ids'?: Array<number>;
+    /**
+    * The priority of the task
+    * @type {number}
+    */
+    'priority'?: number | null;
+}
+export declare const AddTaskRequestDoneConst: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+};
+export type AddTaskRequestDoneConst = typeof AddTaskRequestDoneConst[keyof typeof AddTaskRequestDoneConst];
+export declare const AddTaskRequestMilestoneConst: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+};
+export type AddTaskRequestMilestoneConst = typeof AddTaskRequestMilestoneConst[keyof typeof AddTaskRequestMilestoneConst];

package/dist/versions/v2/models/add-task-request.js

@@ -0,0 +1,24 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddTaskRequestMilestoneConst = exports.AddTaskRequestDoneConst = void 0;
+exports.AddTaskRequestDoneConst = {
+    NUMBER_0: 0,
+    NUMBER_1: 1
+};
+exports.AddTaskRequestMilestoneConst = {
+    NUMBER_0: 0,
+    NUMBER_1: 1
+};

package/dist/versions/v2/models/add-task-response.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+import { GetTasksResponseDataInner } from './get-tasks-response-data-inner';
+/**
+*
+* @export
+* @interface AddTaskResponse
+*/
+export interface AddTaskResponse {
+    /**
+    * If the response is successful or not
+    * @type {boolean}
+    */
+    'success'?: boolean;
+    /**
+    *
+    * @type {GetTasksResponseDataInner}
+    */
+    'data'?: GetTasksResponseDataInner;
+    /**
+    *
+    * @type {object}
+    */
+    'additional_data'?: object | null;
+}

package/dist/versions/v2/models/add-task-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/versions/v2/models/base-product-all-of.d.ts

@@ -16,17 +16,62 @@
 */
 export interface BaseProductAllOf {
     /**
-    * Only available in Growth and above plans  How often a customer is billed for access to a service or product
+    * The ID of the product
+    * @type {number}
+    */
+    'id'?: number;
+    /**
+    * The name of the product
+    * @type {string}
+    */
+    'name'?: string;
+    /**
+    * The product code
     * @type {string}
     */
-    'billing_frequency'?: BaseProductAllOfBillingFrequencyConst;
+    'code'?: string;
+    /**
+    * The unit in which this product is sold
+    * @type {string}
+    */
+    'unit'?: string;
+    /**
+    * The tax percentage
+    * @type {number}
+    */
+    'tax'?: number;
+    /**
+    * Whether this product will be marked as deleted or not
+    * @type {boolean}
+    */
+    'is_deleted'?: boolean;
+    /**
+    * Whether this product can be added to a deal or not
+    * @type {boolean}
+    */
+    'is_linkable'?: boolean;
+    /**
+    *
+    * @type {number}
+    */
+    'visible_to'?: BaseProductAllOfVisibleToConst;
+    /**
+    * Information about the Pipedrive user who owns the product
+    * @type {number}
+    */
+    'owner_id'?: number;
+    /**
+    * An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.
+    * @type {{ [key: string]: any | undefined; }}
+    */
+    'custom_fields'?: {
+        [key: string]: any | undefined;
+    };
 }
-export declare const BaseProductAllOfBillingFrequencyConst: {
-    readonly one_time: "one-time";
-    readonly annually: "annually";
-    readonly semi_annually: "semi-annually";
-    readonly quarterly: "quarterly";
-    readonly monthly: "monthly";
-    readonly weekly: "weekly";
+export declare const BaseProductAllOfVisibleToConst: {
+    readonly NUMBER_1: 1;
+    readonly NUMBER_3: 3;
+    readonly NUMBER_5: 5;
+    readonly NUMBER_7: 7;
 };
-export type BaseProductAllOfBillingFrequencyConst = typeof BaseProductAllOfBillingFrequencyConst[keyof typeof BaseProductAllOfBillingFrequencyConst];
+export type BaseProductAllOfVisibleToConst = typeof BaseProductAllOfVisibleToConst[keyof typeof BaseProductAllOfVisibleToConst];

package/dist/versions/v2/models/base-product-all-of.js

@@ -13,12 +13,10 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseProductAllOfBillingFrequencyConst = void 0;
-exports.BaseProductAllOfBillingFrequencyConst = {
-    one_time: 'one-time',
-    annually: 'annually',
-    semi_annually: 'semi-annually',
-    quarterly: 'quarterly',
-    monthly: 'monthly',
-    weekly: 'weekly'
+exports.BaseProductAllOfVisibleToConst = void 0;
+exports.BaseProductAllOfVisibleToConst = {
+    NUMBER_1: 1,
+    NUMBER_3: 3,
+    NUMBER_5: 5,
+    NUMBER_7: 7
 };

package/dist/versions/v2/models/base-product-all-of1.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.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
+* @interface BaseProductAllOf1
+*/
+export interface BaseProductAllOf1 {
+    /**
+    * Only available in Growth and above plans  How often a customer is billed for access to a service or product
+    * @type {string}
+    */
+    'billing_frequency'?: BaseProductAllOf1BillingFrequencyConst;
+}
+export declare const BaseProductAllOf1BillingFrequencyConst: {
+    readonly one_time: "one-time";
+    readonly annually: "annually";
+    readonly semi_annually: "semi-annually";
+    readonly quarterly: "quarterly";
+    readonly monthly: "monthly";
+    readonly weekly: "weekly";
+};
+export type BaseProductAllOf1BillingFrequencyConst = typeof BaseProductAllOf1BillingFrequencyConst[keyof typeof BaseProductAllOf1BillingFrequencyConst];