pipedrive 23.2.5-rc.2 → 23.3.0-rc.4

package/docs/PostNote.md

@@ -1,10 +0,0 @@
-# Pipedrive.PostNote
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the request was successful or not | [optional] 
-**data** | [**BaseNote**](BaseNote.md) |  | [optional] 
-
-

package/docs/PostRoleAssignment.md

@@ -1,10 +0,0 @@
-# Pipedrive.PostRoleAssignment
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**data** | [**PostRoleAssignmentAllOfData**](PostRoleAssignmentAllOfData.md) |  | [optional] 
-
-

package/docs/PostRoleAssignmentAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.PostRoleAssignmentAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PostRoleAssignmentAllOfData**](PostRoleAssignmentAllOfData.md) |  | [optional] 
-
-

package/docs/PostRoleAssignmentAllOfData.md

@@ -1,10 +0,0 @@
-# Pipedrive.PostRoleAssignmentAllOfData
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**user_id** | **Number** | The ID of the user that was added to the role | [optional] 
-**role_id** | **Number** | The ID of the role the user was added to | [optional] 
-
-

package/docs/PostRoleSettings.md

@@ -1,10 +0,0 @@
-# Pipedrive.PostRoleSettings
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**data** | [**PostRoleSettingsAllOfData**](PostRoleSettingsAllOfData.md) |  | [optional] 
-
-

package/docs/PostRoleSettingsAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.PostRoleSettingsAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PostRoleSettingsAllOfData**](PostRoleSettingsAllOfData.md) |  | [optional] 
-
-

package/docs/PostRoleSettingsAllOfData.md

@@ -1,25 +0,0 @@
-# Pipedrive.PostRoleSettingsAllOfData
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | The ID of the role | [optional] 
-**deal_default_visibility** | **Number** | The setting | [optional] 
-
-
-
-## Enum: DealDefaultVisibilityEnum
-
-
-* `1` (value: `1`)
-
-* `3` (value: `3`)
-
-* `5` (value: `5`)
-
-* `7` (value: `7`)
-
-
-
-

package/docs/PostRoles.md

@@ -1,10 +0,0 @@
-# Pipedrive.PostRoles
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**data** | [**PostRolesAllOfData**](PostRolesAllOfData.md) |  | [optional] 
-
-

package/docs/PostRolesAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.PostRolesAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**PostRolesAllOfData**](PostRolesAllOfData.md) |  | [optional] 
-
-

package/docs/PostRolesAllOfData.md

@@ -1,9 +0,0 @@
-# Pipedrive.PostRolesAllOfData
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | The ID of the created role | [optional] 
-
-

package/docs/Product.md

@@ -1,18 +0,0 @@
-# Pipedrive.Product
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | The ID of the product | [optional] 
-**name** | **String** | The name of the product | [optional] 
-**code** | **String** | Product code | [optional] 
-**unit** | **String** | The unit in which this product is sold | [optional] 
-**tax** | **Number** | Tax percentage | [optional] [default to 0]
-**activeFlag** | [**NumberBooleanDefault1**](NumberBooleanDefault1.md) |  | [optional] 
-**selectable** | [**NumberBooleanDefault1**](NumberBooleanDefault1.md) |  | [optional] 
-**visibleTo** | [**VisibleTo**](VisibleTo.md) | Visibility of the product | [optional] 
-**ownerId** | **Object** | Information about the Pipedrive User who owns the product | [optional] 
-**prices** | **[Object]** | Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional) | [optional] 
-
-

package/docs/ProductAttachementFields.md

@@ -1,19 +0,0 @@
-# Pipedrive.ProductAttachementFields
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] 
-**company_id** | **Number** | The ID of the company | [optional] 
-**deal_id** | **Number** | The ID of the deal | [optional] 
-**product_id** | **Number** | The ID of the product | [optional] 
-**sum** | **Number** | The sum of all the products attached to the deal | [optional] 
-**currency** | **String** | The currency associated with the deal product | [optional] 
-**add_time** | **String** | The date and time when the product was added to the deal | [optional] 
-**last_edit** | **String** | The date and time when the deal product was last edited | [optional] 
-**active_flag** | **Boolean** | Whether the product is active or not | [optional] 
-**tax** | **Number** | The product tax | [optional] 
-**name** | **String** | The product name | [optional] 
-
-

package/docs/ProductAttachmentDetails.md

@@ -1,54 +0,0 @@
-# Pipedrive.ProductAttachmentDetails
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**product_id** | **Number** | The ID of the product | [optional] 
-**item_price** | **Number** | The price at which this product will be added to the deal | [optional] 
-**quantity** | **Number** | Quantity – e.g. how many items of this product will be added to the deal | [optional] 
-**discount** | **Number** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional] [default to 0]
-**discount_type** | **String** | The type of the discount's value | [optional] [default to 'percentage']
-**product_variation_id** | **Number** | The ID of the product variation to use. When omitted, no variation will be used | [optional] 
-**comments** | **String** | A textual comment associated with this product-deal attachment | [optional] 
-**tax** | **Number** | The product tax | [optional] 
-**tax_method** | **String** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional] 
-**enabled_flag** | **Boolean** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional] [default to true]
-**billing_frequency** | [**BillingFrequency**](BillingFrequency.md) |  | [optional] 
-**billing_frequency_cycles** | **Number** | Only available in Advanced and above plans  The number of times the billing frequency repeats for a product in a deal  When `billing_frequency` is set to `one-time`, this field must be `null`  For all the other values of `billing_frequency`, `null` represents a product billed indefinitely  Must be a positive integer less or equal to 312  | [optional] 
-**billing_start_date** | **String** | Only available in Advanced and above plans  The billing start date. Must be between 15 years in the past and 15 years in the future  | [optional] 
-**id** | **Number** | The ID of the deal-product (the ID of the product attached to the deal) | [optional] 
-**company_id** | **Number** | The ID of the company | [optional] 
-**deal_id** | **Number** | The ID of the deal | [optional] 
-**sum** | **Number** | The sum of all the products attached to the deal | [optional] 
-**currency** | **String** | The currency associated with the deal product | [optional] 
-**add_time** | **String** | The date and time when the product was added to the deal | [optional] 
-**last_edit** | **String** | The date and time when the deal product was last edited | [optional] 
-**active_flag** | **Boolean** | Whether the product is active or not | [optional] 
-**name** | **String** | The product name | [optional] 
-
-
-
-## Enum: DiscountTypeEnum
-
-
-* `percentage` (value: `"percentage"`)
-
-* `amount` (value: `"amount"`)
-
-
-
-
-
-## Enum: TaxMethodEnum
-
-
-* `exclusive` (value: `"exclusive"`)
-
-* `inclusive` (value: `"inclusive"`)
-
-* `none` (value: `"none"`)
-
-
-
-

package/docs/ProductBaseDeal.md

@@ -1,51 +0,0 @@
-# Pipedrive.ProductBaseDeal
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | The ID of the deal | [optional] 
-**company_id** | **Number** | The ID of the company | [optional] 
-**creator_user_id** | **Number** | The ID of the deal creator | [optional] 
-**user_id** | **Number** | The ID of the user | [optional] 
-**person_id** | **Number** | The ID of the person associated with the deal | [optional] 
-**org_id** | **Number** | The ID of the organization associated with the deal | [optional] 
-**stage_id** | **Number** | The ID of the deal stage | [optional] 
-**title** | **String** | The title of the deal | [optional] 
-**value** | **Number** | The value of the deal | [optional] 
-**currency** | **String** | The currency associated with the deal | [optional] 
-**add_time** | **String** | The creation date and time of the deal | [optional] 
-**first_add_time** | **String** | The first creation date and time of the deal | [optional] 
-**update_time** | **String** | The last updated date and time of the deal | [optional] 
-**stage_change_time** | **String** | The last updated date and time of the deal stage | [optional] 
-**active** | **Boolean** | Whether the deal is active or not | [optional] 
-**deleted** | **Boolean** | Whether the deal is deleted or not | [optional] 
-**status** | **String** | The status of the deal | [optional] 
-**probability** | **Number** | The success probability percentage of the deal | [optional] 
-**next_activity_date** | **String** | The date of the next activity associated with the deal | [optional] 
-**next_activity_time** | **String** | The time of the next activity associated with the deal | [optional] 
-**next_activity_id** | **Number** | The ID of the next activity associated with the deal | [optional] 
-**last_activity_id** | **Number** | The ID of the last activity associated with the deal | [optional] 
-**last_activity_date** | **String** | The date of the last activity associated with the deal | [optional] 
-**lost_reason** | **String** | The reason for losing the deal | [optional] 
-**visible_to** | **String** | The visibility of the deal | [optional] 
-**close_time** | **String** | The date and time of closing the deal | [optional] 
-**pipeline_id** | **Number** | The ID of the pipeline associated with the deal | [optional] 
-**won_time** | **String** | The date and time of changing the deal status as won | [optional] 
-**first_won_time** | **String** | The date and time of the first time changing the deal status as won | [optional] 
-**lost_time** | **String** | The date and time of changing the deal status as lost | [optional] 
-**products_count** | **Number** | The number of products associated with the deal | [optional] 
-**files_count** | **Number** | The number of files associated with the deal | [optional] 
-**notes_count** | **Number** | The number of notes associated with the deal | [optional] 
-**followers_count** | **Number** | The number of followers associated with the deal | [optional] 
-**email_messages_count** | **Number** | The number of emails associated with the deal | [optional] 
-**activities_count** | **Number** | The number of activities associated with the deal | [optional] 
-**done_activities_count** | **Number** | The number of completed activities associated with the deal | [optional] 
-**undone_activities_count** | **Number** | The number of incomplete activities associated with the deal | [optional] 
-**participants_count** | **Number** | The number of participants associated with the deal | [optional] 
-**expected_close_date** | **Date** | The expected close date of the deal | [optional] 
-**last_incoming_mail_time** | **String** | The date and time of the last incoming email associated with the deal | [optional] 
-**last_outgoing_mail_time** | **String** | The date and time of the last outgoing email associated with the deal | [optional] 
-**label** | **String** | The label or multiple labels assigned to the deal | [optional] 
-
-

package/docs/ProductField.md

@@ -1,66 +0,0 @@
-# Pipedrive.ProductField
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The name of the field | 
-**options** | **[Object]** | 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\"}]` | [optional] 
-**field_type** | **String** | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a 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> | 
-**id** | **Number** | The ID of the product field | [optional] 
-**key** | **String** | The key of the product field | [optional] 
-**order_nr** | **Number** | The position (index) of the product field in the detail view | [optional] 
-**add_time** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] 
-**update_time** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional] 
-**last_updated_by_user_id** | **Number** | The ID of the last user to update the product field | [optional] 
-**created_by_user_id** | **Number** | The ID of the user who created the product field | [optional] 
-**active_flag** | **Boolean** | Whether or not the product field is currently active | [optional] 
-**edit_flag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional] 
-**add_visible_flag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional] 
-**important_flag** | **Boolean** | Whether or not the product field is marked as important | [optional] 
-**bulk_edit_allowed** | **Boolean** | Whether or not the product field data can be edited | [optional] 
-**searchable_flag** | **Boolean** | Whether or not the product field is searchable | [optional] 
-**filtering_allowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional] 
-**sortable_flag** | **Boolean** | Whether or not the product field is sortable | [optional] 
-**mandatory_flag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional] 
-
-
-
-## Enum: FieldTypeEnum
-
-
-* `varchar` (value: `"varchar"`)
-
-* `varchar_auto` (value: `"varchar_auto"`)
-
-* `text` (value: `"text"`)
-
-* `double` (value: `"double"`)
-
-* `monetary` (value: `"monetary"`)
-
-* `date` (value: `"date"`)
-
-* `set` (value: `"set"`)
-
-* `enum` (value: `"enum"`)
-
-* `user` (value: `"user"`)
-
-* `org` (value: `"org"`)
-
-* `people` (value: `"people"`)
-
-* `phone` (value: `"phone"`)
-
-* `time` (value: `"time"`)
-
-* `timerange` (value: `"timerange"`)
-
-* `daterange` (value: `"daterange"`)
-
-* `address` (value: `"address"`)
-
-
-
-

package/docs/ProductFieldAllOf.md

@@ -1,24 +0,0 @@
-# Pipedrive.ProductFieldAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **Number** | The ID of the product field | [optional] 
-**key** | **String** | The key of the product field | [optional] 
-**order_nr** | **Number** | The position (index) of the product field in the detail view | [optional] 
-**add_time** | **String** | The product field creation time. Format: YYYY-MM-DD HH:MM:SS | [optional] 
-**update_time** | **String** | The product field last update time. Format: YYYY-MM-DD HH:MM:SS | [optional] 
-**last_updated_by_user_id** | **Number** | The ID of the last user to update the product field | [optional] 
-**created_by_user_id** | **Number** | The ID of the user who created the product field | [optional] 
-**active_flag** | **Boolean** | Whether or not the product field is currently active | [optional] 
-**edit_flag** | **Boolean** | Whether or not the product field name and metadata is editable | [optional] 
-**add_visible_flag** | **Boolean** | Whether or not the product field is visible in the Add Product Modal | [optional] 
-**important_flag** | **Boolean** | Whether or not the product field is marked as important | [optional] 
-**bulk_edit_allowed** | **Boolean** | Whether or not the product field data can be edited | [optional] 
-**searchable_flag** | **Boolean** | Whether or not the product field is searchable | [optional] 
-**filtering_allowed** | **Boolean** | Whether or not the product field value can be used when filtering searches | [optional] 
-**sortable_flag** | **Boolean** | Whether or not the product field is sortable | [optional] 
-**mandatory_flag** | **Boolean** | Whether or not the product field is mandatory when creating products | [optional] 
-
-