pipedrive 23.2.5 → 23.3.0

package/dist/model/GetNoteField.js

@@ -0,0 +1,218 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _GetFieldAllOf = _interopRequireDefault(require("./GetFieldAllOf"));
+var _InternalFieldType = _interopRequireDefault(require("./InternalFieldType"));
+var _NoteField = _interopRequireDefault(require("./NoteField"));
+var _NoteFieldOptions = _interopRequireDefault(require("./NoteFieldOptions"));
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The GetNoteField model module.
+ * @module model/GetNoteField
+ * @version 1.0.0
+ */
+var GetNoteField = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>GetNoteField</code>.
+   * @alias module:model/GetNoteField
+   * @implements module:model/NoteField
+   * @implements module:model/GetFieldAllOf
+   */
+  function GetNoteField() {
+    (0, _classCallCheck2["default"])(this, GetNoteField);
+    _NoteField["default"].initialize(this);
+    _GetFieldAllOf["default"].initialize(this);
+    GetNoteField.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  (0, _createClass2["default"])(GetNoteField, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>GetNoteField</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/GetNoteField} obj Optional instance to populate.
+     * @return {module:model/GetNoteField} The populated <code>GetNoteField</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new GetNoteField();
+        _NoteField["default"].constructFromObject(data, obj);
+        _GetFieldAllOf["default"].constructFromObject(data, obj);
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
+          delete data['id'];
+        }
+        if (data.hasOwnProperty('key')) {
+          obj['key'] = _ApiClient["default"].convertToType(data['key'], 'String');
+          delete data['key'];
+        }
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+          delete data['name'];
+        }
+        if (data.hasOwnProperty('field_type')) {
+          obj['field_type'] = _InternalFieldType["default"].constructFromObject(data['field_type']);
+          delete data['field_type'];
+        }
+        if (data.hasOwnProperty('active_flag')) {
+          obj['active_flag'] = _ApiClient["default"].convertToType(data['active_flag'], 'Boolean');
+          delete data['active_flag'];
+        }
+        if (data.hasOwnProperty('edit_flag')) {
+          obj['edit_flag'] = _ApiClient["default"].convertToType(data['edit_flag'], 'Boolean');
+          delete data['edit_flag'];
+        }
+        if (data.hasOwnProperty('bulk_edit_allowed')) {
+          obj['bulk_edit_allowed'] = _ApiClient["default"].convertToType(data['bulk_edit_allowed'], 'Boolean');
+          delete data['bulk_edit_allowed'];
+        }
+        if (data.hasOwnProperty('mandatory_flag')) {
+          obj['mandatory_flag'] = _ApiClient["default"].convertToType(data['mandatory_flag'], 'Boolean');
+          delete data['mandatory_flag'];
+        }
+        if (data.hasOwnProperty('options')) {
+          obj['options'] = _ApiClient["default"].convertToType(data['options'], [_NoteFieldOptions["default"]]);
+          delete data['options'];
+        }
+        if (Object.keys(data).length > 0) {
+          Object.assign(obj, data);
+        }
+      }
+      return obj;
+    }
+  }]);
+  return GetNoteField;
+}();
+/**
+ * The ID of the field
+ * @member {Number} id
+ */
+GetNoteField.prototype['id'] = undefined;
+
+/**
+ * The key of the field
+ * @member {String} key
+ */
+GetNoteField.prototype['key'] = undefined;
+
+/**
+ * The name of the field
+ * @member {String} name
+ */
+GetNoteField.prototype['name'] = undefined;
+
+/**
+ * @member {module:model/InternalFieldType} field_type
+ */
+GetNoteField.prototype['field_type'] = undefined;
+
+/**
+ * The active flag of the field
+ * @member {Boolean} active_flag
+ */
+GetNoteField.prototype['active_flag'] = undefined;
+
+/**
+ * The edit flag of the field
+ * @member {Boolean} edit_flag
+ */
+GetNoteField.prototype['edit_flag'] = undefined;
+
+/**
+ * Not used
+ * @member {Boolean} bulk_edit_allowed
+ */
+GetNoteField.prototype['bulk_edit_allowed'] = undefined;
+
+/**
+ * Whether or not the field is mandatory
+ * @member {Boolean} mandatory_flag
+ */
+GetNoteField.prototype['mandatory_flag'] = undefined;
+
+/**
+ * The options of the field. When there are no options, `null` is returned.
+ * @member {Array.<module:model/NoteFieldOptions>} options
+ */
+GetNoteField.prototype['options'] = undefined;
+
+// Implement NoteField interface:
+/**
+ * The ID of the field
+ * @member {Number} id
+ */
+_NoteField["default"].prototype['id'] = undefined;
+/**
+ * The key of the field
+ * @member {String} key
+ */
+_NoteField["default"].prototype['key'] = undefined;
+/**
+ * The name of the field
+ * @member {String} name
+ */
+_NoteField["default"].prototype['name'] = undefined;
+/**
+ * @member {module:model/FieldTypeAsString} field_type
+ */
+_NoteField["default"].prototype['field_type'] = undefined;
+/**
+ * The active flag of the field
+ * @member {Boolean} active_flag
+ */
+_NoteField["default"].prototype['active_flag'] = undefined;
+/**
+ * The edit flag of the field
+ * @member {Boolean} edit_flag
+ */
+_NoteField["default"].prototype['edit_flag'] = undefined;
+/**
+ * Not used
+ * @member {Boolean} bulk_edit_allowed
+ */
+_NoteField["default"].prototype['bulk_edit_allowed'] = undefined;
+/**
+ * Whether or not the field is mandatory
+ * @member {Boolean} mandatory_flag
+ */
+_NoteField["default"].prototype['mandatory_flag'] = undefined;
+/**
+ * The options of the field. When there are no options, `null` is returned.
+ * @member {Array.<module:model/NoteFieldOptions>} options
+ */
+_NoteField["default"].prototype['options'] = undefined;
+// Implement GetFieldAllOf interface:
+/**
+ * @member {module:model/InternalFieldType} field_type
+ */
+_GetFieldAllOf["default"].prototype['field_type'] = undefined;
+var _default = GetNoteField;
+exports["default"] = _default;

package/dist/model/GetProductField.js

@@ -0,0 +1,373 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _GetFieldAllOf = _interopRequireDefault(require("./GetFieldAllOf"));
+var _InternalFieldType = _interopRequireDefault(require("./InternalFieldType"));
+var _ProductField = _interopRequireDefault(require("./ProductField"));
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The GetProductField model module.
+ * @module model/GetProductField
+ * @version 1.0.0
+ */
+var GetProductField = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>GetProductField</code>.
+   * @alias module:model/GetProductField
+   * @implements module:model/ProductField
+   * @implements module:model/GetFieldAllOf
+   * @param name {String} The name of the field
+   * @param fieldType {module:model/InternalFieldType} 
+   */
+  function GetProductField(name, fieldType) {
+    (0, _classCallCheck2["default"])(this, GetProductField);
+    _ProductField["default"].initialize(this, name, fieldType);
+    _GetFieldAllOf["default"].initialize(this);
+    GetProductField.initialize(this, name, fieldType);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  (0, _createClass2["default"])(GetProductField, null, [{
+    key: "initialize",
+    value: function initialize(obj, name, fieldType) {
+      obj['name'] = name;
+      obj['field_type'] = fieldType;
+    }
+
+    /**
+     * Constructs a <code>GetProductField</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/GetProductField} obj Optional instance to populate.
+     * @return {module:model/GetProductField} The populated <code>GetProductField</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new GetProductField();
+        _ProductField["default"].constructFromObject(data, obj);
+        _GetFieldAllOf["default"].constructFromObject(data, obj);
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+          delete data['name'];
+        }
+        if (data.hasOwnProperty('options')) {
+          obj['options'] = _ApiClient["default"].convertToType(data['options'], [Object]);
+          delete data['options'];
+        }
+        if (data.hasOwnProperty('field_type')) {
+          obj['field_type'] = _InternalFieldType["default"].constructFromObject(data['field_type']);
+          delete data['field_type'];
+        }
+        if (data.hasOwnProperty('id')) {
+          obj['id'] = _ApiClient["default"].convertToType(data['id'], 'Number');
+          delete data['id'];
+        }
+        if (data.hasOwnProperty('key')) {
+          obj['key'] = _ApiClient["default"].convertToType(data['key'], 'String');
+          delete data['key'];
+        }
+        if (data.hasOwnProperty('order_nr')) {
+          obj['order_nr'] = _ApiClient["default"].convertToType(data['order_nr'], 'Number');
+          delete data['order_nr'];
+        }
+        if (data.hasOwnProperty('add_time')) {
+          obj['add_time'] = _ApiClient["default"].convertToType(data['add_time'], 'String');
+          delete data['add_time'];
+        }
+        if (data.hasOwnProperty('update_time')) {
+          obj['update_time'] = _ApiClient["default"].convertToType(data['update_time'], 'String');
+          delete data['update_time'];
+        }
+        if (data.hasOwnProperty('last_updated_by_user_id')) {
+          obj['last_updated_by_user_id'] = _ApiClient["default"].convertToType(data['last_updated_by_user_id'], 'Number');
+          delete data['last_updated_by_user_id'];
+        }
+        if (data.hasOwnProperty('created_by_user_id')) {
+          obj['created_by_user_id'] = _ApiClient["default"].convertToType(data['created_by_user_id'], 'Number');
+          delete data['created_by_user_id'];
+        }
+        if (data.hasOwnProperty('active_flag')) {
+          obj['active_flag'] = _ApiClient["default"].convertToType(data['active_flag'], 'Boolean');
+          delete data['active_flag'];
+        }
+        if (data.hasOwnProperty('edit_flag')) {
+          obj['edit_flag'] = _ApiClient["default"].convertToType(data['edit_flag'], 'Boolean');
+          delete data['edit_flag'];
+        }
+        if (data.hasOwnProperty('add_visible_flag')) {
+          obj['add_visible_flag'] = _ApiClient["default"].convertToType(data['add_visible_flag'], 'Boolean');
+          delete data['add_visible_flag'];
+        }
+        if (data.hasOwnProperty('important_flag')) {
+          obj['important_flag'] = _ApiClient["default"].convertToType(data['important_flag'], 'Boolean');
+          delete data['important_flag'];
+        }
+        if (data.hasOwnProperty('bulk_edit_allowed')) {
+          obj['bulk_edit_allowed'] = _ApiClient["default"].convertToType(data['bulk_edit_allowed'], 'Boolean');
+          delete data['bulk_edit_allowed'];
+        }
+        if (data.hasOwnProperty('searchable_flag')) {
+          obj['searchable_flag'] = _ApiClient["default"].convertToType(data['searchable_flag'], 'Boolean');
+          delete data['searchable_flag'];
+        }
+        if (data.hasOwnProperty('filtering_allowed')) {
+          obj['filtering_allowed'] = _ApiClient["default"].convertToType(data['filtering_allowed'], 'Boolean');
+          delete data['filtering_allowed'];
+        }
+        if (data.hasOwnProperty('sortable_flag')) {
+          obj['sortable_flag'] = _ApiClient["default"].convertToType(data['sortable_flag'], 'Boolean');
+          delete data['sortable_flag'];
+        }
+        if (data.hasOwnProperty('mandatory_flag')) {
+          obj['mandatory_flag'] = _ApiClient["default"].convertToType(data['mandatory_flag'], 'Boolean');
+          delete data['mandatory_flag'];
+        }
+        if (Object.keys(data).length > 0) {
+          Object.assign(obj, data);
+        }
+      }
+      return obj;
+    }
+  }]);
+  return GetProductField;
+}();
+/**
+ * The name of the field
+ * @member {String} name
+ */
+GetProductField.prototype['name'] = undefined;
+
+/**
+ * When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`
+ * @member {Array.<Object>} options
+ */
+GetProductField.prototype['options'] = undefined;
+
+/**
+ * @member {module:model/InternalFieldType} field_type
+ */
+GetProductField.prototype['field_type'] = undefined;
+
+/**
+ * The ID of the product field
+ * @member {Number} id
+ */
+GetProductField.prototype['id'] = undefined;
+
+/**
+ * The key of the product field
+ * @member {String} key
+ */
+GetProductField.prototype['key'] = undefined;
+
+/**
+ * The position (index) of the product field in the detail view
+ * @member {Number} order_nr
+ */
+GetProductField.prototype['order_nr'] = undefined;
+
+/**
+ * The product field creation time. Format: YYYY-MM-DD HH:MM:SS
+ * @member {String} add_time
+ */
+GetProductField.prototype['add_time'] = undefined;
+
+/**
+ * The product field last update time. Format: YYYY-MM-DD HH:MM:SS
+ * @member {String} update_time
+ */
+GetProductField.prototype['update_time'] = undefined;
+
+/**
+ * The ID of the last user to update the product field
+ * @member {Number} last_updated_by_user_id
+ */
+GetProductField.prototype['last_updated_by_user_id'] = undefined;
+
+/**
+ * The ID of the user who created the product field
+ * @member {Number} created_by_user_id
+ */
+GetProductField.prototype['created_by_user_id'] = undefined;
+
+/**
+ * Whether or not the product field is currently active
+ * @member {Boolean} active_flag
+ */
+GetProductField.prototype['active_flag'] = undefined;
+
+/**
+ * Whether or not the product field name and metadata is editable
+ * @member {Boolean} edit_flag
+ */
+GetProductField.prototype['edit_flag'] = undefined;
+
+/**
+ * Whether or not the product field is visible in the Add Product Modal
+ * @member {Boolean} add_visible_flag
+ */
+GetProductField.prototype['add_visible_flag'] = undefined;
+
+/**
+ * Whether or not the product field is marked as important
+ * @member {Boolean} important_flag
+ */
+GetProductField.prototype['important_flag'] = undefined;
+
+/**
+ * Whether or not the product field data can be edited
+ * @member {Boolean} bulk_edit_allowed
+ */
+GetProductField.prototype['bulk_edit_allowed'] = undefined;
+
+/**
+ * Whether or not the product field is searchable
+ * @member {Boolean} searchable_flag
+ */
+GetProductField.prototype['searchable_flag'] = undefined;
+
+/**
+ * Whether or not the product field value can be used when filtering searches
+ * @member {Boolean} filtering_allowed
+ */
+GetProductField.prototype['filtering_allowed'] = undefined;
+
+/**
+ * Whether or not the product field is sortable
+ * @member {Boolean} sortable_flag
+ */
+GetProductField.prototype['sortable_flag'] = undefined;
+
+/**
+ * Whether or not the product field is mandatory when creating products
+ * @member {Boolean} mandatory_flag
+ */
+GetProductField.prototype['mandatory_flag'] = undefined;
+
+// Implement ProductField interface:
+/**
+ * The name of the field
+ * @member {String} name
+ */
+_ProductField["default"].prototype['name'] = undefined;
+/**
+ * When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{\"label\":\"red\"}, {\"label\":\"blue\"}, {\"label\":\"lilac\"}]`
+ * @member {Array.<Object>} options
+ */
+_ProductField["default"].prototype['options'] = undefined;
+/**
+ * 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 product 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>
+ * @member {module:model/ProductField.FieldTypeEnum} field_type
+ */
+_ProductField["default"].prototype['field_type'] = undefined;
+/**
+ * The ID of the product field
+ * @member {Number} id
+ */
+_ProductField["default"].prototype['id'] = undefined;
+/**
+ * The key of the product field
+ * @member {String} key
+ */
+_ProductField["default"].prototype['key'] = undefined;
+/**
+ * The position (index) of the product field in the detail view
+ * @member {Number} order_nr
+ */
+_ProductField["default"].prototype['order_nr'] = undefined;
+/**
+ * The product field creation time. Format: YYYY-MM-DD HH:MM:SS
+ * @member {String} add_time
+ */
+_ProductField["default"].prototype['add_time'] = undefined;
+/**
+ * The product field last update time. Format: YYYY-MM-DD HH:MM:SS
+ * @member {String} update_time
+ */
+_ProductField["default"].prototype['update_time'] = undefined;
+/**
+ * The ID of the last user to update the product field
+ * @member {Number} last_updated_by_user_id
+ */
+_ProductField["default"].prototype['last_updated_by_user_id'] = undefined;
+/**
+ * The ID of the user who created the product field
+ * @member {Number} created_by_user_id
+ */
+_ProductField["default"].prototype['created_by_user_id'] = undefined;
+/**
+ * Whether or not the product field is currently active
+ * @member {Boolean} active_flag
+ */
+_ProductField["default"].prototype['active_flag'] = undefined;
+/**
+ * Whether or not the product field name and metadata is editable
+ * @member {Boolean} edit_flag
+ */
+_ProductField["default"].prototype['edit_flag'] = undefined;
+/**
+ * Whether or not the product field is visible in the Add Product Modal
+ * @member {Boolean} add_visible_flag
+ */
+_ProductField["default"].prototype['add_visible_flag'] = undefined;
+/**
+ * Whether or not the product field is marked as important
+ * @member {Boolean} important_flag
+ */
+_ProductField["default"].prototype['important_flag'] = undefined;
+/**
+ * Whether or not the product field data can be edited
+ * @member {Boolean} bulk_edit_allowed
+ */
+_ProductField["default"].prototype['bulk_edit_allowed'] = undefined;
+/**
+ * Whether or not the product field is searchable
+ * @member {Boolean} searchable_flag
+ */
+_ProductField["default"].prototype['searchable_flag'] = undefined;
+/**
+ * Whether or not the product field value can be used when filtering searches
+ * @member {Boolean} filtering_allowed
+ */
+_ProductField["default"].prototype['filtering_allowed'] = undefined;
+/**
+ * Whether or not the product field is sortable
+ * @member {Boolean} sortable_flag
+ */
+_ProductField["default"].prototype['sortable_flag'] = undefined;
+/**
+ * Whether or not the product field is mandatory when creating products
+ * @member {Boolean} mandatory_flag
+ */
+_ProductField["default"].prototype['mandatory_flag'] = undefined;
+// Implement GetFieldAllOf interface:
+/**
+ * @member {module:model/InternalFieldType} field_type
+ */
+_GetFieldAllOf["default"].prototype['field_type'] = undefined;
+var _default = GetProductField;
+exports["default"] = _default;