pipedrive 13.0.8 → 13.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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/PipelinesApi.js
CHANGED
|
@@ -58,7 +58,7 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
60
|
* Add a new pipeline
|
|
61
|
-
* Adds a new pipeline
|
|
61
|
+
* Adds a new pipeline.
|
|
62
62
|
* @param {Object} opts Optional parameters
|
|
63
63
|
* @param {module:model/Pipeline} opts.pipeline
|
|
64
64
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddNewPipeline} and HTTP response
|
|
@@ -96,7 +96,7 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
98
|
* Add a new pipeline
|
|
99
|
-
* Adds a new pipeline
|
|
99
|
+
* Adds a new pipeline.
|
|
100
100
|
* @param {Object} opts Optional parameters
|
|
101
101
|
* @param {module:model/Pipeline} opts.pipeline
|
|
102
102
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddNewPipeline}
|
|
@@ -112,7 +112,7 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
112
112
|
/**
|
|
113
113
|
* Delete a pipeline
|
|
114
114
|
* Marks a pipeline as deleted.
|
|
115
|
-
* @param {Number} id ID of the pipeline
|
|
115
|
+
* @param {Number} id The ID of the pipeline
|
|
116
116
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeletePipelineResponse200} and HTTP response
|
|
117
117
|
*/
|
|
118
118
|
|
|
@@ -155,7 +155,7 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
155
155
|
/**
|
|
156
156
|
* Delete a pipeline
|
|
157
157
|
* Marks a pipeline as deleted.
|
|
158
|
-
* @param {Number} id ID of the pipeline
|
|
158
|
+
* @param {Number} id The ID of the pipeline
|
|
159
159
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeletePipelineResponse200}
|
|
160
160
|
*/
|
|
161
161
|
|
|
@@ -169,9 +169,9 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
169
169
|
/**
|
|
170
170
|
* Get one pipeline
|
|
171
171
|
* Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
|
|
172
|
-
* @param {Number} id ID of the pipeline
|
|
172
|
+
* @param {Number} id The ID of the pipeline
|
|
173
173
|
* @param {Object} opts Optional parameters
|
|
174
|
-
* @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
|
|
174
|
+
* @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
|
|
175
175
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetOnePipeline} and HTTP response
|
|
176
176
|
*/
|
|
177
177
|
|
|
@@ -216,9 +216,9 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
216
216
|
/**
|
|
217
217
|
* Get one pipeline
|
|
218
218
|
* Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
|
|
219
|
-
* @param {Number} id ID of the pipeline
|
|
219
|
+
* @param {Number} id The ID of the pipeline
|
|
220
220
|
* @param {Object} opts Optional parameters
|
|
221
|
-
* @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
|
|
221
|
+
* @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
|
|
222
222
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetOnePipeline}
|
|
223
223
|
*/
|
|
224
224
|
|
|
@@ -231,12 +231,12 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
231
231
|
}
|
|
232
232
|
/**
|
|
233
233
|
* Get deals conversion rates in pipeline
|
|
234
|
-
* Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.
|
|
235
|
-
* @param {Number} id ID of the pipeline
|
|
236
|
-
* @param {Date} startDate
|
|
237
|
-
* @param {Date} endDate
|
|
234
|
+
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
|
235
|
+
* @param {Number} id The ID of the pipeline
|
|
236
|
+
* @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
|
|
237
|
+
* @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
|
|
238
238
|
* @param {Object} opts Optional parameters
|
|
239
|
-
* @param {Number} opts.userId ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
|
|
239
|
+
* @param {Number} opts.userId The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
|
|
240
240
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDealsConversionRatesInPipeline} and HTTP response
|
|
241
241
|
*/
|
|
242
242
|
|
|
@@ -292,12 +292,12 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
292
292
|
}
|
|
293
293
|
/**
|
|
294
294
|
* Get deals conversion rates in pipeline
|
|
295
|
-
* Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.
|
|
296
|
-
* @param {Number} id ID of the pipeline
|
|
297
|
-
* @param {Date} startDate
|
|
298
|
-
* @param {Date} endDate
|
|
295
|
+
* Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
|
|
296
|
+
* @param {Number} id The ID of the pipeline
|
|
297
|
+
* @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
|
|
298
|
+
* @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
|
|
299
299
|
* @param {Object} opts Optional parameters
|
|
300
|
-
* @param {Number} opts.userId ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
|
|
300
|
+
* @param {Number} opts.userId The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
|
|
301
301
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDealsConversionRatesInPipeline}
|
|
302
302
|
*/
|
|
303
303
|
|
|
@@ -310,17 +310,17 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
310
310
|
}
|
|
311
311
|
/**
|
|
312
312
|
* Get deals in a pipeline
|
|
313
|
-
* Lists deals in a specific pipeline across all its stages
|
|
314
|
-
* @param {Number} id ID of the pipeline
|
|
313
|
+
* Lists deals in a specific pipeline across all its stages.
|
|
314
|
+
* @param {Number} id The ID of the pipeline
|
|
315
315
|
* @param {Object} opts Optional parameters
|
|
316
|
-
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
316
|
+
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
317
317
|
* @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.
|
|
318
|
-
* @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
|
|
319
|
-
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
|
318
|
+
* @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
|
|
319
|
+
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
|
320
320
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
321
321
|
* @param {Number} opts.limit Items shown per page
|
|
322
|
-
* @param {module:model/NumberBoolean} opts.getSummary Whether to include summary of the pipeline in the `additional_data` or not
|
|
323
|
-
* @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
|
|
322
|
+
* @param {module:model/NumberBoolean} opts.getSummary Whether to include a summary of the pipeline in the `additional_data` or not
|
|
323
|
+
* @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
|
|
324
324
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStageDeals} and HTTP response
|
|
325
325
|
*/
|
|
326
326
|
|
|
@@ -371,17 +371,17 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
371
371
|
}
|
|
372
372
|
/**
|
|
373
373
|
* Get deals in a pipeline
|
|
374
|
-
* Lists deals in a specific pipeline across all its stages
|
|
375
|
-
* @param {Number} id ID of the pipeline
|
|
374
|
+
* Lists deals in a specific pipeline across all its stages.
|
|
375
|
+
* @param {Number} id The ID of the pipeline
|
|
376
376
|
* @param {Object} opts Optional parameters
|
|
377
|
-
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
377
|
+
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
|
378
378
|
* @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.
|
|
379
|
-
* @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
|
|
380
|
-
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
|
379
|
+
* @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
|
|
380
|
+
* @param {Number} opts.stageId If supplied, only deals within the given stage will be returned
|
|
381
381
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
382
382
|
* @param {Number} opts.limit Items shown per page
|
|
383
|
-
* @param {module:model/NumberBoolean} opts.getSummary Whether to include summary of the pipeline in the `additional_data` or not
|
|
384
|
-
* @param {String} opts.totalsConvertCurrency 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
|
|
383
|
+
* @param {module:model/NumberBoolean} opts.getSummary Whether to include a summary of the pipeline in the `additional_data` or not
|
|
384
|
+
* @param {String} opts.totalsConvertCurrency The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
|
|
385
385
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStageDeals}
|
|
386
386
|
*/
|
|
387
387
|
|
|
@@ -394,12 +394,12 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
394
394
|
}
|
|
395
395
|
/**
|
|
396
396
|
* Get deals movements in pipeline
|
|
397
|
-
* Returns statistics for deals movements for given time period.
|
|
398
|
-
* @param {Number} id ID of the pipeline
|
|
399
|
-
* @param {Date} startDate
|
|
400
|
-
* @param {Date} endDate
|
|
397
|
+
* Returns statistics for deals movements for the given time period.
|
|
398
|
+
* @param {Number} id The ID of the pipeline
|
|
399
|
+
* @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
|
|
400
|
+
* @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
|
|
401
401
|
* @param {Object} opts Optional parameters
|
|
402
|
-
* @param {Number} opts.userId ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
|
|
402
|
+
* @param {Number} opts.userId The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
|
|
403
403
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDealsMovementsInPipeline} and HTTP response
|
|
404
404
|
*/
|
|
405
405
|
|
|
@@ -455,12 +455,12 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
455
455
|
}
|
|
456
456
|
/**
|
|
457
457
|
* Get deals movements in pipeline
|
|
458
|
-
* Returns statistics for deals movements for given time period.
|
|
459
|
-
* @param {Number} id ID of the pipeline
|
|
460
|
-
* @param {Date} startDate
|
|
461
|
-
* @param {Date} endDate
|
|
458
|
+
* Returns statistics for deals movements for the given time period.
|
|
459
|
+
* @param {Number} id The ID of the pipeline
|
|
460
|
+
* @param {Date} startDate The start of the period. Date in format of YYYY-MM-DD.
|
|
461
|
+
* @param {Date} endDate The end of the period. Date in format of YYYY-MM-DD.
|
|
462
462
|
* @param {Object} opts Optional parameters
|
|
463
|
-
* @param {Number} opts.userId ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
|
|
463
|
+
* @param {Number} opts.userId The ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
|
|
464
464
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDealsMovementsInPipeline}
|
|
465
465
|
*/
|
|
466
466
|
|
|
@@ -473,7 +473,7 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
473
473
|
}
|
|
474
474
|
/**
|
|
475
475
|
* Get all pipelines
|
|
476
|
-
* Returns data about all pipelines
|
|
476
|
+
* Returns data about all pipelines.
|
|
477
477
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllPipelines} and HTTP response
|
|
478
478
|
*/
|
|
479
479
|
|
|
@@ -508,7 +508,7 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
508
508
|
}
|
|
509
509
|
/**
|
|
510
510
|
* Get all pipelines
|
|
511
|
-
* Returns data about all pipelines
|
|
511
|
+
* Returns data about all pipelines.
|
|
512
512
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllPipelines}
|
|
513
513
|
*/
|
|
514
514
|
|
|
@@ -520,9 +520,9 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
520
520
|
});
|
|
521
521
|
}
|
|
522
522
|
/**
|
|
523
|
-
*
|
|
524
|
-
* Updates
|
|
525
|
-
* @param {Number} id ID of the pipeline
|
|
523
|
+
* Update a pipeline
|
|
524
|
+
* Updates the properties of a pipeline.
|
|
525
|
+
* @param {Number} id The ID of the pipeline
|
|
526
526
|
* @param {Object} opts Optional parameters
|
|
527
527
|
* @param {module:model/Pipeline} opts.pipeline
|
|
528
528
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EditPipeline} and HTTP response
|
|
@@ -565,9 +565,9 @@ var PipelinesApi = /*#__PURE__*/function () {
|
|
|
565
565
|
return this.apiClient.callApi('/pipelines/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
566
566
|
}
|
|
567
567
|
/**
|
|
568
|
-
*
|
|
569
|
-
* Updates
|
|
570
|
-
* @param {Number} id ID of the pipeline
|
|
568
|
+
* Update a pipeline
|
|
569
|
+
* Updates the properties of a pipeline.
|
|
570
|
+
* @param {Number} id The ID of the pipeline
|
|
571
571
|
* @param {Object} opts Optional parameters
|
|
572
572
|
* @param {module:model/Pipeline} opts.pipeline
|
|
573
573
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EditPipeline}
|
|
@@ -106,7 +106,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
106
106
|
/**
|
|
107
107
|
* Delete a product field
|
|
108
108
|
* Marks a field as deleted. For more information on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
109
|
-
* @param {Number} id ID of the
|
|
109
|
+
* @param {Number} id The ID of the product field
|
|
110
110
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFieldResponse} and HTTP response
|
|
111
111
|
*/
|
|
112
112
|
|
|
@@ -149,7 +149,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
149
149
|
/**
|
|
150
150
|
* Delete a product field
|
|
151
151
|
* Marks a field as deleted. For more information on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
152
|
-
* @param {Number} id ID of the
|
|
152
|
+
* @param {Number} id The ID of the product field
|
|
153
153
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFieldResponse}
|
|
154
154
|
*/
|
|
155
155
|
|
|
@@ -163,7 +163,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
163
163
|
/**
|
|
164
164
|
* Delete multiple product fields in bulk
|
|
165
165
|
* Marks multiple fields as deleted.
|
|
166
|
-
* @param {String} ids
|
|
166
|
+
* @param {String} ids The comma-separated field IDs to delete
|
|
167
167
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteMultipleProductFieldsResponse} and HTTP response
|
|
168
168
|
*/
|
|
169
169
|
|
|
@@ -206,7 +206,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
206
206
|
/**
|
|
207
207
|
* Delete multiple product fields in bulk
|
|
208
208
|
* Marks multiple fields as deleted.
|
|
209
|
-
* @param {String} ids
|
|
209
|
+
* @param {String} ids The comma-separated field IDs to delete
|
|
210
210
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteMultipleProductFieldsResponse}
|
|
211
211
|
*/
|
|
212
212
|
|
|
@@ -220,7 +220,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
220
220
|
/**
|
|
221
221
|
* Get one product field
|
|
222
222
|
* Returns data about a specific product field.
|
|
223
|
-
* @param {Number} id ID of the
|
|
223
|
+
* @param {Number} id The ID of the product field
|
|
224
224
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductFieldResponse} and HTTP response
|
|
225
225
|
*/
|
|
226
226
|
|
|
@@ -263,7 +263,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
263
263
|
/**
|
|
264
264
|
* Get one product field
|
|
265
265
|
* Returns data about a specific product field.
|
|
266
|
-
* @param {Number} id ID of the
|
|
266
|
+
* @param {Number} id The ID of the product field
|
|
267
267
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductFieldResponse}
|
|
268
268
|
*/
|
|
269
269
|
|
|
@@ -276,7 +276,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
276
276
|
}
|
|
277
277
|
/**
|
|
278
278
|
* Get all product fields
|
|
279
|
-
* Returns data about all product fields
|
|
279
|
+
* Returns data about all product fields.
|
|
280
280
|
* @param {Object} opts Optional parameters
|
|
281
281
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
282
282
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -317,7 +317,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
317
317
|
}
|
|
318
318
|
/**
|
|
319
319
|
* Get all product fields
|
|
320
|
-
* Returns data about all product fields
|
|
320
|
+
* Returns data about all product fields.
|
|
321
321
|
* @param {Object} opts Optional parameters
|
|
322
322
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
323
323
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -334,7 +334,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
334
334
|
/**
|
|
335
335
|
* Update a product field
|
|
336
336
|
* Updates a product field. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
337
|
-
* @param {Number} id ID of the
|
|
337
|
+
* @param {Number} id The ID of the product field
|
|
338
338
|
* @param {Object} opts Optional parameters
|
|
339
339
|
* @param {module:model/BasicProductField} opts.basicProductField
|
|
340
340
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProductFieldResponse} and HTTP response
|
|
@@ -379,7 +379,7 @@ var ProductFieldsApi = /*#__PURE__*/function () {
|
|
|
379
379
|
/**
|
|
380
380
|
* Update a product field
|
|
381
381
|
* Updates a product field. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
|
|
382
|
-
* @param {Number} id ID of the
|
|
382
|
+
* @param {Number} id The ID of the product field
|
|
383
383
|
* @param {Object} opts Optional parameters
|
|
384
384
|
* @param {module:model/BasicProductField} opts.basicProductField
|
|
385
385
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProductFieldResponse}
|
package/dist/api/ProductsApi.js
CHANGED
|
@@ -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
|
|
@@ -167,7 +167,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
167
167
|
/**
|
|
168
168
|
* Add a follower to a product
|
|
169
169
|
* Adds a follower to a product.
|
|
170
|
-
* @param {Number} id ID of the product
|
|
170
|
+
* @param {Number} id The ID of the product
|
|
171
171
|
* @param {Object} opts Optional parameters
|
|
172
172
|
* @param {module:model/AddProductFollowerRequest} opts.addProductFollowerRequest
|
|
173
173
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NewFollowerResponse}
|
|
@@ -183,7 +183,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
183
183
|
/**
|
|
184
184
|
* Delete a product
|
|
185
185
|
* Marks a product as deleted.
|
|
186
|
-
* @param {Number} id ID of the product
|
|
186
|
+
* @param {Number} id The ID of the product
|
|
187
187
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductResponse} and HTTP response
|
|
188
188
|
*/
|
|
189
189
|
|
|
@@ -226,7 +226,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
226
226
|
/**
|
|
227
227
|
* Delete a product
|
|
228
228
|
* Marks a product as deleted.
|
|
229
|
-
* @param {Number} id ID of the product
|
|
229
|
+
* @param {Number} id The ID of the product
|
|
230
230
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductResponse}
|
|
231
231
|
*/
|
|
232
232
|
|
|
@@ -240,8 +240,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
240
240
|
/**
|
|
241
241
|
* Delete a follower from a product
|
|
242
242
|
* Deletes a follower from a product.
|
|
243
|
-
* @param {Number} id ID of the product
|
|
244
|
-
* @param {Number} followerId ID of the follower
|
|
243
|
+
* @param {Number} id The ID of the product
|
|
244
|
+
* @param {Number} followerId The ID of the relationship between the follower and the product
|
|
245
245
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteProductFollowerResponse} and HTTP response
|
|
246
246
|
*/
|
|
247
247
|
|
|
@@ -290,8 +290,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
290
290
|
/**
|
|
291
291
|
* Delete a follower from a product
|
|
292
292
|
* Deletes a follower from a product.
|
|
293
|
-
* @param {Number} id ID of the product
|
|
294
|
-
* @param {Number} followerId ID of the follower
|
|
293
|
+
* @param {Number} id The ID of the product
|
|
294
|
+
* @param {Number} followerId The ID of the relationship between the follower and the product
|
|
295
295
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteProductFollowerResponse}
|
|
296
296
|
*/
|
|
297
297
|
|
|
@@ -305,7 +305,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
305
305
|
/**
|
|
306
306
|
* Get one product
|
|
307
307
|
* Returns data about a specific product.
|
|
308
|
-
* @param {Number} id ID of the product
|
|
308
|
+
* @param {Number} id The ID of the product
|
|
309
309
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProductResponse} and HTTP response
|
|
310
310
|
*/
|
|
311
311
|
|
|
@@ -348,7 +348,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
348
348
|
/**
|
|
349
349
|
* Get one product
|
|
350
350
|
* Returns data about a specific product.
|
|
351
|
-
* @param {Number} id ID of the product
|
|
351
|
+
* @param {Number} id The ID of the product
|
|
352
352
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductResponse}
|
|
353
353
|
*/
|
|
354
354
|
|
|
@@ -361,12 +361,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
361
361
|
}
|
|
362
362
|
/**
|
|
363
363
|
* 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
|
|
364
|
+
* Returns data about deals that have a product attached to it.
|
|
365
|
+
* @param {Number} id The ID of the product
|
|
366
366
|
* @param {Object} opts Optional parameters
|
|
367
367
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
368
368
|
* @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')
|
|
369
|
+
* @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
370
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateDealRequest} and HTTP response
|
|
371
371
|
*/
|
|
372
372
|
|
|
@@ -412,12 +412,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
412
412
|
}
|
|
413
413
|
/**
|
|
414
414
|
* 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
|
|
415
|
+
* Returns data about deals that have a product attached to it.
|
|
416
|
+
* @param {Number} id The ID of the product
|
|
417
417
|
* @param {Object} opts Optional parameters
|
|
418
418
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
419
419
|
* @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')
|
|
420
|
+
* @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
421
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateDealRequest}
|
|
422
422
|
*/
|
|
423
423
|
|
|
@@ -431,12 +431,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
431
431
|
/**
|
|
432
432
|
* List files attached to a product
|
|
433
433
|
* Lists files associated with a product.
|
|
434
|
-
* @param {Number} id ID of the product
|
|
434
|
+
* @param {Number} id The ID of the product
|
|
435
435
|
* @param {Object} opts Optional parameters
|
|
436
436
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
437
437
|
* @param {Number} opts.limit Items shown per page
|
|
438
438
|
* @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
|
|
439
|
+
* @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
440
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListFilesResponse} and HTTP response
|
|
441
441
|
*/
|
|
442
442
|
|
|
@@ -484,12 +484,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
484
484
|
/**
|
|
485
485
|
* List files attached to a product
|
|
486
486
|
* Lists files associated with a product.
|
|
487
|
-
* @param {Number} id ID of the product
|
|
487
|
+
* @param {Number} id The ID of the product
|
|
488
488
|
* @param {Object} opts Optional parameters
|
|
489
489
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
490
490
|
* @param {Number} opts.limit Items shown per page
|
|
491
491
|
* @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
|
|
492
|
+
* @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
493
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListFilesResponse}
|
|
494
494
|
*/
|
|
495
495
|
|
|
@@ -502,8 +502,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
502
502
|
}
|
|
503
503
|
/**
|
|
504
504
|
* List followers of a product
|
|
505
|
-
* Lists the followers of a
|
|
506
|
-
* @param {Number} id ID of the product
|
|
505
|
+
* Lists the followers of a product.
|
|
506
|
+
* @param {Number} id The ID of the product
|
|
507
507
|
* @param {Object} opts Optional parameters
|
|
508
508
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
509
509
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -551,8 +551,8 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
551
551
|
}
|
|
552
552
|
/**
|
|
553
553
|
* List followers of a product
|
|
554
|
-
* Lists the followers of a
|
|
555
|
-
* @param {Number} id ID of the product
|
|
554
|
+
* Lists the followers of a product.
|
|
555
|
+
* @param {Number} id The ID of the product
|
|
556
556
|
* @param {Object} opts Optional parameters
|
|
557
557
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
558
558
|
* @param {Number} opts.limit Items shown per page
|
|
@@ -569,7 +569,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
569
569
|
/**
|
|
570
570
|
* List permitted users
|
|
571
571
|
* Lists users permitted to access a product.
|
|
572
|
-
* @param {Number} id ID of the product
|
|
572
|
+
* @param {Number} id The ID of the product
|
|
573
573
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserIDs} and HTTP response
|
|
574
574
|
*/
|
|
575
575
|
|
|
@@ -612,7 +612,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
612
612
|
/**
|
|
613
613
|
* List permitted users
|
|
614
614
|
* Lists users permitted to access a product.
|
|
615
|
-
* @param {Number} id ID of the product
|
|
615
|
+
* @param {Number} id The ID of the product
|
|
616
616
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserIDs}
|
|
617
617
|
*/
|
|
618
618
|
|
|
@@ -625,13 +625,13 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
625
625
|
}
|
|
626
626
|
/**
|
|
627
627
|
* Get all products
|
|
628
|
-
* Returns data about all
|
|
628
|
+
* Returns data about all products.
|
|
629
629
|
* @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
|
|
630
|
+
* @param {Number} opts.userId If supplied, only products owned by the given user will be returned
|
|
631
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
|
632
|
+
* @param {Array.<Number>} opts.ids An array of integers with the IDs of the products that should be returned in the response
|
|
633
|
+
* @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
|
|
634
|
+
* @param {Boolean} opts.getSummary If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
|
|
635
635
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
636
636
|
* @param {Number} opts.limit Items shown per page
|
|
637
637
|
* @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 +676,13 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
676
676
|
}
|
|
677
677
|
/**
|
|
678
678
|
* Get all products
|
|
679
|
-
* Returns data about all
|
|
679
|
+
* Returns data about all products.
|
|
680
680
|
* @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
|
|
681
|
+
* @param {Number} opts.userId If supplied, only products owned by the given user will be returned
|
|
682
|
+
* @param {Number} opts.filterId The ID of the filter to use
|
|
683
|
+
* @param {Array.<Number>} opts.ids An array of integers with the IDs of the products that should be returned in the response
|
|
684
|
+
* @param {String} opts.firstChar If supplied, only products whose name starts with the specified letter will be returned (case insensitive)
|
|
685
|
+
* @param {Boolean} opts.getSummary If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
|
|
686
686
|
* @param {Number} opts.start Pagination start (default to 0)
|
|
687
687
|
* @param {Number} opts.limit Items shown per page
|
|
688
688
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductsResponse}
|
|
@@ -697,12 +697,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
697
697
|
}
|
|
698
698
|
/**
|
|
699
699
|
* Search products
|
|
700
|
-
* Searches all
|
|
700
|
+
* 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
701
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
|
702
702
|
* @param {Object} opts Optional parameters
|
|
703
703
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
704
704
|
* @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
|
|
705
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
|
706
706
|
* @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
707
|
* @param {Number} opts.limit Items shown per page
|
|
708
708
|
* @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 +751,12 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
751
751
|
}
|
|
752
752
|
/**
|
|
753
753
|
* Search products
|
|
754
|
-
* Searches all
|
|
754
|
+
* 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
755
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
|
756
756
|
* @param {Object} opts Optional parameters
|
|
757
757
|
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
758
758
|
* @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
|
|
759
|
+
* @param {module:model/String} opts.includeFields Supports including optional fields in the results which are not provided by default
|
|
760
760
|
* @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
761
|
* @param {Number} opts.limit Items shown per page
|
|
762
762
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProductSearchResponse}
|
|
@@ -772,7 +772,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
772
772
|
/**
|
|
773
773
|
* Update a product
|
|
774
774
|
* Updates product data.
|
|
775
|
-
* @param {Number} id ID of the product
|
|
775
|
+
* @param {Number} id The ID of the product
|
|
776
776
|
* @param {Object} opts Optional parameters
|
|
777
777
|
* @param {module:model/ProductRequest} opts.productRequest
|
|
778
778
|
* @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 +817,7 @@ var ProductsApi = /*#__PURE__*/function () {
|
|
|
817
817
|
/**
|
|
818
818
|
* Update a product
|
|
819
819
|
* Updates product data.
|
|
820
|
-
* @param {Number} id ID of the product
|
|
820
|
+
* @param {Number} id The ID of the product
|
|
821
821
|
* @param {Object} opts Optional parameters
|
|
822
822
|
* @param {module:model/ProductRequest} opts.productRequest
|
|
823
823
|
* @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}
|