pipedrive 13.0.11 → 13.1.2
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +18 -0
- package/README.md +23 -20
- package/dist/ApiClient.js +46 -9
- package/dist/api/ActivitiesApi.js +44 -44
- package/dist/api/ActivityTypesApi.js +36 -36
- package/dist/api/CallLogsApi.js +23 -6
- package/dist/api/CurrenciesApi.js +2 -2
- package/dist/api/DealFieldsApi.js +18 -18
- package/dist/api/DealsApi.js +122 -110
- package/dist/api/FilesApi.js +38 -38
- package/dist/api/FiltersApi.js +23 -6
- package/dist/api/GlobalMessagesApi.js +8 -8
- package/dist/api/GoalsApi.js +54 -54
- package/dist/api/ItemSearchApi.js +6 -6
- package/dist/api/LeadLabelsApi.js +21 -12
- package/dist/api/LeadSourcesApi.js +2 -2
- package/dist/api/LeadsApi.js +23 -18
- package/dist/api/MailboxApi.js +26 -26
- package/dist/api/NoteFieldsApi.js +2 -2
- package/dist/api/NotesApi.js +50 -42
- package/dist/api/OrganizationFieldsApi.js +16 -16
- package/dist/api/OrganizationRelationshipsApi.js +25 -12
- package/dist/api/OrganizationsApi.js +64 -56
- package/dist/api/PermissionSetsApi.js +12 -12
- package/dist/api/PersonFieldsApi.js +16 -16
- package/dist/api/PersonsApi.js +92 -84
- package/dist/api/PipelinesApi.js +50 -50
- package/dist/api/ProductFieldsApi.js +29 -16
- package/dist/api/ProductsApi.js +50 -46
- package/dist/api/RecentsApi.js +6 -6
- package/dist/api/RolesApi.js +38 -38
- package/dist/api/StagesApi.js +14 -14
- package/dist/api/SubscriptionsApi.js +76 -34
- package/dist/api/TeamsApi.js +49 -32
- package/dist/api/UserConnectionsApi.js +2 -2
- package/dist/api/UserSettingsApi.js +2 -2
- package/dist/api/UsersApi.js +44 -44
- package/dist/api/WebhooksApi.js +27 -14
- package/dist/index.js +24 -0
- package/dist/model/ActivityDistributionDataActivityDistribution.js +1 -1
- package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.js +4 -4
- package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERIDActivities.js +2 -2
- package/dist/model/ActivityInfo.js +5 -5
- package/dist/model/ActivityObjectFragment.js +9 -9
- package/dist/model/ActivityPostObject.js +32 -32
- package/dist/model/ActivityPostObjectAllOf.js +7 -7
- package/dist/model/ActivityPutObject.js +32 -32
- package/dist/model/ActivityPutObjectAllOf.js +7 -7
- package/dist/model/ActivityResponseObject.js +96 -96
- package/dist/model/ActivityResponseObjectAllOf.js +39 -39
- package/dist/model/ActivityTypeBulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/ActivityTypeListResponse.js +2 -2
- package/dist/model/ActivityTypeListResponseAllOf.js +1 -1
- package/dist/model/ActivityTypeObjectResponse.js +9 -9
- package/dist/model/AddDealFollowerRequest.js +2 -2
- package/dist/model/AddDealParticipantRequest.js +2 -2
- package/dist/model/AddFollowerToPersonResponseAllOfData.js +4 -4
- package/dist/model/AddLeadLabelRequest.js +2 -2
- package/dist/model/AddLeadRequest.js +9 -9
- package/dist/model/AddNoteRequest.js +22 -22
- package/dist/model/AddNoteRequestAllOf.js +4 -4
- package/dist/model/AddOrganizationRelationshipRequest.js +5 -5
- package/dist/model/AddPersonFollowerRequest.js +2 -2
- package/dist/model/AddProductAttachmentDetails.js +36 -36
- package/dist/model/AddProductAttachmentDetailsAllOf.js +1 -1
- package/dist/model/AddProductFollowerRequest.js +2 -2
- package/dist/model/AddProductRequestBody.js +12 -12
- package/dist/model/AddTeamUserRequest.js +2 -2
- package/dist/model/AddWebhookRequest.js +7 -7
- package/dist/model/AddedDealFollowerData.js +4 -4
- package/dist/model/AdditionalBaseOrganizationItemInfo.js +64 -64
- package/dist/model/AdditionalDataWithPagination.js +1 -1
- package/dist/model/AdditionalMergePersonInfo.js +60 -60
- package/dist/model/AdditionalPersonInfo.js +50 -50
- package/dist/model/AllOrganizationRelationshipsGetResponse.js +2 -2
- package/dist/model/AllOrganizationRelationshipsGetResponseAllOf.js +1 -1
- package/dist/model/AllOrganizationsGetResponse.js +2 -2
- package/dist/model/AllOrganizationsGetResponseAllOf.js +1 -1
- package/dist/model/Assignee.js +3 -3
- package/dist/model/BaseComment.js +7 -7
- package/dist/model/BaseCurrency.js +7 -7
- package/dist/model/BaseDeal.js +51 -51
- package/dist/model/BaseNote.js +14 -14
- package/dist/model/BaseNoteDealTitle.js +2 -2
- package/dist/model/BaseNoteOrganization.js +2 -2
- package/dist/model/BaseNotePerson.js +2 -2
- package/dist/model/BaseOrganizationItem.js +86 -86
- package/dist/model/BaseOrganizationItemFields.js +11 -11
- package/dist/model/BaseOrganizationItemWithEditNameFlag.js +88 -88
- package/dist/model/BaseOrganizationItemWithEditNameFlagAllOf.js +1 -1
- package/dist/model/BaseOrganizationRelationshipItem.js +5 -5
- package/dist/model/BasePersonItem.js +13 -13
- package/dist/model/BasePersonItemEmail.js +2 -2
- package/dist/model/BasePersonItemPhone.js +3 -3
- package/dist/model/BasePipeline.js +8 -8
- package/dist/model/BasePipelineWithSelectedFlag.js +18 -18
- package/dist/model/BasePipelineWithSelectedFlagAllOf.js +1 -1
- package/dist/model/BaseProduct.js +3 -3
- package/dist/model/BaseRole.js +3 -3
- package/dist/model/BaseStage.js +10 -10
- package/dist/model/BaseTeam.js +20 -20
- package/dist/model/BaseTeamAdditionalProperties.js +2 -2
- package/dist/model/BaseUser.js +19 -19
- package/dist/model/BaseUserMe.js +48 -48
- package/dist/model/BaseUserMeAllOf.js +5 -5
- package/dist/model/BaseUserMeAllOfLanguage.js +1 -1
- package/dist/model/BaseWebhook.js +3 -3
- package/dist/model/BasicDeal.js +10 -10
- package/dist/model/BasicDealProduct.js +6 -6
- package/dist/model/BasicGoal.js +6 -6
- package/dist/model/BasicOrganization.js +3 -3
- package/dist/model/BasicPerson.js +23 -10
- package/dist/model/BasicPersonEmail.js +112 -0
- package/dist/model/BasicProductField.js +3 -3
- package/dist/model/BulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/CalculatedFields.js +2 -2
- package/dist/model/CallLogObject.js +6 -6
- package/dist/model/CommentPostPutObject.js +2 -2
- package/dist/model/CreateTeam.js +6 -6
- package/dist/model/Currencies.js +1 -1
- package/dist/model/DealCountAndActivityInfo.js +26 -26
- package/dist/model/DealFlowResponseAllOfData.js +1 -1
- package/dist/model/DealListActivitiesResponse.js +2 -2
- package/dist/model/DealListActivitiesResponseAllOf.js +1 -1
- package/dist/model/DealNonStrict.js +104 -104
- package/dist/model/DealNonStrictModeFields.js +1 -1
- package/dist/model/DealNonStrictModeFieldsCreatorUserId.js +6 -6
- package/dist/model/DealNonStrictWithDetails.js +110 -110
- package/dist/model/DealNonStrictWithDetailsAllOf.js +3 -3
- package/dist/model/DealNonStrictWithDetailsAllOfAge.js +1 -1
- package/dist/model/DealNonStrictWithDetailsAllOfAverageTimeToWon.js +1 -1
- package/dist/model/DealNonStrictWithDetailsAllOfStayInPipelineStages.js +3 -3
- package/dist/model/DealOrganizationData.js +7 -7
- package/dist/model/DealOrganizationDataWithId.js +14 -14
- package/dist/model/DealOrganizationDataWithIdAllOf.js +1 -1
- package/dist/model/DealParticipantCountInfo.js +2 -2
- package/dist/model/DealParticipants.js +1 -1
- package/dist/model/DealPersonData.js +10 -10
- package/dist/model/DealPersonDataEmail.js +112 -0
- package/dist/model/DealPersonDataPhone.js +1 -1
- package/dist/model/DealPersonDataWithId.js +17 -17
- package/dist/model/DealPersonDataWithIdAllOf.js +1 -1
- package/dist/model/DealSearchItemItem.js +8 -8
- package/dist/model/DealSearchItemItemOrganization.js +2 -2
- package/dist/model/DealSearchItemItemOwner.js +1 -1
- package/dist/model/DealSearchItemItemPerson.js +2 -2
- package/dist/model/DealSearchItemItemStage.js +2 -2
- package/dist/model/DealSearchResponseAllOfData.js +1 -1
- package/dist/model/DealStrict.js +112 -112
- package/dist/model/DealStrictModeFields.js +5 -5
- package/dist/model/DealStrictWithMergeId.js +114 -114
- package/dist/model/DealStrictWithMergeIdAllOf.js +1 -1
- package/dist/model/DealSummaryPerStages.js +1 -1
- package/dist/model/DealTitleParameter.js +1 -1
- package/dist/model/DealUserData.js +7 -7
- package/dist/model/DealUserDataWithId.js +14 -14
- package/dist/model/DealUserDataWithIdAllOf.js +1 -1
- package/dist/model/DealsCountAndActivityInfo.js +26 -26
- package/dist/model/DealsCountInfo.js +8 -8
- package/dist/model/DealsMovementsInfo.js +2 -2
- package/dist/model/DealsMovementsInfoFormattedValues.js +2 -2
- package/dist/model/DealsMovementsInfoValues.js +2 -2
- package/dist/model/DeleteActivitiesResponse200Data.js +1 -1
- package/dist/model/DeleteActivityResponse200Data.js +1 -1
- package/dist/model/DeleteDealData.js +1 -1
- package/dist/model/DeleteDealFollowerData.js +1 -1
- package/dist/model/DeleteDealParticipantData.js +1 -1
- package/dist/model/DeleteDealProductData.js +2 -2
- package/dist/model/DeleteFileData.js +1 -1
- package/dist/model/DeleteMultipleDealsData.js +1 -1
- package/dist/model/DeleteMultipleProductFieldsResponseData.js +1 -1
- package/dist/model/DeletePersonResponseAllOfData.js +1 -1
- package/dist/model/DeletePersonsInBulkResponseAllOfData.js +1 -1
- package/dist/model/DeleteProductFieldResponseData.js +1 -1
- package/dist/model/DeleteProductFollowerResponseData.js +1 -1
- package/dist/model/DeleteProductResponseData.js +1 -1
- package/dist/model/DeleteResponseAllOfData.js +1 -1
- package/dist/model/DeleteRoleAllOfData.js +1 -1
- package/dist/model/DeleteRoleAssignmentAllOfData.js +1 -1
- package/dist/model/DeleteStageResponse200Data.js +1 -1
- package/dist/model/DeleteStagesResponse200Data.js +1 -1
- package/dist/model/DeleteTeamUserRequest.js +2 -2
- package/dist/model/Duration.js +3 -3
- package/dist/model/EditPipeline.js +2 -2
- package/dist/model/EditPipelineAllOf.js +1 -1
- package/dist/model/EmailInfo.js +2 -2
- package/dist/model/ExpectedOutcome.js +3 -3
- package/dist/model/Field.js +18 -18
- package/dist/model/FieldCreateRequest.js +5 -5
- package/dist/model/FieldCreateRequestAllOf.js +3 -3
- package/dist/model/FieldUpdateRequest.js +1 -1
- package/dist/model/FileData.js +24 -24
- package/dist/model/FileItem.js +24 -24
- package/dist/model/FiltersPostResponseAllOfData.js +1 -1
- package/dist/model/FullRole.js +12 -12
- package/dist/model/FullRoleAllOf.js +1 -1
- package/dist/model/GetAddProductAttachementDetails.js +1 -1
- package/dist/model/GetAddedDeal.js +1 -1
- package/dist/model/GetAddedDealAdditionalData.js +1 -1
- package/dist/model/GetAllPersonsResponse.js +2 -2
- package/dist/model/GetAllPersonsResponseAllOf.js +1 -1
- package/dist/model/GetAllProductFieldsResponse.js +2 -2
- package/dist/model/GetComments.js +1 -1
- package/dist/model/GetDealAdditionalData.js +1 -1
- package/dist/model/GetDeals.js +1 -1
- package/dist/model/GetDealsConversionRatesInPipelineAllOfData.js +4 -4
- package/dist/model/GetDealsMovementsInPipelineAllOfData.js +1 -1
- package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.js +3 -3
- package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.js +3 -3
- package/dist/model/GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.js +2 -2
- package/dist/model/GetDealsSummaryData.js +6 -6
- package/dist/model/GetDealsSummaryDataValuesTotal.js +6 -6
- package/dist/model/GetDealsSummaryDataWeightedValuesTotal.js +4 -4
- package/dist/model/GetDealsTimelineData.js +1 -1
- package/dist/model/GetDealsTimelineDataTotals.js +9 -9
- package/dist/model/GetDuplicatedDeal.js +1 -1
- package/dist/model/GetLeadSourcesResponse200Data.js +1 -1
- package/dist/model/GetNotes.js +1 -1
- package/dist/model/GetPersonDetailsResponseAllOfAdditionalData.js +1 -1
- package/dist/model/GetProductAttachementDetails.js +1 -1
- package/dist/model/GetProductFieldResponse.js +1 -1
- package/dist/model/GetRecentsAdditionalData.js +2 -2
- package/dist/model/GetRoleAllOfAdditionalData.js +1 -1
- package/dist/model/GetRoleAssignments.js +2 -2
- package/dist/model/GetRoleAssignmentsAllOf.js +1 -1
- package/dist/model/GetRoles.js +2 -2
- package/dist/model/GetRolesAllOf.js +1 -1
- package/dist/model/GetStageDeals.js +1 -1
- package/dist/model/GetStages.js +1 -1
- package/dist/model/GlobalMessageData.js +6 -6
- package/dist/model/GlobalMessageGet.js +2 -2
- package/dist/model/GlobalMessageGetAllOf.js +1 -1
- package/dist/model/GlobalMessageUserData.js +3 -3
- package/dist/model/GoalResults.js +1 -1
- package/dist/model/GoalType.js +2 -2
- package/dist/model/GoalsResponseComponent.js +4 -4
- package/dist/model/LeadLabelResponse.js +4 -4
- package/dist/model/LeadResponse.js +16 -16
- package/dist/model/LeadValue.js +1 -1
- package/dist/model/ListActivitiesResponse.js +2 -2
- package/dist/model/ListActivitiesResponseAllOf.js +1 -1
- package/dist/model/ListDealsResponse.js +2 -2
- package/dist/model/ListDealsResponseAllOf.js +1 -1
- package/dist/model/ListFilesResponse.js +2 -2
- package/dist/model/ListFilesResponseAllOf.js +1 -1
- package/dist/model/ListFollowersResponse.js +2 -2
- package/dist/model/ListFollowersResponseAllOf.js +1 -1
- package/dist/model/ListFollowersResponseAllOfData.js +4 -4
- package/dist/model/ListMailMessagesResponse.js +2 -2
- package/dist/model/ListMailMessagesResponseAllOf.js +1 -1
- package/dist/model/ListPermittedUsersResponse1.js +2 -2
- package/dist/model/ListPermittedUsersResponse1AllOf.js +1 -1
- package/dist/model/ListPermittedUsersResponseAllOfData.js +1 -1
- package/dist/model/ListPersonProductsResponse.js +2 -2
- package/dist/model/ListPersonProductsResponseAllOf.js +1 -1
- package/dist/model/ListPersonsResponse.js +2 -2
- package/dist/model/ListPersonsResponseAllOf.js +1 -1
- package/dist/model/ListProductAdditionalData.js +10 -10
- package/dist/model/ListProductAdditionalDataAllOf.js +5 -5
- package/dist/model/ListProductFollowersResponse.js +2 -2
- package/dist/model/ListProductFollowersResponseAllOf.js +1 -1
- package/dist/model/ListProductFollowersResponseAllOfData.js +4 -4
- package/dist/model/ListProductsResponseAllOfData.js +1 -1
- package/dist/model/MarketingStatus.js +69 -0
- package/dist/model/MergeDealsRequest.js +2 -2
- package/dist/model/MergeOrganizationsRequest.js +2 -2
- package/dist/model/MergePersonDealRelatedInfo.js +30 -30
- package/dist/model/MergePersonItem.js +86 -86
- package/dist/model/MergePersonsRequest.js +2 -2
- package/dist/model/NewDeal.js +25 -25
- package/dist/model/NewDealAllOf.js +1 -1
- package/dist/model/NewDealProduct.js +16 -16
- package/dist/model/NewDealProductAllOf.js +2 -2
- package/dist/model/NewFollowerResponseData.js +4 -4
- package/dist/model/NewGoal.js +12 -12
- package/dist/model/NewOrganization.js +9 -9
- package/dist/model/NewOrganizationAllOf.js +1 -1
- package/dist/model/NewPerson.js +40 -21
- package/dist/model/NewPersonAllOf.js +1 -1
- package/dist/model/NewProductField.js +4 -4
- package/dist/model/Note.js +19 -19
- package/dist/model/NoteConnectToParams.js +2 -2
- package/dist/model/NoteCreatorUser.js +5 -5
- package/dist/model/NoteField.js +7 -7
- package/dist/model/NoteParams.js +7 -7
- package/dist/model/OrganizationAddressInfo.js +11 -11
- package/dist/model/OrganizationCountAndAddressInfo.js +38 -38
- package/dist/model/OrganizationCountInfo.js +8 -8
- package/dist/model/OrganizationData.js +5 -5
- package/dist/model/OrganizationDataWithId.js +13 -13
- package/dist/model/OrganizationDataWithIdAllOf.js +1 -1
- package/dist/model/OrganizationDataWithIdAndActiveFlag.js +15 -15
- package/dist/model/OrganizationDataWithIdAndActiveFlagAllOf.js +1 -1
- package/dist/model/OrganizationDeleteResponseData.js +1 -1
- package/dist/model/OrganizationDetailsGetResponseAllOfAdditionalData.js +1 -1
- package/dist/model/OrganizationFlowResponseAllOfData.js +1 -1
- package/dist/model/OrganizationFollowerDeleteResponseData.js +1 -1
- package/dist/model/OrganizationFollowerItem.js +2 -2
- package/dist/model/OrganizationFollowerItemAllOf.js +1 -1
- package/dist/model/OrganizationItem.js +88 -88
- package/dist/model/OrganizationRelationship.js +1 -1
- package/dist/model/OrganizationRelationshipDeleteResponseAllOfData.js +1 -1
- package/dist/model/OrganizationRelationshipDetails.js +16 -16
- package/dist/model/OrganizationRelationshipWithCalculatedFields.js +14 -14
- package/dist/model/OrganizationSearchItemItem.js +5 -5
- package/dist/model/OrganizationsDeleteResponseData.js +1 -1
- package/dist/model/OrganizationsMergeResponseData.js +1 -1
- package/dist/model/Owner.js +12 -12
- package/dist/model/Params.js +2 -2
- package/dist/model/PaymentItem.js +13 -13
- package/dist/model/PermissionSets.js +2 -2
- package/dist/model/PermissionSetsAllOf.js +1 -1
- package/dist/model/PermissionSetsItem.js +3 -3
- package/dist/model/PersonCountAndEmailInfo.js +18 -18
- package/dist/model/PersonCountEmailDealAndActivityInfo.js +44 -44
- package/dist/model/PersonCountInfo.js +7 -7
- package/dist/model/PersonData.js +5 -5
- package/dist/model/PersonDataEmail.js +2 -2
- package/dist/model/PersonDataPhone.js +2 -2
- package/dist/model/PersonDataWithActiveFlag.js +13 -13
- package/dist/model/PersonDataWithActiveFlagAllOf.js +1 -1
- package/dist/model/PersonFlowResponseAllOfData.js +1 -1
- package/dist/model/PersonItem.js +76 -76
- package/dist/model/PersonListProduct.js +14 -14
- package/dist/model/PersonNameCountAndEmailInfo.js +24 -24
- package/dist/model/PersonNameCountAndEmailInfoWithIds.js +30 -30
- package/dist/model/PersonNameCountAndEmailInfoWithIdsAllOf.js +3 -3
- package/dist/model/PersonNameInfo.js +3 -3
- package/dist/model/PersonNameInfoWithOrgAndOwnerId.js +6 -6
- package/dist/model/PersonSearchItemItem.js +4 -4
- package/dist/model/PersonSearchItemItemOrganization.js +2 -2
- package/dist/model/PersonSearchItemItemOwner.js +1 -1
- package/dist/model/PictureData.js +2 -2
- package/dist/model/PictureDataWithID.js +4 -4
- package/dist/model/PictureDataWithValue.js +4 -4
- package/dist/model/Pipeline.js +4 -4
- package/dist/model/PipelineDetails.js +19 -19
- package/dist/model/PostDealParticipants.js +1 -1
- package/dist/model/PostRoleAssignmentAllOfData.js +2 -2
- package/dist/model/PostRoleSettingsAllOfData.js +1 -1
- package/dist/model/PostRolesAllOfData.js +1 -1
- package/dist/model/ProductAttachementFields.js +12 -12
- package/dist/model/ProductAttachmentDetails.js +35 -35
- package/dist/model/ProductBaseDeal.js +42 -42
- package/dist/model/ProductField.js +36 -36
- package/dist/model/ProductFieldAllOf.js +15 -15
- package/dist/model/ProductListItem.js +21 -21
- package/dist/model/ProductRequest.js +6 -6
- package/dist/model/ProductSearchItemItem.js +5 -5
- package/dist/model/ProductSearchItemItemOwner.js +1 -1
- package/dist/model/ProductWithArrayPrices.js +6 -6
- package/dist/model/ProductWithObjectPrices.js +6 -6
- package/dist/model/ProductsResponse.js +1 -1
- package/dist/model/RecentDataProduct.js +15 -15
- package/dist/model/RelatedDealDataDEALID.js +8 -8
- package/dist/model/RelatedOrganizationName.js +1 -1
- package/dist/model/RelatedPersonData.js +1 -1
- package/dist/model/RelationshipOrganizationInfoItem.js +12 -12
- package/dist/model/RelationshipOrganizationInfoItemAllOf.js +1 -1
- package/dist/model/RelationshipOrganizationInfoItemWithActiveFlag.js +14 -14
- package/dist/model/RequredTitleParameter.js +2 -2
- package/dist/model/ResponseCallLogObject.js +14 -14
- package/dist/model/ResponseCallLogObjectAllOf.js +1 -1
- package/dist/model/RoleAssignment.js +11 -11
- package/dist/model/RoleAssignmentAllOf.js +3 -3
- package/dist/model/RoleSettings.js +10 -10
- package/dist/model/RolesAdditionalData.js +1 -1
- package/dist/model/RolesAdditionalDataPagination.js +1 -1
- package/dist/model/SinglePermissionSetsItem.js +8 -8
- package/dist/model/SinglePermissionSetsItemAllOf.js +1 -1
- package/dist/model/Stage.js +5 -5
- package/dist/model/StageConversions.js +3 -3
- package/dist/model/StageDetails.js +21 -21
- package/dist/model/StageWithPipelineInfo.js +24 -24
- package/dist/model/StageWithPipelineInfoAllOf.js +2 -2
- package/dist/model/SubRole.js +10 -10
- package/dist/model/SubRoleAllOf.js +3 -3
- package/dist/model/SubscriptionInstallmentCreateRequest.js +5 -5
- package/dist/model/SubscriptionInstallmentUpdateRequest.js +1 -1
- package/dist/model/SubscriptionItem.js +15 -15
- package/dist/model/SubscriptionRecurringCancelRequest.js +1 -1
- package/dist/model/SubscriptionRecurringCreateRequest.js +14 -14
- package/dist/model/SubscriptionRecurringUpdateRequest.js +3 -3
- package/dist/model/TeamId.js +1 -1
- package/dist/model/UpdateDealRequest.js +22 -22
- package/dist/model/UpdateLeadLabelRequest.js +1 -1
- package/dist/model/UpdateLeadRequest.js +9 -9
- package/dist/model/UpdateStageRequest.js +10 -10
- package/dist/model/UpdateTeam.js +14 -14
- package/dist/model/UpdateTeamAllOf.js +2 -2
- package/dist/model/UpdateTeamWithAdditionalProperties.js +18 -18
- package/dist/model/UserAssignmentToPermissionSet.js +4 -4
- package/dist/model/UserAssignmentsToPermissionSet.js +2 -2
- package/dist/model/UserAssignmentsToPermissionSetAllOf.js +1 -1
- package/dist/model/UserData.js +6 -6
- package/dist/model/UserDataWithId.js +12 -12
- package/dist/model/UserIDs.js +2 -2
- package/dist/model/UserIDsAllOf.js +1 -1
- package/dist/model/UserPermissionsItem.js +31 -31
- package/dist/model/UserSettingsItem.js +5 -5
- package/package.json +3 -2
package/dist/api/DealsApi.js
CHANGED
@@ -106,7 +106,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
106
106
|
}
|
107
107
|
/**
|
108
108
|
* Add a deal
|
109
|
-
* Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information
|
109
|
+
* Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
110
110
|
* @param {Object} opts Optional parameters
|
111
111
|
* @param {module:model/NewDeal} opts.newDeal
|
112
112
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAddedDeal} and HTTP response
|
@@ -144,7 +144,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
144
144
|
}
|
145
145
|
/**
|
146
146
|
* Add a deal
|
147
|
-
* Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information
|
147
|
+
* Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">adding a deal</a>.
|
148
148
|
* @param {Object} opts Optional parameters
|
149
149
|
* @param {module:model/NewDeal} opts.newDeal
|
150
150
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAddedDeal}
|
@@ -160,7 +160,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
160
160
|
/**
|
161
161
|
* Add a follower to a deal
|
162
162
|
* Adds a follower to a deal.
|
163
|
-
* @param {Number} id ID of the deal
|
163
|
+
* @param {Number} id The ID of the deal
|
164
164
|
* @param {Object} opts Optional parameters
|
165
165
|
* @param {module:model/AddDealFollowerRequest} opts.addDealFollowerRequest
|
166
166
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddedDealFollower} and HTTP response
|
@@ -176,6 +176,10 @@ var DealsApi = /*#__PURE__*/function () {
|
|
176
176
|
throw new Error("Missing the required parameter 'id' when calling addDealFollower");
|
177
177
|
}
|
178
178
|
|
179
|
+
if (opts['user_id'] === undefined || opts['user_id'] === null) {
|
180
|
+
throw new Error("Missing the required parameter 'user_id' when calling addDealFollower");
|
181
|
+
}
|
182
|
+
|
179
183
|
var pathParams = {
|
180
184
|
'id': id
|
181
185
|
};
|
@@ -205,7 +209,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
205
209
|
/**
|
206
210
|
* Add a follower to a deal
|
207
211
|
* Adds a follower to a deal.
|
208
|
-
* @param {Number} id ID of the deal
|
212
|
+
* @param {Number} id The ID of the deal
|
209
213
|
* @param {Object} opts Optional parameters
|
210
214
|
* @param {module:model/AddDealFollowerRequest} opts.addDealFollowerRequest
|
211
215
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddedDealFollower}
|
@@ -221,7 +225,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
221
225
|
/**
|
222
226
|
* Add a participant to a deal
|
223
227
|
* Adds a participant to a deal.
|
224
|
-
* @param {Number} id ID of the deal
|
228
|
+
* @param {Number} id The ID of the deal
|
225
229
|
* @param {Object} opts Optional parameters
|
226
230
|
* @param {module:model/AddDealParticipantRequest} opts.addDealParticipantRequest
|
227
231
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostDealParticipants} and HTTP response
|
@@ -237,6 +241,10 @@ var DealsApi = /*#__PURE__*/function () {
|
|
237
241
|
throw new Error("Missing the required parameter 'id' when calling addDealParticipant");
|
238
242
|
}
|
239
243
|
|
244
|
+
if (opts['person_id'] === undefined || opts['person_id'] === null) {
|
245
|
+
throw new Error("Missing the required parameter 'person_id' when calling addDealParticipant");
|
246
|
+
}
|
247
|
+
|
240
248
|
var pathParams = {
|
241
249
|
'id': id
|
242
250
|
};
|
@@ -266,7 +274,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
266
274
|
/**
|
267
275
|
* Add a participant to a deal
|
268
276
|
* Adds a participant to a deal.
|
269
|
-
* @param {Number} id ID of the deal
|
277
|
+
* @param {Number} id The ID of the deal
|
270
278
|
* @param {Object} opts Optional parameters
|
271
279
|
* @param {module:model/AddDealParticipantRequest} opts.addDealParticipantRequest
|
272
280
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostDealParticipants}
|
@@ -282,7 +290,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
282
290
|
/**
|
283
291
|
* Add a product to the deal, eventually creating a new item called a deal-product
|
284
292
|
* Adds a product to the deal.
|
285
|
-
* @param {Number} id ID of the deal
|
293
|
+
* @param {Number} id The ID of the deal
|
286
294
|
* @param {Object} opts Optional parameters
|
287
295
|
* @param {module:model/NewDealProduct} opts.newDealProduct
|
288
296
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAddProductAttachementDetails} and HTTP response
|
@@ -327,7 +335,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
327
335
|
/**
|
328
336
|
* Add a product to the deal, eventually creating a new item called a deal-product
|
329
337
|
* Adds a product to the deal.
|
330
|
-
* @param {Number} id ID of the deal
|
338
|
+
* @param {Number} id The ID of the deal
|
331
339
|
* @param {Object} opts Optional parameters
|
332
340
|
* @param {module:model/NewDealProduct} opts.newDealProduct
|
333
341
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAddProductAttachementDetails}
|
@@ -343,7 +351,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
343
351
|
/**
|
344
352
|
* Delete a deal
|
345
353
|
* Marks a deal as deleted.
|
346
|
-
* @param {Number} id ID of the deal
|
354
|
+
* @param {Number} id The ID of the deal
|
347
355
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteDeal} and HTTP response
|
348
356
|
*/
|
349
357
|
|
@@ -386,7 +394,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
386
394
|
/**
|
387
395
|
* Delete a deal
|
388
396
|
* Marks a deal as deleted.
|
389
|
-
* @param {Number} id ID of the deal
|
397
|
+
* @param {Number} id The ID of the deal
|
390
398
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteDeal}
|
391
399
|
*/
|
392
400
|
|
@@ -400,8 +408,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
400
408
|
/**
|
401
409
|
* Delete a follower from a deal
|
402
410
|
* Deletes a follower from a deal.
|
403
|
-
* @param {Number} id ID of the deal
|
404
|
-
* @param {Number} followerId ID of the follower
|
411
|
+
* @param {Number} id The ID of the deal
|
412
|
+
* @param {Number} followerId The ID of the follower
|
405
413
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteDealFollower} and HTTP response
|
406
414
|
*/
|
407
415
|
|
@@ -450,8 +458,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
450
458
|
/**
|
451
459
|
* Delete a follower from a deal
|
452
460
|
* Deletes a follower from a deal.
|
453
|
-
* @param {Number} id ID of the deal
|
454
|
-
* @param {Number} followerId ID of the follower
|
461
|
+
* @param {Number} id The ID of the deal
|
462
|
+
* @param {Number} followerId The ID of the follower
|
455
463
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteDealFollower}
|
456
464
|
*/
|
457
465
|
|
@@ -465,8 +473,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
465
473
|
/**
|
466
474
|
* Delete a participant from a deal
|
467
475
|
* Deletes a participant from a deal.
|
468
|
-
* @param {Number} id ID of the deal
|
469
|
-
* @param {Number} dealParticipantId ID of the deal
|
476
|
+
* @param {Number} id The ID of the deal
|
477
|
+
* @param {Number} dealParticipantId The ID of the participant of the deal
|
470
478
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteDealParticipant} and HTTP response
|
471
479
|
*/
|
472
480
|
|
@@ -515,8 +523,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
515
523
|
/**
|
516
524
|
* Delete a participant from a deal
|
517
525
|
* Deletes a participant from a deal.
|
518
|
-
* @param {Number} id ID of the deal
|
519
|
-
* @param {Number} dealParticipantId ID of the deal
|
526
|
+
* @param {Number} id The ID of the deal
|
527
|
+
* @param {Number} dealParticipantId The ID of the participant of the deal
|
520
528
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteDealParticipant}
|
521
529
|
*/
|
522
530
|
|
@@ -530,8 +538,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
530
538
|
/**
|
531
539
|
* Delete an attached product from a deal
|
532
540
|
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
533
|
-
* @param {Number} id ID of the deal
|
534
|
-
* @param {Number} productAttachmentId
|
541
|
+
* @param {Number} id The ID of the deal
|
542
|
+
* @param {Number} productAttachmentId The product attachment ID. This is returned as `product_attachment_id` after attaching a product to a deal or as id when listing the products attached to a deal.
|
535
543
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteDealProduct} and HTTP response
|
536
544
|
*/
|
537
545
|
|
@@ -580,8 +588,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
580
588
|
/**
|
581
589
|
* Delete an attached product from a deal
|
582
590
|
* Deletes a product attachment from a deal, using the `product_attachment_id`.
|
583
|
-
* @param {Number} id ID of the deal
|
584
|
-
* @param {Number} productAttachmentId
|
591
|
+
* @param {Number} id The ID of the deal
|
592
|
+
* @param {Number} productAttachmentId The product attachment ID. This is returned as `product_attachment_id` after attaching a product to a deal or as id when listing the products attached to a deal.
|
585
593
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteDealProduct}
|
586
594
|
*/
|
587
595
|
|
@@ -595,7 +603,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
595
603
|
/**
|
596
604
|
* Delete multiple deals in bulk
|
597
605
|
* Marks multiple deals as deleted.
|
598
|
-
* @param {String} ids
|
606
|
+
* @param {String} ids The comma-separated IDs that will be deleted
|
599
607
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteMultipleDeals} and HTTP response
|
600
608
|
*/
|
601
609
|
|
@@ -638,7 +646,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
638
646
|
/**
|
639
647
|
* Delete multiple deals in bulk
|
640
648
|
* Marks multiple deals as deleted.
|
641
|
-
* @param {String} ids
|
649
|
+
* @param {String} ids The comma-separated IDs that will be deleted
|
642
650
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteMultipleDeals}
|
643
651
|
*/
|
644
652
|
|
@@ -651,8 +659,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
651
659
|
}
|
652
660
|
/**
|
653
661
|
* Duplicate deal
|
654
|
-
*
|
655
|
-
* @param {Number} id ID of the deal
|
662
|
+
* Duplicates a deal.
|
663
|
+
* @param {Number} id The ID of the deal
|
656
664
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDuplicatedDeal} and HTTP response
|
657
665
|
*/
|
658
666
|
|
@@ -694,8 +702,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
694
702
|
}
|
695
703
|
/**
|
696
704
|
* Duplicate deal
|
697
|
-
*
|
698
|
-
* @param {Number} id ID of the deal
|
705
|
+
* Duplicates a deal.
|
706
|
+
* @param {Number} id The ID of the deal
|
699
707
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDuplicatedDeal}
|
700
708
|
*/
|
701
709
|
|
@@ -708,8 +716,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
708
716
|
}
|
709
717
|
/**
|
710
718
|
* Get details of a deal
|
711
|
-
* Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information
|
712
|
-
* @param {Number} id ID of the deal
|
719
|
+
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
720
|
+
* @param {Number} id The ID of the deal
|
713
721
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDeal} and HTTP response
|
714
722
|
*/
|
715
723
|
|
@@ -751,8 +759,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
751
759
|
}
|
752
760
|
/**
|
753
761
|
* Get details of a deal
|
754
|
-
* Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information
|
755
|
-
* @param {Number} id ID of the deal
|
762
|
+
* Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">getting details of a deal</a>.
|
763
|
+
* @param {Number} id The ID of the deal
|
756
764
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDeal}
|
757
765
|
*/
|
758
766
|
|
@@ -766,11 +774,11 @@ var DealsApi = /*#__PURE__*/function () {
|
|
766
774
|
/**
|
767
775
|
* List activities associated with a deal
|
768
776
|
* Lists activities associated with a deal.
|
769
|
-
* @param {Number} id ID of the deal
|
777
|
+
* @param {Number} id The ID of the deal
|
770
778
|
* @param {Object} opts Optional parameters
|
771
779
|
* @param {Number} opts.start Pagination start (default to 0)
|
772
780
|
* @param {Number} opts.limit Items shown per page
|
773
|
-
* @param {module:model/NumberBoolean} opts.done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
|
781
|
+
* @param {module:model/NumberBoolean} opts.done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
774
782
|
* @param {String} opts.exclude A comma-separated string of activity IDs to exclude from result
|
775
783
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DealListActivitiesResponse} and HTTP response
|
776
784
|
*/
|
@@ -819,11 +827,11 @@ var DealsApi = /*#__PURE__*/function () {
|
|
819
827
|
/**
|
820
828
|
* List activities associated with a deal
|
821
829
|
* Lists activities associated with a deal.
|
822
|
-
* @param {Number} id ID of the deal
|
830
|
+
* @param {Number} id The ID of the deal
|
823
831
|
* @param {Object} opts Optional parameters
|
824
832
|
* @param {Number} opts.start Pagination start (default to 0)
|
825
833
|
* @param {Number} opts.limit Items shown per page
|
826
|
-
* @param {module:model/NumberBoolean} opts.done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
|
834
|
+
* @param {module:model/NumberBoolean} opts.done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
|
827
835
|
* @param {String} opts.exclude A comma-separated string of activity IDs to exclude from result
|
828
836
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DealListActivitiesResponse}
|
829
837
|
*/
|
@@ -838,12 +846,12 @@ var DealsApi = /*#__PURE__*/function () {
|
|
838
846
|
/**
|
839
847
|
* List files attached to a deal
|
840
848
|
* Lists files associated with a deal.
|
841
|
-
* @param {Number} id ID of the deal
|
849
|
+
* @param {Number} id The ID of the deal
|
842
850
|
* @param {Object} opts Optional parameters
|
843
851
|
* @param {Number} opts.start Pagination start (default to 0)
|
844
852
|
* @param {Number} opts.limit Items shown per page
|
845
853
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
846
|
-
* @param {String} opts.sort
|
854
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
847
855
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
848
856
|
*/
|
849
857
|
|
@@ -891,12 +899,12 @@ var DealsApi = /*#__PURE__*/function () {
|
|
891
899
|
/**
|
892
900
|
* List files attached to a deal
|
893
901
|
* Lists files associated with a deal.
|
894
|
-
* @param {Number} id ID of the deal
|
902
|
+
* @param {Number} id The ID of the deal
|
895
903
|
* @param {Object} opts Optional parameters
|
896
904
|
* @param {Number} opts.start Pagination start (default to 0)
|
897
905
|
* @param {Number} opts.limit Items shown per page
|
898
906
|
* @param {module:model/NumberBoolean} opts.includeDeletedFiles When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
|
899
|
-
* @param {String} opts.sort
|
907
|
+
* @param {String} opts.sort The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
|
900
908
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
901
909
|
*/
|
902
910
|
|
@@ -910,7 +918,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
910
918
|
/**
|
911
919
|
* List followers of a deal
|
912
920
|
* Lists the followers of a deal.
|
913
|
-
* @param {Number} id ID of the deal
|
921
|
+
* @param {Number} id The ID of the deal
|
914
922
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFollowersResponse} and HTTP response
|
915
923
|
*/
|
916
924
|
|
@@ -953,7 +961,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
953
961
|
/**
|
954
962
|
* List followers of a deal
|
955
963
|
* Lists the followers of a deal.
|
956
|
-
* @param {Number} id ID of the deal
|
964
|
+
* @param {Number} id The ID of the deal
|
957
965
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFollowersResponse}
|
958
966
|
*/
|
959
967
|
|
@@ -967,7 +975,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
967
975
|
/**
|
968
976
|
* List mail messages associated with a deal
|
969
977
|
* Lists mail messages associated with a deal.
|
970
|
-
* @param {Number} id ID of the deal
|
978
|
+
* @param {Number} id The ID of the deal
|
971
979
|
* @param {Object} opts Optional parameters
|
972
980
|
* @param {Number} opts.start Pagination start (default to 0)
|
973
981
|
* @param {Number} opts.limit Items shown per page
|
@@ -1016,7 +1024,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1016
1024
|
/**
|
1017
1025
|
* List mail messages associated with a deal
|
1018
1026
|
* Lists mail messages associated with a deal.
|
1019
|
-
* @param {Number} id ID of the deal
|
1027
|
+
* @param {Number} id The ID of the deal
|
1020
1028
|
* @param {Object} opts Optional parameters
|
1021
1029
|
* @param {Number} opts.start Pagination start (default to 0)
|
1022
1030
|
* @param {Number} opts.limit Items shown per page
|
@@ -1032,8 +1040,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1032
1040
|
}
|
1033
1041
|
/**
|
1034
1042
|
* List participants of a deal
|
1035
|
-
* Lists participants associated with a deal.
|
1036
|
-
* @param {Number} id ID of the deal
|
1043
|
+
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
1044
|
+
* @param {Number} id The ID of the deal
|
1037
1045
|
* @param {Object} opts Optional parameters
|
1038
1046
|
* @param {Number} opts.start Pagination start (default to 0)
|
1039
1047
|
* @param {Number} opts.limit Items shown per page
|
@@ -1081,8 +1089,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1081
1089
|
}
|
1082
1090
|
/**
|
1083
1091
|
* List participants of a deal
|
1084
|
-
* Lists participants associated with a deal.
|
1085
|
-
* @param {Number} id ID of the deal
|
1092
|
+
* Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
|
1093
|
+
* @param {Number} id The ID of the deal
|
1086
1094
|
* @param {Object} opts Optional parameters
|
1087
1095
|
* @param {Number} opts.start Pagination start (default to 0)
|
1088
1096
|
* @param {Number} opts.limit Items shown per page
|
@@ -1099,7 +1107,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1099
1107
|
/**
|
1100
1108
|
* List all persons associated with a deal
|
1101
1109
|
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
|
1102
|
-
* @param {Number} id ID of the deal
|
1110
|
+
* @param {Number} id The ID of the deal
|
1103
1111
|
* @param {Object} opts Optional parameters
|
1104
1112
|
* @param {Number} opts.start Pagination start (default to 0)
|
1105
1113
|
* @param {Number} opts.limit Items shown per page
|
@@ -1148,7 +1156,7 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1148
1156
|
/**
|
1149
1157
|
* List all persons associated with a deal
|
1150
1158
|
* Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
|
1151
|
-
* @param {Number} id ID of the deal
|
1159
|
+
* @param {Number} id The ID of the deal
|
1152
1160
|
* @param {Object} opts Optional parameters
|
1153
1161
|
* @param {Number} opts.start Pagination start (default to 0)
|
1154
1162
|
* @param {Number} opts.limit Items shown per page
|
@@ -1165,11 +1173,11 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1165
1173
|
/**
|
1166
1174
|
* List products attached to a deal
|
1167
1175
|
* Lists products attached to a deal.
|
1168
|
-
* @param {Number} id ID of the deal
|
1176
|
+
* @param {Number} id The ID of the deal
|
1169
1177
|
* @param {Object} opts Optional parameters
|
1170
1178
|
* @param {Number} opts.start Pagination start (default to 0)
|
1171
1179
|
* @param {Number} opts.limit Items shown per page
|
1172
|
-
* @param {module:model/NumberBoolean} opts.includeProductData Whether to fetch product data along with each attached product (1) or not (0, default)
|
1180
|
+
* @param {module:model/NumberBoolean} opts.includeProductData Whether to fetch product data along with each attached product (1) or not (0, default)
|
1173
1181
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListProductsResponse} and HTTP response
|
1174
1182
|
*/
|
1175
1183
|
|
@@ -1216,11 +1224,11 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1216
1224
|
/**
|
1217
1225
|
* List products attached to a deal
|
1218
1226
|
* Lists products attached to a deal.
|
1219
|
-
* @param {Number} id ID of the deal
|
1227
|
+
* @param {Number} id The ID of the deal
|
1220
1228
|
* @param {Object} opts Optional parameters
|
1221
1229
|
* @param {Number} opts.start Pagination start (default to 0)
|
1222
1230
|
* @param {Number} opts.limit Items shown per page
|
1223
|
-
* @param {module:model/NumberBoolean} opts.includeProductData Whether to fetch product data along with each attached product (1) or not (0, default)
|
1231
|
+
* @param {module:model/NumberBoolean} opts.includeProductData Whether to fetch product data along with each attached product (1) or not (0, default)
|
1224
1232
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListProductsResponse}
|
1225
1233
|
*/
|
1226
1234
|
|
@@ -1234,12 +1242,12 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1234
1242
|
/**
|
1235
1243
|
* List updates about a deal
|
1236
1244
|
* Lists updates about a deal.
|
1237
|
-
* @param {Number} id ID of the deal
|
1245
|
+
* @param {Number} id The ID of the deal
|
1238
1246
|
* @param {Object} opts Optional parameters
|
1239
1247
|
* @param {Number} opts.start Pagination start (default to 0)
|
1240
1248
|
* @param {Number} opts.limit Items shown per page
|
1241
1249
|
* @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
1242
|
-
* @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file,
|
1250
|
+
* @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
|
1243
1251
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DealFlowResponse} and HTTP response
|
1244
1252
|
*/
|
1245
1253
|
|
@@ -1287,12 +1295,12 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1287
1295
|
/**
|
1288
1296
|
* List updates about a deal
|
1289
1297
|
* Lists updates about a deal.
|
1290
|
-
* @param {Number} id ID of the deal
|
1298
|
+
* @param {Number} id The ID of the deal
|
1291
1299
|
* @param {Object} opts Optional parameters
|
1292
1300
|
* @param {Number} opts.start Pagination start (default to 0)
|
1293
1301
|
* @param {Number} opts.limit Items shown per page
|
1294
1302
|
* @param {String} opts.allChanges Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
1295
|
-
* @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file,
|
1303
|
+
* @param {String} opts.items A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
|
1296
1304
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DealFlowResponse}
|
1297
1305
|
*/
|
1298
1306
|
|
@@ -1305,8 +1313,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1305
1313
|
}
|
1306
1314
|
/**
|
1307
1315
|
* List permitted users
|
1308
|
-
*
|
1309
|
-
* @param {Number} id ID of the deal
|
1316
|
+
* Lists the users permitted to access a deal.
|
1317
|
+
* @param {Number} id The ID of the deal
|
1310
1318
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPermittedUsersResponse} and HTTP response
|
1311
1319
|
*/
|
1312
1320
|
|
@@ -1348,8 +1356,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1348
1356
|
}
|
1349
1357
|
/**
|
1350
1358
|
* List permitted users
|
1351
|
-
*
|
1352
|
-
* @param {Number} id ID of the deal
|
1359
|
+
* Lists the users permitted to access a deal.
|
1360
|
+
* @param {Number} id The ID of the deal
|
1353
1361
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPermittedUsersResponse}
|
1354
1362
|
*/
|
1355
1363
|
|
@@ -1362,15 +1370,15 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1362
1370
|
}
|
1363
1371
|
/**
|
1364
1372
|
* Get all deals
|
1365
|
-
* Returns all deals. For more information
|
1373
|
+
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1366
1374
|
* @param {Object} opts Optional parameters
|
1367
1375
|
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
1368
|
-
* @param {Number} opts.filterId ID of the filter to use
|
1369
|
-
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
1370
|
-
* @param {module:model/String} opts.status Only fetch deals with specific status. If omitted, all not deleted deals are fetched. (default to 'all_not_deleted')
|
1376
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
1377
|
+
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
1378
|
+
* @param {module:model/String} opts.status Only fetch deals with a specific status. If omitted, all not deleted deals are fetched. (default to 'all_not_deleted')
|
1371
1379
|
* @param {Number} opts.start Pagination start (default to 0)
|
1372
1380
|
* @param {Number} opts.limit Items shown per page
|
1373
|
-
* @param {String} opts.sort
|
1381
|
+
* @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).
|
1374
1382
|
* @param {module:model/NumberBoolean} opts.ownedByYou When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
1375
1383
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDeals} and HTTP response
|
1376
1384
|
*/
|
@@ -1415,15 +1423,15 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1415
1423
|
}
|
1416
1424
|
/**
|
1417
1425
|
* Get all deals
|
1418
|
-
* Returns all deals. For more information
|
1426
|
+
* Returns all deals. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">getting all deals</a>.
|
1419
1427
|
* @param {Object} opts Optional parameters
|
1420
1428
|
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
|
1421
|
-
* @param {Number} opts.filterId ID of the filter to use
|
1422
|
-
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
1423
|
-
* @param {module:model/String} opts.status Only fetch deals with specific status. If omitted, all not deleted deals are fetched. (default to 'all_not_deleted')
|
1429
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
1430
|
+
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
1431
|
+
* @param {module:model/String} opts.status Only fetch deals with a specific status. If omitted, all not deleted deals are fetched. (default to 'all_not_deleted')
|
1424
1432
|
* @param {Number} opts.start Pagination start (default to 0)
|
1425
1433
|
* @param {Number} opts.limit Items shown per page
|
1426
|
-
* @param {String} opts.sort
|
1434
|
+
* @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).
|
1427
1435
|
* @param {module:model/NumberBoolean} opts.ownedByYou When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
|
1428
1436
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDeals}
|
1429
1437
|
*/
|
@@ -1437,12 +1445,12 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1437
1445
|
}
|
1438
1446
|
/**
|
1439
1447
|
* Get deals summary
|
1440
|
-
* Returns summary of all the deals.
|
1448
|
+
* Returns a summary of all the deals.
|
1441
1449
|
* @param {Object} opts Optional parameters
|
1442
|
-
* @param {module:model/String} opts.status Only fetch deals with specific status. open = Open, won = Won, lost = Lost
|
1450
|
+
* @param {module:model/String} opts.status Only fetch deals with a specific status. open = Open, won = Won, lost = Lost
|
1443
1451
|
* @param {Number} opts.filterId <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
1444
1452
|
* @param {Number} opts.userId Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
1445
|
-
* @param {Number} opts.stageId Only deals within the given stage will be returned
|
1453
|
+
* @param {Number} opts.stageId Only deals within the given stage will be returned
|
1446
1454
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDealsSummary} and HTTP response
|
1447
1455
|
*/
|
1448
1456
|
|
@@ -1482,12 +1490,12 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1482
1490
|
}
|
1483
1491
|
/**
|
1484
1492
|
* Get deals summary
|
1485
|
-
* Returns summary of all the deals.
|
1493
|
+
* Returns a summary of all the deals.
|
1486
1494
|
* @param {Object} opts Optional parameters
|
1487
|
-
* @param {module:model/String} opts.status Only fetch deals with specific status. open = Open, won = Won, lost = Lost
|
1495
|
+
* @param {module:model/String} opts.status Only fetch deals with a specific status. open = Open, won = Won, lost = Lost
|
1488
1496
|
* @param {Number} opts.filterId <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
|
1489
1497
|
* @param {Number} opts.userId Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
|
1490
|
-
* @param {Number} opts.stageId Only deals within the given stage will be returned
|
1498
|
+
* @param {Number} opts.stageId Only deals within the given stage will be returned
|
1491
1499
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDealsSummary}
|
1492
1500
|
*/
|
1493
1501
|
|
@@ -1500,17 +1508,17 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1500
1508
|
}
|
1501
1509
|
/**
|
1502
1510
|
* Get deals timeline
|
1503
|
-
* Returns open and won deals, grouped by defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from
|
1504
|
-
* @param {Date} startDate
|
1505
|
-
* @param {module:model/String} interval The type of interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
1511
|
+
* Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1512
|
+
* @param {Date} startDate The date when the first interval starts. Format: YYYY-MM-DD
|
1513
|
+
* @param {module:model/String} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
1506
1514
|
* @param {Number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
1507
1515
|
* @param {String} fieldKey The date field key which deals will be retrieved from
|
1508
1516
|
* @param {Object} opts Optional parameters
|
1509
|
-
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned
|
1517
|
+
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned
|
1510
1518
|
* @param {Number} opts.pipelineId If supplied, only deals matching the given pipeline will be returned
|
1511
1519
|
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
1512
1520
|
* @param {module:model/NumberBoolean} opts.excludeDeals Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
1513
|
-
* @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case
|
1521
|
+
* @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used.
|
1514
1522
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDealsTimeline} and HTTP response
|
1515
1523
|
*/
|
1516
1524
|
|
@@ -1575,17 +1583,17 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1575
1583
|
}
|
1576
1584
|
/**
|
1577
1585
|
* Get deals timeline
|
1578
|
-
* Returns open and won deals, grouped by defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from
|
1579
|
-
* @param {Date} startDate
|
1580
|
-
* @param {module:model/String} interval The type of interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
1586
|
+
* Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.
|
1587
|
+
* @param {Date} startDate The date when the first interval starts. Format: YYYY-MM-DD
|
1588
|
+
* @param {module:model/String} interval The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
|
1581
1589
|
* @param {Number} amount The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
|
1582
1590
|
* @param {String} fieldKey The date field key which deals will be retrieved from
|
1583
1591
|
* @param {Object} opts Optional parameters
|
1584
|
-
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned
|
1592
|
+
* @param {Number} opts.userId If supplied, only deals matching the given user will be returned
|
1585
1593
|
* @param {Number} opts.pipelineId If supplied, only deals matching the given pipeline will be returned
|
1586
1594
|
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
1587
1595
|
* @param {module:model/NumberBoolean} opts.excludeDeals Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
|
1588
|
-
* @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case
|
1596
|
+
* @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user's default currency is used.
|
1589
1597
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDealsTimeline}
|
1590
1598
|
*/
|
1591
1599
|
|
@@ -1598,8 +1606,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1598
1606
|
}
|
1599
1607
|
/**
|
1600
1608
|
* Merge two deals
|
1601
|
-
* Merges a deal with another deal. For more information
|
1602
|
-
* @param {Number} id ID of the deal
|
1609
|
+
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
1610
|
+
* @param {Number} id The ID of the deal
|
1603
1611
|
* @param {Object} opts Optional parameters
|
1604
1612
|
* @param {module:model/MergeDealsRequest} opts.mergeDealsRequest
|
1605
1613
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetMergedDeal} and HTTP response
|
@@ -1615,6 +1623,10 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1615
1623
|
throw new Error("Missing the required parameter 'id' when calling mergeDeals");
|
1616
1624
|
}
|
1617
1625
|
|
1626
|
+
if (opts['merge_with_id'] === undefined || opts['merge_with_id'] === null) {
|
1627
|
+
throw new Error("Missing the required parameter 'merge_with_id' when calling mergeDeals");
|
1628
|
+
}
|
1629
|
+
|
1618
1630
|
var pathParams = {
|
1619
1631
|
'id': id
|
1620
1632
|
};
|
@@ -1643,8 +1655,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1643
1655
|
}
|
1644
1656
|
/**
|
1645
1657
|
* Merge two deals
|
1646
|
-
* Merges a deal with another deal. For more information
|
1647
|
-
* @param {Number} id ID of the deal
|
1658
|
+
* Merges a deal with another deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">merging two deals</a>.
|
1659
|
+
* @param {Number} id The ID of the deal
|
1648
1660
|
* @param {Object} opts Optional parameters
|
1649
1661
|
* @param {module:model/MergeDealsRequest} opts.mergeDealsRequest
|
1650
1662
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetMergedDeal}
|
@@ -1659,15 +1671,15 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1659
1671
|
}
|
1660
1672
|
/**
|
1661
1673
|
* Search deals
|
1662
|
-
* Searches all
|
1674
|
+
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
1663
1675
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
1664
1676
|
* @param {Object} opts Optional parameters
|
1665
1677
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
1666
1678
|
* @param {module:model/Boolean} opts.exactMatch When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
1667
|
-
* @param {Number} opts.personId Will filter
|
1668
|
-
* @param {Number} opts.organizationId Will filter
|
1669
|
-
* @param {module:model/String} opts.status Will filter
|
1670
|
-
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1679
|
+
* @param {Number} opts.personId Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
1680
|
+
* @param {Number} opts.organizationId Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
1681
|
+
* @param {module:model/String} opts.status Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
1682
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1671
1683
|
* @param {Number} opts.start Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. (default to 0)
|
1672
1684
|
* @param {Number} opts.limit Items shown per page
|
1673
1685
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DealSearchResponse} and HTTP response
|
@@ -1719,15 +1731,15 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1719
1731
|
}
|
1720
1732
|
/**
|
1721
1733
|
* Search deals
|
1722
|
-
* Searches all
|
1734
|
+
* Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
|
1723
1735
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
1724
1736
|
* @param {Object} opts Optional parameters
|
1725
1737
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
1726
1738
|
* @param {module:model/Boolean} opts.exactMatch When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
1727
|
-
* @param {Number} opts.personId Will filter
|
1728
|
-
* @param {Number} opts.organizationId Will filter
|
1729
|
-
* @param {module:model/String} opts.status Will filter
|
1730
|
-
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1739
|
+
* @param {Number} opts.personId Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
1740
|
+
* @param {Number} opts.organizationId Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
1741
|
+
* @param {module:model/String} opts.status Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
1742
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1731
1743
|
* @param {Number} opts.start Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. (default to 0)
|
1732
1744
|
* @param {Number} opts.limit Items shown per page
|
1733
1745
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DealSearchResponse}
|
@@ -1742,8 +1754,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1742
1754
|
}
|
1743
1755
|
/**
|
1744
1756
|
* Update a deal
|
1745
|
-
* Updates the properties of a deal. For more information
|
1746
|
-
* @param {Number} id ID of the deal
|
1757
|
+
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
1758
|
+
* @param {Number} id The ID of the deal
|
1747
1759
|
* @param {Object} opts Optional parameters
|
1748
1760
|
* @param {module:model/UpdateDealRequest} opts.updateDealRequest
|
1749
1761
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAddedDeal} and HTTP response
|
@@ -1787,8 +1799,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1787
1799
|
}
|
1788
1800
|
/**
|
1789
1801
|
* Update a deal
|
1790
|
-
* Updates the properties of a deal. For more information
|
1791
|
-
* @param {Number} id ID of the deal
|
1802
|
+
* Updates the properties of a deal. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">updating a deal</a>.
|
1803
|
+
* @param {Number} id The ID of the deal
|
1792
1804
|
* @param {Object} opts Optional parameters
|
1793
1805
|
* @param {module:model/UpdateDealRequest} opts.updateDealRequest
|
1794
1806
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAddedDeal}
|
@@ -1804,8 +1816,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1804
1816
|
/**
|
1805
1817
|
* Update product attachment details of the deal-product (a product already attached to a deal)
|
1806
1818
|
* Updates product attachment details.
|
1807
|
-
* @param {Number} id ID of the deal
|
1808
|
-
* @param {Number} productAttachmentId ID of the deal-product (the ID of the product attached to the deal)
|
1819
|
+
* @param {Number} id The ID of the deal
|
1820
|
+
* @param {Number} productAttachmentId The ID of the deal-product (the ID of the product attached to the deal)
|
1809
1821
|
* @param {Object} opts Optional parameters
|
1810
1822
|
* @param {module:model/BasicDealProduct} opts.basicDealProduct
|
1811
1823
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductAttachementDetails} and HTTP response
|
@@ -1856,8 +1868,8 @@ var DealsApi = /*#__PURE__*/function () {
|
|
1856
1868
|
/**
|
1857
1869
|
* Update product attachment details of the deal-product (a product already attached to a deal)
|
1858
1870
|
* Updates product attachment details.
|
1859
|
-
* @param {Number} id ID of the deal
|
1860
|
-
* @param {Number} productAttachmentId ID of the deal-product (the ID of the product attached to the deal)
|
1871
|
+
* @param {Number} id The ID of the deal
|
1872
|
+
* @param {Number} productAttachmentId The ID of the deal-product (the ID of the product attached to the deal)
|
1861
1873
|
* @param {Object} opts Optional parameters
|
1862
1874
|
* @param {module:model/BasicDealProduct} opts.basicDealProduct
|
1863
1875
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductAttachementDetails}
|