pipedrive 13.0.9 → 13.1.0
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 +18 -16
- package/dist/ApiClient.js +46 -9
- package/dist/api/ActivitiesApi.js +44 -44
- package/dist/api/ActivityTypesApi.js +4 -4
- package/dist/api/CallLogsApi.js +23 -6
- package/dist/api/CurrenciesApi.js +2 -2
- package/dist/api/DealFieldsApi.js +10 -10
- package/dist/api/DealsApi.js +112 -100
- package/dist/api/FilesApi.js +34 -34
- package/dist/api/FiltersApi.js +19 -2
- 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 +10 -10
- package/dist/api/OrganizationRelationshipsApi.js +25 -12
- package/dist/api/OrganizationsApi.js +58 -50
- package/dist/api/PermissionSetsApi.js +12 -12
- package/dist/api/PersonFieldsApi.js +10 -10
- package/dist/api/PersonsApi.js +82 -74
- package/dist/api/PipelinesApi.js +50 -50
- package/dist/api/ProductFieldsApi.js +23 -10
- package/dist/api/ProductsApi.js +48 -44
- 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 +16 -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/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 +6 -39
- 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 +10 -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/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 +20 -20
- 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/PersonsApi.js
CHANGED
@@ -138,7 +138,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
138
138
|
/**
|
139
139
|
* Add a follower to a person
|
140
140
|
* Adds a follower to a person.
|
141
|
-
* @param {Number} id ID of
|
141
|
+
* @param {Number} id The ID of the person
|
142
142
|
* @param {Object} opts Optional parameters
|
143
143
|
* @param {module:model/AddPersonFollowerRequest} opts.addPersonFollowerRequest
|
144
144
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddFollowerToPersonResponse} and HTTP response
|
@@ -154,6 +154,10 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
154
154
|
throw new Error("Missing the required parameter 'id' when calling addPersonFollower");
|
155
155
|
}
|
156
156
|
|
157
|
+
if (opts['user_id'] === undefined || opts['user_id'] === null) {
|
158
|
+
throw new Error("Missing the required parameter 'user_id' when calling addPersonFollower");
|
159
|
+
}
|
160
|
+
|
157
161
|
var pathParams = {
|
158
162
|
'id': id
|
159
163
|
};
|
@@ -183,7 +187,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
183
187
|
/**
|
184
188
|
* Add a follower to a person
|
185
189
|
* Adds a follower to a person.
|
186
|
-
* @param {Number} id ID of
|
190
|
+
* @param {Number} id The ID of the person
|
187
191
|
* @param {Object} opts Optional parameters
|
188
192
|
* @param {module:model/AddPersonFollowerRequest} opts.addPersonFollowerRequest
|
189
193
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddFollowerToPersonResponse}
|
@@ -198,14 +202,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
198
202
|
}
|
199
203
|
/**
|
200
204
|
* Add person picture
|
201
|
-
*
|
202
|
-
* @param {Number} id ID of
|
203
|
-
* @param {File} file One image supplied in the multipart/form-data encoding
|
205
|
+
* Adds a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.
|
206
|
+
* @param {Number} id The ID of the person
|
207
|
+
* @param {File} file One image supplied in the multipart/form-data encoding
|
204
208
|
* @param {Object} opts Optional parameters
|
205
209
|
* @param {Number} opts.cropX X coordinate to where start cropping form (in pixels)
|
206
210
|
* @param {Number} opts.cropY Y coordinate to where start cropping form (in pixels)
|
207
|
-
* @param {Number} opts.cropWidth
|
208
|
-
* @param {Number} opts.cropHeight
|
211
|
+
* @param {Number} opts.cropWidth The width of the cropping area (in pixels)
|
212
|
+
* @param {Number} opts.cropHeight The height of the cropping area (in pixels)
|
209
213
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddPersonPictureResponse} and HTTP response
|
210
214
|
*/
|
211
215
|
|
@@ -258,14 +262,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
258
262
|
}
|
259
263
|
/**
|
260
264
|
* Add person picture
|
261
|
-
*
|
262
|
-
* @param {Number} id ID of
|
263
|
-
* @param {File} file One image supplied in the multipart/form-data encoding
|
265
|
+
* Adds a picture to a person. If a picture is already set, the old picture will be replaced. Added image (or the cropping parameters supplied with the request) should have an equal width and height and should be at least 128 pixels. GIF, JPG and PNG are accepted. All added images will be resized to 128 and 512 pixel wide squares.
|
266
|
+
* @param {Number} id The ID of the person
|
267
|
+
* @param {File} file One image supplied in the multipart/form-data encoding
|
264
268
|
* @param {Object} opts Optional parameters
|
265
269
|
* @param {Number} opts.cropX X coordinate to where start cropping form (in pixels)
|
266
270
|
* @param {Number} opts.cropY Y coordinate to where start cropping form (in pixels)
|
267
|
-
* @param {Number} opts.cropWidth
|
268
|
-
* @param {Number} opts.cropHeight
|
271
|
+
* @param {Number} opts.cropWidth The width of the cropping area (in pixels)
|
272
|
+
* @param {Number} opts.cropHeight The height of the cropping area (in pixels)
|
269
273
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddPersonPictureResponse}
|
270
274
|
*/
|
271
275
|
|
@@ -279,7 +283,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
279
283
|
/**
|
280
284
|
* Delete a person
|
281
285
|
* Marks a person as deleted.
|
282
|
-
* @param {Number} id ID of
|
286
|
+
* @param {Number} id The ID of the person
|
283
287
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
|
284
288
|
*/
|
285
289
|
|
@@ -322,7 +326,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
322
326
|
/**
|
323
327
|
* Delete a person
|
324
328
|
* Marks a person as deleted.
|
325
|
-
* @param {Number} id ID of
|
329
|
+
* @param {Number} id The ID of the person
|
326
330
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
|
327
331
|
*/
|
328
332
|
|
@@ -334,10 +338,10 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
334
338
|
});
|
335
339
|
}
|
336
340
|
/**
|
337
|
-
* Deletes a follower from a person.
|
338
341
|
* Delete a follower from a person
|
339
|
-
*
|
340
|
-
* @param {Number}
|
342
|
+
* Deletes a follower from a person.
|
343
|
+
* @param {Number} id The ID of the person
|
344
|
+
* @param {Number} followerId The ID of the follower
|
341
345
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
|
342
346
|
*/
|
343
347
|
|
@@ -384,10 +388,10 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
384
388
|
return this.apiClient.callApi('/persons/{id}/followers/{follower_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
385
389
|
}
|
386
390
|
/**
|
387
|
-
* Deletes a follower from a person.
|
388
391
|
* Delete a follower from a person
|
389
|
-
*
|
390
|
-
* @param {Number}
|
392
|
+
* Deletes a follower from a person.
|
393
|
+
* @param {Number} id The ID of the person
|
394
|
+
* @param {Number} followerId The ID of the follower
|
391
395
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
|
392
396
|
*/
|
393
397
|
|
@@ -400,8 +404,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
400
404
|
}
|
401
405
|
/**
|
402
406
|
* Delete person picture
|
403
|
-
*
|
404
|
-
* @param {Number} id ID of
|
407
|
+
* Deletes a person’s picture.
|
408
|
+
* @param {Number} id The ID of the person
|
405
409
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
|
406
410
|
*/
|
407
411
|
|
@@ -443,8 +447,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
443
447
|
}
|
444
448
|
/**
|
445
449
|
* Delete person picture
|
446
|
-
*
|
447
|
-
* @param {Number} id ID of
|
450
|
+
* Deletes a person’s picture.
|
451
|
+
* @param {Number} id The ID of the person
|
448
452
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
|
449
453
|
*/
|
450
454
|
|
@@ -459,7 +463,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
459
463
|
* Delete multiple persons in bulk
|
460
464
|
* Marks multiple persons as deleted.
|
461
465
|
* @param {Object} opts Optional parameters
|
462
|
-
* @param {String} opts.ids
|
466
|
+
* @param {String} opts.ids The comma-separated IDs that will be deleted
|
463
467
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonsInBulkResponse} and HTTP response
|
464
468
|
*/
|
465
469
|
|
@@ -498,7 +502,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
498
502
|
* Delete multiple persons in bulk
|
499
503
|
* Marks multiple persons as deleted.
|
500
504
|
* @param {Object} opts Optional parameters
|
501
|
-
* @param {String} opts.ids
|
505
|
+
* @param {String} opts.ids The comma-separated IDs that will be deleted
|
502
506
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonsInBulkResponse}
|
503
507
|
*/
|
504
508
|
|
@@ -511,8 +515,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
511
515
|
}
|
512
516
|
/**
|
513
517
|
* Get details of a person
|
514
|
-
* Returns details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
|
515
|
-
* @param {Number} id ID of
|
518
|
+
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
|
519
|
+
* @param {Number} id The ID of the person
|
516
520
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetPersonDetailsResponse} and HTTP response
|
517
521
|
*/
|
518
522
|
|
@@ -554,8 +558,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
554
558
|
}
|
555
559
|
/**
|
556
560
|
* Get details of a person
|
557
|
-
* Returns details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
|
558
|
-
* @param {Number} id ID of
|
561
|
+
* Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
|
562
|
+
* @param {Number} id The ID of the person
|
559
563
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetPersonDetailsResponse}
|
560
564
|
*/
|
561
565
|
|
@@ -569,11 +573,11 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
569
573
|
/**
|
570
574
|
* List activities associated with a person
|
571
575
|
* Lists activities associated with a person.
|
572
|
-
* @param {Number} id ID of
|
576
|
+
* @param {Number} id The ID of the person
|
573
577
|
* @param {Object} opts Optional parameters
|
574
578
|
* @param {Number} opts.start Pagination start (default to 0)
|
575
579
|
* @param {Number} opts.limit Items shown per page
|
576
|
-
* @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.
|
580
|
+
* @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.
|
577
581
|
* @param {String} opts.exclude A comma-separated string of activity IDs to exclude from result
|
578
582
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListActivitiesResponse} and HTTP response
|
579
583
|
*/
|
@@ -622,11 +626,11 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
622
626
|
/**
|
623
627
|
* List activities associated with a person
|
624
628
|
* Lists activities associated with a person.
|
625
|
-
* @param {Number} id ID of
|
629
|
+
* @param {Number} id The ID of the person
|
626
630
|
* @param {Object} opts Optional parameters
|
627
631
|
* @param {Number} opts.start Pagination start (default to 0)
|
628
632
|
* @param {Number} opts.limit Items shown per page
|
629
|
-
* @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.
|
633
|
+
* @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.
|
630
634
|
* @param {String} opts.exclude A comma-separated string of activity IDs to exclude from result
|
631
635
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListActivitiesResponse}
|
632
636
|
*/
|
@@ -641,12 +645,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
641
645
|
/**
|
642
646
|
* List deals associated with a person
|
643
647
|
* Lists deals associated with a person.
|
644
|
-
* @param {Number} id ID of
|
648
|
+
* @param {Number} id The ID of the person
|
645
649
|
* @param {Object} opts Optional parameters
|
646
650
|
* @param {Number} opts.start Pagination start (default to 0)
|
647
651
|
* @param {Number} opts.limit Items shown per page
|
648
|
-
* @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')
|
649
|
-
* @param {String} opts.sort
|
652
|
+
* @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')
|
653
|
+
* @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).
|
650
654
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListDealsResponse} and HTTP response
|
651
655
|
*/
|
652
656
|
|
@@ -694,12 +698,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
694
698
|
/**
|
695
699
|
* List deals associated with a person
|
696
700
|
* Lists deals associated with a person.
|
697
|
-
* @param {Number} id ID of
|
701
|
+
* @param {Number} id The ID of the person
|
698
702
|
* @param {Object} opts Optional parameters
|
699
703
|
* @param {Number} opts.start Pagination start (default to 0)
|
700
704
|
* @param {Number} opts.limit Items shown per page
|
701
|
-
* @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')
|
702
|
-
* @param {String} opts.sort
|
705
|
+
* @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')
|
706
|
+
* @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).
|
703
707
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListDealsResponse}
|
704
708
|
*/
|
705
709
|
|
@@ -713,12 +717,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
713
717
|
/**
|
714
718
|
* List files attached to a person
|
715
719
|
* Lists files associated with a person.
|
716
|
-
* @param {Number} id ID of
|
720
|
+
* @param {Number} id The ID of the person
|
717
721
|
* @param {Object} opts Optional parameters
|
718
722
|
* @param {Number} opts.start Pagination start (default to 0)
|
719
723
|
* @param {Number} opts.limit Items shown per page
|
720
724
|
* @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.
|
721
|
-
* @param {String} opts.sort
|
725
|
+
* @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.
|
722
726
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
723
727
|
*/
|
724
728
|
|
@@ -766,12 +770,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
766
770
|
/**
|
767
771
|
* List files attached to a person
|
768
772
|
* Lists files associated with a person.
|
769
|
-
* @param {Number} id ID of
|
773
|
+
* @param {Number} id The ID of the person
|
770
774
|
* @param {Object} opts Optional parameters
|
771
775
|
* @param {Number} opts.start Pagination start (default to 0)
|
772
776
|
* @param {Number} opts.limit Items shown per page
|
773
777
|
* @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.
|
774
|
-
* @param {String} opts.sort
|
778
|
+
* @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.
|
775
779
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
776
780
|
*/
|
777
781
|
|
@@ -785,7 +789,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
785
789
|
/**
|
786
790
|
* List followers of a person
|
787
791
|
* Lists the followers of a person.
|
788
|
-
* @param {Number} id ID of
|
792
|
+
* @param {Number} id The ID of the person
|
789
793
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFollowersResponse} and HTTP response
|
790
794
|
*/
|
791
795
|
|
@@ -828,7 +832,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
828
832
|
/**
|
829
833
|
* List followers of a person
|
830
834
|
* Lists the followers of a person.
|
831
|
-
* @param {Number} id ID of
|
835
|
+
* @param {Number} id The ID of the person
|
832
836
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFollowersResponse}
|
833
837
|
*/
|
834
838
|
|
@@ -842,7 +846,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
842
846
|
/**
|
843
847
|
* List mail messages associated with a person
|
844
848
|
* Lists mail messages associated with a person.
|
845
|
-
* @param {Number} id ID of
|
849
|
+
* @param {Number} id The ID of the person
|
846
850
|
* @param {Object} opts Optional parameters
|
847
851
|
* @param {Number} opts.start Pagination start (default to 0)
|
848
852
|
* @param {Number} opts.limit Items shown per page
|
@@ -891,7 +895,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
891
895
|
/**
|
892
896
|
* List mail messages associated with a person
|
893
897
|
* Lists mail messages associated with a person.
|
894
|
-
* @param {Number} id ID of
|
898
|
+
* @param {Number} id The ID of the person
|
895
899
|
* @param {Object} opts Optional parameters
|
896
900
|
* @param {Number} opts.start Pagination start (default to 0)
|
897
901
|
* @param {Number} opts.limit Items shown per page
|
@@ -908,7 +912,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
908
912
|
/**
|
909
913
|
* List products associated with a person
|
910
914
|
* Lists products associated with a person.
|
911
|
-
* @param {Number} id ID of
|
915
|
+
* @param {Number} id The ID of the person
|
912
916
|
* @param {Object} opts Optional parameters
|
913
917
|
* @param {Number} opts.start Pagination start (default to 0)
|
914
918
|
* @param {Number} opts.limit Items shown per page
|
@@ -957,7 +961,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
957
961
|
/**
|
958
962
|
* List products associated with a person
|
959
963
|
* Lists products associated with a person.
|
960
|
-
* @param {Number} id ID of
|
964
|
+
* @param {Number} id The ID of the person
|
961
965
|
* @param {Object} opts Optional parameters
|
962
966
|
* @param {Number} opts.start Pagination start (default to 0)
|
963
967
|
* @param {Number} opts.limit Items shown per page
|
@@ -974,7 +978,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
974
978
|
/**
|
975
979
|
* List updates about a person
|
976
980
|
* Lists updates about a person.
|
977
|
-
* @param {Number} id ID of
|
981
|
+
* @param {Number} id The ID of the person
|
978
982
|
* @param {Object} opts Optional parameters
|
979
983
|
* @param {Number} opts.start Pagination start (default to 0)
|
980
984
|
* @param {Number} opts.limit Items shown per page
|
@@ -1027,7 +1031,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1027
1031
|
/**
|
1028
1032
|
* List updates about a person
|
1029
1033
|
* Lists updates about a person.
|
1030
|
-
* @param {Number} id ID of
|
1034
|
+
* @param {Number} id The ID of the person
|
1031
1035
|
* @param {Object} opts Optional parameters
|
1032
1036
|
* @param {Number} opts.start Pagination start (default to 0)
|
1033
1037
|
* @param {Number} opts.limit Items shown per page
|
@@ -1045,8 +1049,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1045
1049
|
}
|
1046
1050
|
/**
|
1047
1051
|
* List permitted users
|
1048
|
-
* List users permitted to access a person
|
1049
|
-
* @param {Number} id ID of
|
1052
|
+
* List users permitted to access a person.
|
1053
|
+
* @param {Number} id The ID of the person
|
1050
1054
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPermittedUsersResponse1} and HTTP response
|
1051
1055
|
*/
|
1052
1056
|
|
@@ -1088,8 +1092,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1088
1092
|
}
|
1089
1093
|
/**
|
1090
1094
|
* List permitted users
|
1091
|
-
* List users permitted to access a person
|
1092
|
-
* @param {Number} id ID of
|
1095
|
+
* List users permitted to access a person.
|
1096
|
+
* @param {Number} id The ID of the person
|
1093
1097
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPermittedUsersResponse1}
|
1094
1098
|
*/
|
1095
1099
|
|
@@ -1102,14 +1106,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1102
1106
|
}
|
1103
1107
|
/**
|
1104
1108
|
* Get all persons
|
1105
|
-
* Returns all persons
|
1109
|
+
* Returns all persons.
|
1106
1110
|
* @param {Object} opts Optional parameters
|
1107
1111
|
* @param {Number} opts.userId If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
|
1108
|
-
* @param {Number} opts.filterId ID of the filter to use
|
1109
|
-
* @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
|
1112
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
1113
|
+
* @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
|
1110
1114
|
* @param {Number} opts.start Pagination start (default to 0)
|
1111
1115
|
* @param {Number} opts.limit Items shown per page
|
1112
|
-
* @param {String} opts.sort
|
1116
|
+
* @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).
|
1113
1117
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllPersonsResponse} and HTTP response
|
1114
1118
|
*/
|
1115
1119
|
|
@@ -1151,14 +1155,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1151
1155
|
}
|
1152
1156
|
/**
|
1153
1157
|
* Get all persons
|
1154
|
-
* Returns all persons
|
1158
|
+
* Returns all persons.
|
1155
1159
|
* @param {Object} opts Optional parameters
|
1156
1160
|
* @param {Number} opts.userId If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
|
1157
|
-
* @param {Number} opts.filterId ID of the filter to use
|
1158
|
-
* @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
|
1161
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
1162
|
+
* @param {String} opts.firstChar If supplied, only persons whose name starts with the specified letter will be returned (case insensitive)
|
1159
1163
|
* @param {Number} opts.start Pagination start (default to 0)
|
1160
1164
|
* @param {Number} opts.limit Items shown per page
|
1161
|
-
* @param {String} opts.sort
|
1165
|
+
* @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).
|
1162
1166
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllPersonsResponse}
|
1163
1167
|
*/
|
1164
1168
|
|
@@ -1172,7 +1176,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1172
1176
|
/**
|
1173
1177
|
* Merge two persons
|
1174
1178
|
* Merges a person with another person. For more information on how to merge two persons, see <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
1175
|
-
* @param {Number} id ID of
|
1179
|
+
* @param {Number} id The ID of the person
|
1176
1180
|
* @param {Object} opts Optional parameters
|
1177
1181
|
* @param {module:model/MergePersonsRequest} opts.mergePersonsRequest
|
1178
1182
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MergePersonsResponse} and HTTP response
|
@@ -1188,6 +1192,10 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1188
1192
|
throw new Error("Missing the required parameter 'id' when calling mergePersons");
|
1189
1193
|
}
|
1190
1194
|
|
1195
|
+
if (opts['merge_with_id'] === undefined || opts['merge_with_id'] === null) {
|
1196
|
+
throw new Error("Missing the required parameter 'merge_with_id' when calling mergePersons");
|
1197
|
+
}
|
1198
|
+
|
1191
1199
|
var pathParams = {
|
1192
1200
|
'id': id
|
1193
1201
|
};
|
@@ -1217,7 +1225,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1217
1225
|
/**
|
1218
1226
|
* Merge two persons
|
1219
1227
|
* Merges a person with another person. For more information on how to merge two persons, see <a href=\"https://pipedrive.readme.io/docs/merging-two-persons\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
1220
|
-
* @param {Number} id ID of
|
1228
|
+
* @param {Number} id The ID of the person
|
1221
1229
|
* @param {Object} opts Optional parameters
|
1222
1230
|
* @param {module:model/MergePersonsRequest} opts.mergePersonsRequest
|
1223
1231
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MergePersonsResponse}
|
@@ -1232,13 +1240,13 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1232
1240
|
}
|
1233
1241
|
/**
|
1234
1242
|
* Search persons
|
1235
|
-
* Searches all
|
1243
|
+
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
1236
1244
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
1237
1245
|
* @param {Object} opts Optional parameters
|
1238
1246
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
1239
1247
|
* @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.
|
1240
|
-
* @param {Number} opts.organizationId Will filter
|
1241
|
-
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1248
|
+
* @param {Number} opts.organizationId Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
1249
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1242
1250
|
* @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)
|
1243
1251
|
* @param {Number} opts.limit Items shown per page
|
1244
1252
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PersonSearchResponse} and HTTP response
|
@@ -1288,13 +1296,13 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1288
1296
|
}
|
1289
1297
|
/**
|
1290
1298
|
* Search persons
|
1291
|
-
* Searches all
|
1299
|
+
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
1292
1300
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
1293
1301
|
* @param {Object} opts Optional parameters
|
1294
1302
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
1295
1303
|
* @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.
|
1296
|
-
* @param {Number} opts.organizationId Will filter
|
1297
|
-
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1304
|
+
* @param {Number} opts.organizationId Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
1305
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1298
1306
|
* @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)
|
1299
1307
|
* @param {Number} opts.limit Items shown per page
|
1300
1308
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PersonSearchResponse}
|
@@ -1310,7 +1318,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1310
1318
|
/**
|
1311
1319
|
* Update a person
|
1312
1320
|
* Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
1313
|
-
* @param {Number} id ID of
|
1321
|
+
* @param {Number} id The ID of the person
|
1314
1322
|
* @param {Object} opts Optional parameters
|
1315
1323
|
* @param {module:model/BasicPerson} opts.basicPerson
|
1316
1324
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdatePersonResponse} and HTTP response
|
@@ -1355,7 +1363,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1355
1363
|
/**
|
1356
1364
|
* Update a person
|
1357
1365
|
* Updates the properties of a person. For more information on how to update a person, see <a href=\"https://pipedrive.readme.io/docs/updating-a-person\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
1358
|
-
* @param {Number} id ID of
|
1366
|
+
* @param {Number} id The ID of the person
|
1359
1367
|
* @param {Object} opts Optional parameters
|
1360
1368
|
* @param {module:model/BasicPerson} opts.basicPerson
|
1361
1369
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdatePersonResponse}
|