diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 72784e0df7d5682d500299e36c525635e836ae01..84c510cef33b37a5b83d3fe71dad851a4b35ee7b 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1 +1 @@ -window.searchData = {"kinds":{"32":"Variable","1024":"Property","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":32,"name":"AccountApi","url":"modules.html#AccountApi","classes":"tsd-kind-variable"},{"id":1,"kind":65536,"name":"__type","url":"modules.html#AccountApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"AccountApi"},{"id":2,"kind":2048,"name":"accountGetLoginUrls","url":"modules.html#AccountApi.__type.accountGetLoginUrls","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AccountApi.__type"},{"id":3,"kind":2048,"name":"accountLogout","url":"modules.html#AccountApi.__type.accountLogout","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AccountApi.__type"},{"id":4,"kind":32,"name":"AdminApi","url":"modules.html#AdminApi","classes":"tsd-kind-variable"},{"id":5,"kind":65536,"name":"__type","url":"modules.html#AdminApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"AdminApi"},{"id":6,"kind":2048,"name":"adminGetProject","url":"modules.html#AdminApi.__type.adminGetProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AdminApi.__type"},{"id":7,"kind":2048,"name":"adminUpdateQuota","url":"modules.html#AdminApi.__type.adminUpdateQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AdminApi.__type"},{"id":8,"kind":32,"name":"ApplicationProfileApi","url":"modules.html#ApplicationProfileApi","classes":"tsd-kind-variable"},{"id":9,"kind":65536,"name":"__type","url":"modules.html#ApplicationProfileApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ApplicationProfileApi"},{"id":10,"kind":2048,"name":"apiV2ApplicationProfilesOptions","url":"modules.html#ApplicationProfileApi.__type.apiV2ApplicationProfilesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":11,"kind":2048,"name":"createApplicationProfileRequest","url":"modules.html#ApplicationProfileApi.__type.createApplicationProfileRequest","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":12,"kind":2048,"name":"getApplicationProfile","url":"modules.html#ApplicationProfileApi.__type.getApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":13,"kind":2048,"name":"getApplicationProfiles","url":"modules.html#ApplicationProfileApi.__type.getApplicationProfiles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":14,"kind":2048,"name":"getRawApplicationProfile","url":"modules.html#ApplicationProfileApi.__type.getRawApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":15,"kind":32,"name":"BlobApi","url":"modules.html#BlobApi","classes":"tsd-kind-variable"},{"id":16,"kind":65536,"name":"__type","url":"modules.html#BlobApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"BlobApi"},{"id":17,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","url":"modules.html#BlobApi.__type.apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":18,"kind":2048,"name":"createBlob","url":"modules.html#BlobApi.__type.createBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":19,"kind":2048,"name":"deleteBlob","url":"modules.html#BlobApi.__type.deleteBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":20,"kind":2048,"name":"getBlob","url":"modules.html#BlobApi.__type.getBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":21,"kind":2048,"name":"updateBlob","url":"modules.html#BlobApi.__type.updateBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":22,"kind":32,"name":"DisciplineApi","url":"modules.html#DisciplineApi","classes":"tsd-kind-variable"},{"id":23,"kind":65536,"name":"__type","url":"modules.html#DisciplineApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"DisciplineApi"},{"id":24,"kind":2048,"name":"apiV2DisciplinesOptions","url":"modules.html#DisciplineApi.__type.apiV2DisciplinesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"DisciplineApi.__type"},{"id":25,"kind":2048,"name":"getDiscipline","url":"modules.html#DisciplineApi.__type.getDiscipline","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"DisciplineApi.__type"},{"id":26,"kind":2048,"name":"getDisciplines","url":"modules.html#DisciplineApi.__type.getDisciplines","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"DisciplineApi.__type"},{"id":27,"kind":32,"name":"HomeApi","url":"modules.html#HomeApi","classes":"tsd-kind-variable"},{"id":28,"kind":65536,"name":"__type","url":"modules.html#HomeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"HomeApi"},{"id":29,"kind":2048,"name":"homeIndex","url":"modules.html#HomeApi.__type.homeIndex","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"HomeApi.__type"},{"id":30,"kind":32,"name":"LanguageApi","url":"modules.html#LanguageApi","classes":"tsd-kind-variable"},{"id":31,"kind":65536,"name":"__type","url":"modules.html#LanguageApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"LanguageApi"},{"id":32,"kind":2048,"name":"apiV2LanguagesOptions","url":"modules.html#LanguageApi.__type.apiV2LanguagesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LanguageApi.__type"},{"id":33,"kind":2048,"name":"getLanguage","url":"modules.html#LanguageApi.__type.getLanguage","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LanguageApi.__type"},{"id":34,"kind":2048,"name":"getLanguages","url":"modules.html#LanguageApi.__type.getLanguages","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LanguageApi.__type"},{"id":35,"kind":32,"name":"LicenseApi","url":"modules.html#LicenseApi","classes":"tsd-kind-variable"},{"id":36,"kind":65536,"name":"__type","url":"modules.html#LicenseApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"LicenseApi"},{"id":37,"kind":2048,"name":"apiV2LicensesOptions","url":"modules.html#LicenseApi.__type.apiV2LicensesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LicenseApi.__type"},{"id":38,"kind":2048,"name":"getLicense","url":"modules.html#LicenseApi.__type.getLicense","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LicenseApi.__type"},{"id":39,"kind":2048,"name":"getLicenses","url":"modules.html#LicenseApi.__type.getLicenses","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LicenseApi.__type"},{"id":40,"kind":32,"name":"MaintenanceApi","url":"modules.html#MaintenanceApi","classes":"tsd-kind-variable"},{"id":41,"kind":65536,"name":"__type","url":"modules.html#MaintenanceApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"MaintenanceApi"},{"id":42,"kind":2048,"name":"apiV2MaintenancesOptions","url":"modules.html#MaintenanceApi.__type.apiV2MaintenancesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MaintenanceApi.__type"},{"id":43,"kind":2048,"name":"getCurrentMaintenance","url":"modules.html#MaintenanceApi.__type.getCurrentMaintenance","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MaintenanceApi.__type"},{"id":44,"kind":32,"name":"MergeApi","url":"modules.html#MergeApi","classes":"tsd-kind-variable"},{"id":45,"kind":65536,"name":"__type","url":"modules.html#MergeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"MergeApi"},{"id":46,"kind":2048,"name":"mergeCallback","url":"modules.html#MergeApi.__type.mergeCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MergeApi.__type"},{"id":47,"kind":2048,"name":"mergeLogin","url":"modules.html#MergeApi.__type.mergeLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MergeApi.__type"},{"id":48,"kind":32,"name":"ORCiDApi","url":"modules.html#ORCiDApi","classes":"tsd-kind-variable"},{"id":49,"kind":65536,"name":"__type","url":"modules.html#ORCiDApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ORCiDApi"},{"id":50,"kind":2048,"name":"oRCiDLoginGET","url":"modules.html#ORCiDApi.__type.oRCiDLoginGET","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ORCiDApi.__type"},{"id":51,"kind":2048,"name":"oRCiDLoginPOST","url":"modules.html#ORCiDApi.__type.oRCiDLoginPOST","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ORCiDApi.__type"},{"id":52,"kind":32,"name":"OrganizationApi","url":"modules.html#OrganizationApi","classes":"tsd-kind-variable"},{"id":53,"kind":65536,"name":"__type","url":"modules.html#OrganizationApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"OrganizationApi"},{"id":54,"kind":2048,"name":"apiV2OrganizationsOptions","url":"modules.html#OrganizationApi.__type.apiV2OrganizationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"OrganizationApi.__type"},{"id":55,"kind":2048,"name":"getOrganization","url":"modules.html#OrganizationApi.__type.getOrganization","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"OrganizationApi.__type"},{"id":56,"kind":2048,"name":"getOrganizations","url":"modules.html#OrganizationApi.__type.getOrganizations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"OrganizationApi.__type"},{"id":57,"kind":32,"name":"PidApi","url":"modules.html#PidApi","classes":"tsd-kind-variable"},{"id":58,"kind":65536,"name":"__type","url":"modules.html#PidApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"PidApi"},{"id":59,"kind":2048,"name":"apiV2PidsOptions","url":"modules.html#PidApi.__type.apiV2PidsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"PidApi.__type"},{"id":60,"kind":2048,"name":"sendEmailToOwner","url":"modules.html#PidApi.__type.sendEmailToOwner","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"PidApi.__type"},{"id":61,"kind":2048,"name":"validatePid","url":"modules.html#PidApi.__type.validatePid","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"PidApi.__type"},{"id":62,"kind":32,"name":"ProjectApi","url":"modules.html#ProjectApi","classes":"tsd-kind-variable"},{"id":63,"kind":65536,"name":"__type","url":"modules.html#ProjectApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectApi"},{"id":64,"kind":2048,"name":"apiV2ProjectsOptions","url":"modules.html#ProjectApi.__type.apiV2ProjectsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":65,"kind":2048,"name":"createProject","url":"modules.html#ProjectApi.__type.createProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":66,"kind":2048,"name":"deleteProject","url":"modules.html#ProjectApi.__type.deleteProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":67,"kind":2048,"name":"getProject","url":"modules.html#ProjectApi.__type.getProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":68,"kind":2048,"name":"getProjects","url":"modules.html#ProjectApi.__type.getProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":69,"kind":2048,"name":"updateProject","url":"modules.html#ProjectApi.__type.updateProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":70,"kind":32,"name":"ProjectResourceApi","url":"modules.html#ProjectResourceApi","classes":"tsd-kind-variable"},{"id":71,"kind":65536,"name":"__type","url":"modules.html#ProjectResourceApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectResourceApi"},{"id":72,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesOptions","url":"modules.html#ProjectResourceApi.__type.apiV2ProjectsProjectIdResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":73,"kind":2048,"name":"createResourceForProject","url":"modules.html#ProjectResourceApi.__type.createResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":74,"kind":2048,"name":"deleteResourceForProject","url":"modules.html#ProjectResourceApi.__type.deleteResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":75,"kind":2048,"name":"getResourceForProject","url":"modules.html#ProjectResourceApi.__type.getResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":76,"kind":2048,"name":"getResourcesForProject","url":"modules.html#ProjectResourceApi.__type.getResourcesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":77,"kind":2048,"name":"updateResourceForProject","url":"modules.html#ProjectResourceApi.__type.updateResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":78,"kind":32,"name":"ProjectQuotaApi","url":"modules.html#ProjectQuotaApi","classes":"tsd-kind-variable"},{"id":79,"kind":65536,"name":"__type","url":"modules.html#ProjectQuotaApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectQuotaApi"},{"id":80,"kind":2048,"name":"apiV2ProjectsProjectIdQuotasOptions","url":"modules.html#ProjectQuotaApi.__type.apiV2ProjectsProjectIdQuotasOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":81,"kind":2048,"name":"getProjectQuota","url":"modules.html#ProjectQuotaApi.__type.getProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":82,"kind":2048,"name":"getProjectQuotas","url":"modules.html#ProjectQuotaApi.__type.getProjectQuotas","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":83,"kind":2048,"name":"updateProjectQuota","url":"modules.html#ProjectQuotaApi.__type.updateProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":84,"kind":32,"name":"ProjectResourceQuotaApi","url":"modules.html#ProjectResourceQuotaApi","classes":"tsd-kind-variable"},{"id":85,"kind":65536,"name":"__type","url":"modules.html#ProjectResourceQuotaApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectResourceQuotaApi"},{"id":86,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","url":"modules.html#ProjectResourceQuotaApi.__type.apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceQuotaApi.__type"},{"id":87,"kind":2048,"name":"getQuotaForResourceForProject","url":"modules.html#ProjectResourceQuotaApi.__type.getQuotaForResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceQuotaApi.__type"},{"id":88,"kind":32,"name":"ProjectResourceTypeApi","url":"modules.html#ProjectResourceTypeApi","classes":"tsd-kind-variable"},{"id":89,"kind":65536,"name":"__type","url":"modules.html#ProjectResourceTypeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectResourceTypeApi"},{"id":90,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesTypesOptions","url":"modules.html#ProjectResourceTypeApi.__type.apiV2ProjectsProjectIdResourcesTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceTypeApi.__type"},{"id":91,"kind":2048,"name":"getAvailableResourceTypesInformationForProject","url":"modules.html#ProjectResourceTypeApi.__type.getAvailableResourceTypesInformationForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceTypeApi.__type"},{"id":92,"kind":32,"name":"ProjectInvitationApi","url":"modules.html#ProjectInvitationApi","classes":"tsd-kind-variable"},{"id":93,"kind":65536,"name":"__type","url":"modules.html#ProjectInvitationApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectInvitationApi"},{"id":94,"kind":2048,"name":"apiV2ProjectsProjectIdInvitationsOptions","url":"modules.html#ProjectInvitationApi.__type.apiV2ProjectsProjectIdInvitationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":95,"kind":2048,"name":"createProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.createProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":96,"kind":2048,"name":"deleteProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.deleteProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":97,"kind":2048,"name":"getProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.getProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":98,"kind":2048,"name":"getProjectInvitations","url":"modules.html#ProjectInvitationApi.__type.getProjectInvitations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":99,"kind":2048,"name":"resolveProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.resolveProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":100,"kind":32,"name":"ProjectMemberApi","url":"modules.html#ProjectMemberApi","classes":"tsd-kind-variable"},{"id":101,"kind":65536,"name":"__type","url":"modules.html#ProjectMemberApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectMemberApi"},{"id":102,"kind":2048,"name":"addMembership","url":"modules.html#ProjectMemberApi.__type.addMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":103,"kind":2048,"name":"apiV2ProjectsProjectIdMembersOptions","url":"modules.html#ProjectMemberApi.__type.apiV2ProjectsProjectIdMembersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":104,"kind":2048,"name":"deleteMembership","url":"modules.html#ProjectMemberApi.__type.deleteMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":105,"kind":2048,"name":"getMembership","url":"modules.html#ProjectMemberApi.__type.getMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":106,"kind":2048,"name":"getMemberships","url":"modules.html#ProjectMemberApi.__type.getMemberships","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":107,"kind":2048,"name":"updateMembership","url":"modules.html#ProjectMemberApi.__type.updateMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":108,"kind":32,"name":"ResourceApi","url":"modules.html#ResourceApi","classes":"tsd-kind-variable"},{"id":109,"kind":65536,"name":"__type","url":"modules.html#ResourceApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ResourceApi"},{"id":110,"kind":2048,"name":"apiV2ResourcesOptions","url":"modules.html#ResourceApi.__type.apiV2ResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceApi.__type"},{"id":111,"kind":2048,"name":"getResource","url":"modules.html#ResourceApi.__type.getResource","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceApi.__type"},{"id":112,"kind":32,"name":"ResourceTypeApi","url":"modules.html#ResourceTypeApi","classes":"tsd-kind-variable"},{"id":113,"kind":65536,"name":"__type","url":"modules.html#ResourceTypeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ResourceTypeApi"},{"id":114,"kind":2048,"name":"apiV2ResourcesTypesOptions","url":"modules.html#ResourceTypeApi.__type.apiV2ResourcesTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":115,"kind":2048,"name":"getAllGitlabBranchesForProject","url":"modules.html#ResourceTypeApi.__type.getAllGitlabBranchesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":116,"kind":2048,"name":"getAllGitlabProjects","url":"modules.html#ResourceTypeApi.__type.getAllGitlabProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":117,"kind":2048,"name":"getAllResourceTypesInformation","url":"modules.html#ResourceTypeApi.__type.getAllResourceTypesInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":118,"kind":2048,"name":"getGitlabProject","url":"modules.html#ResourceTypeApi.__type.getGitlabProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":119,"kind":2048,"name":"getResourceTypeInformation","url":"modules.html#ResourceTypeApi.__type.getResourceTypeInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":120,"kind":32,"name":"RoleApi","url":"modules.html#RoleApi","classes":"tsd-kind-variable"},{"id":121,"kind":65536,"name":"__type","url":"modules.html#RoleApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"RoleApi"},{"id":122,"kind":2048,"name":"apiV2RolesOptions","url":"modules.html#RoleApi.__type.apiV2RolesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"RoleApi.__type"},{"id":123,"kind":2048,"name":"getRole","url":"modules.html#RoleApi.__type.getRole","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"RoleApi.__type"},{"id":124,"kind":2048,"name":"getRoles","url":"modules.html#RoleApi.__type.getRoles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"RoleApi.__type"},{"id":125,"kind":32,"name":"SearchApi","url":"modules.html#SearchApi","classes":"tsd-kind-variable"},{"id":126,"kind":65536,"name":"__type","url":"modules.html#SearchApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"SearchApi"},{"id":127,"kind":2048,"name":"searchSearch","url":"modules.html#SearchApi.__type.searchSearch","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SearchApi.__type"},{"id":128,"kind":32,"name":"ShibbolethApi","url":"modules.html#ShibbolethApi","classes":"tsd-kind-variable"},{"id":129,"kind":65536,"name":"__type","url":"modules.html#ShibbolethApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ShibbolethApi"},{"id":130,"kind":2048,"name":"shibbolethCallback","url":"modules.html#ShibbolethApi.__type.shibbolethCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ShibbolethApi.__type"},{"id":131,"kind":2048,"name":"shibbolethLogin","url":"modules.html#ShibbolethApi.__type.shibbolethLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ShibbolethApi.__type"},{"id":132,"kind":32,"name":"TitleApi","url":"modules.html#TitleApi","classes":"tsd-kind-variable"},{"id":133,"kind":65536,"name":"__type","url":"modules.html#TitleApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"TitleApi"},{"id":134,"kind":2048,"name":"apiV2TitlesOptions","url":"modules.html#TitleApi.__type.apiV2TitlesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TitleApi.__type"},{"id":135,"kind":2048,"name":"getTitle","url":"modules.html#TitleApi.__type.getTitle","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TitleApi.__type"},{"id":136,"kind":2048,"name":"getTitles","url":"modules.html#TitleApi.__type.getTitles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TitleApi.__type"},{"id":137,"kind":32,"name":"TokenApi","url":"modules.html#TokenApi","classes":"tsd-kind-variable"},{"id":138,"kind":65536,"name":"__type","url":"modules.html#TokenApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"TokenApi"},{"id":139,"kind":2048,"name":"apiV2UsersSelfTokensOptions","url":"modules.html#TokenApi.__type.apiV2UsersSelfTokensOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TokenApi.__type"},{"id":140,"kind":2048,"name":"createApiToken","url":"modules.html#TokenApi.__type.createApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TokenApi.__type"},{"id":141,"kind":2048,"name":"getAllApiTokens","url":"modules.html#TokenApi.__type.getAllApiTokens","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TokenApi.__type"},{"id":142,"kind":2048,"name":"getApiToken","url":"modules.html#TokenApi.__type.getApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TokenApi.__type"},{"id":143,"kind":2048,"name":"revokeToken","url":"modules.html#TokenApi.__type.revokeToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TokenApi.__type"},{"id":144,"kind":32,"name":"ToSApi","url":"modules.html#ToSApi","classes":"tsd-kind-variable"},{"id":145,"kind":65536,"name":"__type","url":"modules.html#ToSApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ToSApi"},{"id":146,"kind":2048,"name":"apiV2TosOptions","url":"modules.html#ToSApi.__type.apiV2TosOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ToSApi.__type"},{"id":147,"kind":2048,"name":"getToS","url":"modules.html#ToSApi.__type.getToS","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ToSApi.__type"},{"id":148,"kind":32,"name":"TreeApi","url":"modules.html#TreeApi","classes":"tsd-kind-variable"},{"id":149,"kind":65536,"name":"__type","url":"modules.html#TreeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"TreeApi"},{"id":150,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","url":"modules.html#TreeApi.__type.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":151,"kind":2048,"name":"createMetadataTree","url":"modules.html#TreeApi.__type.createMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":152,"kind":2048,"name":"getFileTree","url":"modules.html#TreeApi.__type.getFileTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":153,"kind":2048,"name":"getMetadataTree","url":"modules.html#TreeApi.__type.getMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":154,"kind":2048,"name":"updateMetadataTree","url":"modules.html#TreeApi.__type.updateMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":155,"kind":32,"name":"UserApi","url":"modules.html#UserApi","classes":"tsd-kind-variable"},{"id":156,"kind":65536,"name":"__type","url":"modules.html#UserApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"UserApi"},{"id":157,"kind":2048,"name":"acceptCurrentToS","url":"modules.html#UserApi.__type.acceptCurrentToS","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":158,"kind":2048,"name":"apiV2UsersOptions","url":"modules.html#UserApi.__type.apiV2UsersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":159,"kind":2048,"name":"confirmUserEmail","url":"modules.html#UserApi.__type.confirmUserEmail","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":160,"kind":2048,"name":"getCurrentUser","url":"modules.html#UserApi.__type.getCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":161,"kind":2048,"name":"getUsers","url":"modules.html#UserApi.__type.getUsers","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":162,"kind":2048,"name":"initiateUserMerge","url":"modules.html#UserApi.__type.initiateUserMerge","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":163,"kind":2048,"name":"updateCurrentUser","url":"modules.html#UserApi.__type.updateCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":164,"kind":32,"name":"VisibilityApi","url":"modules.html#VisibilityApi","classes":"tsd-kind-variable"},{"id":165,"kind":65536,"name":"__type","url":"modules.html#VisibilityApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"VisibilityApi"},{"id":166,"kind":2048,"name":"apiV2VisibilitiesOptions","url":"modules.html#VisibilityApi.__type.apiV2VisibilitiesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VisibilityApi.__type"},{"id":167,"kind":2048,"name":"getVisibilities","url":"modules.html#VisibilityApi.__type.getVisibilities","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VisibilityApi.__type"},{"id":168,"kind":2048,"name":"getVisibility","url":"modules.html#VisibilityApi.__type.getVisibility","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VisibilityApi.__type"},{"id":169,"kind":32,"name":"VocabularyApi","url":"modules.html#VocabularyApi","classes":"tsd-kind-variable"},{"id":170,"kind":65536,"name":"__type","url":"modules.html#VocabularyApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"VocabularyApi"},{"id":171,"kind":2048,"name":"apiV2VocabulariesOptions","url":"modules.html#VocabularyApi.__type.apiV2VocabulariesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":172,"kind":2048,"name":"getVocabularies","url":"modules.html#VocabularyApi.__type.getVocabularies","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":173,"kind":2048,"name":"getVocabularyInstance","url":"modules.html#VocabularyApi.__type.getVocabularyInstance","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":174,"kind":2048,"name":"getVocabularyInstances","url":"modules.html#VocabularyApi.__type.getVocabularyInstances","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":175,"kind":32,"name":"default","url":"modules.html#default","classes":"tsd-kind-variable"},{"id":176,"kind":65536,"name":"__type","url":"modules.html#default.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"default"},{"id":177,"kind":1024,"name":"AccountApi","url":"modules.html#default.__type.AccountApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":178,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":179,"kind":2048,"name":"accountGetLoginUrls","url":"modules.html#default.__type.__type-1.accountGetLoginUrls","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":180,"kind":2048,"name":"accountLogout","url":"modules.html#default.__type.__type-1.accountLogout","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":181,"kind":1024,"name":"AdminApi","url":"modules.html#default.__type.AdminApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":182,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":183,"kind":2048,"name":"adminGetProject","url":"modules.html#default.__type.__type-2.adminGetProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":184,"kind":2048,"name":"adminUpdateQuota","url":"modules.html#default.__type.__type-2.adminUpdateQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":185,"kind":1024,"name":"BlobApi","url":"modules.html#default.__type.BlobApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":186,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":187,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","url":"modules.html#default.__type.__type-4.apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":188,"kind":2048,"name":"createBlob","url":"modules.html#default.__type.__type-4.createBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":189,"kind":2048,"name":"deleteBlob","url":"modules.html#default.__type.__type-4.deleteBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":190,"kind":2048,"name":"getBlob","url":"modules.html#default.__type.__type-4.getBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":191,"kind":2048,"name":"updateBlob","url":"modules.html#default.__type.__type-4.updateBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":192,"kind":1024,"name":"DisciplineApi","url":"modules.html#default.__type.DisciplineApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":193,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":194,"kind":2048,"name":"apiV2DisciplinesOptions","url":"modules.html#default.__type.__type-5.apiV2DisciplinesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":195,"kind":2048,"name":"getDiscipline","url":"modules.html#default.__type.__type-5.getDiscipline","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":196,"kind":2048,"name":"getDisciplines","url":"modules.html#default.__type.__type-5.getDisciplines","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":197,"kind":1024,"name":"HomeApi","url":"modules.html#default.__type.HomeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":198,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":199,"kind":2048,"name":"homeIndex","url":"modules.html#default.__type.__type-6.homeIndex","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":200,"kind":1024,"name":"LanguageApi","url":"modules.html#default.__type.LanguageApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":201,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":202,"kind":2048,"name":"apiV2LanguagesOptions","url":"modules.html#default.__type.__type-7.apiV2LanguagesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":203,"kind":2048,"name":"getLanguage","url":"modules.html#default.__type.__type-7.getLanguage","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":204,"kind":2048,"name":"getLanguages","url":"modules.html#default.__type.__type-7.getLanguages","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":205,"kind":1024,"name":"LicenseApi","url":"modules.html#default.__type.LicenseApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":206,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":207,"kind":2048,"name":"apiV2LicensesOptions","url":"modules.html#default.__type.__type-8.apiV2LicensesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":208,"kind":2048,"name":"getLicense","url":"modules.html#default.__type.__type-8.getLicense","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":209,"kind":2048,"name":"getLicenses","url":"modules.html#default.__type.__type-8.getLicenses","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":210,"kind":1024,"name":"MaintenanceApi","url":"modules.html#default.__type.MaintenanceApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":211,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-9","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":212,"kind":2048,"name":"apiV2MaintenancesOptions","url":"modules.html#default.__type.__type-9.apiV2MaintenancesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":213,"kind":2048,"name":"getCurrentMaintenance","url":"modules.html#default.__type.__type-9.getCurrentMaintenance","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":214,"kind":1024,"name":"MergeApi","url":"modules.html#default.__type.MergeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":215,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-10","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":216,"kind":2048,"name":"mergeCallback","url":"modules.html#default.__type.__type-10.mergeCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":217,"kind":2048,"name":"mergeLogin","url":"modules.html#default.__type.__type-10.mergeLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":218,"kind":1024,"name":"VocabularyApi","url":"modules.html#default.__type.VocabularyApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":219,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-32","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":220,"kind":2048,"name":"apiV2VocabulariesOptions","url":"modules.html#default.__type.__type-32.apiV2VocabulariesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":221,"kind":2048,"name":"getVocabularies","url":"modules.html#default.__type.__type-32.getVocabularies","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":222,"kind":2048,"name":"getVocabularyInstance","url":"modules.html#default.__type.__type-32.getVocabularyInstance","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":223,"kind":2048,"name":"getVocabularyInstances","url":"modules.html#default.__type.__type-32.getVocabularyInstances","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":224,"kind":1024,"name":"ApplicationProfileApi","url":"modules.html#default.__type.ApplicationProfileApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":225,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":226,"kind":2048,"name":"apiV2ApplicationProfilesOptions","url":"modules.html#default.__type.__type-3.apiV2ApplicationProfilesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":227,"kind":2048,"name":"createApplicationProfileRequest","url":"modules.html#default.__type.__type-3.createApplicationProfileRequest","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":228,"kind":2048,"name":"getApplicationProfile","url":"modules.html#default.__type.__type-3.getApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":229,"kind":2048,"name":"getApplicationProfiles","url":"modules.html#default.__type.__type-3.getApplicationProfiles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":230,"kind":2048,"name":"getRawApplicationProfile","url":"modules.html#default.__type.__type-3.getRawApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":231,"kind":1024,"name":"ORCiDApi","url":"modules.html#default.__type.ORCiDApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":232,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-11","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":233,"kind":2048,"name":"oRCiDLoginGET","url":"modules.html#default.__type.__type-11.oRCiDLoginGET","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":234,"kind":2048,"name":"oRCiDLoginPOST","url":"modules.html#default.__type.__type-11.oRCiDLoginPOST","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":235,"kind":1024,"name":"OrganizationApi","url":"modules.html#default.__type.OrganizationApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":236,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-12","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":237,"kind":2048,"name":"apiV2OrganizationsOptions","url":"modules.html#default.__type.__type-12.apiV2OrganizationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":238,"kind":2048,"name":"getOrganization","url":"modules.html#default.__type.__type-12.getOrganization","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":239,"kind":2048,"name":"getOrganizations","url":"modules.html#default.__type.__type-12.getOrganizations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":240,"kind":1024,"name":"PidApi","url":"modules.html#default.__type.PidApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":241,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-13","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":242,"kind":2048,"name":"apiV2PidsOptions","url":"modules.html#default.__type.__type-13.apiV2PidsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":243,"kind":2048,"name":"sendEmailToOwner","url":"modules.html#default.__type.__type-13.sendEmailToOwner","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":244,"kind":2048,"name":"validatePid","url":"modules.html#default.__type.__type-13.validatePid","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":245,"kind":1024,"name":"ProjectApi","url":"modules.html#default.__type.ProjectApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":246,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-14","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":247,"kind":2048,"name":"apiV2ProjectsOptions","url":"modules.html#default.__type.__type-14.apiV2ProjectsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":248,"kind":2048,"name":"createProject","url":"modules.html#default.__type.__type-14.createProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":249,"kind":2048,"name":"deleteProject","url":"modules.html#default.__type.__type-14.deleteProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":250,"kind":2048,"name":"getProject","url":"modules.html#default.__type.__type-14.getProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":251,"kind":2048,"name":"getProjects","url":"modules.html#default.__type.__type-14.getProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":252,"kind":2048,"name":"updateProject","url":"modules.html#default.__type.__type-14.updateProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":253,"kind":1024,"name":"ProjectResourceApi","url":"modules.html#default.__type.ProjectResourceApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":254,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-18","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":255,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesOptions","url":"modules.html#default.__type.__type-18.apiV2ProjectsProjectIdResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":256,"kind":2048,"name":"createResourceForProject","url":"modules.html#default.__type.__type-18.createResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":257,"kind":2048,"name":"deleteResourceForProject","url":"modules.html#default.__type.__type-18.deleteResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":258,"kind":2048,"name":"getResourceForProject","url":"modules.html#default.__type.__type-18.getResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":259,"kind":2048,"name":"getResourcesForProject","url":"modules.html#default.__type.__type-18.getResourcesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":260,"kind":2048,"name":"updateResourceForProject","url":"modules.html#default.__type.__type-18.updateResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":261,"kind":1024,"name":"ProjectResourceQuotaApi","url":"modules.html#default.__type.ProjectResourceQuotaApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":262,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-19","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":263,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","url":"modules.html#default.__type.__type-19.apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":264,"kind":2048,"name":"getQuotaForResourceForProject","url":"modules.html#default.__type.__type-19.getQuotaForResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":265,"kind":1024,"name":"ProjectResourceTypeApi","url":"modules.html#default.__type.ProjectResourceTypeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":266,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-20","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":267,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesTypesOptions","url":"modules.html#default.__type.__type-20.apiV2ProjectsProjectIdResourcesTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":268,"kind":2048,"name":"getAvailableResourceTypesInformationForProject","url":"modules.html#default.__type.__type-20.getAvailableResourceTypesInformationForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":269,"kind":1024,"name":"ProjectInvitationApi","url":"modules.html#default.__type.ProjectInvitationApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":270,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-15","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":271,"kind":2048,"name":"apiV2ProjectsProjectIdInvitationsOptions","url":"modules.html#default.__type.__type-15.apiV2ProjectsProjectIdInvitationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":272,"kind":2048,"name":"createProjectInvitation","url":"modules.html#default.__type.__type-15.createProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":273,"kind":2048,"name":"deleteProjectInvitation","url":"modules.html#default.__type.__type-15.deleteProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":274,"kind":2048,"name":"getProjectInvitation","url":"modules.html#default.__type.__type-15.getProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":275,"kind":2048,"name":"getProjectInvitations","url":"modules.html#default.__type.__type-15.getProjectInvitations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":276,"kind":2048,"name":"resolveProjectInvitation","url":"modules.html#default.__type.__type-15.resolveProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":277,"kind":1024,"name":"ProjectQuotaApi","url":"modules.html#default.__type.ProjectQuotaApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":278,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-17","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":279,"kind":2048,"name":"apiV2ProjectsProjectIdQuotasOptions","url":"modules.html#default.__type.__type-17.apiV2ProjectsProjectIdQuotasOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":280,"kind":2048,"name":"getProjectQuota","url":"modules.html#default.__type.__type-17.getProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":281,"kind":2048,"name":"getProjectQuotas","url":"modules.html#default.__type.__type-17.getProjectQuotas","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":282,"kind":2048,"name":"updateProjectQuota","url":"modules.html#default.__type.__type-17.updateProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":283,"kind":1024,"name":"ProjectMemberApi","url":"modules.html#default.__type.ProjectMemberApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":284,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-16","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":285,"kind":2048,"name":"addMembership","url":"modules.html#default.__type.__type-16.addMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":286,"kind":2048,"name":"apiV2ProjectsProjectIdMembersOptions","url":"modules.html#default.__type.__type-16.apiV2ProjectsProjectIdMembersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":287,"kind":2048,"name":"deleteMembership","url":"modules.html#default.__type.__type-16.deleteMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":288,"kind":2048,"name":"getMembership","url":"modules.html#default.__type.__type-16.getMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":289,"kind":2048,"name":"getMemberships","url":"modules.html#default.__type.__type-16.getMemberships","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":290,"kind":2048,"name":"updateMembership","url":"modules.html#default.__type.__type-16.updateMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":291,"kind":1024,"name":"ResourceApi","url":"modules.html#default.__type.ResourceApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":292,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-21","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":293,"kind":2048,"name":"apiV2ResourcesOptions","url":"modules.html#default.__type.__type-21.apiV2ResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":294,"kind":2048,"name":"getResource","url":"modules.html#default.__type.__type-21.getResource","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":295,"kind":1024,"name":"ResourceTypeApi","url":"modules.html#default.__type.ResourceTypeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":296,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-22","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":297,"kind":2048,"name":"apiV2ResourcesTypesOptions","url":"modules.html#default.__type.__type-22.apiV2ResourcesTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":298,"kind":2048,"name":"getAllGitlabBranchesForProject","url":"modules.html#default.__type.__type-22.getAllGitlabBranchesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":299,"kind":2048,"name":"getAllGitlabProjects","url":"modules.html#default.__type.__type-22.getAllGitlabProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":300,"kind":2048,"name":"getAllResourceTypesInformation","url":"modules.html#default.__type.__type-22.getAllResourceTypesInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":301,"kind":2048,"name":"getGitlabProject","url":"modules.html#default.__type.__type-22.getGitlabProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":302,"kind":2048,"name":"getResourceTypeInformation","url":"modules.html#default.__type.__type-22.getResourceTypeInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":303,"kind":1024,"name":"RoleApi","url":"modules.html#default.__type.RoleApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":304,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-23","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":305,"kind":2048,"name":"apiV2RolesOptions","url":"modules.html#default.__type.__type-23.apiV2RolesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":306,"kind":2048,"name":"getRole","url":"modules.html#default.__type.__type-23.getRole","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":307,"kind":2048,"name":"getRoles","url":"modules.html#default.__type.__type-23.getRoles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":308,"kind":1024,"name":"SearchApi","url":"modules.html#default.__type.SearchApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":309,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-24","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":310,"kind":2048,"name":"searchSearch","url":"modules.html#default.__type.__type-24.searchSearch","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":311,"kind":1024,"name":"ShibbolethApi","url":"modules.html#default.__type.ShibbolethApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":312,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-25","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":313,"kind":2048,"name":"shibbolethCallback","url":"modules.html#default.__type.__type-25.shibbolethCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":314,"kind":2048,"name":"shibbolethLogin","url":"modules.html#default.__type.__type-25.shibbolethLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":315,"kind":1024,"name":"TitleApi","url":"modules.html#default.__type.TitleApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":316,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-26","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":317,"kind":2048,"name":"apiV2TitlesOptions","url":"modules.html#default.__type.__type-26.apiV2TitlesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":318,"kind":2048,"name":"getTitle","url":"modules.html#default.__type.__type-26.getTitle","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":319,"kind":2048,"name":"getTitles","url":"modules.html#default.__type.__type-26.getTitles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":320,"kind":1024,"name":"TokenApi","url":"modules.html#default.__type.TokenApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":321,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-28","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":322,"kind":2048,"name":"apiV2UsersSelfTokensOptions","url":"modules.html#default.__type.__type-28.apiV2UsersSelfTokensOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":323,"kind":2048,"name":"createApiToken","url":"modules.html#default.__type.__type-28.createApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":324,"kind":2048,"name":"getAllApiTokens","url":"modules.html#default.__type.__type-28.getAllApiTokens","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":325,"kind":2048,"name":"getApiToken","url":"modules.html#default.__type.__type-28.getApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":326,"kind":2048,"name":"revokeToken","url":"modules.html#default.__type.__type-28.revokeToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":327,"kind":1024,"name":"ToSApi","url":"modules.html#default.__type.ToSApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":328,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-27","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":329,"kind":2048,"name":"apiV2TosOptions","url":"modules.html#default.__type.__type-27.apiV2TosOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":330,"kind":2048,"name":"getToS","url":"modules.html#default.__type.__type-27.getToS","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":331,"kind":1024,"name":"TreeApi","url":"modules.html#default.__type.TreeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":332,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-29","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":333,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","url":"modules.html#default.__type.__type-29.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":334,"kind":2048,"name":"createMetadataTree","url":"modules.html#default.__type.__type-29.createMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":335,"kind":2048,"name":"getFileTree","url":"modules.html#default.__type.__type-29.getFileTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":336,"kind":2048,"name":"getMetadataTree","url":"modules.html#default.__type.__type-29.getMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":337,"kind":2048,"name":"updateMetadataTree","url":"modules.html#default.__type.__type-29.updateMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":338,"kind":1024,"name":"UserApi","url":"modules.html#default.__type.UserApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":339,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-30","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":340,"kind":2048,"name":"acceptCurrentToS","url":"modules.html#default.__type.__type-30.acceptCurrentToS","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":341,"kind":2048,"name":"apiV2UsersOptions","url":"modules.html#default.__type.__type-30.apiV2UsersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":342,"kind":2048,"name":"confirmUserEmail","url":"modules.html#default.__type.__type-30.confirmUserEmail","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":343,"kind":2048,"name":"getCurrentUser","url":"modules.html#default.__type.__type-30.getCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":344,"kind":2048,"name":"getUsers","url":"modules.html#default.__type.__type-30.getUsers","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":345,"kind":2048,"name":"initiateUserMerge","url":"modules.html#default.__type.__type-30.initiateUserMerge","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":346,"kind":2048,"name":"updateCurrentUser","url":"modules.html#default.__type.__type-30.updateCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":347,"kind":1024,"name":"VisibilityApi","url":"modules.html#default.__type.VisibilityApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":348,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-31","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":349,"kind":2048,"name":"apiV2VisibilitiesOptions","url":"modules.html#default.__type.__type-31.apiV2VisibilitiesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":350,"kind":2048,"name":"getVisibilities","url":"modules.html#default.__type.__type-31.getVisibilities","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":351,"kind":2048,"name":"getVisibility","url":"modules.html#default.__type.__type-31.getVisibility","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,46.137]],["parent/0",[]],["name/1",[1,16.844]],["parent/1",[0,4.426]],["name/2",[2,49.502]],["parent/2",[3,4.749]],["name/3",[4,49.502]],["parent/3",[3,4.749]],["name/4",[5,46.137]],["parent/4",[]],["name/5",[1,16.844]],["parent/5",[5,4.426]],["name/6",[6,49.502]],["parent/6",[7,4.749]],["name/7",[8,49.502]],["parent/7",[7,4.749]],["name/8",[9,46.137]],["parent/8",[]],["name/9",[1,16.844]],["parent/9",[9,4.426]],["name/10",[10,49.502]],["parent/10",[11,3.993]],["name/11",[12,49.502]],["parent/11",[11,3.993]],["name/12",[13,49.502]],["parent/12",[11,3.993]],["name/13",[14,49.502]],["parent/13",[11,3.993]],["name/14",[15,49.502]],["parent/14",[11,3.993]],["name/15",[16,46.137]],["parent/15",[]],["name/16",[1,16.844]],["parent/16",[16,4.426]],["name/17",[17,49.502]],["parent/17",[18,3.993]],["name/18",[19,49.502]],["parent/18",[18,3.993]],["name/19",[20,49.502]],["parent/19",[18,3.993]],["name/20",[21,49.502]],["parent/20",[18,3.993]],["name/21",[22,49.502]],["parent/21",[18,3.993]],["name/22",[23,46.137]],["parent/22",[]],["name/23",[1,16.844]],["parent/23",[23,4.426]],["name/24",[24,49.502]],["parent/24",[25,4.426]],["name/25",[26,49.502]],["parent/25",[25,4.426]],["name/26",[27,49.502]],["parent/26",[25,4.426]],["name/27",[28,46.137]],["parent/27",[]],["name/28",[1,16.844]],["parent/28",[28,4.426]],["name/29",[29,49.502]],["parent/29",[30,5.239]],["name/30",[31,46.137]],["parent/30",[]],["name/31",[1,16.844]],["parent/31",[31,4.426]],["name/32",[32,49.502]],["parent/32",[33,4.426]],["name/33",[34,49.502]],["parent/33",[33,4.426]],["name/34",[35,49.502]],["parent/34",[33,4.426]],["name/35",[36,46.137]],["parent/35",[]],["name/36",[1,16.844]],["parent/36",[36,4.426]],["name/37",[37,49.502]],["parent/37",[38,4.426]],["name/38",[39,49.502]],["parent/38",[38,4.426]],["name/39",[40,49.502]],["parent/39",[38,4.426]],["name/40",[41,46.137]],["parent/40",[]],["name/41",[1,16.844]],["parent/41",[41,4.426]],["name/42",[42,49.502]],["parent/42",[43,4.749]],["name/43",[44,49.502]],["parent/43",[43,4.749]],["name/44",[45,46.137]],["parent/44",[]],["name/45",[1,16.844]],["parent/45",[45,4.426]],["name/46",[46,49.502]],["parent/46",[47,4.749]],["name/47",[48,49.502]],["parent/47",[47,4.749]],["name/48",[49,46.137]],["parent/48",[]],["name/49",[1,16.844]],["parent/49",[49,4.426]],["name/50",[50,49.502]],["parent/50",[51,4.749]],["name/51",[52,49.502]],["parent/51",[51,4.749]],["name/52",[53,46.137]],["parent/52",[]],["name/53",[1,16.844]],["parent/53",[53,4.426]],["name/54",[54,49.502]],["parent/54",[55,4.426]],["name/55",[56,49.502]],["parent/55",[55,4.426]],["name/56",[57,49.502]],["parent/56",[55,4.426]],["name/57",[58,46.137]],["parent/57",[]],["name/58",[1,16.844]],["parent/58",[58,4.426]],["name/59",[59,49.502]],["parent/59",[60,4.426]],["name/60",[61,49.502]],["parent/60",[60,4.426]],["name/61",[62,49.502]],["parent/61",[60,4.426]],["name/62",[63,46.137]],["parent/62",[]],["name/63",[1,16.844]],["parent/63",[63,4.426]],["name/64",[64,49.502]],["parent/64",[65,3.832]],["name/65",[66,49.502]],["parent/65",[65,3.832]],["name/66",[67,49.502]],["parent/66",[65,3.832]],["name/67",[68,49.502]],["parent/67",[65,3.832]],["name/68",[69,49.502]],["parent/68",[65,3.832]],["name/69",[70,49.502]],["parent/69",[65,3.832]],["name/70",[71,46.137]],["parent/70",[]],["name/71",[1,16.844]],["parent/71",[71,4.426]],["name/72",[72,49.502]],["parent/72",[73,3.832]],["name/73",[74,49.502]],["parent/73",[73,3.832]],["name/74",[75,49.502]],["parent/74",[73,3.832]],["name/75",[76,49.502]],["parent/75",[73,3.832]],["name/76",[77,49.502]],["parent/76",[73,3.832]],["name/77",[78,49.502]],["parent/77",[73,3.832]],["name/78",[79,46.137]],["parent/78",[]],["name/79",[1,16.844]],["parent/79",[79,4.426]],["name/80",[80,49.502]],["parent/80",[81,4.185]],["name/81",[82,49.502]],["parent/81",[81,4.185]],["name/82",[83,49.502]],["parent/82",[81,4.185]],["name/83",[84,49.502]],["parent/83",[81,4.185]],["name/84",[85,46.137]],["parent/84",[]],["name/85",[1,16.844]],["parent/85",[85,4.426]],["name/86",[86,49.502]],["parent/86",[87,4.749]],["name/87",[88,49.502]],["parent/87",[87,4.749]],["name/88",[89,46.137]],["parent/88",[]],["name/89",[1,16.844]],["parent/89",[89,4.426]],["name/90",[90,49.502]],["parent/90",[91,4.749]],["name/91",[92,49.502]],["parent/91",[91,4.749]],["name/92",[93,46.137]],["parent/92",[]],["name/93",[1,16.844]],["parent/93",[93,4.426]],["name/94",[94,49.502]],["parent/94",[95,3.832]],["name/95",[96,49.502]],["parent/95",[95,3.832]],["name/96",[97,49.502]],["parent/96",[95,3.832]],["name/97",[98,49.502]],["parent/97",[95,3.832]],["name/98",[99,49.502]],["parent/98",[95,3.832]],["name/99",[100,49.502]],["parent/99",[95,3.832]],["name/100",[101,46.137]],["parent/100",[]],["name/101",[1,16.844]],["parent/101",[101,4.426]],["name/102",[102,49.502]],["parent/102",[103,3.832]],["name/103",[104,49.502]],["parent/103",[103,3.832]],["name/104",[105,49.502]],["parent/104",[103,3.832]],["name/105",[106,49.502]],["parent/105",[103,3.832]],["name/106",[107,49.502]],["parent/106",[103,3.832]],["name/107",[108,49.502]],["parent/107",[103,3.832]],["name/108",[109,46.137]],["parent/108",[]],["name/109",[1,16.844]],["parent/109",[109,4.426]],["name/110",[110,49.502]],["parent/110",[111,4.749]],["name/111",[112,49.502]],["parent/111",[111,4.749]],["name/112",[113,46.137]],["parent/112",[]],["name/113",[1,16.844]],["parent/113",[113,4.426]],["name/114",[114,49.502]],["parent/114",[115,3.832]],["name/115",[116,49.502]],["parent/115",[115,3.832]],["name/116",[117,49.502]],["parent/116",[115,3.832]],["name/117",[118,49.502]],["parent/117",[115,3.832]],["name/118",[119,49.502]],["parent/118",[115,3.832]],["name/119",[120,49.502]],["parent/119",[115,3.832]],["name/120",[121,46.137]],["parent/120",[]],["name/121",[1,16.844]],["parent/121",[121,4.426]],["name/122",[122,49.502]],["parent/122",[123,4.426]],["name/123",[124,49.502]],["parent/123",[123,4.426]],["name/124",[125,49.502]],["parent/124",[123,4.426]],["name/125",[126,46.137]],["parent/125",[]],["name/126",[1,16.844]],["parent/126",[126,4.426]],["name/127",[127,49.502]],["parent/127",[128,5.239]],["name/128",[129,46.137]],["parent/128",[]],["name/129",[1,16.844]],["parent/129",[129,4.426]],["name/130",[130,49.502]],["parent/130",[131,4.749]],["name/131",[132,49.502]],["parent/131",[131,4.749]],["name/132",[133,46.137]],["parent/132",[]],["name/133",[1,16.844]],["parent/133",[133,4.426]],["name/134",[134,49.502]],["parent/134",[135,4.426]],["name/135",[136,49.502]],["parent/135",[135,4.426]],["name/136",[137,49.502]],["parent/136",[135,4.426]],["name/137",[138,46.137]],["parent/137",[]],["name/138",[1,16.844]],["parent/138",[138,4.426]],["name/139",[139,49.502]],["parent/139",[140,3.993]],["name/140",[141,49.502]],["parent/140",[140,3.993]],["name/141",[142,49.502]],["parent/141",[140,3.993]],["name/142",[143,49.502]],["parent/142",[140,3.993]],["name/143",[144,49.502]],["parent/143",[140,3.993]],["name/144",[145,46.137]],["parent/144",[]],["name/145",[1,16.844]],["parent/145",[145,4.426]],["name/146",[146,49.502]],["parent/146",[147,4.749]],["name/147",[148,49.502]],["parent/147",[147,4.749]],["name/148",[149,46.137]],["parent/148",[]],["name/149",[1,16.844]],["parent/149",[149,4.426]],["name/150",[150,49.502]],["parent/150",[151,3.993]],["name/151",[152,49.502]],["parent/151",[151,3.993]],["name/152",[153,49.502]],["parent/152",[151,3.993]],["name/153",[154,49.502]],["parent/153",[151,3.993]],["name/154",[155,49.502]],["parent/154",[151,3.993]],["name/155",[156,46.137]],["parent/155",[]],["name/156",[1,16.844]],["parent/156",[156,4.426]],["name/157",[157,49.502]],["parent/157",[158,3.695]],["name/158",[159,49.502]],["parent/158",[158,3.695]],["name/159",[160,49.502]],["parent/159",[158,3.695]],["name/160",[161,49.502]],["parent/160",[158,3.695]],["name/161",[162,49.502]],["parent/161",[158,3.695]],["name/162",[163,49.502]],["parent/162",[158,3.695]],["name/163",[164,49.502]],["parent/163",[158,3.695]],["name/164",[165,46.137]],["parent/164",[]],["name/165",[1,16.844]],["parent/165",[165,4.426]],["name/166",[166,49.502]],["parent/166",[167,4.426]],["name/167",[168,49.502]],["parent/167",[167,4.426]],["name/168",[169,49.502]],["parent/168",[167,4.426]],["name/169",[170,46.137]],["parent/169",[]],["name/170",[1,16.844]],["parent/170",[170,4.426]],["name/171",[171,49.502]],["parent/171",[172,4.185]],["name/172",[173,49.502]],["parent/172",[172,4.185]],["name/173",[174,49.502]],["parent/173",[172,4.185]],["name/174",[175,49.502]],["parent/174",[172,4.185]],["name/175",[176,49.502]],["parent/175",[]],["name/176",[1,16.844]],["parent/176",[176,4.749]],["name/177",[0,46.137]],["parent/177",[177,1.631]],["name/178",[1,16.844]],["parent/178",[177,1.631]],["name/179",[2,49.502]],["parent/179",[178,1.106]],["name/180",[4,49.502]],["parent/180",[178,1.106]],["name/181",[5,46.137]],["parent/181",[177,1.631]],["name/182",[1,16.844]],["parent/182",[177,1.631]],["name/183",[6,49.502]],["parent/183",[178,1.106]],["name/184",[8,49.502]],["parent/184",[178,1.106]],["name/185",[16,46.137]],["parent/185",[177,1.631]],["name/186",[1,16.844]],["parent/186",[177,1.631]],["name/187",[17,49.502]],["parent/187",[178,1.106]],["name/188",[19,49.502]],["parent/188",[178,1.106]],["name/189",[20,49.502]],["parent/189",[178,1.106]],["name/190",[21,49.502]],["parent/190",[178,1.106]],["name/191",[22,49.502]],["parent/191",[178,1.106]],["name/192",[23,46.137]],["parent/192",[177,1.631]],["name/193",[1,16.844]],["parent/193",[177,1.631]],["name/194",[24,49.502]],["parent/194",[178,1.106]],["name/195",[26,49.502]],["parent/195",[178,1.106]],["name/196",[27,49.502]],["parent/196",[178,1.106]],["name/197",[28,46.137]],["parent/197",[177,1.631]],["name/198",[1,16.844]],["parent/198",[177,1.631]],["name/199",[29,49.502]],["parent/199",[178,1.106]],["name/200",[31,46.137]],["parent/200",[177,1.631]],["name/201",[1,16.844]],["parent/201",[177,1.631]],["name/202",[32,49.502]],["parent/202",[178,1.106]],["name/203",[34,49.502]],["parent/203",[178,1.106]],["name/204",[35,49.502]],["parent/204",[178,1.106]],["name/205",[36,46.137]],["parent/205",[177,1.631]],["name/206",[1,16.844]],["parent/206",[177,1.631]],["name/207",[37,49.502]],["parent/207",[178,1.106]],["name/208",[39,49.502]],["parent/208",[178,1.106]],["name/209",[40,49.502]],["parent/209",[178,1.106]],["name/210",[41,46.137]],["parent/210",[177,1.631]],["name/211",[1,16.844]],["parent/211",[177,1.631]],["name/212",[42,49.502]],["parent/212",[178,1.106]],["name/213",[44,49.502]],["parent/213",[178,1.106]],["name/214",[45,46.137]],["parent/214",[177,1.631]],["name/215",[1,16.844]],["parent/215",[177,1.631]],["name/216",[46,49.502]],["parent/216",[178,1.106]],["name/217",[48,49.502]],["parent/217",[178,1.106]],["name/218",[170,46.137]],["parent/218",[177,1.631]],["name/219",[1,16.844]],["parent/219",[177,1.631]],["name/220",[171,49.502]],["parent/220",[178,1.106]],["name/221",[173,49.502]],["parent/221",[178,1.106]],["name/222",[174,49.502]],["parent/222",[178,1.106]],["name/223",[175,49.502]],["parent/223",[178,1.106]],["name/224",[9,46.137]],["parent/224",[177,1.631]],["name/225",[1,16.844]],["parent/225",[177,1.631]],["name/226",[10,49.502]],["parent/226",[178,1.106]],["name/227",[12,49.502]],["parent/227",[178,1.106]],["name/228",[13,49.502]],["parent/228",[178,1.106]],["name/229",[14,49.502]],["parent/229",[178,1.106]],["name/230",[15,49.502]],["parent/230",[178,1.106]],["name/231",[49,46.137]],["parent/231",[177,1.631]],["name/232",[1,16.844]],["parent/232",[177,1.631]],["name/233",[50,49.502]],["parent/233",[178,1.106]],["name/234",[52,49.502]],["parent/234",[178,1.106]],["name/235",[53,46.137]],["parent/235",[177,1.631]],["name/236",[1,16.844]],["parent/236",[177,1.631]],["name/237",[54,49.502]],["parent/237",[178,1.106]],["name/238",[56,49.502]],["parent/238",[178,1.106]],["name/239",[57,49.502]],["parent/239",[178,1.106]],["name/240",[58,46.137]],["parent/240",[177,1.631]],["name/241",[1,16.844]],["parent/241",[177,1.631]],["name/242",[59,49.502]],["parent/242",[178,1.106]],["name/243",[61,49.502]],["parent/243",[178,1.106]],["name/244",[62,49.502]],["parent/244",[178,1.106]],["name/245",[63,46.137]],["parent/245",[177,1.631]],["name/246",[1,16.844]],["parent/246",[177,1.631]],["name/247",[64,49.502]],["parent/247",[178,1.106]],["name/248",[66,49.502]],["parent/248",[178,1.106]],["name/249",[67,49.502]],["parent/249",[178,1.106]],["name/250",[68,49.502]],["parent/250",[178,1.106]],["name/251",[69,49.502]],["parent/251",[178,1.106]],["name/252",[70,49.502]],["parent/252",[178,1.106]],["name/253",[71,46.137]],["parent/253",[177,1.631]],["name/254",[1,16.844]],["parent/254",[177,1.631]],["name/255",[72,49.502]],["parent/255",[178,1.106]],["name/256",[74,49.502]],["parent/256",[178,1.106]],["name/257",[75,49.502]],["parent/257",[178,1.106]],["name/258",[76,49.502]],["parent/258",[178,1.106]],["name/259",[77,49.502]],["parent/259",[178,1.106]],["name/260",[78,49.502]],["parent/260",[178,1.106]],["name/261",[85,46.137]],["parent/261",[177,1.631]],["name/262",[1,16.844]],["parent/262",[177,1.631]],["name/263",[86,49.502]],["parent/263",[178,1.106]],["name/264",[88,49.502]],["parent/264",[178,1.106]],["name/265",[89,46.137]],["parent/265",[177,1.631]],["name/266",[1,16.844]],["parent/266",[177,1.631]],["name/267",[90,49.502]],["parent/267",[178,1.106]],["name/268",[92,49.502]],["parent/268",[178,1.106]],["name/269",[93,46.137]],["parent/269",[177,1.631]],["name/270",[1,16.844]],["parent/270",[177,1.631]],["name/271",[94,49.502]],["parent/271",[178,1.106]],["name/272",[96,49.502]],["parent/272",[178,1.106]],["name/273",[97,49.502]],["parent/273",[178,1.106]],["name/274",[98,49.502]],["parent/274",[178,1.106]],["name/275",[99,49.502]],["parent/275",[178,1.106]],["name/276",[100,49.502]],["parent/276",[178,1.106]],["name/277",[79,46.137]],["parent/277",[177,1.631]],["name/278",[1,16.844]],["parent/278",[177,1.631]],["name/279",[80,49.502]],["parent/279",[178,1.106]],["name/280",[82,49.502]],["parent/280",[178,1.106]],["name/281",[83,49.502]],["parent/281",[178,1.106]],["name/282",[84,49.502]],["parent/282",[178,1.106]],["name/283",[101,46.137]],["parent/283",[177,1.631]],["name/284",[1,16.844]],["parent/284",[177,1.631]],["name/285",[102,49.502]],["parent/285",[178,1.106]],["name/286",[104,49.502]],["parent/286",[178,1.106]],["name/287",[105,49.502]],["parent/287",[178,1.106]],["name/288",[106,49.502]],["parent/288",[178,1.106]],["name/289",[107,49.502]],["parent/289",[178,1.106]],["name/290",[108,49.502]],["parent/290",[178,1.106]],["name/291",[109,46.137]],["parent/291",[177,1.631]],["name/292",[1,16.844]],["parent/292",[177,1.631]],["name/293",[110,49.502]],["parent/293",[178,1.106]],["name/294",[112,49.502]],["parent/294",[178,1.106]],["name/295",[113,46.137]],["parent/295",[177,1.631]],["name/296",[1,16.844]],["parent/296",[177,1.631]],["name/297",[114,49.502]],["parent/297",[178,1.106]],["name/298",[116,49.502]],["parent/298",[178,1.106]],["name/299",[117,49.502]],["parent/299",[178,1.106]],["name/300",[118,49.502]],["parent/300",[178,1.106]],["name/301",[119,49.502]],["parent/301",[178,1.106]],["name/302",[120,49.502]],["parent/302",[178,1.106]],["name/303",[121,46.137]],["parent/303",[177,1.631]],["name/304",[1,16.844]],["parent/304",[177,1.631]],["name/305",[122,49.502]],["parent/305",[178,1.106]],["name/306",[124,49.502]],["parent/306",[178,1.106]],["name/307",[125,49.502]],["parent/307",[178,1.106]],["name/308",[126,46.137]],["parent/308",[177,1.631]],["name/309",[1,16.844]],["parent/309",[177,1.631]],["name/310",[127,49.502]],["parent/310",[178,1.106]],["name/311",[129,46.137]],["parent/311",[177,1.631]],["name/312",[1,16.844]],["parent/312",[177,1.631]],["name/313",[130,49.502]],["parent/313",[178,1.106]],["name/314",[132,49.502]],["parent/314",[178,1.106]],["name/315",[133,46.137]],["parent/315",[177,1.631]],["name/316",[1,16.844]],["parent/316",[177,1.631]],["name/317",[134,49.502]],["parent/317",[178,1.106]],["name/318",[136,49.502]],["parent/318",[178,1.106]],["name/319",[137,49.502]],["parent/319",[178,1.106]],["name/320",[138,46.137]],["parent/320",[177,1.631]],["name/321",[1,16.844]],["parent/321",[177,1.631]],["name/322",[139,49.502]],["parent/322",[178,1.106]],["name/323",[141,49.502]],["parent/323",[178,1.106]],["name/324",[142,49.502]],["parent/324",[178,1.106]],["name/325",[143,49.502]],["parent/325",[178,1.106]],["name/326",[144,49.502]],["parent/326",[178,1.106]],["name/327",[145,46.137]],["parent/327",[177,1.631]],["name/328",[1,16.844]],["parent/328",[177,1.631]],["name/329",[146,49.502]],["parent/329",[178,1.106]],["name/330",[148,49.502]],["parent/330",[178,1.106]],["name/331",[149,46.137]],["parent/331",[177,1.631]],["name/332",[1,16.844]],["parent/332",[177,1.631]],["name/333",[150,49.502]],["parent/333",[178,1.106]],["name/334",[152,49.502]],["parent/334",[178,1.106]],["name/335",[153,49.502]],["parent/335",[178,1.106]],["name/336",[154,49.502]],["parent/336",[178,1.106]],["name/337",[155,49.502]],["parent/337",[178,1.106]],["name/338",[156,46.137]],["parent/338",[177,1.631]],["name/339",[1,16.844]],["parent/339",[177,1.631]],["name/340",[157,49.502]],["parent/340",[178,1.106]],["name/341",[159,49.502]],["parent/341",[178,1.106]],["name/342",[160,49.502]],["parent/342",[178,1.106]],["name/343",[161,49.502]],["parent/343",[178,1.106]],["name/344",[162,49.502]],["parent/344",[178,1.106]],["name/345",[163,49.502]],["parent/345",[178,1.106]],["name/346",[164,49.502]],["parent/346",[178,1.106]],["name/347",[165,46.137]],["parent/347",[177,1.631]],["name/348",[1,16.844]],["parent/348",[177,1.631]],["name/349",[166,49.502]],["parent/349",[178,1.106]],["name/350",[168,49.502]],["parent/350",[178,1.106]],["name/351",[169,49.502]],["parent/351",[178,1.106]]],"invertedIndex":[["__type",{"_index":1,"name":{"1":{},"5":{},"9":{},"16":{},"23":{},"28":{},"31":{},"36":{},"41":{},"45":{},"49":{},"53":{},"58":{},"63":{},"71":{},"79":{},"85":{},"89":{},"93":{},"101":{},"109":{},"113":{},"121":{},"126":{},"129":{},"133":{},"138":{},"145":{},"149":{},"156":{},"165":{},"170":{},"176":{},"178":{},"182":{},"186":{},"193":{},"198":{},"201":{},"206":{},"211":{},"215":{},"219":{},"225":{},"232":{},"236":{},"241":{},"246":{},"254":{},"262":{},"266":{},"270":{},"278":{},"284":{},"292":{},"296":{},"304":{},"309":{},"312":{},"316":{},"321":{},"328":{},"332":{},"339":{},"348":{}},"parent":{}}],["acceptcurrenttos",{"_index":157,"name":{"157":{},"340":{}},"parent":{}}],["accountapi",{"_index":0,"name":{"0":{},"177":{}},"parent":{"1":{}}}],["accountapi.__type",{"_index":3,"name":{},"parent":{"2":{},"3":{}}}],["accountgetloginurls",{"_index":2,"name":{"2":{},"179":{}},"parent":{}}],["accountlogout",{"_index":4,"name":{"3":{},"180":{}},"parent":{}}],["addmembership",{"_index":102,"name":{"102":{},"285":{}},"parent":{}}],["adminapi",{"_index":5,"name":{"4":{},"181":{}},"parent":{"5":{}}}],["adminapi.__type",{"_index":7,"name":{},"parent":{"6":{},"7":{}}}],["admingetproject",{"_index":6,"name":{"6":{},"183":{}},"parent":{}}],["adminupdatequota",{"_index":8,"name":{"7":{},"184":{}},"parent":{}}],["apiv2applicationprofilesoptions",{"_index":10,"name":{"10":{},"226":{}},"parent":{}}],["apiv2disciplinesoptions",{"_index":24,"name":{"24":{},"194":{}},"parent":{}}],["apiv2languagesoptions",{"_index":32,"name":{"32":{},"202":{}},"parent":{}}],["apiv2licensesoptions",{"_index":37,"name":{"37":{},"207":{}},"parent":{}}],["apiv2maintenancesoptions",{"_index":42,"name":{"42":{},"212":{}},"parent":{}}],["apiv2organizationsoptions",{"_index":54,"name":{"54":{},"237":{}},"parent":{}}],["apiv2pidsoptions",{"_index":59,"name":{"59":{},"242":{}},"parent":{}}],["apiv2projectsoptions",{"_index":64,"name":{"64":{},"247":{}},"parent":{}}],["apiv2projectsprojectidinvitationsoptions",{"_index":94,"name":{"94":{},"271":{}},"parent":{}}],["apiv2projectsprojectidmembersoptions",{"_index":104,"name":{"103":{},"286":{}},"parent":{}}],["apiv2projectsprojectidquotasoptions",{"_index":80,"name":{"80":{},"279":{}},"parent":{}}],["apiv2projectsprojectidresourcesoptions",{"_index":72,"name":{"72":{},"255":{}},"parent":{}}],["apiv2projectsprojectidresourcesresourceidblobsoptions",{"_index":17,"name":{"17":{},"187":{}},"parent":{}}],["apiv2projectsprojectidresourcesresourceidquotaoptions",{"_index":86,"name":{"86":{},"263":{}},"parent":{}}],["apiv2projectsprojectidresourcesresourceidtreesoptions",{"_index":150,"name":{"150":{},"333":{}},"parent":{}}],["apiv2projectsprojectidresourcestypesoptions",{"_index":90,"name":{"90":{},"267":{}},"parent":{}}],["apiv2resourcesoptions",{"_index":110,"name":{"110":{},"293":{}},"parent":{}}],["apiv2resourcestypesoptions",{"_index":114,"name":{"114":{},"297":{}},"parent":{}}],["apiv2rolesoptions",{"_index":122,"name":{"122":{},"305":{}},"parent":{}}],["apiv2titlesoptions",{"_index":134,"name":{"134":{},"317":{}},"parent":{}}],["apiv2tosoptions",{"_index":146,"name":{"146":{},"329":{}},"parent":{}}],["apiv2usersoptions",{"_index":159,"name":{"158":{},"341":{}},"parent":{}}],["apiv2usersselftokensoptions",{"_index":139,"name":{"139":{},"322":{}},"parent":{}}],["apiv2visibilitiesoptions",{"_index":166,"name":{"166":{},"349":{}},"parent":{}}],["apiv2vocabulariesoptions",{"_index":171,"name":{"171":{},"220":{}},"parent":{}}],["applicationprofileapi",{"_index":9,"name":{"8":{},"224":{}},"parent":{"9":{}}}],["applicationprofileapi.__type",{"_index":11,"name":{},"parent":{"10":{},"11":{},"12":{},"13":{},"14":{}}}],["blobapi",{"_index":16,"name":{"15":{},"185":{}},"parent":{"16":{}}}],["blobapi.__type",{"_index":18,"name":{},"parent":{"17":{},"18":{},"19":{},"20":{},"21":{}}}],["confirmuseremail",{"_index":160,"name":{"159":{},"342":{}},"parent":{}}],["createapitoken",{"_index":141,"name":{"140":{},"323":{}},"parent":{}}],["createapplicationprofilerequest",{"_index":12,"name":{"11":{},"227":{}},"parent":{}}],["createblob",{"_index":19,"name":{"18":{},"188":{}},"parent":{}}],["createmetadatatree",{"_index":152,"name":{"151":{},"334":{}},"parent":{}}],["createproject",{"_index":66,"name":{"65":{},"248":{}},"parent":{}}],["createprojectinvitation",{"_index":96,"name":{"95":{},"272":{}},"parent":{}}],["createresourceforproject",{"_index":74,"name":{"73":{},"256":{}},"parent":{}}],["default",{"_index":176,"name":{"175":{}},"parent":{"176":{}}}],["default.__type",{"_index":177,"name":{},"parent":{"177":{},"178":{},"181":{},"182":{},"185":{},"186":{},"192":{},"193":{},"197":{},"198":{},"200":{},"201":{},"205":{},"206":{},"210":{},"211":{},"214":{},"215":{},"218":{},"219":{},"224":{},"225":{},"231":{},"232":{},"235":{},"236":{},"240":{},"241":{},"245":{},"246":{},"253":{},"254":{},"261":{},"262":{},"265":{},"266":{},"269":{},"270":{},"277":{},"278":{},"283":{},"284":{},"291":{},"292":{},"295":{},"296":{},"303":{},"304":{},"308":{},"309":{},"311":{},"312":{},"315":{},"316":{},"320":{},"321":{},"327":{},"328":{},"331":{},"332":{},"338":{},"339":{},"347":{},"348":{}}}],["default.__type.__type",{"_index":178,"name":{},"parent":{"179":{},"180":{},"183":{},"184":{},"187":{},"188":{},"189":{},"190":{},"191":{},"194":{},"195":{},"196":{},"199":{},"202":{},"203":{},"204":{},"207":{},"208":{},"209":{},"212":{},"213":{},"216":{},"217":{},"220":{},"221":{},"222":{},"223":{},"226":{},"227":{},"228":{},"229":{},"230":{},"233":{},"234":{},"237":{},"238":{},"239":{},"242":{},"243":{},"244":{},"247":{},"248":{},"249":{},"250":{},"251":{},"252":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"263":{},"264":{},"267":{},"268":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"279":{},"280":{},"281":{},"282":{},"285":{},"286":{},"287":{},"288":{},"289":{},"290":{},"293":{},"294":{},"297":{},"298":{},"299":{},"300":{},"301":{},"302":{},"305":{},"306":{},"307":{},"310":{},"313":{},"314":{},"317":{},"318":{},"319":{},"322":{},"323":{},"324":{},"325":{},"326":{},"329":{},"330":{},"333":{},"334":{},"335":{},"336":{},"337":{},"340":{},"341":{},"342":{},"343":{},"344":{},"345":{},"346":{},"349":{},"350":{},"351":{}}}],["deleteblob",{"_index":20,"name":{"19":{},"189":{}},"parent":{}}],["deletemembership",{"_index":105,"name":{"104":{},"287":{}},"parent":{}}],["deleteproject",{"_index":67,"name":{"66":{},"249":{}},"parent":{}}],["deleteprojectinvitation",{"_index":97,"name":{"96":{},"273":{}},"parent":{}}],["deleteresourceforproject",{"_index":75,"name":{"74":{},"257":{}},"parent":{}}],["disciplineapi",{"_index":23,"name":{"22":{},"192":{}},"parent":{"23":{}}}],["disciplineapi.__type",{"_index":25,"name":{},"parent":{"24":{},"25":{},"26":{}}}],["getallapitokens",{"_index":142,"name":{"141":{},"324":{}},"parent":{}}],["getallgitlabbranchesforproject",{"_index":116,"name":{"115":{},"298":{}},"parent":{}}],["getallgitlabprojects",{"_index":117,"name":{"116":{},"299":{}},"parent":{}}],["getallresourcetypesinformation",{"_index":118,"name":{"117":{},"300":{}},"parent":{}}],["getapitoken",{"_index":143,"name":{"142":{},"325":{}},"parent":{}}],["getapplicationprofile",{"_index":13,"name":{"12":{},"228":{}},"parent":{}}],["getapplicationprofiles",{"_index":14,"name":{"13":{},"229":{}},"parent":{}}],["getavailableresourcetypesinformationforproject",{"_index":92,"name":{"91":{},"268":{}},"parent":{}}],["getblob",{"_index":21,"name":{"20":{},"190":{}},"parent":{}}],["getcurrentmaintenance",{"_index":44,"name":{"43":{},"213":{}},"parent":{}}],["getcurrentuser",{"_index":161,"name":{"160":{},"343":{}},"parent":{}}],["getdiscipline",{"_index":26,"name":{"25":{},"195":{}},"parent":{}}],["getdisciplines",{"_index":27,"name":{"26":{},"196":{}},"parent":{}}],["getfiletree",{"_index":153,"name":{"152":{},"335":{}},"parent":{}}],["getgitlabproject",{"_index":119,"name":{"118":{},"301":{}},"parent":{}}],["getlanguage",{"_index":34,"name":{"33":{},"203":{}},"parent":{}}],["getlanguages",{"_index":35,"name":{"34":{},"204":{}},"parent":{}}],["getlicense",{"_index":39,"name":{"38":{},"208":{}},"parent":{}}],["getlicenses",{"_index":40,"name":{"39":{},"209":{}},"parent":{}}],["getmembership",{"_index":106,"name":{"105":{},"288":{}},"parent":{}}],["getmemberships",{"_index":107,"name":{"106":{},"289":{}},"parent":{}}],["getmetadatatree",{"_index":154,"name":{"153":{},"336":{}},"parent":{}}],["getorganization",{"_index":56,"name":{"55":{},"238":{}},"parent":{}}],["getorganizations",{"_index":57,"name":{"56":{},"239":{}},"parent":{}}],["getproject",{"_index":68,"name":{"67":{},"250":{}},"parent":{}}],["getprojectinvitation",{"_index":98,"name":{"97":{},"274":{}},"parent":{}}],["getprojectinvitations",{"_index":99,"name":{"98":{},"275":{}},"parent":{}}],["getprojectquota",{"_index":82,"name":{"81":{},"280":{}},"parent":{}}],["getprojectquotas",{"_index":83,"name":{"82":{},"281":{}},"parent":{}}],["getprojects",{"_index":69,"name":{"68":{},"251":{}},"parent":{}}],["getquotaforresourceforproject",{"_index":88,"name":{"87":{},"264":{}},"parent":{}}],["getrawapplicationprofile",{"_index":15,"name":{"14":{},"230":{}},"parent":{}}],["getresource",{"_index":112,"name":{"111":{},"294":{}},"parent":{}}],["getresourceforproject",{"_index":76,"name":{"75":{},"258":{}},"parent":{}}],["getresourcesforproject",{"_index":77,"name":{"76":{},"259":{}},"parent":{}}],["getresourcetypeinformation",{"_index":120,"name":{"119":{},"302":{}},"parent":{}}],["getrole",{"_index":124,"name":{"123":{},"306":{}},"parent":{}}],["getroles",{"_index":125,"name":{"124":{},"307":{}},"parent":{}}],["gettitle",{"_index":136,"name":{"135":{},"318":{}},"parent":{}}],["gettitles",{"_index":137,"name":{"136":{},"319":{}},"parent":{}}],["gettos",{"_index":148,"name":{"147":{},"330":{}},"parent":{}}],["getusers",{"_index":162,"name":{"161":{},"344":{}},"parent":{}}],["getvisibilities",{"_index":168,"name":{"167":{},"350":{}},"parent":{}}],["getvisibility",{"_index":169,"name":{"168":{},"351":{}},"parent":{}}],["getvocabularies",{"_index":173,"name":{"172":{},"221":{}},"parent":{}}],["getvocabularyinstance",{"_index":174,"name":{"173":{},"222":{}},"parent":{}}],["getvocabularyinstances",{"_index":175,"name":{"174":{},"223":{}},"parent":{}}],["homeapi",{"_index":28,"name":{"27":{},"197":{}},"parent":{"28":{}}}],["homeapi.__type",{"_index":30,"name":{},"parent":{"29":{}}}],["homeindex",{"_index":29,"name":{"29":{},"199":{}},"parent":{}}],["initiateusermerge",{"_index":163,"name":{"162":{},"345":{}},"parent":{}}],["languageapi",{"_index":31,"name":{"30":{},"200":{}},"parent":{"31":{}}}],["languageapi.__type",{"_index":33,"name":{},"parent":{"32":{},"33":{},"34":{}}}],["licenseapi",{"_index":36,"name":{"35":{},"205":{}},"parent":{"36":{}}}],["licenseapi.__type",{"_index":38,"name":{},"parent":{"37":{},"38":{},"39":{}}}],["maintenanceapi",{"_index":41,"name":{"40":{},"210":{}},"parent":{"41":{}}}],["maintenanceapi.__type",{"_index":43,"name":{},"parent":{"42":{},"43":{}}}],["mergeapi",{"_index":45,"name":{"44":{},"214":{}},"parent":{"45":{}}}],["mergeapi.__type",{"_index":47,"name":{},"parent":{"46":{},"47":{}}}],["mergecallback",{"_index":46,"name":{"46":{},"216":{}},"parent":{}}],["mergelogin",{"_index":48,"name":{"47":{},"217":{}},"parent":{}}],["orcidapi",{"_index":49,"name":{"48":{},"231":{}},"parent":{"49":{}}}],["orcidapi.__type",{"_index":51,"name":{},"parent":{"50":{},"51":{}}}],["orcidloginget",{"_index":50,"name":{"50":{},"233":{}},"parent":{}}],["orcidloginpost",{"_index":52,"name":{"51":{},"234":{}},"parent":{}}],["organizationapi",{"_index":53,"name":{"52":{},"235":{}},"parent":{"53":{}}}],["organizationapi.__type",{"_index":55,"name":{},"parent":{"54":{},"55":{},"56":{}}}],["pidapi",{"_index":58,"name":{"57":{},"240":{}},"parent":{"58":{}}}],["pidapi.__type",{"_index":60,"name":{},"parent":{"59":{},"60":{},"61":{}}}],["projectapi",{"_index":63,"name":{"62":{},"245":{}},"parent":{"63":{}}}],["projectapi.__type",{"_index":65,"name":{},"parent":{"64":{},"65":{},"66":{},"67":{},"68":{},"69":{}}}],["projectinvitationapi",{"_index":93,"name":{"92":{},"269":{}},"parent":{"93":{}}}],["projectinvitationapi.__type",{"_index":95,"name":{},"parent":{"94":{},"95":{},"96":{},"97":{},"98":{},"99":{}}}],["projectmemberapi",{"_index":101,"name":{"100":{},"283":{}},"parent":{"101":{}}}],["projectmemberapi.__type",{"_index":103,"name":{},"parent":{"102":{},"103":{},"104":{},"105":{},"106":{},"107":{}}}],["projectquotaapi",{"_index":79,"name":{"78":{},"277":{}},"parent":{"79":{}}}],["projectquotaapi.__type",{"_index":81,"name":{},"parent":{"80":{},"81":{},"82":{},"83":{}}}],["projectresourceapi",{"_index":71,"name":{"70":{},"253":{}},"parent":{"71":{}}}],["projectresourceapi.__type",{"_index":73,"name":{},"parent":{"72":{},"73":{},"74":{},"75":{},"76":{},"77":{}}}],["projectresourcequotaapi",{"_index":85,"name":{"84":{},"261":{}},"parent":{"85":{}}}],["projectresourcequotaapi.__type",{"_index":87,"name":{},"parent":{"86":{},"87":{}}}],["projectresourcetypeapi",{"_index":89,"name":{"88":{},"265":{}},"parent":{"89":{}}}],["projectresourcetypeapi.__type",{"_index":91,"name":{},"parent":{"90":{},"91":{}}}],["resolveprojectinvitation",{"_index":100,"name":{"99":{},"276":{}},"parent":{}}],["resourceapi",{"_index":109,"name":{"108":{},"291":{}},"parent":{"109":{}}}],["resourceapi.__type",{"_index":111,"name":{},"parent":{"110":{},"111":{}}}],["resourcetypeapi",{"_index":113,"name":{"112":{},"295":{}},"parent":{"113":{}}}],["resourcetypeapi.__type",{"_index":115,"name":{},"parent":{"114":{},"115":{},"116":{},"117":{},"118":{},"119":{}}}],["revoketoken",{"_index":144,"name":{"143":{},"326":{}},"parent":{}}],["roleapi",{"_index":121,"name":{"120":{},"303":{}},"parent":{"121":{}}}],["roleapi.__type",{"_index":123,"name":{},"parent":{"122":{},"123":{},"124":{}}}],["searchapi",{"_index":126,"name":{"125":{},"308":{}},"parent":{"126":{}}}],["searchapi.__type",{"_index":128,"name":{},"parent":{"127":{}}}],["searchsearch",{"_index":127,"name":{"127":{},"310":{}},"parent":{}}],["sendemailtoowner",{"_index":61,"name":{"60":{},"243":{}},"parent":{}}],["shibbolethapi",{"_index":129,"name":{"128":{},"311":{}},"parent":{"129":{}}}],["shibbolethapi.__type",{"_index":131,"name":{},"parent":{"130":{},"131":{}}}],["shibbolethcallback",{"_index":130,"name":{"130":{},"313":{}},"parent":{}}],["shibbolethlogin",{"_index":132,"name":{"131":{},"314":{}},"parent":{}}],["titleapi",{"_index":133,"name":{"132":{},"315":{}},"parent":{"133":{}}}],["titleapi.__type",{"_index":135,"name":{},"parent":{"134":{},"135":{},"136":{}}}],["tokenapi",{"_index":138,"name":{"137":{},"320":{}},"parent":{"138":{}}}],["tokenapi.__type",{"_index":140,"name":{},"parent":{"139":{},"140":{},"141":{},"142":{},"143":{}}}],["tosapi",{"_index":145,"name":{"144":{},"327":{}},"parent":{"145":{}}}],["tosapi.__type",{"_index":147,"name":{},"parent":{"146":{},"147":{}}}],["treeapi",{"_index":149,"name":{"148":{},"331":{}},"parent":{"149":{}}}],["treeapi.__type",{"_index":151,"name":{},"parent":{"150":{},"151":{},"152":{},"153":{},"154":{}}}],["updateblob",{"_index":22,"name":{"21":{},"191":{}},"parent":{}}],["updatecurrentuser",{"_index":164,"name":{"163":{},"346":{}},"parent":{}}],["updatemembership",{"_index":108,"name":{"107":{},"290":{}},"parent":{}}],["updatemetadatatree",{"_index":155,"name":{"154":{},"337":{}},"parent":{}}],["updateproject",{"_index":70,"name":{"69":{},"252":{}},"parent":{}}],["updateprojectquota",{"_index":84,"name":{"83":{},"282":{}},"parent":{}}],["updateresourceforproject",{"_index":78,"name":{"77":{},"260":{}},"parent":{}}],["userapi",{"_index":156,"name":{"155":{},"338":{}},"parent":{"156":{}}}],["userapi.__type",{"_index":158,"name":{},"parent":{"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{}}}],["validatepid",{"_index":62,"name":{"61":{},"244":{}},"parent":{}}],["visibilityapi",{"_index":165,"name":{"164":{},"347":{}},"parent":{"165":{}}}],["visibilityapi.__type",{"_index":167,"name":{},"parent":{"166":{},"167":{},"168":{}}}],["vocabularyapi",{"_index":170,"name":{"169":{},"218":{}},"parent":{"170":{}}}],["vocabularyapi.__type",{"_index":172,"name":{},"parent":{"171":{},"172":{},"173":{},"174":{}}}]],"pipeline":[]}} \ No newline at end of file +window.searchData = {"kinds":{"32":"Variable","1024":"Property","2048":"Method","65536":"Type literal"},"rows":[{"id":0,"kind":32,"name":"AccountApi","url":"modules.html#AccountApi","classes":"tsd-kind-variable"},{"id":1,"kind":65536,"name":"__type","url":"modules.html#AccountApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"AccountApi"},{"id":2,"kind":2048,"name":"accountGetLoginUrls","url":"modules.html#AccountApi.__type.accountGetLoginUrls","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AccountApi.__type"},{"id":3,"kind":2048,"name":"accountLogout","url":"modules.html#AccountApi.__type.accountLogout","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AccountApi.__type"},{"id":4,"kind":32,"name":"AdminApi","url":"modules.html#AdminApi","classes":"tsd-kind-variable"},{"id":5,"kind":65536,"name":"__type","url":"modules.html#AdminApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"AdminApi"},{"id":6,"kind":2048,"name":"adminGetProject","url":"modules.html#AdminApi.__type.adminGetProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AdminApi.__type"},{"id":7,"kind":2048,"name":"adminUpdateQuota","url":"modules.html#AdminApi.__type.adminUpdateQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"AdminApi.__type"},{"id":8,"kind":32,"name":"ApplicationProfileApi","url":"modules.html#ApplicationProfileApi","classes":"tsd-kind-variable"},{"id":9,"kind":65536,"name":"__type","url":"modules.html#ApplicationProfileApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ApplicationProfileApi"},{"id":10,"kind":2048,"name":"apiV2ApplicationProfilesOptions","url":"modules.html#ApplicationProfileApi.__type.apiV2ApplicationProfilesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":11,"kind":2048,"name":"createApplicationProfileRequest","url":"modules.html#ApplicationProfileApi.__type.createApplicationProfileRequest","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":12,"kind":2048,"name":"getApplicationProfile","url":"modules.html#ApplicationProfileApi.__type.getApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":13,"kind":2048,"name":"getApplicationProfiles","url":"modules.html#ApplicationProfileApi.__type.getApplicationProfiles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":14,"kind":2048,"name":"getRawApplicationProfile","url":"modules.html#ApplicationProfileApi.__type.getRawApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ApplicationProfileApi.__type"},{"id":15,"kind":32,"name":"BlobApi","url":"modules.html#BlobApi","classes":"tsd-kind-variable"},{"id":16,"kind":65536,"name":"__type","url":"modules.html#BlobApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"BlobApi"},{"id":17,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","url":"modules.html#BlobApi.__type.apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":18,"kind":2048,"name":"createBlob","url":"modules.html#BlobApi.__type.createBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":19,"kind":2048,"name":"deleteBlob","url":"modules.html#BlobApi.__type.deleteBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":20,"kind":2048,"name":"getBlob","url":"modules.html#BlobApi.__type.getBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":21,"kind":2048,"name":"updateBlob","url":"modules.html#BlobApi.__type.updateBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"BlobApi.__type"},{"id":22,"kind":32,"name":"DisciplineApi","url":"modules.html#DisciplineApi","classes":"tsd-kind-variable"},{"id":23,"kind":65536,"name":"__type","url":"modules.html#DisciplineApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"DisciplineApi"},{"id":24,"kind":2048,"name":"apiV2DisciplinesOptions","url":"modules.html#DisciplineApi.__type.apiV2DisciplinesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"DisciplineApi.__type"},{"id":25,"kind":2048,"name":"getDiscipline","url":"modules.html#DisciplineApi.__type.getDiscipline","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"DisciplineApi.__type"},{"id":26,"kind":2048,"name":"getDisciplines","url":"modules.html#DisciplineApi.__type.getDisciplines","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"DisciplineApi.__type"},{"id":27,"kind":32,"name":"HomeApi","url":"modules.html#HomeApi","classes":"tsd-kind-variable"},{"id":28,"kind":65536,"name":"__type","url":"modules.html#HomeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"HomeApi"},{"id":29,"kind":2048,"name":"homeIndex","url":"modules.html#HomeApi.__type.homeIndex","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"HomeApi.__type"},{"id":30,"kind":32,"name":"LanguageApi","url":"modules.html#LanguageApi","classes":"tsd-kind-variable"},{"id":31,"kind":65536,"name":"__type","url":"modules.html#LanguageApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"LanguageApi"},{"id":32,"kind":2048,"name":"apiV2LanguagesOptions","url":"modules.html#LanguageApi.__type.apiV2LanguagesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LanguageApi.__type"},{"id":33,"kind":2048,"name":"getLanguage","url":"modules.html#LanguageApi.__type.getLanguage","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LanguageApi.__type"},{"id":34,"kind":2048,"name":"getLanguages","url":"modules.html#LanguageApi.__type.getLanguages","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LanguageApi.__type"},{"id":35,"kind":32,"name":"LicenseApi","url":"modules.html#LicenseApi","classes":"tsd-kind-variable"},{"id":36,"kind":65536,"name":"__type","url":"modules.html#LicenseApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"LicenseApi"},{"id":37,"kind":2048,"name":"apiV2LicensesOptions","url":"modules.html#LicenseApi.__type.apiV2LicensesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LicenseApi.__type"},{"id":38,"kind":2048,"name":"getLicense","url":"modules.html#LicenseApi.__type.getLicense","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LicenseApi.__type"},{"id":39,"kind":2048,"name":"getLicenses","url":"modules.html#LicenseApi.__type.getLicenses","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"LicenseApi.__type"},{"id":40,"kind":32,"name":"MaintenanceApi","url":"modules.html#MaintenanceApi","classes":"tsd-kind-variable"},{"id":41,"kind":65536,"name":"__type","url":"modules.html#MaintenanceApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"MaintenanceApi"},{"id":42,"kind":2048,"name":"apiV2MaintenancesOptions","url":"modules.html#MaintenanceApi.__type.apiV2MaintenancesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MaintenanceApi.__type"},{"id":43,"kind":2048,"name":"getCurrentMaintenances","url":"modules.html#MaintenanceApi.__type.getCurrentMaintenances","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MaintenanceApi.__type"},{"id":44,"kind":32,"name":"MergeApi","url":"modules.html#MergeApi","classes":"tsd-kind-variable"},{"id":45,"kind":65536,"name":"__type","url":"modules.html#MergeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"MergeApi"},{"id":46,"kind":2048,"name":"mergeCallback","url":"modules.html#MergeApi.__type.mergeCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MergeApi.__type"},{"id":47,"kind":2048,"name":"mergeLogin","url":"modules.html#MergeApi.__type.mergeLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"MergeApi.__type"},{"id":48,"kind":32,"name":"ORCiDApi","url":"modules.html#ORCiDApi","classes":"tsd-kind-variable"},{"id":49,"kind":65536,"name":"__type","url":"modules.html#ORCiDApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ORCiDApi"},{"id":50,"kind":2048,"name":"oRCiDLoginGET","url":"modules.html#ORCiDApi.__type.oRCiDLoginGET","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ORCiDApi.__type"},{"id":51,"kind":2048,"name":"oRCiDLoginPOST","url":"modules.html#ORCiDApi.__type.oRCiDLoginPOST","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ORCiDApi.__type"},{"id":52,"kind":32,"name":"OrganizationApi","url":"modules.html#OrganizationApi","classes":"tsd-kind-variable"},{"id":53,"kind":65536,"name":"__type","url":"modules.html#OrganizationApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"OrganizationApi"},{"id":54,"kind":2048,"name":"apiV2OrganizationsOptions","url":"modules.html#OrganizationApi.__type.apiV2OrganizationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"OrganizationApi.__type"},{"id":55,"kind":2048,"name":"getOrganization","url":"modules.html#OrganizationApi.__type.getOrganization","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"OrganizationApi.__type"},{"id":56,"kind":2048,"name":"getOrganizations","url":"modules.html#OrganizationApi.__type.getOrganizations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"OrganizationApi.__type"},{"id":57,"kind":32,"name":"PidApi","url":"modules.html#PidApi","classes":"tsd-kind-variable"},{"id":58,"kind":65536,"name":"__type","url":"modules.html#PidApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"PidApi"},{"id":59,"kind":2048,"name":"apiV2PidsOptions","url":"modules.html#PidApi.__type.apiV2PidsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"PidApi.__type"},{"id":60,"kind":2048,"name":"sendRequestToOwner","url":"modules.html#PidApi.__type.sendRequestToOwner","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"PidApi.__type"},{"id":61,"kind":2048,"name":"validatePid","url":"modules.html#PidApi.__type.validatePid","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"PidApi.__type"},{"id":62,"kind":32,"name":"ProjectApi","url":"modules.html#ProjectApi","classes":"tsd-kind-variable"},{"id":63,"kind":65536,"name":"__type","url":"modules.html#ProjectApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectApi"},{"id":64,"kind":2048,"name":"apiV2ProjectsOptions","url":"modules.html#ProjectApi.__type.apiV2ProjectsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":65,"kind":2048,"name":"createProject","url":"modules.html#ProjectApi.__type.createProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":66,"kind":2048,"name":"deleteProject","url":"modules.html#ProjectApi.__type.deleteProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":67,"kind":2048,"name":"getProject","url":"modules.html#ProjectApi.__type.getProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":68,"kind":2048,"name":"getProjects","url":"modules.html#ProjectApi.__type.getProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":69,"kind":2048,"name":"updateProject","url":"modules.html#ProjectApi.__type.updateProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectApi.__type"},{"id":70,"kind":32,"name":"ProjectResourceApi","url":"modules.html#ProjectResourceApi","classes":"tsd-kind-variable"},{"id":71,"kind":65536,"name":"__type","url":"modules.html#ProjectResourceApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectResourceApi"},{"id":72,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesOptions","url":"modules.html#ProjectResourceApi.__type.apiV2ProjectsProjectIdResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":73,"kind":2048,"name":"createResourceForProject","url":"modules.html#ProjectResourceApi.__type.createResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":74,"kind":2048,"name":"deleteResourceForProject","url":"modules.html#ProjectResourceApi.__type.deleteResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":75,"kind":2048,"name":"getResourceForProject","url":"modules.html#ProjectResourceApi.__type.getResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":76,"kind":2048,"name":"getResourcesForProject","url":"modules.html#ProjectResourceApi.__type.getResourcesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":77,"kind":2048,"name":"updateResourceForProject","url":"modules.html#ProjectResourceApi.__type.updateResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceApi.__type"},{"id":78,"kind":32,"name":"ProjectQuotaApi","url":"modules.html#ProjectQuotaApi","classes":"tsd-kind-variable"},{"id":79,"kind":65536,"name":"__type","url":"modules.html#ProjectQuotaApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectQuotaApi"},{"id":80,"kind":2048,"name":"apiV2ProjectsProjectIdQuotasOptions","url":"modules.html#ProjectQuotaApi.__type.apiV2ProjectsProjectIdQuotasOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":81,"kind":2048,"name":"getProjectQuota","url":"modules.html#ProjectQuotaApi.__type.getProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":82,"kind":2048,"name":"getProjectQuotas","url":"modules.html#ProjectQuotaApi.__type.getProjectQuotas","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":83,"kind":2048,"name":"updateProjectQuota","url":"modules.html#ProjectQuotaApi.__type.updateProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectQuotaApi.__type"},{"id":84,"kind":32,"name":"ProjectResourceQuotaApi","url":"modules.html#ProjectResourceQuotaApi","classes":"tsd-kind-variable"},{"id":85,"kind":65536,"name":"__type","url":"modules.html#ProjectResourceQuotaApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectResourceQuotaApi"},{"id":86,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","url":"modules.html#ProjectResourceQuotaApi.__type.apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceQuotaApi.__type"},{"id":87,"kind":2048,"name":"getQuotaForResourceForProject","url":"modules.html#ProjectResourceQuotaApi.__type.getQuotaForResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceQuotaApi.__type"},{"id":88,"kind":32,"name":"ProjectResourceTypeApi","url":"modules.html#ProjectResourceTypeApi","classes":"tsd-kind-variable"},{"id":89,"kind":65536,"name":"__type","url":"modules.html#ProjectResourceTypeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectResourceTypeApi"},{"id":90,"kind":2048,"name":"apiV2ProjectsProjectIdResourceTypesOptions","url":"modules.html#ProjectResourceTypeApi.__type.apiV2ProjectsProjectIdResourceTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceTypeApi.__type"},{"id":91,"kind":2048,"name":"getAvailableResourceTypesInformationForProject","url":"modules.html#ProjectResourceTypeApi.__type.getAvailableResourceTypesInformationForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectResourceTypeApi.__type"},{"id":92,"kind":32,"name":"ProjectInvitationApi","url":"modules.html#ProjectInvitationApi","classes":"tsd-kind-variable"},{"id":93,"kind":65536,"name":"__type","url":"modules.html#ProjectInvitationApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectInvitationApi"},{"id":94,"kind":2048,"name":"apiV2ProjectsProjectIdInvitationsOptions","url":"modules.html#ProjectInvitationApi.__type.apiV2ProjectsProjectIdInvitationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":95,"kind":2048,"name":"createProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.createProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":96,"kind":2048,"name":"deleteProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.deleteProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":97,"kind":2048,"name":"getProjectInvitation","url":"modules.html#ProjectInvitationApi.__type.getProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":98,"kind":2048,"name":"getProjectInvitations","url":"modules.html#ProjectInvitationApi.__type.getProjectInvitations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectInvitationApi.__type"},{"id":99,"kind":32,"name":"ProjectMemberApi","url":"modules.html#ProjectMemberApi","classes":"tsd-kind-variable"},{"id":100,"kind":65536,"name":"__type","url":"modules.html#ProjectMemberApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ProjectMemberApi"},{"id":101,"kind":2048,"name":"addMembership","url":"modules.html#ProjectMemberApi.__type.addMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":102,"kind":2048,"name":"apiV2ProjectsProjectIdMembersOptions","url":"modules.html#ProjectMemberApi.__type.apiV2ProjectsProjectIdMembersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":103,"kind":2048,"name":"deleteMembership","url":"modules.html#ProjectMemberApi.__type.deleteMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":104,"kind":2048,"name":"getMembership","url":"modules.html#ProjectMemberApi.__type.getMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":105,"kind":2048,"name":"getMemberships","url":"modules.html#ProjectMemberApi.__type.getMemberships","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":106,"kind":2048,"name":"updateMembership","url":"modules.html#ProjectMemberApi.__type.updateMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ProjectMemberApi.__type"},{"id":107,"kind":32,"name":"ResourceApi","url":"modules.html#ResourceApi","classes":"tsd-kind-variable"},{"id":108,"kind":65536,"name":"__type","url":"modules.html#ResourceApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ResourceApi"},{"id":109,"kind":2048,"name":"apiV2ResourcesOptions","url":"modules.html#ResourceApi.__type.apiV2ResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceApi.__type"},{"id":110,"kind":2048,"name":"getResource","url":"modules.html#ResourceApi.__type.getResource","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceApi.__type"},{"id":111,"kind":32,"name":"ResourceTypeApi","url":"modules.html#ResourceTypeApi","classes":"tsd-kind-variable"},{"id":112,"kind":65536,"name":"__type","url":"modules.html#ResourceTypeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ResourceTypeApi"},{"id":113,"kind":2048,"name":"apiV2ResourceTypesOptions","url":"modules.html#ResourceTypeApi.__type.apiV2ResourceTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":114,"kind":2048,"name":"getAllGitlabBranchesForProject","url":"modules.html#ResourceTypeApi.__type.getAllGitlabBranchesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":115,"kind":2048,"name":"getAllGitlabProjects","url":"modules.html#ResourceTypeApi.__type.getAllGitlabProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":116,"kind":2048,"name":"getAllResourceTypesInformation","url":"modules.html#ResourceTypeApi.__type.getAllResourceTypesInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":117,"kind":2048,"name":"getGitlabProject","url":"modules.html#ResourceTypeApi.__type.getGitlabProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":118,"kind":2048,"name":"getResourceTypeInformation","url":"modules.html#ResourceTypeApi.__type.getResourceTypeInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ResourceTypeApi.__type"},{"id":119,"kind":32,"name":"RoleApi","url":"modules.html#RoleApi","classes":"tsd-kind-variable"},{"id":120,"kind":65536,"name":"__type","url":"modules.html#RoleApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"RoleApi"},{"id":121,"kind":2048,"name":"apiV2RolesOptions","url":"modules.html#RoleApi.__type.apiV2RolesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"RoleApi.__type"},{"id":122,"kind":2048,"name":"getRole","url":"modules.html#RoleApi.__type.getRole","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"RoleApi.__type"},{"id":123,"kind":2048,"name":"getRoles","url":"modules.html#RoleApi.__type.getRoles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"RoleApi.__type"},{"id":124,"kind":32,"name":"SearchApi","url":"modules.html#SearchApi","classes":"tsd-kind-variable"},{"id":125,"kind":65536,"name":"__type","url":"modules.html#SearchApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"SearchApi"},{"id":126,"kind":2048,"name":"apiV2SearchOptions","url":"modules.html#SearchApi.__type.apiV2SearchOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SearchApi.__type"},{"id":127,"kind":2048,"name":"getSearchResults","url":"modules.html#SearchApi.__type.getSearchResults","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SearchApi.__type"},{"id":128,"kind":32,"name":"ShibbolethApi","url":"modules.html#ShibbolethApi","classes":"tsd-kind-variable"},{"id":129,"kind":65536,"name":"__type","url":"modules.html#ShibbolethApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"ShibbolethApi"},{"id":130,"kind":2048,"name":"shibbolethCallback","url":"modules.html#ShibbolethApi.__type.shibbolethCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ShibbolethApi.__type"},{"id":131,"kind":2048,"name":"shibbolethLogin","url":"modules.html#ShibbolethApi.__type.shibbolethLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"ShibbolethApi.__type"},{"id":132,"kind":32,"name":"TitleApi","url":"modules.html#TitleApi","classes":"tsd-kind-variable"},{"id":133,"kind":65536,"name":"__type","url":"modules.html#TitleApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"TitleApi"},{"id":134,"kind":2048,"name":"apiV2TitlesOptions","url":"modules.html#TitleApi.__type.apiV2TitlesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TitleApi.__type"},{"id":135,"kind":2048,"name":"getTitle","url":"modules.html#TitleApi.__type.getTitle","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TitleApi.__type"},{"id":136,"kind":2048,"name":"getTitles","url":"modules.html#TitleApi.__type.getTitles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TitleApi.__type"},{"id":137,"kind":32,"name":"SelfApi","url":"modules.html#SelfApi","classes":"tsd-kind-variable"},{"id":138,"kind":65536,"name":"__type","url":"modules.html#SelfApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"SelfApi"},{"id":139,"kind":2048,"name":"acceptCurrentTos","url":"modules.html#SelfApi.__type.acceptCurrentTos","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":140,"kind":2048,"name":"apiV2SelfOptions","url":"modules.html#SelfApi.__type.apiV2SelfOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":141,"kind":2048,"name":"confirmUserEmail","url":"modules.html#SelfApi.__type.confirmUserEmail","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":142,"kind":2048,"name":"getCurrentUser","url":"modules.html#SelfApi.__type.getCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":143,"kind":2048,"name":"initiateUserMerge","url":"modules.html#SelfApi.__type.initiateUserMerge","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":144,"kind":2048,"name":"resolveProjectInvitation","url":"modules.html#SelfApi.__type.resolveProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":145,"kind":2048,"name":"updateCurrentUser","url":"modules.html#SelfApi.__type.updateCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApi.__type"},{"id":146,"kind":32,"name":"SelfApiTokenApi","url":"modules.html#SelfApiTokenApi","classes":"tsd-kind-variable"},{"id":147,"kind":65536,"name":"__type","url":"modules.html#SelfApiTokenApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"SelfApiTokenApi"},{"id":148,"kind":2048,"name":"apiV2SelfApiTokensOptions","url":"modules.html#SelfApiTokenApi.__type.apiV2SelfApiTokensOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApiTokenApi.__type"},{"id":149,"kind":2048,"name":"createApiToken","url":"modules.html#SelfApiTokenApi.__type.createApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApiTokenApi.__type"},{"id":150,"kind":2048,"name":"getAllApiTokens","url":"modules.html#SelfApiTokenApi.__type.getAllApiTokens","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApiTokenApi.__type"},{"id":151,"kind":2048,"name":"getApiToken","url":"modules.html#SelfApiTokenApi.__type.getApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApiTokenApi.__type"},{"id":152,"kind":2048,"name":"revokeToken","url":"modules.html#SelfApiTokenApi.__type.revokeToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"SelfApiTokenApi.__type"},{"id":153,"kind":32,"name":"TosApi","url":"modules.html#TosApi","classes":"tsd-kind-variable"},{"id":154,"kind":65536,"name":"__type","url":"modules.html#TosApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"TosApi"},{"id":155,"kind":2048,"name":"apiV2TosOptions","url":"modules.html#TosApi.__type.apiV2TosOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TosApi.__type"},{"id":156,"kind":2048,"name":"getTos","url":"modules.html#TosApi.__type.getTos","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TosApi.__type"},{"id":157,"kind":32,"name":"TreeApi","url":"modules.html#TreeApi","classes":"tsd-kind-variable"},{"id":158,"kind":65536,"name":"__type","url":"modules.html#TreeApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"TreeApi"},{"id":159,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","url":"modules.html#TreeApi.__type.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":160,"kind":2048,"name":"createMetadataTree","url":"modules.html#TreeApi.__type.createMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":161,"kind":2048,"name":"getFileTree","url":"modules.html#TreeApi.__type.getFileTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":162,"kind":2048,"name":"getMetadataTree","url":"modules.html#TreeApi.__type.getMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":163,"kind":2048,"name":"updateMetadataTree","url":"modules.html#TreeApi.__type.updateMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"TreeApi.__type"},{"id":164,"kind":32,"name":"UserApi","url":"modules.html#UserApi","classes":"tsd-kind-variable"},{"id":165,"kind":65536,"name":"__type","url":"modules.html#UserApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"UserApi"},{"id":166,"kind":2048,"name":"apiV2UsersOptions","url":"modules.html#UserApi.__type.apiV2UsersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":167,"kind":2048,"name":"getUsers","url":"modules.html#UserApi.__type.getUsers","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"UserApi.__type"},{"id":168,"kind":32,"name":"VisibilityApi","url":"modules.html#VisibilityApi","classes":"tsd-kind-variable"},{"id":169,"kind":65536,"name":"__type","url":"modules.html#VisibilityApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"VisibilityApi"},{"id":170,"kind":2048,"name":"apiV2VisibilitiesOptions","url":"modules.html#VisibilityApi.__type.apiV2VisibilitiesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VisibilityApi.__type"},{"id":171,"kind":2048,"name":"getVisibilities","url":"modules.html#VisibilityApi.__type.getVisibilities","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VisibilityApi.__type"},{"id":172,"kind":2048,"name":"getVisibility","url":"modules.html#VisibilityApi.__type.getVisibility","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VisibilityApi.__type"},{"id":173,"kind":32,"name":"VocabularyApi","url":"modules.html#VocabularyApi","classes":"tsd-kind-variable"},{"id":174,"kind":65536,"name":"__type","url":"modules.html#VocabularyApi.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"VocabularyApi"},{"id":175,"kind":2048,"name":"apiV2VocabulariesOptions","url":"modules.html#VocabularyApi.__type.apiV2VocabulariesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":176,"kind":2048,"name":"getVocabularies","url":"modules.html#VocabularyApi.__type.getVocabularies","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":177,"kind":2048,"name":"getVocabularyInstance","url":"modules.html#VocabularyApi.__type.getVocabularyInstance","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":178,"kind":2048,"name":"getVocabularyInstances","url":"modules.html#VocabularyApi.__type.getVocabularyInstances","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"VocabularyApi.__type"},{"id":179,"kind":32,"name":"default","url":"modules.html#default","classes":"tsd-kind-variable"},{"id":180,"kind":65536,"name":"__type","url":"modules.html#default.__type","classes":"tsd-kind-type-literal tsd-parent-kind-variable","parent":"default"},{"id":181,"kind":1024,"name":"AccountApi","url":"modules.html#default.__type.AccountApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":182,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":183,"kind":2048,"name":"accountGetLoginUrls","url":"modules.html#default.__type.__type-1.accountGetLoginUrls","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":184,"kind":2048,"name":"accountLogout","url":"modules.html#default.__type.__type-1.accountLogout","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":185,"kind":1024,"name":"AdminApi","url":"modules.html#default.__type.AdminApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":186,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":187,"kind":2048,"name":"adminGetProject","url":"modules.html#default.__type.__type-2.adminGetProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":188,"kind":2048,"name":"adminUpdateQuota","url":"modules.html#default.__type.__type-2.adminUpdateQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":189,"kind":1024,"name":"BlobApi","url":"modules.html#default.__type.BlobApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":190,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":191,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","url":"modules.html#default.__type.__type-4.apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":192,"kind":2048,"name":"createBlob","url":"modules.html#default.__type.__type-4.createBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":193,"kind":2048,"name":"deleteBlob","url":"modules.html#default.__type.__type-4.deleteBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":194,"kind":2048,"name":"getBlob","url":"modules.html#default.__type.__type-4.getBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":195,"kind":2048,"name":"updateBlob","url":"modules.html#default.__type.__type-4.updateBlob","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":196,"kind":1024,"name":"DisciplineApi","url":"modules.html#default.__type.DisciplineApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":197,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-5","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":198,"kind":2048,"name":"apiV2DisciplinesOptions","url":"modules.html#default.__type.__type-5.apiV2DisciplinesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":199,"kind":2048,"name":"getDiscipline","url":"modules.html#default.__type.__type-5.getDiscipline","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":200,"kind":2048,"name":"getDisciplines","url":"modules.html#default.__type.__type-5.getDisciplines","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":201,"kind":1024,"name":"HomeApi","url":"modules.html#default.__type.HomeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":202,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-6","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":203,"kind":2048,"name":"homeIndex","url":"modules.html#default.__type.__type-6.homeIndex","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":204,"kind":1024,"name":"LanguageApi","url":"modules.html#default.__type.LanguageApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":205,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-7","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":206,"kind":2048,"name":"apiV2LanguagesOptions","url":"modules.html#default.__type.__type-7.apiV2LanguagesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":207,"kind":2048,"name":"getLanguage","url":"modules.html#default.__type.__type-7.getLanguage","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":208,"kind":2048,"name":"getLanguages","url":"modules.html#default.__type.__type-7.getLanguages","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":209,"kind":1024,"name":"LicenseApi","url":"modules.html#default.__type.LicenseApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":210,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-8","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":211,"kind":2048,"name":"apiV2LicensesOptions","url":"modules.html#default.__type.__type-8.apiV2LicensesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":212,"kind":2048,"name":"getLicense","url":"modules.html#default.__type.__type-8.getLicense","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":213,"kind":2048,"name":"getLicenses","url":"modules.html#default.__type.__type-8.getLicenses","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":214,"kind":1024,"name":"MaintenanceApi","url":"modules.html#default.__type.MaintenanceApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":215,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-9","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":216,"kind":2048,"name":"apiV2MaintenancesOptions","url":"modules.html#default.__type.__type-9.apiV2MaintenancesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":217,"kind":2048,"name":"getCurrentMaintenances","url":"modules.html#default.__type.__type-9.getCurrentMaintenances","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":218,"kind":1024,"name":"MergeApi","url":"modules.html#default.__type.MergeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":219,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-10","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":220,"kind":2048,"name":"mergeCallback","url":"modules.html#default.__type.__type-10.mergeCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":221,"kind":2048,"name":"mergeLogin","url":"modules.html#default.__type.__type-10.mergeLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":222,"kind":1024,"name":"VocabularyApi","url":"modules.html#default.__type.VocabularyApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":223,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-33","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":224,"kind":2048,"name":"apiV2VocabulariesOptions","url":"modules.html#default.__type.__type-33.apiV2VocabulariesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":225,"kind":2048,"name":"getVocabularies","url":"modules.html#default.__type.__type-33.getVocabularies","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":226,"kind":2048,"name":"getVocabularyInstance","url":"modules.html#default.__type.__type-33.getVocabularyInstance","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":227,"kind":2048,"name":"getVocabularyInstances","url":"modules.html#default.__type.__type-33.getVocabularyInstances","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":228,"kind":1024,"name":"ApplicationProfileApi","url":"modules.html#default.__type.ApplicationProfileApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":229,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":230,"kind":2048,"name":"apiV2ApplicationProfilesOptions","url":"modules.html#default.__type.__type-3.apiV2ApplicationProfilesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":231,"kind":2048,"name":"createApplicationProfileRequest","url":"modules.html#default.__type.__type-3.createApplicationProfileRequest","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":232,"kind":2048,"name":"getApplicationProfile","url":"modules.html#default.__type.__type-3.getApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":233,"kind":2048,"name":"getApplicationProfiles","url":"modules.html#default.__type.__type-3.getApplicationProfiles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":234,"kind":2048,"name":"getRawApplicationProfile","url":"modules.html#default.__type.__type-3.getRawApplicationProfile","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":235,"kind":1024,"name":"ORCiDApi","url":"modules.html#default.__type.ORCiDApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":236,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-11","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":237,"kind":2048,"name":"oRCiDLoginGET","url":"modules.html#default.__type.__type-11.oRCiDLoginGET","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":238,"kind":2048,"name":"oRCiDLoginPOST","url":"modules.html#default.__type.__type-11.oRCiDLoginPOST","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":239,"kind":1024,"name":"OrganizationApi","url":"modules.html#default.__type.OrganizationApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":240,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-12","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":241,"kind":2048,"name":"apiV2OrganizationsOptions","url":"modules.html#default.__type.__type-12.apiV2OrganizationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":242,"kind":2048,"name":"getOrganization","url":"modules.html#default.__type.__type-12.getOrganization","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":243,"kind":2048,"name":"getOrganizations","url":"modules.html#default.__type.__type-12.getOrganizations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":244,"kind":1024,"name":"PidApi","url":"modules.html#default.__type.PidApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":245,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-13","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":246,"kind":2048,"name":"apiV2PidsOptions","url":"modules.html#default.__type.__type-13.apiV2PidsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":247,"kind":2048,"name":"sendRequestToOwner","url":"modules.html#default.__type.__type-13.sendRequestToOwner","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":248,"kind":2048,"name":"validatePid","url":"modules.html#default.__type.__type-13.validatePid","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":249,"kind":1024,"name":"ProjectApi","url":"modules.html#default.__type.ProjectApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":250,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-14","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":251,"kind":2048,"name":"apiV2ProjectsOptions","url":"modules.html#default.__type.__type-14.apiV2ProjectsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":252,"kind":2048,"name":"createProject","url":"modules.html#default.__type.__type-14.createProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":253,"kind":2048,"name":"deleteProject","url":"modules.html#default.__type.__type-14.deleteProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":254,"kind":2048,"name":"getProject","url":"modules.html#default.__type.__type-14.getProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":255,"kind":2048,"name":"getProjects","url":"modules.html#default.__type.__type-14.getProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":256,"kind":2048,"name":"updateProject","url":"modules.html#default.__type.__type-14.updateProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":257,"kind":1024,"name":"ProjectResourceApi","url":"modules.html#default.__type.ProjectResourceApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":258,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-18","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":259,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesOptions","url":"modules.html#default.__type.__type-18.apiV2ProjectsProjectIdResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":260,"kind":2048,"name":"createResourceForProject","url":"modules.html#default.__type.__type-18.createResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":261,"kind":2048,"name":"deleteResourceForProject","url":"modules.html#default.__type.__type-18.deleteResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":262,"kind":2048,"name":"getResourceForProject","url":"modules.html#default.__type.__type-18.getResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":263,"kind":2048,"name":"getResourcesForProject","url":"modules.html#default.__type.__type-18.getResourcesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":264,"kind":2048,"name":"updateResourceForProject","url":"modules.html#default.__type.__type-18.updateResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":265,"kind":1024,"name":"ProjectResourceQuotaApi","url":"modules.html#default.__type.ProjectResourceQuotaApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":266,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-19","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":267,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","url":"modules.html#default.__type.__type-19.apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":268,"kind":2048,"name":"getQuotaForResourceForProject","url":"modules.html#default.__type.__type-19.getQuotaForResourceForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":269,"kind":1024,"name":"ProjectResourceTypeApi","url":"modules.html#default.__type.ProjectResourceTypeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":270,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-20","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":271,"kind":2048,"name":"apiV2ProjectsProjectIdResourceTypesOptions","url":"modules.html#default.__type.__type-20.apiV2ProjectsProjectIdResourceTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":272,"kind":2048,"name":"getAvailableResourceTypesInformationForProject","url":"modules.html#default.__type.__type-20.getAvailableResourceTypesInformationForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":273,"kind":1024,"name":"ProjectInvitationApi","url":"modules.html#default.__type.ProjectInvitationApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":274,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-15","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":275,"kind":2048,"name":"apiV2ProjectsProjectIdInvitationsOptions","url":"modules.html#default.__type.__type-15.apiV2ProjectsProjectIdInvitationsOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":276,"kind":2048,"name":"createProjectInvitation","url":"modules.html#default.__type.__type-15.createProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":277,"kind":2048,"name":"deleteProjectInvitation","url":"modules.html#default.__type.__type-15.deleteProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":278,"kind":2048,"name":"getProjectInvitation","url":"modules.html#default.__type.__type-15.getProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":279,"kind":2048,"name":"getProjectInvitations","url":"modules.html#default.__type.__type-15.getProjectInvitations","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":280,"kind":1024,"name":"ProjectQuotaApi","url":"modules.html#default.__type.ProjectQuotaApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":281,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-17","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":282,"kind":2048,"name":"apiV2ProjectsProjectIdQuotasOptions","url":"modules.html#default.__type.__type-17.apiV2ProjectsProjectIdQuotasOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":283,"kind":2048,"name":"getProjectQuota","url":"modules.html#default.__type.__type-17.getProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":284,"kind":2048,"name":"getProjectQuotas","url":"modules.html#default.__type.__type-17.getProjectQuotas","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":285,"kind":2048,"name":"updateProjectQuota","url":"modules.html#default.__type.__type-17.updateProjectQuota","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":286,"kind":1024,"name":"ProjectMemberApi","url":"modules.html#default.__type.ProjectMemberApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":287,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-16","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":288,"kind":2048,"name":"addMembership","url":"modules.html#default.__type.__type-16.addMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":289,"kind":2048,"name":"apiV2ProjectsProjectIdMembersOptions","url":"modules.html#default.__type.__type-16.apiV2ProjectsProjectIdMembersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":290,"kind":2048,"name":"deleteMembership","url":"modules.html#default.__type.__type-16.deleteMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":291,"kind":2048,"name":"getMembership","url":"modules.html#default.__type.__type-16.getMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":292,"kind":2048,"name":"getMemberships","url":"modules.html#default.__type.__type-16.getMemberships","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":293,"kind":2048,"name":"updateMembership","url":"modules.html#default.__type.__type-16.updateMembership","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":294,"kind":1024,"name":"ResourceApi","url":"modules.html#default.__type.ResourceApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":295,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-21","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":296,"kind":2048,"name":"apiV2ResourcesOptions","url":"modules.html#default.__type.__type-21.apiV2ResourcesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":297,"kind":2048,"name":"getResource","url":"modules.html#default.__type.__type-21.getResource","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":298,"kind":1024,"name":"ResourceTypeApi","url":"modules.html#default.__type.ResourceTypeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":299,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-22","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":300,"kind":2048,"name":"apiV2ResourceTypesOptions","url":"modules.html#default.__type.__type-22.apiV2ResourceTypesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":301,"kind":2048,"name":"getAllGitlabBranchesForProject","url":"modules.html#default.__type.__type-22.getAllGitlabBranchesForProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":302,"kind":2048,"name":"getAllGitlabProjects","url":"modules.html#default.__type.__type-22.getAllGitlabProjects","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":303,"kind":2048,"name":"getAllResourceTypesInformation","url":"modules.html#default.__type.__type-22.getAllResourceTypesInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":304,"kind":2048,"name":"getGitlabProject","url":"modules.html#default.__type.__type-22.getGitlabProject","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":305,"kind":2048,"name":"getResourceTypeInformation","url":"modules.html#default.__type.__type-22.getResourceTypeInformation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":306,"kind":1024,"name":"RoleApi","url":"modules.html#default.__type.RoleApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":307,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-23","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":308,"kind":2048,"name":"apiV2RolesOptions","url":"modules.html#default.__type.__type-23.apiV2RolesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":309,"kind":2048,"name":"getRole","url":"modules.html#default.__type.__type-23.getRole","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":310,"kind":2048,"name":"getRoles","url":"modules.html#default.__type.__type-23.getRoles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":311,"kind":1024,"name":"SearchApi","url":"modules.html#default.__type.SearchApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":312,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-24","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":313,"kind":2048,"name":"apiV2SearchOptions","url":"modules.html#default.__type.__type-24.apiV2SearchOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":314,"kind":2048,"name":"getSearchResults","url":"modules.html#default.__type.__type-24.getSearchResults","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":315,"kind":1024,"name":"ShibbolethApi","url":"modules.html#default.__type.ShibbolethApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":316,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-27","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":317,"kind":2048,"name":"shibbolethCallback","url":"modules.html#default.__type.__type-27.shibbolethCallback","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":318,"kind":2048,"name":"shibbolethLogin","url":"modules.html#default.__type.__type-27.shibbolethLogin","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":319,"kind":1024,"name":"TitleApi","url":"modules.html#default.__type.TitleApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":320,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-28","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":321,"kind":2048,"name":"apiV2TitlesOptions","url":"modules.html#default.__type.__type-28.apiV2TitlesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":322,"kind":2048,"name":"getTitle","url":"modules.html#default.__type.__type-28.getTitle","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":323,"kind":2048,"name":"getTitles","url":"modules.html#default.__type.__type-28.getTitles","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":324,"kind":1024,"name":"SelfApiTokenApi","url":"modules.html#default.__type.SelfApiTokenApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":325,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-26","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":326,"kind":2048,"name":"apiV2SelfApiTokensOptions","url":"modules.html#default.__type.__type-26.apiV2SelfApiTokensOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":327,"kind":2048,"name":"createApiToken","url":"modules.html#default.__type.__type-26.createApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":328,"kind":2048,"name":"getAllApiTokens","url":"modules.html#default.__type.__type-26.getAllApiTokens","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":329,"kind":2048,"name":"getApiToken","url":"modules.html#default.__type.__type-26.getApiToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":330,"kind":2048,"name":"revokeToken","url":"modules.html#default.__type.__type-26.revokeToken","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":331,"kind":1024,"name":"SelfApi","url":"modules.html#default.__type.SelfApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":332,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-25","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":333,"kind":2048,"name":"acceptCurrentTos","url":"modules.html#default.__type.__type-25.acceptCurrentTos","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":334,"kind":2048,"name":"apiV2SelfOptions","url":"modules.html#default.__type.__type-25.apiV2SelfOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":335,"kind":2048,"name":"confirmUserEmail","url":"modules.html#default.__type.__type-25.confirmUserEmail","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":336,"kind":2048,"name":"getCurrentUser","url":"modules.html#default.__type.__type-25.getCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":337,"kind":2048,"name":"initiateUserMerge","url":"modules.html#default.__type.__type-25.initiateUserMerge","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":338,"kind":2048,"name":"resolveProjectInvitation","url":"modules.html#default.__type.__type-25.resolveProjectInvitation","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":339,"kind":2048,"name":"updateCurrentUser","url":"modules.html#default.__type.__type-25.updateCurrentUser","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":340,"kind":1024,"name":"TosApi","url":"modules.html#default.__type.TosApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":341,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-29","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":342,"kind":2048,"name":"apiV2TosOptions","url":"modules.html#default.__type.__type-29.apiV2TosOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":343,"kind":2048,"name":"getTos","url":"modules.html#default.__type.__type-29.getTos","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":344,"kind":1024,"name":"TreeApi","url":"modules.html#default.__type.TreeApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":345,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-30","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":346,"kind":2048,"name":"apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","url":"modules.html#default.__type.__type-30.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":347,"kind":2048,"name":"createMetadataTree","url":"modules.html#default.__type.__type-30.createMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":348,"kind":2048,"name":"getFileTree","url":"modules.html#default.__type.__type-30.getFileTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":349,"kind":2048,"name":"getMetadataTree","url":"modules.html#default.__type.__type-30.getMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":350,"kind":2048,"name":"updateMetadataTree","url":"modules.html#default.__type.__type-30.updateMetadataTree","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":351,"kind":1024,"name":"UserApi","url":"modules.html#default.__type.UserApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":352,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-31","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":353,"kind":2048,"name":"apiV2UsersOptions","url":"modules.html#default.__type.__type-31.apiV2UsersOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":354,"kind":2048,"name":"getUsers","url":"modules.html#default.__type.__type-31.getUsers","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":355,"kind":1024,"name":"VisibilityApi","url":"modules.html#default.__type.VisibilityApi","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":"default.__type"},{"id":356,"kind":65536,"name":"__type","url":"modules.html#default.__type.__type-32","classes":"tsd-kind-type-literal tsd-parent-kind-type-literal","parent":"default.__type"},{"id":357,"kind":2048,"name":"apiV2VisibilitiesOptions","url":"modules.html#default.__type.__type-32.apiV2VisibilitiesOptions","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":358,"kind":2048,"name":"getVisibilities","url":"modules.html#default.__type.__type-32.getVisibilities","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"},{"id":359,"kind":2048,"name":"getVisibility","url":"modules.html#default.__type.__type-32.getVisibility","classes":"tsd-kind-method tsd-parent-kind-type-literal","parent":"default.__type.__type"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,46.361]],["parent/0",[]],["name/1",[1,16.768]],["parent/1",[0,4.446]],["name/2",[2,49.726]],["parent/2",[3,4.769]],["name/3",[4,49.726]],["parent/3",[3,4.769]],["name/4",[5,46.361]],["parent/4",[]],["name/5",[1,16.768]],["parent/5",[5,4.446]],["name/6",[6,49.726]],["parent/6",[7,4.769]],["name/7",[8,49.726]],["parent/7",[7,4.769]],["name/8",[9,46.361]],["parent/8",[]],["name/9",[1,16.768]],["parent/9",[9,4.446]],["name/10",[10,49.726]],["parent/10",[11,4.013]],["name/11",[12,49.726]],["parent/11",[11,4.013]],["name/12",[13,49.726]],["parent/12",[11,4.013]],["name/13",[14,49.726]],["parent/13",[11,4.013]],["name/14",[15,49.726]],["parent/14",[11,4.013]],["name/15",[16,46.361]],["parent/15",[]],["name/16",[1,16.768]],["parent/16",[16,4.446]],["name/17",[17,49.726]],["parent/17",[18,4.013]],["name/18",[19,49.726]],["parent/18",[18,4.013]],["name/19",[20,49.726]],["parent/19",[18,4.013]],["name/20",[21,49.726]],["parent/20",[18,4.013]],["name/21",[22,49.726]],["parent/21",[18,4.013]],["name/22",[23,46.361]],["parent/22",[]],["name/23",[1,16.768]],["parent/23",[23,4.446]],["name/24",[24,49.726]],["parent/24",[25,4.446]],["name/25",[26,49.726]],["parent/25",[25,4.446]],["name/26",[27,49.726]],["parent/26",[25,4.446]],["name/27",[28,46.361]],["parent/27",[]],["name/28",[1,16.768]],["parent/28",[28,4.446]],["name/29",[29,49.726]],["parent/29",[30,5.259]],["name/30",[31,46.361]],["parent/30",[]],["name/31",[1,16.768]],["parent/31",[31,4.446]],["name/32",[32,49.726]],["parent/32",[33,4.446]],["name/33",[34,49.726]],["parent/33",[33,4.446]],["name/34",[35,49.726]],["parent/34",[33,4.446]],["name/35",[36,46.361]],["parent/35",[]],["name/36",[1,16.768]],["parent/36",[36,4.446]],["name/37",[37,49.726]],["parent/37",[38,4.446]],["name/38",[39,49.726]],["parent/38",[38,4.446]],["name/39",[40,49.726]],["parent/39",[38,4.446]],["name/40",[41,46.361]],["parent/40",[]],["name/41",[1,16.768]],["parent/41",[41,4.446]],["name/42",[42,49.726]],["parent/42",[43,4.769]],["name/43",[44,49.726]],["parent/43",[43,4.769]],["name/44",[45,46.361]],["parent/44",[]],["name/45",[1,16.768]],["parent/45",[45,4.446]],["name/46",[46,49.726]],["parent/46",[47,4.769]],["name/47",[48,49.726]],["parent/47",[47,4.769]],["name/48",[49,46.361]],["parent/48",[]],["name/49",[1,16.768]],["parent/49",[49,4.446]],["name/50",[50,49.726]],["parent/50",[51,4.769]],["name/51",[52,49.726]],["parent/51",[51,4.769]],["name/52",[53,46.361]],["parent/52",[]],["name/53",[1,16.768]],["parent/53",[53,4.446]],["name/54",[54,49.726]],["parent/54",[55,4.446]],["name/55",[56,49.726]],["parent/55",[55,4.446]],["name/56",[57,49.726]],["parent/56",[55,4.446]],["name/57",[58,46.361]],["parent/57",[]],["name/58",[1,16.768]],["parent/58",[58,4.446]],["name/59",[59,49.726]],["parent/59",[60,4.446]],["name/60",[61,49.726]],["parent/60",[60,4.446]],["name/61",[62,49.726]],["parent/61",[60,4.446]],["name/62",[63,46.361]],["parent/62",[]],["name/63",[1,16.768]],["parent/63",[63,4.446]],["name/64",[64,49.726]],["parent/64",[65,3.853]],["name/65",[66,49.726]],["parent/65",[65,3.853]],["name/66",[67,49.726]],["parent/66",[65,3.853]],["name/67",[68,49.726]],["parent/67",[65,3.853]],["name/68",[69,49.726]],["parent/68",[65,3.853]],["name/69",[70,49.726]],["parent/69",[65,3.853]],["name/70",[71,46.361]],["parent/70",[]],["name/71",[1,16.768]],["parent/71",[71,4.446]],["name/72",[72,49.726]],["parent/72",[73,3.853]],["name/73",[74,49.726]],["parent/73",[73,3.853]],["name/74",[75,49.726]],["parent/74",[73,3.853]],["name/75",[76,49.726]],["parent/75",[73,3.853]],["name/76",[77,49.726]],["parent/76",[73,3.853]],["name/77",[78,49.726]],["parent/77",[73,3.853]],["name/78",[79,46.361]],["parent/78",[]],["name/79",[1,16.768]],["parent/79",[79,4.446]],["name/80",[80,49.726]],["parent/80",[81,4.205]],["name/81",[82,49.726]],["parent/81",[81,4.205]],["name/82",[83,49.726]],["parent/82",[81,4.205]],["name/83",[84,49.726]],["parent/83",[81,4.205]],["name/84",[85,46.361]],["parent/84",[]],["name/85",[1,16.768]],["parent/85",[85,4.446]],["name/86",[86,49.726]],["parent/86",[87,4.769]],["name/87",[88,49.726]],["parent/87",[87,4.769]],["name/88",[89,46.361]],["parent/88",[]],["name/89",[1,16.768]],["parent/89",[89,4.446]],["name/90",[90,49.726]],["parent/90",[91,4.769]],["name/91",[92,49.726]],["parent/91",[91,4.769]],["name/92",[93,46.361]],["parent/92",[]],["name/93",[1,16.768]],["parent/93",[93,4.446]],["name/94",[94,49.726]],["parent/94",[95,4.013]],["name/95",[96,49.726]],["parent/95",[95,4.013]],["name/96",[97,49.726]],["parent/96",[95,4.013]],["name/97",[98,49.726]],["parent/97",[95,4.013]],["name/98",[99,49.726]],["parent/98",[95,4.013]],["name/99",[100,46.361]],["parent/99",[]],["name/100",[1,16.768]],["parent/100",[100,4.446]],["name/101",[101,49.726]],["parent/101",[102,3.853]],["name/102",[103,49.726]],["parent/102",[102,3.853]],["name/103",[104,49.726]],["parent/103",[102,3.853]],["name/104",[105,49.726]],["parent/104",[102,3.853]],["name/105",[106,49.726]],["parent/105",[102,3.853]],["name/106",[107,49.726]],["parent/106",[102,3.853]],["name/107",[108,46.361]],["parent/107",[]],["name/108",[1,16.768]],["parent/108",[108,4.446]],["name/109",[109,49.726]],["parent/109",[110,4.769]],["name/110",[111,49.726]],["parent/110",[110,4.769]],["name/111",[112,46.361]],["parent/111",[]],["name/112",[1,16.768]],["parent/112",[112,4.446]],["name/113",[113,49.726]],["parent/113",[114,3.853]],["name/114",[115,49.726]],["parent/114",[114,3.853]],["name/115",[116,49.726]],["parent/115",[114,3.853]],["name/116",[117,49.726]],["parent/116",[114,3.853]],["name/117",[118,49.726]],["parent/117",[114,3.853]],["name/118",[119,49.726]],["parent/118",[114,3.853]],["name/119",[120,46.361]],["parent/119",[]],["name/120",[1,16.768]],["parent/120",[120,4.446]],["name/121",[121,49.726]],["parent/121",[122,4.446]],["name/122",[123,49.726]],["parent/122",[122,4.446]],["name/123",[124,49.726]],["parent/123",[122,4.446]],["name/124",[125,46.361]],["parent/124",[]],["name/125",[1,16.768]],["parent/125",[125,4.446]],["name/126",[126,49.726]],["parent/126",[127,4.769]],["name/127",[128,49.726]],["parent/127",[127,4.769]],["name/128",[129,46.361]],["parent/128",[]],["name/129",[1,16.768]],["parent/129",[129,4.446]],["name/130",[130,49.726]],["parent/130",[131,4.769]],["name/131",[132,49.726]],["parent/131",[131,4.769]],["name/132",[133,46.361]],["parent/132",[]],["name/133",[1,16.768]],["parent/133",[133,4.446]],["name/134",[134,49.726]],["parent/134",[135,4.446]],["name/135",[136,49.726]],["parent/135",[135,4.446]],["name/136",[137,49.726]],["parent/136",[135,4.446]],["name/137",[138,46.361]],["parent/137",[]],["name/138",[1,16.768]],["parent/138",[138,4.446]],["name/139",[139,49.726]],["parent/139",[140,3.715]],["name/140",[141,49.726]],["parent/140",[140,3.715]],["name/141",[142,49.726]],["parent/141",[140,3.715]],["name/142",[143,49.726]],["parent/142",[140,3.715]],["name/143",[144,49.726]],["parent/143",[140,3.715]],["name/144",[145,49.726]],["parent/144",[140,3.715]],["name/145",[146,49.726]],["parent/145",[140,3.715]],["name/146",[147,46.361]],["parent/146",[]],["name/147",[1,16.768]],["parent/147",[147,4.446]],["name/148",[148,49.726]],["parent/148",[149,4.013]],["name/149",[150,49.726]],["parent/149",[149,4.013]],["name/150",[151,49.726]],["parent/150",[149,4.013]],["name/151",[152,49.726]],["parent/151",[149,4.013]],["name/152",[153,49.726]],["parent/152",[149,4.013]],["name/153",[154,46.361]],["parent/153",[]],["name/154",[1,16.768]],["parent/154",[154,4.446]],["name/155",[155,49.726]],["parent/155",[156,4.769]],["name/156",[157,49.726]],["parent/156",[156,4.769]],["name/157",[158,46.361]],["parent/157",[]],["name/158",[1,16.768]],["parent/158",[158,4.446]],["name/159",[159,49.726]],["parent/159",[160,4.013]],["name/160",[161,49.726]],["parent/160",[160,4.013]],["name/161",[162,49.726]],["parent/161",[160,4.013]],["name/162",[163,49.726]],["parent/162",[160,4.013]],["name/163",[164,49.726]],["parent/163",[160,4.013]],["name/164",[165,46.361]],["parent/164",[]],["name/165",[1,16.768]],["parent/165",[165,4.446]],["name/166",[166,49.726]],["parent/166",[167,4.769]],["name/167",[168,49.726]],["parent/167",[167,4.769]],["name/168",[169,46.361]],["parent/168",[]],["name/169",[1,16.768]],["parent/169",[169,4.446]],["name/170",[170,49.726]],["parent/170",[171,4.446]],["name/171",[172,49.726]],["parent/171",[171,4.446]],["name/172",[173,49.726]],["parent/172",[171,4.446]],["name/173",[174,46.361]],["parent/173",[]],["name/174",[1,16.768]],["parent/174",[174,4.446]],["name/175",[175,49.726]],["parent/175",[176,4.205]],["name/176",[177,49.726]],["parent/176",[176,4.205]],["name/177",[178,49.726]],["parent/177",[176,4.205]],["name/178",[179,49.726]],["parent/178",[176,4.205]],["name/179",[180,49.726]],["parent/179",[]],["name/180",[1,16.768]],["parent/180",[180,4.769]],["name/181",[0,46.361]],["parent/181",[181,1.622]],["name/182",[1,16.768]],["parent/182",[181,1.622]],["name/183",[2,49.726]],["parent/183",[182,1.11]],["name/184",[4,49.726]],["parent/184",[182,1.11]],["name/185",[5,46.361]],["parent/185",[181,1.622]],["name/186",[1,16.768]],["parent/186",[181,1.622]],["name/187",[6,49.726]],["parent/187",[182,1.11]],["name/188",[8,49.726]],["parent/188",[182,1.11]],["name/189",[16,46.361]],["parent/189",[181,1.622]],["name/190",[1,16.768]],["parent/190",[181,1.622]],["name/191",[17,49.726]],["parent/191",[182,1.11]],["name/192",[19,49.726]],["parent/192",[182,1.11]],["name/193",[20,49.726]],["parent/193",[182,1.11]],["name/194",[21,49.726]],["parent/194",[182,1.11]],["name/195",[22,49.726]],["parent/195",[182,1.11]],["name/196",[23,46.361]],["parent/196",[181,1.622]],["name/197",[1,16.768]],["parent/197",[181,1.622]],["name/198",[24,49.726]],["parent/198",[182,1.11]],["name/199",[26,49.726]],["parent/199",[182,1.11]],["name/200",[27,49.726]],["parent/200",[182,1.11]],["name/201",[28,46.361]],["parent/201",[181,1.622]],["name/202",[1,16.768]],["parent/202",[181,1.622]],["name/203",[29,49.726]],["parent/203",[182,1.11]],["name/204",[31,46.361]],["parent/204",[181,1.622]],["name/205",[1,16.768]],["parent/205",[181,1.622]],["name/206",[32,49.726]],["parent/206",[182,1.11]],["name/207",[34,49.726]],["parent/207",[182,1.11]],["name/208",[35,49.726]],["parent/208",[182,1.11]],["name/209",[36,46.361]],["parent/209",[181,1.622]],["name/210",[1,16.768]],["parent/210",[181,1.622]],["name/211",[37,49.726]],["parent/211",[182,1.11]],["name/212",[39,49.726]],["parent/212",[182,1.11]],["name/213",[40,49.726]],["parent/213",[182,1.11]],["name/214",[41,46.361]],["parent/214",[181,1.622]],["name/215",[1,16.768]],["parent/215",[181,1.622]],["name/216",[42,49.726]],["parent/216",[182,1.11]],["name/217",[44,49.726]],["parent/217",[182,1.11]],["name/218",[45,46.361]],["parent/218",[181,1.622]],["name/219",[1,16.768]],["parent/219",[181,1.622]],["name/220",[46,49.726]],["parent/220",[182,1.11]],["name/221",[48,49.726]],["parent/221",[182,1.11]],["name/222",[174,46.361]],["parent/222",[181,1.622]],["name/223",[1,16.768]],["parent/223",[181,1.622]],["name/224",[175,49.726]],["parent/224",[182,1.11]],["name/225",[177,49.726]],["parent/225",[182,1.11]],["name/226",[178,49.726]],["parent/226",[182,1.11]],["name/227",[179,49.726]],["parent/227",[182,1.11]],["name/228",[9,46.361]],["parent/228",[181,1.622]],["name/229",[1,16.768]],["parent/229",[181,1.622]],["name/230",[10,49.726]],["parent/230",[182,1.11]],["name/231",[12,49.726]],["parent/231",[182,1.11]],["name/232",[13,49.726]],["parent/232",[182,1.11]],["name/233",[14,49.726]],["parent/233",[182,1.11]],["name/234",[15,49.726]],["parent/234",[182,1.11]],["name/235",[49,46.361]],["parent/235",[181,1.622]],["name/236",[1,16.768]],["parent/236",[181,1.622]],["name/237",[50,49.726]],["parent/237",[182,1.11]],["name/238",[52,49.726]],["parent/238",[182,1.11]],["name/239",[53,46.361]],["parent/239",[181,1.622]],["name/240",[1,16.768]],["parent/240",[181,1.622]],["name/241",[54,49.726]],["parent/241",[182,1.11]],["name/242",[56,49.726]],["parent/242",[182,1.11]],["name/243",[57,49.726]],["parent/243",[182,1.11]],["name/244",[58,46.361]],["parent/244",[181,1.622]],["name/245",[1,16.768]],["parent/245",[181,1.622]],["name/246",[59,49.726]],["parent/246",[182,1.11]],["name/247",[61,49.726]],["parent/247",[182,1.11]],["name/248",[62,49.726]],["parent/248",[182,1.11]],["name/249",[63,46.361]],["parent/249",[181,1.622]],["name/250",[1,16.768]],["parent/250",[181,1.622]],["name/251",[64,49.726]],["parent/251",[182,1.11]],["name/252",[66,49.726]],["parent/252",[182,1.11]],["name/253",[67,49.726]],["parent/253",[182,1.11]],["name/254",[68,49.726]],["parent/254",[182,1.11]],["name/255",[69,49.726]],["parent/255",[182,1.11]],["name/256",[70,49.726]],["parent/256",[182,1.11]],["name/257",[71,46.361]],["parent/257",[181,1.622]],["name/258",[1,16.768]],["parent/258",[181,1.622]],["name/259",[72,49.726]],["parent/259",[182,1.11]],["name/260",[74,49.726]],["parent/260",[182,1.11]],["name/261",[75,49.726]],["parent/261",[182,1.11]],["name/262",[76,49.726]],["parent/262",[182,1.11]],["name/263",[77,49.726]],["parent/263",[182,1.11]],["name/264",[78,49.726]],["parent/264",[182,1.11]],["name/265",[85,46.361]],["parent/265",[181,1.622]],["name/266",[1,16.768]],["parent/266",[181,1.622]],["name/267",[86,49.726]],["parent/267",[182,1.11]],["name/268",[88,49.726]],["parent/268",[182,1.11]],["name/269",[89,46.361]],["parent/269",[181,1.622]],["name/270",[1,16.768]],["parent/270",[181,1.622]],["name/271",[90,49.726]],["parent/271",[182,1.11]],["name/272",[92,49.726]],["parent/272",[182,1.11]],["name/273",[93,46.361]],["parent/273",[181,1.622]],["name/274",[1,16.768]],["parent/274",[181,1.622]],["name/275",[94,49.726]],["parent/275",[182,1.11]],["name/276",[96,49.726]],["parent/276",[182,1.11]],["name/277",[97,49.726]],["parent/277",[182,1.11]],["name/278",[98,49.726]],["parent/278",[182,1.11]],["name/279",[99,49.726]],["parent/279",[182,1.11]],["name/280",[79,46.361]],["parent/280",[181,1.622]],["name/281",[1,16.768]],["parent/281",[181,1.622]],["name/282",[80,49.726]],["parent/282",[182,1.11]],["name/283",[82,49.726]],["parent/283",[182,1.11]],["name/284",[83,49.726]],["parent/284",[182,1.11]],["name/285",[84,49.726]],["parent/285",[182,1.11]],["name/286",[100,46.361]],["parent/286",[181,1.622]],["name/287",[1,16.768]],["parent/287",[181,1.622]],["name/288",[101,49.726]],["parent/288",[182,1.11]],["name/289",[103,49.726]],["parent/289",[182,1.11]],["name/290",[104,49.726]],["parent/290",[182,1.11]],["name/291",[105,49.726]],["parent/291",[182,1.11]],["name/292",[106,49.726]],["parent/292",[182,1.11]],["name/293",[107,49.726]],["parent/293",[182,1.11]],["name/294",[108,46.361]],["parent/294",[181,1.622]],["name/295",[1,16.768]],["parent/295",[181,1.622]],["name/296",[109,49.726]],["parent/296",[182,1.11]],["name/297",[111,49.726]],["parent/297",[182,1.11]],["name/298",[112,46.361]],["parent/298",[181,1.622]],["name/299",[1,16.768]],["parent/299",[181,1.622]],["name/300",[113,49.726]],["parent/300",[182,1.11]],["name/301",[115,49.726]],["parent/301",[182,1.11]],["name/302",[116,49.726]],["parent/302",[182,1.11]],["name/303",[117,49.726]],["parent/303",[182,1.11]],["name/304",[118,49.726]],["parent/304",[182,1.11]],["name/305",[119,49.726]],["parent/305",[182,1.11]],["name/306",[120,46.361]],["parent/306",[181,1.622]],["name/307",[1,16.768]],["parent/307",[181,1.622]],["name/308",[121,49.726]],["parent/308",[182,1.11]],["name/309",[123,49.726]],["parent/309",[182,1.11]],["name/310",[124,49.726]],["parent/310",[182,1.11]],["name/311",[125,46.361]],["parent/311",[181,1.622]],["name/312",[1,16.768]],["parent/312",[181,1.622]],["name/313",[126,49.726]],["parent/313",[182,1.11]],["name/314",[128,49.726]],["parent/314",[182,1.11]],["name/315",[129,46.361]],["parent/315",[181,1.622]],["name/316",[1,16.768]],["parent/316",[181,1.622]],["name/317",[130,49.726]],["parent/317",[182,1.11]],["name/318",[132,49.726]],["parent/318",[182,1.11]],["name/319",[133,46.361]],["parent/319",[181,1.622]],["name/320",[1,16.768]],["parent/320",[181,1.622]],["name/321",[134,49.726]],["parent/321",[182,1.11]],["name/322",[136,49.726]],["parent/322",[182,1.11]],["name/323",[137,49.726]],["parent/323",[182,1.11]],["name/324",[147,46.361]],["parent/324",[181,1.622]],["name/325",[1,16.768]],["parent/325",[181,1.622]],["name/326",[148,49.726]],["parent/326",[182,1.11]],["name/327",[150,49.726]],["parent/327",[182,1.11]],["name/328",[151,49.726]],["parent/328",[182,1.11]],["name/329",[152,49.726]],["parent/329",[182,1.11]],["name/330",[153,49.726]],["parent/330",[182,1.11]],["name/331",[138,46.361]],["parent/331",[181,1.622]],["name/332",[1,16.768]],["parent/332",[181,1.622]],["name/333",[139,49.726]],["parent/333",[182,1.11]],["name/334",[141,49.726]],["parent/334",[182,1.11]],["name/335",[142,49.726]],["parent/335",[182,1.11]],["name/336",[143,49.726]],["parent/336",[182,1.11]],["name/337",[144,49.726]],["parent/337",[182,1.11]],["name/338",[145,49.726]],["parent/338",[182,1.11]],["name/339",[146,49.726]],["parent/339",[182,1.11]],["name/340",[154,46.361]],["parent/340",[181,1.622]],["name/341",[1,16.768]],["parent/341",[181,1.622]],["name/342",[155,49.726]],["parent/342",[182,1.11]],["name/343",[157,49.726]],["parent/343",[182,1.11]],["name/344",[158,46.361]],["parent/344",[181,1.622]],["name/345",[1,16.768]],["parent/345",[181,1.622]],["name/346",[159,49.726]],["parent/346",[182,1.11]],["name/347",[161,49.726]],["parent/347",[182,1.11]],["name/348",[162,49.726]],["parent/348",[182,1.11]],["name/349",[163,49.726]],["parent/349",[182,1.11]],["name/350",[164,49.726]],["parent/350",[182,1.11]],["name/351",[165,46.361]],["parent/351",[181,1.622]],["name/352",[1,16.768]],["parent/352",[181,1.622]],["name/353",[166,49.726]],["parent/353",[182,1.11]],["name/354",[168,49.726]],["parent/354",[182,1.11]],["name/355",[169,46.361]],["parent/355",[181,1.622]],["name/356",[1,16.768]],["parent/356",[181,1.622]],["name/357",[170,49.726]],["parent/357",[182,1.11]],["name/358",[172,49.726]],["parent/358",[182,1.11]],["name/359",[173,49.726]],["parent/359",[182,1.11]]],"invertedIndex":[["__type",{"_index":1,"name":{"1":{},"5":{},"9":{},"16":{},"23":{},"28":{},"31":{},"36":{},"41":{},"45":{},"49":{},"53":{},"58":{},"63":{},"71":{},"79":{},"85":{},"89":{},"93":{},"100":{},"108":{},"112":{},"120":{},"125":{},"129":{},"133":{},"138":{},"147":{},"154":{},"158":{},"165":{},"169":{},"174":{},"180":{},"182":{},"186":{},"190":{},"197":{},"202":{},"205":{},"210":{},"215":{},"219":{},"223":{},"229":{},"236":{},"240":{},"245":{},"250":{},"258":{},"266":{},"270":{},"274":{},"281":{},"287":{},"295":{},"299":{},"307":{},"312":{},"316":{},"320":{},"325":{},"332":{},"341":{},"345":{},"352":{},"356":{}},"parent":{}}],["acceptcurrenttos",{"_index":139,"name":{"139":{},"333":{}},"parent":{}}],["accountapi",{"_index":0,"name":{"0":{},"181":{}},"parent":{"1":{}}}],["accountapi.__type",{"_index":3,"name":{},"parent":{"2":{},"3":{}}}],["accountgetloginurls",{"_index":2,"name":{"2":{},"183":{}},"parent":{}}],["accountlogout",{"_index":4,"name":{"3":{},"184":{}},"parent":{}}],["addmembership",{"_index":101,"name":{"101":{},"288":{}},"parent":{}}],["adminapi",{"_index":5,"name":{"4":{},"185":{}},"parent":{"5":{}}}],["adminapi.__type",{"_index":7,"name":{},"parent":{"6":{},"7":{}}}],["admingetproject",{"_index":6,"name":{"6":{},"187":{}},"parent":{}}],["adminupdatequota",{"_index":8,"name":{"7":{},"188":{}},"parent":{}}],["apiv2applicationprofilesoptions",{"_index":10,"name":{"10":{},"230":{}},"parent":{}}],["apiv2disciplinesoptions",{"_index":24,"name":{"24":{},"198":{}},"parent":{}}],["apiv2languagesoptions",{"_index":32,"name":{"32":{},"206":{}},"parent":{}}],["apiv2licensesoptions",{"_index":37,"name":{"37":{},"211":{}},"parent":{}}],["apiv2maintenancesoptions",{"_index":42,"name":{"42":{},"216":{}},"parent":{}}],["apiv2organizationsoptions",{"_index":54,"name":{"54":{},"241":{}},"parent":{}}],["apiv2pidsoptions",{"_index":59,"name":{"59":{},"246":{}},"parent":{}}],["apiv2projectsoptions",{"_index":64,"name":{"64":{},"251":{}},"parent":{}}],["apiv2projectsprojectidinvitationsoptions",{"_index":94,"name":{"94":{},"275":{}},"parent":{}}],["apiv2projectsprojectidmembersoptions",{"_index":103,"name":{"102":{},"289":{}},"parent":{}}],["apiv2projectsprojectidquotasoptions",{"_index":80,"name":{"80":{},"282":{}},"parent":{}}],["apiv2projectsprojectidresourcesoptions",{"_index":72,"name":{"72":{},"259":{}},"parent":{}}],["apiv2projectsprojectidresourcesresourceidblobsoptions",{"_index":17,"name":{"17":{},"191":{}},"parent":{}}],["apiv2projectsprojectidresourcesresourceidquotaoptions",{"_index":86,"name":{"86":{},"267":{}},"parent":{}}],["apiv2projectsprojectidresourcesresourceidtreesoptions",{"_index":159,"name":{"159":{},"346":{}},"parent":{}}],["apiv2projectsprojectidresourcetypesoptions",{"_index":90,"name":{"90":{},"271":{}},"parent":{}}],["apiv2resourcesoptions",{"_index":109,"name":{"109":{},"296":{}},"parent":{}}],["apiv2resourcetypesoptions",{"_index":113,"name":{"113":{},"300":{}},"parent":{}}],["apiv2rolesoptions",{"_index":121,"name":{"121":{},"308":{}},"parent":{}}],["apiv2searchoptions",{"_index":126,"name":{"126":{},"313":{}},"parent":{}}],["apiv2selfapitokensoptions",{"_index":148,"name":{"148":{},"326":{}},"parent":{}}],["apiv2selfoptions",{"_index":141,"name":{"140":{},"334":{}},"parent":{}}],["apiv2titlesoptions",{"_index":134,"name":{"134":{},"321":{}},"parent":{}}],["apiv2tosoptions",{"_index":155,"name":{"155":{},"342":{}},"parent":{}}],["apiv2usersoptions",{"_index":166,"name":{"166":{},"353":{}},"parent":{}}],["apiv2visibilitiesoptions",{"_index":170,"name":{"170":{},"357":{}},"parent":{}}],["apiv2vocabulariesoptions",{"_index":175,"name":{"175":{},"224":{}},"parent":{}}],["applicationprofileapi",{"_index":9,"name":{"8":{},"228":{}},"parent":{"9":{}}}],["applicationprofileapi.__type",{"_index":11,"name":{},"parent":{"10":{},"11":{},"12":{},"13":{},"14":{}}}],["blobapi",{"_index":16,"name":{"15":{},"189":{}},"parent":{"16":{}}}],["blobapi.__type",{"_index":18,"name":{},"parent":{"17":{},"18":{},"19":{},"20":{},"21":{}}}],["confirmuseremail",{"_index":142,"name":{"141":{},"335":{}},"parent":{}}],["createapitoken",{"_index":150,"name":{"149":{},"327":{}},"parent":{}}],["createapplicationprofilerequest",{"_index":12,"name":{"11":{},"231":{}},"parent":{}}],["createblob",{"_index":19,"name":{"18":{},"192":{}},"parent":{}}],["createmetadatatree",{"_index":161,"name":{"160":{},"347":{}},"parent":{}}],["createproject",{"_index":66,"name":{"65":{},"252":{}},"parent":{}}],["createprojectinvitation",{"_index":96,"name":{"95":{},"276":{}},"parent":{}}],["createresourceforproject",{"_index":74,"name":{"73":{},"260":{}},"parent":{}}],["default",{"_index":180,"name":{"179":{}},"parent":{"180":{}}}],["default.__type",{"_index":181,"name":{},"parent":{"181":{},"182":{},"185":{},"186":{},"189":{},"190":{},"196":{},"197":{},"201":{},"202":{},"204":{},"205":{},"209":{},"210":{},"214":{},"215":{},"218":{},"219":{},"222":{},"223":{},"228":{},"229":{},"235":{},"236":{},"239":{},"240":{},"244":{},"245":{},"249":{},"250":{},"257":{},"258":{},"265":{},"266":{},"269":{},"270":{},"273":{},"274":{},"280":{},"281":{},"286":{},"287":{},"294":{},"295":{},"298":{},"299":{},"306":{},"307":{},"311":{},"312":{},"315":{},"316":{},"319":{},"320":{},"324":{},"325":{},"331":{},"332":{},"340":{},"341":{},"344":{},"345":{},"351":{},"352":{},"355":{},"356":{}}}],["default.__type.__type",{"_index":182,"name":{},"parent":{"183":{},"184":{},"187":{},"188":{},"191":{},"192":{},"193":{},"194":{},"195":{},"198":{},"199":{},"200":{},"203":{},"206":{},"207":{},"208":{},"211":{},"212":{},"213":{},"216":{},"217":{},"220":{},"221":{},"224":{},"225":{},"226":{},"227":{},"230":{},"231":{},"232":{},"233":{},"234":{},"237":{},"238":{},"241":{},"242":{},"243":{},"246":{},"247":{},"248":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"267":{},"268":{},"271":{},"272":{},"275":{},"276":{},"277":{},"278":{},"279":{},"282":{},"283":{},"284":{},"285":{},"288":{},"289":{},"290":{},"291":{},"292":{},"293":{},"296":{},"297":{},"300":{},"301":{},"302":{},"303":{},"304":{},"305":{},"308":{},"309":{},"310":{},"313":{},"314":{},"317":{},"318":{},"321":{},"322":{},"323":{},"326":{},"327":{},"328":{},"329":{},"330":{},"333":{},"334":{},"335":{},"336":{},"337":{},"338":{},"339":{},"342":{},"343":{},"346":{},"347":{},"348":{},"349":{},"350":{},"353":{},"354":{},"357":{},"358":{},"359":{}}}],["deleteblob",{"_index":20,"name":{"19":{},"193":{}},"parent":{}}],["deletemembership",{"_index":104,"name":{"103":{},"290":{}},"parent":{}}],["deleteproject",{"_index":67,"name":{"66":{},"253":{}},"parent":{}}],["deleteprojectinvitation",{"_index":97,"name":{"96":{},"277":{}},"parent":{}}],["deleteresourceforproject",{"_index":75,"name":{"74":{},"261":{}},"parent":{}}],["disciplineapi",{"_index":23,"name":{"22":{},"196":{}},"parent":{"23":{}}}],["disciplineapi.__type",{"_index":25,"name":{},"parent":{"24":{},"25":{},"26":{}}}],["getallapitokens",{"_index":151,"name":{"150":{},"328":{}},"parent":{}}],["getallgitlabbranchesforproject",{"_index":115,"name":{"114":{},"301":{}},"parent":{}}],["getallgitlabprojects",{"_index":116,"name":{"115":{},"302":{}},"parent":{}}],["getallresourcetypesinformation",{"_index":117,"name":{"116":{},"303":{}},"parent":{}}],["getapitoken",{"_index":152,"name":{"151":{},"329":{}},"parent":{}}],["getapplicationprofile",{"_index":13,"name":{"12":{},"232":{}},"parent":{}}],["getapplicationprofiles",{"_index":14,"name":{"13":{},"233":{}},"parent":{}}],["getavailableresourcetypesinformationforproject",{"_index":92,"name":{"91":{},"272":{}},"parent":{}}],["getblob",{"_index":21,"name":{"20":{},"194":{}},"parent":{}}],["getcurrentmaintenances",{"_index":44,"name":{"43":{},"217":{}},"parent":{}}],["getcurrentuser",{"_index":143,"name":{"142":{},"336":{}},"parent":{}}],["getdiscipline",{"_index":26,"name":{"25":{},"199":{}},"parent":{}}],["getdisciplines",{"_index":27,"name":{"26":{},"200":{}},"parent":{}}],["getfiletree",{"_index":162,"name":{"161":{},"348":{}},"parent":{}}],["getgitlabproject",{"_index":118,"name":{"117":{},"304":{}},"parent":{}}],["getlanguage",{"_index":34,"name":{"33":{},"207":{}},"parent":{}}],["getlanguages",{"_index":35,"name":{"34":{},"208":{}},"parent":{}}],["getlicense",{"_index":39,"name":{"38":{},"212":{}},"parent":{}}],["getlicenses",{"_index":40,"name":{"39":{},"213":{}},"parent":{}}],["getmembership",{"_index":105,"name":{"104":{},"291":{}},"parent":{}}],["getmemberships",{"_index":106,"name":{"105":{},"292":{}},"parent":{}}],["getmetadatatree",{"_index":163,"name":{"162":{},"349":{}},"parent":{}}],["getorganization",{"_index":56,"name":{"55":{},"242":{}},"parent":{}}],["getorganizations",{"_index":57,"name":{"56":{},"243":{}},"parent":{}}],["getproject",{"_index":68,"name":{"67":{},"254":{}},"parent":{}}],["getprojectinvitation",{"_index":98,"name":{"97":{},"278":{}},"parent":{}}],["getprojectinvitations",{"_index":99,"name":{"98":{},"279":{}},"parent":{}}],["getprojectquota",{"_index":82,"name":{"81":{},"283":{}},"parent":{}}],["getprojectquotas",{"_index":83,"name":{"82":{},"284":{}},"parent":{}}],["getprojects",{"_index":69,"name":{"68":{},"255":{}},"parent":{}}],["getquotaforresourceforproject",{"_index":88,"name":{"87":{},"268":{}},"parent":{}}],["getrawapplicationprofile",{"_index":15,"name":{"14":{},"234":{}},"parent":{}}],["getresource",{"_index":111,"name":{"110":{},"297":{}},"parent":{}}],["getresourceforproject",{"_index":76,"name":{"75":{},"262":{}},"parent":{}}],["getresourcesforproject",{"_index":77,"name":{"76":{},"263":{}},"parent":{}}],["getresourcetypeinformation",{"_index":119,"name":{"118":{},"305":{}},"parent":{}}],["getrole",{"_index":123,"name":{"122":{},"309":{}},"parent":{}}],["getroles",{"_index":124,"name":{"123":{},"310":{}},"parent":{}}],["getsearchresults",{"_index":128,"name":{"127":{},"314":{}},"parent":{}}],["gettitle",{"_index":136,"name":{"135":{},"322":{}},"parent":{}}],["gettitles",{"_index":137,"name":{"136":{},"323":{}},"parent":{}}],["gettos",{"_index":157,"name":{"156":{},"343":{}},"parent":{}}],["getusers",{"_index":168,"name":{"167":{},"354":{}},"parent":{}}],["getvisibilities",{"_index":172,"name":{"171":{},"358":{}},"parent":{}}],["getvisibility",{"_index":173,"name":{"172":{},"359":{}},"parent":{}}],["getvocabularies",{"_index":177,"name":{"176":{},"225":{}},"parent":{}}],["getvocabularyinstance",{"_index":178,"name":{"177":{},"226":{}},"parent":{}}],["getvocabularyinstances",{"_index":179,"name":{"178":{},"227":{}},"parent":{}}],["homeapi",{"_index":28,"name":{"27":{},"201":{}},"parent":{"28":{}}}],["homeapi.__type",{"_index":30,"name":{},"parent":{"29":{}}}],["homeindex",{"_index":29,"name":{"29":{},"203":{}},"parent":{}}],["initiateusermerge",{"_index":144,"name":{"143":{},"337":{}},"parent":{}}],["languageapi",{"_index":31,"name":{"30":{},"204":{}},"parent":{"31":{}}}],["languageapi.__type",{"_index":33,"name":{},"parent":{"32":{},"33":{},"34":{}}}],["licenseapi",{"_index":36,"name":{"35":{},"209":{}},"parent":{"36":{}}}],["licenseapi.__type",{"_index":38,"name":{},"parent":{"37":{},"38":{},"39":{}}}],["maintenanceapi",{"_index":41,"name":{"40":{},"214":{}},"parent":{"41":{}}}],["maintenanceapi.__type",{"_index":43,"name":{},"parent":{"42":{},"43":{}}}],["mergeapi",{"_index":45,"name":{"44":{},"218":{}},"parent":{"45":{}}}],["mergeapi.__type",{"_index":47,"name":{},"parent":{"46":{},"47":{}}}],["mergecallback",{"_index":46,"name":{"46":{},"220":{}},"parent":{}}],["mergelogin",{"_index":48,"name":{"47":{},"221":{}},"parent":{}}],["orcidapi",{"_index":49,"name":{"48":{},"235":{}},"parent":{"49":{}}}],["orcidapi.__type",{"_index":51,"name":{},"parent":{"50":{},"51":{}}}],["orcidloginget",{"_index":50,"name":{"50":{},"237":{}},"parent":{}}],["orcidloginpost",{"_index":52,"name":{"51":{},"238":{}},"parent":{}}],["organizationapi",{"_index":53,"name":{"52":{},"239":{}},"parent":{"53":{}}}],["organizationapi.__type",{"_index":55,"name":{},"parent":{"54":{},"55":{},"56":{}}}],["pidapi",{"_index":58,"name":{"57":{},"244":{}},"parent":{"58":{}}}],["pidapi.__type",{"_index":60,"name":{},"parent":{"59":{},"60":{},"61":{}}}],["projectapi",{"_index":63,"name":{"62":{},"249":{}},"parent":{"63":{}}}],["projectapi.__type",{"_index":65,"name":{},"parent":{"64":{},"65":{},"66":{},"67":{},"68":{},"69":{}}}],["projectinvitationapi",{"_index":93,"name":{"92":{},"273":{}},"parent":{"93":{}}}],["projectinvitationapi.__type",{"_index":95,"name":{},"parent":{"94":{},"95":{},"96":{},"97":{},"98":{}}}],["projectmemberapi",{"_index":100,"name":{"99":{},"286":{}},"parent":{"100":{}}}],["projectmemberapi.__type",{"_index":102,"name":{},"parent":{"101":{},"102":{},"103":{},"104":{},"105":{},"106":{}}}],["projectquotaapi",{"_index":79,"name":{"78":{},"280":{}},"parent":{"79":{}}}],["projectquotaapi.__type",{"_index":81,"name":{},"parent":{"80":{},"81":{},"82":{},"83":{}}}],["projectresourceapi",{"_index":71,"name":{"70":{},"257":{}},"parent":{"71":{}}}],["projectresourceapi.__type",{"_index":73,"name":{},"parent":{"72":{},"73":{},"74":{},"75":{},"76":{},"77":{}}}],["projectresourcequotaapi",{"_index":85,"name":{"84":{},"265":{}},"parent":{"85":{}}}],["projectresourcequotaapi.__type",{"_index":87,"name":{},"parent":{"86":{},"87":{}}}],["projectresourcetypeapi",{"_index":89,"name":{"88":{},"269":{}},"parent":{"89":{}}}],["projectresourcetypeapi.__type",{"_index":91,"name":{},"parent":{"90":{},"91":{}}}],["resolveprojectinvitation",{"_index":145,"name":{"144":{},"338":{}},"parent":{}}],["resourceapi",{"_index":108,"name":{"107":{},"294":{}},"parent":{"108":{}}}],["resourceapi.__type",{"_index":110,"name":{},"parent":{"109":{},"110":{}}}],["resourcetypeapi",{"_index":112,"name":{"111":{},"298":{}},"parent":{"112":{}}}],["resourcetypeapi.__type",{"_index":114,"name":{},"parent":{"113":{},"114":{},"115":{},"116":{},"117":{},"118":{}}}],["revoketoken",{"_index":153,"name":{"152":{},"330":{}},"parent":{}}],["roleapi",{"_index":120,"name":{"119":{},"306":{}},"parent":{"120":{}}}],["roleapi.__type",{"_index":122,"name":{},"parent":{"121":{},"122":{},"123":{}}}],["searchapi",{"_index":125,"name":{"124":{},"311":{}},"parent":{"125":{}}}],["searchapi.__type",{"_index":127,"name":{},"parent":{"126":{},"127":{}}}],["selfapi",{"_index":138,"name":{"137":{},"331":{}},"parent":{"138":{}}}],["selfapi.__type",{"_index":140,"name":{},"parent":{"139":{},"140":{},"141":{},"142":{},"143":{},"144":{},"145":{}}}],["selfapitokenapi",{"_index":147,"name":{"146":{},"324":{}},"parent":{"147":{}}}],["selfapitokenapi.__type",{"_index":149,"name":{},"parent":{"148":{},"149":{},"150":{},"151":{},"152":{}}}],["sendrequesttoowner",{"_index":61,"name":{"60":{},"247":{}},"parent":{}}],["shibbolethapi",{"_index":129,"name":{"128":{},"315":{}},"parent":{"129":{}}}],["shibbolethapi.__type",{"_index":131,"name":{},"parent":{"130":{},"131":{}}}],["shibbolethcallback",{"_index":130,"name":{"130":{},"317":{}},"parent":{}}],["shibbolethlogin",{"_index":132,"name":{"131":{},"318":{}},"parent":{}}],["titleapi",{"_index":133,"name":{"132":{},"319":{}},"parent":{"133":{}}}],["titleapi.__type",{"_index":135,"name":{},"parent":{"134":{},"135":{},"136":{}}}],["tosapi",{"_index":154,"name":{"153":{},"340":{}},"parent":{"154":{}}}],["tosapi.__type",{"_index":156,"name":{},"parent":{"155":{},"156":{}}}],["treeapi",{"_index":158,"name":{"157":{},"344":{}},"parent":{"158":{}}}],["treeapi.__type",{"_index":160,"name":{},"parent":{"159":{},"160":{},"161":{},"162":{},"163":{}}}],["updateblob",{"_index":22,"name":{"21":{},"195":{}},"parent":{}}],["updatecurrentuser",{"_index":146,"name":{"145":{},"339":{}},"parent":{}}],["updatemembership",{"_index":107,"name":{"106":{},"293":{}},"parent":{}}],["updatemetadatatree",{"_index":164,"name":{"163":{},"350":{}},"parent":{}}],["updateproject",{"_index":70,"name":{"69":{},"256":{}},"parent":{}}],["updateprojectquota",{"_index":84,"name":{"83":{},"285":{}},"parent":{}}],["updateresourceforproject",{"_index":78,"name":{"77":{},"264":{}},"parent":{}}],["userapi",{"_index":165,"name":{"164":{},"351":{}},"parent":{"165":{}}}],["userapi.__type",{"_index":167,"name":{},"parent":{"166":{},"167":{}}}],["validatepid",{"_index":62,"name":{"61":{},"248":{}},"parent":{}}],["visibilityapi",{"_index":169,"name":{"168":{},"355":{}},"parent":{"169":{}}}],["visibilityapi.__type",{"_index":171,"name":{},"parent":{"170":{},"171":{},"172":{}}}],["vocabularyapi",{"_index":174,"name":{"173":{},"222":{}},"parent":{"174":{}}}],["vocabularyapi.__type",{"_index":176,"name":{},"parent":{"175":{},"176":{},"177":{},"178":{}}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index ce32516720347230d6b2ee858bcecbf9868db4a2..1da018abc6fb96fc3804cab441e5d03f06892339 100644 --- a/docs/index.html +++ b/docs/index.html @@ -136,9 +136,6 @@ <li class=" tsd-kind-variable"> <a href="modules.html#AccountApi" class="tsd-kind-icon">Account<wbr>Api</a> </li> - <li class=" tsd-kind-variable"> - <a href="modules.html#AdminApi" class="tsd-kind-icon">Admin<wbr>Api</a> - </li> <li class=" tsd-kind-variable"> <a href="modules.html#ApplicationProfileApi" class="tsd-kind-icon">Application<wbr>Profile<wbr>Api</a> </li> @@ -206,16 +203,19 @@ <a href="modules.html#SearchApi" class="tsd-kind-icon">Search<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#ShibbolethApi" class="tsd-kind-icon">Shibboleth<wbr>Api</a> + <a href="modules.html#SelfApi" class="tsd-kind-icon">Self<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#TitleApi" class="tsd-kind-icon">Title<wbr>Api</a> + <a href="modules.html#SelfApiTokenApi" class="tsd-kind-icon">Self<wbr>Api<wbr>Token<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#ToSApi" class="tsd-kind-icon">ToSApi</a> + <a href="modules.html#ShibbolethApi" class="tsd-kind-icon">Shibboleth<wbr>Api</a> + </li> + <li class=" tsd-kind-variable"> + <a href="modules.html#TitleApi" class="tsd-kind-icon">Title<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#TokenApi" class="tsd-kind-icon">Token<wbr>Api</a> + <a href="modules.html#TosApi" class="tsd-kind-icon">Tos<wbr>Api</a> </li> <li class=" tsd-kind-variable"> <a href="modules.html#TreeApi" class="tsd-kind-icon">Tree<wbr>Api</a> diff --git a/docs/modules.html b/docs/modules.html index 6f1c06ecdc1ac99d85bbd66f1c7a1575a5a1251a..67112a97c343bef92785e78ea2da55980bcc7784 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -88,10 +88,11 @@ <li class="tsd-kind-variable"><a href="modules.html#ResourceTypeApi" class="tsd-kind-icon">Resource<wbr>Type<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#RoleApi" class="tsd-kind-icon">Role<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#SearchApi" class="tsd-kind-icon">Search<wbr>Api</a></li> + <li class="tsd-kind-variable"><a href="modules.html#SelfApi" class="tsd-kind-icon">Self<wbr>Api</a></li> + <li class="tsd-kind-variable"><a href="modules.html#SelfApiTokenApi" class="tsd-kind-icon">Self<wbr>Api<wbr>Token<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#ShibbolethApi" class="tsd-kind-icon">Shibboleth<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#TitleApi" class="tsd-kind-icon">Title<wbr>Api</a></li> - <li class="tsd-kind-variable"><a href="modules.html#ToSApi" class="tsd-kind-icon">ToSApi</a></li> - <li class="tsd-kind-variable"><a href="modules.html#TokenApi" class="tsd-kind-icon">Token<wbr>Api</a></li> + <li class="tsd-kind-variable"><a href="modules.html#TosApi" class="tsd-kind-icon">Tos<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#TreeApi" class="tsd-kind-icon">Tree<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#UserApi" class="tsd-kind-icon">User<wbr>Api</a></li> <li class="tsd-kind-variable"><a href="modules.html#VisibilityApi" class="tsd-kind-icon">Visibility<wbr>Api</a></li> @@ -307,11 +308,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4323</li> + <li>Defined in Coscine.Api/api.ts:4514</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -336,11 +340,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4332</li> + <li>Defined in Coscine.Api/api.ts:4524</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Submits a request to create a new application profile.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -368,11 +375,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4343</li> + <li>Defined in Coscine.Api/api.ts:4536</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves an application profile by its URI.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -382,6 +392,9 @@ <ul class="tsd-parameters"> <li> <h5>profile: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The URI of the application profile to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> format: <span class="tsd-signature-type">RdfFormat</span></h5> @@ -406,11 +419,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4356</li> + <li>Defined in Coscine.Api/api.ts:4550</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all application profiles.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -450,11 +466,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4365</li> + <li>Defined in Coscine.Api/api.ts:4560</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the <code>raw</code> application profile definition by its URI.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -464,6 +483,9 @@ <ul class="tsd-parameters"> <li> <h5>profile: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The URI of the application profile.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -497,11 +519,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4768</li> + <li>Defined in Coscine.Api/api.ts:4979</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -532,11 +557,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4780</li> + <li>Defined in Coscine.Api/api.ts:4992</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new blob for a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -546,12 +574,21 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key for the new blob.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <span class="tsd-signature-type">any</span></h5> @@ -573,11 +610,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4791</li> + <li>Defined in Coscine.Api/api.ts:5004</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a blob from a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -587,12 +627,21 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key associated with the blob to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -611,11 +660,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4802</li> + <li>Defined in Coscine.Api/api.ts:5016</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Download a blob from a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -625,12 +677,21 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key associated with the blob.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -649,11 +710,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4814</li> + <li>Defined in Coscine.Api/api.ts:5029</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates an existing blob of a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -663,12 +727,21 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> </li> <li> <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key associated with the blob to update.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <span class="tsd-signature-type">any</span></h5> @@ -705,11 +778,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5072</li> + <li>Defined in Coscine.Api/api.ts:5299</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -734,11 +810,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5081</li> + <li>Defined in Coscine.Api/api.ts:5309</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a discipline with the specified ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -748,6 +827,9 @@ <ul class="tsd-parameters"> <li> <h5>disciplineId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the discipline.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -766,11 +848,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5092</li> + <li>Defined in Coscine.Api/api.ts:5321</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all disciplines.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -866,11 +951,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5318</li> + <li>Defined in Coscine.Api/api.ts:5557</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -895,11 +983,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5327</li> + <li>Defined in Coscine.Api/api.ts:5567</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a language by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -909,6 +1000,9 @@ <ul class="tsd-parameters"> <li> <h5>languageId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the language.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -927,11 +1021,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5338</li> + <li>Defined in Coscine.Api/api.ts:5579</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all languages.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -980,11 +1077,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5564</li> + <li>Defined in Coscine.Api/api.ts:5815</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1009,11 +1109,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5573</li> + <li>Defined in Coscine.Api/api.ts:5825</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a license with the specified ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1023,6 +1126,9 @@ <ul class="tsd-parameters"> <li> <h5>licenseId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the license.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1041,11 +1147,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5584</li> + <li>Defined in Coscine.Api/api.ts:5837</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all licenses.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1076,7 +1185,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="MaintenanceApi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Maintenance<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Maintenance<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2MaintenancesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentMaintenance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">Maintenance<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2MaintenancesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentMaintenances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:14</li> @@ -1094,11 +1203,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5746</li> + <li>Defined in Coscine.Api/api.ts:6007</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1115,19 +1227,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Current<wbr>Maintenance<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Current<wbr>Maintenances<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Maintenance<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Maintenances<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5754</li> + <li>Defined in Coscine.Api/api.ts:6016</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the current maintenance messages.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1139,7 +1254,7 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -1334,11 +1449,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5972</li> + <li>Defined in Coscine.Api/api.ts:6243</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1357,17 +1475,20 @@ <li class="tsd-parameter"> <h5>get<wbr>Organization<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Organization<span class="tsd-signature-symbol">(</span>organizationRorUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Organization<span class="tsd-signature-symbol">(</span>organizationRorUri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5981</li> + <li>Defined in Coscine.Api/api.ts:6253</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves an organization.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1376,7 +1497,7 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>organizationRorUrl: <span class="tsd-signature-type">string</span></h5> + <h5>organizationRorUri: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1395,11 +1516,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5993</li> + <li>Defined in Coscine.Api/api.ts:6266</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all organizations.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1433,7 +1557,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="PidApi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Pid<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Pid<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2PidsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sendEmailToOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>validatePid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">Pid<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2PidsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sendRequestToOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>validatePid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:18</li> @@ -1451,11 +1575,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6222</li> + <li>Defined in Coscine.Api/api.ts:6505</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1472,19 +1599,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>send<wbr>Email<wbr>ToOwner<span class="tsd-signature-symbol">: </span>function</h5> + <h5>send<wbr>Request<wbr>ToOwner<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">send<wbr>Email<wbr>ToOwner<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pidEnquiryDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PidEnquiryDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">send<wbr>Request<wbr>ToOwner<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pidRequestDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PidRequestDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6233</li> + <li>Defined in Coscine.Api/api.ts:6517</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Sends an inquiry to the owner of the given PID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1494,12 +1624,18 @@ <ul class="tsd-parameters"> <li> <h5>prefix: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID prefix of a project or a resource to validate</p> + </div> </li> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID body of a project or a resource to validate</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pidEnquiryDto: <span class="tsd-signature-type">PidEnquiryDto</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pidRequestDto: <span class="tsd-signature-type">PidRequestDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1518,11 +1654,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6243</li> + <li>Defined in Coscine.Api/api.ts:6528</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Validates the given PID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1532,9 +1671,15 @@ <ul class="tsd-parameters"> <li> <h5>prefix: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID prefix of a project or a resource to validate</p> + </div> </li> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID body of a project or a resource to validate</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1568,11 +1713,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6625</li> + <li>Defined in Coscine.Api/api.ts:6926</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1597,11 +1745,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6634</li> + <li>Defined in Coscine.Api/api.ts:6936</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1629,11 +1780,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6643</li> + <li>Defined in Coscine.Api/api.ts:6946</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1643,6 +1797,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1661,11 +1818,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6653</li> + <li>Defined in Coscine.Api/api.ts:6957</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1675,6 +1835,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeSubProjects: <span class="tsd-signature-type">boolean</span></h5> @@ -1696,11 +1859,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6665</li> + <li>Defined in Coscine.Api/api.ts:6970</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all projects.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1737,11 +1903,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6675</li> + <li>Defined in Coscine.Api/api.ts:6981</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1751,6 +1920,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectForUpdateDto: <span class="tsd-signature-type">ProjectForUpdateDto</span></h5> @@ -1769,7 +1941,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="ProjectInvitationApi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Project<wbr>Invitation<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Project<wbr>Invitation<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdInvitationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>resolveProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">Project<wbr>Invitation<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdInvitationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:24</li> @@ -1787,11 +1959,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7106</li> + <li>Defined in Coscine.Api/api.ts:7378</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1819,11 +1994,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7116</li> + <li>Defined in Coscine.Api/api.ts:7389</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a project invitation for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1833,6 +2011,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationForProjectManipulationDto: <span class="tsd-signature-type">ProjectInvitationForProjectManipulationDto</span></h5> @@ -1854,11 +2035,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7126</li> + <li>Defined in Coscine.Api/api.ts:7400</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a project invitation for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1868,9 +2052,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>projectInvitationId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project invitation to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1889,11 +2079,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7136</li> + <li>Defined in Coscine.Api/api.ts:7411</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project invitation for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1903,9 +2096,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>projectInvitationId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project invitation to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -1924,11 +2123,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7148</li> + <li>Defined in Coscine.Api/api.ts:7424</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all project invitations for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -1938,6 +2140,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -1956,41 +2161,6 @@ </li> </ul> </li> - <li class="tsd-parameter"> - <h5>resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationResolveDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectInvitationResolveDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:7158</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationResolveDto: <span class="tsd-signature-type">ProjectInvitationResolveDto</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> </ul> </div> </section> @@ -2015,11 +2185,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7598</li> + <li>Defined in Coscine.Api/api.ts:7870</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2029,6 +2202,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectRoleForProjectCreationDto: <span class="tsd-signature-type">ProjectRoleForProjectCreationDto</span></h5> @@ -2050,11 +2226,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7607</li> + <li>Defined in Coscine.Api/api.ts:7880</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2082,11 +2261,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7617</li> + <li>Defined in Coscine.Api/api.ts:7891</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2096,9 +2278,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project membership to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2117,11 +2305,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7627</li> + <li>Defined in Coscine.Api/api.ts:7902</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2131,9 +2322,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project membership to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2152,11 +2349,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7639</li> + <li>Defined in Coscine.Api/api.ts:7915</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all project memberships for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2166,6 +2366,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -2193,11 +2396,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7650</li> + <li>Defined in Coscine.Api/api.ts:7927</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2207,9 +2413,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project membership to update.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectRoleForProjectManipulationDto: <span class="tsd-signature-type">ProjectRoleForProjectManipulationDto</span></h5> @@ -2246,11 +2458,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7988</li> + <li>Defined in Coscine.Api/api.ts:8280</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2278,11 +2493,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7998</li> + <li>Defined in Coscine.Api/api.ts:8291</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project quota for a specified project and resource type.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2292,9 +2510,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource type.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2313,11 +2537,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8010</li> + <li>Defined in Coscine.Api/api.ts:8304</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all project quotas for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2327,6 +2554,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -2354,11 +2584,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8021</li> + <li>Defined in Coscine.Api/api.ts:8316</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a project quota for a specified project and resource type.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2368,9 +2601,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource type.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectQuotaForUpdateDto: <span class="tsd-signature-type">ProjectQuotaForUpdateDto</span></h5> @@ -2407,11 +2646,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8437</li> + <li>Defined in Coscine.Api/api.ts:8749</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2439,11 +2681,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8447</li> + <li>Defined in Coscine.Api/api.ts:8760</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2453,6 +2698,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> resourceForCreationDto: <span class="tsd-signature-type">ResourceForCreationDto</span></h5> @@ -2474,11 +2722,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8457</li> + <li>Defined in Coscine.Api/api.ts:8771</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2488,9 +2739,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2509,11 +2766,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8467</li> + <li>Defined in Coscine.Api/api.ts:8782</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2523,9 +2783,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2544,11 +2810,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8479</li> + <li>Defined in Coscine.Api/api.ts:8795</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all resources for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2558,6 +2827,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -2585,11 +2857,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8490</li> + <li>Defined in Coscine.Api/api.ts:8807</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2599,9 +2874,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to update.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> resourceForUpdateDto: <span class="tsd-signature-type">ResourceForUpdateDto</span></h5> @@ -2638,11 +2919,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8714</li> + <li>Defined in Coscine.Api/api.ts:9042</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2673,11 +2957,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8724</li> + <li>Defined in Coscine.Api/api.ts:9053</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the resource quota for a specific resource in a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2687,9 +2974,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2705,7 +2998,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="ProjectResourceTypeApi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Project<wbr>Resource<wbr>Type<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Project<wbr>Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAvailableResourceTypesInformationForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">Project<wbr>Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourceTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAvailableResourceTypesInformationForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:23</li> @@ -2715,19 +3008,22 @@ <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8887</li> + <li>Defined in Coscine.Api/api.ts:9223</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2755,12 +3051,15 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8896</li> + <li>Defined in Coscine.Api/api.ts:9233</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> - <dt>throws</dt> + <dt>summary</dt> + <dd><p>Retrieves the available resource types information for a specific project.</p> + </dd> + <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> </dl> @@ -2769,6 +3068,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2802,11 +3104,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9051</li> + <li>Defined in Coscine.Api/api.ts:9395</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2831,11 +3136,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9060</li> + <li>Defined in Coscine.Api/api.ts:9405</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a resource by its ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2845,6 +3153,9 @@ <ul class="tsd-parameters"> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -2860,7 +3171,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="ResourceTypeApi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Resource<wbr>Type<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ResourcesTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabBranchesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllResourceTypesInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getGitlabProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceTypeInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ResourceTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabBranchesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllResourceTypesInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getGitlabProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceTypeInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:27</li> @@ -2870,19 +3181,22 @@ <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Resources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Resource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Resources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Resource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9436</li> + <li>Defined in Coscine.Api/api.ts:9796</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2907,11 +3221,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9447</li> + <li>Defined in Coscine.Api/api.ts:9808</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2921,6 +3238,9 @@ <ul class="tsd-parameters"> <li> <h5>gitlabProjectId: <span class="tsd-signature-type">number</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the GitLab project.</p> + </div> </li> <li> <h5>domain: <span class="tsd-signature-type">string</span></h5> @@ -2945,11 +3265,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9457</li> + <li>Defined in Coscine.Api/api.ts:9819</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -2980,11 +3303,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9465</li> + <li>Defined in Coscine.Api/api.ts:9828</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the entire global resource types information.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3009,11 +3335,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9476</li> + <li>Defined in Coscine.Api/api.ts:9840</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3023,6 +3352,9 @@ <ul class="tsd-parameters"> <li> <h5>gitlabProjectId: <span class="tsd-signature-type">number</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the GitLab project.</p> + </div> </li> <li> <h5>domain: <span class="tsd-signature-type">string</span></h5> @@ -3047,11 +3379,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9485</li> + <li>Defined in Coscine.Api/api.ts:9850</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the resource type information for a specific resource type.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3061,6 +3396,9 @@ <ul class="tsd-parameters"> <li> <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource type to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -3094,11 +3432,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9746</li> + <li>Defined in Coscine.Api/api.ts:10124</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3123,11 +3464,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9755</li> + <li>Defined in Coscine.Api/api.ts:10134</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a role by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3137,6 +3481,9 @@ <ul class="tsd-parameters"> <li> <h5>roleId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the role.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -3155,11 +3502,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9766</li> + <li>Defined in Coscine.Api/api.ts:10146</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all roles.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3190,7 +3540,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="SearchApi" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> Search<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Search<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>searchSearch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">Search<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2SearchOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getSearchResults<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:29</li> @@ -3200,21 +3550,21 @@ <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>search<wbr>Search<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Search<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">search<wbr>Search<span class="tsd-signature-symbol">(</span>searchQuery<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, includeUsers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, useAdvancedSyntax<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, includedLanguages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, categoryFilter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CategoryFilter</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OrderBy</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ItemSearchResult</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Search<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.Search/api.ts:221</li> + <li>Defined in Coscine.Api/api.ts:10358</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>Search Elasticsearch</p> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -3224,22 +3574,48 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchQuery: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Search<wbr>Results<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Search<wbr>Results<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, useAdvancedSyntax<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, languages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, category<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SearchCategoryType</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchResultDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:10374</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a search result by given search parameters.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeUsers: <span class="tsd-signature-type">boolean</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> query: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> useAdvancedSyntax: <span class="tsd-signature-type">boolean</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> includedLanguages: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> categoryFilter: <span class="tsd-signature-type">CategoryFilter</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> languages: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">OrderBy</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> category: <span class="tsd-signature-type">SearchCategoryType</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -3247,11 +3623,14 @@ <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ItemSearchResult</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchResultDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -3259,33 +3638,33 @@ </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="ShibbolethApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> Shibboleth<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Shibboleth<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>shibbolethCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>shibbolethLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <a name="SelfApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Self<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Self<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>acceptCurrentTos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2SelfOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>confirmUserEmail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initiateUserMerge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>resolveProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in index.ts:30</li> + <li>Defined in index.ts:32</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>shibboleth<wbr>Callback<span class="tsd-signature-symbol">: </span>function</h5> + <h5>accept<wbr>Current<wbr>Tos<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Callback<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, remoteError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">accept<wbr>Current<wbr>Tos<span class="tsd-signature-symbol">(</span>userTermsOfServiceAcceptDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UserTermsOfServiceAcceptDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:826</li> + <li>Defined in Coscine.Api/api.ts:10783</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>Callback method to catch the login</p> + <dd><p>Accepts the current Terms Of Service for the current authenticated user.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -3295,35 +3674,32 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> remoteError: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> userTermsOfServiceAcceptDto: <span class="tsd-signature-type">UserTermsOfServiceAcceptDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>shibboleth<wbr>Login<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Self<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Login<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, entityId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Self<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:837</li> + <li>Defined in Coscine.Api/api.ts:10792</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the "entityId" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.</p> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -3332,49 +3708,31 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> entityId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </div> - </section> - <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="TitleApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> Title<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Title<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2TitlesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> - <aside class="tsd-sources"> - <ul> - <li>Defined in index.ts:31</li> - </ul> - </aside> - <div class="tsd-type-declaration"> - <h4>Type declaration</h4> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">(</span>confirmationToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9992</li> + <li>Defined in Coscine.Api/api.ts:10802</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Confirms the email of a user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3382,6 +3740,9 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5>confirmationToken: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -3391,19 +3752,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Title<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Title<span class="tsd-signature-symbol">(</span>titleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10001</li> + <li>Defined in Coscine.Api/api.ts:10811</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3411,31 +3775,31 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>titleId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Titles<span class="tsd-signature-symbol">: </span>function</h5> + <h5>initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Titles<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">(</span>identityProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdentityProviders</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10012</li> + <li>Defined in Coscine.Api/api.ts:10821</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Initiates user merging for the current user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3444,51 +3808,33 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5>identityProvider: <span class="tsd-signature-type">IdentityProviders</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </div> - </section> - <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="ToSApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> ToSApi</h3> - <div class="tsd-signature tsd-kind-icon">ToSApi<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2TosOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getToS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> - <aside class="tsd-sources"> - <ul> - <li>Defined in index.ts:33</li> - </ul> - </aside> - <div class="tsd-type-declaration"> - <h4>Type declaration</h4> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectInvitationResolveDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectInvitationResolveDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10174</li> + <li>Defined in Coscine.Api/api.ts:10831</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Resolves a project invitation for the authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3496,6 +3842,9 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationResolveDto: <span class="tsd-signature-type">ProjectInvitationResolveDto</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -3505,19 +3854,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>ToS<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>ToS<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>userForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UserForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10182</li> + <li>Defined in Coscine.Api/api.ts:10841</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3525,11 +3877,14 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> userForUpdateDto: <span class="tsd-signature-type">UserForUpdateDto</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -3537,31 +3892,34 @@ </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="TokenApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> Token<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Token<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2UsersSelfTokensOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllApiTokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>revokeToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <a name="SelfApiTokenApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Self<wbr>Api<wbr>Token<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Self<wbr>Api<wbr>Token<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2SelfApiTokensOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllApiTokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>revokeToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in index.ts:32</li> + <li>Defined in index.ts:33</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Users<wbr>Self<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Self<wbr>Api<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Users<wbr>Self<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Self<wbr>Api<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11471</li> + <li>Defined in Coscine.Api/api.ts:11218</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3586,11 +3944,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11480</li> + <li>Defined in Coscine.Api/api.ts:11228</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates an API token for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3618,11 +3979,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11491</li> + <li>Defined in Coscine.Api/api.ts:11240</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all API tokens for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3656,11 +4020,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11500</li> + <li>Defined in Coscine.Api/api.ts:11250</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves an API token for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3670,6 +4037,9 @@ <ul class="tsd-parameters"> <li> <h5>apiTokenId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the token.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -3688,11 +4058,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11509</li> + <li>Defined in Coscine.Api/api.ts:11260</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Revokes an API token for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3702,6 +4075,9 @@ <ul class="tsd-parameters"> <li> <h5>apiTokenId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the token.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -3715,31 +4091,34 @@ </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="TreeApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> Tree<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Tree<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdTreesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getFileTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <a name="ShibbolethApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Shibboleth<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Shibboleth<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>shibbolethCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>shibbolethLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in index.ts:34</li> + <li>Defined in index.ts:30</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdTrees<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>shibboleth<wbr>Callback<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdTrees<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Callback<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, remoteError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10569</li> + <li>Defined in Coscine.Api.STS/api.ts:826</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Callback method to catch the login</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3748,33 +4127,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> </li> <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> remoteError: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> + <h5>shibboleth<wbr>Login<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataTreeForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MetadataTreeForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Login<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, entityId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10580</li> + <li>Defined in Coscine.Api.STS/api.ts:837</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the "entityId" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3783,36 +4165,51 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> metadataTreeForCreationDto: <span class="tsd-signature-type">MetadataTreeForCreationDto</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> entityId: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-variable"> + <a name="TitleApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Title<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Title<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2TitlesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in index.ts:31</li> + </ul> + </aside> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10594</li> + <li>Defined in Coscine.Api/api.ts:11520</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3821,45 +4218,30 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Title<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RdfFormat</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Title<span class="tsd-signature-symbol">(</span>titleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10609</li> + <li>Defined in Coscine.Api/api.ts:11530</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a title by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3868,48 +4250,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> format: <span class="tsd-signature-type">RdfFormat</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5>titleId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the title.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Titles<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataTreeForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MetadataTreeForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Titles<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10620</li> + <li>Defined in Coscine.Api/api.ts:11542</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all titles.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3918,19 +4288,19 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> metadataTreeForUpdateDto: <span class="tsd-signature-type">MetadataTreeForUpdateDto</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -3938,31 +4308,34 @@ </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="UserApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> User<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">User<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>acceptCurrentToS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2UsersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>confirmUserEmail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getUsers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initiateUserMerge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <a name="TosApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Tos<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Tos<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2TosOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> - <li>Defined in index.ts:35</li> + <li>Defined in index.ts:34</li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>accept<wbr>Current<wbr>ToS<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">accept<wbr>Current<wbr>ToS<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11059</li> + <li>Defined in Coscine.Api/api.ts:11712</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -3979,19 +4352,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>api<wbr>V2Users<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Tos<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Users<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Tos<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11067</li> + <li>Defined in Coscine.Api/api.ts:11721</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the current Terms of Service version.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4003,24 +4379,42 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-variable"> + <a name="TreeApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Tree<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Tree<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdTreesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getFileTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in index.ts:35</li> + </ul> + </aside> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdTrees<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">(</span>confirmationToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdTrees<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11076</li> + <li>Defined in Coscine.Api/api.ts:12121</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4029,7 +4423,10 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>confirmationToken: <span class="tsd-signature-type">string</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -4040,19 +4437,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> + <h5>create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataTreeForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MetadataTreeForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11084</li> + <li>Defined in Coscine.Api/api.ts:12133</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new metadata tree for a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4060,28 +4460,49 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> metadataTreeForCreationDto: <span class="tsd-signature-type">MetadataTreeForCreationDto</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Users<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Users<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicUserDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11094</li> + <li>Defined in Coscine.Api/api.ts:12148</li> </ul> </aside> <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>The <code>OrderBy</code> query is currently not supported.</p> + </div> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the file tree associated with a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4090,7 +4511,25 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>searchTerm: <span class="tsd-signature-type">string</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> @@ -4099,24 +4538,27 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicUserDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">(</span>externalAuthenticator<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExternalAuthenticators</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RdfFormat</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11103</li> + <li>Defined in Coscine.Api/api.ts:12164</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the metadata tree associated with a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4125,30 +4567,57 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>externalAuthenticator: <span class="tsd-signature-type">ExternalAuthenticators</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> format: <span class="tsd-signature-type">RdfFormat</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>userForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UserForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataTreeForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MetadataTreeForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11112</li> + <li>Defined in Coscine.Api/api.ts:12176</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates an existing metadata tree of a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4157,7 +4626,19 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> userForUpdateDto: <span class="tsd-signature-type">UserForUpdateDto</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> metadataTreeForUpdateDto: <span class="tsd-signature-type">MetadataTreeForUpdateDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -4171,9 +4652,9 @@ </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="VisibilityApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> Visibility<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Visibility<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2VisibilitiesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibilities<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibility<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <a name="UserApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> User<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">User<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2UsersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getUsers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:36</li> @@ -4183,19 +4664,22 @@ <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Visibilities<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Users<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Visibilities<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Users<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11757</li> + <li>Defined in Coscine.Api/api.ts:12399</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4212,19 +4696,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Visibilities<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Users<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Visibilities<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Users<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicUserDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11768</li> + <li>Defined in Coscine.Api/api.ts:12410</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all users.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4233,10 +4720,7 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + <h5>searchTerm: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> @@ -4245,39 +4729,7 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>get<wbr>Visibility<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Visibility<span class="tsd-signature-symbol">(</span>visibilityId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoResponse</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:11777</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5>visibilityId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicUserDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -4285,9 +4737,9 @@ </div> </section> <section class="tsd-panel tsd-member tsd-kind-variable"> - <a name="VocabularyApi" class="tsd-anchor"></a> - <h3><span class="tsd-flag ts-flagConst">Const</span> Vocabulary<wbr>Api</h3> - <div class="tsd-signature tsd-kind-icon">Vocabulary<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2VocabulariesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <a name="VisibilityApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Visibility<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Visibility<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2VisibilitiesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibilities<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibility<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:37</li> @@ -4297,19 +4749,22 @@ <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Vocabularies<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Visibilities<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Vocabularies<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Visibilities<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12100</li> + <li>Defined in Coscine.Api/api.ts:12633</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4326,19 +4781,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Vocabularies<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Visibilities<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Vocabularies<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AcceptedLanguage</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VocabularyDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Visibilities<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12113</li> + <li>Defined in Coscine.Api/api.ts:12645</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all visibilities.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4347,7 +4805,133 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchTerm: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Visibility<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Visibility<span class="tsd-signature-symbol">(</span>visibilityId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoResponse</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:12655</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a visibility by ID.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>visibilityId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the visibility.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VisibilityDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </div> + </section> + <section class="tsd-panel tsd-member tsd-kind-variable"> + <a name="VocabularyApi" class="tsd-anchor"></a> + <h3><span class="tsd-flag ts-flagConst">Const</span> Vocabulary<wbr>Api</h3> + <div class="tsd-signature tsd-kind-icon">Vocabulary<wbr>Api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>apiV2VocabulariesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <aside class="tsd-sources"> + <ul> + <li>Defined in index.ts:38</li> + </ul> + </aside> + <div class="tsd-type-declaration"> + <h4>Type declaration</h4> + <ul class="tsd-parameters"> + <li class="tsd-parameter"> + <h5>api<wbr>V2Vocabularies<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Vocabularies<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:12990</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Vocabularies<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Vocabularies<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AcceptedLanguage</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">VocabularyDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:13004</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves top-level instances from vocabularies.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchTerm: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">AcceptedLanguage</span></h5> @@ -4378,11 +4962,17 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12123</li> + <li>Defined in Coscine.Api/api.ts:13015</li> </ul> </aside> <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Could be a top-level instance, or an intermediate-level instance from a vocabulary.</p> + </div> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a single instance from a vocabulary.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4392,6 +4982,9 @@ <ul class="tsd-parameters"> <li> <h5>instance: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The URI of the vocabulary instance to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> acceptLanguage: <span class="tsd-signature-type">AcceptedLanguage</span></h5> @@ -4413,11 +5006,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12137</li> + <li>Defined in Coscine.Api/api.ts:13030</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves vocabulary instances.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4457,7 +5053,7 @@ <section class="tsd-panel tsd-member tsd-kind-variable"> <a name="default" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> default</h3> - <div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>AccountApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>accountGetLoginUrls<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>accountLogout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>AdminApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>adminGetProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>adminUpdateQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ApplicationProfileApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ApplicationProfilesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApplicationProfileRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRawApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>BlobApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>DisciplineApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2DisciplinesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDiscipline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDisciplines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>HomeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homeIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>LanguageApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LanguagesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>LicenseApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LicensesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicense<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicenses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>MaintenanceApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2MaintenancesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentMaintenance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>MergeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>mergeCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mergeLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ORCiDApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>oRCiDLoginGET<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>oRCiDLoginPOST<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>OrganizationApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2OrganizationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganization<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganizations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>PidApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2PidsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sendEmailToOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>validatePid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectInvitationApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdInvitationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>resolveProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectMemberApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>addMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2ProjectsProjectIdMembersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMemberships<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectQuotaApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdQuotasOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuotas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectResourceApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourcesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectResourceQuotaApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getQuotaForResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectResourceTypeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAvailableResourceTypesInformationForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ResourceApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ResourceTypeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourcesTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabBranchesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllResourceTypesInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getGitlabProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceTypeInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>RoleApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2RolesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRole<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRoles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>SearchApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>searchSearch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ShibbolethApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>shibbolethCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>shibbolethLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>TitleApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TitlesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ToSApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TosOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getToS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>TokenApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2UsersSelfTokensOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllApiTokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>revokeToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>TreeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdTreesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getFileTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>UserApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>acceptCurrentToS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2UsersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>confirmUserEmail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getUsers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initiateUserMerge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>VisibilityApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2VisibilitiesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibilities<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibility<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>VocabularyApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2VocabulariesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> + <div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>AccountApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>accountGetLoginUrls<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>accountLogout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>AdminApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>adminGetProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>adminUpdateQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ApplicationProfileApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ApplicationProfilesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApplicationProfileRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRawApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>BlobApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>DisciplineApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2DisciplinesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDiscipline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDisciplines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>HomeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homeIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>LanguageApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LanguagesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>LicenseApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LicensesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicense<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicenses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>MaintenanceApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2MaintenancesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentMaintenances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>MergeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>mergeCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mergeLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ORCiDApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>oRCiDLoginGET<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>oRCiDLoginPOST<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>OrganizationApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2OrganizationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganization<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganizations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>PidApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2PidsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sendRequestToOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>validatePid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectInvitationApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdInvitationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectMemberApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>addMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2ProjectsProjectIdMembersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMemberships<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectQuotaApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdQuotasOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuotas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectResourceApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourcesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectResourceQuotaApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getQuotaForResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ProjectResourceTypeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourceTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAvailableResourceTypesInformationForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ResourceApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ResourceTypeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourceTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabBranchesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllResourceTypesInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getGitlabProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceTypeInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>RoleApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2RolesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRole<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRoles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>SearchApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2SearchOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getSearchResults<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>SelfApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>acceptCurrentTos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2SelfOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>confirmUserEmail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initiateUserMerge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>resolveProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>SelfApiTokenApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2SelfApiTokensOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllApiTokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>revokeToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>ShibbolethApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>shibbolethCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>shibbolethLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>TitleApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TitlesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>TosApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TosOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>TreeApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdTreesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getFileTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMetadataTree<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>UserApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2UsersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getUsers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>VisibilityApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2VisibilitiesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibilities<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVisibility<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>VocabularyApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2VocabulariesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getVocabularyInstances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div> <aside class="tsd-sources"> <ul> <li>Defined in index.ts:4</li> @@ -4622,29 +5218,482 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Application<wbr>Profile<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ApplicationProfilesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApplicationProfileRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRawApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> + <li class="tsd-parameter"> + <h5>api<wbr>V2Application<wbr>Profiles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Application<wbr>Profiles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4514</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>create<wbr>Application<wbr>Profile<wbr>Request<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">create<wbr>Application<wbr>Profile<wbr>Request<span class="tsd-signature-symbol">(</span>applicationProfileForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ApplicationProfileForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileForCreationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4524</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Submits a request to create a new application profile.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> applicationProfileForCreationDto: <span class="tsd-signature-type">ApplicationProfileForCreationDto</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileForCreationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RdfFormat</span>, acceptLanguage<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AcceptedLanguage</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoResponse</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4536</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves an application profile by its URI.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>profile: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The URI of the application profile to retrieve.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> format: <span class="tsd-signature-type">RdfFormat</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> acceptLanguage: <span class="tsd-signature-type">AcceptedLanguage</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Application<wbr>Profiles<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Application<wbr>Profiles<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AcceptedLanguage</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4550</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all application profiles.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchTerm: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">AcceptedLanguage</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Raw<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4560</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the <code>raw</code> application profile definition by its URI.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>profile: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The URI of the application profile.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Blob<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> + <li class="tsd-parameter"> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdBlobs<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdBlobs<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4979</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>create<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">create<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:4992</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new blob for a resource.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> + </li> + <li> + <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key for the new blob.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <span class="tsd-signature-type">any</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>delete<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">delete<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:5004</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a blob from a resource.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> + </li> + <li> + <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key associated with the blob to delete.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>get<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">get<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:5016</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Download a blob from a resource.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> + </li> + <li> + <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key associated with the blob.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>update<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> + <li class="tsd-signature tsd-kind-icon">update<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + </ul> + <ul class="tsd-descriptions"> + <li class="tsd-description"> + <aside class="tsd-sources"> + <ul> + <li>Defined in Coscine.Api/api.ts:5029</li> + </ul> + </aside> + <div class="tsd-comment tsd-typography"> + <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates an existing blob of a resource.</p> + </dd> + <dt>throws</dt> + <dd><p>{RequiredError}</p> + </dd> + </dl> + </div> + <h4 class="tsd-parameters-title">Parameters</h4> + <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier or slug of the project.</p> + </div> + </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The identifier of the resource.</p> + </div> + </li> + <li> + <h5>key: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The key associated with the blob to update.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <span class="tsd-signature-type">any</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + </li> + </ul> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Application<wbr>Profile<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ApplicationProfilesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApplicationProfileRequest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApplicationProfiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRawApplicationProfile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Discipline<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2DisciplinesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDiscipline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDisciplines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Application<wbr>Profiles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Disciplines<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Application<wbr>Profiles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Disciplines<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4323</li> + <li>Defined in Coscine.Api/api.ts:5299</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4661,19 +5710,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Application<wbr>Profile<wbr>Request<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Discipline<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Application<wbr>Profile<wbr>Request<span class="tsd-signature-symbol">(</span>applicationProfileForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ApplicationProfileForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileForCreationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Discipline<span class="tsd-signature-symbol">(</span>disciplineId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4332</li> + <li>Defined in Coscine.Api/api.ts:5309</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a discipline with the specified ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4682,30 +5734,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> applicationProfileForCreationDto: <span class="tsd-signature-type">ApplicationProfileForCreationDto</span></h5> + <h5>disciplineId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the discipline.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileForCreationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Disciplines<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RdfFormat</span>, acceptLanguage<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AcceptedLanguage</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Disciplines<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4343</li> + <li>Defined in Coscine.Api/api.ts:5321</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all disciplines.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4714,36 +5772,44 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>profile: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> format: <span class="tsd-signature-type">RdfFormat</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> acceptLanguage: <span class="tsd-signature-type">AcceptedLanguage</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Home<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homeIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>Application<wbr>Profiles<span class="tsd-signature-symbol">: </span>function</h5> + <h5>home<wbr>Index<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Application<wbr>Profiles<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, language<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AcceptedLanguage</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">home<wbr>Index<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4356</li> + <li>Defined in Coscine.Api.STS/api.ts:296</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4751,43 +5817,36 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchTerm: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> language: <span class="tsd-signature-type">AcceptedLanguage</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApplicationProfileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Language<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LanguagesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>Raw<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Languages<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Raw<wbr>Application<wbr>Profile<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Languages<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4365</li> + <li>Defined in Coscine.Api/api.ts:5557</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4795,36 +5854,31 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>profile: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Blob<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdBlobsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateBlob<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdBlobs<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Language<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdBlobs<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Language<span class="tsd-signature-symbol">(</span>languageId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4768</li> + <li>Defined in Coscine.Api/api.ts:5567</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a language by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4833,33 +5887,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5>languageId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the language.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Languages<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Languages<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4780</li> + <li>Defined in Coscine.Api/api.ts:5579</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all languages.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4868,39 +5925,44 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5>key: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <span class="tsd-signature-type">any</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>License<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LicensesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicense<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicenses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>delete<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Licenses<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">delete<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Licenses<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4791</li> + <li>Defined in Coscine.Api/api.ts:5815</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4908,15 +5970,6 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>key: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -4926,19 +5979,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>License<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>License<span class="tsd-signature-symbol">(</span>licenseId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4802</li> + <li>Defined in Coscine.Api/api.ts:5825</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a license with the specified ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4947,36 +6003,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>key: <span class="tsd-signature-type">string</span></h5> + <h5>licenseId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the license.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Blob<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Licenses<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Blob<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, file<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Licenses<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:4814</li> + <li>Defined in Coscine.Api/api.ts:5837</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all licenses.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -4985,44 +6041,44 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5>key: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> file: <span class="tsd-signature-type">any</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Discipline<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2DisciplinesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDiscipline<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getDisciplines<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Maintenance<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2MaintenancesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentMaintenances<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Disciplines<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Maintenances<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Disciplines<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Maintenances<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5072</li> + <li>Defined in Coscine.Api/api.ts:6007</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5039,51 +6095,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Discipline<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Current<wbr>Maintenances<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Discipline<span class="tsd-signature-symbol">(</span>disciplineId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Maintenances<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5081</li> + <li>Defined in Coscine.Api/api.ts:6016</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> + <dt>summary</dt> + <dd><p>Retrieves the current maintenance messages.</p> </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5>disciplineId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoResponse</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>get<wbr>Disciplines<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Disciplines<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:5092</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5091,45 +6118,33 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DisciplineDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Home<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>homeIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Merge<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>mergeCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mergeLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>home<wbr>Index<span class="tsd-signature-symbol">: </span>function</h5> + <h5>merge<wbr>Callback<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">home<wbr>Index<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">merge<wbr>Callback<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:296</li> + <li>Defined in Coscine.Api.STS/api.ts:448</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> - <dt>summary</dt> - <dd><p>The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/</p> - </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5137,6 +6152,9 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -5145,21 +6163,16 @@ </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Language<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LanguagesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLanguages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Languages<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>merge<wbr>Login<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Languages<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">merge<wbr>Login<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5318</li> + <li>Defined in Coscine.Api.STS/api.ts:457</li> </ul> </aside> <div class="tsd-comment tsd-typography"> @@ -5171,28 +6184,39 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>ORCiDApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>oRCiDLoginGET<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>oRCiDLoginPOST<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>Language<span class="tsd-signature-symbol">: </span>function</h5> + <h5>oRCiDLoginGET<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Language<span class="tsd-signature-symbol">(</span>languageId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">oRCiDLoginGET<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5327</li> + <li>Defined in Coscine.Api.STS/api.ts:631</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>ORCiD Login Route</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5201,30 +6225,33 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>languageId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Languages<span class="tsd-signature-symbol">: </span>function</h5> + <h5>oRCiDLoginPOST<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Languages<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">oRCiDLoginPOST<span class="tsd-signature-symbol">(</span>oRCiDJWT<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5338</li> + <li>Defined in Coscine.Api.STS/api.ts:642</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Execute ORCiD validation and login</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5233,41 +6260,41 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> oRCiDJWT: <span class="tsd-signature-type">string</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LanguageDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>License<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2LicensesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicense<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getLicenses<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Organization<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2OrganizationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganization<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganizations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Licenses<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Organizations<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Licenses<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Organizations<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5564</li> + <li>Defined in Coscine.Api/api.ts:6243</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5284,19 +6311,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>License<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Organization<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>License<span class="tsd-signature-symbol">(</span>licenseId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Organization<span class="tsd-signature-symbol">(</span>organizationRorUri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5573</li> + <li>Defined in Coscine.Api/api.ts:6253</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves an organization.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5305,30 +6335,33 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>licenseId: <span class="tsd-signature-type">string</span></h5> + <h5>organizationRorUri: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Licenses<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Organizations<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Licenses<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Organizations<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5584</li> + <li>Defined in Coscine.Api/api.ts:6266</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all organizations.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5336,6 +6369,9 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchTerm: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> </li> @@ -5349,29 +6385,32 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">LicenseDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Maintenance<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2MaintenancesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentMaintenance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Pid<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2PidsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sendRequestToOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>validatePid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Maintenances<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Pids<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Maintenances<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Pids<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5746</li> + <li>Defined in Coscine.Api/api.ts:6505</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5388,19 +6427,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Current<wbr>Maintenance<span class="tsd-signature-symbol">: </span>function</h5> + <h5>send<wbr>Request<wbr>ToOwner<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Maintenance<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">send<wbr>Request<wbr>ToOwner<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pidRequestDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PidRequestDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5754</li> + <li>Defined in Coscine.Api/api.ts:6517</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Sends an inquiry to the owner of the given PID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5408,33 +6450,46 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5>prefix: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID prefix of a project or a resource to validate</p> + </div> + </li> + <li> + <h5>id: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID body of a project or a resource to validate</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pidRequestDto: <span class="tsd-signature-type">PidRequestDto</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MaintenanceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Merge<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>mergeCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>mergeLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>merge<wbr>Callback<span class="tsd-signature-symbol">: </span>function</h5> + <h5>validate<wbr>Pid<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">merge<wbr>Callback<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">validate<wbr>Pid<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PidValidationDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:448</li> + <li>Defined in Coscine.Api/api.ts:6528</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Validates the given PID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5443,30 +6498,47 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + <h5>prefix: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID prefix of a project or a resource to validate</p> + </div> + </li> + <li> + <h5>id: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The PID body of a project or a resource to validate</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PidValidationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Project<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>merge<wbr>Login<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">merge<wbr>Login<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:457</li> + <li>Defined in Coscine.Api/api.ts:6926</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5474,38 +6546,30 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>ORCiDApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>oRCiDLoginGET<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>oRCiDLoginPOST<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>oRCiDLoginGET<span class="tsd-signature-symbol">: </span>function</h5> + <h5>create<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">oRCiDLoginGET<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">create<wbr>Project<span class="tsd-signature-symbol">(</span>projectForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:631</li> + <li>Defined in Coscine.Api/api.ts:6936</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>ORCiD Login Route</p> + <dd><p>Creates a new project.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -5515,32 +6579,32 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectForCreationDto: <span class="tsd-signature-type">ProjectForCreationDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>oRCiDLoginPOST<span class="tsd-signature-symbol">: </span>function</h5> + <h5>delete<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">oRCiDLoginPOST<span class="tsd-signature-symbol">(</span>oRCiDJWT<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">delete<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:642</li> + <li>Defined in Coscine.Api/api.ts:6946</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>Execute ORCiD validation and login</p> + <dd><p>Deletes a project.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -5550,38 +6614,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> oRCiDJWT: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Organization<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2OrganizationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganization<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getOrganizations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Organizations<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Organizations<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, includeSubProjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5972</li> + <li>Defined in Coscine.Api/api.ts:6957</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5589,28 +6651,40 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeSubProjects: <span class="tsd-signature-type">boolean</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Organization<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Projects<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Organization<span class="tsd-signature-symbol">(</span>organizationRorUrl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Projects<span class="tsd-signature-symbol">(</span>topLevel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5981</li> + <li>Defined in Coscine.Api/api.ts:6970</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all projects.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5619,30 +6693,42 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>organizationRorUrl: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> topLevel: <span class="tsd-signature-type">boolean</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Organizations<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Organizations<span class="tsd-signature-symbol">(</span>searchTerm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:5993</li> + <li>Defined in Coscine.Api/api.ts:6981</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5651,44 +6737,44 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchTerm: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectForUpdateDto: <span class="tsd-signature-type">ProjectForUpdateDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OrganizationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Pid<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2PidsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>sendEmailToOwner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>validatePid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Project<wbr>Invitation<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdInvitationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Pids<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdInvitations<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Pids<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdInvitations<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6222</li> + <li>Defined in Coscine.Api/api.ts:7378</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5696,6 +6782,9 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -5705,19 +6794,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>send<wbr>Email<wbr>ToOwner<span class="tsd-signature-symbol">: </span>function</h5> + <h5>create<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">send<wbr>Email<wbr>ToOwner<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pidEnquiryDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PidEnquiryDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">create<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationForProjectManipulationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectInvitationForProjectManipulationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6233</li> + <li>Defined in Coscine.Api/api.ts:7389</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a project invitation for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5726,36 +6818,39 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>prefix: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>id: <span class="tsd-signature-type">string</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pidEnquiryDto: <span class="tsd-signature-type">PidEnquiryDto</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationForProjectManipulationDto: <span class="tsd-signature-type">ProjectInvitationForProjectManipulationDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>validate<wbr>Pid<span class="tsd-signature-symbol">: </span>function</h5> + <h5>delete<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">validate<wbr>Pid<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PidValidationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">delete<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6243</li> + <li>Defined in Coscine.Api/api.ts:7400</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a project invitation for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5764,38 +6859,42 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>prefix: <span class="tsd-signature-type">string</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5>id: <span class="tsd-signature-type">string</span></h5> + <h5>projectInvitationId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project invitation to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PidValidationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Project<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6625</li> + <li>Defined in Coscine.Api/api.ts:7411</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project invitation for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5803,28 +6902,43 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> + </li> + <li> + <h5>projectInvitationId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project invitation to retrieve.</p> + </div> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Project<wbr>Invitations<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Project<span class="tsd-signature-symbol">(</span>projectForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Invitations<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6634</li> + <li>Defined in Coscine.Api/api.ts:7424</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all project invitations for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5833,30 +6947,50 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectForCreationDto: <span class="tsd-signature-type">ProjectForCreationDto</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Project<wbr>Member<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>addMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2ProjectsProjectIdMembersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMemberships<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>delete<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>add<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">delete<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">add<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectRoleForProjectCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectRoleForProjectCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6643</li> + <li>Defined in Coscine.Api/api.ts:7870</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5866,29 +7000,38 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectRoleForProjectCreationDto: <span class="tsd-signature-type">ProjectRoleForProjectCreationDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdMembers<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, includeSubProjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdMembers<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6653</li> + <li>Defined in Coscine.Api/api.ts:7880</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5899,31 +7042,31 @@ <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeSubProjects: <span class="tsd-signature-type">boolean</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Projects<span class="tsd-signature-symbol">: </span>function</h5> + <h5>delete<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Projects<span class="tsd-signature-symbol">(</span>topLevel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">delete<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, membershipId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6665</li> + <li>Defined in Coscine.Api/api.ts:7891</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5932,39 +7075,42 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> topLevel: <span class="tsd-signature-type">boolean</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project membership to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, membershipId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:6675</li> + <li>Defined in Coscine.Api/api.ts:7902</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -5974,37 +7120,41 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectForUpdateDto: <span class="tsd-signature-type">ProjectForUpdateDto</span></h5> + <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project membership to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Project<wbr>Invitation<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdInvitationsOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectInvitations<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>resolveProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdInvitations<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Memberships<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdInvitations<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Memberships<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7106</li> + <li>Defined in Coscine.Api/api.ts:7915</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all project memberships for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6014,29 +7164,44 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationForProjectManipulationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectInvitationForProjectManipulationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, membershipId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectRoleForProjectManipulationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectRoleForProjectManipulationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7116</li> + <li>Defined in Coscine.Api/api.ts:7927</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a project membership for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6046,32 +7211,49 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationForProjectManipulationDto: <span class="tsd-signature-type">ProjectInvitationForProjectManipulationDto</span></h5> + <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the project membership to update.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectRoleForProjectManipulationDto: <span class="tsd-signature-type">ProjectRoleForProjectManipulationDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Project<wbr>Quota<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdQuotasOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuotas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>delete<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdQuotas<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">delete<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdQuotas<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7126</li> + <li>Defined in Coscine.Api/api.ts:8280</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6082,9 +7264,6 @@ <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> </li> - <li> - <h5>projectInvitationId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -6094,19 +7273,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceTypeId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7136</li> + <li>Defined in Coscine.Api/api.ts:8291</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a project quota for a specified project and resource type.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6116,32 +7298,41 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5>projectInvitationId: <span class="tsd-signature-type">string</span></h5> + <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource type.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Project<wbr>Invitations<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Project<wbr>Quotas<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Invitations<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Quotas<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7148</li> + <li>Defined in Coscine.Api/api.ts:8304</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all project quotas for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6151,6 +7342,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -6165,24 +7359,27 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectInvitationDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectInvitationResolveDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectInvitationResolveDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceTypeId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectQuotaForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectQuotaForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7158</li> + <li>Defined in Coscine.Api/api.ts:8316</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a project quota for a specified project and resource type.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6192,9 +7389,18 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationResolveDto: <span class="tsd-signature-type">ProjectInvitationResolveDto</span></h5> + <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource type.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectQuotaForUpdateDto: <span class="tsd-signature-type">ProjectQuotaForUpdateDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -6207,22 +7413,25 @@ </ul> </li> <li class="tsd-parameter"> - <h5>Project<wbr>Member<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>addMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2ProjectsProjectIdMembersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getMemberships<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateMembership<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Project<wbr>Resource<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourcesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>add<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">add<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectRoleForProjectCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectRoleForProjectCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7598</li> + <li>Defined in Coscine.Api/api.ts:8749</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6233,31 +7442,31 @@ <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectRoleForProjectCreationDto: <span class="tsd-signature-type">ProjectRoleForProjectCreationDto</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdMembers<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>create<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdMembers<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">create<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ResourceForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7607</li> + <li>Defined in Coscine.Api/api.ts:8760</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6267,29 +7476,38 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> resourceForCreationDto: <span class="tsd-signature-type">ResourceForCreationDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>delete<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> + <h5>delete<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">delete<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, membershipId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">delete<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7617</li> + <li>Defined in Coscine.Api/api.ts:8771</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Deletes a resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6299,9 +7517,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to delete.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -6312,19 +7536,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, membershipId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7627</li> + <li>Defined in Coscine.Api/api.ts:8782</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6334,32 +7561,41 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Memberships<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Resources<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Memberships<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Resources<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7639</li> + <li>Defined in Coscine.Api/api.ts:8795</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all resources for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6369,6 +7605,9 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> @@ -6383,24 +7622,27 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectRoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Membership<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Membership<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, membershipId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectRoleForProjectManipulationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectRoleForProjectManipulationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ResourceForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7650</li> + <li>Defined in Coscine.Api/api.ts:8807</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates a resource for a specified project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6410,12 +7652,18 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5>membershipId: <span class="tsd-signature-type">string</span></h5> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to update.</p> + </div> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectRoleForProjectManipulationDto: <span class="tsd-signature-type">ProjectRoleForProjectManipulationDto</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> resourceForUpdateDto: <span class="tsd-signature-type">ResourceForUpdateDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -6428,22 +7676,25 @@ </ul> </li> <li class="tsd-parameter"> - <h5>Project<wbr>Quota<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdQuotasOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getProjectQuotas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateProjectQuota<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Project<wbr>Resource<wbr>Quota<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getQuotaForResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdQuotas<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdQuota<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdQuotas<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdQuota<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7988</li> + <li>Defined in Coscine.Api/api.ts:9042</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6454,6 +7705,9 @@ <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> </li> + <li> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -6463,19 +7717,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Quota<wbr>For<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceTypeId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Quota<wbr>For<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:7998</li> + <li>Defined in Coscine.Api/api.ts:9053</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the resource quota for a specific resource in a project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6485,32 +7742,46 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> - <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Project<wbr>Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourceTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAvailableResourceTypesInformationForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>Project<wbr>Quotas<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Project<wbr>Quotas<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8010</li> + <li>Defined in Coscine.Api/api.ts:9223</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6521,37 +7792,31 @@ <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ProjectQuotaDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Available<wbr>Resource<wbr>Types<wbr>Information<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Project<wbr>Quota<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceTypeId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectQuotaForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectQuotaForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Available<wbr>Resource<wbr>Types<wbr>Information<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8021</li> + <li>Defined in Coscine.Api/api.ts:9233</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the available resource types information for a specific project.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6561,40 +7826,40 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectQuotaForUpdateDto: <span class="tsd-signature-type">ProjectQuotaForUpdateDto</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The Id or slug of the project.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Project<wbr>Resource<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>deleteResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourcesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Resource<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Resources<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Resources<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8437</li> + <li>Defined in Coscine.Api/api.ts:9395</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6602,9 +7867,6 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -6614,19 +7876,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Resource<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ResourceForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Resource<span class="tsd-signature-symbol">(</span>resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8447</li> + <li>Defined in Coscine.Api/api.ts:9405</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a resource by its ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6635,10 +7900,10 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> resourceForCreationDto: <span class="tsd-signature-type">ResourceForCreationDto</span></h5> + <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -6648,20 +7913,28 @@ </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourceTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabBranchesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllResourceTypesInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getGitlabProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceTypeInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>delete<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Resource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">delete<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Resource<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8457</li> + <li>Defined in Coscine.Api/api.ts:9796</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6669,12 +7942,6 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -6684,19 +7951,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>All<wbr>Gitlab<wbr>Branches<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Gitlab<wbr>Branches<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>gitlabProjectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabBranchDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8467</li> + <li>Defined in Coscine.Api/api.ts:9808</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6705,33 +7975,42 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <h5>gitlabProjectId: <span class="tsd-signature-type">number</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the GitLab project.</p> + </div> </li> <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5>domain: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5>accessToken: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabBranchDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Resources<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>All<wbr>Gitlab<wbr>Projects<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Resources<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Gitlab<wbr>Projects<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8479</li> + <li>Defined in Coscine.Api/api.ts:9819</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6740,39 +8019,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + <h5>domain: <span class="tsd-signature-type">string</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5>accessToken: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>update<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>All<wbr>Resource<wbr>Types<wbr>Information<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ResourceForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Resource<wbr>Types<wbr>Information<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8490</li> + <li>Defined in Coscine.Api/api.ts:9828</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the entire global resource types information.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6780,42 +8056,31 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> resourceForUpdateDto: <span class="tsd-signature-type">ResourceForUpdateDto</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Project<wbr>Resource<wbr>Quota<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesResourceIdQuotaOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getQuotaForResourceForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdQuota<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Gitlab<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Resource<wbr>IdQuota<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Gitlab<wbr>Project<span class="tsd-signature-symbol">(</span>gitlabProjectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8714</li> + <li>Defined in Coscine.Api/api.ts:9840</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6824,33 +8089,42 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <h5>gitlabProjectId: <span class="tsd-signature-type">number</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the GitLab project.</p> + </div> </li> <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5>domain: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5>accessToken: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Quota<wbr>For<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Resource<wbr>Type<wbr>Information<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Quota<wbr>For<wbr>Resource<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Resource<wbr>Type<wbr>Information<span class="tsd-signature-symbol">(</span>resourceTypeId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8724</li> + <li>Defined in Coscine.Api/api.ts:9850</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the resource type information for a specific resource type.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6859,38 +8133,41 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the resource type to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceQuotaDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Project<wbr>Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ProjectsProjectIdResourcesTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAvailableResourceTypesInformationForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Role<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2RolesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRole<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRoles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Roles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Projects<wbr>Project<wbr>IdResources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Roles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8887</li> + <li>Defined in Coscine.Api/api.ts:10124</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6898,9 +8175,6 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -6910,19 +8184,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Available<wbr>Resource<wbr>Types<wbr>Information<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Role<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Available<wbr>Resource<wbr>Types<wbr>Information<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Role<span class="tsd-signature-symbol">(</span>roleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:8896</li> + <li>Defined in Coscine.Api/api.ts:10134</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a role by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6931,64 +8208,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>projectId: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + <h5>roleId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the role.</p> + </div> </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Resource<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourcesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> - <li class="tsd-parameter"> - <h5>api<wbr>V2Resources<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Resources<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:9051</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Resource<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Roles<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Resource<span class="tsd-signature-symbol">(</span>resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Roles<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9060</li> + <li>Defined in Coscine.Api/api.ts:10146</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all roles.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -6997,35 +8246,44 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Resource<wbr>Type<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2ResourcesTypesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabBranchesForProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllGitlabProjects<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllResourceTypesInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getGitlabProject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getResourceTypeInformation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Search<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2SearchOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getSearchResults<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Resources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Search<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Resources<wbr>Types<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Search<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9436</li> + <li>Defined in Coscine.Api/api.ts:10358</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7042,19 +8300,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>All<wbr>Gitlab<wbr>Branches<wbr>For<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Search<wbr>Results<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Gitlab<wbr>Branches<wbr>For<wbr>Project<span class="tsd-signature-symbol">(</span>gitlabProjectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabBranchDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Search<wbr>Results<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, useAdvancedSyntax<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, languages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, category<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SearchCategoryType</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchResultDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9447</li> + <li>Defined in Coscine.Api/api.ts:10374</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a search result by given search parameters.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7063,71 +8324,56 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>gitlabProjectId: <span class="tsd-signature-type">number</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> query: <span class="tsd-signature-type">string</span></h5> </li> <li> - <h5>domain: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> useAdvancedSyntax: <span class="tsd-signature-type">boolean</span></h5> </li> <li> - <h5>accessToken: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> languages: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> category: <span class="tsd-signature-type">SearchCategoryType</span></h5> </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabBranchDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>get<wbr>All<wbr>Gitlab<wbr>Projects<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Gitlab<wbr>Projects<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:9457</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> <li> - <h5>domain: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> </li> <li> - <h5>accessToken: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchResultDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Self<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>acceptCurrentTos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2SelfOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>confirmUserEmail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initiateUserMerge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>resolveProjectInvitation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>All<wbr>Resource<wbr>Types<wbr>Information<span class="tsd-signature-symbol">: </span>function</h5> + <h5>accept<wbr>Current<wbr>Tos<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Resource<wbr>Types<wbr>Information<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">accept<wbr>Current<wbr>Tos<span class="tsd-signature-symbol">(</span>userTermsOfServiceAcceptDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UserTermsOfServiceAcceptDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9465</li> + <li>Defined in Coscine.Api/api.ts:10783</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Accepts the current Terms Of Service for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7135,28 +8381,34 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> userTermsOfServiceAcceptDto: <span class="tsd-signature-type">UserTermsOfServiceAcceptDto</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoIEnumerableResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Gitlab<wbr>Project<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Self<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Gitlab<wbr>Project<span class="tsd-signature-symbol">(</span>gitlabProjectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, accessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Self<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9476</li> + <li>Defined in Coscine.Api/api.ts:10792</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7164,37 +8416,31 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>gitlabProjectId: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5>domain: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5>accessToken: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GitlabProjectDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Resource<wbr>Type<wbr>Information<span class="tsd-signature-symbol">: </span>function</h5> + <h5>confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Resource<wbr>Type<wbr>Information<span class="tsd-signature-symbol">(</span>resourceTypeId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">(</span>confirmationToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9485</li> + <li>Defined in Coscine.Api/api.ts:10802</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Confirms the email of a user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7203,35 +8449,33 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>resourceTypeId: <span class="tsd-signature-type">string</span></h5> + <h5>confirmationToken: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ResourceTypeInformationDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Role<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2RolesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRole<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getRoles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Roles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Roles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9746</li> + <li>Defined in Coscine.Api/api.ts:10811</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7243,24 +8487,27 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Role<span class="tsd-signature-symbol">: </span>function</h5> + <h5>initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Role<span class="tsd-signature-symbol">(</span>roleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">(</span>identityProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IdentityProviders</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9755</li> + <li>Defined in Coscine.Api/api.ts:10821</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Initiates user merging for the current user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7269,30 +8516,33 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>roleId: <span class="tsd-signature-type">string</span></h5> + <h5>identityProvider: <span class="tsd-signature-type">IdentityProviders</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Roles<span class="tsd-signature-symbol">: </span>function</h5> + <h5>resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Roles<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">resolve<wbr>Project<wbr>Invitation<span class="tsd-signature-symbol">(</span>projectInvitationResolveDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ProjectInvitationResolveDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9766</li> + <li>Defined in Coscine.Api/api.ts:10831</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Resolves a project invitation for the authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7301,43 +8551,32 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> projectInvitationResolveDto: <span class="tsd-signature-type">ProjectInvitationResolveDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">RoleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Search<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>searchSearch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>search<wbr>Search<span class="tsd-signature-symbol">: </span>function</h5> + <h5>update<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">search<wbr>Search<span class="tsd-signature-symbol">(</span>searchQuery<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, includeUsers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, useAdvancedSyntax<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, includedLanguages<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, categoryFilter<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CategoryFilter</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OrderBy</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ItemSearchResult</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">update<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>userForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UserForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.Search/api.ts:221</li> + <li>Defined in Coscine.Api/api.ts:10841</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>Search Elasticsearch</p> + <dd><p>Updates the current authenticated user.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -7347,58 +8586,37 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> searchQuery: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeUsers: <span class="tsd-signature-type">boolean</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> useAdvancedSyntax: <span class="tsd-signature-type">boolean</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> includedLanguages: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> categoryFilter: <span class="tsd-signature-type">CategoryFilter</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">OrderBy</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> userForUpdateDto: <span class="tsd-signature-type">UserForUpdateDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ItemSearchResult</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Shibboleth<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>shibbolethCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>shibbolethLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Self<wbr>Api<wbr>Token<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2SelfApiTokensOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllApiTokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>revokeToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>shibboleth<wbr>Callback<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Self<wbr>Api<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Callback<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, remoteError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Self<wbr>Api<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:826</li> + <li>Defined in Coscine.Api/api.ts:11218</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>Callback method to catch the login</p> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -7407,36 +8625,30 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> remoteError: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>shibboleth<wbr>Login<span class="tsd-signature-symbol">: </span>function</h5> + <h5>create<wbr>Api<wbr>Token<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Login<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, entityId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">create<wbr>Api<wbr>Token<span class="tsd-signature-symbol">(</span>apiTokenForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ApiTokenForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api.STS/api.ts:837</li> + <li>Defined in Coscine.Api/api.ts:11228</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>summary</dt> - <dd><p>This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the "entityId" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.</p> + <dd><p>Creates an API token for the current authenticated user.</p> </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> @@ -7446,38 +8658,33 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> entityId: <span class="tsd-signature-type">string</span></h5> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> apiTokenForCreationDto: <span class="tsd-signature-type">ApiTokenForCreationDto</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>Title<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TitlesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> - <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>All<wbr>Api<wbr>Tokens<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Api<wbr>Tokens<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:9992</li> + <li>Defined in Coscine.Api/api.ts:11240</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all API tokens for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7485,28 +8692,40 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Title<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Api<wbr>Token<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Title<span class="tsd-signature-symbol">(</span>titleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Api<wbr>Token<span class="tsd-signature-symbol">(</span>apiTokenId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10001</li> + <li>Defined in Coscine.Api/api.ts:11250</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves an API token for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7515,30 +8734,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5>titleId: <span class="tsd-signature-type">string</span></h5> + <h5>apiTokenId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the token.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>Titles<span class="tsd-signature-symbol">: </span>function</h5> + <h5>revoke<wbr>Token<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Titles<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">revoke<wbr>Token<span class="tsd-signature-symbol">(</span>apiTokenId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10012</li> + <li>Defined in Coscine.Api/api.ts:11260</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Revokes an API token for the current authenticated user.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7547,41 +8772,41 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageNumber: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> orderBy: <span class="tsd-signature-type">string</span></h5> + <h5>apiTokenId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the token.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>ToSApi<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TosOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getToS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Shibboleth<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>shibbolethCallback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>shibbolethLogin<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>shibboleth<wbr>Callback<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Callback<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, remoteError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10174</li> + <li>Defined in Coscine.Api.STS/api.ts:826</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Callback method to catch the login</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7589,28 +8814,37 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> remoteError: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>ToS<span class="tsd-signature-symbol">: </span>function</h5> + <h5>shibboleth<wbr>Login<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>ToS<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">shibboleth<wbr>Login<span class="tsd-signature-symbol">(</span>returnUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, entityId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10182</li> + <li>Defined in Coscine.Api.STS/api.ts:837</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>This method is the central route for logging into an identity provider. On default, the user is redirected to the WAFY of the DFN-AAI. Setting the "entityId" parameter allows the application to redirect to a specific identity provider defined by DFN-AAI.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7618,33 +8852,42 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> returnUrl: <span class="tsd-signature-type">string</span></h5> + </li> + <li> + <h5><span class="tsd-flag ts-flagOptional">Optional</span> entityId: <span class="tsd-signature-type">string</span></h5> + </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> - <h5>Token<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2UsersSelfTokensOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>createApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getAllApiTokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getApiToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>revokeToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>Title<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TitlesOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTitles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>api<wbr>V2Users<wbr>Self<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">api<wbr>V2Users<wbr>Self<wbr>Tokens<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Titles<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11471</li> + <li>Defined in Coscine.Api/api.ts:11520</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7661,19 +8904,22 @@ </ul> </li> <li class="tsd-parameter"> - <h5>create<wbr>Api<wbr>Token<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Title<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Api<wbr>Token<span class="tsd-signature-symbol">(</span>apiTokenForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ApiTokenForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Title<span class="tsd-signature-symbol">(</span>titleId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11480</li> + <li>Defined in Coscine.Api/api.ts:11530</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a title by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7682,30 +8928,36 @@ <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> apiTokenForCreationDto: <span class="tsd-signature-type">ApiTokenForCreationDto</span></h5> + <h5>titleId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the title.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>get<wbr>All<wbr>Api<wbr>Tokens<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Titles<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Api<wbr>Tokens<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Titles<span class="tsd-signature-symbol">(</span>pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11491</li> + <li>Defined in Coscine.Api/api.ts:11542</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all titles.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7726,24 +8978,32 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TitleDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> + </ul> + </li> + <li class="tsd-parameter"> + <h5>Tos<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2TosOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getTos<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <ul class="tsd-parameters"> <li class="tsd-parameter"> - <h5>get<wbr>Api<wbr>Token<span class="tsd-signature-symbol">: </span>function</h5> + <h5>api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Api<wbr>Token<span class="tsd-signature-symbol">(</span>apiTokenId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">api<wbr>V2Tos<wbr>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11500</li> + <li>Defined in Coscine.Api/api.ts:11712</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7751,31 +9011,31 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>apiTokenId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ApiTokenDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> - <h5>revoke<wbr>Token<span class="tsd-signature-symbol">: </span>function</h5> + <h5>get<wbr>Tos<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">revoke<wbr>Token<span class="tsd-signature-symbol">(</span>apiTokenId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Tos<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11509</li> + <li>Defined in Coscine.Api/api.ts:11721</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the current Terms of Service version.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7783,14 +9043,11 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>apiTokenId: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TermsOfServiceDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -7808,11 +9065,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10569</li> + <li>Defined in Coscine.Api/api.ts:12121</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7837,17 +9097,20 @@ <li class="tsd-parameter"> <h5>create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataTreeForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MetadataTreeForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">create<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, metadataTreeForCreationDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">MetadataTreeForCreationDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10580</li> + <li>Defined in Coscine.Api/api.ts:12133</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Creates a new metadata tree for a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7857,9 +9120,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> metadataTreeForCreationDto: <span class="tsd-signature-type">MetadataTreeForCreationDto</span></h5> @@ -7868,24 +9137,30 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>File<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10594</li> + <li>Defined in Coscine.Api/api.ts:12148</li> </ul> </aside> <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>The <code>OrderBy</code> query is currently not supported.</p> + </div> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the file tree associated with a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7895,9 +9170,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> @@ -7915,24 +9196,27 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FileTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> <li class="tsd-parameter"> <h5>get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RdfFormat</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> + <li class="tsd-signature tsd-kind-icon">get<wbr>Metadata<wbr>Tree<span class="tsd-signature-symbol">(</span>projectId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, resourceId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, format<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RdfFormat</span>, pageNumber<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, orderBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10609</li> + <li>Defined in Coscine.Api/api.ts:12164</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves the metadata tree associated with a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7942,9 +9226,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> path: <span class="tsd-signature-type">string</span></h5> @@ -7965,7 +9255,7 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">MetadataTreeDtoIEnumerablePagedResponse</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </li> @@ -7978,11 +9268,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:10620</li> + <li>Defined in Coscine.Api/api.ts:12176</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Updates an existing metadata tree of a resource.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -7992,9 +9285,15 @@ <ul class="tsd-parameters"> <li> <h5>projectId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier or slug of the project.</p> + </div> </li> <li> <h5>resourceId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The unique identifier of the resource.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> metadataTreeForUpdateDto: <span class="tsd-signature-type">MetadataTreeForUpdateDto</span></h5> @@ -8010,37 +9309,8 @@ </ul> </li> <li class="tsd-parameter"> - <h5>User<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>acceptCurrentToS<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>apiV2UsersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>confirmUserEmail<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getUsers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>initiateUserMerge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>updateCurrentUser<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> + <h5>User<wbr>Api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>apiV2UsersOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>getUsers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> - <li class="tsd-parameter"> - <h5>accept<wbr>Current<wbr>ToS<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">accept<wbr>Current<wbr>ToS<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:11059</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> <li class="tsd-parameter"> <h5>api<wbr>V2Users<wbr>Options<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> @@ -8050,40 +9320,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11067</li> + <li>Defined in Coscine.Api/api.ts:12399</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">confirm<wbr>User<wbr>Email<span class="tsd-signature-symbol">(</span>confirmationToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:11076</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8091,9 +9335,6 @@ </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> - <li> - <h5>confirmationToken: <span class="tsd-signature-type">string</span></h5> - </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> </li> @@ -8102,35 +9343,6 @@ </li> </ul> </li> - <li class="tsd-parameter"> - <h5>get<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:11084</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserDtoResponse</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> <li class="tsd-parameter"> <h5>get<wbr>Users<span class="tsd-signature-symbol">: </span>function</h5> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> @@ -8140,11 +9352,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11094</li> + <li>Defined in Coscine.Api/api.ts:12410</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all users.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8166,70 +9381,6 @@ </li> </ul> </li> - <li class="tsd-parameter"> - <h5>initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">initiate<wbr>User<wbr>Merge<span class="tsd-signature-symbol">(</span>externalAuthenticator<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ExternalAuthenticators</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:11103</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5>externalAuthenticator: <span class="tsd-signature-type">ExternalAuthenticators</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">UserMergeDtoResponse</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> - <li class="tsd-parameter"> - <h5>update<wbr>Current<wbr>User<span class="tsd-signature-symbol">: </span>function</h5> - <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"> - <li class="tsd-signature tsd-kind-icon">update<wbr>Current<wbr>User<span class="tsd-signature-symbol">(</span>userForUpdateDto<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">UserForUpdateDto</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> - </ul> - <ul class="tsd-descriptions"> - <li class="tsd-description"> - <aside class="tsd-sources"> - <ul> - <li>Defined in Coscine.Api/api.ts:11112</li> - </ul> - </aside> - <div class="tsd-comment tsd-typography"> - <dl class="tsd-comment-tags"> - <dt>throws</dt> - <dd><p>{RequiredError}</p> - </dd> - </dl> - </div> - <h4 class="tsd-parameters-title">Parameters</h4> - <ul class="tsd-parameters"> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> userForUpdateDto: <span class="tsd-signature-type">UserForUpdateDto</span></h5> - </li> - <li> - <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> - </li> - </ul> - <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> - </li> - </ul> - </li> </ul> </li> <li class="tsd-parameter"> @@ -8244,11 +9395,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11757</li> + <li>Defined in Coscine.Api/api.ts:12633</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8273,11 +9427,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11768</li> + <li>Defined in Coscine.Api/api.ts:12645</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves all visibilities.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8311,11 +9468,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:11777</li> + <li>Defined in Coscine.Api/api.ts:12655</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a visibility by ID.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8325,6 +9485,9 @@ <ul class="tsd-parameters"> <li> <h5>visibilityId: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The ID of the visibility.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5> @@ -8348,11 +9511,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12100</li> + <li>Defined in Coscine.Api/api.ts:12990</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Responds with the HTTP methods allowed for the endpoint.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8377,11 +9543,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12113</li> + <li>Defined in Coscine.Api/api.ts:13004</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves top-level instances from vocabularies.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8421,11 +9590,17 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12123</li> + <li>Defined in Coscine.Api/api.ts:13015</li> </ul> </aside> <div class="tsd-comment tsd-typography"> + <div class="lead"> + <p>Could be a top-level instance, or an intermediate-level instance from a vocabulary.</p> + </div> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves a single instance from a vocabulary.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8435,6 +9610,9 @@ <ul class="tsd-parameters"> <li> <h5>instance: <span class="tsd-signature-type">string</span></h5> + <div class="tsd-comment tsd-typography"> + <p>The URI of the vocabulary instance to retrieve.</p> + </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> acceptLanguage: <span class="tsd-signature-type">AcceptedLanguage</span></h5> @@ -8456,11 +9634,14 @@ <li class="tsd-description"> <aside class="tsd-sources"> <ul> - <li>Defined in Coscine.Api/api.ts:12137</li> + <li>Defined in Coscine.Api/api.ts:13030</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> + <dt>summary</dt> + <dd><p>Retrieves vocabulary instances.</p> + </dd> <dt>throws</dt> <dd><p>{RequiredError}</p> </dd> @@ -8584,16 +9765,19 @@ <a href="modules.html#SearchApi" class="tsd-kind-icon">Search<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#ShibbolethApi" class="tsd-kind-icon">Shibboleth<wbr>Api</a> + <a href="modules.html#SelfApi" class="tsd-kind-icon">Self<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#TitleApi" class="tsd-kind-icon">Title<wbr>Api</a> + <a href="modules.html#SelfApiTokenApi" class="tsd-kind-icon">Self<wbr>Api<wbr>Token<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#ToSApi" class="tsd-kind-icon">ToSApi</a> + <a href="modules.html#ShibbolethApi" class="tsd-kind-icon">Shibboleth<wbr>Api</a> + </li> + <li class=" tsd-kind-variable"> + <a href="modules.html#TitleApi" class="tsd-kind-icon">Title<wbr>Api</a> </li> <li class=" tsd-kind-variable"> - <a href="modules.html#TokenApi" class="tsd-kind-icon">Token<wbr>Api</a> + <a href="modules.html#TosApi" class="tsd-kind-icon">Tos<wbr>Api</a> </li> <li class=" tsd-kind-variable"> <a href="modules.html#TreeApi" class="tsd-kind-icon">Tree<wbr>Api</a> diff --git a/src/Coscine.Api.Admin/.gitignore b/src/Coscine.Api.Admin/.gitignore deleted file mode 100644 index 149b57654723c14590f35c6c0db8460f19173078..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -wwwroot/*.js -node_modules -typings -dist diff --git a/src/Coscine.Api.Admin/.npmignore b/src/Coscine.Api.Admin/.npmignore deleted file mode 100644 index 999d88df6939a13529be54ef2e68fb3248257ad8..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/.npmignore +++ /dev/null @@ -1 +0,0 @@ -# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/src/Coscine.Api.Admin/.openapi-generator-ignore b/src/Coscine.Api.Admin/.openapi-generator-ignore deleted file mode 100644 index 7484ee590a3894506cf063799b885428f95a71be..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/.openapi-generator-ignore +++ /dev/null @@ -1,23 +0,0 @@ -# OpenAPI Generator Ignore -# Generated by openapi-generator https://github.com/openapitools/openapi-generator - -# Use this file to prevent files from being overwritten by the generator. -# The patterns follow closely to .gitignore or .dockerignore. - -# As an example, the C# client generator defines ApiClient.cs. -# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: -#ApiClient.cs - -# You can match any string of characters against a directory, file or extension with a single asterisk (*): -#foo/*/qux -# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux - -# You can recursively match patterns against a directory, file or extension with a double asterisk (**): -#foo/**/qux -# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux - -# You can also negate patterns with an exclamation (!). -# For example, you can ignore all files in a docs folder with the file extension .md: -#docs/*.md -# Then explicitly reverse the ignore rule for a single file: -#!docs/README.md diff --git a/src/Coscine.Api.Admin/.openapi-generator/FILES b/src/Coscine.Api.Admin/.openapi-generator/FILES deleted file mode 100644 index 16b445eee6ddfbfbfe345427f484f94cba9ee946..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/.openapi-generator/FILES +++ /dev/null @@ -1,9 +0,0 @@ -.gitignore -.npmignore -.openapi-generator-ignore -api.ts -base.ts -common.ts -configuration.ts -git_push.sh -index.ts diff --git a/src/Coscine.Api.Admin/.openapi-generator/VERSION b/src/Coscine.Api.Admin/.openapi-generator/VERSION deleted file mode 100644 index 804440660c71cc833e24b1a87544a706fb3eac35..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -5.2.1 \ No newline at end of file diff --git a/src/Coscine.Api.Admin/api.ts b/src/Coscine.Api.Admin/api.ts deleted file mode 100644 index bf67a179de899aec384ba36b29783380a1431ff3..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/api.ts +++ /dev/null @@ -1,339 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Admin - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 3.0.5 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from './configuration'; -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; -// Some imports not used depending on template conditions -// @ts-ignore -import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; -// @ts-ignore -import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; - -/** - * Retuned when searching for a project. Contains basic informations and quotas. - * @export - * @interface AdminProjectObject - */ -export interface AdminProjectObject { - /** - * Project Id - * @type {string} - * @memberof AdminProjectObject - */ - id?: string; - /** - * Project Name (full project name) - * @type {string} - * @memberof AdminProjectObject - */ - projectName?: string | null; - /** - * Project Display Name - * @type {string} - * @memberof AdminProjectObject - */ - displayName?: string | null; - /** - * List of the admin quotas (AdminQuotaReturnObject) - * @type {Array<AdminQuotaReturnObject>} - * @memberof AdminProjectObject - */ - quotas?: Array<AdminQuotaReturnObject> | null; -} -/** - * Returned when searching for a project, as part of the AdminProjectObject. Contains quota informations. - * @export - * @interface AdminQuotaReturnObject - */ -export interface AdminQuotaReturnObject { - /** - * Quota relation id (See Database, Table \'ProjectQuotas\', Column \'RelationId\'). - * @type {string} - * @memberof AdminQuotaReturnObject - */ - relationId?: string; - /** - * Which resource type the quota is referring to. - * @type {string} - * @memberof AdminQuotaReturnObject - */ - resourceType?: string | null; - /** - * How much space is used by all files in all resources in total [Bytes]. - * @type {QuotaDimObject} - * @memberof AdminQuotaReturnObject - */ - totalUsed?: QuotaDimObject | null; - /** - * How much space is reserved by resources in total [GiB]. Is equal to the sum of all resource quota reserved values. - * @type {QuotaDimObject} - * @memberof AdminQuotaReturnObject - */ - totalReserved?: QuotaDimObject | null; - /** - * How much space is currently allocated and is available to be taken by resources [GiB] (See Database, Table \'ProjectQuotas\', Column \'Quota\'). - * @type {QuotaDimObject} - * @memberof AdminQuotaReturnObject - */ - allocated?: QuotaDimObject | null; - /** - * How much maximum space is possible to be taken by resources [GiB] (See Database, Table \'ProjectQuotas\', Column \'MaxQuota\'). - * @type {QuotaDimObject} - * @memberof AdminQuotaReturnObject - */ - maximum?: QuotaDimObject | null; -} -/** - * - * @export - * @interface QuotaDimObject - */ -export interface QuotaDimObject { - /** - * - * @type {number} - * @memberof QuotaDimObject - */ - value?: number; - /** - * - * @type {QuotaUnit} - * @memberof QuotaDimObject - */ - unit?: QuotaUnit; -} -/** - * - * @export - * @enum {string} - */ - -export enum QuotaUnit { - Byte = 'https://qudt.org/vocab/unit/BYTE', - KibiByte = 'https://qudt.org/vocab/unit/KibiBYTE', - MebiByte = 'https://qudt.org/vocab/unit/MebiBYTE', - GibiByte = 'https://qudt.org/vocab/unit/GibiBYTE', - TebiByte = 'https://qudt.org/vocab/unit/TebiBYTE', - PebiByte = 'https://qudt.org/vocab/unit/PebiBYTE' -} - -/** - * Data send to update the project quota. - * @export - * @interface UpdateQuotaParameterObject - */ -export interface UpdateQuotaParameterObject { - /** - * The new maximum project quota value. - * @type {number} - * @memberof UpdateQuotaParameterObject - */ - maximumGiB?: number; -} - -/** - * AdminApi - axios parameter creator - * @export - */ -export const AdminApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Find the project related to the projectString(GUID or slug) - * @param {string} projectString The project id (GUID) or slug (from URL). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - adminGetProject: async (projectString: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectString' is not null or undefined - assertParamExists('adminGetProject', 'projectString', projectString) - const localVarPath = `/Admin/{projectString}` - .replace(`{${"projectString"}}`, encodeURIComponent(String(projectString))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication JWT token required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @summary Update a project maximum and allocated quota - * @param {string} projectId Id of the project - * @param {string} resourceTypeId Id of the resource type - * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - adminUpdateQuota: async (projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('adminUpdateQuota', 'projectId', projectId) - // verify required parameter 'resourceTypeId' is not null or undefined - assertParamExists('adminUpdateQuota', 'resourceTypeId', resourceTypeId) - // verify required parameter 'updateQuotaParameterObject' is not null or undefined - assertParamExists('adminUpdateQuota', 'updateQuotaParameterObject', updateQuotaParameterObject) - const localVarPath = `/Admin/{projectId}/{resourceTypeId}` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) - .replace(`{${"resourceTypeId"}}`, encodeURIComponent(String(resourceTypeId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication JWT token required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(updateQuotaParameterObject, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * AdminApi - functional programming interface - * @export - */ -export const AdminApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = AdminApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Find the project related to the projectString(GUID or slug) - * @param {string} projectString The project id (GUID) or slug (from URL). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async adminGetProject(projectString: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminProjectObject>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.adminGetProject(projectString, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Update a project maximum and allocated quota - * @param {string} projectId Id of the project - * @param {string} resourceTypeId Id of the resource type - * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.adminUpdateQuota(projectId, resourceTypeId, updateQuotaParameterObject, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * AdminApi - factory interface - * @export - */ -export const AdminApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = AdminApiFp(configuration) - return { - /** - * - * @summary Find the project related to the projectString(GUID or slug) - * @param {string} projectString The project id (GUID) or slug (from URL). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - adminGetProject(projectString: string, options?: any): AxiosPromise<AdminProjectObject> { - return localVarFp.adminGetProject(projectString, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Update a project maximum and allocated quota - * @param {string} projectId Id of the project - * @param {string} resourceTypeId Id of the resource type - * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): AxiosPromise<any> { - return localVarFp.adminUpdateQuota(projectId, resourceTypeId, updateQuotaParameterObject, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * AdminApi - object-oriented interface - * @export - * @class AdminApi - * @extends {BaseAPI} - */ -export class AdminApi extends BaseAPI { - /** - * - * @summary Find the project related to the projectString(GUID or slug) - * @param {string} projectString The project id (GUID) or slug (from URL). - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApi - */ - public adminGetProject(projectString: string, options?: any) { - return AdminApiFp(this.configuration).adminGetProject(projectString, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Update a project maximum and allocated quota - * @param {string} projectId Id of the project - * @param {string} resourceTypeId Id of the resource type - * @param {UpdateQuotaParameterObject} updateQuotaParameterObject JSON object for updating the project maximum and allocated quota. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof AdminApi - */ - public adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any) { - return AdminApiFp(this.configuration).adminUpdateQuota(projectId, resourceTypeId, updateQuotaParameterObject, options).then((request) => request(this.axios, this.basePath)); - } -} - - diff --git a/src/Coscine.Api.Admin/base.ts b/src/Coscine.Api.Admin/base.ts deleted file mode 100644 index bff0c66235e240ebd2d1fbe9c74256525c88e9ff..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/base.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Admin - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 3.0.5 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from "./configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; - -export const BASE_PATH = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Admin".replace(/\/+$/, ""); - -/** - * - * @export - */ -export const COLLECTION_FORMATS = { - csv: ",", - ssv: " ", - tsv: "\t", - pipes: "|", -}; - -/** - * - * @export - * @interface RequestArgs - */ -export interface RequestArgs { - url: string; - options: any; -} - -/** - * - * @export - * @class BaseAPI - */ -export class BaseAPI { - protected configuration: Configuration | undefined; - - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { - if (configuration) { - this.configuration = configuration; - this.basePath = configuration.basePath || this.basePath; - } - } -}; - -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ -export class RequiredError extends Error { - name: "RequiredError" = "RequiredError"; - constructor(public field: string, msg?: string) { - super(msg); - } -} diff --git a/src/Coscine.Api.Admin/common.ts b/src/Coscine.Api.Admin/common.ts deleted file mode 100644 index 6e21b46f827e57944f2b6bc686b92f4077f49562..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/common.ts +++ /dev/null @@ -1,138 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Admin - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 3.0.5 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from "./configuration"; -import { RequiredError, RequestArgs } from "./base"; -import { AxiosInstance } from 'axios'; - -/** - * - * @export - */ -export const DUMMY_BASE_URL = 'https://example.com' - -/** - * - * @throws {RequiredError} - * @export - */ -export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { - if (paramValue === null || paramValue === undefined) { - throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); - } -} - -/** - * - * @export - */ -export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? await configuration.apiKey(keyParamName) - : await configuration.apiKey; - object[keyParamName] = localVarApiKeyValue; - } -} - -/** - * - * @export - */ -export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { - if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { username: configuration.username, password: configuration.password }; - } -} - -/** - * - * @export - */ -export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const accessToken = typeof configuration.accessToken === 'function' - ? await configuration.accessToken() - : await configuration.accessToken; - object["Authorization"] = "Bearer " + accessToken; - } -} - -/** - * - * @export - */ -export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const localVarAccessTokenValue = typeof configuration.accessToken === 'function' - ? await configuration.accessToken(name, scopes) - : await configuration.accessToken; - object["Authorization"] = "Bearer " + localVarAccessTokenValue; - } -} - -/** - * - * @export - */ -export const setSearchParams = function (url: URL, ...objects: any[]) { - const searchParams = new URLSearchParams(url.search); - for (const object of objects) { - for (const key in object) { - if (Array.isArray(object[key])) { - searchParams.delete(key); - for (const item of object[key]) { - searchParams.append(key, item); - } - } else { - searchParams.set(key, object[key]); - } - } - } - url.search = searchParams.toString(); -} - -/** - * - * @export - */ -export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { - const nonString = typeof value !== 'string'; - const needsSerialization = nonString && configuration && configuration.isJsonMime - ? configuration.isJsonMime(requestOptions.headers['Content-Type']) - : nonString; - return needsSerialization - ? JSON.stringify(value !== undefined ? value : {}) - : (value || ""); -} - -/** - * - * @export - */ -export const toPathString = function (url: URL) { - return url.pathname + url.search + url.hash -} - -/** - * - * @export - */ -export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); - }; -} diff --git a/src/Coscine.Api.Admin/configuration.ts b/src/Coscine.Api.Admin/configuration.ts deleted file mode 100644 index 16d724c58b7d5c2fa4bf3afe32c7c479e810ccfb..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/configuration.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Admin - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 3.0.5 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -export interface ConfigurationParameters { - apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); - username?: string; - password?: string; - accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>); - basePath?: string; - baseOptions?: any; - formDataCtor?: new () => any; -} - -export class Configuration { - /** - * parameter for apiKey security - * @param name security name - * @memberof Configuration - */ - apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - username?: string; - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - password?: string; - /** - * parameter for oauth2 security - * @param name security name - * @param scopes oauth2 scope - * @memberof Configuration - */ - accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>); - /** - * override base path - * - * @type {string} - * @memberof Configuration - */ - basePath?: string; - /** - * base options for axios calls - * - * @type {any} - * @memberof Configuration - */ - baseOptions?: any; - /** - * The FormData constructor that will be used to create multipart form data - * requests. You can inject this here so that execution environments that - * do not support the FormData class can still run the generated client. - * - * @type {new () => FormData} - */ - formDataCtor?: new () => any; - - constructor(param: ConfigurationParameters = {}) { - this.apiKey = param.apiKey; - this.username = param.username; - this.password = param.password; - this.accessToken = param.accessToken; - this.basePath = param.basePath; - this.baseOptions = param.baseOptions; - this.formDataCtor = param.formDataCtor; - } - - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * application/vnd.company+json - * @param mime - MIME (Multipurpose Internet Mail Extensions) - * @return True if the given MIME is JSON, false otherwise. - */ - public isJsonMime(mime: string): boolean { - const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); - return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); - } -} diff --git a/src/Coscine.Api.Admin/git_push.sh b/src/Coscine.Api.Admin/git_push.sh deleted file mode 100644 index ced3be2b0c7b2349ff06d18da19d4b31435c9fa6..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/git_push.sh +++ /dev/null @@ -1,58 +0,0 @@ -#!/bin/sh -# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ -# -# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" - -git_user_id=$1 -git_repo_id=$2 -release_note=$3 -git_host=$4 - -if [ "$git_host" = "" ]; then - git_host="github.com" - echo "[INFO] No command line input provided. Set \$git_host to $git_host" -fi - -if [ "$git_user_id" = "" ]; then - git_user_id="GIT_USER_ID" - echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" -fi - -if [ "$git_repo_id" = "" ]; then - git_repo_id="GIT_REPO_ID" - echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" -fi - -if [ "$release_note" = "" ]; then - release_note="Minor update" - echo "[INFO] No command line input provided. Set \$release_note to $release_note" -fi - -# Initialize the local directory as a Git repository -git init - -# Adds the files in the local repository and stages them for commit. -git add . - -# Commits the tracked changes and prepares them to be pushed to a remote repository. -git commit -m "$release_note" - -# Sets the new remote -git_remote=`git remote` -if [ "$git_remote" = "" ]; then # git remote not defined - - if [ "$GIT_TOKEN" = "" ]; then - echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." - git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git - else - git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git - fi - -fi - -git pull origin master - -# Pushes (Forces) the changes in the local repository up to the remote repository -echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" -git push origin master 2>&1 | grep -v 'To https' - diff --git a/src/Coscine.Api.Admin/index.ts b/src/Coscine.Api.Admin/index.ts deleted file mode 100644 index 310658eb10fbe4ed9ce097d057dbd6c9c00dbbc4..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Admin/index.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Admin - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 3.0.5 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -export * from "./api"; -export * from "./configuration"; - diff --git a/src/Coscine.Api.Search/.gitignore b/src/Coscine.Api.Search/.gitignore deleted file mode 100644 index 149b57654723c14590f35c6c0db8460f19173078..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -wwwroot/*.js -node_modules -typings -dist diff --git a/src/Coscine.Api.Search/.npmignore b/src/Coscine.Api.Search/.npmignore deleted file mode 100644 index 999d88df6939a13529be54ef2e68fb3248257ad8..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/.npmignore +++ /dev/null @@ -1 +0,0 @@ -# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/src/Coscine.Api.Search/.openapi-generator-ignore b/src/Coscine.Api.Search/.openapi-generator-ignore deleted file mode 100644 index 7484ee590a3894506cf063799b885428f95a71be..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/.openapi-generator-ignore +++ /dev/null @@ -1,23 +0,0 @@ -# OpenAPI Generator Ignore -# Generated by openapi-generator https://github.com/openapitools/openapi-generator - -# Use this file to prevent files from being overwritten by the generator. -# The patterns follow closely to .gitignore or .dockerignore. - -# As an example, the C# client generator defines ApiClient.cs. -# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: -#ApiClient.cs - -# You can match any string of characters against a directory, file or extension with a single asterisk (*): -#foo/*/qux -# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux - -# You can recursively match patterns against a directory, file or extension with a double asterisk (**): -#foo/**/qux -# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux - -# You can also negate patterns with an exclamation (!). -# For example, you can ignore all files in a docs folder with the file extension .md: -#docs/*.md -# Then explicitly reverse the ignore rule for a single file: -#!docs/README.md diff --git a/src/Coscine.Api.Search/.openapi-generator/FILES b/src/Coscine.Api.Search/.openapi-generator/FILES deleted file mode 100644 index 16b445eee6ddfbfbfe345427f484f94cba9ee946..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/.openapi-generator/FILES +++ /dev/null @@ -1,9 +0,0 @@ -.gitignore -.npmignore -.openapi-generator-ignore -api.ts -base.ts -common.ts -configuration.ts -git_push.sh -index.ts diff --git a/src/Coscine.Api.Search/.openapi-generator/VERSION b/src/Coscine.Api.Search/.openapi-generator/VERSION deleted file mode 100644 index 804440660c71cc833e24b1a87544a706fb3eac35..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -5.2.1 \ No newline at end of file diff --git a/src/Coscine.Api.Search/api.ts b/src/Coscine.Api.Search/api.ts deleted file mode 100644 index d426369c7edc548e454ed345e0a9788e10aedc22..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/api.ts +++ /dev/null @@ -1,254 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Search - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.7.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from './configuration'; -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; -// Some imports not used depending on template conditions -// @ts-ignore -import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; -// @ts-ignore -import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; - -/** - * - * @export - * @enum {string} - */ - -export enum CategoryFilter { - None = 'None', - Resource = 'Resource', - Project = 'Project', - Metadata = 'Metadata' -} - -/** - * Item Search Result Object - * @export - * @interface ItemSearchResult - */ -export interface ItemSearchResult { - /** - * Graph Name - * @type {string} - * @memberof ItemSearchResult - */ - graphName?: string; - /** - * Graph Name - * @type {ItemType} - * @memberof ItemSearchResult - */ - type?: ItemType; - /** - * Search result fields - * @type {any} - * @memberof ItemSearchResult - */ - source?: any | null; -} -/** - * - * @export - * @enum {string} - */ - -export enum ItemType { - Metadata = 'Metadata', - Project = 'Project', - Resource = 'Resource' -} - -/** - * - * @export - * @enum {string} - */ - -export enum OrderBy { - DateCreatedAsc = 'Date_Created_Asc', - DateCreatedDesc = 'Date_Created_Desc', - ScoreAsc = 'Score_Asc', - ScoreDesc = 'Score_Desc', - NameAsc = 'Name_Asc', - NameDesc = 'Name_Desc' -} - - -/** - * SearchApi - axios parameter creator - * @export - */ -export const SearchApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Search Elasticsearch - * @param {string} [searchQuery] The actual search query - * @param {boolean} [includeUsers] Specify user or only public metadata records could be found - * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [includedLanguages] Set the used languages - * @param {CategoryFilter} [categoryFilter] Set the category filter - * @param {OrderBy} [orderBy] Set the order for sorting - * @param {number} [pageNumber] The requested page number - * @param {number} [pageSize] The size of a page - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - searchSearch: async (searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/Search`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication JWT token required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - if (searchQuery !== undefined) { - localVarQueryParameter['SearchQuery'] = searchQuery; - } - - if (includeUsers !== undefined) { - localVarQueryParameter['IncludeUsers'] = includeUsers; - } - - if (useAdvancedSyntax !== undefined) { - localVarQueryParameter['UseAdvancedSyntax'] = useAdvancedSyntax; - } - - if (includedLanguages) { - localVarQueryParameter['IncludedLanguages'] = includedLanguages; - } - - if (categoryFilter !== undefined) { - localVarQueryParameter['CategoryFilter'] = categoryFilter; - } - - if (orderBy !== undefined) { - localVarQueryParameter['OrderBy'] = orderBy; - } - - if (pageNumber !== undefined) { - localVarQueryParameter['PageNumber'] = pageNumber; - } - - if (pageSize !== undefined) { - localVarQueryParameter['PageSize'] = pageSize; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * SearchApi - functional programming interface - * @export - */ -export const SearchApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration) - return { - /** - * - * @summary Search Elasticsearch - * @param {string} [searchQuery] The actual search query - * @param {boolean} [includeUsers] Specify user or only public metadata records could be found - * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [includedLanguages] Set the used languages - * @param {CategoryFilter} [categoryFilter] Set the category filter - * @param {OrderBy} [orderBy] Set the order for sorting - * @param {number} [pageNumber] The requested page number - * @param {number} [pageSize] The size of a page - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemSearchResult>>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * SearchApi - factory interface - * @export - */ -export const SearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SearchApiFp(configuration) - return { - /** - * - * @summary Search Elasticsearch - * @param {string} [searchQuery] The actual search query - * @param {boolean} [includeUsers] Specify user or only public metadata records could be found - * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [includedLanguages] Set the used languages - * @param {CategoryFilter} [categoryFilter] Set the category filter - * @param {OrderBy} [orderBy] Set the order for sorting - * @param {number} [pageNumber] The requested page number - * @param {number} [pageSize] The size of a page - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): AxiosPromise<Array<ItemSearchResult>> { - return localVarFp.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * SearchApi - object-oriented interface - * @export - * @class SearchApi - * @extends {BaseAPI} - */ -export class SearchApi extends BaseAPI { - /** - * - * @summary Search Elasticsearch - * @param {string} [searchQuery] The actual search query - * @param {boolean} [includeUsers] Specify user or only public metadata records could be found - * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [includedLanguages] Set the used languages - * @param {CategoryFilter} [categoryFilter] Set the category filter - * @param {OrderBy} [orderBy] Set the order for sorting - * @param {number} [pageNumber] The requested page number - * @param {number} [pageSize] The size of a page - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SearchApi - */ - public searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any) { - return SearchApiFp(this.configuration).searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, categoryFilter, orderBy, pageNumber, pageSize, options).then((request) => request(this.axios, this.basePath)); - } -} - - diff --git a/src/Coscine.Api.Search/base.ts b/src/Coscine.Api.Search/base.ts deleted file mode 100644 index e55c2835c9faf37012e51f84790219f6407e2529..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/base.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Search - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.7.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from "./configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; - -export const BASE_PATH = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Search".replace(/\/+$/, ""); - -/** - * - * @export - */ -export const COLLECTION_FORMATS = { - csv: ",", - ssv: " ", - tsv: "\t", - pipes: "|", -}; - -/** - * - * @export - * @interface RequestArgs - */ -export interface RequestArgs { - url: string; - options: any; -} - -/** - * - * @export - * @class BaseAPI - */ -export class BaseAPI { - protected configuration: Configuration | undefined; - - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { - if (configuration) { - this.configuration = configuration; - this.basePath = configuration.basePath || this.basePath; - } - } -}; - -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ -export class RequiredError extends Error { - name: "RequiredError" = "RequiredError"; - constructor(public field: string, msg?: string) { - super(msg); - } -} diff --git a/src/Coscine.Api.Search/common.ts b/src/Coscine.Api.Search/common.ts deleted file mode 100644 index 58d6886f9d2570d2e61182c3dc9705a8c5d5ee78..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/common.ts +++ /dev/null @@ -1,138 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Search - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.7.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from "./configuration"; -import { RequiredError, RequestArgs } from "./base"; -import { AxiosInstance } from 'axios'; - -/** - * - * @export - */ -export const DUMMY_BASE_URL = 'https://example.com' - -/** - * - * @throws {RequiredError} - * @export - */ -export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { - if (paramValue === null || paramValue === undefined) { - throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); - } -} - -/** - * - * @export - */ -export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? await configuration.apiKey(keyParamName) - : await configuration.apiKey; - object[keyParamName] = localVarApiKeyValue; - } -} - -/** - * - * @export - */ -export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { - if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { username: configuration.username, password: configuration.password }; - } -} - -/** - * - * @export - */ -export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const accessToken = typeof configuration.accessToken === 'function' - ? await configuration.accessToken() - : await configuration.accessToken; - object["Authorization"] = "Bearer " + accessToken; - } -} - -/** - * - * @export - */ -export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const localVarAccessTokenValue = typeof configuration.accessToken === 'function' - ? await configuration.accessToken(name, scopes) - : await configuration.accessToken; - object["Authorization"] = "Bearer " + localVarAccessTokenValue; - } -} - -/** - * - * @export - */ -export const setSearchParams = function (url: URL, ...objects: any[]) { - const searchParams = new URLSearchParams(url.search); - for (const object of objects) { - for (const key in object) { - if (Array.isArray(object[key])) { - searchParams.delete(key); - for (const item of object[key]) { - searchParams.append(key, item); - } - } else { - searchParams.set(key, object[key]); - } - } - } - url.search = searchParams.toString(); -} - -/** - * - * @export - */ -export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { - const nonString = typeof value !== 'string'; - const needsSerialization = nonString && configuration && configuration.isJsonMime - ? configuration.isJsonMime(requestOptions.headers['Content-Type']) - : nonString; - return needsSerialization - ? JSON.stringify(value !== undefined ? value : {}) - : (value || ""); -} - -/** - * - * @export - */ -export const toPathString = function (url: URL) { - return url.pathname + url.search + url.hash -} - -/** - * - * @export - */ -export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); - }; -} diff --git a/src/Coscine.Api.Search/configuration.ts b/src/Coscine.Api.Search/configuration.ts deleted file mode 100644 index ad2d2710e4cb27ffe9db7e2a0cc32898cd0d828a..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/configuration.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Search - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.7.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -export interface ConfigurationParameters { - apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); - username?: string; - password?: string; - accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>); - basePath?: string; - baseOptions?: any; - formDataCtor?: new () => any; -} - -export class Configuration { - /** - * parameter for apiKey security - * @param name security name - * @memberof Configuration - */ - apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>); - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - username?: string; - /** - * parameter for basic security - * - * @type {string} - * @memberof Configuration - */ - password?: string; - /** - * parameter for oauth2 security - * @param name security name - * @param scopes oauth2 scope - * @memberof Configuration - */ - accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>); - /** - * override base path - * - * @type {string} - * @memberof Configuration - */ - basePath?: string; - /** - * base options for axios calls - * - * @type {any} - * @memberof Configuration - */ - baseOptions?: any; - /** - * The FormData constructor that will be used to create multipart form data - * requests. You can inject this here so that execution environments that - * do not support the FormData class can still run the generated client. - * - * @type {new () => FormData} - */ - formDataCtor?: new () => any; - - constructor(param: ConfigurationParameters = {}) { - this.apiKey = param.apiKey; - this.username = param.username; - this.password = param.password; - this.accessToken = param.accessToken; - this.basePath = param.basePath; - this.baseOptions = param.baseOptions; - this.formDataCtor = param.formDataCtor; - } - - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * application/vnd.company+json - * @param mime - MIME (Multipurpose Internet Mail Extensions) - * @return True if the given MIME is JSON, false otherwise. - */ - public isJsonMime(mime: string): boolean { - const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); - return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); - } -} diff --git a/src/Coscine.Api.Search/git_push.sh b/src/Coscine.Api.Search/git_push.sh deleted file mode 100644 index ced3be2b0c7b2349ff06d18da19d4b31435c9fa6..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/git_push.sh +++ /dev/null @@ -1,58 +0,0 @@ -#!/bin/sh -# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ -# -# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" - -git_user_id=$1 -git_repo_id=$2 -release_note=$3 -git_host=$4 - -if [ "$git_host" = "" ]; then - git_host="github.com" - echo "[INFO] No command line input provided. Set \$git_host to $git_host" -fi - -if [ "$git_user_id" = "" ]; then - git_user_id="GIT_USER_ID" - echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" -fi - -if [ "$git_repo_id" = "" ]; then - git_repo_id="GIT_REPO_ID" - echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" -fi - -if [ "$release_note" = "" ]; then - release_note="Minor update" - echo "[INFO] No command line input provided. Set \$release_note to $release_note" -fi - -# Initialize the local directory as a Git repository -git init - -# Adds the files in the local repository and stages them for commit. -git add . - -# Commits the tracked changes and prepares them to be pushed to a remote repository. -git commit -m "$release_note" - -# Sets the new remote -git_remote=`git remote` -if [ "$git_remote" = "" ]; then # git remote not defined - - if [ "$GIT_TOKEN" = "" ]; then - echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." - git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git - else - git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git - fi - -fi - -git pull origin master - -# Pushes (Forces) the changes in the local repository up to the remote repository -echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" -git push origin master 2>&1 | grep -v 'To https' - diff --git a/src/Coscine.Api.Search/index.ts b/src/Coscine.Api.Search/index.ts deleted file mode 100644 index f0681c139126f7f0aa81601dc42e5f114abb4167..0000000000000000000000000000000000000000 --- a/src/Coscine.Api.Search/index.ts +++ /dev/null @@ -1,18 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Coscine.Api.Search - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.7.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -export * from "./api"; -export * from "./configuration"; - diff --git a/src/Coscine.Api/api.ts b/src/Coscine.Api/api.ts index 0144cab76c788cc1334fa4886d52934c5ecf7692..bfe4a131a22289e399b14482e07c5a1cae4b5d25 100644 --- a/src/Coscine.Api/api.ts +++ b/src/Coscine.Api/api.ts @@ -49,19 +49,19 @@ export interface ApiTokenDto { * @type {string} * @memberof ApiTokenDto */ - name?: string | null; + name?: string; /** * * @type {string} * @memberof ApiTokenDto */ - created?: string; + creationDate?: string; /** * * @type {string} * @memberof ApiTokenDto */ - expires?: string; + expiryDate?: string; /** * * @type {string} @@ -70,10 +70,10 @@ export interface ApiTokenDto { token?: string | null; /** * - * @type {string} + * @type {UserMinimalDto} * @memberof ApiTokenDto */ - ownerId?: string; + owner?: UserMinimalDto; } /** * @@ -161,7 +161,7 @@ export interface ApplicationProfileDto { * @type {string} * @memberof ApplicationProfileDto */ - baseUri?: string | null; + uri?: string; /** * * @type {string} @@ -176,16 +176,10 @@ export interface ApplicationProfileDto { description?: string | null; /** * - * @type {string} - * @memberof ApplicationProfileDto - */ - format?: string | null; - /** - * - * @type {string} + * @type {RdfDefinitionDto} * @memberof ApplicationProfileDto */ - definition?: string | null; + definition?: RdfDefinitionDto; } /** * @@ -254,25 +248,19 @@ export interface ApplicationProfileForCreationDto { * @type {string} * @memberof ApplicationProfileForCreationDto */ - name?: string | null; - /** - * - * @type {string} - * @memberof ApplicationProfileForCreationDto - */ - baseUri?: string | null; + name: string; /** * * @type {string} * @memberof ApplicationProfileForCreationDto */ - definition?: string | null; + uri: string; /** * - * @type {string} + * @type {RdfDefinitionForManipulationDto} * @memberof ApplicationProfileForCreationDto */ - mimeType?: string | null; + definition: RdfDefinitionForManipulationDto; } /** * @@ -299,6 +287,32 @@ export interface ApplicationProfileForCreationDtoResponse { */ isSuccess?: boolean; } +/** + * + * @export + * @interface ApplicationProfileForResourceCreationDto + */ +export interface ApplicationProfileForResourceCreationDto { + /** + * + * @type {string} + * @memberof ApplicationProfileForResourceCreationDto + */ + uri: string; +} +/** + * + * @export + * @interface ApplicationProfileMinimalDto + */ +export interface ApplicationProfileMinimalDto { + /** + * + * @type {string} + * @memberof ApplicationProfileMinimalDto + */ + uri?: string; +} /** * * @export @@ -316,19 +330,19 @@ export interface DisciplineDto { * @type {string} * @memberof DisciplineDto */ - url?: string | null; + uri?: string; /** * * @type {string} * @memberof DisciplineDto */ - displayNameDe?: string | null; + displayNameDe?: string; /** * * @type {string} * @memberof DisciplineDto */ - displayNameEn?: string | null; + displayNameEn?: string; } /** * @@ -428,116 +442,86 @@ export interface DisciplineForUserManipulationDto { /** * * @export - * @interface ExternalAuthDto + * @interface FileTreeDto */ -export interface ExternalAuthDto { +export interface FileTreeDto { /** * * @type {string} - * @memberof ExternalAuthDto + * @memberof FileTreeDto */ - id?: string; - /** - * - * @type {string} - * @memberof ExternalAuthDto - */ - displayName?: string | null; -} -/** - * - * @export - * @enum {string} - */ - -export enum ExternalAuthenticators { - Shibboleth = 'Shibboleth', - OrciD = 'ORCiD' -} - -/** - * - * @export - * @interface FileDto - */ -export interface FileDto { - /** - * - * @type {string} - * @memberof FileDto - */ - path?: string | null; + path?: string; /** * * @type {TreeDataType} - * @memberof FileDto + * @memberof FileTreeDto */ type?: TreeDataType; /** * * @type {string} - * @memberof FileDto + * @memberof FileTreeDto */ - parentDirectory?: string | null; + directory?: string; /** * * @type {string} - * @memberof FileDto + * @memberof FileTreeDto */ - name?: string | null; + name?: string; /** * * @type {string} - * @memberof FileDto + * @memberof FileTreeDto */ - extension?: string | null; + extension?: string; /** * * @type {number} - * @memberof FileDto + * @memberof FileTreeDto */ size?: number; /** * * @type {string} - * @memberof FileDto + * @memberof FileTreeDto */ creationDate?: string | null; /** * * @type {string} - * @memberof FileDto + * @memberof FileTreeDto */ changeDate?: string | null; } /** * * @export - * @interface FileDtoIEnumerablePagedResponse + * @interface FileTreeDtoIEnumerablePagedResponse */ -export interface FileDtoIEnumerablePagedResponse { +export interface FileTreeDtoIEnumerablePagedResponse { /** * - * @type {Array<FileDto>} - * @memberof FileDtoIEnumerablePagedResponse + * @type {Array<FileTreeDto>} + * @memberof FileTreeDtoIEnumerablePagedResponse */ - data?: Array<FileDto> | null; + data?: Array<FileTreeDto> | null; /** * * @type {number} - * @memberof FileDtoIEnumerablePagedResponse + * @memberof FileTreeDtoIEnumerablePagedResponse */ statusCode?: number | null; /** * * @type {boolean} - * @memberof FileDtoIEnumerablePagedResponse + * @memberof FileTreeDtoIEnumerablePagedResponse */ isSuccess?: boolean; /** * * @type {Pagination} - * @memberof FileDtoIEnumerablePagedResponse + * @memberof FileTreeDtoIEnumerablePagedResponse */ pagination?: Pagination; } @@ -608,7 +592,7 @@ export interface GitlabBranchDto { * @type {string} * @memberof GitlabBranchDto */ - name?: string | null; + name?: string; /** * * @type {boolean} @@ -694,67 +678,67 @@ export interface GitlabProjectDto { * @type {string} * @memberof GitlabProjectDto */ - name?: string | null; + name?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - nameWithNamespace?: string | null; + nameWithNamespace?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - description?: string | null; + description?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - defaultBranch?: string | null; + defaultBranch?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - path?: string | null; + path?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - pathWithNamespace?: string | null; + pathWithNamespace?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - lastActivityAt?: string | null; + lastActivityAt?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - createdAt?: string | null; + createdAt?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - webUrl?: string | null; + webUrl?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - httpUrlToRepo?: string | null; + httpUrlToRepo?: string; /** * * @type {string} * @memberof GitlabProjectDto */ - sshUrlToRepo?: string | null; + sshUrlToRepo?: string; } /** * @@ -862,6 +846,36 @@ export interface GitlabResourceTypeOptionsForUpdateDto { */ accessToken: string; } +/** + * + * @export + * @interface IdentityProviderDto + */ +export interface IdentityProviderDto { + /** + * + * @type {string} + * @memberof IdentityProviderDto + */ + id?: string; + /** + * + * @type {string} + * @memberof IdentityProviderDto + */ + displayName?: string; +} +/** + * + * @export + * @enum {string} + */ + +export enum IdentityProviders { + Shibboleth = 'Shibboleth', + OrciD = 'ORCiD' +} + /** * * @export @@ -879,13 +893,13 @@ export interface LanguageDto { * @type {string} * @memberof LanguageDto */ - displayName?: string | null; + displayName?: string; /** * * @type {string} * @memberof LanguageDto */ - abbreviation?: string | null; + abbreviation?: string; } /** * @@ -973,7 +987,7 @@ export interface LicenseDto { * @type {string} * @memberof LicenseDto */ - displayName?: string | null; + displayName?: string; } /** * @@ -1055,25 +1069,25 @@ export interface MaintenanceDto { * @type {string} * @memberof MaintenanceDto */ - displayName?: string | null; + displayName?: string; /** * * @type {string} * @memberof MaintenanceDto */ - url?: string | null; + href?: string; /** * * @type {string} * @memberof MaintenanceDto */ - type?: string | null; + type?: string; /** * * @type {string} * @memberof MaintenanceDto */ - body?: string | null; + body?: string; /** * * @type {string} @@ -1090,124 +1104,124 @@ export interface MaintenanceDto { /** * * @export - * @interface MaintenanceDtoResponse + * @interface MaintenanceDtoIEnumerablePagedResponse */ -export interface MaintenanceDtoResponse { +export interface MaintenanceDtoIEnumerablePagedResponse { /** * - * @type {MaintenanceDto} - * @memberof MaintenanceDtoResponse + * @type {Array<MaintenanceDto>} + * @memberof MaintenanceDtoIEnumerablePagedResponse */ - data?: MaintenanceDto; + data?: Array<MaintenanceDto> | null; /** * * @type {number} - * @memberof MaintenanceDtoResponse + * @memberof MaintenanceDtoIEnumerablePagedResponse */ statusCode?: number | null; /** * * @type {boolean} - * @memberof MaintenanceDtoResponse + * @memberof MaintenanceDtoIEnumerablePagedResponse */ isSuccess?: boolean; + /** + * + * @type {Pagination} + * @memberof MaintenanceDtoIEnumerablePagedResponse + */ + pagination?: Pagination; } /** * * @export - * @interface MetadataDto + * @interface MetadataTreeDto */ -export interface MetadataDto { +export interface MetadataTreeDto { /** * * @type {string} - * @memberof MetadataDto + * @memberof MetadataTreeDto */ - path?: string | null; + path?: string; /** * * @type {TreeDataType} - * @memberof MetadataDto + * @memberof MetadataTreeDto */ type?: TreeDataType; /** * * @type {string} - * @memberof MetadataDto + * @memberof MetadataTreeDto */ - version?: string | null; + version?: string; /** * * @type {Array<string>} - * @memberof MetadataDto - */ - availableVersions?: Array<string> | null; - /** - * - * @type {string} - * @memberof MetadataDto + * @memberof MetadataTreeDto */ - definition?: string | null; + availableVersions?: Array<string>; /** * - * @type {string} - * @memberof MetadataDto + * @type {RdfDefinitionDto} + * @memberof MetadataTreeDto */ - format?: string | null; + definition?: RdfDefinitionDto; } /** * * @export - * @interface MetadataDtoIEnumerablePagedResponse + * @interface MetadataTreeDtoIEnumerablePagedResponse */ -export interface MetadataDtoIEnumerablePagedResponse { +export interface MetadataTreeDtoIEnumerablePagedResponse { /** * - * @type {Array<MetadataDto>} - * @memberof MetadataDtoIEnumerablePagedResponse + * @type {Array<MetadataTreeDto>} + * @memberof MetadataTreeDtoIEnumerablePagedResponse */ - data?: Array<MetadataDto> | null; + data?: Array<MetadataTreeDto> | null; /** * * @type {number} - * @memberof MetadataDtoIEnumerablePagedResponse + * @memberof MetadataTreeDtoIEnumerablePagedResponse */ statusCode?: number | null; /** * * @type {boolean} - * @memberof MetadataDtoIEnumerablePagedResponse + * @memberof MetadataTreeDtoIEnumerablePagedResponse */ isSuccess?: boolean; /** * * @type {Pagination} - * @memberof MetadataDtoIEnumerablePagedResponse + * @memberof MetadataTreeDtoIEnumerablePagedResponse */ pagination?: Pagination; } /** * * @export - * @interface MetadataDtoResponse + * @interface MetadataTreeDtoResponse */ -export interface MetadataDtoResponse { +export interface MetadataTreeDtoResponse { /** * - * @type {MetadataDto} - * @memberof MetadataDtoResponse + * @type {MetadataTreeDto} + * @memberof MetadataTreeDtoResponse */ - data?: MetadataDto; + data?: MetadataTreeDto; /** * * @type {number} - * @memberof MetadataDtoResponse + * @memberof MetadataTreeDtoResponse */ statusCode?: number | null; /** * * @type {boolean} - * @memberof MetadataDtoResponse + * @memberof MetadataTreeDtoResponse */ isSuccess?: boolean; } @@ -1225,16 +1239,10 @@ export interface MetadataTreeForCreationDto { path: string; /** * - * @type {string} - * @memberof MetadataTreeForCreationDto - */ - definition: string; - /** - * - * @type {RdfFormat} + * @type {RdfDefinitionForManipulationDto} * @memberof MetadataTreeForCreationDto */ - format: RdfFormat; + definition: RdfDefinitionForManipulationDto; } /** * @@ -1250,16 +1258,10 @@ export interface MetadataTreeForUpdateDto { path: string; /** * - * @type {string} - * @memberof MetadataTreeForUpdateDto - */ - definition: string; - /** - * - * @type {RdfFormat} + * @type {RdfDefinitionForManipulationDto} * @memberof MetadataTreeForUpdateDto */ - format: RdfFormat; + definition: RdfDefinitionForManipulationDto; } /** * @@ -1272,13 +1274,13 @@ export interface OrganizationDto { * @type {string} * @memberof OrganizationDto */ - rorUri?: string | null; + uri?: string; /** * * @type {string} * @memberof OrganizationDto */ - name?: string | null; + displayName?: string; /** * * @type {string} @@ -1353,7 +1355,7 @@ export interface OrganizationForProjectManipulationDto { * @type {string} * @memberof OrganizationForProjectManipulationDto */ - rorUri: string; + uri: string; } /** * @@ -1401,34 +1403,45 @@ export interface Pagination { /** * * @export - * @interface PidEnquiryDto + * @interface PidRequestDto */ -export interface PidEnquiryDto { +export interface PidRequestDto { /** * * @type {string} - * @memberof PidEnquiryDto + * @memberof PidRequestDto */ name: string; /** * * @type {string} - * @memberof PidEnquiryDto + * @memberof PidRequestDto */ email: string; /** * * @type {string} - * @memberof PidEnquiryDto + * @memberof PidRequestDto */ message: string; /** * * @type {boolean} - * @memberof PidEnquiryDto + * @memberof PidRequestDto */ sendConfirmationEmail?: boolean; } +/** + * + * @export + * @enum {string} + */ + +export enum PidType { + Project = 'project', + Resource = 'resource' +} + /** * * @export @@ -1443,16 +1456,10 @@ export interface PidValidationDto { isValid?: boolean; /** * - * @type {boolean} - * @memberof PidValidationDto - */ - isProject?: boolean; - /** - * - * @type {boolean} + * @type {PidType} * @memberof PidValidationDto */ - isResource?: boolean; + type?: PidType; } /** * @@ -1496,19 +1503,19 @@ export interface ProjectDto { * @type {string} * @memberof ProjectDto */ - pid?: string | null; + pid?: string; /** * * @type {string} * @memberof ProjectDto */ - projectName?: string | null; + name?: string; /** * * @type {string} * @memberof ProjectDto */ - description?: string | null; + description?: string; /** * * @type {string} @@ -1556,31 +1563,31 @@ export interface ProjectDto { * @type {Array<DisciplineDto>} * @memberof ProjectDto */ - disciplines?: Array<DisciplineDto> | null; + disciplines?: Array<DisciplineDto>; /** * * @type {Array<OrganizationDto>} * @memberof ProjectDto */ - organizations?: Array<OrganizationDto> | null; + organizations?: Array<OrganizationDto>; /** * * @type {string} * @memberof ProjectDto */ - slug?: string | null; + slug?: string; /** * - * @type {string} + * @type {UserMinimalDto} * @memberof ProjectDto */ - creator?: string | null; + creator?: UserMinimalDto; /** * * @type {string} * @memberof ProjectDto */ - dateCreated?: string | null; + creationDate?: string | null; /** * * @type {Array<ProjectDto>} @@ -1589,10 +1596,10 @@ export interface ProjectDto { subProjects?: Array<ProjectDto> | null; /** * - * @type {string} + * @type {ProjectMinimalDto} * @memberof ProjectDto */ - parentId?: string | null; + parent?: ProjectMinimalDto; } /** * @@ -1661,7 +1668,7 @@ export interface ProjectForCreationDto { * @type {string} * @memberof ProjectForCreationDto */ - projectName: string; + name: string; /** * * @type {string} @@ -1740,7 +1747,7 @@ export interface ProjectForUpdateDto { * @type {string} * @memberof ProjectForUpdateDto */ - projectName: string; + name: string; /** * * @type {string} @@ -1825,31 +1832,31 @@ export interface ProjectInvitationDto { * @type {string} * @memberof ProjectInvitationDto */ - expiration?: string; + expirationDate?: string; /** * * @type {string} * @memberof ProjectInvitationDto */ - userMail?: string | null; + email?: string; /** * - * @type {ProjectRoleUserDto} + * @type {PublicUserDto} * @memberof ProjectInvitationDto */ - issuer?: ProjectRoleUserDto; + issuer?: PublicUserDto; /** * - * @type {string} + * @type {ProjectMinimalDto} * @memberof ProjectInvitationDto */ - projectId?: string; + project?: ProjectMinimalDto; /** * - * @type {string} + * @type {RoleMinimalDto} * @memberof ProjectInvitationDto */ - roleId?: string; + role?: RoleMinimalDto; } /** * @@ -1942,27 +1949,34 @@ export interface ProjectInvitationResolveDto { /** * * @export - * @interface ProjectQuotaDto + * @interface ProjectMinimalDto */ -export interface ProjectQuotaDto { +export interface ProjectMinimalDto { /** * * @type {string} - * @memberof ProjectQuotaDto + * @memberof ProjectMinimalDto */ - projectId?: string; + id?: string; +} +/** + * + * @export + * @interface ProjectQuotaDto + */ +export interface ProjectQuotaDto { /** * * @type {string} * @memberof ProjectQuotaDto */ - resourceTypeId?: string; + projectId?: string; /** * - * @type {string} + * @type {QuotaDto} * @memberof ProjectQuotaDto */ - name?: string | null; + totalUsed?: QuotaDto; /** * * @type {QuotaDto} @@ -1981,6 +1995,12 @@ export interface ProjectQuotaDto { * @memberof ProjectQuotaDto */ maximum?: QuotaDto; + /** + * + * @type {ResourceTypeMinimalDto} + * @memberof ProjectQuotaDto + */ + resourceType?: ResourceTypeMinimalDto; /** * * @type {Array<ResourceQuotaDto>} @@ -2056,6 +2076,12 @@ export interface ProjectQuotaForUpdateDto { * @memberof ProjectQuotaForUpdateDto */ allocated: QuotaForManipulationDto; + /** + * + * @type {QuotaForManipulationDto} + * @memberof ProjectQuotaForUpdateDto + */ + maximum?: QuotaForManipulationDto; } /** * @@ -2071,10 +2097,10 @@ export interface ProjectRoleDto { id?: string; /** * - * @type {string} + * @type {ProjectMinimalDto} * @memberof ProjectRoleDto */ - projectId?: string; + project?: ProjectMinimalDto; /** * * @type {RoleDto} @@ -2083,10 +2109,10 @@ export interface ProjectRoleDto { role?: RoleDto; /** * - * @type {ProjectRoleUserDto} + * @type {PublicUserDto} * @memberof ProjectRoleDto */ - user?: ProjectRoleUserDto; + user?: PublicUserDto; } /** * @@ -2176,43 +2202,6 @@ export interface ProjectRoleForProjectManipulationDto { */ roleId: string; } -/** - * - * @export - * @interface ProjectRoleUserDto - */ -export interface ProjectRoleUserDto { - /** - * - * @type {string} - * @memberof ProjectRoleUserDto - */ - userId?: string; - /** - * - * @type {string} - * @memberof ProjectRoleUserDto - */ - firstName?: string | null; - /** - * - * @type {string} - * @memberof ProjectRoleUserDto - */ - lastName?: string | null; - /** - * - * @type {string} - * @memberof ProjectRoleUserDto - */ - displayName?: string | null; - /** - * - * @type {string} - * @memberof ProjectRoleUserDto - */ - emailAddress?: string | null; -} /** * * @export @@ -2230,25 +2219,25 @@ export interface PublicUserDto { * @type {string} * @memberof PublicUserDto */ - displayName?: string | null; + displayName?: string; /** * * @type {string} * @memberof PublicUserDto */ - firstName?: string | null; + givenName?: string; /** * * @type {string} * @memberof PublicUserDto */ - lastName?: string | null; + familyName?: string; /** * * @type {string} * @memberof PublicUserDto */ - email?: string | null; + email?: string; /** * * @type {TitleDto} @@ -2334,6 +2323,44 @@ export enum QuotaUnit { PebiByte = 'https://qudt.org/vocab/unit/PebiBYTE' } +/** + * + * @export + * @interface RdfDefinitionDto + */ +export interface RdfDefinitionDto { + /** + * + * @type {string} + * @memberof RdfDefinitionDto + */ + content?: string | null; + /** + * + * @type {string} + * @memberof RdfDefinitionDto + */ + type?: string | null; +} +/** + * + * @export + * @interface RdfDefinitionForManipulationDto + */ +export interface RdfDefinitionForManipulationDto { + /** + * + * @type {string} + * @memberof RdfDefinitionForManipulationDto + */ + content: string; + /** + * + * @type {RdfFormat} + * @memberof RdfDefinitionForManipulationDto + */ + type: RdfFormat; +} /** * * @export @@ -2356,7 +2383,7 @@ export interface RdsOptionsDto { * @type {string} * @memberof RdsOptionsDto */ - bucketName?: string | null; + bucketName?: string; /** * * @type {QuotaDto} @@ -2375,7 +2402,7 @@ export interface RdsResourceTypeOptionsForManipulationDto { * @type {QuotaForManipulationDto} * @memberof RdsResourceTypeOptionsForManipulationDto */ - size?: QuotaForManipulationDto; + quota?: QuotaForManipulationDto; } /** * @@ -2388,37 +2415,37 @@ export interface RdsS3OptionsDto { * @type {string} * @memberof RdsS3OptionsDto */ - bucketName?: string | null; + bucketName?: string; /** * * @type {string} * @memberof RdsS3OptionsDto */ - accessKeyRead?: string | null; + accessKeyRead?: string; /** * * @type {string} * @memberof RdsS3OptionsDto */ - secretKeyRead?: string | null; + secretKeyRead?: string; /** * * @type {string} * @memberof RdsS3OptionsDto */ - accessKeyWrite?: string | null; + accessKeyWrite?: string; /** * * @type {string} * @memberof RdsS3OptionsDto */ - secretKeyWrite?: string | null; + secretKeyWrite?: string; /** * * @type {string} * @memberof RdsS3OptionsDto */ - endpoint?: string | null; + endpoint?: string; /** * * @type {QuotaDto} @@ -2437,7 +2464,7 @@ export interface RdsS3ResourceTypeOptionsForManipulationDto { * @type {QuotaForManipulationDto} * @memberof RdsS3ResourceTypeOptionsForManipulationDto */ - size?: QuotaForManipulationDto; + quota?: QuotaForManipulationDto; } /** * @@ -2450,37 +2477,37 @@ export interface RdsS3WormOptionsDto { * @type {string} * @memberof RdsS3WormOptionsDto */ - bucketName?: string | null; + bucketName?: string; /** * * @type {string} * @memberof RdsS3WormOptionsDto */ - accessKeyRead?: string | null; + accessKeyRead?: string; /** * * @type {string} * @memberof RdsS3WormOptionsDto */ - secretKeyRead?: string | null; + secretKeyRead?: string; /** * * @type {string} * @memberof RdsS3WormOptionsDto */ - accessKeyWrite?: string | null; + accessKeyWrite?: string; /** * * @type {string} * @memberof RdsS3WormOptionsDto */ - secretKeyWrite?: string | null; + secretKeyWrite?: string; /** * * @type {string} * @memberof RdsS3WormOptionsDto */ - endpoint?: string | null; + endpoint?: string; /** * * @type {QuotaDto} @@ -2499,7 +2526,7 @@ export interface RdsS3WormResourceTypeOptionsForManipulationDto { * @type {QuotaForManipulationDto} * @memberof RdsS3WormResourceTypeOptionsForManipulationDto */ - size?: QuotaForManipulationDto; + quota?: QuotaForManipulationDto; } /** * @@ -2512,7 +2539,7 @@ export interface ResourceContentPageColumnsDto { * @type {Set<string>} * @memberof ResourceContentPageColumnsDto */ - always?: Set<string> | null; + always?: Set<string>; } /** * @@ -2582,7 +2609,7 @@ export interface ResourceCreationPageDto { * @type {Array<Array<string>>} * @memberof ResourceCreationPageDto */ - components?: Array<Array<string>> | null; + components?: Array<Array<string>>; } /** * @@ -2601,7 +2628,7 @@ export interface ResourceDto { * @type {string} * @memberof ResourceDto */ - pid?: string | null; + pid?: string; /** * * @type {ResourceTypeDto} @@ -2613,19 +2640,19 @@ export interface ResourceDto { * @type {string} * @memberof ResourceDto */ - resourceName?: string | null; + name?: string; /** * * @type {string} * @memberof ResourceDto */ - displayName?: string | null; + displayName?: string; /** * * @type {string} * @memberof ResourceDto */ - description?: string | null; + description?: string; /** * * @type {Array<string>} @@ -2646,22 +2673,22 @@ export interface ResourceDto { usageRights?: string | null; /** * - * @type {string} + * @type {ApplicationProfileMinimalDto} * @memberof ResourceDto */ - applicationProfile?: string | null; + applicationProfile?: ApplicationProfileMinimalDto; /** * * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }} * @memberof ResourceDto */ - fixedValues?: { [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; } | null; + fixedValues?: { [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }; /** * * @type {Array<DisciplineDto>} * @memberof ResourceDto */ - disciplines?: Array<DisciplineDto> | null; + disciplines?: Array<DisciplineDto>; /** * * @type {VisibilityDto} @@ -2754,7 +2781,7 @@ export interface ResourceForCreationDto { * @type {string} * @memberof ResourceForCreationDto */ - resourceName: string; + name: string; /** * * @type {string} @@ -2790,7 +2817,7 @@ export interface ResourceForCreationDto { * @type {string} * @memberof ResourceForCreationDto */ - usageRights?: string | null; + usageNote?: string | null; /** * * @type {VisibilityForResourceManipulationDto} @@ -2811,10 +2838,10 @@ export interface ResourceForCreationDto { resourceTypeId: string; /** * - * @type {string} + * @type {ApplicationProfileForResourceCreationDto} * @memberof ResourceForCreationDto */ - applicationProfile: string; + applicationProfile: ApplicationProfileForResourceCreationDto; /** * * @type {ResourceTypeOptionsForCreationDto} @@ -2833,7 +2860,7 @@ export interface ResourceForUpdateDto { * @type {string} * @memberof ResourceForUpdateDto */ - resourceName: string; + name: string; /** * * @type {string} @@ -2869,7 +2896,7 @@ export interface ResourceForUpdateDto { * @type {string} * @memberof ResourceForUpdateDto */ - usageRights?: string | null; + usageNote?: string | null; /** * * @type {VisibilityForResourceManipulationDto} @@ -2898,33 +2925,40 @@ export interface ResourceForUpdateDto { /** * * @export - * @interface ResourceQuotaDto + * @interface ResourceMinimalDto */ -export interface ResourceQuotaDto { +export interface ResourceMinimalDto { /** * * @type {string} - * @memberof ResourceQuotaDto + * @memberof ResourceMinimalDto */ - resourceId?: string; + id?: string; +} +/** + * + * @export + * @interface ResourceQuotaDto + */ +export interface ResourceQuotaDto { /** * - * @type {string} + * @type {ResourceMinimalDto} * @memberof ResourceQuotaDto */ - resourceDisplayName?: string | null; + resource?: ResourceMinimalDto; /** * - * @type {QuotaDto} + * @type {number} * @memberof ResourceQuotaDto */ - used?: QuotaDto; + usedPercentage?: number | null; /** * - * @type {number} + * @type {QuotaDto} * @memberof ResourceQuotaDto */ - usedPercentage?: number | null; + used?: QuotaDto; /** * * @type {QuotaDto} @@ -2974,13 +3008,13 @@ export interface ResourceTypeDto { * @type {string} * @memberof ResourceTypeDto */ - generalType?: string | null; + generalType?: string; /** * * @type {string} * @memberof ResourceTypeDto */ - specificType?: string | null; + specificType?: string; /** * * @type {ResourceTypeOptionsDto} @@ -3162,39 +3196,58 @@ export interface ResourceTypeInformationDtoResponse { /** * * @export - * @interface ResourceTypeOptionsDto + * @interface ResourceTypeMinimalDto */ -export interface ResourceTypeOptionsDto { +export interface ResourceTypeMinimalDto { /** * - * @type {object} - * @memberof ResourceTypeOptionsDto + * @type {string} + * @memberof ResourceTypeMinimalDto */ - linkedDataOptions?: object; + id?: string; /** * - * @type {GitLabOptionsDto} - * @memberof ResourceTypeOptionsDto + * @type {string} + * @memberof ResourceTypeMinimalDto */ - gitLabOptions?: GitLabOptionsDto; - /** + specificType?: string; +} +/** + * + * @export + * @interface ResourceTypeOptionsDto + */ +export interface ResourceTypeOptionsDto { + /** + * + * @type {object} + * @memberof ResourceTypeOptionsDto + */ + linkedData?: object; + /** + * + * @type {GitLabOptionsDto} + * @memberof ResourceTypeOptionsDto + */ + gitLab?: GitLabOptionsDto; + /** * * @type {RdsOptionsDto} * @memberof ResourceTypeOptionsDto */ - rdsOptions?: RdsOptionsDto; + rds?: RdsOptionsDto; /** * * @type {RdsS3OptionsDto} * @memberof ResourceTypeOptionsDto */ - rdsS3Options?: RdsS3OptionsDto; + rdsS3?: RdsS3OptionsDto; /** * * @type {RdsS3WormOptionsDto} * @memberof ResourceTypeOptionsDto */ - rdsS3WormOptions?: RdsS3WormOptionsDto; + rdsS3Worm?: RdsS3WormOptionsDto; } /** * @@ -3298,13 +3351,13 @@ export interface RoleDto { * @type {string} * @memberof RoleDto */ - displayName?: string | null; + displayName?: string; /** * * @type {string} * @memberof RoleDto */ - description?: string | null; + description?: string; } /** * @@ -3362,6 +3415,88 @@ export interface RoleDtoResponse { */ isSuccess?: boolean; } +/** + * + * @export + * @interface RoleMinimalDto + */ +export interface RoleMinimalDto { + /** + * + * @type {string} + * @memberof RoleMinimalDto + */ + id?: string; +} +/** + * + * @export + * @enum {string} + */ + +export enum SearchCategoryType { + None = 'None', + HttpsPurlOrgCoscineTermsStructureMetadata = 'https://purl.org/coscine/terms/structure#Metadata', + HttpsPurlOrgCoscineTermsStructureProject = 'https://purl.org/coscine/terms/structure#Project', + HttpsPurlOrgCoscineTermsStructureResource = 'https://purl.org/coscine/terms/structure#Resource' +} + +/** + * + * @export + * @interface SearchResultDto + */ +export interface SearchResultDto { + /** + * + * @type {string} + * @memberof SearchResultDto + */ + uri?: string; + /** + * + * @type {SearchCategoryType} + * @memberof SearchResultDto + */ + type?: SearchCategoryType; + /** + * + * @type {any} + * @memberof SearchResultDto + */ + source?: any | null; +} +/** + * + * @export + * @interface SearchResultDtoIEnumerablePagedResponse + */ +export interface SearchResultDtoIEnumerablePagedResponse { + /** + * + * @type {Array<SearchResultDto>} + * @memberof SearchResultDtoIEnumerablePagedResponse + */ + data?: Array<SearchResultDto> | null; + /** + * + * @type {number} + * @memberof SearchResultDtoIEnumerablePagedResponse + */ + statusCode?: number | null; + /** + * + * @type {boolean} + * @memberof SearchResultDtoIEnumerablePagedResponse + */ + isSuccess?: boolean; + /** + * + * @type {Pagination} + * @memberof SearchResultDtoIEnumerablePagedResponse + */ + pagination?: Pagination; +} /** * * @export @@ -3373,7 +3508,13 @@ export interface TermsOfServiceDto { * @type {string} * @memberof TermsOfServiceDto */ - version?: string | null; + version?: string; + /** + * + * @type {boolean} + * @memberof TermsOfServiceDto + */ + isCurrent?: boolean; } /** * @@ -3417,7 +3558,7 @@ export interface TitleDto { * @type {string} * @memberof TitleDto */ - displayName?: string | null; + displayName?: string; } /** * @@ -3516,25 +3657,25 @@ export interface UserDto { * @type {string} * @memberof UserDto */ - displayName?: string | null; + displayName?: string; /** * * @type {string} * @memberof UserDto */ - firstName?: string | null; + givenName?: string; /** * * @type {string} * @memberof UserDto */ - lastName?: string | null; + familyName?: string; /** * - * @type {string} + * @type {Array<UserEmailDto>} * @memberof UserDto */ - email?: string | null; + emails?: Array<UserEmailDto>; /** * * @type {TitleDto} @@ -3564,25 +3705,25 @@ export interface UserDto { * @type {Array<DisciplineDto>} * @memberof UserDto */ - disciplines?: Array<DisciplineDto> | null; + disciplines?: Array<DisciplineDto>; /** * * @type {Array<UserOrganizationDto>} * @memberof UserDto */ - organizations?: Array<UserOrganizationDto> | null; + organizations?: Array<UserOrganizationDto>; /** * * @type {Array<UserInstituteDto>} * @memberof UserDto */ - institutes?: Array<UserInstituteDto> | null; + institutes?: Array<UserInstituteDto>; /** * - * @type {Array<ExternalAuthDto>} + * @type {Array<IdentityProviderDto>} * @memberof UserDto */ - externalAuthenticators?: Array<ExternalAuthDto> | null; + identities?: Array<IdentityProviderDto>; } /** * @@ -3609,6 +3750,31 @@ export interface UserDtoResponse { */ isSuccess?: boolean; } +/** + * + * @export + * @interface UserEmailDto + */ +export interface UserEmailDto { + /** + * + * @type {string} + * @memberof UserEmailDto + */ + email?: string; + /** + * + * @type {boolean} + * @memberof UserEmailDto + */ + isConfirmed?: boolean; + /** + * + * @type {boolean} + * @memberof UserEmailDto + */ + isPrimary?: boolean; +} /** * * @export @@ -3620,13 +3786,13 @@ export interface UserForUpdateDto { * @type {string} * @memberof UserForUpdateDto */ - firstName: string; + givenName: string; /** * * @type {string} * @memberof UserForUpdateDto */ - lastName: string; + familyName: string; /** * * @type {string} @@ -3675,13 +3841,13 @@ export interface UserInstituteDto { * @type {string} * @memberof UserInstituteDto */ - rorUri?: string | null; + uri?: string; /** * * @type {string} * @memberof UserInstituteDto */ - name?: string | null; + displayName?: string; /** * * @type {string} @@ -3706,7 +3872,7 @@ export interface UserMergeDto { * @type {string} * @memberof UserMergeDto */ - mergeToken?: string | null; + token?: string; } /** * @@ -3733,6 +3899,19 @@ export interface UserMergeDtoResponse { */ isSuccess?: boolean; } +/** + * + * @export + * @interface UserMinimalDto + */ +export interface UserMinimalDto { + /** + * + * @type {string} + * @memberof UserMinimalDto + */ + id?: string; +} /** * * @export @@ -3744,13 +3923,13 @@ export interface UserOrganizationDto { * @type {string} * @memberof UserOrganizationDto */ - rorUri?: string | null; + uri?: string; /** * * @type {string} * @memberof UserOrganizationDto */ - name?: string | null; + displayName?: string; /** * * @type {string} @@ -3764,6 +3943,19 @@ export interface UserOrganizationDto { */ readOnly?: boolean; } +/** + * + * @export + * @interface UserTermsOfServiceAcceptDto + */ +export interface UserTermsOfServiceAcceptDto { + /** + * + * @type {string} + * @memberof UserTermsOfServiceAcceptDto + */ + version: string; +} /** * * @export @@ -3781,7 +3973,7 @@ export interface VisibilityDto { * @type {string} * @memberof VisibilityDto */ - displayName?: string | null; + displayName?: string; } /** * @@ -3876,13 +4068,13 @@ export interface VocabularyDto { * @type {string} * @memberof VocabularyDto */ - graphUri?: string | null; + graphUri?: string; /** * * @type {string} * @memberof VocabularyDto */ - classUri?: string | null; + classUri?: string; /** * * @type {string} @@ -3938,13 +4130,13 @@ export interface VocabularyInstanceDto { * @type {string} * @memberof VocabularyInstanceDto */ - graphUri?: string | null; + graphUri?: string; /** * * @type {string} * @memberof VocabularyInstanceDto */ - instanceUri?: string | null; + instanceUri?: string; /** * * @type {string} @@ -4035,6 +4227,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4067,7 +4260,8 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }, /** * - * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] + * @summary Submits a request to create a new application profile. + * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] The details required to create a new application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4103,16 +4297,17 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }, /** * - * @param {string} profile - * @param {RdfFormat} [format] - * @param {AcceptedLanguage} [acceptLanguage] + * @summary Retrieves an application profile by its URI. + * @param {string} profile The URI of the application profile to retrieve. + * @param {RdfFormat} [format] The desired data format for the returned application profile. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the application profile data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplicationProfile: async (profile: string, format?: RdfFormat, acceptLanguage?: AcceptedLanguage, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'profile' is not null or undefined assertParamExists('getApplicationProfile', 'profile', profile) - const localVarPath = `/api/v2/application-profiles/{profile}` + const localVarPath = `/api/v2/application-profiles/profiles/{profile}` .replace(`{${"profile"}}`, encodeURIComponent(String(profile))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4149,6 +4344,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }, /** * + * @summary Retrieves all application profiles. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -4158,7 +4354,7 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: * @throws {RequiredError} */ getApplicationProfiles: async (searchTerm?: string, language?: AcceptedLanguage, pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/application-profiles`; + const localVarPath = `/api/v2/application-profiles/profiles`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -4206,14 +4402,15 @@ export const ApplicationProfileApiAxiosParamCreator = function (configuration?: }, /** * - * @param {string} profile + * @summary Retrieves the `raw` application profile definition by its URI. + * @param {string} profile The URI of the application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRawApplicationProfile: async (profile: string, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'profile' is not null or undefined assertParamExists('getRawApplicationProfile', 'profile', profile) - const localVarPath = `/api/v2/application-profiles/{profile}/raw` + const localVarPath = `/api/v2/application-profiles/profiles/{profile}/raw` .replace(`{${"profile"}}`, encodeURIComponent(String(profile))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4252,6 +4449,7 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4261,7 +4459,8 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { }, /** * - * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] + * @summary Submits a request to create a new application profile. + * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] The details required to create a new application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4271,9 +4470,10 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} profile - * @param {RdfFormat} [format] - * @param {AcceptedLanguage} [acceptLanguage] + * @summary Retrieves an application profile by its URI. + * @param {string} profile The URI of the application profile to retrieve. + * @param {RdfFormat} [format] The desired data format for the returned application profile. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the application profile data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4283,6 +4483,7 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all application profiles. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -4297,7 +4498,8 @@ export const ApplicationProfileApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} profile + * @summary Retrieves the `raw` application profile definition by its URI. + * @param {string} profile The URI of the application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4317,6 +4519,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4325,7 +4528,8 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat }, /** * - * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] + * @summary Submits a request to create a new application profile. + * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] The details required to create a new application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4334,9 +4538,10 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat }, /** * - * @param {string} profile - * @param {RdfFormat} [format] - * @param {AcceptedLanguage} [acceptLanguage] + * @summary Retrieves an application profile by its URI. + * @param {string} profile The URI of the application profile to retrieve. + * @param {RdfFormat} [format] The desired data format for the returned application profile. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the application profile data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4345,6 +4550,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat }, /** * + * @summary Retrieves all application profiles. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -4358,7 +4564,8 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat }, /** * - * @param {string} profile + * @summary Retrieves the `raw` application profile definition by its URI. + * @param {string} profile The URI of the application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4377,6 +4584,7 @@ export const ApplicationProfileApiFactory = function (configuration?: Configurat export class ApplicationProfileApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationProfileApi @@ -4387,7 +4595,8 @@ export class ApplicationProfileApi extends BaseAPI { /** * - * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] + * @summary Submits a request to create a new application profile. + * @param {ApplicationProfileForCreationDto} [applicationProfileForCreationDto] The details required to create a new application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationProfileApi @@ -4398,9 +4607,10 @@ export class ApplicationProfileApi extends BaseAPI { /** * - * @param {string} profile - * @param {RdfFormat} [format] - * @param {AcceptedLanguage} [acceptLanguage] + * @summary Retrieves an application profile by its URI. + * @param {string} profile The URI of the application profile to retrieve. + * @param {RdfFormat} [format] The desired data format for the returned application profile. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the application profile data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationProfileApi @@ -4411,6 +4621,7 @@ export class ApplicationProfileApi extends BaseAPI { /** * + * @summary Retrieves all application profiles. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -4426,7 +4637,8 @@ export class ApplicationProfileApi extends BaseAPI { /** * - * @param {string} profile + * @summary Retrieves the `raw` application profile definition by its URI. + * @param {string} profile The URI of the application profile. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ApplicationProfileApi @@ -4445,6 +4657,7 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -4485,9 +4698,10 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Creates a new blob for a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key for the new blob. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4538,9 +4752,10 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Deletes a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4582,9 +4797,10 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Download a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4626,9 +4842,10 @@ export const BlobApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Updates an existing blob of a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to update. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4689,6 +4906,7 @@ export const BlobApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -4700,9 +4918,10 @@ export const BlobApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Creates a new blob for a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key for the new blob. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4713,9 +4932,10 @@ export const BlobApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Deletes a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4725,9 +4945,10 @@ export const BlobApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Download a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4737,9 +4958,10 @@ export const BlobApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Updates an existing blob of a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to update. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4760,6 +4982,7 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -4770,9 +4993,10 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Creates a new blob for a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key for the new blob. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4782,9 +5006,10 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Deletes a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4793,9 +5018,10 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Download a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4804,9 +5030,10 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Updates an existing blob of a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to update. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4826,6 +5053,7 @@ export const BlobApiFactory = function (configuration?: Configuration, basePath? export class BlobApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -4838,9 +5066,10 @@ export class BlobApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Creates a new blob for a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key for the new blob. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4852,9 +5081,10 @@ export class BlobApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Deletes a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BlobApi @@ -4865,9 +5095,10 @@ export class BlobApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Download a blob from a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BlobApi @@ -4878,9 +5109,10 @@ export class BlobApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} key + * @summary Updates an existing blob of a resource. + * @param {string} projectId The identifier or slug of the project. + * @param {string} resourceId The identifier of the resource. + * @param {string} key The key associated with the blob to update. * @param {any} [file] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4900,6 +5132,7 @@ export const DisciplineApiAxiosParamCreator = function (configuration?: Configur return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4932,7 +5165,8 @@ export const DisciplineApiAxiosParamCreator = function (configuration?: Configur }, /** * - * @param {string} disciplineId + * @summary Retrieves a discipline with the specified ID. + * @param {string} disciplineId The ID of the discipline. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4968,6 +5202,7 @@ export const DisciplineApiAxiosParamCreator = function (configuration?: Configur }, /** * + * @summary Retrieves all disciplines. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5025,6 +5260,7 @@ export const DisciplineApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5034,7 +5270,8 @@ export const DisciplineApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} disciplineId + * @summary Retrieves a discipline with the specified ID. + * @param {string} disciplineId The ID of the discipline. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5044,6 +5281,7 @@ export const DisciplineApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all disciplines. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5066,6 +5304,7 @@ export const DisciplineApiFactory = function (configuration?: Configuration, bas return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5074,7 +5313,8 @@ export const DisciplineApiFactory = function (configuration?: Configuration, bas }, /** * - * @param {string} disciplineId + * @summary Retrieves a discipline with the specified ID. + * @param {string} disciplineId The ID of the discipline. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5083,6 +5323,7 @@ export const DisciplineApiFactory = function (configuration?: Configuration, bas }, /** * + * @summary Retrieves all disciplines. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5104,6 +5345,7 @@ export const DisciplineApiFactory = function (configuration?: Configuration, bas export class DisciplineApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DisciplineApi @@ -5114,7 +5356,8 @@ export class DisciplineApi extends BaseAPI { /** * - * @param {string} disciplineId + * @summary Retrieves a discipline with the specified ID. + * @param {string} disciplineId The ID of the discipline. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DisciplineApi @@ -5125,6 +5368,7 @@ export class DisciplineApi extends BaseAPI { /** * + * @summary Retrieves all disciplines. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5146,6 +5390,7 @@ export const LanguageApiAxiosParamCreator = function (configuration?: Configurat return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5178,7 +5423,8 @@ export const LanguageApiAxiosParamCreator = function (configuration?: Configurat }, /** * - * @param {string} languageId + * @summary Retrieves a language by ID. + * @param {string} languageId The ID of the language. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5214,6 +5460,7 @@ export const LanguageApiAxiosParamCreator = function (configuration?: Configurat }, /** * + * @summary Retrieves all languages. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5271,6 +5518,7 @@ export const LanguageApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5280,7 +5528,8 @@ export const LanguageApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} languageId + * @summary Retrieves a language by ID. + * @param {string} languageId The ID of the language. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5290,6 +5539,7 @@ export const LanguageApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all languages. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5312,6 +5562,7 @@ export const LanguageApiFactory = function (configuration?: Configuration, baseP return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5320,7 +5571,8 @@ export const LanguageApiFactory = function (configuration?: Configuration, baseP }, /** * - * @param {string} languageId + * @summary Retrieves a language by ID. + * @param {string} languageId The ID of the language. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5329,6 +5581,7 @@ export const LanguageApiFactory = function (configuration?: Configuration, baseP }, /** * + * @summary Retrieves all languages. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5350,6 +5603,7 @@ export const LanguageApiFactory = function (configuration?: Configuration, baseP export class LanguageApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguageApi @@ -5360,7 +5614,8 @@ export class LanguageApi extends BaseAPI { /** * - * @param {string} languageId + * @summary Retrieves a language by ID. + * @param {string} languageId The ID of the language. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LanguageApi @@ -5371,6 +5626,7 @@ export class LanguageApi extends BaseAPI { /** * + * @summary Retrieves all languages. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5392,6 +5648,7 @@ export const LicenseApiAxiosParamCreator = function (configuration?: Configurati return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5424,7 +5681,8 @@ export const LicenseApiAxiosParamCreator = function (configuration?: Configurati }, /** * - * @param {string} licenseId + * @summary Retrieves a license with the specified ID. + * @param {string} licenseId The ID of the license. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5460,6 +5718,7 @@ export const LicenseApiAxiosParamCreator = function (configuration?: Configurati }, /** * + * @summary Retrieves all licenses. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5517,6 +5776,7 @@ export const LicenseApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5526,7 +5786,8 @@ export const LicenseApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} licenseId + * @summary Retrieves a license with the specified ID. + * @param {string} licenseId The ID of the license. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5536,6 +5797,7 @@ export const LicenseApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all licenses. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5558,6 +5820,7 @@ export const LicenseApiFactory = function (configuration?: Configuration, basePa return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5566,7 +5829,8 @@ export const LicenseApiFactory = function (configuration?: Configuration, basePa }, /** * - * @param {string} licenseId + * @summary Retrieves a license with the specified ID. + * @param {string} licenseId The ID of the license. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5575,6 +5839,7 @@ export const LicenseApiFactory = function (configuration?: Configuration, basePa }, /** * + * @summary Retrieves all licenses. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5596,6 +5861,7 @@ export const LicenseApiFactory = function (configuration?: Configuration, basePa export class LicenseApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LicenseApi @@ -5606,7 +5872,8 @@ export class LicenseApi extends BaseAPI { /** * - * @param {string} licenseId + * @summary Retrieves a license with the specified ID. + * @param {string} licenseId The ID of the license. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LicenseApi @@ -5617,6 +5884,7 @@ export class LicenseApi extends BaseAPI { /** * + * @summary Retrieves all licenses. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -5638,6 +5906,7 @@ export const MaintenanceApiAxiosParamCreator = function (configuration?: Configu return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5670,11 +5939,12 @@ export const MaintenanceApiAxiosParamCreator = function (configuration?: Configu }, /** * + * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCurrentMaintenance: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/maintenances/current`; + getCurrentMaintenances: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/maintenances`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5712,6 +5982,7 @@ export const MaintenanceApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5721,11 +5992,12 @@ export const MaintenanceApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCurrentMaintenance(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MaintenanceDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMaintenance(options); + async getCurrentMaintenances(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MaintenanceDtoIEnumerablePagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentMaintenances(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -5740,6 +6012,7 @@ export const MaintenanceApiFactory = function (configuration?: Configuration, ba return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5748,11 +6021,12 @@ export const MaintenanceApiFactory = function (configuration?: Configuration, ba }, /** * + * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCurrentMaintenance(options?: any): AxiosPromise<MaintenanceDtoResponse> { - return localVarFp.getCurrentMaintenance(options).then((request) => request(axios, basePath)); + getCurrentMaintenances(options?: any): AxiosPromise<MaintenanceDtoIEnumerablePagedResponse> { + return localVarFp.getCurrentMaintenances(options).then((request) => request(axios, basePath)); }, }; }; @@ -5766,6 +6040,7 @@ export const MaintenanceApiFactory = function (configuration?: Configuration, ba export class MaintenanceApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MaintenanceApi @@ -5776,12 +6051,13 @@ export class MaintenanceApi extends BaseAPI { /** * + * @summary Retrieves the current maintenance messages. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MaintenanceApi */ - public getCurrentMaintenance(options?: any) { - return MaintenanceApiFp(this.configuration).getCurrentMaintenance(options).then((request) => request(this.axios, this.basePath)); + public getCurrentMaintenances(options?: any) { + return MaintenanceApiFp(this.configuration).getCurrentMaintenances(options).then((request) => request(this.axios, this.basePath)); } } @@ -5794,6 +6070,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5826,15 +6103,16 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {string} organizationRorUrl + * @summary Retrieves an organization. + * @param {string} organizationRorUri * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOrganization: async (organizationRorUrl: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'organizationRorUrl' is not null or undefined - assertParamExists('getOrganization', 'organizationRorUrl', organizationRorUrl) - const localVarPath = `/api/v2/organizations/{organizationRorUrl}` - .replace(`{${"organizationRorUrl"}}`, encodeURIComponent(String(organizationRorUrl))); + getOrganization: async (organizationRorUri: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'organizationRorUri' is not null or undefined + assertParamExists('getOrganization', 'organizationRorUri', organizationRorUri) + const localVarPath = `/api/v2/organizations/{organizationRorUri}` + .replace(`{${"organizationRorUri"}}`, encodeURIComponent(String(organizationRorUri))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5862,6 +6140,7 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config }, /** * + * @summary Retrieves all organizations. * @param {string} [searchTerm] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -5924,6 +6203,7 @@ export const OrganizationApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5933,16 +6213,18 @@ export const OrganizationApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} organizationRorUrl + * @summary Retrieves an organization. + * @param {string} organizationRorUri * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getOrganization(organizationRorUrl: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganization(organizationRorUrl, options); + async getOrganization(organizationRorUri: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganization(organizationRorUri, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * + * @summary Retrieves all organizations. * @param {string} [searchTerm] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -5966,6 +6248,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5974,15 +6257,17 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b }, /** * - * @param {string} organizationRorUrl + * @summary Retrieves an organization. + * @param {string} organizationRorUri * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOrganization(organizationRorUrl: string, options?: any): AxiosPromise<OrganizationDtoResponse> { - return localVarFp.getOrganization(organizationRorUrl, options).then((request) => request(axios, basePath)); + getOrganization(organizationRorUri: string, options?: any): AxiosPromise<OrganizationDtoResponse> { + return localVarFp.getOrganization(organizationRorUri, options).then((request) => request(axios, basePath)); }, /** * + * @summary Retrieves all organizations. * @param {string} [searchTerm] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -6005,6 +6290,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b export class OrganizationApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationApi @@ -6015,17 +6301,19 @@ export class OrganizationApi extends BaseAPI { /** * - * @param {string} organizationRorUrl + * @summary Retrieves an organization. + * @param {string} organizationRorUri * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationApi */ - public getOrganization(organizationRorUrl: string, options?: any) { - return OrganizationApiFp(this.configuration).getOrganization(organizationRorUrl, options).then((request) => request(this.axios, this.basePath)); + public getOrganization(organizationRorUri: string, options?: any) { + return OrganizationApiFp(this.configuration).getOrganization(organizationRorUri, options).then((request) => request(this.axios, this.basePath)); } /** * + * @summary Retrieves all organizations. * @param {string} [searchTerm] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -6048,6 +6336,7 @@ export const PidApiAxiosParamCreator = function (configuration?: Configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6080,18 +6369,19 @@ export const PidApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} prefix - * @param {string} id - * @param {PidEnquiryDto} [pidEnquiryDto] + * @summary Sends an inquiry to the owner of the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate + * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - sendEmailToOwner: async (prefix: string, id: string, pidEnquiryDto?: PidEnquiryDto, options: any = {}): Promise<RequestArgs> => { + sendRequestToOwner: async (prefix: string, id: string, pidRequestDto?: PidRequestDto, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'prefix' is not null or undefined - assertParamExists('sendEmailToOwner', 'prefix', prefix) + assertParamExists('sendRequestToOwner', 'prefix', prefix) // verify required parameter 'id' is not null or undefined - assertParamExists('sendEmailToOwner', 'id', id) - const localVarPath = `/api/v2/pids/{prefix}/{id}/email` + assertParamExists('sendRequestToOwner', 'id', id) + const localVarPath = `/api/v2/pids/{prefix}/{id}/requests` .replace(`{${"prefix"}}`, encodeURIComponent(String(prefix))) .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -6115,7 +6405,7 @@ export const PidApiAxiosParamCreator = function (configuration?: Configuration) setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(pidEnquiryDto, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(pidRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -6124,8 +6414,9 @@ export const PidApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} prefix - * @param {string} id + * @summary Validates the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6174,6 +6465,7 @@ export const PidApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6183,20 +6475,22 @@ export const PidApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} prefix - * @param {string} id - * @param {PidEnquiryDto} [pidEnquiryDto] + * @summary Sends an inquiry to the owner of the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate + * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async sendEmailToOwner(prefix: string, id: string, pidEnquiryDto?: PidEnquiryDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.sendEmailToOwner(prefix, id, pidEnquiryDto, options); + async sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.sendRequestToOwner(prefix, id, pidRequestDto, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {string} prefix - * @param {string} id + * @summary Validates the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6216,6 +6510,7 @@ export const PidApiFactory = function (configuration?: Configuration, basePath?: return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6224,19 +6519,21 @@ export const PidApiFactory = function (configuration?: Configuration, basePath?: }, /** * - * @param {string} prefix - * @param {string} id - * @param {PidEnquiryDto} [pidEnquiryDto] + * @summary Sends an inquiry to the owner of the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate + * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - sendEmailToOwner(prefix: string, id: string, pidEnquiryDto?: PidEnquiryDto, options?: any): AxiosPromise<void> { - return localVarFp.sendEmailToOwner(prefix, id, pidEnquiryDto, options).then((request) => request(axios, basePath)); + sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: any): AxiosPromise<void> { + return localVarFp.sendRequestToOwner(prefix, id, pidRequestDto, options).then((request) => request(axios, basePath)); }, /** * - * @param {string} prefix - * @param {string} id + * @summary Validates the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6255,6 +6552,7 @@ export const PidApiFactory = function (configuration?: Configuration, basePath?: export class PidApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PidApi @@ -6265,21 +6563,23 @@ export class PidApi extends BaseAPI { /** * - * @param {string} prefix - * @param {string} id - * @param {PidEnquiryDto} [pidEnquiryDto] + * @summary Sends an inquiry to the owner of the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate + * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PidApi */ - public sendEmailToOwner(prefix: string, id: string, pidEnquiryDto?: PidEnquiryDto, options?: any) { - return PidApiFp(this.configuration).sendEmailToOwner(prefix, id, pidEnquiryDto, options).then((request) => request(this.axios, this.basePath)); + public sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: any) { + return PidApiFp(this.configuration).sendRequestToOwner(prefix, id, pidRequestDto, options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {string} prefix - * @param {string} id + * @summary Validates the given PID. + * @param {string} prefix The PID prefix of a project or a resource to validate + * @param {string} id The PID body of a project or a resource to validate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PidApi @@ -6298,6 +6598,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6330,7 +6631,8 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }, /** * - * @param {ProjectForCreationDto} [projectForCreationDto] + * @summary Creates a new project. + * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6366,7 +6668,8 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }, /** * - * @param {string} projectId + * @summary Deletes a project. + * @param {string} projectId The ID of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6402,7 +6705,8 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }, /** * - * @param {string} projectId + * @summary Retrieves a project. + * @param {string} projectId The ID of the project. * @param {boolean} [includeSubProjects] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -6443,6 +6747,7 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }, /** * + * @summary Retrieves all projects. * @param {boolean} [topLevel] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -6495,8 +6800,9 @@ export const ProjectApiAxiosParamCreator = function (configuration?: Configurati }, /** * - * @param {string} projectId - * @param {ProjectForUpdateDto} [projectForUpdateDto] + * @summary Updates a project. + * @param {string} projectId The ID of the project. + * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6545,6 +6851,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6554,7 +6861,8 @@ export const ProjectApiFp = function(configuration?: Configuration) { }, /** * - * @param {ProjectForCreationDto} [projectForCreationDto] + * @summary Creates a new project. + * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6564,7 +6872,8 @@ export const ProjectApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId + * @summary Deletes a project. + * @param {string} projectId The ID of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6574,7 +6883,8 @@ export const ProjectApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId + * @summary Retrieves a project. + * @param {string} projectId The ID of the project. * @param {boolean} [includeSubProjects] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -6585,6 +6895,7 @@ export const ProjectApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all projects. * @param {boolean} [topLevel] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -6598,8 +6909,9 @@ export const ProjectApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {ProjectForUpdateDto} [projectForUpdateDto] + * @summary Updates a project. + * @param {string} projectId The ID of the project. + * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6619,6 +6931,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6627,7 +6940,8 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa }, /** * - * @param {ProjectForCreationDto} [projectForCreationDto] + * @summary Creates a new project. + * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6636,7 +6950,8 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa }, /** * - * @param {string} projectId + * @summary Deletes a project. + * @param {string} projectId The ID of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6645,7 +6960,8 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa }, /** * - * @param {string} projectId + * @summary Retrieves a project. + * @param {string} projectId The ID of the project. * @param {boolean} [includeSubProjects] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -6655,6 +6971,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa }, /** * + * @summary Retrieves all projects. * @param {boolean} [topLevel] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -6667,8 +6984,9 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa }, /** * - * @param {string} projectId - * @param {ProjectForUpdateDto} [projectForUpdateDto] + * @summary Updates a project. + * @param {string} projectId The ID of the project. + * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6687,6 +7005,7 @@ export const ProjectApiFactory = function (configuration?: Configuration, basePa export class ProjectApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectApi @@ -6697,7 +7016,8 @@ export class ProjectApi extends BaseAPI { /** * - * @param {ProjectForCreationDto} [projectForCreationDto] + * @summary Creates a new project. + * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectApi @@ -6708,7 +7028,8 @@ export class ProjectApi extends BaseAPI { /** * - * @param {string} projectId + * @summary Deletes a project. + * @param {string} projectId The ID of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectApi @@ -6719,7 +7040,8 @@ export class ProjectApi extends BaseAPI { /** * - * @param {string} projectId + * @summary Retrieves a project. + * @param {string} projectId The ID of the project. * @param {boolean} [includeSubProjects] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -6731,6 +7053,7 @@ export class ProjectApi extends BaseAPI { /** * + * @summary Retrieves all projects. * @param {boolean} [topLevel] * @param {number} [pageNumber] * @param {number} [pageSize] @@ -6745,8 +7068,9 @@ export class ProjectApi extends BaseAPI { /** * - * @param {string} projectId - * @param {ProjectForUpdateDto} [projectForUpdateDto] + * @summary Updates a project. + * @param {string} projectId The ID of the project. + * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectApi @@ -6765,6 +7089,7 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -6801,8 +7126,9 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }, /** * - * @param {string} projectId - * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] + * @summary Creates a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6841,8 +7167,9 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }, /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Deletes a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6881,8 +7208,9 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }, /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Retrieves a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6921,7 +7249,8 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C }, /** * - * @param {string} projectId + * @summary Retrieves all project invitations for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -6965,46 +7294,6 @@ export const ProjectInvitationApiAxiosParamCreator = function (configuration?: C let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {string} projectId - * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - resolveProjectInvitation: async (projectId: string, projectInvitationResolveDto?: ProjectInvitationResolveDto, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('resolveProjectInvitation', 'projectId', projectId) - const localVarPath = `/api/v2/projects/{projectId}/invitations/resolve` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(projectInvitationResolveDto, localVarRequestOptions, configuration) - return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -7022,6 +7311,7 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7032,8 +7322,9 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] + * @summary Creates a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7043,8 +7334,9 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Deletes a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7054,8 +7346,9 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Retrieves a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7065,7 +7358,8 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId + * @summary Retrieves all project invitations for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7076,17 +7370,6 @@ export const ProjectInvitationApiFp = function(configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getProjectInvitations(projectId, pageNumber, pageSize, orderBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * - * @param {string} projectId - * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async resolveProjectInvitation(projectId: string, projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resolveProjectInvitation(projectId, projectInvitationResolveDto, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, } }; @@ -7099,6 +7382,7 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7108,8 +7392,9 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati }, /** * - * @param {string} projectId - * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] + * @summary Creates a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7118,8 +7403,9 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati }, /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Deletes a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7128,8 +7414,9 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati }, /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Retrieves a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7138,7 +7425,8 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati }, /** * - * @param {string} projectId + * @summary Retrieves all project invitations for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7148,16 +7436,6 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati getProjectInvitations(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ProjectInvitationDtoIEnumerablePagedResponse> { return localVarFp.getProjectInvitations(projectId, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); }, - /** - * - * @param {string} projectId - * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - resolveProjectInvitation(projectId: string, projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any): AxiosPromise<void> { - return localVarFp.resolveProjectInvitation(projectId, projectInvitationResolveDto, options).then((request) => request(axios, basePath)); - }, }; }; @@ -7170,6 +7448,7 @@ export const ProjectInvitationApiFactory = function (configuration?: Configurati export class ProjectInvitationApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7181,8 +7460,9 @@ export class ProjectInvitationApi extends BaseAPI { /** * - * @param {string} projectId - * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] + * @summary Creates a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectInvitationApi @@ -7193,8 +7473,9 @@ export class ProjectInvitationApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Deletes a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectInvitationApi @@ -7205,8 +7486,9 @@ export class ProjectInvitationApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} projectInvitationId + * @summary Retrieves a project invitation for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} projectInvitationId The ID of the project invitation to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectInvitationApi @@ -7217,7 +7499,8 @@ export class ProjectInvitationApi extends BaseAPI { /** * - * @param {string} projectId + * @summary Retrieves all project invitations for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7228,18 +7511,6 @@ export class ProjectInvitationApi extends BaseAPI { public getProjectInvitations(projectId: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { return ProjectInvitationApiFp(this.configuration).getProjectInvitations(projectId, pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); } - - /** - * - * @param {string} projectId - * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ProjectInvitationApi - */ - public resolveProjectInvitation(projectId: string, projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any) { - return ProjectInvitationApiFp(this.configuration).resolveProjectInvitation(projectId, projectInvitationResolveDto, options).then((request) => request(this.axios, this.basePath)); - } } @@ -7251,8 +7522,9 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi return { /** * - * @param {string} projectId - * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] + * @summary Creates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] The project membership data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7291,6 +7563,7 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }, /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7327,8 +7600,9 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }, /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Deletes a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7367,8 +7641,9 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }, /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Retrieves a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7407,7 +7682,8 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }, /** * - * @param {string} projectId + * @summary Retrieves all project memberships for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7458,9 +7734,10 @@ export const ProjectMemberApiAxiosParamCreator = function (configuration?: Confi }, /** * - * @param {string} projectId - * @param {string} membershipId - * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] + * @summary Updates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to update. + * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] The updated project membership data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7512,8 +7789,9 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { return { /** * - * @param {string} projectId - * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] + * @summary Creates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] The project membership data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7523,6 +7801,7 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { }, /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7533,8 +7812,9 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Deletes a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7544,8 +7824,9 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Retrieves a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7555,7 +7836,8 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId + * @summary Retrieves all project memberships for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7568,9 +7850,10 @@ export const ProjectMemberApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} membershipId - * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] + * @summary Updates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to update. + * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] The updated project membership data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7590,8 +7873,9 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, return { /** * - * @param {string} projectId - * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] + * @summary Creates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] The project membership data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7600,6 +7884,7 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, }, /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7609,8 +7894,9 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, }, /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Deletes a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7619,8 +7905,9 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, }, /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Retrieves a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7629,7 +7916,8 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, }, /** * - * @param {string} projectId + * @summary Retrieves all project memberships for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7641,9 +7929,10 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, }, /** * - * @param {string} projectId - * @param {string} membershipId - * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] + * @summary Updates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to update. + * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] The updated project membership data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7662,8 +7951,9 @@ export const ProjectMemberApiFactory = function (configuration?: Configuration, export class ProjectMemberApi extends BaseAPI { /** * - * @param {string} projectId - * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] + * @summary Creates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ProjectRoleForProjectCreationDto} [projectRoleForProjectCreationDto] The project membership data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectMemberApi @@ -7674,6 +7964,7 @@ export class ProjectMemberApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7685,8 +7976,9 @@ export class ProjectMemberApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Deletes a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectMemberApi @@ -7697,8 +7989,9 @@ export class ProjectMemberApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} membershipId + * @summary Retrieves a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectMemberApi @@ -7709,7 +8002,8 @@ export class ProjectMemberApi extends BaseAPI { /** * - * @param {string} projectId + * @summary Retrieves all project memberships for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7723,9 +8017,10 @@ export class ProjectMemberApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} membershipId - * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] + * @summary Updates a project membership for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} membershipId The ID of the project membership to update. + * @param {ProjectRoleForProjectManipulationDto} [projectRoleForProjectManipulationDto] The updated project membership data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectMemberApi @@ -7744,6 +8039,7 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7780,8 +8076,9 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {string} projectId - * @param {string} resourceTypeId + * @summary Retrieves a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7820,7 +8117,8 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {string} projectId + * @summary Retrieves all project quotas for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7871,9 +8169,10 @@ export const ProjectQuotaApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {string} projectId - * @param {string} resourceTypeId - * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] + * @summary Updates a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. + * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] The updated project quota data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7925,6 +8224,7 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7935,8 +8235,9 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceTypeId + * @summary Retrieves a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7946,7 +8247,8 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId + * @summary Retrieves all project quotas for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -7959,9 +8261,10 @@ export const ProjectQuotaApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceTypeId - * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] + * @summary Updates a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. + * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] The updated project quota data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -7981,6 +8284,7 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -7990,8 +8294,9 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b }, /** * - * @param {string} projectId - * @param {string} resourceTypeId + * @summary Retrieves a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8000,7 +8305,8 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b }, /** * - * @param {string} projectId + * @summary Retrieves all project quotas for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -8012,9 +8318,10 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b }, /** * - * @param {string} projectId - * @param {string} resourceTypeId - * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] + * @summary Updates a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. + * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] The updated project quota data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8033,6 +8340,7 @@ export const ProjectQuotaApiFactory = function (configuration?: Configuration, b export class ProjectQuotaApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -8044,8 +8352,9 @@ export class ProjectQuotaApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceTypeId + * @summary Retrieves a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectQuotaApi @@ -8056,7 +8365,8 @@ export class ProjectQuotaApi extends BaseAPI { /** * - * @param {string} projectId + * @summary Retrieves all project quotas for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -8070,9 +8380,10 @@ export class ProjectQuotaApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceTypeId - * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] + * @summary Updates a project quota for a specified project and resource type. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceTypeId The ID of the resource type. + * @param {ProjectQuotaForUpdateDto} [projectQuotaForUpdateDto] The updated project quota data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectQuotaApi @@ -8091,6 +8402,7 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -8127,8 +8439,9 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }, /** * - * @param {string} projectId - * @param {ResourceForCreationDto} [resourceForCreationDto] + * @summary Creates a new resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ResourceForCreationDto} [resourceForCreationDto] The resource data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8167,8 +8480,9 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Deletes a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8207,8 +8521,9 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8247,7 +8562,8 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }, /** * - * @param {string} projectId + * @summary Retrieves all resources for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -8298,9 +8614,10 @@ export const ProjectResourceApiAxiosParamCreator = function (configuration?: Con }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {ResourceForUpdateDto} [resourceForUpdateDto] + * @summary Updates a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to update. + * @param {ResourceForUpdateDto} [resourceForUpdateDto] The updated resource data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8352,6 +8669,7 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -8362,8 +8680,9 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {ResourceForCreationDto} [resourceForCreationDto] + * @summary Creates a new resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ResourceForCreationDto} [resourceForCreationDto] The resource data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8373,8 +8692,9 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Deletes a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8384,8 +8704,9 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8395,7 +8716,8 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId + * @summary Retrieves all resources for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -8408,9 +8730,10 @@ export const ProjectResourceApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {ResourceForUpdateDto} [resourceForUpdateDto] + * @summary Updates a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to update. + * @param {ResourceForUpdateDto} [resourceForUpdateDto] The updated resource data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8430,6 +8753,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -8439,8 +8763,9 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration }, /** * - * @param {string} projectId - * @param {ResourceForCreationDto} [resourceForCreationDto] + * @summary Creates a new resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ResourceForCreationDto} [resourceForCreationDto] The resource data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8449,8 +8774,9 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Deletes a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8459,8 +8785,9 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8469,7 +8796,8 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration }, /** * - * @param {string} projectId + * @summary Retrieves all resources for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -8481,9 +8809,10 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {ResourceForUpdateDto} [resourceForUpdateDto] + * @summary Updates a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to update. + * @param {ResourceForUpdateDto} [resourceForUpdateDto] The updated resource data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8502,6 +8831,7 @@ export const ProjectResourceApiFactory = function (configuration?: Configuration export class ProjectResourceApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -8513,8 +8843,9 @@ export class ProjectResourceApi extends BaseAPI { /** * - * @param {string} projectId - * @param {ResourceForCreationDto} [resourceForCreationDto] + * @summary Creates a new resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {ResourceForCreationDto} [resourceForCreationDto] The resource data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceApi @@ -8525,8 +8856,9 @@ export class ProjectResourceApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Deletes a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceApi @@ -8537,8 +8869,9 @@ export class ProjectResourceApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceApi @@ -8549,7 +8882,8 @@ export class ProjectResourceApi extends BaseAPI { /** * - * @param {string} projectId + * @summary Retrieves all resources for a specified project. + * @param {string} projectId The Id or slug of the project. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -8563,9 +8897,10 @@ export class ProjectResourceApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {ResourceForUpdateDto} [resourceForUpdateDto] + * @summary Updates a resource for a specified project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource to update. + * @param {ResourceForUpdateDto} [resourceForUpdateDto] The updated resource data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceApi @@ -8584,6 +8919,7 @@ export const ProjectResourceQuotaApiAxiosParamCreator = function (configuration? return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -8624,8 +8960,9 @@ export const ProjectResourceQuotaApiAxiosParamCreator = function (configuration? }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves the resource quota for a specific resource in a project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8674,6 +9011,7 @@ export const ProjectResourceQuotaApiFp = function(configuration?: Configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -8685,8 +9023,9 @@ export const ProjectResourceQuotaApiFp = function(configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves the resource quota for a specific resource in a project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8706,6 +9045,7 @@ export const ProjectResourceQuotaApiFactory = function (configuration?: Configur return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -8716,8 +9056,9 @@ export const ProjectResourceQuotaApiFactory = function (configuration?: Configur }, /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves the resource quota for a specific resource in a project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8736,6 +9077,7 @@ export const ProjectResourceQuotaApiFactory = function (configuration?: Configur export class ProjectResourceQuotaApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {string} resourceId * @param {*} [options] Override http request option. @@ -8748,8 +9090,9 @@ export class ProjectResourceQuotaApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Retrieves the resource quota for a specific resource in a project. + * @param {string} projectId The Id or slug of the project. + * @param {string} resourceId The ID of the resource. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceQuotaApi @@ -8768,14 +9111,15 @@ export const ProjectResourceTypeApiAxiosParamCreator = function (configuration?: return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2ProjectsProjectIdResourcesTypesOptions: async (projectId: string, options: any = {}): Promise<RequestArgs> => { + apiV2ProjectsProjectIdResourceTypesOptions: async (projectId: string, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'projectId' is not null or undefined - assertParamExists('apiV2ProjectsProjectIdResourcesTypesOptions', 'projectId', projectId) - const localVarPath = `/api/v2/projects/{projectId}/resources/types` + assertParamExists('apiV2ProjectsProjectIdResourceTypesOptions', 'projectId', projectId) + const localVarPath = `/api/v2/projects/{projectId}/resource-types` .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -8804,14 +9148,15 @@ export const ProjectResourceTypeApiAxiosParamCreator = function (configuration?: }, /** * - * @param {string} projectId + * @summary Retrieves the available resource types information for a specific project. + * @param {string} projectId The Id or slug of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAvailableResourceTypesInformationForProject: async (projectId: string, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'projectId' is not null or undefined assertParamExists('getAvailableResourceTypesInformationForProject', 'projectId', projectId) - const localVarPath = `/api/v2/projects/{projectId}/resources/types` + const localVarPath = `/api/v2/projects/{projectId}/resource-types` .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -8850,17 +9195,19 @@ export const ProjectResourceTypeApiFp = function(configuration?: Configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiV2ProjectsProjectIdResourcesTypesOptions(projectId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ProjectsProjectIdResourcesTypesOptions(projectId, options); + async apiV2ProjectsProjectIdResourceTypesOptions(projectId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ProjectsProjectIdResourceTypesOptions(projectId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {string} projectId + * @summary Retrieves the available resource types information for a specific project. + * @param {string} projectId The Id or slug of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8880,16 +9227,18 @@ export const ProjectResourceTypeApiFactory = function (configuration?: Configura return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2ProjectsProjectIdResourcesTypesOptions(projectId: string, options?: any): AxiosPromise<void> { - return localVarFp.apiV2ProjectsProjectIdResourcesTypesOptions(projectId, options).then((request) => request(axios, basePath)); + apiV2ProjectsProjectIdResourceTypesOptions(projectId: string, options?: any): AxiosPromise<void> { + return localVarFp.apiV2ProjectsProjectIdResourceTypesOptions(projectId, options).then((request) => request(axios, basePath)); }, /** * - * @param {string} projectId + * @summary Retrieves the available resource types information for a specific project. + * @param {string} projectId The Id or slug of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8908,18 +9257,20 @@ export const ProjectResourceTypeApiFactory = function (configuration?: Configura export class ProjectResourceTypeApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {string} projectId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceTypeApi */ - public apiV2ProjectsProjectIdResourcesTypesOptions(projectId: string, options?: any) { - return ProjectResourceTypeApiFp(this.configuration).apiV2ProjectsProjectIdResourcesTypesOptions(projectId, options).then((request) => request(this.axios, this.basePath)); + public apiV2ProjectsProjectIdResourceTypesOptions(projectId: string, options?: any) { + return ProjectResourceTypeApiFp(this.configuration).apiV2ProjectsProjectIdResourceTypesOptions(projectId, options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {string} projectId + * @summary Retrieves the available resource types information for a specific project. + * @param {string} projectId The Id or slug of the project. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectResourceTypeApi @@ -8938,6 +9289,7 @@ export const ResourceApiAxiosParamCreator = function (configuration?: Configurat return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -8970,7 +9322,8 @@ export const ResourceApiAxiosParamCreator = function (configuration?: Configurat }, /** * - * @param {string} resourceId + * @summary Retrieves a resource by its ID. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9016,6 +9369,7 @@ export const ResourceApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9025,7 +9379,8 @@ export const ResourceApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} resourceId + * @summary Retrieves a resource by its ID. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9045,6 +9400,7 @@ export const ResourceApiFactory = function (configuration?: Configuration, baseP return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9053,7 +9409,8 @@ export const ResourceApiFactory = function (configuration?: Configuration, baseP }, /** * - * @param {string} resourceId + * @summary Retrieves a resource by its ID. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9072,6 +9429,7 @@ export const ResourceApiFactory = function (configuration?: Configuration, baseP export class ResourceApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ResourceApi @@ -9082,7 +9440,8 @@ export class ResourceApi extends BaseAPI { /** * - * @param {string} resourceId + * @summary Retrieves a resource by its ID. + * @param {string} resourceId The ID of the resource to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ResourceApi @@ -9101,11 +9460,12 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2ResourcesTypesOptions: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/resources/types`; + apiV2ResourceTypesOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/resource-types`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -9133,7 +9493,8 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {number} gitlabProjectId + * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9146,7 +9507,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config assertParamExists('getAllGitlabBranchesForProject', 'domain', domain) // verify required parameter 'accessToken' is not null or undefined assertParamExists('getAllGitlabBranchesForProject', 'accessToken', accessToken) - const localVarPath = `/api/v2/resources/types/gitlab/projects/{gitlabProjectId}/branches` + const localVarPath = `/api/v2/resource-types/gitlab/projects/{gitlabProjectId}/branches` .replace(`{${"gitlabProjectId"}}`, encodeURIComponent(String(gitlabProjectId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -9183,6 +9544,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }, /** * + * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9193,7 +9555,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config assertParamExists('getAllGitlabProjects', 'domain', domain) // verify required parameter 'accessToken' is not null or undefined assertParamExists('getAllGitlabProjects', 'accessToken', accessToken) - const localVarPath = `/api/v2/resources/types/gitlab/projects`; + const localVarPath = `/api/v2/resource-types/gitlab/projects`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -9229,11 +9591,12 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }, /** * + * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllResourceTypesInformation: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/resources/types`; + const localVarPath = `/api/v2/resource-types/types`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -9261,7 +9624,8 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {number} gitlabProjectId + * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9274,7 +9638,7 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config assertParamExists('getGitlabProject', 'domain', domain) // verify required parameter 'accessToken' is not null or undefined assertParamExists('getGitlabProject', 'accessToken', accessToken) - const localVarPath = `/api/v2/resources/types/gitlab/projects/{gitlabProjectId}` + const localVarPath = `/api/v2/resource-types/gitlab/projects/{gitlabProjectId}` .replace(`{${"gitlabProjectId"}}`, encodeURIComponent(String(gitlabProjectId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -9311,14 +9675,15 @@ export const ResourceTypeApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {string} resourceTypeId + * @summary Retrieves the resource type information for a specific resource type. + * @param {string} resourceTypeId The ID of the resource type to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResourceTypeInformation: async (resourceTypeId: string, options: any = {}): Promise<RequestArgs> => { // verify required parameter 'resourceTypeId' is not null or undefined assertParamExists('getResourceTypeInformation', 'resourceTypeId', resourceTypeId) - const localVarPath = `/api/v2/resources/types/{resourceTypeId}` + const localVarPath = `/api/v2/resource-types/types/{resourceTypeId}` .replace(`{${"resourceTypeId"}}`, encodeURIComponent(String(resourceTypeId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -9357,16 +9722,18 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiV2ResourcesTypesOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ResourcesTypesOptions(options); + async apiV2ResourceTypesOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ResourceTypesOptions(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {number} gitlabProjectId + * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9378,6 +9745,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9389,6 +9757,7 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9398,7 +9767,8 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { }, /** * - * @param {number} gitlabProjectId + * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9410,7 +9780,8 @@ export const ResourceTypeApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} resourceTypeId + * @summary Retrieves the resource type information for a specific resource type. + * @param {string} resourceTypeId The ID of the resource type to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9430,15 +9801,17 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2ResourcesTypesOptions(options?: any): AxiosPromise<void> { - return localVarFp.apiV2ResourcesTypesOptions(options).then((request) => request(axios, basePath)); + apiV2ResourceTypesOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2ResourceTypesOptions(options).then((request) => request(axios, basePath)); }, /** * - * @param {number} gitlabProjectId + * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9449,6 +9822,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b }, /** * + * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9459,6 +9833,7 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b }, /** * + * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9467,7 +9842,8 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b }, /** * - * @param {number} gitlabProjectId + * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9478,7 +9854,8 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b }, /** * - * @param {string} resourceTypeId + * @summary Retrieves the resource type information for a specific resource type. + * @param {string} resourceTypeId The ID of the resource type to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9497,17 +9874,19 @@ export const ResourceTypeApiFactory = function (configuration?: Configuration, b export class ResourceTypeApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ResourceTypeApi */ - public apiV2ResourcesTypesOptions(options?: any) { - return ResourceTypeApiFp(this.configuration).apiV2ResourcesTypesOptions(options).then((request) => request(this.axios, this.basePath)); + public apiV2ResourceTypesOptions(options?: any) { + return ResourceTypeApiFp(this.configuration).apiV2ResourceTypesOptions(options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {number} gitlabProjectId + * @summary Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9520,6 +9899,7 @@ export class ResourceTypeApi extends BaseAPI { /** * + * @summary Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9532,6 +9912,7 @@ export class ResourceTypeApi extends BaseAPI { /** * + * @summary Retrieves the entire global resource types information. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ResourceTypeApi @@ -9542,7 +9923,8 @@ export class ResourceTypeApi extends BaseAPI { /** * - * @param {number} gitlabProjectId + * @summary Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. + * @param {number} gitlabProjectId The ID of the GitLab project. * @param {string} domain * @param {string} accessToken * @param {*} [options] Override http request option. @@ -9555,7 +9937,8 @@ export class ResourceTypeApi extends BaseAPI { /** * - * @param {string} resourceTypeId + * @summary Retrieves the resource type information for a specific resource type. + * @param {string} resourceTypeId The ID of the resource type to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ResourceTypeApi @@ -9574,6 +9957,7 @@ export const RoleApiAxiosParamCreator = function (configuration?: Configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9606,7 +9990,8 @@ export const RoleApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} roleId + * @summary Retrieves a role by ID. + * @param {string} roleId The ID of the role. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9642,6 +10027,7 @@ export const RoleApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @summary Retrieves all roles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -9699,6 +10085,7 @@ export const RoleApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9708,7 +10095,8 @@ export const RoleApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} roleId + * @summary Retrieves a role by ID. + * @param {string} roleId The ID of the role. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9718,6 +10106,7 @@ export const RoleApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all roles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -9740,6 +10129,7 @@ export const RoleApiFactory = function (configuration?: Configuration, basePath? return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9748,7 +10138,8 @@ export const RoleApiFactory = function (configuration?: Configuration, basePath? }, /** * - * @param {string} roleId + * @summary Retrieves a role by ID. + * @param {string} roleId The ID of the role. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -9757,6 +10148,7 @@ export const RoleApiFactory = function (configuration?: Configuration, basePath? }, /** * + * @summary Retrieves all roles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -9778,6 +10170,7 @@ export const RoleApiFactory = function (configuration?: Configuration, basePath? export class RoleApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RoleApi @@ -9788,7 +10181,8 @@ export class RoleApi extends BaseAPI { /** * - * @param {string} roleId + * @summary Retrieves a role by ID. + * @param {string} roleId The ID of the role. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RoleApi @@ -9799,6 +10193,7 @@ export class RoleApi extends BaseAPI { /** * + * @summary Retrieves all roles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -9813,18 +10208,19 @@ export class RoleApi extends BaseAPI { /** - * TitleApi - axios parameter creator + * SearchApi - axios parameter creator * @export */ -export const TitleApiAxiosParamCreator = function (configuration?: Configuration) { +export const SearchApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2TitlesOptions: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/titles`; + apiV2SearchOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/search`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -9852,15 +10248,19 @@ export const TitleApiAxiosParamCreator = function (configuration?: Configuration }, /** * - * @param {string} titleId + * @summary Retrieves a search result by given search parameters. + * @param {string} [query] + * @param {boolean} [useAdvancedSyntax] + * @param {Array<string>} [languages] + * @param {SearchCategoryType} [category] + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTitle: async (titleId: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'titleId' is not null or undefined - assertParamExists('getTitle', 'titleId', titleId) - const localVarPath = `/api/v2/titles/{titleId}` - .replace(`{${"titleId"}}`, encodeURIComponent(String(titleId))); + getSearchResults: async (query?: string, useAdvancedSyntax?: boolean, languages?: Array<string>, category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/search`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -9875,40 +10275,21 @@ export const TitleApiAxiosParamCreator = function (configuration?: Configuration // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (query !== undefined) { + localVarQueryParameter['Query'] = query; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {number} [pageNumber] - * @param {number} [pageSize] - * @param {string} [orderBy] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getTitles: async (pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/titles`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (useAdvancedSyntax !== undefined) { + localVarQueryParameter['UseAdvancedSyntax'] = useAdvancedSyntax; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (languages) { + localVarQueryParameter['Languages'] = languages; + } - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (category !== undefined) { + localVarQueryParameter['Category'] = category; + } if (pageNumber !== undefined) { localVarQueryParameter['PageNumber'] = pageNumber; @@ -9937,140 +10318,130 @@ export const TitleApiAxiosParamCreator = function (configuration?: Configuration }; /** - * TitleApi - functional programming interface + * SearchApi - functional programming interface * @export */ -export const TitleApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TitleApiAxiosParamCreator(configuration) +export const SearchApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiV2TitlesOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TitlesOptions(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {string} titleId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getTitle(titleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTitle(titleId, options); + async apiV2SearchOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2SearchOptions(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * + * @summary Retrieves a search result by given search parameters. + * @param {string} [query] + * @param {boolean} [useAdvancedSyntax] + * @param {Array<string>} [languages] + * @param {SearchCategoryType} [category] * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoIEnumerablePagedResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTitles(pageNumber, pageSize, orderBy, options); + async getSearchResults(query?: string, useAdvancedSyntax?: boolean, languages?: Array<string>, category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResultDtoIEnumerablePagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchResults(query, useAdvancedSyntax, languages, category, pageNumber, pageSize, orderBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** - * TitleApi - factory interface + * SearchApi - factory interface * @export */ -export const TitleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TitleApiFp(configuration) +export const SearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SearchApiFp(configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2TitlesOptions(options?: any): AxiosPromise<void> { - return localVarFp.apiV2TitlesOptions(options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {string} titleId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getTitle(titleId: string, options?: any): AxiosPromise<TitleDtoResponse> { - return localVarFp.getTitle(titleId, options).then((request) => request(axios, basePath)); + apiV2SearchOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2SearchOptions(options).then((request) => request(axios, basePath)); }, /** * + * @summary Retrieves a search result by given search parameters. + * @param {string} [query] + * @param {boolean} [useAdvancedSyntax] + * @param {Array<string>} [languages] + * @param {SearchCategoryType} [category] * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<TitleDtoIEnumerablePagedResponse> { - return localVarFp.getTitles(pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); + getSearchResults(query?: string, useAdvancedSyntax?: boolean, languages?: Array<string>, category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<SearchResultDtoIEnumerablePagedResponse> { + return localVarFp.getSearchResults(query, useAdvancedSyntax, languages, category, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); }, }; }; /** - * TitleApi - object-oriented interface + * SearchApi - object-oriented interface * @export - * @class TitleApi + * @class SearchApi * @extends {BaseAPI} */ -export class TitleApi extends BaseAPI { - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TitleApi - */ - public apiV2TitlesOptions(options?: any) { - return TitleApiFp(this.configuration).apiV2TitlesOptions(options).then((request) => request(this.axios, this.basePath)); - } - +export class SearchApi extends BaseAPI { /** * - * @param {string} titleId + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TitleApi + * @memberof SearchApi */ - public getTitle(titleId: string, options?: any) { - return TitleApiFp(this.configuration).getTitle(titleId, options).then((request) => request(this.axios, this.basePath)); + public apiV2SearchOptions(options?: any) { + return SearchApiFp(this.configuration).apiV2SearchOptions(options).then((request) => request(this.axios, this.basePath)); } /** * + * @summary Retrieves a search result by given search parameters. + * @param {string} [query] + * @param {boolean} [useAdvancedSyntax] + * @param {Array<string>} [languages] + * @param {SearchCategoryType} [category] * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TitleApi + * @memberof SearchApi */ - public getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { - return TitleApiFp(this.configuration).getTitles(pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); + public getSearchResults(query?: string, useAdvancedSyntax?: boolean, languages?: Array<string>, category?: SearchCategoryType, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { + return SearchApiFp(this.configuration).getSearchResults(query, useAdvancedSyntax, languages, category, pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); } } /** - * ToSApi - axios parameter creator + * SelfApi - axios parameter creator * @export */ -export const ToSApiAxiosParamCreator = function (configuration?: Configuration) { +export const SelfApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * + * @summary Accepts the current Terms Of Service for the current authenticated user. + * @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2TosOptions: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/tos`; + acceptCurrentTos: async (userTermsOfServiceAcceptDto?: UserTermsOfServiceAcceptDto, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self/tos`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10078,7 +10449,7 @@ export const ToSApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -10087,9 +10458,12 @@ export const ToSApiAxiosParamCreator = function (configuration?: Configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(userTermsOfServiceAcceptDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -10098,11 +10472,12 @@ export const ToSApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getToS: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/tos`; + apiV2SelfOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10110,7 +10485,7 @@ export const ToSApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -10128,113 +10503,862 @@ export const ToSApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, - } -}; - -/** - * ToSApi - functional programming interface - * @export - */ -export const ToSApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ToSApiAxiosParamCreator(configuration) - return { /** * + * @summary Confirms the email of a user. + * @param {string} confirmationToken * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiV2TosOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TosOptions(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + confirmUserEmail: async (confirmationToken: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'confirmationToken' is not null or undefined + assertParamExists('confirmUserEmail', 'confirmationToken', confirmationToken) + const localVarPath = `/api/v2/self/emails`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (confirmationToken !== undefined) { + localVarQueryParameter['ConfirmationToken'] = confirmationToken; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; }, /** * + * @summary Retrieves the current authenticated user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getToS(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TermsOfServiceDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getToS(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; + getCurrentUser: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } -/** - * ToSApi - factory interface - * @export - */ -export const ToSApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ToSApiFp(configuration) - return { + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * + * @summary Initiates user merging for the current user. + * @param {IdentityProviders} identityProvider * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2TosOptions(options?: any): AxiosPromise<void> { - return localVarFp.apiV2TosOptions(options).then((request) => request(axios, basePath)); - }, - /** - * + initiateUserMerge: async (identityProvider: IdentityProviders, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'identityProvider' is not null or undefined + assertParamExists('initiateUserMerge', 'identityProvider', identityProvider) + const localVarPath = `/api/v2/self/identities`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (identityProvider !== undefined) { + localVarQueryParameter['IdentityProvider'] = identityProvider; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Resolves a project invitation for the authenticated user. + * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resolveProjectInvitation: async (projectInvitationResolveDto?: ProjectInvitationResolveDto, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self/project-invitations`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(projectInvitationResolveDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Updates the current authenticated user. + * @param {UserForUpdateDto} [userForUpdateDto] The updated user data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateCurrentUser: async (userForUpdateDto?: UserForUpdateDto, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(userForUpdateDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * SelfApi - functional programming interface + * @export + */ +export const SelfApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SelfApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Accepts the current Terms Of Service for the current authenticated user. + * @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async acceptCurrentTos(userTermsOfServiceAcceptDto?: UserTermsOfServiceAcceptDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.acceptCurrentTos(userTermsOfServiceAcceptDto, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async apiV2SelfOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2SelfOptions(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Confirms the email of a user. + * @param {string} confirmationToken + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async confirmUserEmail(confirmationToken: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.confirmUserEmail(confirmationToken, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Retrieves the current authenticated user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getCurrentUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentUser(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Initiates user merging for the current user. + * @param {IdentityProviders} identityProvider + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async initiateUserMerge(identityProvider: IdentityProviders, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserMergeDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.initiateUserMerge(identityProvider, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Resolves a project invitation for the authenticated user. + * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async resolveProjectInvitation(projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.resolveProjectInvitation(projectInvitationResolveDto, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Updates the current authenticated user. + * @param {UserForUpdateDto} [userForUpdateDto] The updated user data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateCurrentUser(userForUpdateDto, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * SelfApi - factory interface + * @export + */ +export const SelfApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SelfApiFp(configuration) + return { + /** + * + * @summary Accepts the current Terms Of Service for the current authenticated user. + * @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + acceptCurrentTos(userTermsOfServiceAcceptDto?: UserTermsOfServiceAcceptDto, options?: any): AxiosPromise<void> { + return localVarFp.acceptCurrentTos(userTermsOfServiceAcceptDto, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiV2SelfOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2SelfOptions(options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Confirms the email of a user. + * @param {string} confirmationToken + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmUserEmail(confirmationToken: string, options?: any): AxiosPromise<void> { + return localVarFp.confirmUserEmail(confirmationToken, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Retrieves the current authenticated user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCurrentUser(options?: any): AxiosPromise<UserDtoResponse> { + return localVarFp.getCurrentUser(options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Initiates user merging for the current user. + * @param {IdentityProviders} identityProvider + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + initiateUserMerge(identityProvider: IdentityProviders, options?: any): AxiosPromise<UserMergeDtoResponse> { + return localVarFp.initiateUserMerge(identityProvider, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Resolves a project invitation for the authenticated user. + * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resolveProjectInvitation(projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any): AxiosPromise<void> { + return localVarFp.resolveProjectInvitation(projectInvitationResolveDto, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Updates the current authenticated user. + * @param {UserForUpdateDto} [userForUpdateDto] The updated user data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any): AxiosPromise<void> { + return localVarFp.updateCurrentUser(userForUpdateDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * SelfApi - object-oriented interface + * @export + * @class SelfApi + * @extends {BaseAPI} + */ +export class SelfApi extends BaseAPI { + /** + * + * @summary Accepts the current Terms Of Service for the current authenticated user. + * @param {UserTermsOfServiceAcceptDto} [userTermsOfServiceAcceptDto] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public acceptCurrentTos(userTermsOfServiceAcceptDto?: UserTermsOfServiceAcceptDto, options?: any) { + return SelfApiFp(this.configuration).acceptCurrentTos(userTermsOfServiceAcceptDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public apiV2SelfOptions(options?: any) { + return SelfApiFp(this.configuration).apiV2SelfOptions(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Confirms the email of a user. + * @param {string} confirmationToken + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public confirmUserEmail(confirmationToken: string, options?: any) { + return SelfApiFp(this.configuration).confirmUserEmail(confirmationToken, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Retrieves the current authenticated user. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public getCurrentUser(options?: any) { + return SelfApiFp(this.configuration).getCurrentUser(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Initiates user merging for the current user. + * @param {IdentityProviders} identityProvider + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public initiateUserMerge(identityProvider: IdentityProviders, options?: any) { + return SelfApiFp(this.configuration).initiateUserMerge(identityProvider, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Resolves a project invitation for the authenticated user. + * @param {ProjectInvitationResolveDto} [projectInvitationResolveDto] The project invitation resolve data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public resolveProjectInvitation(projectInvitationResolveDto?: ProjectInvitationResolveDto, options?: any) { + return SelfApiFp(this.configuration).resolveProjectInvitation(projectInvitationResolveDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Updates the current authenticated user. + * @param {UserForUpdateDto} [userForUpdateDto] The updated user data. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApi + */ + public updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any) { + return SelfApiFp(this.configuration).updateCurrentUser(userForUpdateDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + +/** + * SelfApiTokenApi - axios parameter creator + * @export + */ +export const SelfApiTokenApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiV2SelfApiTokensOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self/api-tokens`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Creates an API token for the current authenticated user. + * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createApiToken: async (apiTokenForCreationDto?: ApiTokenForCreationDto, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self/api-tokens`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(apiTokenForCreationDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Retrieves all API tokens for the current authenticated user. + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllApiTokens: async (pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/self/api-tokens`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (pageNumber !== undefined) { + localVarQueryParameter['PageNumber'] = pageNumber; + } + + if (pageSize !== undefined) { + localVarQueryParameter['PageSize'] = pageSize; + } + + if (orderBy !== undefined) { + localVarQueryParameter['OrderBy'] = orderBy; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Retrieves an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getApiToken: async (apiTokenId: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'apiTokenId' is not null or undefined + assertParamExists('getApiToken', 'apiTokenId', apiTokenId) + const localVarPath = `/api/v2/self/api-tokens/{apiTokenId}` + .replace(`{${"apiTokenId"}}`, encodeURIComponent(String(apiTokenId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Revokes an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + revokeToken: async (apiTokenId: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'apiTokenId' is not null or undefined + assertParamExists('revokeToken', 'apiTokenId', apiTokenId) + const localVarPath = `/api/v2/self/api-tokens/{apiTokenId}` + .replace(`{${"apiTokenId"}}`, encodeURIComponent(String(apiTokenId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Bearer required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * SelfApiTokenApi - functional programming interface + * @export + */ +export const SelfApiTokenApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SelfApiTokenApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async apiV2SelfApiTokensOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2SelfApiTokensOptions(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Creates an API token for the current authenticated user. + * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createApiToken(apiTokenForCreationDto, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Retrieves all API tokens for the current authenticated user. + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoIEnumerablePagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAllApiTokens(pageNumber, pageSize, orderBy, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Retrieves an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getToS(options?: any): AxiosPromise<TermsOfServiceDtoResponse> { - return localVarFp.getToS(options).then((request) => request(axios, basePath)); + async getApiToken(apiTokenId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getApiToken(apiTokenId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Revokes an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async revokeToken(apiTokenId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.revokeToken(apiTokenId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * SelfApiTokenApi - factory interface + * @export + */ +export const SelfApiTokenApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SelfApiTokenApiFp(configuration) + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiV2SelfApiTokensOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2SelfApiTokensOptions(options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Creates an API token for the current authenticated user. + * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any): AxiosPromise<ApiTokenDtoResponse> { + return localVarFp.createApiToken(apiTokenForCreationDto, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Retrieves all API tokens for the current authenticated user. + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ApiTokenDtoIEnumerablePagedResponse> { + return localVarFp.getAllApiTokens(pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Retrieves an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getApiToken(apiTokenId: string, options?: any): AxiosPromise<ApiTokenDtoResponse> { + return localVarFp.getApiToken(apiTokenId, options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Revokes an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + revokeToken(apiTokenId: string, options?: any): AxiosPromise<void> { + return localVarFp.revokeToken(apiTokenId, options).then((request) => request(axios, basePath)); }, }; }; /** - * ToSApi - object-oriented interface + * SelfApiTokenApi - object-oriented interface * @export - * @class ToSApi + * @class SelfApiTokenApi * @extends {BaseAPI} */ -export class ToSApi extends BaseAPI { +export class SelfApiTokenApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ToSApi + * @memberof SelfApiTokenApi */ - public apiV2TosOptions(options?: any) { - return ToSApiFp(this.configuration).apiV2TosOptions(options).then((request) => request(this.axios, this.basePath)); + public apiV2SelfApiTokensOptions(options?: any) { + return SelfApiTokenApiFp(this.configuration).apiV2SelfApiTokensOptions(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Creates an API token for the current authenticated user. + * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] The API token data for creation. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApiTokenApi + */ + public createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any) { + return SelfApiTokenApiFp(this.configuration).createApiToken(apiTokenForCreationDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Retrieves all API tokens for the current authenticated user. + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApiTokenApi + */ + public getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { + return SelfApiTokenApiFp(this.configuration).getAllApiTokens(pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); } /** * + * @summary Retrieves an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ToSApi + * @memberof SelfApiTokenApi */ - public getToS(options?: any) { - return ToSApiFp(this.configuration).getToS(options).then((request) => request(this.axios, this.basePath)); + public getApiToken(apiTokenId: string, options?: any) { + return SelfApiTokenApiFp(this.configuration).getApiToken(apiTokenId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Revokes an API token for the current authenticated user. + * @param {string} apiTokenId The ID of the token. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SelfApiTokenApi + */ + public revokeToken(apiTokenId: string, options?: any) { + return SelfApiTokenApiFp(this.configuration).revokeToken(apiTokenId, options).then((request) => request(this.axios, this.basePath)); } } /** - * TreeApi - axios parameter creator + * TitleApi - axios parameter creator * @export */ -export const TreeApiAxiosParamCreator = function (configuration?: Configuration) { +export const TitleApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * - * @param {string} projectId - * @param {string} resourceId + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: async (projectId: string, resourceId: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('apiV2ProjectsProjectIdResourcesResourceIdTreesOptions', 'projectId', projectId) - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('apiV2ProjectsProjectIdResourcesResourceIdTreesOptions', 'resourceId', resourceId) - const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + apiV2TitlesOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/titles`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10262,67 +11386,16 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createMetadataTree: async (projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('createMetadataTree', 'projectId', projectId) - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('createMetadataTree', 'resourceId', resourceId) - const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(metadataTreeForCreationDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {number} [pageNumber] - * @param {number} [pageSize] - * @param {string} [orderBy] + * @summary Retrieves a title by ID. + * @param {string} titleId The ID of the title. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFileTree: async (projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('getFileTree', 'projectId', projectId) - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('getFileTree', 'resourceId', resourceId) - const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/files` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + getTitle: async (titleId: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'titleId' is not null or undefined + assertParamExists('getTitle', 'titleId', titleId) + const localVarPath = `/api/v2/titles/{titleId}` + .replace(`{${"titleId"}}`, encodeURIComponent(String(titleId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10337,22 +11410,6 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (path !== undefined) { - localVarQueryParameter['Path'] = path; - } - - if (pageNumber !== undefined) { - localVarQueryParameter['PageNumber'] = pageNumber; - } - - if (pageSize !== undefined) { - localVarQueryParameter['PageSize'] = pageSize; - } - - if (orderBy !== undefined) { - localVarQueryParameter['OrderBy'] = orderBy; - } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); @@ -10366,85 +11423,15 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {RdfFormat} [format] + * @summary Retrieves all titles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMetadataTree: async (projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('getMetadataTree', 'projectId', projectId) - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('getMetadataTree', 'resourceId', resourceId) - const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - if (path !== undefined) { - localVarQueryParameter['Path'] = path; - } - - if (format !== undefined) { - localVarQueryParameter['Format'] = format; - } - - if (pageNumber !== undefined) { - localVarQueryParameter['PageNumber'] = pageNumber; - } - - if (pageSize !== undefined) { - localVarQueryParameter['PageSize'] = pageSize; - } - - if (orderBy !== undefined) { - localVarQueryParameter['OrderBy'] = orderBy; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateMetadataTree: async (projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'projectId' is not null or undefined - assertParamExists('updateMetadataTree', 'projectId', projectId) - // verify required parameter 'resourceId' is not null or undefined - assertParamExists('updateMetadataTree', 'resourceId', resourceId) - const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` - .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) - .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); + getTitles: async (pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/titles`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10452,21 +11439,30 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (pageNumber !== undefined) { + localVarQueryParameter['PageNumber'] = pageNumber; + } + + if (pageSize !== undefined) { + localVarQueryParameter['PageSize'] = pageSize; + } + + if (orderBy !== undefined) { + localVarQueryParameter['OrderBy'] = orderBy; + } - - localVarHeaderParameter['Content-Type'] = 'application/json'; + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(metadataTreeForUpdateDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -10477,245 +11473,150 @@ export const TreeApiAxiosParamCreator = function (configuration?: Configuration) }; /** - * TreeApi - functional programming interface + * TitleApi - functional programming interface * @export */ -export const TreeApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TreeApiAxiosParamCreator(configuration) +export const TitleApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TitleApiAxiosParamCreator(configuration) return { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId, resourceId, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createMetadataTree(projectId, resourceId, metadataTreeForCreationDto, options); + async apiV2TitlesOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TitlesOptions(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {number} [pageNumber] - * @param {number} [pageSize] - * @param {string} [orderBy] + * @summary Retrieves a title by ID. + * @param {string} titleId The ID of the title. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileDtoIEnumerablePagedResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFileTree(projectId, resourceId, path, pageNumber, pageSize, orderBy, options); + async getTitle(titleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTitle(titleId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {RdfFormat} [format] + * @summary Retrieves all titles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataDtoIEnumerablePagedResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadataTree(projectId, resourceId, path, format, pageNumber, pageSize, orderBy, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateMetadataTree(projectId, resourceId, metadataTreeForUpdateDto, options); + async getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TitleDtoIEnumerablePagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTitles(pageNumber, pageSize, orderBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** - * TreeApi - factory interface + * TitleApi - factory interface * @export */ -export const TreeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TreeApiFp(configuration) +export const TitleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TitleApiFp(configuration) return { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void> { - return localVarFp.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId, resourceId, options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any): AxiosPromise<MetadataDtoResponse> { - return localVarFp.createMetadataTree(projectId, resourceId, metadataTreeForCreationDto, options).then((request) => request(axios, basePath)); + apiV2TitlesOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2TitlesOptions(options).then((request) => request(axios, basePath)); }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {number} [pageNumber] - * @param {number} [pageSize] - * @param {string} [orderBy] + * @summary Retrieves a title by ID. + * @param {string} titleId The ID of the title. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<FileDtoIEnumerablePagedResponse> { - return localVarFp.getFileTree(projectId, resourceId, path, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); + getTitle(titleId: string, options?: any): AxiosPromise<TitleDtoResponse> { + return localVarFp.getTitle(titleId, options).then((request) => request(axios, basePath)); }, /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {RdfFormat} [format] + * @summary Retrieves all titles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<MetadataDtoIEnumerablePagedResponse> { - return localVarFp.getMetadataTree(projectId, resourceId, path, format, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any): AxiosPromise<void> { - return localVarFp.updateMetadataTree(projectId, resourceId, metadataTreeForUpdateDto, options).then((request) => request(axios, basePath)); + getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<TitleDtoIEnumerablePagedResponse> { + return localVarFp.getTitles(pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); }, }; }; /** - * TreeApi - object-oriented interface + * TitleApi - object-oriented interface * @export - * @class TreeApi + * @class TitleApi * @extends {BaseAPI} */ -export class TreeApi extends BaseAPI { - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TreeApi - */ - public apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any) { - return TreeApiFp(this.configuration).apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId, resourceId, options).then((request) => request(this.axios, this.basePath)); - } - +export class TitleApi extends BaseAPI { /** * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TreeApi + * @memberof TitleApi */ - public createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any) { - return TreeApiFp(this.configuration).createMetadataTree(projectId, resourceId, metadataTreeForCreationDto, options).then((request) => request(this.axios, this.basePath)); + public apiV2TitlesOptions(options?: any) { + return TitleApiFp(this.configuration).apiV2TitlesOptions(options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {number} [pageNumber] - * @param {number} [pageSize] - * @param {string} [orderBy] + * @summary Retrieves a title by ID. + * @param {string} titleId The ID of the title. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TreeApi + * @memberof TitleApi */ - public getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { - return TreeApiFp(this.configuration).getFileTree(projectId, resourceId, path, pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); + public getTitle(titleId: string, options?: any) { + return TitleApiFp(this.configuration).getTitle(titleId, options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {string} projectId - * @param {string} resourceId - * @param {string} [path] - * @param {RdfFormat} [format] + * @summary Retrieves all titles. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TreeApi - */ - public getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { - return TreeApiFp(this.configuration).getMetadataTree(projectId, resourceId, path, format, pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @param {string} projectId - * @param {string} resourceId - * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TreeApi + * @memberof TitleApi */ - public updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any) { - return TreeApiFp(this.configuration).updateMetadataTree(projectId, resourceId, metadataTreeForUpdateDto, options).then((request) => request(this.axios, this.basePath)); + public getTitles(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { + return TitleApiFp(this.configuration).getTitles(pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); } } /** - * UserApi - axios parameter creator + * TosApi - axios parameter creator * @export */ -export const UserApiAxiosParamCreator = function (configuration?: Configuration) { +export const TosApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - acceptCurrentToS: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users/self/accept-tos`; + apiV2TosOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/tos`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10723,7 +11624,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -10743,11 +11644,12 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @summary Retrieves the current Terms of Service version. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2UsersOptions: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users`; + getTos: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/tos`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10755,7 +11657,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -10773,16 +11675,120 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) options: localVarRequestOptions, }; }, + } +}; + +/** + * TosApi - functional programming interface + * @export + */ +export const TosApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TosApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async apiV2TosOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TosOptions(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Retrieves the current Terms of Service version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTos(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TermsOfServiceDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTos(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * TosApi - factory interface + * @export + */ +export const TosApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TosApiFp(configuration) + return { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiV2TosOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2TosOptions(options).then((request) => request(axios, basePath)); + }, + /** + * + * @summary Retrieves the current Terms of Service version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTos(options?: any): AxiosPromise<TermsOfServiceDtoResponse> { + return localVarFp.getTos(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * TosApi - object-oriented interface + * @export + * @class TosApi + * @extends {BaseAPI} + */ +export class TosApi extends BaseAPI { + /** + * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TosApi + */ + public apiV2TosOptions(options?: any) { + return TosApiFp(this.configuration).apiV2TosOptions(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Retrieves the current Terms of Service version. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TosApi + */ + public getTos(options?: any) { + return TosApiFp(this.configuration).getTos(options).then((request) => request(this.axios, this.basePath)); + } +} + + +/** + * TreeApi - axios parameter creator + * @export + */ +export const TreeApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** * - * @param {string} confirmationToken + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {string} projectId + * @param {string} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - confirmUserEmail: async (confirmationToken: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'confirmationToken' is not null or undefined - assertParamExists('confirmUserEmail', 'confirmationToken', confirmationToken) - const localVarPath = `/api/v2/users/self/confirm-email`; + apiV2ProjectsProjectIdResourcesResourceIdTreesOptions: async (projectId: string, resourceId: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('apiV2ProjectsProjectIdResourcesResourceIdTreesOptions', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('apiV2ProjectsProjectIdResourcesResourceIdTreesOptions', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10790,17 +11796,13 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'OPTIONS', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (confirmationToken !== undefined) { - localVarQueryParameter['ConfirmationToken'] = confirmationToken; - } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); @@ -10814,11 +11816,21 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }, /** * + * @summary Creates a new metadata tree for a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] The metadata tree data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCurrentUser: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users/self`; + createMetadataTree: async (projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('createMetadataTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('createMetadataTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10826,7 +11838,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -10835,9 +11847,12 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(metadataTreeForCreationDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -10845,16 +11860,25 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * - * @param {string} searchTerm + * The `OrderBy` query is currently not supported. + * @summary Retrieves the file tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {number} [pageNumber] + * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUsers: async (searchTerm: string, orderBy?: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'searchTerm' is not null or undefined - assertParamExists('getUsers', 'searchTerm', searchTerm) - const localVarPath = `/api/v2/users`; + getFileTree: async (projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('getFileTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('getFileTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/files` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10869,12 +11893,20 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (orderBy !== undefined) { - localVarQueryParameter['OrderBy'] = orderBy; + if (path !== undefined) { + localVarQueryParameter['Path'] = path; } - if (searchTerm !== undefined) { - localVarQueryParameter['SearchTerm'] = searchTerm; + if (pageNumber !== undefined) { + localVarQueryParameter['PageNumber'] = pageNumber; + } + + if (pageSize !== undefined) { + localVarQueryParameter['PageSize'] = pageSize; + } + + if (orderBy !== undefined) { + localVarQueryParameter['OrderBy'] = orderBy; } @@ -10890,14 +11922,25 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {ExternalAuthenticators} externalAuthenticator + * @summary Retrieves the metadata tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {RdfFormat} [format] + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - initiateUserMerge: async (externalAuthenticator: ExternalAuthenticators, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'externalAuthenticator' is not null or undefined - assertParamExists('initiateUserMerge', 'externalAuthenticator', externalAuthenticator) - const localVarPath = `/api/v2/users/self/init-merge`; + getMetadataTree: async (projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('getMetadataTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('getMetadataTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10905,15 +11948,31 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (externalAuthenticator !== undefined) { - localVarQueryParameter['ExternalAuthenticator'] = externalAuthenticator; + if (path !== undefined) { + localVarQueryParameter['Path'] = path; + } + + if (format !== undefined) { + localVarQueryParameter['Format'] = format; + } + + if (pageNumber !== undefined) { + localVarQueryParameter['PageNumber'] = pageNumber; + } + + if (pageSize !== undefined) { + localVarQueryParameter['PageSize'] = pageSize; + } + + if (orderBy !== undefined) { + localVarQueryParameter['OrderBy'] = orderBy; } @@ -10929,12 +11988,21 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }, /** * - * @param {UserForUpdateDto} [userForUpdateDto] + * @summary Updates an existing metadata tree of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] The updated metadata tree data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateCurrentUser: async (userForUpdateDto?: UserForUpdateDto, options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users/self`; + updateMetadataTree: async (projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'projectId' is not null or undefined + assertParamExists('updateMetadataTree', 'projectId', projectId) + // verify required parameter 'resourceId' is not null or undefined + assertParamExists('updateMetadataTree', 'resourceId', resourceId) + const localVarPath = `/api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata` + .replace(`{${"projectId"}}`, encodeURIComponent(String(projectId))) + .replace(`{${"resourceId"}}`, encodeURIComponent(String(resourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -10956,7 +12024,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(userForUpdateDto, localVarRequestOptions, configuration) + localVarRequestOptions.data = serializeDataIfNeeded(metadataTreeForUpdateDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -10967,251 +12035,261 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) }; /** - * UserApi - functional programming interface + * TreeApi - functional programming interface * @export */ -export const UserApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) +export const TreeApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TreeApiAxiosParamCreator(configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {string} projectId + * @param {string} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async acceptCurrentToS(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.acceptCurrentToS(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async apiV2UsersOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2UsersOptions(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {string} confirmationToken - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async confirmUserEmail(confirmationToken: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.confirmUserEmail(confirmationToken, options); + async apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId, resourceId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * + * @summary Creates a new metadata tree for a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] The metadata tree data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getCurrentUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentUser(options); + async createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createMetadataTree(projectId, resourceId, metadataTreeForCreationDto, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * - * @param {string} searchTerm + * The `OrderBy` query is currently not supported. + * @summary Retrieves the file tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {number} [pageNumber] + * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getUsers(searchTerm: string, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicUserDtoIEnumerableResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUsers(searchTerm, orderBy, options); + async getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTreeDtoIEnumerablePagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFileTree(projectId, resourceId, path, pageNumber, pageSize, orderBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {ExternalAuthenticators} externalAuthenticator + * @summary Retrieves the metadata tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {RdfFormat} [format] + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async initiateUserMerge(externalAuthenticator: ExternalAuthenticators, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserMergeDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.initiateUserMerge(externalAuthenticator, options); + async getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataTreeDtoIEnumerablePagedResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadataTree(projectId, resourceId, path, format, pageNumber, pageSize, orderBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {UserForUpdateDto} [userForUpdateDto] + * @summary Updates an existing metadata tree of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] The updated metadata tree data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateCurrentUser(userForUpdateDto, options); + async updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateMetadataTree(projectId, resourceId, metadataTreeForUpdateDto, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** - * UserApi - factory interface + * TreeApi - factory interface * @export */ -export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UserApiFp(configuration) +export const TreeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TreeApiFp(configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {string} projectId + * @param {string} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - acceptCurrentToS(options?: any): AxiosPromise<void> { - return localVarFp.acceptCurrentToS(options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - apiV2UsersOptions(options?: any): AxiosPromise<void> { - return localVarFp.apiV2UsersOptions(options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {string} confirmationToken - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - confirmUserEmail(confirmationToken: string, options?: any): AxiosPromise<void> { - return localVarFp.confirmUserEmail(confirmationToken, options).then((request) => request(axios, basePath)); + apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any): AxiosPromise<void> { + return localVarFp.apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId, resourceId, options).then((request) => request(axios, basePath)); }, /** * + * @summary Creates a new metadata tree for a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] The metadata tree data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCurrentUser(options?: any): AxiosPromise<UserDtoResponse> { - return localVarFp.getCurrentUser(options).then((request) => request(axios, basePath)); + createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any): AxiosPromise<MetadataTreeDtoResponse> { + return localVarFp.createMetadataTree(projectId, resourceId, metadataTreeForCreationDto, options).then((request) => request(axios, basePath)); }, /** - * - * @param {string} searchTerm + * The `OrderBy` query is currently not supported. + * @summary Retrieves the file tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {number} [pageNumber] + * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUsers(searchTerm: string, orderBy?: string, options?: any): AxiosPromise<PublicUserDtoIEnumerableResponse> { - return localVarFp.getUsers(searchTerm, orderBy, options).then((request) => request(axios, basePath)); + getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<FileTreeDtoIEnumerablePagedResponse> { + return localVarFp.getFileTree(projectId, resourceId, path, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); }, /** * - * @param {ExternalAuthenticators} externalAuthenticator + * @summary Retrieves the metadata tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {RdfFormat} [format] + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - initiateUserMerge(externalAuthenticator: ExternalAuthenticators, options?: any): AxiosPromise<UserMergeDtoResponse> { - return localVarFp.initiateUserMerge(externalAuthenticator, options).then((request) => request(axios, basePath)); + getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<MetadataTreeDtoIEnumerablePagedResponse> { + return localVarFp.getMetadataTree(projectId, resourceId, path, format, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); }, /** * - * @param {UserForUpdateDto} [userForUpdateDto] + * @summary Updates an existing metadata tree of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] The updated metadata tree data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any): AxiosPromise<void> { - return localVarFp.updateCurrentUser(userForUpdateDto, options).then((request) => request(axios, basePath)); + updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any): AxiosPromise<void> { + return localVarFp.updateMetadataTree(projectId, resourceId, metadataTreeForUpdateDto, options).then((request) => request(axios, basePath)); }, }; }; /** - * UserApi - object-oriented interface + * TreeApi - object-oriented interface * @export - * @class UserApi + * @class TreeApi * @extends {BaseAPI} */ -export class UserApi extends BaseAPI { - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public acceptCurrentToS(options?: any) { - return UserApiFp(this.configuration).acceptCurrentToS(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public apiV2UsersOptions(options?: any) { - return UserApiFp(this.configuration).apiV2UsersOptions(options).then((request) => request(this.axios, this.basePath)); - } - +export class TreeApi extends BaseAPI { /** * - * @param {string} confirmationToken + * @summary Responds with the HTTP methods allowed for the endpoint. + * @param {string} projectId + * @param {string} resourceId * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi + * @memberof TreeApi */ - public confirmUserEmail(confirmationToken: string, options?: any) { - return UserApiFp(this.configuration).confirmUserEmail(confirmationToken, options).then((request) => request(this.axios, this.basePath)); + public apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId: string, resourceId: string, options?: any) { + return TreeApiFp(this.configuration).apiV2ProjectsProjectIdResourcesResourceIdTreesOptions(projectId, resourceId, options).then((request) => request(this.axios, this.basePath)); } /** * + * @summary Creates a new metadata tree for a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForCreationDto} [metadataTreeForCreationDto] The metadata tree data for creation. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi + * @memberof TreeApi */ - public getCurrentUser(options?: any) { - return UserApiFp(this.configuration).getCurrentUser(options).then((request) => request(this.axios, this.basePath)); + public createMetadataTree(projectId: string, resourceId: string, metadataTreeForCreationDto?: MetadataTreeForCreationDto, options?: any) { + return TreeApiFp(this.configuration).createMetadataTree(projectId, resourceId, metadataTreeForCreationDto, options).then((request) => request(this.axios, this.basePath)); } /** - * - * @param {string} searchTerm + * The `OrderBy` query is currently not supported. + * @summary Retrieves the file tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {number} [pageNumber] + * @param {number} [pageSize] * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi + * @memberof TreeApi */ - public getUsers(searchTerm: string, orderBy?: string, options?: any) { - return UserApiFp(this.configuration).getUsers(searchTerm, orderBy, options).then((request) => request(this.axios, this.basePath)); + public getFileTree(projectId: string, resourceId: string, path?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { + return TreeApiFp(this.configuration).getFileTree(projectId, resourceId, path, pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {ExternalAuthenticators} externalAuthenticator + * @summary Retrieves the metadata tree associated with a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {string} [path] + * @param {RdfFormat} [format] + * @param {number} [pageNumber] + * @param {number} [pageSize] + * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi + * @memberof TreeApi */ - public initiateUserMerge(externalAuthenticator: ExternalAuthenticators, options?: any) { - return UserApiFp(this.configuration).initiateUserMerge(externalAuthenticator, options).then((request) => request(this.axios, this.basePath)); + public getMetadataTree(projectId: string, resourceId: string, path?: string, format?: RdfFormat, pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { + return TreeApiFp(this.configuration).getMetadataTree(projectId, resourceId, path, format, pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {UserForUpdateDto} [userForUpdateDto] + * @summary Updates an existing metadata tree of a resource. + * @param {string} projectId The unique identifier or slug of the project. + * @param {string} resourceId The unique identifier of the resource. + * @param {MetadataTreeForUpdateDto} [metadataTreeForUpdateDto] The updated metadata tree data. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi + * @memberof TreeApi */ - public updateCurrentUser(userForUpdateDto?: UserForUpdateDto, options?: any) { - return UserApiFp(this.configuration).updateCurrentUser(userForUpdateDto, options).then((request) => request(this.axios, this.basePath)); + public updateMetadataTree(projectId: string, resourceId: string, metadataTreeForUpdateDto?: MetadataTreeForUpdateDto, options?: any) { + return TreeApiFp(this.configuration).updateMetadataTree(projectId, resourceId, metadataTreeForUpdateDto, options).then((request) => request(this.axios, this.basePath)); } } /** - * UserApiTokenApi - axios parameter creator + * UserApi - axios parameter creator * @export */ -export const UserApiTokenApiAxiosParamCreator = function (configuration?: Configuration) { +export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2UsersSelfTokensOptions: async (options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users/self/tokens`; + apiV2UsersOptions: async (options: any = {}): Promise<RequestArgs> => { + const localVarPath = `/api/v2/users`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -11239,50 +12317,16 @@ export const UserApiTokenApiAxiosParamCreator = function (configuration?: Config }, /** * - * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createApiToken: async (apiTokenForCreationDto?: ApiTokenForCreationDto, options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users/self/tokens`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(apiTokenForCreationDto, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {number} [pageNumber] - * @param {number} [pageSize] + * @summary Retrieves all users. + * @param {string} searchTerm * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAllApiTokens: async (pageNumber?: number, pageSize?: number, orderBy?: string, options: any = {}): Promise<RequestArgs> => { - const localVarPath = `/api/v2/users/self/tokens`; + getUsers: async (searchTerm: string, orderBy?: string, options: any = {}): Promise<RequestArgs> => { + // verify required parameter 'searchTerm' is not null or undefined + assertParamExists('getUsers', 'searchTerm', searchTerm) + const localVarPath = `/api/v2/users`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -11297,90 +12341,14 @@ export const UserApiTokenApiAxiosParamCreator = function (configuration?: Config // authentication Bearer required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (pageNumber !== undefined) { - localVarQueryParameter['PageNumber'] = pageNumber; - } - - if (pageSize !== undefined) { - localVarQueryParameter['PageSize'] = pageSize; - } - if (orderBy !== undefined) { localVarQueryParameter['OrderBy'] = orderBy; } - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getApiToken: async (apiTokenId: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'apiTokenId' is not null or undefined - assertParamExists('getApiToken', 'apiTokenId', apiTokenId) - const localVarPath = `/api/v2/users/self/tokens/{apiTokenId}` - .replace(`{${"apiTokenId"}}`, encodeURIComponent(String(apiTokenId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - revokeToken: async (apiTokenId: string, options: any = {}): Promise<RequestArgs> => { - // verify required parameter 'apiTokenId' is not null or undefined - assertParamExists('revokeToken', 'apiTokenId', apiTokenId) - const localVarPath = `/api/v2/users/self/tokens/{apiTokenId}` - .replace(`{${"apiTokenId"}}`, encodeURIComponent(String(apiTokenId))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (searchTerm !== undefined) { + localVarQueryParameter['SearchTerm'] = searchTerm; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication Bearer required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); @@ -11396,183 +12364,96 @@ export const UserApiTokenApiAxiosParamCreator = function (configuration?: Config }; /** - * UserApiTokenApi - functional programming interface + * UserApi - functional programming interface * @export */ -export const UserApiTokenApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UserApiTokenApiAxiosParamCreator(configuration) +export const UserApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiV2UsersSelfTokensOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2UsersSelfTokensOptions(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createApiToken(apiTokenForCreationDto, options); + async apiV2UsersOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2UsersOptions(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * - * @param {number} [pageNumber] - * @param {number} [pageSize] + * @summary Retrieves all users. + * @param {string} searchTerm * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoIEnumerablePagedResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllApiTokens(pageNumber, pageSize, orderBy, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getApiToken(apiTokenId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiTokenDtoResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getApiToken(apiTokenId, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async revokeToken(apiTokenId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.revokeToken(apiTokenId, options); + async getUsers(searchTerm: string, orderBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicUserDtoIEnumerableResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUsers(searchTerm, orderBy, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; /** - * UserApiTokenApi - factory interface + * UserApi - factory interface * @export */ -export const UserApiTokenApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UserApiTokenApiFp(configuration) +export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = UserApiFp(configuration) return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiV2UsersSelfTokensOptions(options?: any): AxiosPromise<void> { - return localVarFp.apiV2UsersSelfTokensOptions(options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any): AxiosPromise<ApiTokenDtoResponse> { - return localVarFp.createApiToken(apiTokenForCreationDto, options).then((request) => request(axios, basePath)); + apiV2UsersOptions(options?: any): AxiosPromise<void> { + return localVarFp.apiV2UsersOptions(options).then((request) => request(axios, basePath)); }, /** * - * @param {number} [pageNumber] - * @param {number} [pageSize] + * @summary Retrieves all users. + * @param {string} searchTerm * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any): AxiosPromise<ApiTokenDtoIEnumerablePagedResponse> { - return localVarFp.getAllApiTokens(pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getApiToken(apiTokenId: string, options?: any): AxiosPromise<ApiTokenDtoResponse> { - return localVarFp.getApiToken(apiTokenId, options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - revokeToken(apiTokenId: string, options?: any): AxiosPromise<void> { - return localVarFp.revokeToken(apiTokenId, options).then((request) => request(axios, basePath)); + getUsers(searchTerm: string, orderBy?: string, options?: any): AxiosPromise<PublicUserDtoIEnumerableResponse> { + return localVarFp.getUsers(searchTerm, orderBy, options).then((request) => request(axios, basePath)); }, }; }; /** - * UserApiTokenApi - object-oriented interface + * UserApi - object-oriented interface * @export - * @class UserApiTokenApi + * @class UserApi * @extends {BaseAPI} */ -export class UserApiTokenApi extends BaseAPI { - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApiTokenApi - */ - public apiV2UsersSelfTokensOptions(options?: any) { - return UserApiTokenApiFp(this.configuration).apiV2UsersSelfTokensOptions(options).then((request) => request(this.axios, this.basePath)); - } - +export class UserApi extends BaseAPI { /** * - * @param {ApiTokenForCreationDto} [apiTokenForCreationDto] + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiTokenApi + * @memberof UserApi */ - public createApiToken(apiTokenForCreationDto?: ApiTokenForCreationDto, options?: any) { - return UserApiTokenApiFp(this.configuration).createApiToken(apiTokenForCreationDto, options).then((request) => request(this.axios, this.basePath)); + public apiV2UsersOptions(options?: any) { + return UserApiFp(this.configuration).apiV2UsersOptions(options).then((request) => request(this.axios, this.basePath)); } /** * - * @param {number} [pageNumber] - * @param {number} [pageSize] + * @summary Retrieves all users. + * @param {string} searchTerm * @param {string} [orderBy] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiTokenApi - */ - public getAllApiTokens(pageNumber?: number, pageSize?: number, orderBy?: string, options?: any) { - return UserApiTokenApiFp(this.configuration).getAllApiTokens(pageNumber, pageSize, orderBy, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApiTokenApi - */ - public getApiToken(apiTokenId: string, options?: any) { - return UserApiTokenApiFp(this.configuration).getApiToken(apiTokenId, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @param {string} apiTokenId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApiTokenApi + * @memberof UserApi */ - public revokeToken(apiTokenId: string, options?: any) { - return UserApiTokenApiFp(this.configuration).revokeToken(apiTokenId, options).then((request) => request(this.axios, this.basePath)); + public getUsers(searchTerm: string, orderBy?: string, options?: any) { + return UserApiFp(this.configuration).getUsers(searchTerm, orderBy, options).then((request) => request(this.axios, this.basePath)); } } @@ -11585,6 +12466,7 @@ export const VisibilityApiAxiosParamCreator = function (configuration?: Configur return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11617,6 +12499,7 @@ export const VisibilityApiAxiosParamCreator = function (configuration?: Configur }, /** * + * @summary Retrieves all visibilities. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -11664,7 +12547,8 @@ export const VisibilityApiAxiosParamCreator = function (configuration?: Configur }, /** * - * @param {string} visibilityId + * @summary Retrieves a visibility by ID. + * @param {string} visibilityId The ID of the visibility. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11710,6 +12594,7 @@ export const VisibilityApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11719,6 +12604,7 @@ export const VisibilityApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves all visibilities. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -11731,7 +12617,8 @@ export const VisibilityApiFp = function(configuration?: Configuration) { }, /** * - * @param {string} visibilityId + * @summary Retrieves a visibility by ID. + * @param {string} visibilityId The ID of the visibility. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11751,6 +12638,7 @@ export const VisibilityApiFactory = function (configuration?: Configuration, bas return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11759,6 +12647,7 @@ export const VisibilityApiFactory = function (configuration?: Configuration, bas }, /** * + * @summary Retrieves all visibilities. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -11770,7 +12659,8 @@ export const VisibilityApiFactory = function (configuration?: Configuration, bas }, /** * - * @param {string} visibilityId + * @summary Retrieves a visibility by ID. + * @param {string} visibilityId The ID of the visibility. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11789,6 +12679,7 @@ export const VisibilityApiFactory = function (configuration?: Configuration, bas export class VisibilityApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VisibilityApi @@ -11799,6 +12690,7 @@ export class VisibilityApi extends BaseAPI { /** * + * @summary Retrieves all visibilities. * @param {number} [pageNumber] * @param {number} [pageSize] * @param {string} [orderBy] @@ -11812,7 +12704,8 @@ export class VisibilityApi extends BaseAPI { /** * - * @param {string} visibilityId + * @summary Retrieves a visibility by ID. + * @param {string} visibilityId The ID of the visibility. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VisibilityApi @@ -11831,6 +12724,7 @@ export const VocabularyApiAxiosParamCreator = function (configuration?: Configur return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11863,6 +12757,7 @@ export const VocabularyApiAxiosParamCreator = function (configuration?: Configur }, /** * + * @summary Retrieves top-level instances from vocabularies. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -11919,9 +12814,10 @@ export const VocabularyApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * - * @param {string} instance - * @param {AcceptedLanguage} [acceptLanguage] + * Could be a top-level instance, or an intermediate-level instance from a vocabulary. + * @summary Retrieves a single instance from a vocabulary. + * @param {string} instance The URI of the vocabulary instance to retrieve. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the instance data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -11961,6 +12857,7 @@ export const VocabularyApiAxiosParamCreator = function (configuration?: Configur }, /** * + * @summary Retrieves vocabulary instances. * @param {string} _class * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] @@ -12035,6 +12932,7 @@ export const VocabularyApiFp = function(configuration?: Configuration) { return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -12044,6 +12942,7 @@ export const VocabularyApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves top-level instances from vocabularies. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -12057,9 +12956,10 @@ export const VocabularyApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * - * @param {string} instance - * @param {AcceptedLanguage} [acceptLanguage] + * Could be a top-level instance, or an intermediate-level instance from a vocabulary. + * @summary Retrieves a single instance from a vocabulary. + * @param {string} instance The URI of the vocabulary instance to retrieve. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the instance data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -12069,6 +12969,7 @@ export const VocabularyApiFp = function(configuration?: Configuration) { }, /** * + * @summary Retrieves vocabulary instances. * @param {string} _class * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] @@ -12094,6 +12995,7 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas return { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -12102,6 +13004,7 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas }, /** * + * @summary Retrieves top-level instances from vocabularies. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -12114,9 +13017,10 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas return localVarFp.getVocabularies(searchTerm, language, pageNumber, pageSize, orderBy, options).then((request) => request(axios, basePath)); }, /** - * - * @param {string} instance - * @param {AcceptedLanguage} [acceptLanguage] + * Could be a top-level instance, or an intermediate-level instance from a vocabulary. + * @summary Retrieves a single instance from a vocabulary. + * @param {string} instance The URI of the vocabulary instance to retrieve. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the instance data. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -12125,6 +13029,7 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas }, /** * + * @summary Retrieves vocabulary instances. * @param {string} _class * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] @@ -12149,6 +13054,7 @@ export const VocabularyApiFactory = function (configuration?: Configuration, bas export class VocabularyApi extends BaseAPI { /** * + * @summary Responds with the HTTP methods allowed for the endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VocabularyApi @@ -12159,6 +13065,7 @@ export class VocabularyApi extends BaseAPI { /** * + * @summary Retrieves top-level instances from vocabularies. * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] * @param {number} [pageNumber] @@ -12173,9 +13080,10 @@ export class VocabularyApi extends BaseAPI { } /** - * - * @param {string} instance - * @param {AcceptedLanguage} [acceptLanguage] + * Could be a top-level instance, or an intermediate-level instance from a vocabulary. + * @summary Retrieves a single instance from a vocabulary. + * @param {string} instance The URI of the vocabulary instance to retrieve. + * @param {AcceptedLanguage} [acceptLanguage] The preferred language for the instance data. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof VocabularyApi @@ -12186,6 +13094,7 @@ export class VocabularyApi extends BaseAPI { /** * + * @summary Retrieves vocabulary instances. * @param {string} _class * @param {string} [searchTerm] * @param {AcceptedLanguage} [language] diff --git a/src/apis.ts b/src/apis.ts index dc5fbd59e4d0ebb79eabbed7d4af1ce94f82773a..a0e541f33fad8b1094a96b29416b2a13e5d06d22 100644 --- a/src/apis.ts +++ b/src/apis.ts @@ -20,20 +20,20 @@ import { ResourceApiFactory } from './Coscine.Api/api'; import { ResourceTypeApiFactory } from './Coscine.Api/api'; import { RoleApiFactory } from './Coscine.Api/api'; import { TitleApiFactory } from './Coscine.Api/api'; -import { ToSApiFactory } from './Coscine.Api/api'; +import { TosApiFactory } from './Coscine.Api/api'; import { TreeApiFactory } from './Coscine.Api/api'; import { UserApiFactory } from './Coscine.Api/api'; -import { UserApiTokenApiFactory } from './Coscine.Api/api'; +import { SelfApiFactory } from './Coscine.Api/api'; +import { SelfApiTokenApiFactory } from './Coscine.Api/api'; import { VisibilityApiFactory } from './Coscine.Api/api'; import { VocabularyApiFactory } from './Coscine.Api/api'; -import { AdminApiFactory } from './Coscine.Api.Admin/api'; import { AccountApiFactory } from './Coscine.Api.STS/api'; import { HomeApiFactory } from './Coscine.Api.STS/api'; import { MergeApiFactory } from './Coscine.Api.STS/api'; import { ORCiDApiFactory } from './Coscine.Api.STS/api'; import { ShibbolethApiFactory } from './Coscine.Api.STS/api'; -import { SearchApiFactory } from './Coscine.Api.Search/api'; +import { SearchApiFactory } from './Coscine.Api/api'; let accessToken = ''; if (typeof coscine !== 'undefined' && typeof coscine.authorization !== 'undefined') { @@ -61,7 +61,6 @@ const getHostName = () => { function implementations(axios?: AxiosInstance) { return { AccountApi: AccountApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.STS', axios), - AdminApi: AdminApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Admin', axios), BlobApi: BlobApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), DisciplineApi: DisciplineApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), HomeApi: HomeApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.STS', axios), @@ -84,11 +83,12 @@ function implementations(axios?: AxiosInstance) { ResourceApi: ResourceApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), ResourceTypeApi: ResourceTypeApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), RoleApi: RoleApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), - SearchApi: SearchApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.Search', axios), + SearchApi: SearchApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), ShibbolethApi: ShibbolethApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine/api/Coscine.Api.STS', axios), TitleApi: TitleApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), - TokenApi: UserApiTokenApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), - ToSApi: ToSApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), + SelfApiTokenApi: SelfApiTokenApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), + SelfApi: SelfApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), + TosApi: TosApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), TreeApi: TreeApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), UserApi: UserApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios), VisibilityApi: VisibilityApiFactory(new Configuration({ 'accessToken': accessToken }), 'https://' + getHostName() + '/coscine', axios) diff --git a/src/index.ts b/src/index.ts index d5fddff3799b005c75e18b8ccf5c8a2aa822383b..c6ad22e4d91fe90087de32c5295ad3bc16bc43d6 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,7 +4,6 @@ import instance from './axios-basic'; const apis = implementations(instance); export const AccountApi = apis.AccountApi; -export const AdminApi = apis.AdminApi; export const ApplicationProfileApi = apis.ApplicationProfileApi; export const BlobApi = apis.BlobApi; export const DisciplineApi = apis.DisciplineApi; @@ -29,8 +28,9 @@ export const RoleApi = apis.RoleApi; export const SearchApi = apis.SearchApi; export const ShibbolethApi = apis.ShibbolethApi; export const TitleApi = apis.TitleApi; -export const TokenApi = apis.TokenApi; -export const ToSApi = apis.ToSApi; +export const SelfApi = apis.SelfApi; +export const SelfApiTokenApi = apis.SelfApiTokenApi; +export const TosApi = apis.TosApi; export const TreeApi = apis.TreeApi; export const UserApi = apis.UserApi; export const VisibilityApi = apis.VisibilityApi; diff --git a/test/execute.test.ts b/test/execute.test.ts index 651f01708f8f055aa19533fbb93e2c10c7e06d7d..7d2492d4441258d3a8776058a83a369da4578071 100644 --- a/test/execute.test.ts +++ b/test/execute.test.ts @@ -1,7 +1,7 @@ import { MaintenanceApi } from '../src/index'; test('Test', async () => { - const maintenance = await MaintenanceApi.getCurrentMaintenance(); + const maintenance = await MaintenanceApi.getCurrentMaintenances(); console.log(maintenance.data); expect(true).toBe(true); });