pipedrive 13.0.11 → 13.1.2
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +18 -0
- package/README.md +23 -20
- package/dist/ApiClient.js +46 -9
- package/dist/api/ActivitiesApi.js +44 -44
- package/dist/api/ActivityTypesApi.js +36 -36
- package/dist/api/CallLogsApi.js +23 -6
- package/dist/api/CurrenciesApi.js +2 -2
- package/dist/api/DealFieldsApi.js +18 -18
- package/dist/api/DealsApi.js +122 -110
- package/dist/api/FilesApi.js +38 -38
- package/dist/api/FiltersApi.js +23 -6
- package/dist/api/GlobalMessagesApi.js +8 -8
- package/dist/api/GoalsApi.js +54 -54
- package/dist/api/ItemSearchApi.js +6 -6
- package/dist/api/LeadLabelsApi.js +21 -12
- package/dist/api/LeadSourcesApi.js +2 -2
- package/dist/api/LeadsApi.js +23 -18
- package/dist/api/MailboxApi.js +26 -26
- package/dist/api/NoteFieldsApi.js +2 -2
- package/dist/api/NotesApi.js +50 -42
- package/dist/api/OrganizationFieldsApi.js +16 -16
- package/dist/api/OrganizationRelationshipsApi.js +25 -12
- package/dist/api/OrganizationsApi.js +64 -56
- package/dist/api/PermissionSetsApi.js +12 -12
- package/dist/api/PersonFieldsApi.js +16 -16
- package/dist/api/PersonsApi.js +92 -84
- package/dist/api/PipelinesApi.js +50 -50
- package/dist/api/ProductFieldsApi.js +29 -16
- package/dist/api/ProductsApi.js +50 -46
- package/dist/api/RecentsApi.js +6 -6
- package/dist/api/RolesApi.js +38 -38
- package/dist/api/StagesApi.js +14 -14
- package/dist/api/SubscriptionsApi.js +76 -34
- package/dist/api/TeamsApi.js +49 -32
- package/dist/api/UserConnectionsApi.js +2 -2
- package/dist/api/UserSettingsApi.js +2 -2
- package/dist/api/UsersApi.js +44 -44
- package/dist/api/WebhooksApi.js +27 -14
- package/dist/index.js +24 -0
- package/dist/model/ActivityDistributionDataActivityDistribution.js +1 -1
- package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERID.js +4 -4
- package/dist/model/ActivityDistributionDataActivityDistributionASSIGNEDTOUSERIDActivities.js +2 -2
- package/dist/model/ActivityInfo.js +5 -5
- package/dist/model/ActivityObjectFragment.js +9 -9
- package/dist/model/ActivityPostObject.js +32 -32
- package/dist/model/ActivityPostObjectAllOf.js +7 -7
- package/dist/model/ActivityPutObject.js +32 -32
- package/dist/model/ActivityPutObjectAllOf.js +7 -7
- package/dist/model/ActivityResponseObject.js +96 -96
- package/dist/model/ActivityResponseObjectAllOf.js +39 -39
- package/dist/model/ActivityTypeBulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/ActivityTypeListResponse.js +2 -2
- package/dist/model/ActivityTypeListResponseAllOf.js +1 -1
- package/dist/model/ActivityTypeObjectResponse.js +9 -9
- package/dist/model/AddDealFollowerRequest.js +2 -2
- package/dist/model/AddDealParticipantRequest.js +2 -2
- package/dist/model/AddFollowerToPersonResponseAllOfData.js +4 -4
- package/dist/model/AddLeadLabelRequest.js +2 -2
- package/dist/model/AddLeadRequest.js +9 -9
- package/dist/model/AddNoteRequest.js +22 -22
- package/dist/model/AddNoteRequestAllOf.js +4 -4
- package/dist/model/AddOrganizationRelationshipRequest.js +5 -5
- package/dist/model/AddPersonFollowerRequest.js +2 -2
- package/dist/model/AddProductAttachmentDetails.js +36 -36
- package/dist/model/AddProductAttachmentDetailsAllOf.js +1 -1
- package/dist/model/AddProductFollowerRequest.js +2 -2
- package/dist/model/AddProductRequestBody.js +12 -12
- package/dist/model/AddTeamUserRequest.js +2 -2
- package/dist/model/AddWebhookRequest.js +7 -7
- package/dist/model/AddedDealFollowerData.js +4 -4
- package/dist/model/AdditionalBaseOrganizationItemInfo.js +64 -64
- package/dist/model/AdditionalDataWithPagination.js +1 -1
- package/dist/model/AdditionalMergePersonInfo.js +60 -60
- package/dist/model/AdditionalPersonInfo.js +50 -50
- package/dist/model/AllOrganizationRelationshipsGetResponse.js +2 -2
- package/dist/model/AllOrganizationRelationshipsGetResponseAllOf.js +1 -1
- package/dist/model/AllOrganizationsGetResponse.js +2 -2
- package/dist/model/AllOrganizationsGetResponseAllOf.js +1 -1
- package/dist/model/Assignee.js +3 -3
- package/dist/model/BaseComment.js +7 -7
- package/dist/model/BaseCurrency.js +7 -7
- package/dist/model/BaseDeal.js +51 -51
- package/dist/model/BaseNote.js +14 -14
- package/dist/model/BaseNoteDealTitle.js +2 -2
- package/dist/model/BaseNoteOrganization.js +2 -2
- package/dist/model/BaseNotePerson.js +2 -2
- package/dist/model/BaseOrganizationItem.js +86 -86
- package/dist/model/BaseOrganizationItemFields.js +11 -11
- package/dist/model/BaseOrganizationItemWithEditNameFlag.js +88 -88
- package/dist/model/BaseOrganizationItemWithEditNameFlagAllOf.js +1 -1
- package/dist/model/BaseOrganizationRelationshipItem.js +5 -5
- package/dist/model/BasePersonItem.js +13 -13
- package/dist/model/BasePersonItemEmail.js +2 -2
- package/dist/model/BasePersonItemPhone.js +3 -3
- package/dist/model/BasePipeline.js +8 -8
- package/dist/model/BasePipelineWithSelectedFlag.js +18 -18
- package/dist/model/BasePipelineWithSelectedFlagAllOf.js +1 -1
- package/dist/model/BaseProduct.js +3 -3
- package/dist/model/BaseRole.js +3 -3
- package/dist/model/BaseStage.js +10 -10
- package/dist/model/BaseTeam.js +20 -20
- package/dist/model/BaseTeamAdditionalProperties.js +2 -2
- package/dist/model/BaseUser.js +19 -19
- package/dist/model/BaseUserMe.js +48 -48
- package/dist/model/BaseUserMeAllOf.js +5 -5
- package/dist/model/BaseUserMeAllOfLanguage.js +1 -1
- package/dist/model/BaseWebhook.js +3 -3
- package/dist/model/BasicDeal.js +10 -10
- package/dist/model/BasicDealProduct.js +6 -6
- package/dist/model/BasicGoal.js +6 -6
- package/dist/model/BasicOrganization.js +3 -3
- package/dist/model/BasicPerson.js +23 -10
- package/dist/model/BasicPersonEmail.js +112 -0
- package/dist/model/BasicProductField.js +3 -3
- package/dist/model/BulkDeleteResponseAllOfData.js +1 -1
- package/dist/model/CalculatedFields.js +2 -2
- package/dist/model/CallLogObject.js +6 -6
- package/dist/model/CommentPostPutObject.js +2 -2
- package/dist/model/CreateTeam.js +6 -6
- package/dist/model/Currencies.js +1 -1
- package/dist/model/DealCountAndActivityInfo.js +26 -26
- package/dist/model/DealFlowResponseAllOfData.js +1 -1
- package/dist/model/DealListActivitiesResponse.js +2 -2
- package/dist/model/DealListActivitiesResponseAllOf.js +1 -1
- package/dist/model/DealNonStrict.js +104 -104
- package/dist/model/DealNonStrictModeFields.js +1 -1
- package/dist/model/DealNonStrictModeFieldsCreatorUserId.js +6 -6
- package/dist/model/DealNonStrictWithDetails.js +110 -110
- package/dist/model/DealNonStrictWithDetailsAllOf.js +3 -3
- package/dist/model/DealNonStrictWithDetailsAllOfAge.js +1 -1
- package/dist/model/DealNonStrictWithDetailsAllOfAverageTimeToWon.js +1 -1
- package/dist/model/DealNonStrictWithDetailsAllOfStayInPipelineStages.js +3 -3
- package/dist/model/DealOrganizationData.js +7 -7
- package/dist/model/DealOrganizationDataWithId.js +14 -14
- package/dist/model/DealOrganizationDataWithIdAllOf.js +1 -1
- package/dist/model/DealParticipantCountInfo.js +2 -2
- package/dist/model/DealParticipants.js +1 -1
- package/dist/model/DealPersonData.js +10 -10
- package/dist/model/DealPersonDataEmail.js +112 -0
- package/dist/model/DealPersonDataPhone.js +1 -1
- package/dist/model/DealPersonDataWithId.js +17 -17
- package/dist/model/DealPersonDataWithIdAllOf.js +1 -1
- package/dist/model/DealSearchItemItem.js +8 -8
- package/dist/model/DealSearchItemItemOrganization.js +2 -2
- package/dist/model/DealSearchItemItemOwner.js +1 -1
- package/dist/model/DealSearchItemItemPerson.js +2 -2
- package/dist/model/DealSearchItemItemStage.js +2 -2
- package/dist/model/DealSearchResponseAllOfData.js +1 -1
- package/dist/model/DealStrict.js +112 -112
- package/dist/model/DealStrictModeFields.js +5 -5
- package/dist/model/DealStrictWithMergeId.js +114 -114
- package/dist/model/DealStrictWithMergeIdAllOf.js +1 -1
- package/dist/model/DealSummaryPerStages.js +1 -1
- package/dist/model/DealTitleParameter.js +1 -1
- package/dist/model/DealUserData.js +7 -7
- package/dist/model/DealUserDataWithId.js +14 -14
- package/dist/model/DealUserDataWithIdAllOf.js +1 -1
- package/dist/model/DealsCountAndActivityInfo.js +26 -26
- package/dist/model/DealsCountInfo.js +8 -8
- package/dist/model/DealsMovementsInfo.js +2 -2
- package/dist/model/DealsMovementsInfoFormattedValues.js +2 -2
- package/dist/model/DealsMovementsInfoValues.js +2 -2
- package/dist/model/DeleteActivitiesResponse200Data.js +1 -1
- package/dist/model/DeleteActivityResponse200Data.js +1 -1
- package/dist/model/DeleteDealData.js +1 -1
- package/dist/model/DeleteDealFollowerData.js +1 -1
- package/dist/model/DeleteDealParticipantData.js +1 -1
- package/dist/model/DeleteDealProductData.js +2 -2
- package/dist/model/DeleteFileData.js +1 -1
- package/dist/model/DeleteMultipleDealsData.js +1 -1
- package/dist/model/DeleteMultipleProductFieldsResponseData.js +1 -1
- package/dist/model/DeletePersonResponseAllOfData.js +1 -1
- package/dist/model/DeletePersonsInBulkResponseAllOfData.js +1 -1
- package/dist/model/DeleteProductFieldResponseData.js +1 -1
- package/dist/model/DeleteProductFollowerResponseData.js +1 -1
- package/dist/model/DeleteProductResponseData.js +1 -1
- package/dist/model/DeleteResponseAllOfData.js +1 -1
- package/dist/model/DeleteRoleAllOfData.js +1 -1
- package/dist/model/DeleteRoleAssignmentAllOfData.js +1 -1
- package/dist/model/DeleteStageResponse200Data.js +1 -1
- package/dist/model/DeleteStagesResponse200Data.js +1 -1
- package/dist/model/DeleteTeamUserRequest.js +2 -2
- package/dist/model/Duration.js +3 -3
- package/dist/model/EditPipeline.js +2 -2
- package/dist/model/EditPipelineAllOf.js +1 -1
- package/dist/model/EmailInfo.js +2 -2
- package/dist/model/ExpectedOutcome.js +3 -3
- package/dist/model/Field.js +18 -18
- package/dist/model/FieldCreateRequest.js +5 -5
- package/dist/model/FieldCreateRequestAllOf.js +3 -3
- package/dist/model/FieldUpdateRequest.js +1 -1
- package/dist/model/FileData.js +24 -24
- package/dist/model/FileItem.js +24 -24
- package/dist/model/FiltersPostResponseAllOfData.js +1 -1
- package/dist/model/FullRole.js +12 -12
- package/dist/model/FullRoleAllOf.js +1 -1
- package/dist/model/GetAddProductAttachementDetails.js +1 -1
- package/dist/model/GetAddedDeal.js +1 -1
- package/dist/model/GetAddedDealAdditionalData.js +1 -1
- package/dist/model/GetAllPersonsResponse.js +2 -2
- package/dist/model/GetAllPersonsResponseAllOf.js +1 -1
- package/dist/model/GetAllProductFieldsResponse.js +2 -2
- package/dist/model/GetComments.js +1 -1
- package/dist/model/GetDealAdditionalData.js +1 -1
- package/dist/model/GetDeals.js +1 -1
- package/dist/model/GetDealsConversionRatesInPipelineAllOfData.js +4 -4
- package/dist/model/GetDealsMovementsInPipelineAllOfData.js +1 -1
- package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDays.js +3 -3
- package/dist/model/GetDealsMovementsInPipelineAllOfDataAverageAgeInDaysByStages.js +3 -3
- package/dist/model/GetDealsMovementsInPipelineAllOfDataMovementsBetweenStages.js +2 -2
- package/dist/model/GetDealsSummaryData.js +6 -6
- package/dist/model/GetDealsSummaryDataValuesTotal.js +6 -6
- package/dist/model/GetDealsSummaryDataWeightedValuesTotal.js +4 -4
- package/dist/model/GetDealsTimelineData.js +1 -1
- package/dist/model/GetDealsTimelineDataTotals.js +9 -9
- package/dist/model/GetDuplicatedDeal.js +1 -1
- package/dist/model/GetLeadSourcesResponse200Data.js +1 -1
- package/dist/model/GetNotes.js +1 -1
- package/dist/model/GetPersonDetailsResponseAllOfAdditionalData.js +1 -1
- package/dist/model/GetProductAttachementDetails.js +1 -1
- package/dist/model/GetProductFieldResponse.js +1 -1
- package/dist/model/GetRecentsAdditionalData.js +2 -2
- package/dist/model/GetRoleAllOfAdditionalData.js +1 -1
- package/dist/model/GetRoleAssignments.js +2 -2
- package/dist/model/GetRoleAssignmentsAllOf.js +1 -1
- package/dist/model/GetRoles.js +2 -2
- package/dist/model/GetRolesAllOf.js +1 -1
- package/dist/model/GetStageDeals.js +1 -1
- package/dist/model/GetStages.js +1 -1
- package/dist/model/GlobalMessageData.js +6 -6
- package/dist/model/GlobalMessageGet.js +2 -2
- package/dist/model/GlobalMessageGetAllOf.js +1 -1
- package/dist/model/GlobalMessageUserData.js +3 -3
- package/dist/model/GoalResults.js +1 -1
- package/dist/model/GoalType.js +2 -2
- package/dist/model/GoalsResponseComponent.js +4 -4
- package/dist/model/LeadLabelResponse.js +4 -4
- package/dist/model/LeadResponse.js +16 -16
- package/dist/model/LeadValue.js +1 -1
- package/dist/model/ListActivitiesResponse.js +2 -2
- package/dist/model/ListActivitiesResponseAllOf.js +1 -1
- package/dist/model/ListDealsResponse.js +2 -2
- package/dist/model/ListDealsResponseAllOf.js +1 -1
- package/dist/model/ListFilesResponse.js +2 -2
- package/dist/model/ListFilesResponseAllOf.js +1 -1
- package/dist/model/ListFollowersResponse.js +2 -2
- package/dist/model/ListFollowersResponseAllOf.js +1 -1
- package/dist/model/ListFollowersResponseAllOfData.js +4 -4
- package/dist/model/ListMailMessagesResponse.js +2 -2
- package/dist/model/ListMailMessagesResponseAllOf.js +1 -1
- package/dist/model/ListPermittedUsersResponse1.js +2 -2
- package/dist/model/ListPermittedUsersResponse1AllOf.js +1 -1
- package/dist/model/ListPermittedUsersResponseAllOfData.js +1 -1
- package/dist/model/ListPersonProductsResponse.js +2 -2
- package/dist/model/ListPersonProductsResponseAllOf.js +1 -1
- package/dist/model/ListPersonsResponse.js +2 -2
- package/dist/model/ListPersonsResponseAllOf.js +1 -1
- package/dist/model/ListProductAdditionalData.js +10 -10
- package/dist/model/ListProductAdditionalDataAllOf.js +5 -5
- package/dist/model/ListProductFollowersResponse.js +2 -2
- package/dist/model/ListProductFollowersResponseAllOf.js +1 -1
- package/dist/model/ListProductFollowersResponseAllOfData.js +4 -4
- package/dist/model/ListProductsResponseAllOfData.js +1 -1
- package/dist/model/MarketingStatus.js +69 -0
- package/dist/model/MergeDealsRequest.js +2 -2
- package/dist/model/MergeOrganizationsRequest.js +2 -2
- package/dist/model/MergePersonDealRelatedInfo.js +30 -30
- package/dist/model/MergePersonItem.js +86 -86
- package/dist/model/MergePersonsRequest.js +2 -2
- package/dist/model/NewDeal.js +25 -25
- package/dist/model/NewDealAllOf.js +1 -1
- package/dist/model/NewDealProduct.js +16 -16
- package/dist/model/NewDealProductAllOf.js +2 -2
- package/dist/model/NewFollowerResponseData.js +4 -4
- package/dist/model/NewGoal.js +12 -12
- package/dist/model/NewOrganization.js +9 -9
- package/dist/model/NewOrganizationAllOf.js +1 -1
- package/dist/model/NewPerson.js +40 -21
- package/dist/model/NewPersonAllOf.js +1 -1
- package/dist/model/NewProductField.js +4 -4
- package/dist/model/Note.js +19 -19
- package/dist/model/NoteConnectToParams.js +2 -2
- package/dist/model/NoteCreatorUser.js +5 -5
- package/dist/model/NoteField.js +7 -7
- package/dist/model/NoteParams.js +7 -7
- package/dist/model/OrganizationAddressInfo.js +11 -11
- package/dist/model/OrganizationCountAndAddressInfo.js +38 -38
- package/dist/model/OrganizationCountInfo.js +8 -8
- package/dist/model/OrganizationData.js +5 -5
- package/dist/model/OrganizationDataWithId.js +13 -13
- package/dist/model/OrganizationDataWithIdAllOf.js +1 -1
- package/dist/model/OrganizationDataWithIdAndActiveFlag.js +15 -15
- package/dist/model/OrganizationDataWithIdAndActiveFlagAllOf.js +1 -1
- package/dist/model/OrganizationDeleteResponseData.js +1 -1
- package/dist/model/OrganizationDetailsGetResponseAllOfAdditionalData.js +1 -1
- package/dist/model/OrganizationFlowResponseAllOfData.js +1 -1
- package/dist/model/OrganizationFollowerDeleteResponseData.js +1 -1
- package/dist/model/OrganizationFollowerItem.js +2 -2
- package/dist/model/OrganizationFollowerItemAllOf.js +1 -1
- package/dist/model/OrganizationItem.js +88 -88
- package/dist/model/OrganizationRelationship.js +1 -1
- package/dist/model/OrganizationRelationshipDeleteResponseAllOfData.js +1 -1
- package/dist/model/OrganizationRelationshipDetails.js +16 -16
- package/dist/model/OrganizationRelationshipWithCalculatedFields.js +14 -14
- package/dist/model/OrganizationSearchItemItem.js +5 -5
- package/dist/model/OrganizationsDeleteResponseData.js +1 -1
- package/dist/model/OrganizationsMergeResponseData.js +1 -1
- package/dist/model/Owner.js +12 -12
- package/dist/model/Params.js +2 -2
- package/dist/model/PaymentItem.js +13 -13
- package/dist/model/PermissionSets.js +2 -2
- package/dist/model/PermissionSetsAllOf.js +1 -1
- package/dist/model/PermissionSetsItem.js +3 -3
- package/dist/model/PersonCountAndEmailInfo.js +18 -18
- package/dist/model/PersonCountEmailDealAndActivityInfo.js +44 -44
- package/dist/model/PersonCountInfo.js +7 -7
- package/dist/model/PersonData.js +5 -5
- package/dist/model/PersonDataEmail.js +2 -2
- package/dist/model/PersonDataPhone.js +2 -2
- package/dist/model/PersonDataWithActiveFlag.js +13 -13
- package/dist/model/PersonDataWithActiveFlagAllOf.js +1 -1
- package/dist/model/PersonFlowResponseAllOfData.js +1 -1
- package/dist/model/PersonItem.js +76 -76
- package/dist/model/PersonListProduct.js +14 -14
- package/dist/model/PersonNameCountAndEmailInfo.js +24 -24
- package/dist/model/PersonNameCountAndEmailInfoWithIds.js +30 -30
- package/dist/model/PersonNameCountAndEmailInfoWithIdsAllOf.js +3 -3
- package/dist/model/PersonNameInfo.js +3 -3
- package/dist/model/PersonNameInfoWithOrgAndOwnerId.js +6 -6
- package/dist/model/PersonSearchItemItem.js +4 -4
- package/dist/model/PersonSearchItemItemOrganization.js +2 -2
- package/dist/model/PersonSearchItemItemOwner.js +1 -1
- package/dist/model/PictureData.js +2 -2
- package/dist/model/PictureDataWithID.js +4 -4
- package/dist/model/PictureDataWithValue.js +4 -4
- package/dist/model/Pipeline.js +4 -4
- package/dist/model/PipelineDetails.js +19 -19
- package/dist/model/PostDealParticipants.js +1 -1
- package/dist/model/PostRoleAssignmentAllOfData.js +2 -2
- package/dist/model/PostRoleSettingsAllOfData.js +1 -1
- package/dist/model/PostRolesAllOfData.js +1 -1
- package/dist/model/ProductAttachementFields.js +12 -12
- package/dist/model/ProductAttachmentDetails.js +35 -35
- package/dist/model/ProductBaseDeal.js +42 -42
- package/dist/model/ProductField.js +36 -36
- package/dist/model/ProductFieldAllOf.js +15 -15
- package/dist/model/ProductListItem.js +21 -21
- package/dist/model/ProductRequest.js +6 -6
- package/dist/model/ProductSearchItemItem.js +5 -5
- package/dist/model/ProductSearchItemItemOwner.js +1 -1
- package/dist/model/ProductWithArrayPrices.js +6 -6
- package/dist/model/ProductWithObjectPrices.js +6 -6
- package/dist/model/ProductsResponse.js +1 -1
- package/dist/model/RecentDataProduct.js +15 -15
- package/dist/model/RelatedDealDataDEALID.js +8 -8
- package/dist/model/RelatedOrganizationName.js +1 -1
- package/dist/model/RelatedPersonData.js +1 -1
- package/dist/model/RelationshipOrganizationInfoItem.js +12 -12
- package/dist/model/RelationshipOrganizationInfoItemAllOf.js +1 -1
- package/dist/model/RelationshipOrganizationInfoItemWithActiveFlag.js +14 -14
- package/dist/model/RequredTitleParameter.js +2 -2
- package/dist/model/ResponseCallLogObject.js +14 -14
- package/dist/model/ResponseCallLogObjectAllOf.js +1 -1
- package/dist/model/RoleAssignment.js +11 -11
- package/dist/model/RoleAssignmentAllOf.js +3 -3
- package/dist/model/RoleSettings.js +10 -10
- package/dist/model/RolesAdditionalData.js +1 -1
- package/dist/model/RolesAdditionalDataPagination.js +1 -1
- package/dist/model/SinglePermissionSetsItem.js +8 -8
- package/dist/model/SinglePermissionSetsItemAllOf.js +1 -1
- package/dist/model/Stage.js +5 -5
- package/dist/model/StageConversions.js +3 -3
- package/dist/model/StageDetails.js +21 -21
- package/dist/model/StageWithPipelineInfo.js +24 -24
- package/dist/model/StageWithPipelineInfoAllOf.js +2 -2
- package/dist/model/SubRole.js +10 -10
- package/dist/model/SubRoleAllOf.js +3 -3
- package/dist/model/SubscriptionInstallmentCreateRequest.js +5 -5
- package/dist/model/SubscriptionInstallmentUpdateRequest.js +1 -1
- package/dist/model/SubscriptionItem.js +15 -15
- package/dist/model/SubscriptionRecurringCancelRequest.js +1 -1
- package/dist/model/SubscriptionRecurringCreateRequest.js +14 -14
- package/dist/model/SubscriptionRecurringUpdateRequest.js +3 -3
- package/dist/model/TeamId.js +1 -1
- package/dist/model/UpdateDealRequest.js +22 -22
- package/dist/model/UpdateLeadLabelRequest.js +1 -1
- package/dist/model/UpdateLeadRequest.js +9 -9
- package/dist/model/UpdateStageRequest.js +10 -10
- package/dist/model/UpdateTeam.js +14 -14
- package/dist/model/UpdateTeamAllOf.js +2 -2
- package/dist/model/UpdateTeamWithAdditionalProperties.js +18 -18
- package/dist/model/UserAssignmentToPermissionSet.js +4 -4
- package/dist/model/UserAssignmentsToPermissionSet.js +2 -2
- package/dist/model/UserAssignmentsToPermissionSetAllOf.js +1 -1
- package/dist/model/UserData.js +6 -6
- package/dist/model/UserDataWithId.js +12 -12
- package/dist/model/UserIDs.js +2 -2
- package/dist/model/UserIDsAllOf.js +1 -1
- package/dist/model/UserPermissionsItem.js +31 -31
- package/dist/model/UserSettingsItem.js +5 -5
- package/package.json +3 -2
package/dist/api/FilesApi.js
CHANGED
@@ -54,14 +54,14 @@ var FilesApi = /*#__PURE__*/function () {
|
|
54
54
|
}
|
55
55
|
/**
|
56
56
|
* Add file
|
57
|
-
* Lets you upload a file and associate it with
|
58
|
-
* @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
|
57
|
+
* Lets you upload a file and associate it with a deal, person, organization, activity or product. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a file</a>.
|
58
|
+
* @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
|
59
59
|
* @param {Object} opts Optional parameters
|
60
|
-
* @param {Number} opts.dealId ID of the deal to associate file(s) with
|
61
|
-
* @param {Number} opts.personId ID of the person to associate file(s) with
|
62
|
-
* @param {Number} opts.orgId ID of the organization to associate file(s) with
|
63
|
-
* @param {Number} opts.productId ID of the product to associate file(s) with
|
64
|
-
* @param {Number} opts.activityId ID of the activity to associate file(s) with
|
60
|
+
* @param {Number} opts.dealId The ID of the deal to associate file(s) with
|
61
|
+
* @param {Number} opts.personId The ID of the person to associate file(s) with
|
62
|
+
* @param {Number} opts.orgId The ID of the organization to associate file(s) with
|
63
|
+
* @param {Number} opts.productId The ID of the product to associate file(s) with
|
64
|
+
* @param {Number} opts.activityId The ID of the activity to associate file(s) with
|
65
65
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddFile} and HTTP response
|
66
66
|
*/
|
67
67
|
|
@@ -109,14 +109,14 @@ var FilesApi = /*#__PURE__*/function () {
|
|
109
109
|
}
|
110
110
|
/**
|
111
111
|
* Add file
|
112
|
-
* Lets you upload a file and associate it with
|
113
|
-
* @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
|
112
|
+
* Lets you upload a file and associate it with a deal, person, organization, activity or product. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a file</a>.
|
113
|
+
* @param {File} file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries
|
114
114
|
* @param {Object} opts Optional parameters
|
115
|
-
* @param {Number} opts.dealId ID of the deal to associate file(s) with
|
116
|
-
* @param {Number} opts.personId ID of the person to associate file(s) with
|
117
|
-
* @param {Number} opts.orgId ID of the organization to associate file(s) with
|
118
|
-
* @param {Number} opts.productId ID of the product to associate file(s) with
|
119
|
-
* @param {Number} opts.activityId ID of the activity to associate file(s) with
|
115
|
+
* @param {Number} opts.dealId The ID of the deal to associate file(s) with
|
116
|
+
* @param {Number} opts.personId The ID of the person to associate file(s) with
|
117
|
+
* @param {Number} opts.orgId The ID of the organization to associate file(s) with
|
118
|
+
* @param {Number} opts.productId The ID of the product to associate file(s) with
|
119
|
+
* @param {Number} opts.activityId The ID of the activity to associate file(s) with
|
120
120
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddFile}
|
121
121
|
*/
|
122
122
|
|
@@ -129,11 +129,11 @@ var FilesApi = /*#__PURE__*/function () {
|
|
129
129
|
}
|
130
130
|
/**
|
131
131
|
* Create a remote file and link it to an item
|
132
|
-
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information
|
132
|
+
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
133
133
|
* @param {module:model/String} fileType The file type
|
134
134
|
* @param {String} title The title of the file
|
135
135
|
* @param {module:model/String} itemType The item type
|
136
|
-
* @param {Number} itemId ID of the item to associate the file with
|
136
|
+
* @param {Number} itemId The ID of the item to associate the file with
|
137
137
|
* @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
|
138
138
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateRemoteFileAndLinkItToItem} and HTTP response
|
139
139
|
*/
|
@@ -200,11 +200,11 @@ var FilesApi = /*#__PURE__*/function () {
|
|
200
200
|
}
|
201
201
|
/**
|
202
202
|
* Create a remote file and link it to an item
|
203
|
-
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information
|
203
|
+
* Creates a new empty file in the remote location (`googledrive`) that will be linked to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
204
204
|
* @param {module:model/String} fileType The file type
|
205
205
|
* @param {String} title The title of the file
|
206
206
|
* @param {module:model/String} itemType The item type
|
207
|
-
* @param {Number} itemId ID of the item to associate the file with
|
207
|
+
* @param {Number} itemId The ID of the item to associate the file with
|
208
208
|
* @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
|
209
209
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateRemoteFileAndLinkItToItem}
|
210
210
|
*/
|
@@ -219,7 +219,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
219
219
|
/**
|
220
220
|
* Delete a file
|
221
221
|
* Marks a file as deleted.
|
222
|
-
* @param {Number} id ID of the file
|
222
|
+
* @param {Number} id The ID of the file
|
223
223
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteFile} and HTTP response
|
224
224
|
*/
|
225
225
|
|
@@ -262,7 +262,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
262
262
|
/**
|
263
263
|
* Delete a file
|
264
264
|
* Marks a file as deleted.
|
265
|
-
* @param {Number} id ID of the file
|
265
|
+
* @param {Number} id The ID of the file
|
266
266
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteFile}
|
267
267
|
*/
|
268
268
|
|
@@ -276,7 +276,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
276
276
|
/**
|
277
277
|
* Download one file
|
278
278
|
* Initializes a file download.
|
279
|
-
* @param {Number} id ID of the file
|
279
|
+
* @param {Number} id The ID of the file
|
280
280
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Blob} and HTTP response
|
281
281
|
*/
|
282
282
|
|
@@ -319,7 +319,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
319
319
|
/**
|
320
320
|
* Download one file
|
321
321
|
* Initializes a file download.
|
322
|
-
* @param {Number} id ID of the file
|
322
|
+
* @param {Number} id The ID of the file
|
323
323
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Blob}
|
324
324
|
*/
|
325
325
|
|
@@ -333,7 +333,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
333
333
|
/**
|
334
334
|
* Get one file
|
335
335
|
* Returns data about a specific file.
|
336
|
-
* @param {Number} id ID of the file
|
336
|
+
* @param {Number} id The ID of the file
|
337
337
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetOneFile} and HTTP response
|
338
338
|
*/
|
339
339
|
|
@@ -376,7 +376,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
376
376
|
/**
|
377
377
|
* Get one file
|
378
378
|
* Returns data about a specific file.
|
379
|
-
* @param {Number} id ID of the file
|
379
|
+
* @param {Number} id The ID of the file
|
380
380
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetOneFile}
|
381
381
|
*/
|
382
382
|
|
@@ -394,7 +394,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
394
394
|
* @param {Number} opts.start Pagination start (default to 0)
|
395
395
|
* @param {Number} opts.limit Items shown per page
|
396
396
|
* @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.
|
397
|
-
* @param {String} opts.sort
|
397
|
+
* @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`.
|
398
398
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAllFiles} and HTTP response
|
399
399
|
*/
|
400
400
|
|
@@ -439,7 +439,7 @@ var FilesApi = /*#__PURE__*/function () {
|
|
439
439
|
* @param {Number} opts.start Pagination start (default to 0)
|
440
440
|
* @param {Number} opts.limit Items shown per page
|
441
441
|
* @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.
|
442
|
-
* @param {String} opts.sort
|
442
|
+
* @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`.
|
443
443
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAllFiles}
|
444
444
|
*/
|
445
445
|
|
@@ -452,10 +452,10 @@ var FilesApi = /*#__PURE__*/function () {
|
|
452
452
|
}
|
453
453
|
/**
|
454
454
|
* Link a remote file to an item
|
455
|
-
* Links an existing remote file (`googledrive`) to the item you supply. For more information
|
455
|
+
* Links an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
456
456
|
* @param {module:model/String} itemType The item type
|
457
|
-
* @param {Number} itemId ID of the item to associate the file with
|
458
|
-
* @param {String} remoteId The remote item
|
457
|
+
* @param {Number} itemId The ID of the item to associate the file with
|
458
|
+
* @param {String} remoteId The remote item ID
|
459
459
|
* @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
|
460
460
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LinkRemoteFileToItem} and HTTP response
|
461
461
|
*/
|
@@ -516,10 +516,10 @@ var FilesApi = /*#__PURE__*/function () {
|
|
516
516
|
}
|
517
517
|
/**
|
518
518
|
* Link a remote file to an item
|
519
|
-
* Links an existing remote file (`googledrive`) to the item you supply. For more information
|
519
|
+
* Links an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">adding a remote file</a>.
|
520
520
|
* @param {module:model/String} itemType The item type
|
521
|
-
* @param {Number} itemId ID of the item to associate the file with
|
522
|
-
* @param {String} remoteId The remote item
|
521
|
+
* @param {Number} itemId The ID of the item to associate the file with
|
522
|
+
* @param {String} remoteId The remote item ID
|
523
523
|
* @param {module:model/String} remoteLocation The location type to send the file to. Only `googledrive` is supported at the moment.
|
524
524
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LinkRemoteFileToItem}
|
525
525
|
*/
|
@@ -534,10 +534,10 @@ var FilesApi = /*#__PURE__*/function () {
|
|
534
534
|
/**
|
535
535
|
* Update file details
|
536
536
|
* Updates the properties of a file.
|
537
|
-
* @param {Number} id ID of the file
|
537
|
+
* @param {Number} id The ID of the file
|
538
538
|
* @param {Object} opts Optional parameters
|
539
|
-
* @param {String} opts.name
|
540
|
-
* @param {String} opts.description
|
539
|
+
* @param {String} opts.name The visible name of the file
|
540
|
+
* @param {String} opts.description The description of the file
|
541
541
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateFile} and HTTP response
|
542
542
|
*/
|
543
543
|
|
@@ -583,10 +583,10 @@ var FilesApi = /*#__PURE__*/function () {
|
|
583
583
|
/**
|
584
584
|
* Update file details
|
585
585
|
* Updates the properties of a file.
|
586
|
-
* @param {Number} id ID of the file
|
586
|
+
* @param {Number} id The ID of the file
|
587
587
|
* @param {Object} opts Optional parameters
|
588
|
-
* @param {String} opts.name
|
589
|
-
* @param {String} opts.description
|
588
|
+
* @param {String} opts.name The visible name of the file
|
589
|
+
* @param {String} opts.description The description of the file
|
590
590
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateFile}
|
591
591
|
*/
|
592
592
|
|
package/dist/api/FiltersApi.js
CHANGED
@@ -54,7 +54,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
54
54
|
}
|
55
55
|
/**
|
56
56
|
* Add a new filter
|
57
|
-
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information
|
57
|
+
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
58
58
|
* @param {Object} opts Optional parameters
|
59
59
|
* @param {module:model/AddFilterRequest} opts.addFilterRequest
|
60
60
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FiltersPostResponse} and HTTP response
|
@@ -66,6 +66,19 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
66
66
|
value: function addFilterWithHttpInfo(opts) {
|
67
67
|
opts = opts || {};
|
68
68
|
var postBody = opts['addFilterRequest'];
|
69
|
+
|
70
|
+
if (opts['name'] === undefined || opts['name'] === null) {
|
71
|
+
throw new Error("Missing the required parameter 'name' when calling addFilter");
|
72
|
+
}
|
73
|
+
|
74
|
+
if (opts['conditions'] === undefined || opts['conditions'] === null) {
|
75
|
+
throw new Error("Missing the required parameter 'conditions' when calling addFilter");
|
76
|
+
}
|
77
|
+
|
78
|
+
if (opts['type'] === undefined || opts['type'] === null) {
|
79
|
+
throw new Error("Missing the required parameter 'type' when calling addFilter");
|
80
|
+
}
|
81
|
+
|
69
82
|
var pathParams = {};
|
70
83
|
var queryParams = {};
|
71
84
|
var headerParams = {};
|
@@ -92,7 +105,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
92
105
|
}
|
93
106
|
/**
|
94
107
|
* Add a new filter
|
95
|
-
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information
|
108
|
+
* Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
96
109
|
* @param {Object} opts Optional parameters
|
97
110
|
* @param {module:model/AddFilterRequest} opts.addFilterRequest
|
98
111
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FiltersPostResponse}
|
@@ -165,7 +178,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
165
178
|
/**
|
166
179
|
* Delete multiple filters in bulk
|
167
180
|
* Marks multiple filters as deleted.
|
168
|
-
* @param {String} ids
|
181
|
+
* @param {String} ids The comma-separated filter IDs to delete
|
169
182
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FiltersBulkDeleteResponse} and HTTP response
|
170
183
|
*/
|
171
184
|
|
@@ -208,7 +221,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
208
221
|
/**
|
209
222
|
* Delete multiple filters in bulk
|
210
223
|
* Marks multiple filters as deleted.
|
211
|
-
* @param {String} ids
|
224
|
+
* @param {String} ids The comma-separated filter IDs to delete
|
212
225
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FiltersBulkDeleteResponse}
|
213
226
|
*/
|
214
227
|
|
@@ -278,7 +291,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
278
291
|
}
|
279
292
|
/**
|
280
293
|
* Get all filter helpers
|
281
|
-
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information
|
294
|
+
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
282
295
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
|
283
296
|
*/
|
284
297
|
|
@@ -313,7 +326,7 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
313
326
|
}
|
314
327
|
/**
|
315
328
|
* Get all filter helpers
|
316
|
-
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information
|
329
|
+
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
317
330
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
|
318
331
|
*/
|
319
332
|
|
@@ -397,6 +410,10 @@ var FiltersApi = /*#__PURE__*/function () {
|
|
397
410
|
throw new Error("Missing the required parameter 'id' when calling updateFilter");
|
398
411
|
}
|
399
412
|
|
413
|
+
if (opts['conditions'] === undefined || opts['conditions'] === null) {
|
414
|
+
throw new Error("Missing the required parameter 'conditions' when calling updateFilter");
|
415
|
+
}
|
416
|
+
|
400
417
|
var pathParams = {
|
401
418
|
'id': id
|
402
419
|
};
|
@@ -42,8 +42,8 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
|
|
42
42
|
}
|
43
43
|
/**
|
44
44
|
* Dismiss a global message
|
45
|
-
* Removes global message from being shown
|
46
|
-
* @param {Number} id ID of global message to be dismissed
|
45
|
+
* Removes a global message from being shown if the message is dismissible.
|
46
|
+
* @param {Number} id The ID of the global message to be dismissed
|
47
47
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GlobalMessageDelete} and HTTP response
|
48
48
|
*/
|
49
49
|
|
@@ -86,8 +86,8 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
|
|
86
86
|
}
|
87
87
|
/**
|
88
88
|
* Dismiss a global message
|
89
|
-
* Removes global message from being shown
|
90
|
-
* @param {Number} id ID of global message to be dismissed
|
89
|
+
* Removes a global message from being shown if the message is dismissible.
|
90
|
+
* @param {Number} id The ID of the global message to be dismissed
|
91
91
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GlobalMessageDelete}
|
92
92
|
*/
|
93
93
|
|
@@ -100,9 +100,9 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
|
|
100
100
|
}
|
101
101
|
/**
|
102
102
|
* Get global messages
|
103
|
-
* Returns data about global messages to display for the authorized user.
|
103
|
+
* Returns data about the global messages to display for the authorized user.
|
104
104
|
* @param {Object} opts Optional parameters
|
105
|
-
* @param {Number} opts.limit
|
105
|
+
* @param {Number} opts.limit The number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
|
106
106
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GlobalMessageGet} and HTTP response
|
107
107
|
*/
|
108
108
|
|
@@ -139,9 +139,9 @@ var GlobalMessagesApi = /*#__PURE__*/function () {
|
|
139
139
|
}
|
140
140
|
/**
|
141
141
|
* Get global messages
|
142
|
-
* Returns data about global messages to display for the authorized user.
|
142
|
+
* Returns data about the global messages to display for the authorized user.
|
143
143
|
* @param {Object} opts Optional parameters
|
144
|
-
* @param {Number} opts.limit
|
144
|
+
* @param {Number} opts.limit The number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
|
145
145
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GlobalMessageGet}
|
146
146
|
*/
|
147
147
|
|
package/dist/api/GoalsApi.js
CHANGED
@@ -101,8 +101,8 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
101
101
|
}
|
102
102
|
/**
|
103
103
|
* Delete existing goal
|
104
|
-
* Marks goal as deleted.
|
105
|
-
* @param {String} id ID of the goal to be deleted
|
104
|
+
* Marks a goal as deleted.
|
105
|
+
* @param {String} id The ID of the goal to be deleted
|
106
106
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteGoalResponse200} and HTTP response
|
107
107
|
*/
|
108
108
|
|
@@ -144,8 +144,8 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
144
144
|
}
|
145
145
|
/**
|
146
146
|
* Delete existing goal
|
147
|
-
* Marks goal as deleted.
|
148
|
-
* @param {String} id ID of the goal to be deleted
|
147
|
+
* Marks a goal as deleted.
|
148
|
+
* @param {String} id The ID of the goal to be deleted
|
149
149
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteGoalResponse200}
|
150
150
|
*/
|
151
151
|
|
@@ -158,10 +158,10 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
158
158
|
}
|
159
159
|
/**
|
160
160
|
* Get result of a goal
|
161
|
-
* Gets progress of a goal for specified period.
|
162
|
-
* @param {String} id ID of the goal that the results are looked for
|
163
|
-
* @param {Date} periodStart
|
164
|
-
* @param {Date} periodEnd
|
161
|
+
* Gets the progress of a goal for the specified period.
|
162
|
+
* @param {String} id The ID of the goal that the results are looked for
|
163
|
+
* @param {Date} periodStart The start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
|
164
|
+
* @param {Date} periodEnd The end date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
|
165
165
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalResultResponse200} and HTTP response
|
166
166
|
*/
|
167
167
|
|
@@ -216,10 +216,10 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
216
216
|
}
|
217
217
|
/**
|
218
218
|
* Get result of a goal
|
219
|
-
* Gets progress of a goal for specified period.
|
220
|
-
* @param {String} id ID of the goal that the results are looked for
|
221
|
-
* @param {Date} periodStart
|
222
|
-
* @param {Date} periodEnd
|
219
|
+
* Gets the progress of a goal for the specified period.
|
220
|
+
* @param {String} id The ID of the goal that the results are looked for
|
221
|
+
* @param {Date} periodStart The start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or after the goal duration start date.
|
222
|
+
* @param {Date} periodEnd The end date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD. This date must be the same or before the goal duration end date.
|
223
223
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalResultResponse200}
|
224
224
|
*/
|
225
225
|
|
@@ -234,19 +234,19 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
234
234
|
* Find goals
|
235
235
|
* Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
|
236
236
|
* @param {Object} opts Optional parameters
|
237
|
-
* @param {module:model/String} opts.typeName
|
238
|
-
* @param {String} opts.title
|
239
|
-
* @param {module:model/Boolean} opts.isActive Whether goal is active or not
|
240
|
-
* @param {Number} opts.assigneeId ID of the user who's goal to fetch. When omitted, only your goals will be returned.
|
241
|
-
* @param {module:model/String} opts.assigneeType
|
242
|
-
* @param {Number} opts.expectedOutcomeTarget
|
243
|
-
* @param {module:model/String} opts.expectedOutcomeTrackingMetric
|
244
|
-
* @param {Number} opts.expectedOutcomeCurrencyId
|
245
|
-
* @param {Number} opts.typeParamsPipelineId ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
|
246
|
-
* @param {Number} opts.typeParamsStageId ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
|
247
|
-
* @param {Number} opts.typeParamsActivityTypeId ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
|
248
|
-
* @param {Date} opts.periodStart
|
249
|
-
* @param {Date} opts.periodEnd
|
237
|
+
* @param {module:model/String} opts.typeName The type of the goal. If provided, everyone's goals will be returned.
|
238
|
+
* @param {String} opts.title The title of the goal
|
239
|
+
* @param {module:model/Boolean} opts.isActive Whether the goal is active or not (default to true)
|
240
|
+
* @param {Number} opts.assigneeId The ID of the user who's goal to fetch. When omitted, only your goals will be returned.
|
241
|
+
* @param {module:model/String} opts.assigneeType The type of the goal's assignee. If provided, everyone's goals will be returned.
|
242
|
+
* @param {Number} opts.expectedOutcomeTarget The numeric value of the outcome. If provided, everyone's goals will be returned.
|
243
|
+
* @param {module:model/String} opts.expectedOutcomeTrackingMetric The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
|
244
|
+
* @param {Number} opts.expectedOutcomeCurrencyId The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
|
245
|
+
* @param {Number} opts.typeParamsPipelineId The ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
|
246
|
+
* @param {Number} opts.typeParamsStageId The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
|
247
|
+
* @param {Number} opts.typeParamsActivityTypeId The ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
|
248
|
+
* @param {Date} opts.periodStart The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
|
249
|
+
* @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
|
250
250
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetGoalsResponse200} and HTTP response
|
251
251
|
*/
|
252
252
|
|
@@ -297,19 +297,19 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
297
297
|
* Find goals
|
298
298
|
* Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
|
299
299
|
* @param {Object} opts Optional parameters
|
300
|
-
* @param {module:model/String} opts.typeName
|
301
|
-
* @param {String} opts.title
|
302
|
-
* @param {module:model/Boolean} opts.isActive Whether goal is active or not
|
303
|
-
* @param {Number} opts.assigneeId ID of the user who's goal to fetch. When omitted, only your goals will be returned.
|
304
|
-
* @param {module:model/String} opts.assigneeType
|
305
|
-
* @param {Number} opts.expectedOutcomeTarget
|
306
|
-
* @param {module:model/String} opts.expectedOutcomeTrackingMetric
|
307
|
-
* @param {Number} opts.expectedOutcomeCurrencyId
|
308
|
-
* @param {Number} opts.typeParamsPipelineId ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
|
309
|
-
* @param {Number} opts.typeParamsStageId ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
|
310
|
-
* @param {Number} opts.typeParamsActivityTypeId ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
|
311
|
-
* @param {Date} opts.periodStart
|
312
|
-
* @param {Date} opts.periodEnd
|
300
|
+
* @param {module:model/String} opts.typeName The type of the goal. If provided, everyone's goals will be returned.
|
301
|
+
* @param {String} opts.title The title of the goal
|
302
|
+
* @param {module:model/Boolean} opts.isActive Whether the goal is active or not (default to true)
|
303
|
+
* @param {Number} opts.assigneeId The ID of the user who's goal to fetch. When omitted, only your goals will be returned.
|
304
|
+
* @param {module:model/String} opts.assigneeType The type of the goal's assignee. If provided, everyone's goals will be returned.
|
305
|
+
* @param {Number} opts.expectedOutcomeTarget The numeric value of the outcome. If provided, everyone's goals will be returned.
|
306
|
+
* @param {module:model/String} opts.expectedOutcomeTrackingMetric The tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
|
307
|
+
* @param {Number} opts.expectedOutcomeCurrencyId The numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
|
308
|
+
* @param {Number} opts.typeParamsPipelineId The ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
|
309
|
+
* @param {Number} opts.typeParamsStageId The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
|
310
|
+
* @param {Number} opts.typeParamsActivityTypeId The ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
|
311
|
+
* @param {Date} opts.periodStart The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
|
312
|
+
* @param {Date} opts.periodEnd The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
|
313
313
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetGoalsResponse200}
|
314
314
|
*/
|
315
315
|
|
@@ -322,15 +322,15 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
322
322
|
}
|
323
323
|
/**
|
324
324
|
* Update existing goal
|
325
|
-
* Updates existing goal.
|
326
|
-
* @param {String} id ID of the goal to be updated
|
325
|
+
* Updates an existing goal.
|
326
|
+
* @param {String} id The ID of the goal to be updated
|
327
327
|
* @param {Object} opts Optional parameters
|
328
|
-
* @param {String} opts.title
|
329
|
-
* @param {Object} opts.assignee Who
|
330
|
-
* @param {Object} opts.type
|
331
|
-
* @param {Object} opts.expectedOutcome
|
332
|
-
* @param {Object} opts.duration
|
333
|
-
* @param {module:model/String} opts.interval
|
328
|
+
* @param {String} opts.title The title of the goal
|
329
|
+
* @param {Object.<String, Object>} opts.assignee Who this goal is assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
|
330
|
+
* @param {Object.<String, Object>} opts.type The type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
|
331
|
+
* @param {Object.<String, Object>} opts.expectedOutcome The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
|
332
|
+
* @param {Object.<String, Object>} opts.duration The date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
|
333
|
+
* @param {module:model/String} opts.interval The interval of the goal
|
334
334
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddOrUpdateGoalResponse200} and HTTP response
|
335
335
|
*/
|
336
336
|
|
@@ -379,15 +379,15 @@ var GoalsApi = /*#__PURE__*/function () {
|
|
379
379
|
}
|
380
380
|
/**
|
381
381
|
* Update existing goal
|
382
|
-
* Updates existing goal.
|
383
|
-
* @param {String} id ID of the goal to be updated
|
382
|
+
* Updates an existing goal.
|
383
|
+
* @param {String} id The ID of the goal to be updated
|
384
384
|
* @param {Object} opts Optional parameters
|
385
|
-
* @param {String} opts.title
|
386
|
-
* @param {Object} opts.assignee Who
|
387
|
-
* @param {Object} opts.type
|
388
|
-
* @param {Object} opts.expectedOutcome
|
389
|
-
* @param {Object} opts.duration
|
390
|
-
* @param {module:model/String} opts.interval
|
385
|
+
* @param {String} opts.title The title of the goal
|
386
|
+
* @param {Object.<String, Object>} opts.assignee Who this goal is assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
|
387
|
+
* @param {Object.<String, Object>} opts.type The type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`, `deals_progressed`, `activities_completed`, `activities_added`, `deals_started` or `revenue_forecast`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
|
388
|
+
* @param {Object.<String, Object>} opts.expectedOutcome The expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
|
389
|
+
* @param {Object.<String, Object>} opts.duration The date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD. \\\"end\\\" can be set to `null` for an infinite, open-ended goal.
|
390
|
+
* @param {module:model/String} opts.interval The interval of the goal
|
391
391
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddOrUpdateGoalResponse200}
|
392
392
|
*/
|
393
393
|
|
@@ -46,8 +46,8 @@ var ItemSearchApi = /*#__PURE__*/function () {
|
|
46
46
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
47
47
|
* @param {Object} opts Optional parameters
|
48
48
|
* @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
49
|
-
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for
|
50
|
-
* @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related
|
49
|
+
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
|
50
|
+
* @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization.
|
51
51
|
* @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.
|
52
52
|
* @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
53
53
|
* @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)
|
@@ -105,8 +105,8 @@ var ItemSearchApi = /*#__PURE__*/function () {
|
|
105
105
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
106
106
|
* @param {Object} opts Optional parameters
|
107
107
|
* @param {module:model/String} opts.itemTypes A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
108
|
-
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for
|
109
|
-
* @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related
|
108
|
+
* @param {module:model/String} opts.fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> </table> <br> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
|
109
|
+
* @param {module:model/Boolean} opts.searchForRelatedItems When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization.
|
110
110
|
* @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.
|
111
111
|
* @param {module:model/String} opts.includeFields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
112
112
|
* @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)
|
@@ -123,7 +123,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
|
|
123
123
|
}
|
124
124
|
/**
|
125
125
|
* Perform a search using a specific field from an item type
|
126
|
-
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (
|
126
|
+
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
|
127
127
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
128
128
|
* @param {module:model/String} fieldType The type of the field to perform the search from
|
129
129
|
* @param {String} fieldKey The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).
|
@@ -189,7 +189,7 @@ var ItemSearchApi = /*#__PURE__*/function () {
|
|
189
189
|
}
|
190
190
|
/**
|
191
191
|
* Perform a search using a specific field from an item type
|
192
|
-
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (
|
192
|
+
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
|
193
193
|
* @param {String} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`).
|
194
194
|
* @param {module:model/String} fieldType The type of the field to perform the search from
|
195
195
|
* @param {String} fieldKey The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).
|