pipedrive 13.0.10 → 13.1.1
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 +19 -16
- package/dist/ApiClient.js +46 -9
- package/dist/api/ActivitiesApi.js +44 -44
- package/dist/api/ActivityTypesApi.js +4 -4
- package/dist/api/CallLogsApi.js +23 -6
- package/dist/api/CurrenciesApi.js +2 -2
- package/dist/api/DealFieldsApi.js +10 -10
- package/dist/api/DealsApi.js +114 -102
- package/dist/api/FilesApi.js +34 -34
- package/dist/api/FiltersApi.js +19 -2
- package/dist/api/GlobalMessagesApi.js +8 -8
- package/dist/api/GoalsApi.js +54 -54
- package/dist/api/ItemSearchApi.js +6 -6
- package/dist/api/LeadLabelsApi.js +21 -12
- package/dist/api/LeadSourcesApi.js +2 -2
- package/dist/api/LeadsApi.js +23 -18
- package/dist/api/MailboxApi.js +26 -26
- package/dist/api/NoteFieldsApi.js +2 -2
- package/dist/api/NotesApi.js +50 -42
- package/dist/api/OrganizationFieldsApi.js +10 -10
- package/dist/api/OrganizationRelationshipsApi.js +25 -12
- package/dist/api/OrganizationsApi.js +60 -52
- package/dist/api/PermissionSetsApi.js +12 -12
- package/dist/api/PersonFieldsApi.js +10 -10
- package/dist/api/PersonsApi.js +90 -82
- package/dist/api/PipelinesApi.js +50 -50
- package/dist/api/ProductFieldsApi.js +23 -10
- package/dist/api/ProductsApi.js +48 -44
- package/dist/api/RecentsApi.js +6 -6
- package/dist/api/RolesApi.js +38 -38
- package/dist/api/StagesApi.js +14 -14
- package/dist/api/SubscriptionsApi.js +76 -34
- package/dist/api/TeamsApi.js +49 -32
- package/dist/api/UserConnectionsApi.js +2 -2
- package/dist/api/UserSettingsApi.js +2 -2
- package/dist/api/UsersApi.js +44 -44
- package/dist/api/WebhooksApi.js +27 -14
- package/dist/index.js +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/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/RecentsApi.js
CHANGED
@@ -40,10 +40,10 @@ var RecentsApi = /*#__PURE__*/function () {
|
|
40
40
|
}
|
41
41
|
/**
|
42
42
|
* Get recents
|
43
|
-
* Returns data about all recent changes
|
44
|
-
* @param {String} sinceTimestamp
|
43
|
+
* Returns data about all recent changes occurred after the given timestamp.
|
44
|
+
* @param {String} sinceTimestamp The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
|
45
45
|
* @param {Object} opts Optional parameters
|
46
|
-
* @param {module:model/String} opts.items Multiple selection of item types to include in query (optional)
|
46
|
+
* @param {module:model/String} opts.items Multiple selection of item types to include in the query (optional)
|
47
47
|
* @param {Number} opts.start Pagination start (default to 0)
|
48
48
|
* @param {Number} opts.limit Items shown per page
|
49
49
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRecents} and HTTP response
|
@@ -91,10 +91,10 @@ var RecentsApi = /*#__PURE__*/function () {
|
|
91
91
|
}
|
92
92
|
/**
|
93
93
|
* Get recents
|
94
|
-
* Returns data about all recent changes
|
95
|
-
* @param {String} sinceTimestamp
|
94
|
+
* Returns data about all recent changes occurred after the given timestamp.
|
95
|
+
* @param {String} sinceTimestamp The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
|
96
96
|
* @param {Object} opts Optional parameters
|
97
|
-
* @param {module:model/String} opts.items Multiple selection of item types to include in query (optional)
|
97
|
+
* @param {module:model/String} opts.items Multiple selection of item types to include in the query (optional)
|
98
98
|
* @param {Number} opts.start Pagination start (default to 0)
|
99
99
|
* @param {Number} opts.limit Items shown per page
|
100
100
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRecents}
|
package/dist/api/RolesApi.js
CHANGED
@@ -60,8 +60,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
60
60
|
}
|
61
61
|
/**
|
62
62
|
* Add or update role setting
|
63
|
-
*
|
64
|
-
* @param {Number} id ID of the role
|
63
|
+
* Adds or updates the visibility setting for a role.
|
64
|
+
* @param {Number} id The ID of the role
|
65
65
|
* @param {module:model/String} settingKey
|
66
66
|
* @param {module:model/Number} value Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.
|
67
67
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoleSettings} and HTTP response
|
@@ -119,8 +119,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
119
119
|
}
|
120
120
|
/**
|
121
121
|
* Add or update role setting
|
122
|
-
*
|
123
|
-
* @param {Number} id ID of the role
|
122
|
+
* Adds or updates the visibility setting for a role.
|
123
|
+
* @param {Number} id The ID of the role
|
124
124
|
* @param {module:model/String} settingKey
|
125
125
|
* @param {module:model/Number} value Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class='role-setting'> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class='role-setting'> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href='https://support.pipedrive.com/en/article/visibility-groups'>here</a>.
|
126
126
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoleSettings}
|
@@ -136,8 +136,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
136
136
|
/**
|
137
137
|
* Add a role
|
138
138
|
* @param {Object} opts Optional parameters
|
139
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
140
|
-
* @param {String} opts.name The name of the
|
139
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
140
|
+
* @param {String} opts.name The name of the role
|
141
141
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoles} and HTTP response
|
142
142
|
*/
|
143
143
|
|
@@ -176,8 +176,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
176
176
|
/**
|
177
177
|
* Add a role
|
178
178
|
* @param {Object} opts Optional parameters
|
179
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
180
|
-
* @param {String} opts.name The name of the
|
179
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
180
|
+
* @param {String} opts.name The name of the role
|
181
181
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoles}
|
182
182
|
*/
|
183
183
|
|
@@ -190,9 +190,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
190
190
|
}
|
191
191
|
/**
|
192
192
|
* Add role assignment
|
193
|
-
*
|
194
|
-
* @param {Number} id ID of the role
|
195
|
-
* @param {Number} userId ID of the user
|
193
|
+
* Adds assignment for a role.
|
194
|
+
* @param {Number} id The ID of the role
|
195
|
+
* @param {Number} userId The ID of the user
|
196
196
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PostRoleAssignment} and HTTP response
|
197
197
|
*/
|
198
198
|
|
@@ -241,9 +241,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
241
241
|
}
|
242
242
|
/**
|
243
243
|
* Add role assignment
|
244
|
-
*
|
245
|
-
* @param {Number} id ID of the role
|
246
|
-
* @param {Number} userId ID of the user
|
244
|
+
* Adds assignment for a role.
|
245
|
+
* @param {Number} id The ID of the role
|
246
|
+
* @param {Number} userId The ID of the user
|
247
247
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PostRoleAssignment}
|
248
248
|
*/
|
249
249
|
|
@@ -256,7 +256,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
256
256
|
}
|
257
257
|
/**
|
258
258
|
* Delete a role
|
259
|
-
* @param {Number} id ID of the role
|
259
|
+
* @param {Number} id The ID of the role
|
260
260
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteRole} and HTTP response
|
261
261
|
*/
|
262
262
|
|
@@ -298,7 +298,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
298
298
|
}
|
299
299
|
/**
|
300
300
|
* Delete a role
|
301
|
-
* @param {Number} id ID of the role
|
301
|
+
* @param {Number} id The ID of the role
|
302
302
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteRole}
|
303
303
|
*/
|
304
304
|
|
@@ -311,9 +311,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
311
311
|
}
|
312
312
|
/**
|
313
313
|
* Delete a role assignment
|
314
|
-
*
|
315
|
-
* @param {Number} id ID of the role
|
316
|
-
* @param {Number} userId ID of the user
|
314
|
+
* Deletes assignment from a role.
|
315
|
+
* @param {Number} id The ID of the role
|
316
|
+
* @param {Number} userId The ID of the user
|
317
317
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteRoleAssignment} and HTTP response
|
318
318
|
*/
|
319
319
|
|
@@ -362,9 +362,9 @@ var RolesApi = /*#__PURE__*/function () {
|
|
362
362
|
}
|
363
363
|
/**
|
364
364
|
* Delete a role assignment
|
365
|
-
*
|
366
|
-
* @param {Number} id ID of the role
|
367
|
-
* @param {Number} userId ID of the user
|
365
|
+
* Deletes assignment from a role.
|
366
|
+
* @param {Number} id The ID of the role
|
367
|
+
* @param {Number} userId The ID of the user
|
368
368
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteRoleAssignment}
|
369
369
|
*/
|
370
370
|
|
@@ -377,7 +377,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
377
377
|
}
|
378
378
|
/**
|
379
379
|
* Get one role
|
380
|
-
* @param {Number} id ID of the role
|
380
|
+
* @param {Number} id The ID of the role
|
381
381
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRole} and HTTP response
|
382
382
|
*/
|
383
383
|
|
@@ -419,7 +419,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
419
419
|
}
|
420
420
|
/**
|
421
421
|
* Get one role
|
422
|
-
* @param {Number} id ID of the role
|
422
|
+
* @param {Number} id The ID of the role
|
423
423
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRole}
|
424
424
|
*/
|
425
425
|
|
@@ -432,8 +432,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
432
432
|
}
|
433
433
|
/**
|
434
434
|
* List role assignments
|
435
|
-
*
|
436
|
-
* @param {Number} id ID of the role
|
435
|
+
* Lists assignments for a role.
|
436
|
+
* @param {Number} id The ID of the role
|
437
437
|
* @param {Object} opts Optional parameters
|
438
438
|
* @param {Number} opts.start Pagination start (default to 0)
|
439
439
|
* @param {Number} opts.limit Items shown per page
|
@@ -481,8 +481,8 @@ var RolesApi = /*#__PURE__*/function () {
|
|
481
481
|
}
|
482
482
|
/**
|
483
483
|
* List role assignments
|
484
|
-
*
|
485
|
-
* @param {Number} id ID of the role
|
484
|
+
* Lists assignments for a role.
|
485
|
+
* @param {Number} id The ID of the role
|
486
486
|
* @param {Object} opts Optional parameters
|
487
487
|
* @param {Number} opts.start Pagination start (default to 0)
|
488
488
|
* @param {Number} opts.limit Items shown per page
|
@@ -498,7 +498,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
498
498
|
}
|
499
499
|
/**
|
500
500
|
* List role settings
|
501
|
-
* @param {Number} id ID of the role
|
501
|
+
* @param {Number} id The ID of the role
|
502
502
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetRoleSettings} and HTTP response
|
503
503
|
*/
|
504
504
|
|
@@ -540,7 +540,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
540
540
|
}
|
541
541
|
/**
|
542
542
|
* List role settings
|
543
|
-
* @param {Number} id ID of the role
|
543
|
+
* @param {Number} id The ID of the role
|
544
544
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetRoleSettings}
|
545
545
|
*/
|
546
546
|
|
@@ -553,7 +553,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
553
553
|
}
|
554
554
|
/**
|
555
555
|
* List role sub-roles
|
556
|
-
* @param {Number} id ID of the role
|
556
|
+
* @param {Number} id The ID of the role
|
557
557
|
* @param {Object} opts Optional parameters
|
558
558
|
* @param {Number} opts.start Pagination start (default to 0)
|
559
559
|
* @param {Number} opts.limit Items shown per page
|
@@ -601,7 +601,7 @@ var RolesApi = /*#__PURE__*/function () {
|
|
601
601
|
}
|
602
602
|
/**
|
603
603
|
* List role sub-roles
|
604
|
-
* @param {Number} id ID of the role
|
604
|
+
* @param {Number} id The ID of the role
|
605
605
|
* @param {Object} opts Optional parameters
|
606
606
|
* @param {Number} opts.start Pagination start (default to 0)
|
607
607
|
* @param {Number} opts.limit Items shown per page
|
@@ -672,10 +672,10 @@ var RolesApi = /*#__PURE__*/function () {
|
|
672
672
|
}
|
673
673
|
/**
|
674
674
|
* Update role details
|
675
|
-
* @param {Number} id ID of the role
|
675
|
+
* @param {Number} id The ID of the role
|
676
676
|
* @param {Object} opts Optional parameters
|
677
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
678
|
-
* @param {String} opts.name The name of the
|
677
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
678
|
+
* @param {String} opts.name The name of the role
|
679
679
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PutRole} and HTTP response
|
680
680
|
*/
|
681
681
|
|
@@ -720,10 +720,10 @@ var RolesApi = /*#__PURE__*/function () {
|
|
720
720
|
}
|
721
721
|
/**
|
722
722
|
* Update role details
|
723
|
-
* @param {Number} id ID of the role
|
723
|
+
* @param {Number} id The ID of the role
|
724
724
|
* @param {Object} opts Optional parameters
|
725
|
-
* @param {Number} opts.parentRoleId The ID of the parent
|
726
|
-
* @param {String} opts.name The name of the
|
725
|
+
* @param {Number} opts.parentRoleId The ID of the parent role
|
726
|
+
* @param {String} opts.name The name of the role
|
727
727
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PutRole}
|
728
728
|
*/
|
729
729
|
|
package/dist/api/StagesApi.js
CHANGED
@@ -110,7 +110,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
110
110
|
/**
|
111
111
|
* Delete a stage
|
112
112
|
* Marks a stage as deleted.
|
113
|
-
* @param {Number} id ID of the stage
|
113
|
+
* @param {Number} id The ID of the stage
|
114
114
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteStageResponse200} and HTTP response
|
115
115
|
*/
|
116
116
|
|
@@ -153,7 +153,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
153
153
|
/**
|
154
154
|
* Delete a stage
|
155
155
|
* Marks a stage as deleted.
|
156
|
-
* @param {Number} id ID of the stage
|
156
|
+
* @param {Number} id The ID of the stage
|
157
157
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteStageResponse200}
|
158
158
|
*/
|
159
159
|
|
@@ -167,7 +167,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
167
167
|
/**
|
168
168
|
* Delete multiple stages in bulk
|
169
169
|
* Marks multiple stages as deleted.
|
170
|
-
* @param {String} ids
|
170
|
+
* @param {String} ids The comma-separated stage IDs to delete
|
171
171
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteStagesResponse200} and HTTP response
|
172
172
|
*/
|
173
173
|
|
@@ -210,7 +210,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
210
210
|
/**
|
211
211
|
* Delete multiple stages in bulk
|
212
212
|
* Marks multiple stages as deleted.
|
213
|
-
* @param {String} ids
|
213
|
+
* @param {String} ids The comma-separated stage IDs to delete
|
214
214
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteStagesResponse200}
|
215
215
|
*/
|
216
216
|
|
@@ -224,7 +224,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
224
224
|
/**
|
225
225
|
* Get one stage
|
226
226
|
* Returns data about a specific stage.
|
227
|
-
* @param {Number} id ID of the stage
|
227
|
+
* @param {Number} id The ID of the stage
|
228
228
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetOneStage} and HTTP response
|
229
229
|
*/
|
230
230
|
|
@@ -267,7 +267,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
267
267
|
/**
|
268
268
|
* Get one stage
|
269
269
|
* Returns data about a specific stage.
|
270
|
-
* @param {Number} id ID of the stage
|
270
|
+
* @param {Number} id The ID of the stage
|
271
271
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetOneStage}
|
272
272
|
*/
|
273
273
|
|
@@ -281,11 +281,11 @@ var StagesApi = /*#__PURE__*/function () {
|
|
281
281
|
/**
|
282
282
|
* Get deals in a stage
|
283
283
|
* Lists deals in a specific stage.
|
284
|
-
* @param {Number} id ID of the stage
|
284
|
+
* @param {Number} id The ID of the stage
|
285
285
|
* @param {Object} opts Optional parameters
|
286
|
-
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
286
|
+
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
287
287
|
* @param {Number} opts.userId If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
|
288
|
-
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
288
|
+
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
289
289
|
* @param {Number} opts.start Pagination start (default to 0)
|
290
290
|
* @param {Number} opts.limit Items shown per page
|
291
291
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetStageDeals} and HTTP response
|
@@ -336,11 +336,11 @@ var StagesApi = /*#__PURE__*/function () {
|
|
336
336
|
/**
|
337
337
|
* Get deals in a stage
|
338
338
|
* Lists deals in a specific stage.
|
339
|
-
* @param {Number} id ID of the stage
|
339
|
+
* @param {Number} id The ID of the stage
|
340
340
|
* @param {Object} opts Optional parameters
|
341
|
-
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
341
|
+
* @param {Number} opts.filterId If supplied, only deals matching the given filter will be returned
|
342
342
|
* @param {Number} opts.userId If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
|
343
|
-
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
343
|
+
* @param {module:model/NumberBoolean} opts.everyone If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
|
344
344
|
* @param {Number} opts.start Pagination start (default to 0)
|
345
345
|
* @param {Number} opts.limit Items shown per page
|
346
346
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetStageDeals}
|
@@ -410,7 +410,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
410
410
|
/**
|
411
411
|
* Update stage details
|
412
412
|
* Updates the properties of a stage.
|
413
|
-
* @param {Number} id ID of the stage
|
413
|
+
* @param {Number} id The ID of the stage
|
414
414
|
* @param {Object} opts Optional parameters
|
415
415
|
* @param {module:model/UpdateStageRequest} opts.updateStageRequest
|
416
416
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetAddUpdateStage} and HTTP response
|
@@ -455,7 +455,7 @@ var StagesApi = /*#__PURE__*/function () {
|
|
455
455
|
/**
|
456
456
|
* Update stage details
|
457
457
|
* Updates the properties of a stage.
|
458
|
-
* @param {Number} id ID of the stage
|
458
|
+
* @param {Number} id The ID of the stage
|
459
459
|
* @param {Object} opts Optional parameters
|
460
460
|
* @param {module:model/UpdateStageRequest} opts.updateStageRequest
|
461
461
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetAddUpdateStage}
|
@@ -52,7 +52,7 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
52
52
|
}
|
53
53
|
/**
|
54
54
|
* Add a recurring subscription
|
55
|
-
* Adds a new recurring
|
55
|
+
* Adds a new recurring subscription.
|
56
56
|
* @param {Object} opts Optional parameters
|
57
57
|
* @param {module:model/SubscriptionRecurringCreateRequest} opts.subscriptionRecurringCreateRequest
|
58
58
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
@@ -64,6 +64,27 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
64
64
|
value: function addRecurringSubscriptionWithHttpInfo(opts) {
|
65
65
|
opts = opts || {};
|
66
66
|
var postBody = opts['subscriptionRecurringCreateRequest'];
|
67
|
+
|
68
|
+
if (opts['deal_id'] === undefined || opts['deal_id'] === null) {
|
69
|
+
throw new Error("Missing the required parameter 'deal_id' when calling addRecurringSubscription");
|
70
|
+
}
|
71
|
+
|
72
|
+
if (opts['currency'] === undefined || opts['currency'] === null) {
|
73
|
+
throw new Error("Missing the required parameter 'currency' when calling addRecurringSubscription");
|
74
|
+
}
|
75
|
+
|
76
|
+
if (opts['cadence_type'] === undefined || opts['cadence_type'] === null) {
|
77
|
+
throw new Error("Missing the required parameter 'cadence_type' when calling addRecurringSubscription");
|
78
|
+
}
|
79
|
+
|
80
|
+
if (opts['cycle_amount'] === undefined || opts['cycle_amount'] === null) {
|
81
|
+
throw new Error("Missing the required parameter 'cycle_amount' when calling addRecurringSubscription");
|
82
|
+
}
|
83
|
+
|
84
|
+
if (opts['start_date'] === undefined || opts['start_date'] === null) {
|
85
|
+
throw new Error("Missing the required parameter 'start_date' when calling addRecurringSubscription");
|
86
|
+
}
|
87
|
+
|
67
88
|
var pathParams = {};
|
68
89
|
var queryParams = {};
|
69
90
|
var headerParams = {};
|
@@ -90,7 +111,7 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
90
111
|
}
|
91
112
|
/**
|
92
113
|
* Add a recurring subscription
|
93
|
-
* Adds a new recurring
|
114
|
+
* Adds a new recurring subscription.
|
94
115
|
* @param {Object} opts Optional parameters
|
95
116
|
* @param {module:model/SubscriptionRecurringCreateRequest} opts.subscriptionRecurringCreateRequest
|
96
117
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
@@ -105,7 +126,7 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
105
126
|
}
|
106
127
|
/**
|
107
128
|
* Add an installment subscription
|
108
|
-
* Adds a new installment
|
129
|
+
* Adds a new installment subscription.
|
109
130
|
* @param {Object} opts Optional parameters
|
110
131
|
* @param {module:model/SubscriptionInstallmentCreateRequest} opts.subscriptionInstallmentCreateRequest
|
111
132
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
@@ -116,6 +137,19 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
116
137
|
value: function addSubscriptionInstallmentWithHttpInfo(opts) {
|
117
138
|
opts = opts || {};
|
118
139
|
var postBody = opts['subscriptionInstallmentCreateRequest'];
|
140
|
+
|
141
|
+
if (opts['deal_id'] === undefined || opts['deal_id'] === null) {
|
142
|
+
throw new Error("Missing the required parameter 'deal_id' when calling addSubscriptionInstallment");
|
143
|
+
}
|
144
|
+
|
145
|
+
if (opts['currency'] === undefined || opts['currency'] === null) {
|
146
|
+
throw new Error("Missing the required parameter 'currency' when calling addSubscriptionInstallment");
|
147
|
+
}
|
148
|
+
|
149
|
+
if (opts['payments'] === undefined || opts['payments'] === null) {
|
150
|
+
throw new Error("Missing the required parameter 'payments' when calling addSubscriptionInstallment");
|
151
|
+
}
|
152
|
+
|
119
153
|
var pathParams = {};
|
120
154
|
var queryParams = {};
|
121
155
|
var headerParams = {};
|
@@ -142,7 +176,7 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
142
176
|
}
|
143
177
|
/**
|
144
178
|
* Add an installment subscription
|
145
|
-
* Adds a new installment
|
179
|
+
* Adds a new installment subscription.
|
146
180
|
* @param {Object} opts Optional parameters
|
147
181
|
* @param {module:model/SubscriptionInstallmentCreateRequest} opts.subscriptionInstallmentCreateRequest
|
148
182
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
@@ -157,8 +191,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
157
191
|
}
|
158
192
|
/**
|
159
193
|
* Cancel a recurring subscription
|
160
|
-
* Cancels a recurring
|
161
|
-
* @param {Number} id ID of the
|
194
|
+
* Cancels a recurring subscription.
|
195
|
+
* @param {Number} id The ID of the subscription
|
162
196
|
* @param {Object} opts Optional parameters
|
163
197
|
* @param {module:model/SubscriptionRecurringCancelRequest} opts.subscriptionRecurringCancelRequest
|
164
198
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
@@ -202,8 +236,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
202
236
|
}
|
203
237
|
/**
|
204
238
|
* Cancel a recurring subscription
|
205
|
-
* Cancels a recurring
|
206
|
-
* @param {Number} id ID of the
|
239
|
+
* Cancels a recurring subscription.
|
240
|
+
* @param {Number} id The ID of the subscription
|
207
241
|
* @param {Object} opts Optional parameters
|
208
242
|
* @param {module:model/SubscriptionRecurringCancelRequest} opts.subscriptionRecurringCancelRequest
|
209
243
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
@@ -218,8 +252,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
218
252
|
}
|
219
253
|
/**
|
220
254
|
* Delete a subscription
|
221
|
-
* Marks an installment or a recurring
|
222
|
-
* @param {Number} id ID of the
|
255
|
+
* Marks an installment or a recurring subscription as deleted.
|
256
|
+
* @param {Number} id The ID of the subscription
|
223
257
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
224
258
|
*/
|
225
259
|
|
@@ -261,8 +295,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
261
295
|
}
|
262
296
|
/**
|
263
297
|
* Delete a subscription
|
264
|
-
* Marks an installment or a recurring
|
265
|
-
* @param {Number} id ID of the
|
298
|
+
* Marks an installment or a recurring subscription as deleted.
|
299
|
+
* @param {Number} id The ID of the subscription
|
266
300
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
267
301
|
*/
|
268
302
|
|
@@ -275,8 +309,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
275
309
|
}
|
276
310
|
/**
|
277
311
|
* Find subscription by deal
|
278
|
-
* Returns details of an installment or a recurring
|
279
|
-
* @param {Number} dealId ID of the
|
312
|
+
* Returns details of an installment or a recurring subscription by the deal ID.
|
313
|
+
* @param {Number} dealId The ID of the deal
|
280
314
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
281
315
|
*/
|
282
316
|
|
@@ -318,8 +352,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
318
352
|
}
|
319
353
|
/**
|
320
354
|
* Find subscription by deal
|
321
|
-
* Returns details of an installment or a recurring
|
322
|
-
* @param {Number} dealId ID of the
|
355
|
+
* Returns details of an installment or a recurring subscription by the deal ID.
|
356
|
+
* @param {Number} dealId The ID of the deal
|
323
357
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
324
358
|
*/
|
325
359
|
|
@@ -332,8 +366,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
332
366
|
}
|
333
367
|
/**
|
334
368
|
* Get details of a subscription
|
335
|
-
* Returns details of an installment or a recurring
|
336
|
-
* @param {Number} id ID of the
|
369
|
+
* Returns details of an installment or a recurring subscription.
|
370
|
+
* @param {Number} id The ID of the subscription
|
337
371
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
338
372
|
*/
|
339
373
|
|
@@ -375,8 +409,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
375
409
|
}
|
376
410
|
/**
|
377
411
|
* Get details of a subscription
|
378
|
-
* Returns details of an installment or a recurring
|
379
|
-
* @param {Number} id ID of the
|
412
|
+
* Returns details of an installment or a recurring subscription.
|
413
|
+
* @param {Number} id The ID of the subscription
|
380
414
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
381
415
|
*/
|
382
416
|
|
@@ -388,9 +422,9 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
388
422
|
});
|
389
423
|
}
|
390
424
|
/**
|
391
|
-
* Get all payments of a
|
392
|
-
* Returns all payments of an installment or recurring
|
393
|
-
* @param {Number} id ID of the
|
425
|
+
* Get all payments of a subscription
|
426
|
+
* Returns all payments of an installment or recurring subscription.
|
427
|
+
* @param {Number} id The ID of the subscription
|
394
428
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PaymentsResponse} and HTTP response
|
395
429
|
*/
|
396
430
|
|
@@ -431,9 +465,9 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
431
465
|
return this.apiClient.callApi('/subscriptions/{id}/payments', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
432
466
|
}
|
433
467
|
/**
|
434
|
-
* Get all payments of a
|
435
|
-
* Returns all payments of an installment or recurring
|
436
|
-
* @param {Number} id ID of the
|
468
|
+
* Get all payments of a subscription
|
469
|
+
* Returns all payments of an installment or recurring subscription.
|
470
|
+
* @param {Number} id The ID of the subscription
|
437
471
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PaymentsResponse}
|
438
472
|
*/
|
439
473
|
|
@@ -446,8 +480,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
446
480
|
}
|
447
481
|
/**
|
448
482
|
* Update a recurring subscription
|
449
|
-
* Updates a recurring
|
450
|
-
* @param {Number} id ID of the
|
483
|
+
* Updates a recurring subscription.
|
484
|
+
* @param {Number} id The ID of the subscription
|
451
485
|
* @param {Object} opts Optional parameters
|
452
486
|
* @param {module:model/SubscriptionRecurringUpdateRequest} opts.subscriptionRecurringUpdateRequest
|
453
487
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
@@ -463,6 +497,10 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
463
497
|
throw new Error("Missing the required parameter 'id' when calling updateRecurringSubscription");
|
464
498
|
}
|
465
499
|
|
500
|
+
if (opts['effective_date'] === undefined || opts['effective_date'] === null) {
|
501
|
+
throw new Error("Missing the required parameter 'effective_date' when calling updateRecurringSubscription");
|
502
|
+
}
|
503
|
+
|
466
504
|
var pathParams = {
|
467
505
|
'id': id
|
468
506
|
};
|
@@ -491,8 +529,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
491
529
|
}
|
492
530
|
/**
|
493
531
|
* Update a recurring subscription
|
494
|
-
* Updates a recurring
|
495
|
-
* @param {Number} id ID of the
|
532
|
+
* Updates a recurring subscription.
|
533
|
+
* @param {Number} id The ID of the subscription
|
496
534
|
* @param {Object} opts Optional parameters
|
497
535
|
* @param {module:model/SubscriptionRecurringUpdateRequest} opts.subscriptionRecurringUpdateRequest
|
498
536
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|
@@ -507,8 +545,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
507
545
|
}
|
508
546
|
/**
|
509
547
|
* Update an installment subscription
|
510
|
-
* Updates an installment
|
511
|
-
* @param {Number} id ID of the
|
548
|
+
* Updates an installment subscription.
|
549
|
+
* @param {Number} id The ID of the subscription
|
512
550
|
* @param {Object} opts Optional parameters
|
513
551
|
* @param {module:model/SubscriptionInstallmentUpdateRequest} opts.subscriptionInstallmentUpdateRequest
|
514
552
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SubscriptionsIdResponse} and HTTP response
|
@@ -524,6 +562,10 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
524
562
|
throw new Error("Missing the required parameter 'id' when calling updateSubscriptionInstallment");
|
525
563
|
}
|
526
564
|
|
565
|
+
if (opts['payments'] === undefined || opts['payments'] === null) {
|
566
|
+
throw new Error("Missing the required parameter 'payments' when calling updateSubscriptionInstallment");
|
567
|
+
}
|
568
|
+
|
527
569
|
var pathParams = {
|
528
570
|
'id': id
|
529
571
|
};
|
@@ -552,8 +594,8 @@ var SubscriptionsApi = /*#__PURE__*/function () {
|
|
552
594
|
}
|
553
595
|
/**
|
554
596
|
* Update an installment subscription
|
555
|
-
* Updates an installment
|
556
|
-
* @param {Number} id ID of the
|
597
|
+
* Updates an installment subscription.
|
598
|
+
* @param {Number} id The ID of the subscription
|
557
599
|
* @param {Object} opts Optional parameters
|
558
600
|
* @param {module:model/SubscriptionInstallmentUpdateRequest} opts.subscriptionInstallmentUpdateRequest
|
559
601
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SubscriptionsIdResponse}
|