pipedrive 13.0.11 → 13.1.2

package/dist/api/PipelinesApi.js

@@ -58,7 +58,7 @@ var PipelinesApi = /*#__PURE__*/function () {
   }
   /**
    * Add a new pipeline
-   * Adds a new pipeline
+   * Adds a new pipeline.
    * @param {Object} opts Optional parameters
    * @param {module:model/Pipeline} opts.pipeline 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddNewPipeline} and HTTP response
@@ -96,7 +96,7 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Add a new pipeline
-     * Adds a new pipeline
+     * Adds a new pipeline.
      * @param {Object} opts Optional parameters
      * @param {module:model/Pipeline} opts.pipeline 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddNewPipeline}
@@ -112,7 +112,7 @@ var PipelinesApi = /*#__PURE__*/function () {
     /**
      * Delete a pipeline
      * Marks a pipeline as deleted.
-     * @param {Number} id ID of the pipeline
+     * @param {Number} id The ID of the pipeline
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePipelineResponse200} and HTTP response
      */
 
@@ -155,7 +155,7 @@ var PipelinesApi = /*#__PURE__*/function () {
     /**
      * Delete a pipeline
      * Marks a pipeline as deleted.
-     * @param {Number} id ID of the pipeline
+     * @param {Number} id The ID of the pipeline
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePipelineResponse200}
      */
 
@@ -169,9 +169,9 @@ var PipelinesApi = /*#__PURE__*/function () {
     /**
      * Get one pipeline
      * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
-     * @param {Number} id ID of the pipeline
+     * @param {Number} id The ID of the pipeline
      * @param {Object} opts Optional parameters
-     * @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
+     * @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetOnePipeline} and HTTP response
      */
 
@@ -216,9 +216,9 @@ var PipelinesApi = /*#__PURE__*/function () {
     /**
      * Get one pipeline
      * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
-     * @param {Number} id ID of the pipeline
+     * @param {Number} id The ID of the pipeline
      * @param {Object} opts Optional parameters
-     * @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
+     * @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetOnePipeline}
      */
 
@@ -231,12 +231,12 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get deals conversion rates in pipeline
-     * Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.
-     * @param {Number} id ID of the pipeline
-     * @param {Date} startDate Start of the period. Date in format of YYYY-MM-DD.
-     * @param {Date} endDate End of the period. Date in format of YYYY-MM-DD.
+     * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
+     * @param {Number} id The ID of the pipeline
+     * @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
+     * @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.userId ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
+     * @param {Number} opts.userId The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDealsConversionRatesInPipeline} and HTTP response
      */
 
@@ -292,12 +292,12 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get deals conversion rates in pipeline
-     * Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.
-     * @param {Number} id ID of the pipeline
-     * @param {Date} startDate Start of the period. Date in format of YYYY-MM-DD.
-     * @param {Date} endDate End of the period. Date in format of YYYY-MM-DD.
+     * Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
+     * @param {Number} id The ID of the pipeline
+     * @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
+     * @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.userId ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
+     * @param {Number} opts.userId The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDealsConversionRatesInPipeline}
      */
 
@@ -310,17 +310,17 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get deals in a pipeline
-     * Lists deals in a specific pipeline across all its stages
-     * @param {Number} id ID of the pipeline
+     * Lists deals in a specific pipeline across all its stages.
+     * @param {Number} id The ID of the pipeline
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned.
+     * @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
      * @param {Number} opts.userId If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
-     * @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned.
-     * @param {Number} opts.stageId If supplied, only deals within the given stage will be returned.
+     * @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
+     * @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
-     * @param {module:model/NumberBoolean} opts.getSummary Whether to include summary of the pipeline in the `additional_data` or not.
-     * @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
+     * @param {module:model/NumberBoolean} opts.getSummary Whether to include a summary of the pipeline in the `additional_data` or not
+     * @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStageDeals} and HTTP response
      */
 
@@ -371,17 +371,17 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get deals in a pipeline
-     * Lists deals in a specific pipeline across all its stages
-     * @param {Number} id ID of the pipeline
+     * Lists deals in a specific pipeline across all its stages.
+     * @param {Number} id The ID of the pipeline
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned.
+     * @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
      * @param {Number} opts.userId If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
-     * @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned.
-     * @param {Number} opts.stageId If supplied, only deals within the given stage will be returned.
+     * @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
+     * @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
-     * @param {module:model/NumberBoolean} opts.getSummary Whether to include summary of the pipeline in the `additional_data` or not.
-     * @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
+     * @param {module:model/NumberBoolean} opts.getSummary Whether to include a summary of the pipeline in the `additional_data` or not
+     * @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStageDeals}
      */
 
@@ -394,12 +394,12 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get deals movements in pipeline
-     * Returns statistics for deals movements for given time period.
-     * @param {Number} id ID of the pipeline
-     * @param {Date} startDate Start of the period. Date in format of YYYY-MM-DD.
-     * @param {Date} endDate End of the period. Date in format of YYYY-MM-DD.
+     * Returns statistics for deals movements for the given time period.
+     * @param {Number} id The ID of the pipeline
+     * @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
+     * @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.userId ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
+     * @param {Number} opts.userId The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDealsMovementsInPipeline} and HTTP response
      */
 
@@ -455,12 +455,12 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get deals movements in pipeline
-     * Returns statistics for deals movements for given time period.
-     * @param {Number} id ID of the pipeline
-     * @param {Date} startDate Start of the period. Date in format of YYYY-MM-DD.
-     * @param {Date} endDate End of the period. Date in format of YYYY-MM-DD.
+     * Returns statistics for deals movements for the given time period.
+     * @param {Number} id The ID of the pipeline
+     * @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
+     * @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.userId ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
+     * @param {Number} opts.userId The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDealsMovementsInPipeline}
      */
 
@@ -473,7 +473,7 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get all pipelines
-     * Returns data about all pipelines
+     * Returns data about all pipelines.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllPipelines} and HTTP response
      */
 
@@ -508,7 +508,7 @@ var PipelinesApi = /*#__PURE__*/function () {
     }
     /**
      * Get all pipelines
-     * Returns data about all pipelines
+     * Returns data about all pipelines.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllPipelines}
      */
 
@@ -520,9 +520,9 @@ var PipelinesApi = /*#__PURE__*/function () {
       });
     }
     /**
-     * Edit a pipeline
-     * Updates pipeline properties
-     * @param {Number} id ID of the pipeline
+     * Update a pipeline
+     * Updates the properties of a pipeline.
+     * @param {Number} id The ID of the pipeline
      * @param {Object} opts Optional parameters
      * @param {module:model/Pipeline} opts.pipeline 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EditPipeline} and HTTP response
@@ -565,9 +565,9 @@ var PipelinesApi = /*#__PURE__*/function () {
       return this.apiClient.callApi('/pipelines/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
     /**
-     * Edit a pipeline
-     * Updates pipeline properties
-     * @param {Number} id ID of the pipeline
+     * Update a pipeline
+     * Updates the properties of a pipeline.
+     * @param {Number} id The ID of the pipeline
      * @param {Object} opts Optional parameters
      * @param {module:model/Pipeline} opts.pipeline 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EditPipeline}

package/dist/api/ProductFieldsApi.js

@@ -52,7 +52,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
   }
   /**
    * Add a new product field
-   * Adds a new product field. For more information on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+   * Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
    * @param {Object} opts Optional parameters
    * @param {module:model/NewProductField} opts.newProductField 
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductFieldResponse} and HTTP response
@@ -64,6 +64,15 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     value: function addProductFieldWithHttpInfo(opts) {
       opts = opts || {};
       var postBody = opts['newProductField'];
+
+      if (opts['name'] === undefined || opts['name'] === null) {
+        throw new Error("Missing the required parameter 'name' when calling addProductField");
+      }
+
+      if (opts['field_type'] === undefined || opts['field_type'] === null) {
+        throw new Error("Missing the required parameter 'field_type' when calling addProductField");
+      }
+
       var pathParams = {};
       var queryParams = {};
       var headerParams = {};
@@ -90,7 +99,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Add a new product field
-     * Adds a new product field. For more information on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+     * Adds a new product field. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">adding a new custom field</a>.
      * @param {Object} opts Optional parameters
      * @param {module:model/NewProductField} opts.newProductField 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductFieldResponse}
@@ -105,8 +114,8 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a product field
-     * Marks a field as deleted. For more information on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
-     * @param {Number} id ID of the Product Field
+     * Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
+     * @param {Number} id The ID of the product field
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFieldResponse} and HTTP response
      */
 
@@ -148,8 +157,8 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Delete a product field
-     * Marks a field as deleted. For more information on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
-     * @param {Number} id ID of the Product Field
+     * Marks a product field as deleted. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">deleting a custom field</a>.
+     * @param {Number} id The ID of the product field
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFieldResponse}
      */
 
@@ -163,7 +172,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     /**
      * Delete multiple product fields in bulk
      * Marks multiple fields as deleted.
-     * @param {String} ids Comma-separated field IDs to delete
+     * @param {String} ids The comma-separated field IDs to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteMultipleProductFieldsResponse} and HTTP response
      */
 
@@ -206,7 +215,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     /**
      * Delete multiple product fields in bulk
      * Marks multiple fields as deleted.
-     * @param {String} ids Comma-separated field IDs to delete
+     * @param {String} ids The comma-separated field IDs to delete
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteMultipleProductFieldsResponse}
      */
 
@@ -220,7 +229,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     /**
      * Get one product field
      * Returns data about a specific product field.
-     * @param {Number} id ID of the Product Field
+     * @param {Number} id The ID of the product field
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductFieldResponse} and HTTP response
      */
 
@@ -263,7 +272,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     /**
      * Get one product field
      * Returns data about a specific product field.
-     * @param {Number} id ID of the Product Field
+     * @param {Number} id The ID of the product field
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductFieldResponse}
      */
 
@@ -276,7 +285,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Get all product fields
-     * Returns data about all product fields
+     * Returns data about all product fields.
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
@@ -317,7 +326,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Get all product fields
-     * Returns data about all product fields
+     * Returns data about all product fields.
      * @param {Object} opts Optional parameters
      * @param {Number} opts.start Pagination start (default to 0)
      * @param {Number} opts.limit Items shown per page
@@ -333,8 +342,8 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Update a product field
-     * Updates a product field. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
-     * @param {Number} id ID of the Product Field
+     * Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
+     * @param {Number} id The ID of the product field
      * @param {Object} opts Optional parameters
      * @param {module:model/BasicProductField} opts.basicProductField 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductFieldResponse} and HTTP response
@@ -350,6 +359,10 @@ var ProductFieldsApi = /*#__PURE__*/function () {
         throw new Error("Missing the required parameter 'id' when calling updateProductField");
       }
 
+      if (opts['name'] === undefined || opts['name'] === null) {
+        throw new Error("Missing the required parameter 'name' when calling updateProductField");
+      }
+
       var pathParams = {
         'id': id
       };
@@ -378,8 +391,8 @@ var ProductFieldsApi = /*#__PURE__*/function () {
     }
     /**
      * Update a product field
-     * Updates a product field. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
-     * @param {Number} id ID of the Product Field
+     * Updates a product field. For more information, see the tutorial for <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values</a>.
+     * @param {Number} id The ID of the product field
      * @param {Object} opts Optional parameters
      * @param {module:model/BasicProductField} opts.basicProductField 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductFieldResponse}