pipedrive 13.0.8 → 13.0.12

package/dist/api/FilesApi.js

@@ -54,14 +54,14 @@ var FilesApi = /*#__PURE__*/function () {
   }
   /**
    * Add file
-   * Lets you upload a file and associate it with Deal, Person, Organization, Activity or Product. For more information on how to add a file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
-   * @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries.
+   * Lets you upload a file and associate it with deal, person, organization, activity or product. For more information on how to add a file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+   * @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
    * @param {Object} opts Optional parameters
-   * @param {Number} opts.dealId ID of the deal to associate file(s) with
-   * @param {Number} opts.personId ID of the person to associate file(s) with
-   * @param {Number} opts.orgId ID of the organization to associate file(s) with
-   * @param {Number} opts.productId ID of the product to associate file(s) with
-   * @param {Number} opts.activityId ID of the activity to associate file(s) with
+   * @param {Number} opts.dealId The ID of the deal to associate file(s) with
+   * @param {Number} opts.personId The ID of the person to associate file(s) with
+   * @param {Number} opts.orgId The ID of the organization to associate file(s) with
+   * @param {Number} opts.productId The ID of the product to associate file(s) with
+   * @param {Number} opts.activityId The ID of the activity to associate file(s) with
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddFile} and HTTP response
    */
 
@@ -109,14 +109,14 @@ var FilesApi = /*#__PURE__*/function () {
     }
     /**
      * Add file
-     * Lets you upload a file and associate it with Deal, Person, Organization, Activity or Product. For more information on how to add a file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
-     * @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries.
+     * Lets you upload a file and associate it with deal, person, organization, activity or product. For more information on how to add a file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+     * @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.dealId ID of the deal to associate file(s) with
-     * @param {Number} opts.personId ID of the person to associate file(s) with
-     * @param {Number} opts.orgId ID of the organization to associate file(s) with
-     * @param {Number} opts.productId ID of the product to associate file(s) with
-     * @param {Number} opts.activityId ID of the activity to associate file(s) with
+     * @param {Number} opts.dealId The ID of the deal to associate file(s) with
+     * @param {Number} opts.personId The ID of the person to associate file(s) with
+     * @param {Number} opts.orgId The ID of the organization to associate file(s) with
+     * @param {Number} opts.productId The ID of the product to associate file(s) with
+     * @param {Number} opts.activityId The ID of the activity to associate file(s) with
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddFile}
      */
 
@@ -133,7 +133,7 @@ var FilesApi = /*#__PURE__*/function () {
      * @param {module:model/String} fileType The file type
      * @param {String} title The title of the file
      * @param {module:model/String} itemType The item type
-     * @param {Number} itemId ID of the item to associate the file with
+     * @param {Number} itemId The ID of the item to associate the file with
      * @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateRemoteFileAndLinkItToItem} and HTTP response
      */
@@ -204,7 +204,7 @@ var FilesApi = /*#__PURE__*/function () {
      * @param {module:model/String} fileType The file type
      * @param {String} title The title of the file
      * @param {module:model/String} itemType The item type
-     * @param {Number} itemId ID of the item to associate the file with
+     * @param {Number} itemId The ID of the item to associate the file with
      * @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateRemoteFileAndLinkItToItem}
      */
@@ -219,7 +219,7 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Delete a file
      * Marks a file as deleted.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteFile} and HTTP response
      */
 
@@ -262,7 +262,7 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Delete a file
      * Marks a file as deleted.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteFile}
      */
 
@@ -276,7 +276,7 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Download one file
      * Initializes a file download.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Blob} and HTTP response
      */
 
@@ -319,7 +319,7 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Download one file
      * Initializes a file download.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Blob}
      */
 
@@ -333,7 +333,7 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Get one file
      * Returns data about a specific file.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetOneFile} and HTTP response
      */
 
@@ -376,7 +376,7 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Get one file
      * Returns data about a specific file.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetOneFile}
      */
 
@@ -394,7 +394,7 @@ var FilesApi = /*#__PURE__*/function () {
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
      * @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
-     * @param {String} opts.sort Field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
+     * @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllFiles} and HTTP response
      */
 
@@ -439,7 +439,7 @@ var FilesApi = /*#__PURE__*/function () {
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
      * @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
-     * @param {String} opts.sort Field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
+     * @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllFiles}
      */
 
@@ -454,8 +454,8 @@ var FilesApi = /*#__PURE__*/function () {
      * Link a remote file to an item
      * Links an existing remote file (`googledrive`) to the item you supply. For more information on how to link a remote file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
      * @param {module:model/String} itemType The item type
-     * @param {Number} itemId ID of the item to associate the file with
-     * @param {String} remoteId The remote item id
+     * @param {Number} itemId The ID of the item to associate the file with
+     * @param {String} remoteId The remote item ID
      * @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LinkRemoteFileToItem} and HTTP response
      */
@@ -518,8 +518,8 @@ var FilesApi = /*#__PURE__*/function () {
      * Link a remote file to an item
      * Links an existing remote file (`googledrive`) to the item you supply. For more information on how to link a remote file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
      * @param {module:model/String} itemType The item type
-     * @param {Number} itemId ID of the item to associate the file with
-     * @param {String} remoteId The remote item id
+     * @param {Number} itemId The ID of the item to associate the file with
+     * @param {String} remoteId The remote item ID
      * @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LinkRemoteFileToItem}
      */
@@ -534,10 +534,10 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Update file details
      * Updates the properties of a file.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @param {Object} opts Optional parameters
-     * @param {String} opts.name Visible name of the file
-     * @param {String} opts.description Description of the file
+     * @param {String} opts.name The visible name of the file
+     * @param {String} opts.description The description of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateFile} and HTTP response
      */
 
@@ -583,10 +583,10 @@ var FilesApi = /*#__PURE__*/function () {
     /**
      * Update file details
      * Updates the properties of a file.
-     * @param {Number} id ID of the file
+     * @param {Number} id The ID of the file
      * @param {Object} opts Optional parameters
-     * @param {String} opts.name Visible name of the file
-     * @param {String} opts.description Description of the file
+     * @param {String} opts.name The visible name of the file
+     * @param {String} opts.description The description of the file
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateFile}
      */
 

package/dist/api/FiltersApi.js

@@ -165,7 +165,7 @@ var FiltersApi = /*#__PURE__*/function () {
     /**
      * Delete multiple filters in bulk
      * Marks multiple filters as deleted.
-     * @param {String} ids Comma-separated filter IDs to delete
+     * @param {String} ids The comma-separated filter IDs to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FiltersBulkDeleteResponse} and HTTP response
      */
 
@@ -208,7 +208,7 @@ var FiltersApi = /*#__PURE__*/function () {
     /**
      * Delete multiple filters in bulk
      * Marks multiple filters as deleted.
-     * @param {String} ids Comma-separated filter IDs to delete
+     * @param {String} ids The comma-separated filter IDs to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FiltersBulkDeleteResponse}
      */
 

package/dist/api/GlobalMessagesApi.js

@@ -42,8 +42,8 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
   }
   /**
    * Dismiss a global message
-   * Removes global message from being shown, if message is dismissible
-   * @param {Number} id ID of global message to be dismissed.
+   * Removes a global message from being shown if the message is dismissible.
+   * @param {Number} id The ID of the global message to be dismissed
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GlobalMessageDelete} and HTTP response
    */
 
@@ -86,8 +86,8 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
     }
     /**
      * Dismiss a global message
-     * Removes global message from being shown, if message is dismissible
-     * @param {Number} id ID of global message to be dismissed.
+     * Removes a global message from being shown if the message is dismissible.
+     * @param {Number} id The ID of the global message to be dismissed
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GlobalMessageDelete}
      */
 
@@ -100,9 +100,9 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
     }
     /**
      * Get global messages
-     * Returns data about global messages to display for the authorized user.
+     * Returns data about the global messages to display for the authorized user.
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.limit Number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
+     * @param {Number} opts.limit The number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GlobalMessageGet} and HTTP response
      */
 
@@ -139,9 +139,9 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
     }
     /**
      * Get global messages
-     * Returns data about global messages to display for the authorized user.
+     * Returns data about the global messages to display for the authorized user.
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.limit Number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
+     * @param {Number} opts.limit The number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GlobalMessageGet}
      */
 

package/dist/api/GoalsApi.js

@@ -101,8 +101,8 @@ var GoalsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete existing goal
-     * Marks goal as deleted.
-     * @param {String} id ID of the goal to be deleted.
+     * Marks a goal as deleted.
+     * @param {String} id The ID of the goal to be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteGoalResponse200} and HTTP response
      */
 
@@ -144,8 +144,8 @@ var GoalsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete existing goal
-     * Marks goal as deleted.
-     * @param {String} id ID of the goal to be deleted.
+     * Marks a goal as deleted.
+     * @param {String} id The ID of the goal to be deleted
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteGoalResponse200}
      */
 
@@ -158,10 +158,10 @@ var GoalsApi = /*#__PURE__*/function () {
     }
     /**
      * Get result of a goal
-     * Gets progress of a goal for specified period.
-     * @param {String} id ID of the goal that the results are looked for.
-     * @param {Date} periodStart Start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
-     * @param {Date} periodEnd End date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
+     * Gets the progress of a goal for the specified period.
+     * @param {String} id The ID of the goal that the results are looked for
+     * @param {Date} periodStart The start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
+     * @param {Date} periodEnd The end date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalResultResponse200} and HTTP response
      */
 
@@ -216,10 +216,10 @@ var GoalsApi = /*#__PURE__*/function () {
     }
     /**
      * Get result of a goal
-     * Gets progress of a goal for specified period.
-     * @param {String} id ID of the goal that the results are looked for.
-     * @param {Date} periodStart Start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
-     * @param {Date} periodEnd End date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
+     * Gets the progress of a goal for the specified period.
+     * @param {String} id The ID of the goal that the results are looked for
+     * @param {Date} periodStart The start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
+     * @param {Date} periodEnd The end date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalResultResponse200}
      */
 
@@ -234,19 +234,19 @@ var GoalsApi = /*#__PURE__*/function () {
      * Find goals
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
      * @param {Object} opts Optional parameters
-     * @param {module:model/String} opts.typeName Type of the goal. If provided, everyone's goals will be returned.
-     * @param {String} opts.title Title of the goal.
-     * @param {module:model/Boolean} opts.isActive Whether goal is active or not. (default to true)
-     * @param {Number} opts.assigneeId ID of the user who's goal to fetch. When omitted, only your goals will be returned.
-     * @param {module:model/String} opts.assigneeType Type of the goal's assignee. If provided, everyone's goals will be returned.
-     * @param {Number} opts.expectedOutcomeTarget Numeric value of the outcome. If provided, everyone's goals will be returned.
-     * @param {module:model/String} opts.expectedOutcomeTrackingMetric Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
-     * @param {Number} opts.expectedOutcomeCurrencyId Numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsPipelineId ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsStageId ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsActivityTypeId ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
-     * @param {Date} opts.periodStart Start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
-     * @param {Date} opts.periodEnd End date of the period for which to find goals. Date in format of YYYY-MM-DD.
+     * @param {module:model/String} opts.typeName The type of the goal. If provided, everyone's goals will be returned.
+     * @param {String} opts.title The title of the goal
+     * @param {module:model/Boolean} opts.isActive Whether the goal is active or not (default to true)
+     * @param {Number} opts.assigneeId The ID of the user who's goal to fetch. When omitted, only your goals will be returned.
+     * @param {module:model/String} opts.assigneeType The type of the goal's assignee. If provided, everyone's goals will be returned.
+     * @param {Number} opts.expectedOutcomeTarget The numeric value of the outcome. If provided, everyone's goals will be returned.
+     * @param {module:model/String} opts.expectedOutcomeTrackingMetric The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
+     * @param {Number} opts.expectedOutcomeCurrencyId The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
+     * @param {Number} opts.typeParamsPipelineId The ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
+     * @param {Number} opts.typeParamsStageId The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
+     * @param {Number} opts.typeParamsActivityTypeId The ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
+     * @param {Date} opts.periodStart The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
+     * @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalsResponse200} and HTTP response
      */
 
@@ -297,19 +297,19 @@ var GoalsApi = /*#__PURE__*/function () {
      * Find goals
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
      * @param {Object} opts Optional parameters
-     * @param {module:model/String} opts.typeName Type of the goal. If provided, everyone's goals will be returned.
-     * @param {String} opts.title Title of the goal.
-     * @param {module:model/Boolean} opts.isActive Whether goal is active or not. (default to true)
-     * @param {Number} opts.assigneeId ID of the user who's goal to fetch. When omitted, only your goals will be returned.
-     * @param {module:model/String} opts.assigneeType Type of the goal's assignee. If provided, everyone's goals will be returned.
-     * @param {Number} opts.expectedOutcomeTarget Numeric value of the outcome. If provided, everyone's goals will be returned.
-     * @param {module:model/String} opts.expectedOutcomeTrackingMetric Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
-     * @param {Number} opts.expectedOutcomeCurrencyId Numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsPipelineId ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsStageId ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
-     * @param {Number} opts.typeParamsActivityTypeId ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
-     * @param {Date} opts.periodStart Start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
-     * @param {Date} opts.periodEnd End date of the period for which to find goals. Date in format of YYYY-MM-DD.
+     * @param {module:model/String} opts.typeName The type of the goal. If provided, everyone's goals will be returned.
+     * @param {String} opts.title The title of the goal
+     * @param {module:model/Boolean} opts.isActive Whether the goal is active or not (default to true)
+     * @param {Number} opts.assigneeId The ID of the user who's goal to fetch. When omitted, only your goals will be returned.
+     * @param {module:model/String} opts.assigneeType The type of the goal's assignee. If provided, everyone's goals will be returned.
+     * @param {Number} opts.expectedOutcomeTarget The numeric value of the outcome. If provided, everyone's goals will be returned.
+     * @param {module:model/String} opts.expectedOutcomeTrackingMetric The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
+     * @param {Number} opts.expectedOutcomeCurrencyId The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
+     * @param {Number} opts.typeParamsPipelineId The ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
+     * @param {Number} opts.typeParamsStageId The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
+     * @param {Number} opts.typeParamsActivityTypeId The ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
+     * @param {Date} opts.periodStart The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
+     * @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalsResponse200}
      */
 
@@ -322,15 +322,15 @@ var GoalsApi = /*#__PURE__*/function () {
     }
     /**
      * Update existing goal
-     * Updates existing goal.
-     * @param {String} id ID of the goal to be updated.
+     * Updates an existing goal.
+     * @param {String} id The ID of the goal to be updated
      * @param {Object} opts Optional parameters
-     * @param {String} opts.title Title of the goal.
-     * @param {Object} opts.assignee Who is this goal assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
-     * @param {Object} opts.type Type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
-     * @param {Object} opts.expectedOutcome Expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
-     * @param {Object} opts.duration Date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
-     * @param {module:model/String} opts.interval Interval of the goal
+     * @param {String} opts.title The title of the goal
+     * @param {Object} opts.assignee Who this goal is assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
+     * @param {Object} opts.type The type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
+     * @param {Object} opts.expectedOutcome The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
+     * @param {Object} opts.duration The date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
+     * @param {module:model/String} opts.interval The interval of the goal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateGoalResponse200} and HTTP response
      */
 
@@ -379,15 +379,15 @@ var GoalsApi = /*#__PURE__*/function () {
     }
     /**
      * Update existing goal
-     * Updates existing goal.
-     * @param {String} id ID of the goal to be updated.
+     * Updates an existing goal.
+     * @param {String} id The ID of the goal to be updated
      * @param {Object} opts Optional parameters
-     * @param {String} opts.title Title of the goal.
-     * @param {Object} opts.assignee Who is this goal assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
-     * @param {Object} opts.type Type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
-     * @param {Object} opts.expectedOutcome Expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
-     * @param {Object} opts.duration Date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
-     * @param {module:model/String} opts.interval Interval of the goal
+     * @param {String} opts.title The title of the goal
+     * @param {Object} opts.assignee Who this goal is assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
+     * @param {Object} opts.type The type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
+     * @param {Object} opts.expectedOutcome The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
+     * @param {Object} opts.duration The date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
+     * @param {module:model/String} opts.interval The interval of the goal
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateGoalResponse200}
      */
 

package/dist/api/ItemSearchApi.js

@@ -46,7 +46,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
    * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
    * @param {Object} opts Optional parameters
    * @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
-   * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for Leads, the email, organization_name, person_name, and phone fields will return results only for Leads not linked to contacts. For searching Leads by Person or Organization values, please use `search_for_related_items`.
+   * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for Leads, the email, organization_name, person_name, and phone fields will return results only for Leads not linked to contacts. For searching Leads by Person or Organization values, please use `search_for_related_items`.
    * @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related Leads and 100 newest related Deals for each found Person and Organization and up to 100 newest related Persons for each found Organization.
    * @param {module:model/Boolean} opts.exactMatch When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
    * @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
@@ -105,7 +105,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
      * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
      * @param {Object} opts Optional parameters
      * @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
-     * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for Leads, the email, organization_name, person_name, and phone fields will return results only for Leads not linked to contacts. For searching Leads by Person or Organization values, please use `search_for_related_items`.
+     * @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for Leads, the email, organization_name, person_name, and phone fields will return results only for Leads not linked to contacts. For searching Leads by Person or Organization values, please use `search_for_related_items`.
      * @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related Leads and 100 newest related Deals for each found Person and Organization and up to 100 newest related Persons for each found Organization.
      * @param {module:model/Boolean} opts.exactMatch When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
      * @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
@@ -123,7 +123,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
     }
     /**
      * Perform a search using a specific field from an item type
-     * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (Deals, Persons, Organizations or Products).
+     * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (Deals, Leads, Persons, Organizations or Products).
      * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
      * @param {module:model/String} fieldType The type of the field to perform the search from
      * @param {String} fieldKey The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).
@@ -189,7 +189,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
     }
     /**
      * Perform a search using a specific field from an item type
-     * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (Deals, Persons, Organizations or Products).
+     * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (Deals, Leads, Persons, Organizations or Products).
      * @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
      * @param {module:model/String} fieldType The type of the field to perform the search from
      * @param {String} fieldKey The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).

package/dist/api/LeadLabelsApi.js

@@ -50,7 +50,7 @@ var LeadLabelsApi = /*#__PURE__*/function () {
   }
   /**
    * Add a lead label
-   * Creates a Lead Label
+   * Creates a lead label.
    * @param {Object} opts Optional parameters
    * @param {module:model/AddLeadLabelRequest} opts.addLeadLabelRequest 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateLeadLabelResponse200} and HTTP response
@@ -88,7 +88,7 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Add a lead label
-     * Creates a Lead Label
+     * Creates a lead label.
      * @param {Object} opts Optional parameters
      * @param {module:model/AddLeadLabelRequest} opts.addLeadLabelRequest 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateLeadLabelResponse200}
@@ -103,8 +103,8 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a lead label
-     * Deletes a specific Lead Label
-     * @param {String} id The ID of the Lead Label
+     * Deletes a specific lead label.
+     * @param {String} id The ID of the lead label
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeadIdResponse200} and HTTP response
      */
 
@@ -146,8 +146,8 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a lead label
-     * Deletes a specific Lead Label
-     * @param {String} id The ID of the Lead Label
+     * Deletes a specific lead label.
+     * @param {String} id The ID of the lead label
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeadIdResponse200}
      */
 
@@ -160,7 +160,7 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Get all lead labels
-     * Returns details of all Lead Labels. This endpoint does not support pagination and all Labels are always returned.
+     * Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLeadLabelsResponse200} and HTTP response
      */
 
@@ -195,7 +195,7 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Get all lead labels
-     * Returns details of all Lead Labels. This endpoint does not support pagination and all Labels are always returned.
+     * Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLeadLabelsResponse200}
      */
 
@@ -208,8 +208,8 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Update a lead label
-     * Updates one or more properties of a Lead Label. Only properties included in the request will be updated. 
-     * @param {String} id The ID of the Lead Label
+     * Updates one or more properties of a lead label. Only properties included in the request will be updated. 
+     * @param {String} id The ID of the lead label
      * @param {Object} opts Optional parameters
      * @param {module:model/UpdateLeadLabelRequest} opts.updateLeadLabelRequest 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateLeadLabelResponse200} and HTTP response
@@ -253,8 +253,8 @@ var LeadLabelsApi = /*#__PURE__*/function () {
     }
     /**
      * Update a lead label
-     * Updates one or more properties of a Lead Label. Only properties included in the request will be updated. 
-     * @param {String} id The ID of the Lead Label
+     * Updates one or more properties of a lead label. Only properties included in the request will be updated. 
+     * @param {String} id The ID of the lead label
      * @param {Object} opts Optional parameters
      * @param {module:model/UpdateLeadLabelRequest} opts.updateLeadLabelRequest 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateLeadLabelResponse200}

package/dist/api/LeadSourcesApi.js

@@ -40,7 +40,7 @@ var LeadSourcesApi = /*#__PURE__*/function () {
   }
   /**
    * Get all lead sources
-   * Returns all Lead Sources. Please note that the list of Lead Sources is fixed, it cannot be modified. All Leads created through the Public Pipedrive API will have a Lead Source `API` assigned. 
+   * Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Public Pipedrive API will have a lead source `API` assigned. 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLeadSourcesResponse200} and HTTP response
    */
 
@@ -76,7 +76,7 @@ var LeadSourcesApi = /*#__PURE__*/function () {
     }
     /**
      * Get all lead sources
-     * Returns all Lead Sources. Please note that the list of Lead Sources is fixed, it cannot be modified. All Leads created through the Public Pipedrive API will have a Lead Source `API` assigned. 
+     * Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Public Pipedrive API will have a lead source `API` assigned. 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLeadSourcesResponse200}
      */