pipedrive 13.0.8 → 13.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (396) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +18 -16
  3. package/dist/api/ActivitiesApi.js +44 -44
  4. package/dist/api/ActivityTypesApi.js +4 -4
  5. package/dist/api/CallLogsApi.js +6 -6
  6. package/dist/api/CurrenciesApi.js +2 -2
  7. package/dist/api/DealFieldsApi.js +10 -10
  8. package/dist/api/DealsApi.js +100 -100
  9. package/dist/api/FilesApi.js +34 -34
  10. package/dist/api/FiltersApi.js +2 -2
  11. package/dist/api/GlobalMessagesApi.js +8 -8
  12. package/dist/api/GoalsApi.js +54 -54
  13. package/dist/api/ItemSearchApi.js +4 -4
  14. package/dist/api/LeadLabelsApi.js +12 -12
  15. package/dist/api/LeadSourcesApi.js +2 -2
  16. package/dist/api/LeadsApi.js +18 -18
  17. package/dist/api/MailboxApi.js +26 -26
  18. package/dist/api/NoteFieldsApi.js +2 -2
  19. package/dist/api/NotesApi.js +42 -42
  20. package/dist/api/OrganizationFieldsApi.js +10 -10
  21. package/dist/api/OrganizationRelationshipsApi.js +12 -12
  22. package/dist/api/OrganizationsApi.js +50 -50
  23. package/dist/api/PermissionSetsApi.js +12 -12
  24. package/dist/api/PersonFieldsApi.js +10 -10
  25. package/dist/api/PersonsApi.js +74 -74
  26. package/dist/api/PipelinesApi.js +50 -50
  27. package/dist/api/ProductFieldsApi.js +10 -10
  28. package/dist/api/ProductsApi.js +44 -44
  29. package/dist/api/RecentsApi.js +6 -6
  30. package/dist/api/RolesApi.js +38 -38
  31. package/dist/api/StagesApi.js +14 -14
  32. package/dist/api/SubscriptionsApi.js +34 -34
  33. package/dist/api/TeamsApi.js +32 -32
  34. package/dist/api/UserConnectionsApi.js +2 -2
  35. package/dist/api/UserSettingsApi.js +2 -2
  36. package/dist/api/UsersApi.js +44 -44
  37. package/dist/api/WebhooksApi.js +14 -14
  38. package/dist/index.js +16 -0
  39. package/dist/model/ActivityDistributionDataActivityDistribution.js +1 -1
  40. package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.js +4 -4
  41. package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERIDActivities.js +2 -2
  42. package/dist/model/ActivityInfo.js +5 -5
  43. package/dist/model/ActivityObjectFragment.js +9 -9
  44. package/dist/model/ActivityPostObject.js +32 -32
  45. package/dist/model/ActivityPostObjectAllOf.js +7 -7
  46. package/dist/model/ActivityPutObject.js +32 -32
  47. package/dist/model/ActivityPutObjectAllOf.js +7 -7
  48. package/dist/model/ActivityResponseObject.js +96 -96
  49. package/dist/model/ActivityResponseObjectAllOf.js +39 -39
  50. package/dist/model/ActivityTypeBulkDeleteResponseAllOfData.js +1 -1
  51. package/dist/model/AddDealFollowerRequest.js +2 -2
  52. package/dist/model/AddDealParticipantRequest.js +2 -2
  53. package/dist/model/AddFollowerToPersonResponseAllOfData.js +4 -4
  54. package/dist/model/AddLeadLabelRequest.js +2 -2
  55. package/dist/model/AddLeadRequest.js +9 -9
  56. package/dist/model/AddNoteRequest.js +22 -22
  57. package/dist/model/AddNoteRequestAllOf.js +4 -4
  58. package/dist/model/AddOrganizationRelationshipRequest.js +6 -39
  59. package/dist/model/AddPersonFollowerRequest.js +2 -2
  60. package/dist/model/AddProductAttachmentDetails.js +51 -51
  61. package/dist/model/AddProductAttachmentDetailsAllOf.js +1 -1
  62. package/dist/model/AddProductFollowerRequest.js +2 -2
  63. package/dist/model/AddProductRequestBody.js +12 -12
  64. package/dist/model/AddTeamUserRequest.js +2 -2
  65. package/dist/model/AddWebhookRequest.js +7 -7
  66. package/dist/model/AddedDealFollowerData.js +4 -4
  67. package/dist/model/AdditionalBaseOrganizationItemInfo.js +64 -64
  68. package/dist/model/AdditionalDataWithPagination.js +1 -1
  69. package/dist/model/AdditionalMergePersonInfo.js +60 -60
  70. package/dist/model/AdditionalPersonInfo.js +50 -50
  71. package/dist/model/AllOrganizationRelationshipsGetResponse.js +2 -2
  72. package/dist/model/AllOrganizationRelationshipsGetResponseAllOf.js +1 -1
  73. package/dist/model/AllOrganizationsGetResponse.js +2 -2
  74. package/dist/model/AllOrganizationsGetResponseAllOf.js +1 -1
  75. package/dist/model/Assignee.js +3 -3
  76. package/dist/model/BaseComment.js +7 -7
  77. package/dist/model/BaseCurrency.js +7 -7
  78. package/dist/model/BaseDeal.js +51 -51
  79. package/dist/model/BaseNote.js +14 -14
  80. package/dist/model/BaseNoteDealTitle.js +2 -2
  81. package/dist/model/BaseNoteOrganization.js +2 -2
  82. package/dist/model/BaseNotePerson.js +2 -2
  83. package/dist/model/BaseOrganizationItem.js +86 -86
  84. package/dist/model/BaseOrganizationItemFields.js +11 -11
  85. package/dist/model/BaseOrganizationItemWithEditNameFlag.js +88 -88
  86. package/dist/model/BaseOrganizationItemWithEditNameFlagAllOf.js +1 -1
  87. package/dist/model/BaseOrganizationRelationshipItem.js +5 -5
  88. package/dist/model/BasePersonItem.js +13 -13
  89. package/dist/model/BasePersonItemEmail.js +2 -2
  90. package/dist/model/BasePersonItemPhone.js +3 -3
  91. package/dist/model/BasePipeline.js +8 -8
  92. package/dist/model/BasePipelineWithSelectedFlag.js +18 -18
  93. package/dist/model/BasePipelineWithSelectedFlagAllOf.js +1 -1
  94. package/dist/model/BaseProduct.js +3 -3
  95. package/dist/model/BaseRole.js +3 -3
  96. package/dist/model/BaseStage.js +10 -10
  97. package/dist/model/BaseTeam.js +20 -20
  98. package/dist/model/BaseTeamAdditionalProperties.js +2 -2
  99. package/dist/model/BaseUser.js +19 -19
  100. package/dist/model/BaseUserMe.js +48 -48
  101. package/dist/model/BaseUserMeAllOf.js +5 -5
  102. package/dist/model/BaseUserMeAllOfLanguage.js +1 -1
  103. package/dist/model/BaseWebhook.js +3 -3
  104. package/dist/model/BasicDeal.js +10 -10
  105. package/dist/model/BasicDealProduct.js +17 -5
  106. package/dist/model/BasicGoal.js +6 -6
  107. package/dist/model/BasicOrganization.js +3 -3
  108. package/dist/model/BasicPerson.js +10 -10
  109. package/dist/model/BasicPersonEmail.js +112 -0
  110. package/dist/model/BasicProductField.js +3 -3
  111. package/dist/model/BulkDeleteResponseAllOfData.js +1 -1
  112. package/dist/model/CalculatedFields.js +2 -2
  113. package/dist/model/CallLogObject.js +6 -6
  114. package/dist/model/CommentPostPutObject.js +2 -2
  115. package/dist/model/CreateTeam.js +6 -6
  116. package/dist/model/Currencies.js +1 -1
  117. package/dist/model/DealCountAndActivityInfo.js +26 -26
  118. package/dist/model/DealFlowResponseAllOfData.js +1 -1
  119. package/dist/model/DealListActivitiesResponse.js +2 -2
  120. package/dist/model/DealListActivitiesResponseAllOf.js +1 -1
  121. package/dist/model/DealNonStrict.js +104 -104
  122. package/dist/model/DealNonStrictModeFields.js +1 -1
  123. package/dist/model/DealNonStrictModeFieldsCreatorUserId.js +6 -6
  124. package/dist/model/DealNonStrictWithDetails.js +110 -110
  125. package/dist/model/DealNonStrictWithDetailsAllOf.js +3 -3
  126. package/dist/model/DealNonStrictWithDetailsAllOfAge.js +1 -1
  127. package/dist/model/DealNonStrictWithDetailsAllOfAverageTimeToWon.js +1 -1
  128. package/dist/model/DealNonStrictWithDetailsAllOfStayInPipelineStages.js +3 -3
  129. package/dist/model/DealOrganizationData.js +7 -7
  130. package/dist/model/DealOrganizationDataWithId.js +14 -14
  131. package/dist/model/DealOrganizationDataWithIdAllOf.js +1 -1
  132. package/dist/model/DealParticipantCountInfo.js +2 -2
  133. package/dist/model/DealParticipants.js +1 -1
  134. package/dist/model/DealPersonData.js +10 -10
  135. package/dist/model/DealPersonDataEmail.js +112 -0
  136. package/dist/model/DealPersonDataPhone.js +1 -1
  137. package/dist/model/DealPersonDataWithId.js +17 -17
  138. package/dist/model/DealPersonDataWithIdAllOf.js +1 -1
  139. package/dist/model/DealSearchItemItem.js +8 -8
  140. package/dist/model/DealSearchItemItemOrganization.js +2 -2
  141. package/dist/model/DealSearchItemItemOwner.js +1 -1
  142. package/dist/model/DealSearchItemItemPerson.js +2 -2
  143. package/dist/model/DealSearchItemItemStage.js +2 -2
  144. package/dist/model/DealSearchResponseAllOfData.js +1 -1
  145. package/dist/model/DealStrict.js +112 -112
  146. package/dist/model/DealStrictModeFields.js +5 -5
  147. package/dist/model/DealStrictWithMergeId.js +114 -114
  148. package/dist/model/DealStrictWithMergeIdAllOf.js +1 -1
  149. package/dist/model/DealSummaryPerStages.js +1 -1
  150. package/dist/model/DealTitleParameter.js +1 -1
  151. package/dist/model/DealUserData.js +7 -7
  152. package/dist/model/DealUserDataWithId.js +14 -14
  153. package/dist/model/DealUserDataWithIdAllOf.js +1 -1
  154. package/dist/model/DealsCountAndActivityInfo.js +26 -26
  155. package/dist/model/DealsCountInfo.js +8 -8
  156. package/dist/model/DealsMovementsInfo.js +2 -2
  157. package/dist/model/DealsMovementsInfoFormattedValues.js +2 -2
  158. package/dist/model/DealsMovementsInfoValues.js +2 -2
  159. package/dist/model/DeleteActivitiesResponse200Data.js +1 -1
  160. package/dist/model/DeleteActivityResponse200Data.js +1 -1
  161. package/dist/model/DeleteDealData.js +1 -1
  162. package/dist/model/DeleteDealFollowerData.js +1 -1
  163. package/dist/model/DeleteDealParticipantData.js +1 -1
  164. package/dist/model/DeleteDealProductData.js +2 -2
  165. package/dist/model/DeleteFileData.js +1 -1
  166. package/dist/model/DeleteMultipleDealsData.js +1 -1
  167. package/dist/model/DeleteMultipleProductFieldsResponseData.js +1 -1
  168. package/dist/model/DeletePersonResponseAllOfData.js +1 -1
  169. package/dist/model/DeletePersonsInBulkResponseAllOfData.js +1 -1
  170. package/dist/model/DeleteProductFieldResponseData.js +1 -1
  171. package/dist/model/DeleteProductFollowerResponseData.js +1 -1
  172. package/dist/model/DeleteProductResponseData.js +1 -1
  173. package/dist/model/DeleteResponseAllOfData.js +1 -1
  174. package/dist/model/DeleteRoleAllOfData.js +1 -1
  175. package/dist/model/DeleteRoleAssignmentAllOfData.js +1 -1
  176. package/dist/model/DeleteStageResponse200Data.js +1 -1
  177. package/dist/model/DeleteStagesResponse200Data.js +1 -1
  178. package/dist/model/DeleteTeamUserRequest.js +2 -2
  179. package/dist/model/Duration.js +3 -3
  180. package/dist/model/EditPipeline.js +2 -2
  181. package/dist/model/EditPipelineAllOf.js +1 -1
  182. package/dist/model/EmailInfo.js +2 -2
  183. package/dist/model/ExpectedOutcome.js +3 -3
  184. package/dist/model/Field.js +18 -18
  185. package/dist/model/FieldCreateRequest.js +5 -5
  186. package/dist/model/FieldCreateRequestAllOf.js +3 -3
  187. package/dist/model/FieldUpdateRequest.js +1 -1
  188. package/dist/model/FileData.js +24 -24
  189. package/dist/model/FileItem.js +24 -24
  190. package/dist/model/FiltersPostResponseAllOfData.js +1 -1
  191. package/dist/model/FullRole.js +12 -12
  192. package/dist/model/FullRoleAllOf.js +1 -1
  193. package/dist/model/GetAddProductAttachementDetails.js +1 -1
  194. package/dist/model/GetAddedDeal.js +1 -1
  195. package/dist/model/GetAddedDealAdditionalData.js +1 -1
  196. package/dist/model/GetAllPersonsResponse.js +2 -2
  197. package/dist/model/GetAllPersonsResponseAllOf.js +1 -1
  198. package/dist/model/GetAllProductFieldsResponse.js +2 -2
  199. package/dist/model/GetComments.js +1 -1
  200. package/dist/model/GetDealAdditionalData.js +1 -1
  201. package/dist/model/GetDeals.js +1 -1
  202. package/dist/model/GetDealsConversionRatesInPipelineAllOfData.js +4 -4
  203. package/dist/model/GetDealsMovementsInPipelineAllOfData.js +1 -1
  204. package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.js +3 -3
  205. package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.js +3 -3
  206. package/dist/model/GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.js +2 -2
  207. package/dist/model/GetDealsSummaryData.js +6 -6
  208. package/dist/model/GetDealsSummaryDataValuesTotal.js +6 -6
  209. package/dist/model/GetDealsSummaryDataWeightedValuesTotal.js +4 -4
  210. package/dist/model/GetDealsTimelineData.js +1 -1
  211. package/dist/model/GetDealsTimelineDataTotals.js +9 -9
  212. package/dist/model/GetDuplicatedDeal.js +1 -1
  213. package/dist/model/GetLeadSourcesResponse200Data.js +1 -1
  214. package/dist/model/GetNotes.js +1 -1
  215. package/dist/model/GetPersonDetailsResponseAllOfAdditionalData.js +1 -1
  216. package/dist/model/GetProductAttachementDetails.js +1 -1
  217. package/dist/model/GetProductFieldResponse.js +1 -1
  218. package/dist/model/GetRecentsAdditionalData.js +2 -2
  219. package/dist/model/GetRoleAllOfAdditionalData.js +1 -1
  220. package/dist/model/GetRoleAssignments.js +2 -2
  221. package/dist/model/GetRoleAssignmentsAllOf.js +1 -1
  222. package/dist/model/GetRoles.js +2 -2
  223. package/dist/model/GetRolesAllOf.js +1 -1
  224. package/dist/model/GetStageDeals.js +1 -1
  225. package/dist/model/GetStages.js +1 -1
  226. package/dist/model/GlobalMessageData.js +6 -6
  227. package/dist/model/GlobalMessageGet.js +2 -2
  228. package/dist/model/GlobalMessageGetAllOf.js +1 -1
  229. package/dist/model/GlobalMessageUserData.js +3 -3
  230. package/dist/model/GoalResults.js +1 -1
  231. package/dist/model/GoalType.js +2 -2
  232. package/dist/model/GoalsResponseComponent.js +4 -4
  233. package/dist/model/LeadLabelResponse.js +4 -4
  234. package/dist/model/LeadResponse.js +16 -16
  235. package/dist/model/LeadValue.js +1 -1
  236. package/dist/model/ListActivitiesResponse.js +2 -2
  237. package/dist/model/ListActivitiesResponseAllOf.js +1 -1
  238. package/dist/model/ListDealsResponse.js +2 -2
  239. package/dist/model/ListDealsResponseAllOf.js +1 -1
  240. package/dist/model/ListFilesResponse.js +2 -2
  241. package/dist/model/ListFilesResponseAllOf.js +1 -1
  242. package/dist/model/ListFollowersResponse.js +2 -2
  243. package/dist/model/ListFollowersResponseAllOf.js +1 -1
  244. package/dist/model/ListFollowersResponseAllOfData.js +4 -4
  245. package/dist/model/ListMailMessagesResponse.js +2 -2
  246. package/dist/model/ListMailMessagesResponseAllOf.js +1 -1
  247. package/dist/model/ListPermittedUsersResponse1.js +2 -2
  248. package/dist/model/ListPermittedUsersResponse1AllOf.js +1 -1
  249. package/dist/model/ListPermittedUsersResponseAllOfData.js +1 -1
  250. package/dist/model/ListPersonProductsResponse.js +2 -2
  251. package/dist/model/ListPersonProductsResponseAllOf.js +1 -1
  252. package/dist/model/ListPersonsResponse.js +2 -2
  253. package/dist/model/ListPersonsResponseAllOf.js +1 -1
  254. package/dist/model/ListProductAdditionalData.js +10 -10
  255. package/dist/model/ListProductAdditionalDataAllOf.js +5 -5
  256. package/dist/model/ListProductFollowersResponse.js +2 -2
  257. package/dist/model/ListProductFollowersResponseAllOf.js +1 -1
  258. package/dist/model/ListProductFollowersResponseAllOfData.js +4 -4
  259. package/dist/model/ListProductsResponseAllOfData.js +1 -1
  260. package/dist/model/MergeDealsRequest.js +2 -2
  261. package/dist/model/MergeOrganizationsRequest.js +2 -2
  262. package/dist/model/MergePersonDealRelatedInfo.js +30 -30
  263. package/dist/model/MergePersonItem.js +86 -86
  264. package/dist/model/MergePersonsRequest.js +2 -2
  265. package/dist/model/NewDeal.js +25 -25
  266. package/dist/model/NewDealAllOf.js +1 -1
  267. package/dist/model/NewDealProduct.js +33 -14
  268. package/dist/model/NewDealProductAllOf.js +2 -2
  269. package/dist/model/NewFollowerResponseData.js +4 -4
  270. package/dist/model/NewGoal.js +12 -12
  271. package/dist/model/NewOrganization.js +9 -9
  272. package/dist/model/NewOrganizationAllOf.js +1 -1
  273. package/dist/model/NewPerson.js +20 -20
  274. package/dist/model/NewPersonAllOf.js +1 -1
  275. package/dist/model/NewProductField.js +4 -4
  276. package/dist/model/Note.js +19 -19
  277. package/dist/model/NoteConnectToParams.js +2 -2
  278. package/dist/model/NoteCreatorUser.js +5 -5
  279. package/dist/model/NoteField.js +7 -7
  280. package/dist/model/NoteParams.js +7 -7
  281. package/dist/model/OrganizationAddressInfo.js +11 -11
  282. package/dist/model/OrganizationCountAndAddressInfo.js +38 -38
  283. package/dist/model/OrganizationCountInfo.js +8 -8
  284. package/dist/model/OrganizationData.js +5 -5
  285. package/dist/model/OrganizationDataWithId.js +13 -13
  286. package/dist/model/OrganizationDataWithIdAllOf.js +1 -1
  287. package/dist/model/OrganizationDataWithIdAndActiveFlag.js +15 -15
  288. package/dist/model/OrganizationDataWithIdAndActiveFlagAllOf.js +1 -1
  289. package/dist/model/OrganizationDeleteResponseData.js +1 -1
  290. package/dist/model/OrganizationDetailsGetResponseAllOfAdditionalData.js +1 -1
  291. package/dist/model/OrganizationFlowResponseAllOfData.js +1 -1
  292. package/dist/model/OrganizationFollowerDeleteResponseData.js +1 -1
  293. package/dist/model/OrganizationFollowerItem.js +2 -2
  294. package/dist/model/OrganizationFollowerItemAllOf.js +1 -1
  295. package/dist/model/OrganizationItem.js +88 -88
  296. package/dist/model/OrganizationRelationship.js +1 -1
  297. package/dist/model/OrganizationRelationshipDeleteResponseAllOfData.js +1 -1
  298. package/dist/model/OrganizationRelationshipDetails.js +16 -16
  299. package/dist/model/OrganizationRelationshipWithCalculatedFields.js +14 -14
  300. package/dist/model/OrganizationSearchItemItem.js +5 -5
  301. package/dist/model/OrganizationsDeleteResponseData.js +1 -1
  302. package/dist/model/OrganizationsMergeResponseData.js +1 -1
  303. package/dist/model/Owner.js +12 -12
  304. package/dist/model/Params.js +2 -2
  305. package/dist/model/PaymentItem.js +13 -13
  306. package/dist/model/PermissionSets.js +2 -2
  307. package/dist/model/PermissionSetsAllOf.js +1 -1
  308. package/dist/model/PermissionSetsItem.js +3 -3
  309. package/dist/model/PersonCountAndEmailInfo.js +18 -18
  310. package/dist/model/PersonCountEmailDealAndActivityInfo.js +44 -44
  311. package/dist/model/PersonCountInfo.js +7 -7
  312. package/dist/model/PersonData.js +5 -5
  313. package/dist/model/PersonDataEmail.js +2 -2
  314. package/dist/model/PersonDataPhone.js +2 -2
  315. package/dist/model/PersonDataWithActiveFlag.js +13 -13
  316. package/dist/model/PersonDataWithActiveFlagAllOf.js +1 -1
  317. package/dist/model/PersonFlowResponseAllOfData.js +1 -1
  318. package/dist/model/PersonItem.js +76 -76
  319. package/dist/model/PersonListProduct.js +14 -14
  320. package/dist/model/PersonNameCountAndEmailInfo.js +24 -24
  321. package/dist/model/PersonNameCountAndEmailInfoWithIds.js +30 -30
  322. package/dist/model/PersonNameCountAndEmailInfoWithIdsAllOf.js +3 -3
  323. package/dist/model/PersonNameInfo.js +3 -3
  324. package/dist/model/PersonNameInfoWithOrgAndOwnerId.js +6 -6
  325. package/dist/model/PersonSearchItemItem.js +4 -4
  326. package/dist/model/PersonSearchItemItemOrganization.js +2 -2
  327. package/dist/model/PersonSearchItemItemOwner.js +1 -1
  328. package/dist/model/PictureData.js +2 -2
  329. package/dist/model/PictureDataWithID.js +4 -4
  330. package/dist/model/PictureDataWithValue.js +4 -4
  331. package/dist/model/Pipeline.js +4 -4
  332. package/dist/model/PipelineDetails.js +19 -19
  333. package/dist/model/PostDealParticipants.js +1 -1
  334. package/dist/model/PostRoleAssignmentAllOfData.js +2 -2
  335. package/dist/model/PostRoleSettingsAllOfData.js +1 -1
  336. package/dist/model/PostRolesAllOfData.js +1 -1
  337. package/dist/model/ProductAttachementFields.js +12 -12
  338. package/dist/model/ProductAttachmentDetails.js +51 -44
  339. package/dist/model/ProductBaseDeal.js +42 -42
  340. package/dist/model/ProductField.js +36 -36
  341. package/dist/model/ProductFieldAllOf.js +15 -15
  342. package/dist/model/ProductListItem.js +21 -21
  343. package/dist/model/ProductRequest.js +6 -6
  344. package/dist/model/ProductSearchItemItem.js +5 -5
  345. package/dist/model/ProductSearchItemItemOwner.js +1 -1
  346. package/dist/model/ProductWithArrayPrices.js +6 -6
  347. package/dist/model/ProductWithObjectPrices.js +6 -6
  348. package/dist/model/ProductsResponse.js +1 -1
  349. package/dist/model/RecentDataProduct.js +15 -15
  350. package/dist/model/RelatedDealDataDEALID.js +8 -8
  351. package/dist/model/RelatedOrganizationName.js +1 -1
  352. package/dist/model/RelatedPersonData.js +1 -1
  353. package/dist/model/RelationshipOrganizationInfoItem.js +12 -12
  354. package/dist/model/RelationshipOrganizationInfoItemAllOf.js +1 -1
  355. package/dist/model/RelationshipOrganizationInfoItemWithActiveFlag.js +14 -14
  356. package/dist/model/RequredTitleParameter.js +2 -2
  357. package/dist/model/ResponseCallLogObject.js +14 -14
  358. package/dist/model/ResponseCallLogObjectAllOf.js +1 -1
  359. package/dist/model/RoleAssignment.js +11 -11
  360. package/dist/model/RoleAssignmentAllOf.js +3 -3
  361. package/dist/model/RoleSettings.js +10 -10
  362. package/dist/model/RolesAdditionalData.js +1 -1
  363. package/dist/model/RolesAdditionalDataPagination.js +1 -1
  364. package/dist/model/SinglePermissionSetsItem.js +8 -8
  365. package/dist/model/SinglePermissionSetsItemAllOf.js +1 -1
  366. package/dist/model/Stage.js +5 -5
  367. package/dist/model/StageConversions.js +3 -3
  368. package/dist/model/StageDetails.js +21 -21
  369. package/dist/model/StageWithPipelineInfo.js +24 -24
  370. package/dist/model/StageWithPipelineInfoAllOf.js +2 -2
  371. package/dist/model/SubRole.js +10 -10
  372. package/dist/model/SubRoleAllOf.js +3 -3
  373. package/dist/model/SubscriptionInstallmentCreateRequest.js +5 -5
  374. package/dist/model/SubscriptionInstallmentUpdateRequest.js +1 -1
  375. package/dist/model/SubscriptionItem.js +15 -15
  376. package/dist/model/SubscriptionRecurringCancelRequest.js +1 -1
  377. package/dist/model/SubscriptionRecurringCreateRequest.js +14 -14
  378. package/dist/model/SubscriptionRecurringUpdateRequest.js +3 -3
  379. package/dist/model/TeamId.js +1 -1
  380. package/dist/model/UpdateDealRequest.js +22 -22
  381. package/dist/model/UpdateLeadLabelRequest.js +1 -1
  382. package/dist/model/UpdateLeadRequest.js +9 -9
  383. package/dist/model/UpdateStageRequest.js +10 -10
  384. package/dist/model/UpdateTeam.js +14 -14
  385. package/dist/model/UpdateTeamAllOf.js +2 -2
  386. package/dist/model/UpdateTeamWithAdditionalProperties.js +18 -18
  387. package/dist/model/UserAssignmentToPermissionSet.js +4 -4
  388. package/dist/model/UserAssignmentsToPermissionSet.js +2 -2
  389. package/dist/model/UserAssignmentsToPermissionSetAllOf.js +1 -1
  390. package/dist/model/UserData.js +6 -6
  391. package/dist/model/UserDataWithId.js +12 -12
  392. package/dist/model/UserIDs.js +2 -2
  393. package/dist/model/UserIDsAllOf.js +1 -1
  394. package/dist/model/UserPermissionsItem.js +31 -31
  395. package/dist/model/UserSettingsItem.js +5 -5
  396. package/package.json +1 -1
@@ -50,7 +50,7 @@ var LeadsApi = /*#__PURE__*/function () {
50
50
  }
51
51
  /**
52
52
  * Add a lead
53
- * Creates a Lead. A Lead always has to be linked to a Person or an Organization or both. All Leads created through the Pipedrive API will have a Lead Source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a Lead</a>. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
53
+ * Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
54
54
  * @param {Object} opts Optional parameters
55
55
  * @param {module:model/AddLeadRequest} opts.addLeadRequest
56
56
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OneLeadResponse200} and HTTP response
@@ -88,7 +88,7 @@ var LeadsApi = /*#__PURE__*/function () {
88
88
  }
89
89
  /**
90
90
  * Add a lead
91
- * Creates a Lead. A Lead always has to be linked to a Person or an Organization or both. All Leads created through the Pipedrive API will have a Lead Source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a Lead</a>. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
91
+ * Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source `API` assigned. Here's the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-lead\" target=\"_blank\" rel=\"noopener noreferrer\">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields' values tutorial</a>.
92
92
  * @param {Object} opts Optional parameters
93
93
  * @param {module:model/AddLeadRequest} opts.addLeadRequest
94
94
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OneLeadResponse200}
@@ -103,8 +103,8 @@ var LeadsApi = /*#__PURE__*/function () {
103
103
  }
104
104
  /**
105
105
  * Delete a lead
106
- * Deletes a specific Lead
107
- * @param {String} id The ID of the Lead
106
+ * Deletes a specific lead.
107
+ * @param {String} id The ID of the lead
108
108
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeadIdResponse200} and HTTP response
109
109
  */
110
110
 
@@ -146,8 +146,8 @@ var LeadsApi = /*#__PURE__*/function () {
146
146
  }
147
147
  /**
148
148
  * Delete a lead
149
- * Deletes a specific Lead
150
- * @param {String} id The ID of the Lead
149
+ * Deletes a specific lead.
150
+ * @param {String} id The ID of the lead
151
151
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeadIdResponse200}
152
152
  */
153
153
 
@@ -160,8 +160,8 @@ var LeadsApi = /*#__PURE__*/function () {
160
160
  }
161
161
  /**
162
162
  * Get one lead
163
- * Returns details of a specific Lead. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from Deals.
164
- * @param {String} id The ID of the Lead
163
+ * Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
164
+ * @param {String} id The ID of the lead
165
165
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OneLeadResponse200} and HTTP response
166
166
  */
167
167
 
@@ -203,8 +203,8 @@ var LeadsApi = /*#__PURE__*/function () {
203
203
  }
204
204
  /**
205
205
  * Get one lead
206
- * Returns details of a specific Lead. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from Deals.
207
- * @param {String} id The ID of the Lead
206
+ * Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.
207
+ * @param {String} id The ID of the lead
208
208
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OneLeadResponse200}
209
209
  */
210
210
 
@@ -217,11 +217,11 @@ var LeadsApi = /*#__PURE__*/function () {
217
217
  }
218
218
  /**
219
219
  * Get all leads
220
- * Returns multiple Leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals.
220
+ * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.
221
221
  * @param {Object} opts Optional parameters
222
222
  * @param {Number} opts.limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
223
223
  * @param {Number} opts.start For pagination, the position that represents the first result for the page
224
- * @param {module:model/String} opts.archivedStatus Filtering based on archived status of a Lead. If not provided, `All` is used.
224
+ * @param {module:model/String} opts.archivedStatus Filtering based on the archived status of a lead. If not provided, `All` is used.
225
225
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetLeadsResponse200} and HTTP response
226
226
  */
227
227
 
@@ -260,11 +260,11 @@ var LeadsApi = /*#__PURE__*/function () {
260
260
  }
261
261
  /**
262
262
  * Get all leads
263
- * Returns multiple Leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from Deals.
263
+ * Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.
264
264
  * @param {Object} opts Optional parameters
265
265
  * @param {Number} opts.limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
266
266
  * @param {Number} opts.start For pagination, the position that represents the first result for the page
267
- * @param {module:model/String} opts.archivedStatus Filtering based on archived status of a Lead. If not provided, `All` is used.
267
+ * @param {module:model/String} opts.archivedStatus Filtering based on the archived status of a lead. If not provided, `All` is used.
268
268
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetLeadsResponse200}
269
269
  */
270
270
 
@@ -277,8 +277,8 @@ var LeadsApi = /*#__PURE__*/function () {
277
277
  }
278
278
  /**
279
279
  * Update a lead
280
- * Updates one or more properties of a Lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from Deals. 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>.
281
- * @param {String} id The ID of the Lead
280
+ * Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. 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>.
281
+ * @param {String} id The ID of the lead
282
282
  * @param {Object} opts Optional parameters
283
283
  * @param {module:model/UpdateLeadRequest} opts.updateLeadRequest
284
284
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OneLeadResponse200} and HTTP response
@@ -322,8 +322,8 @@ var LeadsApi = /*#__PURE__*/function () {
322
322
  }
323
323
  /**
324
324
  * Update a lead
325
- * Updates one or more properties of a Lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a Lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the Lead, it won't appear in the response. Please note that Leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from Deals. 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>.
326
- * @param {String} id The ID of the Lead
325
+ * Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. 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>.
326
+ * @param {String} id The ID of the lead
327
327
  * @param {Object} opts Optional parameters
328
328
  * @param {module:model/UpdateLeadRequest} opts.updateLeadRequest
329
329
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OneLeadResponse200}
@@ -54,8 +54,8 @@ var MailboxApi = /*#__PURE__*/function () {
54
54
  }
55
55
  /**
56
56
  * Delete mail thread
57
- * Marks mail thread as deleted.
58
- * @param {Number} id ID of the mail thread
57
+ * Marks a mail thread as deleted.
58
+ * @param {Number} id The ID of the mail thread
59
59
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MailThreadDelete} and HTTP response
60
60
  */
61
61
 
@@ -98,8 +98,8 @@ var MailboxApi = /*#__PURE__*/function () {
98
98
  }
99
99
  /**
100
100
  * Delete mail thread
101
- * Marks mail thread as deleted.
102
- * @param {Number} id ID of the mail thread
101
+ * Marks a mail thread as deleted.
102
+ * @param {Number} id The ID of the mail thread
103
103
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MailThreadDelete}
104
104
  */
105
105
 
@@ -112,10 +112,10 @@ var MailboxApi = /*#__PURE__*/function () {
112
112
  }
113
113
  /**
114
114
  * Get one mail message
115
- * Returns data about specific mail message.
116
- * @param {Number} id ID of the mail message to fetch.
115
+ * Returns data about a specific mail message.
116
+ * @param {Number} id The ID of the mail message to fetch
117
117
  * @param {Object} opts Optional parameters
118
- * @param {module:model/NumberBooleanDefault0} opts.includeBody Whether to include full message body or not. `0` = Don't include, `1` = Include
118
+ * @param {module:model/NumberBooleanDefault0} opts.includeBody Whether to include the full message body or not. `0` = Don't include, `1` = Include
119
119
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MailMessage} and HTTP response
120
120
  */
121
121
 
@@ -159,10 +159,10 @@ var MailboxApi = /*#__PURE__*/function () {
159
159
  }
160
160
  /**
161
161
  * Get one mail message
162
- * Returns data about specific mail message.
163
- * @param {Number} id ID of the mail message to fetch.
162
+ * Returns data about a specific mail message.
163
+ * @param {Number} id The ID of the mail message to fetch
164
164
  * @param {Object} opts Optional parameters
165
- * @param {module:model/NumberBooleanDefault0} opts.includeBody Whether to include full message body or not. `0` = Don't include, `1` = Include
165
+ * @param {module:model/NumberBooleanDefault0} opts.includeBody Whether to include the full message body or not. `0` = Don't include, `1` = Include
166
166
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MailMessage}
167
167
  */
168
168
 
@@ -175,8 +175,8 @@ var MailboxApi = /*#__PURE__*/function () {
175
175
  }
176
176
  /**
177
177
  * Get one mail thread
178
- * Returns specific mail thread.
179
- * @param {Number} id ID of the mail thread
178
+ * Returns a specific mail thread.
179
+ * @param {Number} id The ID of the mail thread
180
180
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MailThreadOne} and HTTP response
181
181
  */
182
182
 
@@ -218,8 +218,8 @@ var MailboxApi = /*#__PURE__*/function () {
218
218
  }
219
219
  /**
220
220
  * Get one mail thread
221
- * Returns specific mail thread.
222
- * @param {Number} id ID of the mail thread
221
+ * Returns a specific mail thread.
222
+ * @param {Number} id The ID of the mail thread
223
223
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MailThreadOne}
224
224
  */
225
225
 
@@ -232,8 +232,8 @@ var MailboxApi = /*#__PURE__*/function () {
232
232
  }
233
233
  /**
234
234
  * Get all mail messages of mail thread
235
- * Get mail messages inside specified mail thread.
236
- * @param {Number} id ID of the mail thread
235
+ * Get all the mail messages inside a specified mail thread.
236
+ * @param {Number} id The ID of the mail thread
237
237
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MailThreadMessages} and HTTP response
238
238
  */
239
239
 
@@ -275,8 +275,8 @@ var MailboxApi = /*#__PURE__*/function () {
275
275
  }
276
276
  /**
277
277
  * Get all mail messages of mail thread
278
- * Get mail messages inside specified mail thread.
279
- * @param {Number} id ID of the mail thread
278
+ * Get all the mail messages inside a specified mail thread.
279
+ * @param {Number} id The ID of the mail thread
280
280
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MailThreadMessages}
281
281
  */
282
282
 
@@ -289,8 +289,8 @@ var MailboxApi = /*#__PURE__*/function () {
289
289
  }
290
290
  /**
291
291
  * Get mail threads
292
- * Returns mail threads in specified folder ordered by most recent message within.
293
- * @param {module:model/String} folder Type of folder to fetch.
292
+ * Returns mail threads in a specified folder ordered by the most recent message within.
293
+ * @param {module:model/String} folder The type of folder to fetch
294
294
  * @param {Object} opts Optional parameters
295
295
  * @param {Number} opts.start Pagination start (default to 0)
296
296
  * @param {Number} opts.limit Items shown per page
@@ -337,8 +337,8 @@ var MailboxApi = /*#__PURE__*/function () {
337
337
  }
338
338
  /**
339
339
  * Get mail threads
340
- * Returns mail threads in specified folder ordered by most recent message within.
341
- * @param {module:model/String} folder Type of folder to fetch.
340
+ * Returns mail threads in a specified folder ordered by the most recent message within.
341
+ * @param {module:model/String} folder The type of folder to fetch
342
342
  * @param {Object} opts Optional parameters
343
343
  * @param {Number} opts.start Pagination start (default to 0)
344
344
  * @param {Number} opts.limit Items shown per page
@@ -355,12 +355,12 @@ var MailboxApi = /*#__PURE__*/function () {
355
355
  /**
356
356
  * Update mail thread details
357
357
  * Updates the properties of a mail thread.
358
- * @param {Number} id ID of the mail thread
358
+ * @param {Number} id The ID of the mail thread
359
359
  * @param {Object} opts Optional parameters
360
360
  * @param {Number} opts.dealId The ID of the deal this thread is associated with
361
361
  * @param {String} opts.leadId The ID of the lead this thread is associated with
362
362
  * @param {module:model/NumberBoolean} opts.sharedFlag Whether this thread is shared with other users in your company
363
- * @param {module:model/NumberBoolean} opts.readFlag Whether this thread read or unread
363
+ * @param {module:model/NumberBoolean} opts.readFlag Whether this thread is read or unread
364
364
  * @param {module:model/NumberBoolean} opts.archivedFlag Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox.
365
365
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MailThreadPut} and HTTP response
366
366
  */
@@ -410,12 +410,12 @@ var MailboxApi = /*#__PURE__*/function () {
410
410
  /**
411
411
  * Update mail thread details
412
412
  * Updates the properties of a mail thread.
413
- * @param {Number} id ID of the mail thread
413
+ * @param {Number} id The ID of the mail thread
414
414
  * @param {Object} opts Optional parameters
415
415
  * @param {Number} opts.dealId The ID of the deal this thread is associated with
416
416
  * @param {String} opts.leadId The ID of the lead this thread is associated with
417
417
  * @param {module:model/NumberBoolean} opts.sharedFlag Whether this thread is shared with other users in your company
418
- * @param {module:model/NumberBoolean} opts.readFlag Whether this thread read or unread
418
+ * @param {module:model/NumberBoolean} opts.readFlag Whether this thread is read or unread
419
419
  * @param {module:model/NumberBoolean} opts.archivedFlag Whether this thread is archived or not. You can only archive threads that belong to Inbox folder. Archived threads will disappear from Inbox.
420
420
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MailThreadPut}
421
421
  */
@@ -40,7 +40,7 @@ var NoteFieldsApi = /*#__PURE__*/function () {
40
40
  }
41
41
  /**
42
42
  * Get all note fields
43
- * Returns data about all note fields
43
+ * Returns data about all note fields.
44
44
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NoteFieldsResponse} and HTTP response
45
45
  */
46
46
 
@@ -76,7 +76,7 @@ var NoteFieldsApi = /*#__PURE__*/function () {
76
76
  }
77
77
  /**
78
78
  * Get all note fields
79
- * Returns data about all note fields
79
+ * Returns data about all note fields.
80
80
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NoteFieldsResponse}
81
81
  */
82
82
 
@@ -112,7 +112,7 @@ var NotesApi = /*#__PURE__*/function () {
112
112
  /**
113
113
  * Add a comment to a note
114
114
  * Adds a new comment to a note.
115
- * @param {Number} id ID of the note
115
+ * @param {Number} id The ID of the note
116
116
  * @param {Object} opts Optional parameters
117
117
  * @param {module:model/CommentPostPutObject} opts.commentPostPutObject
118
118
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostComment} and HTTP response
@@ -157,7 +157,7 @@ var NotesApi = /*#__PURE__*/function () {
157
157
  /**
158
158
  * Add a comment to a note
159
159
  * Adds a new comment to a note.
160
- * @param {Number} id ID of the note
160
+ * @param {Number} id The ID of the note
161
161
  * @param {Object} opts Optional parameters
162
162
  * @param {module:model/CommentPostPutObject} opts.commentPostPutObject
163
163
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostComment}
@@ -173,8 +173,8 @@ var NotesApi = /*#__PURE__*/function () {
173
173
  /**
174
174
  * Delete a comment related to a note
175
175
  * Deletes a comment.
176
- * @param {Number} id ID of the note
177
- * @param {String} commentId ID of the comment
176
+ * @param {Number} id The ID of the note
177
+ * @param {String} commentId The ID of the comment
178
178
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteComment} and HTTP response
179
179
  */
180
180
 
@@ -223,8 +223,8 @@ var NotesApi = /*#__PURE__*/function () {
223
223
  /**
224
224
  * Delete a comment related to a note
225
225
  * Deletes a comment.
226
- * @param {Number} id ID of the note
227
- * @param {String} commentId ID of the comment
226
+ * @param {Number} id The ID of the note
227
+ * @param {String} commentId The ID of the comment
228
228
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteComment}
229
229
  */
230
230
 
@@ -238,7 +238,7 @@ var NotesApi = /*#__PURE__*/function () {
238
238
  /**
239
239
  * Delete a note
240
240
  * Deletes a specific note.
241
- * @param {Number} id ID of the note
241
+ * @param {Number} id The ID of the note
242
242
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteNote} and HTTP response
243
243
  */
244
244
 
@@ -281,7 +281,7 @@ var NotesApi = /*#__PURE__*/function () {
281
281
  /**
282
282
  * Delete a note
283
283
  * Deletes a specific note.
284
- * @param {Number} id ID of the note
284
+ * @param {Number} id The ID of the note
285
285
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteNote}
286
286
  */
287
287
 
@@ -294,9 +294,9 @@ var NotesApi = /*#__PURE__*/function () {
294
294
  }
295
295
  /**
296
296
  * Get one comment
297
- * Returns details about a comment
298
- * @param {Number} id ID of the note
299
- * @param {String} commentId ID of the comment
297
+ * Returns the details of a comment.
298
+ * @param {Number} id The ID of the note
299
+ * @param {String} commentId The ID of the comment
300
300
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostComment} and HTTP response
301
301
  */
302
302
 
@@ -344,9 +344,9 @@ var NotesApi = /*#__PURE__*/function () {
344
344
  }
345
345
  /**
346
346
  * Get one comment
347
- * Returns details about a comment
348
- * @param {Number} id ID of the note
349
- * @param {String} commentId ID of the comment
347
+ * Returns the details of a comment.
348
+ * @param {Number} id The ID of the note
349
+ * @param {String} commentId The ID of the comment
350
350
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostComment}
351
351
  */
352
352
 
@@ -360,7 +360,7 @@ var NotesApi = /*#__PURE__*/function () {
360
360
  /**
361
361
  * Get one note
362
362
  * Returns details about a specific note.
363
- * @param {Number} id ID of the note
363
+ * @param {Number} id The ID of the note
364
364
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostNote} and HTTP response
365
365
  */
366
366
 
@@ -403,7 +403,7 @@ var NotesApi = /*#__PURE__*/function () {
403
403
  /**
404
404
  * Get one note
405
405
  * Returns details about a specific note.
406
- * @param {Number} id ID of the note
406
+ * @param {Number} id The ID of the note
407
407
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostNote}
408
408
  */
409
409
 
@@ -416,8 +416,8 @@ var NotesApi = /*#__PURE__*/function () {
416
416
  }
417
417
  /**
418
418
  * Get all comments for a note
419
- * Returns all comments associated with a Note.
420
- * @param {Number} id ID of the note
419
+ * Returns all comments associated with a note.
420
+ * @param {Number} id The ID of the note
421
421
  * @param {Object} opts Optional parameters
422
422
  * @param {Number} opts.start Pagination start (default to 0)
423
423
  * @param {Number} opts.limit Items shown per page
@@ -465,8 +465,8 @@ var NotesApi = /*#__PURE__*/function () {
465
465
  }
466
466
  /**
467
467
  * Get all comments for a note
468
- * Returns all comments associated with a Note.
469
- * @param {Number} id ID of the note
468
+ * Returns all comments associated with a note.
469
+ * @param {Number} id The ID of the note
470
470
  * @param {Object} opts Optional parameters
471
471
  * @param {Number} opts.start Pagination start (default to 0)
472
472
  * @param {Number} opts.limit Items shown per page
@@ -488,16 +488,16 @@ var NotesApi = /*#__PURE__*/function () {
488
488
  * @param {String} opts.leadId The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
489
489
  * @param {Number} opts.dealId The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
490
490
  * @param {Number} opts.personId The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
491
- * @param {Number} opts.orgId The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned
491
+ * @param {Number} opts.orgId The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
492
492
  * @param {Number} opts.start Pagination start (default to 0)
493
493
  * @param {Number} opts.limit Items shown per page
494
- * @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`, `content`, `add_time`, `update_time`.
495
- * @param {Date} opts.startDate Date in format of YYYY-MM-DD from which notes to fetch.
496
- * @param {Date} opts.endDate Date in format of YYYY-MM-DD until which notes to fetch to.
497
- * @param {module:model/NumberBoolean} opts.pinnedToLeadFlag If set, then results are filtered by note to lead pinning state
498
- * @param {module:model/NumberBoolean} opts.pinnedToDealFlag If set, then results are filtered by note to deal pinning state
499
- * @param {module:model/NumberBoolean} opts.pinnedToOrganizationFlag If set, then results are filtered by note to organization pinning state
500
- * @param {module:model/NumberBoolean} opts.pinnedToPersonFlag If set, then results are filtered by note to person pinning state
494
+ * @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`, `content`, `add_time`, `update_time`.
495
+ * @param {Date} opts.startDate The date in format of YYYY-MM-DD from which notes to fetch
496
+ * @param {Date} opts.endDate The date in format of YYYY-MM-DD until which notes to fetch to
497
+ * @param {module:model/NumberBoolean} opts.pinnedToLeadFlag If set, the results are filtered by note to lead pinning state
498
+ * @param {module:model/NumberBoolean} opts.pinnedToDealFlag If set, the results are filtered by note to deal pinning state
499
+ * @param {module:model/NumberBoolean} opts.pinnedToOrganizationFlag If set, the results are filtered by note to organization pinning state
500
+ * @param {module:model/NumberBoolean} opts.pinnedToPersonFlag If set, the results are filtered by note to person pinning state
501
501
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetNotes} and HTTP response
502
502
  */
503
503
 
@@ -553,16 +553,16 @@ var NotesApi = /*#__PURE__*/function () {
553
553
  * @param {String} opts.leadId The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
554
554
  * @param {Number} opts.dealId The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
555
555
  * @param {Number} opts.personId The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
556
- * @param {Number} opts.orgId The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned
556
+ * @param {Number} opts.orgId The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
557
557
  * @param {Number} opts.start Pagination start (default to 0)
558
558
  * @param {Number} opts.limit Items shown per page
559
- * @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`, `content`, `add_time`, `update_time`.
560
- * @param {Date} opts.startDate Date in format of YYYY-MM-DD from which notes to fetch.
561
- * @param {Date} opts.endDate Date in format of YYYY-MM-DD until which notes to fetch to.
562
- * @param {module:model/NumberBoolean} opts.pinnedToLeadFlag If set, then results are filtered by note to lead pinning state
563
- * @param {module:model/NumberBoolean} opts.pinnedToDealFlag If set, then results are filtered by note to deal pinning state
564
- * @param {module:model/NumberBoolean} opts.pinnedToOrganizationFlag If set, then results are filtered by note to organization pinning state
565
- * @param {module:model/NumberBoolean} opts.pinnedToPersonFlag If set, then results are filtered by note to person pinning state
559
+ * @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`, `content`, `add_time`, `update_time`.
560
+ * @param {Date} opts.startDate The date in format of YYYY-MM-DD from which notes to fetch
561
+ * @param {Date} opts.endDate The date in format of YYYY-MM-DD until which notes to fetch to
562
+ * @param {module:model/NumberBoolean} opts.pinnedToLeadFlag If set, the results are filtered by note to lead pinning state
563
+ * @param {module:model/NumberBoolean} opts.pinnedToDealFlag If set, the results are filtered by note to deal pinning state
564
+ * @param {module:model/NumberBoolean} opts.pinnedToOrganizationFlag If set, the results are filtered by note to organization pinning state
565
+ * @param {module:model/NumberBoolean} opts.pinnedToPersonFlag If set, the results are filtered by note to person pinning state
566
566
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetNotes}
567
567
  */
568
568
 
@@ -576,8 +576,8 @@ var NotesApi = /*#__PURE__*/function () {
576
576
  /**
577
577
  * Update a comment related to a note
578
578
  * Updates a comment related to a note.
579
- * @param {Number} id ID of the note
580
- * @param {String} commentId ID of the comment
579
+ * @param {Number} id The ID of the note
580
+ * @param {String} commentId The ID of the comment
581
581
  * @param {Object} opts Optional parameters
582
582
  * @param {module:model/CommentPostPutObject} opts.commentPostPutObject
583
583
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostComment} and HTTP response
@@ -628,8 +628,8 @@ var NotesApi = /*#__PURE__*/function () {
628
628
  /**
629
629
  * Update a comment related to a note
630
630
  * Updates a comment related to a note.
631
- * @param {Number} id ID of the note
632
- * @param {String} commentId ID of the comment
631
+ * @param {Number} id The ID of the note
632
+ * @param {String} commentId The ID of the comment
633
633
  * @param {Object} opts Optional parameters
634
634
  * @param {module:model/CommentPostPutObject} opts.commentPostPutObject
635
635
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostComment}
@@ -645,7 +645,7 @@ var NotesApi = /*#__PURE__*/function () {
645
645
  /**
646
646
  * Update a note
647
647
  * Updates a note.
648
- * @param {Number} id ID of the note
648
+ * @param {Number} id The ID of the note
649
649
  * @param {Object} opts Optional parameters
650
650
  * @param {module:model/Note} opts.note
651
651
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostNote} and HTTP response
@@ -690,7 +690,7 @@ var NotesApi = /*#__PURE__*/function () {
690
690
  /**
691
691
  * Update a note
692
692
  * Updates a note.
693
- * @param {Number} id ID of the note
693
+ * @param {Number} id The ID of the note
694
694
  * @param {Object} opts Optional parameters
695
695
  * @param {module:model/Note} opts.note
696
696
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostNote}
@@ -104,7 +104,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
104
104
  /**
105
105
  * Delete an organization field
106
106
  * 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>.
107
- * @param {Number} id ID of the field
107
+ * @param {Number} id The ID of the field
108
108
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteResponse} and HTTP response
109
109
  */
110
110
 
@@ -147,7 +147,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
147
147
  /**
148
148
  * Delete an organization field
149
149
  * 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>.
150
- * @param {Number} id ID of the field
150
+ * @param {Number} id The ID of the field
151
151
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteResponse}
152
152
  */
153
153
 
@@ -161,7 +161,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
161
161
  /**
162
162
  * Delete multiple organization fields in bulk
163
163
  * Marks multiple fields as deleted.
164
- * @param {String} ids Comma-separated field IDs to delete
164
+ * @param {String} ids The comma-separated field IDs to delete
165
165
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BulkDeleteResponse} and HTTP response
166
166
  */
167
167
 
@@ -204,7 +204,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
204
204
  /**
205
205
  * Delete multiple organization fields in bulk
206
206
  * Marks multiple fields as deleted.
207
- * @param {String} ids Comma-separated field IDs to delete
207
+ * @param {String} ids The comma-separated field IDs to delete
208
208
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BulkDeleteResponse}
209
209
  */
210
210
 
@@ -218,7 +218,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
218
218
  /**
219
219
  * Get one organization field
220
220
  * Returns data about a specific organization field.
221
- * @param {Number} id ID of the field
221
+ * @param {Number} id The ID of the field
222
222
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FieldResponse} and HTTP response
223
223
  */
224
224
 
@@ -261,7 +261,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
261
261
  /**
262
262
  * Get one organization field
263
263
  * Returns data about a specific organization field.
264
- * @param {Number} id ID of the field
264
+ * @param {Number} id The ID of the field
265
265
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FieldResponse}
266
266
  */
267
267
 
@@ -274,7 +274,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
274
274
  }
275
275
  /**
276
276
  * Get all organization fields
277
- * Returns data about all organization fields
277
+ * Returns data about all organization fields.
278
278
  * @param {Object} opts Optional parameters
279
279
  * @param {Number} opts.start Pagination start (default to 0)
280
280
  * @param {Number} opts.limit Items shown per page
@@ -315,7 +315,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
315
315
  }
316
316
  /**
317
317
  * Get all organization fields
318
- * Returns data about all organization fields
318
+ * Returns data about all organization fields.
319
319
  * @param {Object} opts Optional parameters
320
320
  * @param {Number} opts.start Pagination start (default to 0)
321
321
  * @param {Number} opts.limit Items shown per page
@@ -332,7 +332,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
332
332
  /**
333
333
  * Update an organization field
334
334
  * Updates an organization 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>.
335
- * @param {Number} id ID of the field
335
+ * @param {Number} id The ID of the field
336
336
  * @param {Object} opts Optional parameters
337
337
  * @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
338
338
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FieldResponse} and HTTP response
@@ -377,7 +377,7 @@ var OrganizationFieldsApi = /*#__PURE__*/function () {
377
377
  /**
378
378
  * Update an organization field
379
379
  * Updates an organization 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>.
380
- * @param {Number} id ID of the field
380
+ * @param {Number} id The ID of the field
381
381
  * @param {Object} opts Optional parameters
382
382
  * @param {module:model/FieldUpdateRequest} opts.fieldUpdateRequest
383
383
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FieldResponse}