pipedrive 13.0.8 → 13.0.12
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +20 -0
- package/README.md +18 -16
- package/dist/api/ActivitiesApi.js +44 -44
- package/dist/api/ActivityTypesApi.js +4 -4
- package/dist/api/CallLogsApi.js +6 -6
- package/dist/api/CurrenciesApi.js +2 -2
- package/dist/api/DealFieldsApi.js +10 -10
- package/dist/api/DealsApi.js +100 -100
- package/dist/api/FilesApi.js +34 -34
- package/dist/api/FiltersApi.js +2 -2
- package/dist/api/GlobalMessagesApi.js +8 -8
- package/dist/api/GoalsApi.js +54 -54
- package/dist/api/ItemSearchApi.js +4 -4
- package/dist/api/LeadLabelsApi.js +12 -12
- package/dist/api/LeadSourcesApi.js +2 -2
- package/dist/api/LeadsApi.js +18 -18
- package/dist/api/MailboxApi.js +26 -26
- package/dist/api/NoteFieldsApi.js +2 -2
- package/dist/api/NotesApi.js +42 -42
- package/dist/api/OrganizationFieldsApi.js +10 -10
- package/dist/api/OrganizationRelationshipsApi.js +12 -12
- package/dist/api/OrganizationsApi.js +50 -50
- package/dist/api/PermissionSetsApi.js +12 -12
- package/dist/api/PersonFieldsApi.js +10 -10
- package/dist/api/PersonsApi.js +74 -74
- package/dist/api/PipelinesApi.js +50 -50
- package/dist/api/ProductFieldsApi.js +10 -10
- package/dist/api/ProductsApi.js +44 -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 +34 -34
- package/dist/api/TeamsApi.js +32 -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 +14 -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 +51 -51
- 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 +17 -5
- 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 +33 -14
- 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 +51 -44
- 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 +1 -1
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
|
@@ -183,7 +183,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
183
183
|
/**
|
184
184
|
* Add a follower to a person
|
185
185
|
* Adds a follower to a person.
|
186
|
-
* @param {Number} id ID of
|
186
|
+
* @param {Number} id The ID of the person
|
187
187
|
* @param {Object} opts Optional parameters
|
188
188
|
* @param {module:model/AddPersonFollowerRequest} opts.addPersonFollowerRequest
|
189
189
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddFollowerToPersonResponse}
|
@@ -198,14 +198,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
198
198
|
}
|
199
199
|
/**
|
200
200
|
* Add person picture
|
201
|
-
*
|
202
|
-
* @param {Number} id ID of
|
203
|
-
* @param {File} file One image supplied in the multipart/form-data encoding
|
201
|
+
* 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.
|
202
|
+
* @param {Number} id The ID of the person
|
203
|
+
* @param {File} file One image supplied in the multipart/form-data encoding
|
204
204
|
* @param {Object} opts Optional parameters
|
205
205
|
* @param {Number} opts.cropX X coordinate to where start cropping form (in pixels)
|
206
206
|
* @param {Number} opts.cropY Y coordinate to where start cropping form (in pixels)
|
207
|
-
* @param {Number} opts.cropWidth
|
208
|
-
* @param {Number} opts.cropHeight
|
207
|
+
* @param {Number} opts.cropWidth The width of the cropping area (in pixels)
|
208
|
+
* @param {Number} opts.cropHeight The height of the cropping area (in pixels)
|
209
209
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddPersonPictureResponse} and HTTP response
|
210
210
|
*/
|
211
211
|
|
@@ -258,14 +258,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
258
258
|
}
|
259
259
|
/**
|
260
260
|
* Add person picture
|
261
|
-
*
|
262
|
-
* @param {Number} id ID of
|
263
|
-
* @param {File} file One image supplied in the multipart/form-data encoding
|
261
|
+
* 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.
|
262
|
+
* @param {Number} id The ID of the person
|
263
|
+
* @param {File} file One image supplied in the multipart/form-data encoding
|
264
264
|
* @param {Object} opts Optional parameters
|
265
265
|
* @param {Number} opts.cropX X coordinate to where start cropping form (in pixels)
|
266
266
|
* @param {Number} opts.cropY Y coordinate to where start cropping form (in pixels)
|
267
|
-
* @param {Number} opts.cropWidth
|
268
|
-
* @param {Number} opts.cropHeight
|
267
|
+
* @param {Number} opts.cropWidth The width of the cropping area (in pixels)
|
268
|
+
* @param {Number} opts.cropHeight The height of the cropping area (in pixels)
|
269
269
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddPersonPictureResponse}
|
270
270
|
*/
|
271
271
|
|
@@ -279,7 +279,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
279
279
|
/**
|
280
280
|
* Delete a person
|
281
281
|
* Marks a person as deleted.
|
282
|
-
* @param {Number} id ID of
|
282
|
+
* @param {Number} id The ID of the person
|
283
283
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
|
284
284
|
*/
|
285
285
|
|
@@ -322,7 +322,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
322
322
|
/**
|
323
323
|
* Delete a person
|
324
324
|
* Marks a person as deleted.
|
325
|
-
* @param {Number} id ID of
|
325
|
+
* @param {Number} id The ID of the person
|
326
326
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
|
327
327
|
*/
|
328
328
|
|
@@ -334,10 +334,10 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
334
334
|
});
|
335
335
|
}
|
336
336
|
/**
|
337
|
-
* Deletes a follower from a person.
|
338
337
|
* Delete a follower from a person
|
339
|
-
*
|
340
|
-
* @param {Number}
|
338
|
+
* Deletes a follower from a person.
|
339
|
+
* @param {Number} id The ID of the person
|
340
|
+
* @param {Number} followerId The ID of the follower
|
341
341
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
|
342
342
|
*/
|
343
343
|
|
@@ -384,10 +384,10 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
384
384
|
return this.apiClient.callApi('/persons/{id}/followers/{follower_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
385
385
|
}
|
386
386
|
/**
|
387
|
-
* Deletes a follower from a person.
|
388
387
|
* Delete a follower from a person
|
389
|
-
*
|
390
|
-
* @param {Number}
|
388
|
+
* Deletes a follower from a person.
|
389
|
+
* @param {Number} id The ID of the person
|
390
|
+
* @param {Number} followerId The ID of the follower
|
391
391
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
|
392
392
|
*/
|
393
393
|
|
@@ -400,8 +400,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
400
400
|
}
|
401
401
|
/**
|
402
402
|
* Delete person picture
|
403
|
-
*
|
404
|
-
* @param {Number} id ID of
|
403
|
+
* Deletes a person’s picture.
|
404
|
+
* @param {Number} id The ID of the person
|
405
405
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonResponse} and HTTP response
|
406
406
|
*/
|
407
407
|
|
@@ -443,8 +443,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
443
443
|
}
|
444
444
|
/**
|
445
445
|
* Delete person picture
|
446
|
-
*
|
447
|
-
* @param {Number} id ID of
|
446
|
+
* Deletes a person’s picture.
|
447
|
+
* @param {Number} id The ID of the person
|
448
448
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonResponse}
|
449
449
|
*/
|
450
450
|
|
@@ -459,7 +459,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
459
459
|
* Delete multiple persons in bulk
|
460
460
|
* Marks multiple persons as deleted.
|
461
461
|
* @param {Object} opts Optional parameters
|
462
|
-
* @param {String} opts.ids
|
462
|
+
* @param {String} opts.ids The comma-separated IDs that will be deleted
|
463
463
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePersonsInBulkResponse} and HTTP response
|
464
464
|
*/
|
465
465
|
|
@@ -498,7 +498,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
498
498
|
* Delete multiple persons in bulk
|
499
499
|
* Marks multiple persons as deleted.
|
500
500
|
* @param {Object} opts Optional parameters
|
501
|
-
* @param {String} opts.ids
|
501
|
+
* @param {String} opts.ids The comma-separated IDs that will be deleted
|
502
502
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePersonsInBulkResponse}
|
503
503
|
*/
|
504
504
|
|
@@ -511,8 +511,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
511
511
|
}
|
512
512
|
/**
|
513
513
|
* 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
|
514
|
+
* 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.
|
515
|
+
* @param {Number} id The ID of the person
|
516
516
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetPersonDetailsResponse} and HTTP response
|
517
517
|
*/
|
518
518
|
|
@@ -554,8 +554,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
554
554
|
}
|
555
555
|
/**
|
556
556
|
* 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
|
557
|
+
* 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.
|
558
|
+
* @param {Number} id The ID of the person
|
559
559
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetPersonDetailsResponse}
|
560
560
|
*/
|
561
561
|
|
@@ -569,11 +569,11 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
569
569
|
/**
|
570
570
|
* List activities associated with a person
|
571
571
|
* Lists activities associated with a person.
|
572
|
-
* @param {Number} id ID of
|
572
|
+
* @param {Number} id The ID of the person
|
573
573
|
* @param {Object} opts Optional parameters
|
574
574
|
* @param {Number} opts.start Pagination start (default to 0)
|
575
575
|
* @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.
|
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.
|
577
577
|
* @param {String} opts.exclude A comma-separated string of activity IDs to exclude from result
|
578
578
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListActivitiesResponse} and HTTP response
|
579
579
|
*/
|
@@ -622,11 +622,11 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
622
622
|
/**
|
623
623
|
* List activities associated with a person
|
624
624
|
* Lists activities associated with a person.
|
625
|
-
* @param {Number} id ID of
|
625
|
+
* @param {Number} id The ID of the person
|
626
626
|
* @param {Object} opts Optional parameters
|
627
627
|
* @param {Number} opts.start Pagination start (default to 0)
|
628
628
|
* @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.
|
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.
|
630
630
|
* @param {String} opts.exclude A comma-separated string of activity IDs to exclude from result
|
631
631
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListActivitiesResponse}
|
632
632
|
*/
|
@@ -641,12 +641,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
641
641
|
/**
|
642
642
|
* List deals associated with a person
|
643
643
|
* Lists deals associated with a person.
|
644
|
-
* @param {Number} id ID of
|
644
|
+
* @param {Number} id The ID of the person
|
645
645
|
* @param {Object} opts Optional parameters
|
646
646
|
* @param {Number} opts.start Pagination start (default to 0)
|
647
647
|
* @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
|
648
|
+
* @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')
|
649
|
+
* @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
650
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListDealsResponse} and HTTP response
|
651
651
|
*/
|
652
652
|
|
@@ -694,12 +694,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
694
694
|
/**
|
695
695
|
* List deals associated with a person
|
696
696
|
* Lists deals associated with a person.
|
697
|
-
* @param {Number} id ID of
|
697
|
+
* @param {Number} id The ID of the person
|
698
698
|
* @param {Object} opts Optional parameters
|
699
699
|
* @param {Number} opts.start Pagination start (default to 0)
|
700
700
|
* @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
|
701
|
+
* @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')
|
702
|
+
* @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
703
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListDealsResponse}
|
704
704
|
*/
|
705
705
|
|
@@ -713,12 +713,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
713
713
|
/**
|
714
714
|
* List files attached to a person
|
715
715
|
* Lists files associated with a person.
|
716
|
-
* @param {Number} id ID of
|
716
|
+
* @param {Number} id The ID of the person
|
717
717
|
* @param {Object} opts Optional parameters
|
718
718
|
* @param {Number} opts.start Pagination start (default to 0)
|
719
719
|
* @param {Number} opts.limit Items shown per page
|
720
720
|
* @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
|
721
|
+
* @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
722
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
723
723
|
*/
|
724
724
|
|
@@ -766,12 +766,12 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
766
766
|
/**
|
767
767
|
* List files attached to a person
|
768
768
|
* Lists files associated with a person.
|
769
|
-
* @param {Number} id ID of
|
769
|
+
* @param {Number} id The ID of the person
|
770
770
|
* @param {Object} opts Optional parameters
|
771
771
|
* @param {Number} opts.start Pagination start (default to 0)
|
772
772
|
* @param {Number} opts.limit Items shown per page
|
773
773
|
* @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
|
774
|
+
* @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
775
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
776
776
|
*/
|
777
777
|
|
@@ -785,7 +785,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
785
785
|
/**
|
786
786
|
* List followers of a person
|
787
787
|
* Lists the followers of a person.
|
788
|
-
* @param {Number} id ID of
|
788
|
+
* @param {Number} id The ID of the person
|
789
789
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFollowersResponse} and HTTP response
|
790
790
|
*/
|
791
791
|
|
@@ -828,7 +828,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
828
828
|
/**
|
829
829
|
* List followers of a person
|
830
830
|
* Lists the followers of a person.
|
831
|
-
* @param {Number} id ID of
|
831
|
+
* @param {Number} id The ID of the person
|
832
832
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFollowersResponse}
|
833
833
|
*/
|
834
834
|
|
@@ -842,7 +842,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
842
842
|
/**
|
843
843
|
* List mail messages associated with a person
|
844
844
|
* Lists mail messages associated with a person.
|
845
|
-
* @param {Number} id ID of
|
845
|
+
* @param {Number} id The ID of the person
|
846
846
|
* @param {Object} opts Optional parameters
|
847
847
|
* @param {Number} opts.start Pagination start (default to 0)
|
848
848
|
* @param {Number} opts.limit Items shown per page
|
@@ -891,7 +891,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
891
891
|
/**
|
892
892
|
* List mail messages associated with a person
|
893
893
|
* Lists mail messages associated with a person.
|
894
|
-
* @param {Number} id ID of
|
894
|
+
* @param {Number} id The ID of the person
|
895
895
|
* @param {Object} opts Optional parameters
|
896
896
|
* @param {Number} opts.start Pagination start (default to 0)
|
897
897
|
* @param {Number} opts.limit Items shown per page
|
@@ -908,7 +908,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
908
908
|
/**
|
909
909
|
* List products associated with a person
|
910
910
|
* Lists products associated with a person.
|
911
|
-
* @param {Number} id ID of
|
911
|
+
* @param {Number} id The ID of the person
|
912
912
|
* @param {Object} opts Optional parameters
|
913
913
|
* @param {Number} opts.start Pagination start (default to 0)
|
914
914
|
* @param {Number} opts.limit Items shown per page
|
@@ -957,7 +957,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
957
957
|
/**
|
958
958
|
* List products associated with a person
|
959
959
|
* Lists products associated with a person.
|
960
|
-
* @param {Number} id ID of
|
960
|
+
* @param {Number} id The ID of the person
|
961
961
|
* @param {Object} opts Optional parameters
|
962
962
|
* @param {Number} opts.start Pagination start (default to 0)
|
963
963
|
* @param {Number} opts.limit Items shown per page
|
@@ -974,7 +974,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
974
974
|
/**
|
975
975
|
* List updates about a person
|
976
976
|
* Lists updates about a person.
|
977
|
-
* @param {Number} id ID of
|
977
|
+
* @param {Number} id The ID of the person
|
978
978
|
* @param {Object} opts Optional parameters
|
979
979
|
* @param {Number} opts.start Pagination start (default to 0)
|
980
980
|
* @param {Number} opts.limit Items shown per page
|
@@ -1027,7 +1027,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1027
1027
|
/**
|
1028
1028
|
* List updates about a person
|
1029
1029
|
* Lists updates about a person.
|
1030
|
-
* @param {Number} id ID of
|
1030
|
+
* @param {Number} id The ID of the person
|
1031
1031
|
* @param {Object} opts Optional parameters
|
1032
1032
|
* @param {Number} opts.start Pagination start (default to 0)
|
1033
1033
|
* @param {Number} opts.limit Items shown per page
|
@@ -1045,8 +1045,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1045
1045
|
}
|
1046
1046
|
/**
|
1047
1047
|
* List permitted users
|
1048
|
-
* List users permitted to access a person
|
1049
|
-
* @param {Number} id ID of
|
1048
|
+
* List users permitted to access a person.
|
1049
|
+
* @param {Number} id The ID of the person
|
1050
1050
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPermittedUsersResponse1} and HTTP response
|
1051
1051
|
*/
|
1052
1052
|
|
@@ -1088,8 +1088,8 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1088
1088
|
}
|
1089
1089
|
/**
|
1090
1090
|
* List permitted users
|
1091
|
-
* List users permitted to access a person
|
1092
|
-
* @param {Number} id ID of
|
1091
|
+
* List users permitted to access a person.
|
1092
|
+
* @param {Number} id The ID of the person
|
1093
1093
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPermittedUsersResponse1}
|
1094
1094
|
*/
|
1095
1095
|
|
@@ -1102,14 +1102,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1102
1102
|
}
|
1103
1103
|
/**
|
1104
1104
|
* Get all persons
|
1105
|
-
* Returns all persons
|
1105
|
+
* Returns all persons.
|
1106
1106
|
* @param {Object} opts Optional parameters
|
1107
1107
|
* @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)
|
1108
|
+
* @param {Number} opts.filterId The 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)
|
1110
1110
|
* @param {Number} opts.start Pagination start (default to 0)
|
1111
1111
|
* @param {Number} opts.limit Items shown per page
|
1112
|
-
* @param {String} opts.sort
|
1112
|
+
* @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
1113
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllPersonsResponse} and HTTP response
|
1114
1114
|
*/
|
1115
1115
|
|
@@ -1151,14 +1151,14 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1151
1151
|
}
|
1152
1152
|
/**
|
1153
1153
|
* Get all persons
|
1154
|
-
* Returns all persons
|
1154
|
+
* Returns all persons.
|
1155
1155
|
* @param {Object} opts Optional parameters
|
1156
1156
|
* @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)
|
1157
|
+
* @param {Number} opts.filterId The 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)
|
1159
1159
|
* @param {Number} opts.start Pagination start (default to 0)
|
1160
1160
|
* @param {Number} opts.limit Items shown per page
|
1161
|
-
* @param {String} opts.sort
|
1161
|
+
* @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
1162
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllPersonsResponse}
|
1163
1163
|
*/
|
1164
1164
|
|
@@ -1172,7 +1172,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1172
1172
|
/**
|
1173
1173
|
* Merge two persons
|
1174
1174
|
* 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
|
1175
|
+
* @param {Number} id The ID of the person
|
1176
1176
|
* @param {Object} opts Optional parameters
|
1177
1177
|
* @param {module:model/MergePersonsRequest} opts.mergePersonsRequest
|
1178
1178
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MergePersonsResponse} and HTTP response
|
@@ -1217,7 +1217,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1217
1217
|
/**
|
1218
1218
|
* Merge two persons
|
1219
1219
|
* 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
|
1220
|
+
* @param {Number} id The ID of the person
|
1221
1221
|
* @param {Object} opts Optional parameters
|
1222
1222
|
* @param {module:model/MergePersonsRequest} opts.mergePersonsRequest
|
1223
1223
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MergePersonsResponse}
|
@@ -1232,13 +1232,13 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1232
1232
|
}
|
1233
1233
|
/**
|
1234
1234
|
* Search persons
|
1235
|
-
* Searches all
|
1235
|
+
* 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
1236
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
1237
1237
|
* @param {Object} opts Optional parameters
|
1238
1238
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
1239
1239
|
* @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
|
1240
|
+
* @param {Number} opts.organizationId Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
1241
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1242
1242
|
* @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
1243
|
* @param {Number} opts.limit Items shown per page
|
1244
1244
|
* @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 +1288,13 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1288
1288
|
}
|
1289
1289
|
/**
|
1290
1290
|
* Search persons
|
1291
|
-
* Searches all
|
1291
|
+
* 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
1292
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
1293
1293
|
* @param {Object} opts Optional parameters
|
1294
1294
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
1295
1295
|
* @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
|
1296
|
+
* @param {Number} opts.organizationId Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
1297
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
1298
1298
|
* @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
1299
|
* @param {Number} opts.limit Items shown per page
|
1300
1300
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PersonSearchResponse}
|
@@ -1310,7 +1310,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1310
1310
|
/**
|
1311
1311
|
* Update a person
|
1312
1312
|
* 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
|
1313
|
+
* @param {Number} id The ID of the person
|
1314
1314
|
* @param {Object} opts Optional parameters
|
1315
1315
|
* @param {module:model/BasicPerson} opts.basicPerson
|
1316
1316
|
* @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 +1355,7 @@ var PersonsApi = /*#__PURE__*/function () {
|
|
1355
1355
|
/**
|
1356
1356
|
* Update a person
|
1357
1357
|
* 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
|
1358
|
+
* @param {Number} id The ID of the person
|
1359
1359
|
* @param {Object} opts Optional parameters
|
1360
1360
|
* @param {module:model/BasicPerson} opts.basicPerson
|
1361
1361
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdatePersonResponse}
|