pipedrive 13.0.11 → 13.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +18 -0
- package/README.md +23 -20
- package/dist/ApiClient.js +46 -9
- package/dist/api/ActivitiesApi.js +44 -44
- package/dist/api/ActivityTypesApi.js +36 -36
- package/dist/api/CallLogsApi.js +23 -6
- package/dist/api/CurrenciesApi.js +2 -2
- package/dist/api/DealFieldsApi.js +18 -18
- package/dist/api/DealsApi.js +122 -110
- package/dist/api/FilesApi.js +38 -38
- package/dist/api/FiltersApi.js +23 -6
- package/dist/api/GlobalMessagesApi.js +8 -8
- package/dist/api/GoalsApi.js +54 -54
- package/dist/api/ItemSearchApi.js +6 -6
- package/dist/api/LeadLabelsApi.js +21 -12
- package/dist/api/LeadSourcesApi.js +2 -2
- package/dist/api/LeadsApi.js +23 -18
- package/dist/api/MailboxApi.js +26 -26
- package/dist/api/NoteFieldsApi.js +2 -2
- package/dist/api/NotesApi.js +50 -42
- package/dist/api/OrganizationFieldsApi.js +16 -16
- package/dist/api/OrganizationRelationshipsApi.js +25 -12
- package/dist/api/OrganizationsApi.js +64 -56
- package/dist/api/PermissionSetsApi.js +12 -12
- package/dist/api/PersonFieldsApi.js +16 -16
- package/dist/api/PersonsApi.js +92 -84
- package/dist/api/PipelinesApi.js +50 -50
- package/dist/api/ProductFieldsApi.js +29 -16
- package/dist/api/ProductsApi.js +50 -46
- package/dist/api/RecentsApi.js +6 -6
- package/dist/api/RolesApi.js +38 -38
- package/dist/api/StagesApi.js +14 -14
- package/dist/api/SubscriptionsApi.js +76 -34
- package/dist/api/TeamsApi.js +49 -32
- package/dist/api/UserConnectionsApi.js +2 -2
- package/dist/api/UserSettingsApi.js +2 -2
- package/dist/api/UsersApi.js +44 -44
- package/dist/api/WebhooksApi.js +27 -14
- package/dist/index.js +24 -0
- package/dist/model/ActivityDistributionDataActivityDistribution.js +1 -1
- package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.js +4 -4
- package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERIDActivities.js +2 -2
- package/dist/model/ActivityInfo.js +5 -5
- package/dist/model/ActivityObjectFragment.js +9 -9
- package/dist/model/ActivityPostObject.js +32 -32
- package/dist/model/ActivityPostObjectAllOf.js +7 -7
- package/dist/model/ActivityPutObject.js +32 -32
- package/dist/model/ActivityPutObjectAllOf.js +7 -7
- package/dist/model/ActivityResponseObject.js +96 -96
- package/dist/model/ActivityResponseObjectAllOf.js +39 -39
- package/dist/model/ActivityTypeBulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/ActivityTypeListResponse.js +2 -2
- package/dist/model/ActivityTypeListResponseAllOf.js +1 -1
- package/dist/model/ActivityTypeObjectResponse.js +9 -9
- package/dist/model/AddDealFollowerRequest.js +2 -2
- package/dist/model/AddDealParticipantRequest.js +2 -2
- package/dist/model/AddFollowerToPersonResponseAllOfData.js +4 -4
- package/dist/model/AddLeadLabelRequest.js +2 -2
- package/dist/model/AddLeadRequest.js +9 -9
- package/dist/model/AddNoteRequest.js +22 -22
- package/dist/model/AddNoteRequestAllOf.js +4 -4
- package/dist/model/AddOrganizationRelationshipRequest.js +5 -5
- package/dist/model/AddPersonFollowerRequest.js +2 -2
- package/dist/model/AddProductAttachmentDetails.js +36 -36
- package/dist/model/AddProductAttachmentDetailsAllOf.js +1 -1
- package/dist/model/AddProductFollowerRequest.js +2 -2
- package/dist/model/AddProductRequestBody.js +12 -12
- package/dist/model/AddTeamUserRequest.js +2 -2
- package/dist/model/AddWebhookRequest.js +7 -7
- package/dist/model/AddedDealFollowerData.js +4 -4
- package/dist/model/AdditionalBaseOrganizationItemInfo.js +64 -64
- package/dist/model/AdditionalDataWithPagination.js +1 -1
- package/dist/model/AdditionalMergePersonInfo.js +60 -60
- package/dist/model/AdditionalPersonInfo.js +50 -50
- package/dist/model/AllOrganizationRelationshipsGetResponse.js +2 -2
- package/dist/model/AllOrganizationRelationshipsGetResponseAllOf.js +1 -1
- package/dist/model/AllOrganizationsGetResponse.js +2 -2
- package/dist/model/AllOrganizationsGetResponseAllOf.js +1 -1
- package/dist/model/Assignee.js +3 -3
- package/dist/model/BaseComment.js +7 -7
- package/dist/model/BaseCurrency.js +7 -7
- package/dist/model/BaseDeal.js +51 -51
- package/dist/model/BaseNote.js +14 -14
- package/dist/model/BaseNoteDealTitle.js +2 -2
- package/dist/model/BaseNoteOrganization.js +2 -2
- package/dist/model/BaseNotePerson.js +2 -2
- package/dist/model/BaseOrganizationItem.js +86 -86
- package/dist/model/BaseOrganizationItemFields.js +11 -11
- package/dist/model/BaseOrganizationItemWithEditNameFlag.js +88 -88
- package/dist/model/BaseOrganizationItemWithEditNameFlagAllOf.js +1 -1
- package/dist/model/BaseOrganizationRelationshipItem.js +5 -5
- package/dist/model/BasePersonItem.js +13 -13
- package/dist/model/BasePersonItemEmail.js +2 -2
- package/dist/model/BasePersonItemPhone.js +3 -3
- package/dist/model/BasePipeline.js +8 -8
- package/dist/model/BasePipelineWithSelectedFlag.js +18 -18
- package/dist/model/BasePipelineWithSelectedFlagAllOf.js +1 -1
- package/dist/model/BaseProduct.js +3 -3
- package/dist/model/BaseRole.js +3 -3
- package/dist/model/BaseStage.js +10 -10
- package/dist/model/BaseTeam.js +20 -20
- package/dist/model/BaseTeamAdditionalProperties.js +2 -2
- package/dist/model/BaseUser.js +19 -19
- package/dist/model/BaseUserMe.js +48 -48
- package/dist/model/BaseUserMeAllOf.js +5 -5
- package/dist/model/BaseUserMeAllOfLanguage.js +1 -1
- package/dist/model/BaseWebhook.js +3 -3
- package/dist/model/BasicDeal.js +10 -10
- package/dist/model/BasicDealProduct.js +6 -6
- package/dist/model/BasicGoal.js +6 -6
- package/dist/model/BasicOrganization.js +3 -3
- package/dist/model/BasicPerson.js +23 -10
- package/dist/model/BasicPersonEmail.js +112 -0
- package/dist/model/BasicProductField.js +3 -3
- package/dist/model/BulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/CalculatedFields.js +2 -2
- package/dist/model/CallLogObject.js +6 -6
- package/dist/model/CommentPostPutObject.js +2 -2
- package/dist/model/CreateTeam.js +6 -6
- package/dist/model/Currencies.js +1 -1
- package/dist/model/DealCountAndActivityInfo.js +26 -26
- package/dist/model/DealFlowResponseAllOfData.js +1 -1
- package/dist/model/DealListActivitiesResponse.js +2 -2
- package/dist/model/DealListActivitiesResponseAllOf.js +1 -1
- package/dist/model/DealNonStrict.js +104 -104
- package/dist/model/DealNonStrictModeFields.js +1 -1
- package/dist/model/DealNonStrictModeFieldsCreatorUserId.js +6 -6
- package/dist/model/DealNonStrictWithDetails.js +110 -110
- package/dist/model/DealNonStrictWithDetailsAllOf.js +3 -3
- package/dist/model/DealNonStrictWithDetailsAllOfAge.js +1 -1
- package/dist/model/DealNonStrictWithDetailsAllOfAverageTimeToWon.js +1 -1
- package/dist/model/DealNonStrictWithDetailsAllOfStayInPipelineStages.js +3 -3
- package/dist/model/DealOrganizationData.js +7 -7
- package/dist/model/DealOrganizationDataWithId.js +14 -14
- package/dist/model/DealOrganizationDataWithIdAllOf.js +1 -1
- package/dist/model/DealParticipantCountInfo.js +2 -2
- package/dist/model/DealParticipants.js +1 -1
- package/dist/model/DealPersonData.js +10 -10
- package/dist/model/DealPersonDataEmail.js +112 -0
- package/dist/model/DealPersonDataPhone.js +1 -1
- package/dist/model/DealPersonDataWithId.js +17 -17
- package/dist/model/DealPersonDataWithIdAllOf.js +1 -1
- package/dist/model/DealSearchItemItem.js +8 -8
- package/dist/model/DealSearchItemItemOrganization.js +2 -2
- package/dist/model/DealSearchItemItemOwner.js +1 -1
- package/dist/model/DealSearchItemItemPerson.js +2 -2
- package/dist/model/DealSearchItemItemStage.js +2 -2
- package/dist/model/DealSearchResponseAllOfData.js +1 -1
- package/dist/model/DealStrict.js +112 -112
- package/dist/model/DealStrictModeFields.js +5 -5
- package/dist/model/DealStrictWithMergeId.js +114 -114
- package/dist/model/DealStrictWithMergeIdAllOf.js +1 -1
- package/dist/model/DealSummaryPerStages.js +1 -1
- package/dist/model/DealTitleParameter.js +1 -1
- package/dist/model/DealUserData.js +7 -7
- package/dist/model/DealUserDataWithId.js +14 -14
- package/dist/model/DealUserDataWithIdAllOf.js +1 -1
- package/dist/model/DealsCountAndActivityInfo.js +26 -26
- package/dist/model/DealsCountInfo.js +8 -8
- package/dist/model/DealsMovementsInfo.js +2 -2
- package/dist/model/DealsMovementsInfoFormattedValues.js +2 -2
- package/dist/model/DealsMovementsInfoValues.js +2 -2
- package/dist/model/DeleteActivitiesResponse200Data.js +1 -1
- package/dist/model/DeleteActivityResponse200Data.js +1 -1
- package/dist/model/DeleteDealData.js +1 -1
- package/dist/model/DeleteDealFollowerData.js +1 -1
- package/dist/model/DeleteDealParticipantData.js +1 -1
- package/dist/model/DeleteDealProductData.js +2 -2
- package/dist/model/DeleteFileData.js +1 -1
- package/dist/model/DeleteMultipleDealsData.js +1 -1
- package/dist/model/DeleteMultipleProductFieldsResponseData.js +1 -1
- package/dist/model/DeletePersonResponseAllOfData.js +1 -1
- package/dist/model/DeletePersonsInBulkResponseAllOfData.js +1 -1
- package/dist/model/DeleteProductFieldResponseData.js +1 -1
- package/dist/model/DeleteProductFollowerResponseData.js +1 -1
- package/dist/model/DeleteProductResponseData.js +1 -1
- package/dist/model/DeleteResponseAllOfData.js +1 -1
- package/dist/model/DeleteRoleAllOfData.js +1 -1
- package/dist/model/DeleteRoleAssignmentAllOfData.js +1 -1
- package/dist/model/DeleteStageResponse200Data.js +1 -1
- package/dist/model/DeleteStagesResponse200Data.js +1 -1
- package/dist/model/DeleteTeamUserRequest.js +2 -2
- package/dist/model/Duration.js +3 -3
- package/dist/model/EditPipeline.js +2 -2
- package/dist/model/EditPipelineAllOf.js +1 -1
- package/dist/model/EmailInfo.js +2 -2
- package/dist/model/ExpectedOutcome.js +3 -3
- package/dist/model/Field.js +18 -18
- package/dist/model/FieldCreateRequest.js +5 -5
- package/dist/model/FieldCreateRequestAllOf.js +3 -3
- package/dist/model/FieldUpdateRequest.js +1 -1
- package/dist/model/FileData.js +24 -24
- package/dist/model/FileItem.js +24 -24
- package/dist/model/FiltersPostResponseAllOfData.js +1 -1
- package/dist/model/FullRole.js +12 -12
- package/dist/model/FullRoleAllOf.js +1 -1
- package/dist/model/GetAddProductAttachementDetails.js +1 -1
- package/dist/model/GetAddedDeal.js +1 -1
- package/dist/model/GetAddedDealAdditionalData.js +1 -1
- package/dist/model/GetAllPersonsResponse.js +2 -2
- package/dist/model/GetAllPersonsResponseAllOf.js +1 -1
- package/dist/model/GetAllProductFieldsResponse.js +2 -2
- package/dist/model/GetComments.js +1 -1
- package/dist/model/GetDealAdditionalData.js +1 -1
- package/dist/model/GetDeals.js +1 -1
- package/dist/model/GetDealsConversionRatesInPipelineAllOfData.js +4 -4
- package/dist/model/GetDealsMovementsInPipelineAllOfData.js +1 -1
- package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.js +3 -3
- package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.js +3 -3
- package/dist/model/GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.js +2 -2
- package/dist/model/GetDealsSummaryData.js +6 -6
- package/dist/model/GetDealsSummaryDataValuesTotal.js +6 -6
- package/dist/model/GetDealsSummaryDataWeightedValuesTotal.js +4 -4
- package/dist/model/GetDealsTimelineData.js +1 -1
- package/dist/model/GetDealsTimelineDataTotals.js +9 -9
- package/dist/model/GetDuplicatedDeal.js +1 -1
- package/dist/model/GetLeadSourcesResponse200Data.js +1 -1
- package/dist/model/GetNotes.js +1 -1
- package/dist/model/GetPersonDetailsResponseAllOfAdditionalData.js +1 -1
- package/dist/model/GetProductAttachementDetails.js +1 -1
- package/dist/model/GetProductFieldResponse.js +1 -1
- package/dist/model/GetRecentsAdditionalData.js +2 -2
- package/dist/model/GetRoleAllOfAdditionalData.js +1 -1
- package/dist/model/GetRoleAssignments.js +2 -2
- package/dist/model/GetRoleAssignmentsAllOf.js +1 -1
- package/dist/model/GetRoles.js +2 -2
- package/dist/model/GetRolesAllOf.js +1 -1
- package/dist/model/GetStageDeals.js +1 -1
- package/dist/model/GetStages.js +1 -1
- package/dist/model/GlobalMessageData.js +6 -6
- package/dist/model/GlobalMessageGet.js +2 -2
- package/dist/model/GlobalMessageGetAllOf.js +1 -1
- package/dist/model/GlobalMessageUserData.js +3 -3
- package/dist/model/GoalResults.js +1 -1
- package/dist/model/GoalType.js +2 -2
- package/dist/model/GoalsResponseComponent.js +4 -4
- package/dist/model/LeadLabelResponse.js +4 -4
- package/dist/model/LeadResponse.js +16 -16
- package/dist/model/LeadValue.js +1 -1
- package/dist/model/ListActivitiesResponse.js +2 -2
- package/dist/model/ListActivitiesResponseAllOf.js +1 -1
- package/dist/model/ListDealsResponse.js +2 -2
- package/dist/model/ListDealsResponseAllOf.js +1 -1
- package/dist/model/ListFilesResponse.js +2 -2
- package/dist/model/ListFilesResponseAllOf.js +1 -1
- package/dist/model/ListFollowersResponse.js +2 -2
- package/dist/model/ListFollowersResponseAllOf.js +1 -1
- package/dist/model/ListFollowersResponseAllOfData.js +4 -4
- package/dist/model/ListMailMessagesResponse.js +2 -2
- package/dist/model/ListMailMessagesResponseAllOf.js +1 -1
- package/dist/model/ListPermittedUsersResponse1.js +2 -2
- package/dist/model/ListPermittedUsersResponse1AllOf.js +1 -1
- package/dist/model/ListPermittedUsersResponseAllOfData.js +1 -1
- package/dist/model/ListPersonProductsResponse.js +2 -2
- package/dist/model/ListPersonProductsResponseAllOf.js +1 -1
- package/dist/model/ListPersonsResponse.js +2 -2
- package/dist/model/ListPersonsResponseAllOf.js +1 -1
- package/dist/model/ListProductAdditionalData.js +10 -10
- package/dist/model/ListProductAdditionalDataAllOf.js +5 -5
- package/dist/model/ListProductFollowersResponse.js +2 -2
- package/dist/model/ListProductFollowersResponseAllOf.js +1 -1
- package/dist/model/ListProductFollowersResponseAllOfData.js +4 -4
- package/dist/model/ListProductsResponseAllOfData.js +1 -1
- package/dist/model/MarketingStatus.js +69 -0
- package/dist/model/MergeDealsRequest.js +2 -2
- package/dist/model/MergeOrganizationsRequest.js +2 -2
- package/dist/model/MergePersonDealRelatedInfo.js +30 -30
- package/dist/model/MergePersonItem.js +86 -86
- package/dist/model/MergePersonsRequest.js +2 -2
- package/dist/model/NewDeal.js +25 -25
- package/dist/model/NewDealAllOf.js +1 -1
- package/dist/model/NewDealProduct.js +16 -16
- package/dist/model/NewDealProductAllOf.js +2 -2
- package/dist/model/NewFollowerResponseData.js +4 -4
- package/dist/model/NewGoal.js +12 -12
- package/dist/model/NewOrganization.js +9 -9
- package/dist/model/NewOrganizationAllOf.js +1 -1
- package/dist/model/NewPerson.js +40 -21
- package/dist/model/NewPersonAllOf.js +1 -1
- package/dist/model/NewProductField.js +4 -4
- package/dist/model/Note.js +19 -19
- package/dist/model/NoteConnectToParams.js +2 -2
- package/dist/model/NoteCreatorUser.js +5 -5
- package/dist/model/NoteField.js +7 -7
- package/dist/model/NoteParams.js +7 -7
- package/dist/model/OrganizationAddressInfo.js +11 -11
- package/dist/model/OrganizationCountAndAddressInfo.js +38 -38
- package/dist/model/OrganizationCountInfo.js +8 -8
- package/dist/model/OrganizationData.js +5 -5
- package/dist/model/OrganizationDataWithId.js +13 -13
- package/dist/model/OrganizationDataWithIdAllOf.js +1 -1
- package/dist/model/OrganizationDataWithIdAndActiveFlag.js +15 -15
- package/dist/model/OrganizationDataWithIdAndActiveFlagAllOf.js +1 -1
- package/dist/model/OrganizationDeleteResponseData.js +1 -1
- package/dist/model/OrganizationDetailsGetResponseAllOfAdditionalData.js +1 -1
- package/dist/model/OrganizationFlowResponseAllOfData.js +1 -1
- package/dist/model/OrganizationFollowerDeleteResponseData.js +1 -1
- package/dist/model/OrganizationFollowerItem.js +2 -2
- package/dist/model/OrganizationFollowerItemAllOf.js +1 -1
- package/dist/model/OrganizationItem.js +88 -88
- package/dist/model/OrganizationRelationship.js +1 -1
- package/dist/model/OrganizationRelationshipDeleteResponseAllOfData.js +1 -1
- package/dist/model/OrganizationRelationshipDetails.js +16 -16
- package/dist/model/OrganizationRelationshipWithCalculatedFields.js +14 -14
- package/dist/model/OrganizationSearchItemItem.js +5 -5
- package/dist/model/OrganizationsDeleteResponseData.js +1 -1
- package/dist/model/OrganizationsMergeResponseData.js +1 -1
- package/dist/model/Owner.js +12 -12
- package/dist/model/Params.js +2 -2
- package/dist/model/PaymentItem.js +13 -13
- package/dist/model/PermissionSets.js +2 -2
- package/dist/model/PermissionSetsAllOf.js +1 -1
- package/dist/model/PermissionSetsItem.js +3 -3
- package/dist/model/PersonCountAndEmailInfo.js +18 -18
- package/dist/model/PersonCountEmailDealAndActivityInfo.js +44 -44
- package/dist/model/PersonCountInfo.js +7 -7
- package/dist/model/PersonData.js +5 -5
- package/dist/model/PersonDataEmail.js +2 -2
- package/dist/model/PersonDataPhone.js +2 -2
- package/dist/model/PersonDataWithActiveFlag.js +13 -13
- package/dist/model/PersonDataWithActiveFlagAllOf.js +1 -1
- package/dist/model/PersonFlowResponseAllOfData.js +1 -1
- package/dist/model/PersonItem.js +76 -76
- package/dist/model/PersonListProduct.js +14 -14
- package/dist/model/PersonNameCountAndEmailInfo.js +24 -24
- package/dist/model/PersonNameCountAndEmailInfoWithIds.js +30 -30
- package/dist/model/PersonNameCountAndEmailInfoWithIdsAllOf.js +3 -3
- package/dist/model/PersonNameInfo.js +3 -3
- package/dist/model/PersonNameInfoWithOrgAndOwnerId.js +6 -6
- package/dist/model/PersonSearchItemItem.js +4 -4
- package/dist/model/PersonSearchItemItemOrganization.js +2 -2
- package/dist/model/PersonSearchItemItemOwner.js +1 -1
- package/dist/model/PictureData.js +2 -2
- package/dist/model/PictureDataWithID.js +4 -4
- package/dist/model/PictureDataWithValue.js +4 -4
- package/dist/model/Pipeline.js +4 -4
- package/dist/model/PipelineDetails.js +19 -19
- package/dist/model/PostDealParticipants.js +1 -1
- package/dist/model/PostRoleAssignmentAllOfData.js +2 -2
- package/dist/model/PostRoleSettingsAllOfData.js +1 -1
- package/dist/model/PostRolesAllOfData.js +1 -1
- package/dist/model/ProductAttachementFields.js +12 -12
- package/dist/model/ProductAttachmentDetails.js +35 -35
- package/dist/model/ProductBaseDeal.js +42 -42
- package/dist/model/ProductField.js +36 -36
- package/dist/model/ProductFieldAllOf.js +15 -15
- package/dist/model/ProductListItem.js +21 -21
- package/dist/model/ProductRequest.js +6 -6
- package/dist/model/ProductSearchItemItem.js +5 -5
- package/dist/model/ProductSearchItemItemOwner.js +1 -1
- package/dist/model/ProductWithArrayPrices.js +6 -6
- package/dist/model/ProductWithObjectPrices.js +6 -6
- package/dist/model/ProductsResponse.js +1 -1
- package/dist/model/RecentDataProduct.js +15 -15
- package/dist/model/RelatedDealDataDEALID.js +8 -8
- package/dist/model/RelatedOrganizationName.js +1 -1
- package/dist/model/RelatedPersonData.js +1 -1
- package/dist/model/RelationshipOrganizationInfoItem.js +12 -12
- package/dist/model/RelationshipOrganizationInfoItemAllOf.js +1 -1
- package/dist/model/RelationshipOrganizationInfoItemWithActiveFlag.js +14 -14
- package/dist/model/RequredTitleParameter.js +2 -2
- package/dist/model/ResponseCallLogObject.js +14 -14
- package/dist/model/ResponseCallLogObjectAllOf.js +1 -1
- package/dist/model/RoleAssignment.js +11 -11
- package/dist/model/RoleAssignmentAllOf.js +3 -3
- package/dist/model/RoleSettings.js +10 -10
- package/dist/model/RolesAdditionalData.js +1 -1
- package/dist/model/RolesAdditionalDataPagination.js +1 -1
- package/dist/model/SinglePermissionSetsItem.js +8 -8
- package/dist/model/SinglePermissionSetsItemAllOf.js +1 -1
- package/dist/model/Stage.js +5 -5
- package/dist/model/StageConversions.js +3 -3
- package/dist/model/StageDetails.js +21 -21
- package/dist/model/StageWithPipelineInfo.js +24 -24
- package/dist/model/StageWithPipelineInfoAllOf.js +2 -2
- package/dist/model/SubRole.js +10 -10
- package/dist/model/SubRoleAllOf.js +3 -3
- package/dist/model/SubscriptionInstallmentCreateRequest.js +5 -5
- package/dist/model/SubscriptionInstallmentUpdateRequest.js +1 -1
- package/dist/model/SubscriptionItem.js +15 -15
- package/dist/model/SubscriptionRecurringCancelRequest.js +1 -1
- package/dist/model/SubscriptionRecurringCreateRequest.js +14 -14
- package/dist/model/SubscriptionRecurringUpdateRequest.js +3 -3
- package/dist/model/TeamId.js +1 -1
- package/dist/model/UpdateDealRequest.js +22 -22
- package/dist/model/UpdateLeadLabelRequest.js +1 -1
- package/dist/model/UpdateLeadRequest.js +9 -9
- package/dist/model/UpdateStageRequest.js +10 -10
- package/dist/model/UpdateTeam.js +14 -14
- package/dist/model/UpdateTeamAllOf.js +2 -2
- package/dist/model/UpdateTeamWithAdditionalProperties.js +18 -18
- package/dist/model/UserAssignmentToPermissionSet.js +4 -4
- package/dist/model/UserAssignmentsToPermissionSet.js +2 -2
- package/dist/model/UserAssignmentsToPermissionSetAllOf.js +1 -1
- package/dist/model/UserData.js +6 -6
- package/dist/model/UserDataWithId.js +12 -12
- package/dist/model/UserIDs.js +2 -2
- package/dist/model/UserIDsAllOf.js +1 -1
- package/dist/model/UserPermissionsItem.js +31 -31
- package/dist/model/UserSettingsItem.js +5 -5
- package/package.json +3 -2
package/dist/api/ProductsApi.js
CHANGED
|
@@ -68,7 +68,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
70
|
* Add a product
|
|
71
|
-
* Adds a new product to the Products inventory. For more information
|
|
71
|
+
* Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
|
|
72
72
|
* @param {Object} opts Optional parameters
|
|
73
73
|
* @param {module:model/AddProductRequestBody} opts.addProductRequestBody
|
|
74
74
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProductResponse} and HTTP response
|
|
@@ -106,7 +106,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
108
|
* Add a product
|
|
109
|
-
* Adds a new product to the Products inventory. For more information
|
|
109
|
+
* Adds a new product to the Products inventory. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">adding a product</a>.
|
|
110
110
|
* @param {Object} opts Optional parameters
|
|
111
111
|
* @param {module:model/AddProductRequestBody} opts.addProductRequestBody
|
|
112
112
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductResponse}
|
|
@@ -122,7 +122,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
122
122
|
/**
|
|
123
123
|
* Add a follower to a product
|
|
124
124
|
* Adds a follower to a product.
|
|
125
|
-
* @param {Number} id ID of the product
|
|
125
|
+
* @param {Number} id The ID of the product
|
|
126
126
|
* @param {Object} opts Optional parameters
|
|
127
127
|
* @param {module:model/AddProductFollowerRequest} opts.addProductFollowerRequest
|
|
128
128
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NewFollowerResponse} and HTTP response
|
|
@@ -138,6 +138,10 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
138
138
|
throw new Error("Missing the required parameter 'id' when calling addProductFollower");
|
|
139
139
|
}
|
|
140
140
|
|
|
141
|
+
if (opts['user_id'] === undefined || opts['user_id'] === null) {
|
|
142
|
+
throw new Error("Missing the required parameter 'user_id' when calling addProductFollower");
|
|
143
|
+
}
|
|
144
|
+
|
|
141
145
|
var pathParams = {
|
|
142
146
|
'id': id
|
|
143
147
|
};
|
|
@@ -167,7 +171,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
167
171
|
/**
|
|
168
172
|
* Add a follower to a product
|
|
169
173
|
* Adds a follower to a product.
|
|
170
|
-
* @param {Number} id ID of the product
|
|
174
|
+
* @param {Number} id The ID of the product
|
|
171
175
|
* @param {Object} opts Optional parameters
|
|
172
176
|
* @param {module:model/AddProductFollowerRequest} opts.addProductFollowerRequest
|
|
173
177
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NewFollowerResponse}
|
|
@@ -183,7 +187,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
183
187
|
/**
|
|
184
188
|
* Delete a product
|
|
185
189
|
* Marks a product as deleted.
|
|
186
|
-
* @param {Number} id ID of the product
|
|
190
|
+
* @param {Number} id The ID of the product
|
|
187
191
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductResponse} and HTTP response
|
|
188
192
|
*/
|
|
189
193
|
|
|
@@ -226,7 +230,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
226
230
|
/**
|
|
227
231
|
* Delete a product
|
|
228
232
|
* Marks a product as deleted.
|
|
229
|
-
* @param {Number} id ID of the product
|
|
233
|
+
* @param {Number} id The ID of the product
|
|
230
234
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductResponse}
|
|
231
235
|
*/
|
|
232
236
|
|
|
@@ -240,8 +244,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
240
244
|
/**
|
|
241
245
|
* Delete a follower from a product
|
|
242
246
|
* Deletes a follower from a product.
|
|
243
|
-
* @param {Number} id ID of the product
|
|
244
|
-
* @param {Number} followerId ID of the relationship between the follower and the product
|
|
247
|
+
* @param {Number} id The ID of the product
|
|
248
|
+
* @param {Number} followerId The ID of the relationship between the follower and the product
|
|
245
249
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFollowerResponse} and HTTP response
|
|
246
250
|
*/
|
|
247
251
|
|
|
@@ -290,8 +294,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
290
294
|
/**
|
|
291
295
|
* Delete a follower from a product
|
|
292
296
|
* Deletes a follower from a product.
|
|
293
|
-
* @param {Number} id ID of the product
|
|
294
|
-
* @param {Number} followerId ID of the relationship between the follower and the product
|
|
297
|
+
* @param {Number} id The ID of the product
|
|
298
|
+
* @param {Number} followerId The ID of the relationship between the follower and the product
|
|
295
299
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFollowerResponse}
|
|
296
300
|
*/
|
|
297
301
|
|
|
@@ -305,7 +309,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
305
309
|
/**
|
|
306
310
|
* Get one product
|
|
307
311
|
* Returns data about a specific product.
|
|
308
|
-
* @param {Number} id ID of the product
|
|
312
|
+
* @param {Number} id The ID of the product
|
|
309
313
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProductResponse} and HTTP response
|
|
310
314
|
*/
|
|
311
315
|
|
|
@@ -348,7 +352,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
348
352
|
/**
|
|
349
353
|
* Get one product
|
|
350
354
|
* Returns data about a specific product.
|
|
351
|
-
* @param {Number} id ID of the product
|
|
355
|
+
* @param {Number} id The ID of the product
|
|
352
356
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductResponse}
|
|
353
357
|
*/
|
|
354
358
|
|
|
@@ -361,12 +365,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
361
365
|
}
|
|
362
366
|
/**
|
|
363
367
|
* Get deals where a product is attached to
|
|
364
|
-
* Returns data about deals that have a product attached to.
|
|
365
|
-
* @param {Number} id ID of the product
|
|
368
|
+
* Returns data about deals that have a product attached to it.
|
|
369
|
+
* @param {Number} id The ID of the product
|
|
366
370
|
* @param {Object} opts Optional parameters
|
|
367
371
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
368
372
|
* @param {Number} opts.limit Items shown per page
|
|
369
|
-
* @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')
|
|
373
|
+
* @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')
|
|
370
374
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateDealRequest} and HTTP response
|
|
371
375
|
*/
|
|
372
376
|
|
|
@@ -412,12 +416,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
412
416
|
}
|
|
413
417
|
/**
|
|
414
418
|
* Get deals where a product is attached to
|
|
415
|
-
* Returns data about deals that have a product attached to.
|
|
416
|
-
* @param {Number} id ID of the product
|
|
419
|
+
* Returns data about deals that have a product attached to it.
|
|
420
|
+
* @param {Number} id The ID of the product
|
|
417
421
|
* @param {Object} opts Optional parameters
|
|
418
422
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
419
423
|
* @param {Number} opts.limit Items shown per page
|
|
420
|
-
* @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')
|
|
424
|
+
* @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')
|
|
421
425
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateDealRequest}
|
|
422
426
|
*/
|
|
423
427
|
|
|
@@ -431,12 +435,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
431
435
|
/**
|
|
432
436
|
* List files attached to a product
|
|
433
437
|
* Lists files associated with a product.
|
|
434
|
-
* @param {Number} id ID of the product
|
|
438
|
+
* @param {Number} id The ID of the product
|
|
435
439
|
* @param {Object} opts Optional parameters
|
|
436
440
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
437
441
|
* @param {Number} opts.limit Items shown per page
|
|
438
442
|
* @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.
|
|
439
|
-
* @param {String} opts.sort
|
|
443
|
+
* @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`.
|
|
440
444
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
|
441
445
|
*/
|
|
442
446
|
|
|
@@ -484,12 +488,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
484
488
|
/**
|
|
485
489
|
* List files attached to a product
|
|
486
490
|
* Lists files associated with a product.
|
|
487
|
-
* @param {Number} id ID of the product
|
|
491
|
+
* @param {Number} id The ID of the product
|
|
488
492
|
* @param {Object} opts Optional parameters
|
|
489
493
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
490
494
|
* @param {Number} opts.limit Items shown per page
|
|
491
495
|
* @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.
|
|
492
|
-
* @param {String} opts.sort
|
|
496
|
+
* @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`.
|
|
493
497
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
|
494
498
|
*/
|
|
495
499
|
|
|
@@ -502,8 +506,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
502
506
|
}
|
|
503
507
|
/**
|
|
504
508
|
* List followers of a product
|
|
505
|
-
* Lists the followers of a
|
|
506
|
-
* @param {Number} id ID of the product
|
|
509
|
+
* Lists the followers of a product.
|
|
510
|
+
* @param {Number} id The ID of the product
|
|
507
511
|
* @param {Object} opts Optional parameters
|
|
508
512
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
509
513
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -551,8 +555,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
551
555
|
}
|
|
552
556
|
/**
|
|
553
557
|
* List followers of a product
|
|
554
|
-
* Lists the followers of a
|
|
555
|
-
* @param {Number} id ID of the product
|
|
558
|
+
* Lists the followers of a product.
|
|
559
|
+
* @param {Number} id The ID of the product
|
|
556
560
|
* @param {Object} opts Optional parameters
|
|
557
561
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
558
562
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -569,7 +573,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
569
573
|
/**
|
|
570
574
|
* List permitted users
|
|
571
575
|
* Lists users permitted to access a product.
|
|
572
|
-
* @param {Number} id ID of the product
|
|
576
|
+
* @param {Number} id The ID of the product
|
|
573
577
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserIDs} and HTTP response
|
|
574
578
|
*/
|
|
575
579
|
|
|
@@ -612,7 +616,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
612
616
|
/**
|
|
613
617
|
* List permitted users
|
|
614
618
|
* Lists users permitted to access a product.
|
|
615
|
-
* @param {Number} id ID of the product
|
|
619
|
+
* @param {Number} id The ID of the product
|
|
616
620
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserIDs}
|
|
617
621
|
*/
|
|
618
622
|
|
|
@@ -625,13 +629,13 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
625
629
|
}
|
|
626
630
|
/**
|
|
627
631
|
* Get all products
|
|
628
|
-
* Returns data about all
|
|
632
|
+
* Returns data about all products.
|
|
629
633
|
* @param {Object} opts Optional parameters
|
|
630
|
-
* @param {Number} opts.userId If supplied, only
|
|
631
|
-
* @param {Number} opts.filterId ID of the filter to use
|
|
632
|
-
* @param {Array.<Number>} opts.ids An array of integers with the IDs of the
|
|
633
|
-
* @param {String} opts.firstChar If supplied, only
|
|
634
|
-
* @param {Boolean} opts.getSummary If supplied, response will return the total numbers of
|
|
634
|
+
* @param {Number} opts.userId If supplied, only products owned by the given user will be returned
|
|
635
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
|
636
|
+
* @param {Array.<Number>} opts.ids An array of integers with the IDs of the products that should be returned in the response
|
|
637
|
+
* @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
|
|
638
|
+
* @param {Boolean} opts.getSummary If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
|
|
635
639
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
636
640
|
* @param {Number} opts.limit Items shown per page
|
|
637
641
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProductsResponse} and HTTP response
|
|
@@ -676,13 +680,13 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
676
680
|
}
|
|
677
681
|
/**
|
|
678
682
|
* Get all products
|
|
679
|
-
* Returns data about all
|
|
683
|
+
* Returns data about all products.
|
|
680
684
|
* @param {Object} opts Optional parameters
|
|
681
|
-
* @param {Number} opts.userId If supplied, only
|
|
682
|
-
* @param {Number} opts.filterId ID of the filter to use
|
|
683
|
-
* @param {Array.<Number>} opts.ids An array of integers with the IDs of the
|
|
684
|
-
* @param {String} opts.firstChar If supplied, only
|
|
685
|
-
* @param {Boolean} opts.getSummary If supplied, response will return the total numbers of
|
|
685
|
+
* @param {Number} opts.userId If supplied, only products owned by the given user will be returned
|
|
686
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
|
687
|
+
* @param {Array.<Number>} opts.ids An array of integers with the IDs of the products that should be returned in the response
|
|
688
|
+
* @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
|
|
689
|
+
* @param {Boolean} opts.getSummary If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
|
|
686
690
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
687
691
|
* @param {Number} opts.limit Items shown per page
|
|
688
692
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductsResponse}
|
|
@@ -697,12 +701,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
697
701
|
}
|
|
698
702
|
/**
|
|
699
703
|
* Search products
|
|
700
|
-
* Searches all
|
|
704
|
+
* Searches all products by name, code 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.
|
|
701
705
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
|
702
706
|
* @param {Object} opts Optional parameters
|
|
703
707
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
704
708
|
* @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.
|
|
705
|
-
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
|
709
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
|
706
710
|
* @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)
|
|
707
711
|
* @param {Number} opts.limit Items shown per page
|
|
708
712
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProductSearchResponse} and HTTP response
|
|
@@ -751,12 +755,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
751
755
|
}
|
|
752
756
|
/**
|
|
753
757
|
* Search products
|
|
754
|
-
* Searches all
|
|
758
|
+
* Searches all products by name, code 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.
|
|
755
759
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
|
756
760
|
* @param {Object} opts Optional parameters
|
|
757
761
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
758
762
|
* @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.
|
|
759
|
-
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
|
763
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
|
760
764
|
* @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)
|
|
761
765
|
* @param {Number} opts.limit Items shown per page
|
|
762
766
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductSearchResponse}
|
|
@@ -772,7 +776,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
772
776
|
/**
|
|
773
777
|
* Update a product
|
|
774
778
|
* Updates product data.
|
|
775
|
-
* @param {Number} id ID of the product
|
|
779
|
+
* @param {Number} id The ID of the product
|
|
776
780
|
* @param {Object} opts Optional parameters
|
|
777
781
|
* @param {module:model/ProductRequest} opts.productRequest
|
|
778
782
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateProductResponse} and HTTP response
|
|
@@ -817,7 +821,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
817
821
|
/**
|
|
818
822
|
* Update a product
|
|
819
823
|
* Updates product data.
|
|
820
|
-
* @param {Number} id ID of the product
|
|
824
|
+
* @param {Number} id The ID of the product
|
|
821
825
|
* @param {Object} opts Optional parameters
|
|
822
826
|
* @param {module:model/ProductRequest} opts.productRequest
|
|
823
827
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateProductResponse}
|
package/dist/api/RecentsApi.js
CHANGED
|
@@ -40,10 +40,10 @@ var RecentsApi = /*#__PURE__*/function () {
|
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
42
|
* Get recents
|
|
43
|
-
* Returns data about all recent changes
|
|
44
|
-
* @param {String} sinceTimestamp
|
|
43
|
+
* Returns data about all recent changes occurred after the given timestamp.
|
|
44
|
+
* @param {String} sinceTimestamp The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
|
|
45
45
|
* @param {Object} opts Optional parameters
|
|
46
|
-
* @param {module:model/String} opts.items Multiple selection of item types to include in query (optional)
|
|
46
|
+
* @param {module:model/String} opts.items Multiple selection of item types to include in the query (optional)
|
|
47
47
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
48
48
|
* @param {Number} opts.limit Items shown per page
|
|
49
49
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRecents} and HTTP response
|
|
@@ -91,10 +91,10 @@ var RecentsApi = /*#__PURE__*/function () {
|
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
93
|
* Get recents
|
|
94
|
-
* Returns data about all recent changes
|
|
95
|
-
* @param {String} sinceTimestamp
|
|
94
|
+
* Returns data about all recent changes occurred after the given timestamp.
|
|
95
|
+
* @param {String} sinceTimestamp The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
|
|
96
96
|
* @param {Object} opts Optional parameters
|
|
97
|
-
* @param {module:model/String} opts.items Multiple selection of item types to include in query (optional)
|
|
97
|
+
* @param {module:model/String} opts.items Multiple selection of item types to include in the query (optional)
|
|
98
98
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
99
99
|
* @param {Number} opts.limit Items shown per page
|
|
100
100
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRecents}
|
package/dist/api/RolesApi.js
CHANGED
|
@@ -60,8 +60,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
62
|
* Add or update role setting
|
|
63
|
-
*
|
|
64
|
-
* @param {Number} id ID of the role
|
|
63
|
+
* Adds or updates the visibility setting for a role.
|
|
64
|
+
* @param {Number} id The ID of the role
|
|
65
65
|
* @param {module:model/String} settingKey
|
|
66
66
|
* @param {module:model/Number} value Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.
|
|
67
67
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoleSettings} and HTTP response
|
|
@@ -119,8 +119,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
121
|
* Add or update role setting
|
|
122
|
-
*
|
|
123
|
-
* @param {Number} id ID of the role
|
|
122
|
+
* Adds or updates the visibility setting for a role.
|
|
123
|
+
* @param {Number} id The ID of the role
|
|
124
124
|
* @param {module:model/String} settingKey
|
|
125
125
|
* @param {module:model/Number} value Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.
|
|
126
126
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoleSettings}
|
|
@@ -136,8 +136,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
136
136
|
/**
|
|
137
137
|
* Add a role
|
|
138
138
|
* @param {Object} opts Optional parameters
|
|
139
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
|
140
|
-
* @param {String} opts.name The name of the
|
|
139
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
|
140
|
+
* @param {String} opts.name The name of the role
|
|
141
141
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoles} and HTTP response
|
|
142
142
|
*/
|
|
143
143
|
|
|
@@ -176,8 +176,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
176
176
|
/**
|
|
177
177
|
* Add a role
|
|
178
178
|
* @param {Object} opts Optional parameters
|
|
179
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
|
180
|
-
* @param {String} opts.name The name of the
|
|
179
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
|
180
|
+
* @param {String} opts.name The name of the role
|
|
181
181
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoles}
|
|
182
182
|
*/
|
|
183
183
|
|
|
@@ -190,9 +190,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
190
190
|
}
|
|
191
191
|
/**
|
|
192
192
|
* Add role assignment
|
|
193
|
-
*
|
|
194
|
-
* @param {Number} id ID of the role
|
|
195
|
-
* @param {Number} userId ID of the user
|
|
193
|
+
* Adds assignment for a role.
|
|
194
|
+
* @param {Number} id The ID of the role
|
|
195
|
+
* @param {Number} userId The ID of the user
|
|
196
196
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoleAssignment} and HTTP response
|
|
197
197
|
*/
|
|
198
198
|
|
|
@@ -241,9 +241,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
241
241
|
}
|
|
242
242
|
/**
|
|
243
243
|
* Add role assignment
|
|
244
|
-
*
|
|
245
|
-
* @param {Number} id ID of the role
|
|
246
|
-
* @param {Number} userId ID of the user
|
|
244
|
+
* Adds assignment for a role.
|
|
245
|
+
* @param {Number} id The ID of the role
|
|
246
|
+
* @param {Number} userId The ID of the user
|
|
247
247
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoleAssignment}
|
|
248
248
|
*/
|
|
249
249
|
|
|
@@ -256,7 +256,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
256
256
|
}
|
|
257
257
|
/**
|
|
258
258
|
* Delete a role
|
|
259
|
-
* @param {Number} id ID of the role
|
|
259
|
+
* @param {Number} id The ID of the role
|
|
260
260
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteRole} and HTTP response
|
|
261
261
|
*/
|
|
262
262
|
|
|
@@ -298,7 +298,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
298
298
|
}
|
|
299
299
|
/**
|
|
300
300
|
* Delete a role
|
|
301
|
-
* @param {Number} id ID of the role
|
|
301
|
+
* @param {Number} id The ID of the role
|
|
302
302
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteRole}
|
|
303
303
|
*/
|
|
304
304
|
|
|
@@ -311,9 +311,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
311
311
|
}
|
|
312
312
|
/**
|
|
313
313
|
* Delete a role assignment
|
|
314
|
-
*
|
|
315
|
-
* @param {Number} id ID of the role
|
|
316
|
-
* @param {Number} userId ID of the user
|
|
314
|
+
* Deletes assignment from a role.
|
|
315
|
+
* @param {Number} id The ID of the role
|
|
316
|
+
* @param {Number} userId The ID of the user
|
|
317
317
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteRoleAssignment} and HTTP response
|
|
318
318
|
*/
|
|
319
319
|
|
|
@@ -362,9 +362,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
362
362
|
}
|
|
363
363
|
/**
|
|
364
364
|
* Delete a role assignment
|
|
365
|
-
*
|
|
366
|
-
* @param {Number} id ID of the role
|
|
367
|
-
* @param {Number} userId ID of the user
|
|
365
|
+
* Deletes assignment from a role.
|
|
366
|
+
* @param {Number} id The ID of the role
|
|
367
|
+
* @param {Number} userId The ID of the user
|
|
368
368
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteRoleAssignment}
|
|
369
369
|
*/
|
|
370
370
|
|
|
@@ -377,7 +377,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
379
|
* Get one role
|
|
380
|
-
* @param {Number} id ID of the role
|
|
380
|
+
* @param {Number} id The ID of the role
|
|
381
381
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRole} and HTTP response
|
|
382
382
|
*/
|
|
383
383
|
|
|
@@ -419,7 +419,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
419
419
|
}
|
|
420
420
|
/**
|
|
421
421
|
* Get one role
|
|
422
|
-
* @param {Number} id ID of the role
|
|
422
|
+
* @param {Number} id The ID of the role
|
|
423
423
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRole}
|
|
424
424
|
*/
|
|
425
425
|
|
|
@@ -432,8 +432,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
432
432
|
}
|
|
433
433
|
/**
|
|
434
434
|
* List role assignments
|
|
435
|
-
*
|
|
436
|
-
* @param {Number} id ID of the role
|
|
435
|
+
* Lists assignments for a role.
|
|
436
|
+
* @param {Number} id The ID of the role
|
|
437
437
|
* @param {Object} opts Optional parameters
|
|
438
438
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
439
439
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -481,8 +481,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
481
481
|
}
|
|
482
482
|
/**
|
|
483
483
|
* List role assignments
|
|
484
|
-
*
|
|
485
|
-
* @param {Number} id ID of the role
|
|
484
|
+
* Lists assignments for a role.
|
|
485
|
+
* @param {Number} id The ID of the role
|
|
486
486
|
* @param {Object} opts Optional parameters
|
|
487
487
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
488
488
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -498,7 +498,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
500
|
* List role settings
|
|
501
|
-
* @param {Number} id ID of the role
|
|
501
|
+
* @param {Number} id The ID of the role
|
|
502
502
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRoleSettings} and HTTP response
|
|
503
503
|
*/
|
|
504
504
|
|
|
@@ -540,7 +540,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
540
540
|
}
|
|
541
541
|
/**
|
|
542
542
|
* List role settings
|
|
543
|
-
* @param {Number} id ID of the role
|
|
543
|
+
* @param {Number} id The ID of the role
|
|
544
544
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRoleSettings}
|
|
545
545
|
*/
|
|
546
546
|
|
|
@@ -553,7 +553,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
553
553
|
}
|
|
554
554
|
/**
|
|
555
555
|
* List role sub-roles
|
|
556
|
-
* @param {Number} id ID of the role
|
|
556
|
+
* @param {Number} id The ID of the role
|
|
557
557
|
* @param {Object} opts Optional parameters
|
|
558
558
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
559
559
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -601,7 +601,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
601
601
|
}
|
|
602
602
|
/**
|
|
603
603
|
* List role sub-roles
|
|
604
|
-
* @param {Number} id ID of the role
|
|
604
|
+
* @param {Number} id The ID of the role
|
|
605
605
|
* @param {Object} opts Optional parameters
|
|
606
606
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
607
607
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -672,10 +672,10 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
672
672
|
}
|
|
673
673
|
/**
|
|
674
674
|
* Update role details
|
|
675
|
-
* @param {Number} id ID of the role
|
|
675
|
+
* @param {Number} id The ID of the role
|
|
676
676
|
* @param {Object} opts Optional parameters
|
|
677
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
|
678
|
-
* @param {String} opts.name The name of the
|
|
677
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
|
678
|
+
* @param {String} opts.name The name of the role
|
|
679
679
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PutRole} and HTTP response
|
|
680
680
|
*/
|
|
681
681
|
|
|
@@ -720,10 +720,10 @@ var RolesApi = /*#__PURE__*/function () {
|
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
722
|
* Update role details
|
|
723
|
-
* @param {Number} id ID of the role
|
|
723
|
+
* @param {Number} id The ID of the role
|
|
724
724
|
* @param {Object} opts Optional parameters
|
|
725
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
|
726
|
-
* @param {String} opts.name The name of the
|
|
725
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
|
726
|
+
* @param {String} opts.name The name of the role
|
|
727
727
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PutRole}
|
|
728
728
|
*/
|
|
729
729
|
|
package/dist/api/StagesApi.js
CHANGED
|
@@ -110,7 +110,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
110
110
|
/**
|
|
111
111
|
* Delete a stage
|
|
112
112
|
* Marks a stage as deleted.
|
|
113
|
-
* @param {Number} id ID of the stage
|
|
113
|
+
* @param {Number} id The ID of the stage
|
|
114
114
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteStageResponse200} and HTTP response
|
|
115
115
|
*/
|
|
116
116
|
|
|
@@ -153,7 +153,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
153
153
|
/**
|
|
154
154
|
* Delete a stage
|
|
155
155
|
* Marks a stage as deleted.
|
|
156
|
-
* @param {Number} id ID of the stage
|
|
156
|
+
* @param {Number} id The ID of the stage
|
|
157
157
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteStageResponse200}
|
|
158
158
|
*/
|
|
159
159
|
|
|
@@ -167,7 +167,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
167
167
|
/**
|
|
168
168
|
* Delete multiple stages in bulk
|
|
169
169
|
* Marks multiple stages as deleted.
|
|
170
|
-
* @param {String} ids
|
|
170
|
+
* @param {String} ids The comma-separated stage IDs to delete
|
|
171
171
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteStagesResponse200} and HTTP response
|
|
172
172
|
*/
|
|
173
173
|
|
|
@@ -210,7 +210,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
210
210
|
/**
|
|
211
211
|
* Delete multiple stages in bulk
|
|
212
212
|
* Marks multiple stages as deleted.
|
|
213
|
-
* @param {String} ids
|
|
213
|
+
* @param {String} ids The comma-separated stage IDs to delete
|
|
214
214
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteStagesResponse200}
|
|
215
215
|
*/
|
|
216
216
|
|
|
@@ -224,7 +224,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
224
224
|
/**
|
|
225
225
|
* Get one stage
|
|
226
226
|
* Returns data about a specific stage.
|
|
227
|
-
* @param {Number} id ID of the stage
|
|
227
|
+
* @param {Number} id The ID of the stage
|
|
228
228
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetOneStage} and HTTP response
|
|
229
229
|
*/
|
|
230
230
|
|
|
@@ -267,7 +267,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
267
267
|
/**
|
|
268
268
|
* Get one stage
|
|
269
269
|
* Returns data about a specific stage.
|
|
270
|
-
* @param {Number} id ID of the stage
|
|
270
|
+
* @param {Number} id The ID of the stage
|
|
271
271
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetOneStage}
|
|
272
272
|
*/
|
|
273
273
|
|
|
@@ -281,11 +281,11 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
281
281
|
/**
|
|
282
282
|
* Get deals in a stage
|
|
283
283
|
* Lists deals in a specific stage.
|
|
284
|
-
* @param {Number} id ID of the stage
|
|
284
|
+
* @param {Number} id The ID of the stage
|
|
285
285
|
* @param {Object} opts Optional parameters
|
|
286
|
-
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
286
|
+
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
287
287
|
* @param {Number} opts.userId If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
|
|
288
|
-
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
|
288
|
+
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
|
289
289
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
290
290
|
* @param {Number} opts.limit Items shown per page
|
|
291
291
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStageDeals} and HTTP response
|
|
@@ -336,11 +336,11 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
336
336
|
/**
|
|
337
337
|
* Get deals in a stage
|
|
338
338
|
* Lists deals in a specific stage.
|
|
339
|
-
* @param {Number} id ID of the stage
|
|
339
|
+
* @param {Number} id The ID of the stage
|
|
340
340
|
* @param {Object} opts Optional parameters
|
|
341
|
-
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
341
|
+
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
342
342
|
* @param {Number} opts.userId If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
|
|
343
|
-
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
|
343
|
+
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
|
344
344
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
345
345
|
* @param {Number} opts.limit Items shown per page
|
|
346
346
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStageDeals}
|
|
@@ -410,7 +410,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
410
410
|
/**
|
|
411
411
|
* Update stage details
|
|
412
412
|
* Updates the properties of a stage.
|
|
413
|
-
* @param {Number} id ID of the stage
|
|
413
|
+
* @param {Number} id The ID of the stage
|
|
414
414
|
* @param {Object} opts Optional parameters
|
|
415
415
|
* @param {module:model/UpdateStageRequest} opts.updateStageRequest
|
|
416
416
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAddUpdateStage} and HTTP response
|
|
@@ -455,7 +455,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
|
455
455
|
/**
|
|
456
456
|
* Update stage details
|
|
457
457
|
* Updates the properties of a stage.
|
|
458
|
-
* @param {Number} id ID of the stage
|
|
458
|
+
* @param {Number} id The ID of the stage
|
|
459
459
|
* @param {Object} opts Optional parameters
|
|
460
460
|
* @param {module:model/UpdateStageRequest} opts.updateStageRequest
|
|
461
461
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAddUpdateStage}
|