Options
All
  • Public
  • Public/Protected
  • All
Menu

@coscine/api-client

Index

Variables

Const AccountApi

AccountApi: { accountGetLoginUrls: any; accountLogout: any } = ...

Type declaration

  • accountGetLoginUrls: function
    • accountGetLoginUrls(options?: any): AxiosPromise<LoginUrls>
    • summary

      Return relevant URLs for logging the user in

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<LoginUrls>

  • accountLogout: function
    • accountLogout(options?: any): AxiosPromise<any>
    • summary

      Route for logging the user out of Coscine

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<any>

Const AdminApi

AdminApi: { adminGetProject: any; adminUpdateQuota: any } = ...

Type declaration

  • adminGetProject: function
    • adminGetProject(projectString: string, options?: any): AxiosPromise<AdminProjectObject>
    • summary

      Find the project related to the projectString(GUID or slug)

      throws

      {RequiredError}

      Parameters

      • projectString: string

        The project id (GUID) or slug (from URL).

      • Optional options: any

      Returns AxiosPromise<AdminProjectObject>

  • adminUpdateQuota: function
    • adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): AxiosPromise<any>
    • summary

      Update a project maximum and allocated quota

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • resourceTypeId: string

        Id of the resource type

      • updateQuotaParameterObject: UpdateQuotaParameterObject

        JSON object for updating the project maximum and allocated quota.

      • Optional options: any

      Returns AxiosPromise<any>

Const BlobApi

BlobApi: { blobDeleteFileWithParameter: any; blobGetFileWithParameter: any; blobUploadFileWithParameter: any } = ...

Type declaration

  • blobDeleteFileWithParameter: function
    • blobDeleteFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>
    • summary

      This method deletes a given file

      throws

      {RequiredError}

      Parameters

      • resourceId: string

        Id of the resource

      • Optional path: string
      • Optional options: any

      Returns AxiosPromise<any>

  • blobGetFileWithParameter: function
    • blobGetFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>
    • summary

      This method checks if the given file exists and returns it

      throws

      {RequiredError}

      Parameters

      • resourceId: string

        Id of the resource

      • Optional path: string
      • Optional options: any

      Returns AxiosPromise<any>

  • blobUploadFileWithParameter: function
    • blobUploadFileWithParameter(resourceId: string, path?: string, files?: any[], options?: any): AxiosPromise<any>
    • summary

      This method uploads a given File

      throws

      {RequiredError}

      Parameters

      • resourceId: string

        Id of the resource

      • Optional path: string
      • Optional files: any[]
      • Optional options: any

      Returns AxiosPromise<any>

Const ContactChangeApi

ContactChangeApi: { contactChangeChangeContactEmail: any; contactChangeConfirmContactEmail: any; contactChangeConfirmationStatus: any } = ...

Type declaration

  • contactChangeChangeContactEmail: function
    • contactChangeChangeContactEmail(body: string, options?: any): AxiosPromise<ContactChangeObject>
    • summary

      This method enables the user to request a change of his or her contact email. After entering a valid email, a confirmation email will be sent to the new address and a notification email will be sent to the present address.

      throws

      {RequiredError}

      Parameters

      • body: string

        A new email as string set by the user.

      • Optional options: any

      Returns AxiosPromise<ContactChangeObject>

  • contactChangeConfirmContactEmail: function
    • contactChangeConfirmContactEmail(verification: string, options?: any): AxiosPromise<UserObject>
    • summary

      Calling this method checks whether or not the entered confirmation token (verification) exists inside the database for the current user. If yes, it updates the EmailAddress field for that user with the New Email that has been requested with the ChangeContactEmail method.

      throws

      {RequiredError}

      Parameters

      • verification: string

        The Confirmation Token as String for a New Email.

      • Optional options: any

      Returns AxiosPromise<UserObject>

  • contactChangeConfirmationStatus: function
    • contactChangeConfirmationStatus(options?: any): AxiosPromise<ContactChangeObject[]>
    • summary

      Calling this method will check if there are pending emails for confirmation for the current user.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ContactChangeObject[]>

Const DisciplineApi

DisciplineApi: { disciplineIndex: any } = ...

Type declaration

  • disciplineIndex: function
    • disciplineIndex(options?: any): AxiosPromise<DisciplineObject[]>
    • summary

      Returns all available disciplines

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<DisciplineObject[]>

Const GitLabApi

GitLabApi: { gitLabGetAllProjects: any; gitLabGetBranchesForProject: any; gitLabGetProject: any } = ...

Type declaration

  • gitLabGetAllProjects: function
    • gitLabGetAllProjects(domain?: string, accessToken?: string, options?: any): AxiosPromise<Project[]>
    • summary

      Returns all GitLab projects, that the user is a member of, based on the provided credentials.

      throws

      {RequiredError}

      Parameters

      • Optional domain: string
      • Optional accessToken: string
      • Optional options: any

      Returns AxiosPromise<Project[]>

  • gitLabGetBranchesForProject: function
    • gitLabGetBranchesForProject(projectId: number, domain?: string, accessToken?: string, options?: any): AxiosPromise<Branch[]>
    • summary

      Returns all GitLab branches of a project, that the user is a member of, based on the provided credentials.

      throws

      {RequiredError}

      Parameters

      • projectId: number

        GitLab Project Identifier

      • Optional domain: string
      • Optional accessToken: string
      • Optional options: any

      Returns AxiosPromise<Branch[]>

  • gitLabGetProject: function
    • gitLabGetProject(projectId: number, domain?: string, accessToken?: string, options?: any): AxiosPromise<Project>
    • summary

      Returns a single GitLab project, that the user is a member of, based on the provided credentials.

      throws

      {RequiredError}

      Parameters

      • projectId: number

        GitLab Project Identifier

      • Optional domain: string
      • Optional accessToken: string
      • Optional options: any

      Returns AxiosPromise<Project>

Const HomeApi

HomeApi: { homeIndex: any } = ...

Type declaration

  • homeIndex: function
    • homeIndex(options?: any): AxiosPromise<any>
    • summary

      The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<any>

Const LanguageApi

LanguageApi: { languageIndex: any } = ...

Type declaration

  • languageIndex: function
    • languageIndex(options?: any): AxiosPromise<LanguageObject[]>
    • summary

      Returns all available languages.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<LanguageObject[]>

Const LicenseApi

LicenseApi: { licenseIndex: any } = ...

Type declaration

  • licenseIndex: function
    • licenseIndex(options?: any): AxiosPromise<LicenseObject[]>
    • summary

      Returns all available licenses

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<LicenseObject[]>

Const MergeApi

MergeApi: { mergeCallback: any; mergeLogin: any } = ...

Type declaration

  • mergeCallback: function
    • mergeCallback(returnUrl?: string, options?: any): AxiosPromise<any>
    • throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

  • mergeLogin: function
    • mergeLogin(returnUrl?: string, options?: any): AxiosPromise<any>
    • throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

Const MetadataApi

MetadataApi: { metadataGetClassInstances: any; metadataGetProfile: any; metadataGetProfiles: any; metadataGetVocabularies: any; metadataGetVocabulary: any; metadataSaveApplicationProfile: any } = ...

Type declaration

  • metadataGetClassInstances: function
    • metadataGetClassInstances(className: string, options?: any): AxiosPromise<BilingualLabels>
    • summary

      This method returns instances.

      throws

      {RequiredError}

      Parameters

      • className: string

        class name

      • Optional options: any

      Returns AxiosPromise<BilingualLabels>

  • metadataGetProfile: function
    • metadataGetProfile(profile: string, options?: any): AxiosPromise<any>
    • summary

      This method returns the application profile for the given profileUrl.

      throws

      {RequiredError}

      Parameters

      • profile: string

        Url of the application profile

      • Optional options: any

      Returns AxiosPromise<any>

  • metadataGetProfiles: function
    • metadataGetProfiles(options?: any): AxiosPromise<string[]>
    • summary

      This method returns all application profiles.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<string[]>

  • metadataGetVocabularies: function
    • metadataGetVocabularies(options?: any): AxiosPromise<string[]>
    • summary

      This method returns a list of all vocabularies.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<string[]>

  • metadataGetVocabulary: function
    • metadataGetVocabulary(path: string, options?: any): AxiosPromise<BilingualLabels>
    • summary

      This method returns a specific vocabulary.

      throws

      {RequiredError}

      Parameters

      • path: string

        Url of the vocabulary

      • Optional options: any

      Returns AxiosPromise<BilingualLabels>

  • metadataSaveApplicationProfile: function
    • metadataSaveApplicationProfile(applicationProfile: ApplicationProfile, options?: any): AxiosPromise<any>
    • summary

      Create a request for storing a given application profile.

      throws

      {RequiredError}

      Parameters

      • applicationProfile: ApplicationProfile

        Object describing the application profile

      • Optional options: any

      Returns AxiosPromise<any>

Const NoticeApi

NoticeApi: { noticeGetMaintenance: any; noticeGetNotice: any } = ...

Type declaration

  • noticeGetMaintenance: function
    • noticeGetMaintenance(options?: any): AxiosPromise<MaintenanceReturnObject>
    • summary

      Returns defined properties of the first entry of the rss feed

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<MaintenanceReturnObject>

  • noticeGetNotice: function
    • noticeGetNotice(documentSlug: string, language?: string, options?: any): AxiosPromise<any>
    • summary

      Returns a notice

      deprecated
      throws

      {RequiredError}

      Parameters

      • documentSlug: string

        Slug defining a configured notice

      • Optional language: string
      • Optional options: any

      Returns AxiosPromise<any>

Const ORCiDApi

ORCiDApi: { oRCiDLoginGET: any; oRCiDLoginPOST: any } = ...

Type declaration

  • oRCiDLoginGET: function
    • oRCiDLoginGET(returnUrl?: string, options?: any): AxiosPromise<any>
    • summary

      ORCiD Login Route

      throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

  • oRCiDLoginPOST: function
    • oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): AxiosPromise<any>
    • summary

      Execute ORCiD validation and login

      throws

      {RequiredError}

      Parameters

      • Optional oRCiDJWT: string
      • Optional returnUrl: string
      • Optional options: any

      Returns AxiosPromise<any>

Const OrganizationApi

OrganizationApi: { organizationGetOrganization: any; organizationGetROR: any; organizationIndex: any; organizationIsMember: any; organizationIsMember2: any } = ...

Type declaration

  • organizationGetOrganization: function
    • organizationGetOrganization(url: string, options?: any): AxiosPromise<WrapperObject>
    • summary

      Returns a specific organization.

      throws

      {RequiredError}

      Parameters

      • url: string

        Url of the organization.

      • Optional options: any

      Returns AxiosPromise<WrapperObject>

  • organizationGetROR: function
    • organizationGetROR(filter?: string, options?: any): AxiosPromise<WrapperObject>
    • summary

      Returns all labels and urls from the ror graph.

      throws

      {RequiredError}

      Parameters

      • Optional filter: string
      • Optional options: any

      Returns AxiosPromise<WrapperObject>

  • organizationIndex: function
    • organizationIndex(member?: number, filter?: string, options?: any): AxiosPromise<WrapperObject>
    • summary

      Returns all organizations that match the provided criterea.

      throws

      {RequiredError}

      Parameters

      • Optional member: number
      • Optional filter: string
      • Optional options: any

      Returns AxiosPromise<WrapperObject>

  • organizationIsMember: function
    • organizationIsMember(url: string, options?: any): AxiosPromise<IsMemberObject>
    • summary

      Returns true if the current user is a member of the given organization.

      throws

      {RequiredError}

      Parameters

      • url: string

        Url of the organization.

      • Optional options: any

      Returns AxiosPromise<IsMemberObject>

  • organizationIsMember2: function
    • organizationIsMember2(options?: any): AxiosPromise<WrapperObject>
    • summary

      Returns a list of organizations in which the current user is a member.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<WrapperObject>

Const PidApi

PidApi: { pidIsValid: any; pidSendMailToOwner: any } = ...

Type declaration

  • pidIsValid: function
    • pidIsValid(pid: string, options?: any): AxiosPromise<any>
    • summary

      Returns a 200, if a PID is valid.

      throws

      {RequiredError}

      Parameters

      • pid: string

        PID

      • Optional options: any

      Returns AxiosPromise<any>

  • pidSendMailToOwner: function
    • pidSendMailToOwner(messageObject: MessageObject, options?: any): AxiosPromise<any>
    • summary

      Sends a request to the pid owner.

      throws

      {RequiredError}

      Parameters

      • messageObject: MessageObject

        Entry with the information for the email to the pid owner.

      • Optional options: any

      Returns AxiosPromise<any>

Const ProjectApi

ProjectApi: { projectCreateApplicationProfile: any; projectDelete: any; projectDeleteInvitation: any; projectGet: any; projectGetBySlug: any; projectGetResources: any; projectGetTopLevelProjects: any; projectIndex: any; projectListInvitations: any; projectResolveInvitation: any; projectSendInvitation: any; projectStore: any; projectUpdate: any } = ...

Type declaration

  • projectCreateApplicationProfile: function
    • projectCreateApplicationProfile(projectId: string, options?: any): AxiosPromise<any>
    • summary

      Creation of an Application Profile.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Project id of the project

      • Optional options: any

      Returns AxiosPromise<any>

  • projectDelete: function
    • projectDelete(id: string, options?: any): AxiosPromise<any>
    • summary

      Deletes a project

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<any>

  • projectDeleteInvitation: function
    • projectDeleteInvitation(invitationId: string, options?: any): AxiosPromise<any>
    • summary

      Deletes a project invitation.

      throws

      {RequiredError}

      Parameters

      • invitationId: string

        Id of an invitation

      • Optional options: any

      Returns AxiosPromise<any>

  • projectGet: function
    • projectGet(id: string, options?: any): AxiosPromise<ProjectObject>
    • summary

      This returns the project if the user has access to it

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<ProjectObject>

  • projectGetBySlug: function
    • projectGetBySlug(slug: string, options?: any): AxiosPromise<ProjectObject>
    • summary

      This returns the project if the user has access to it

      throws

      {RequiredError}

      Parameters

      • slug: string

        Slug of the project

      • Optional options: any

      Returns AxiosPromise<ProjectObject>

  • projectGetResources: function
    • projectGetResources(id: string, options?: any): AxiosPromise<ResourceObject[]>
    • summary

      Gets all resources in a project

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<ResourceObject[]>

  • projectGetTopLevelProjects: function
    • projectGetTopLevelProjects(options?: any): AxiosPromise<ProjectObject[]>
    • summary

      Retrieves all top level projects

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ProjectObject[]>

  • projectIndex: function
    • projectIndex(options?: any): AxiosPromise<ProjectObject[]>
    • summary

      Returns all available projects (including sub projects)

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ProjectObject[]>

  • projectListInvitations: function
    • projectListInvitations(projectId: string, options?: any): AxiosPromise<InvitationReturnObject[]>
    • summary

      List all invitations of a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<InvitationReturnObject[]>

  • projectResolveInvitation: function
    • projectResolveInvitation(invitationToken: string, options?: any): AxiosPromise<any>
    • summary

      Resolves a project invitation for the current user.

      throws

      {RequiredError}

      Parameters

      • invitationToken: string

        Token for a project invitation stored inside the URL under &quot;.../?invitationToken={token}&quot;

      • Optional options: any

      Returns AxiosPromise<any>

  • projectSendInvitation: function
    • projectSendInvitation(sendInvitationObject: SendInvitationObject, options?: any): AxiosPromise<any>
    • summary

      Creates and sends a project invitation to a specified email.

      throws

      {RequiredError}

      Parameters

      • sendInvitationObject: SendInvitationObject

        Informations for sending an invitation. The invitation token is stored inside the URL under &quot;.../?invitationToken={token}&quot;.

      • Optional options: any

      Returns AxiosPromise<any>

  • projectStore: function
    • projectStore(projectObject: ProjectObject, options?: any): AxiosPromise<any>
    • summary

      Creates a project

      throws

      {RequiredError}

      Parameters

      • projectObject: ProjectObject

        A Project Object

      • Optional options: any

      Returns AxiosPromise<any>

  • projectUpdate: function
    • projectUpdate(id: string, projectObject: ProjectObject, options?: any): AxiosPromise<any>
    • summary

      Updates a project

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • projectObject: ProjectObject

        A Project Object

      • Optional options: any

      Returns AxiosPromise<any>

Const ProjectQuotaApi

ProjectQuotaApi: { projectQuotaQuota: any; projectQuotaQuotas: any; projectQuotaUpdateQuota: any } = ...

Type declaration

  • projectQuotaQuota: function
    • projectQuotaQuota(id: string, resourceTypeId: string, options?: any): AxiosPromise<ProjectQuotaExtendedReturnObject>
    • summary

      Retrieves the project quota in GiB of a resource type for the selected project together with all individual resources of this resource type.

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • resourceTypeId: string

        Id of the resource type

      • Optional options: any

      Returns AxiosPromise<ProjectQuotaExtendedReturnObject>

  • projectQuotaQuotas: function
    • projectQuotaQuotas(id: string, options?: any): AxiosPromise<ProjectQuotaReturnObject[]>
    • summary

      Retrieves all project quotas in GiB grouped by resource type for the selected project.

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<ProjectQuotaReturnObject[]>

  • projectQuotaUpdateQuota: function
    • projectQuotaUpdateQuota(id: string, resourceTypeId: string, updateProjectQuotaObject: UpdateProjectQuotaObject, options?: any): AxiosPromise<any>
    • summary

      Updates the reserved project quota of a resource type for a selected poject. Quota value in GiB.

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • resourceTypeId: string

        Id of the resource type

      • updateProjectQuotaObject: UpdateProjectQuotaObject

        Object containing the update values.

      • Optional options: any

      Returns AxiosPromise<any>

Const ProjectRoleApi

ProjectRoleApi: { projectRoleDelete: any; projectRoleDelete2: any; projectRoleGet: any; projectRoleIndex: any; projectRoleSet: any } = ...

Type declaration

  • projectRoleDelete: function
    • projectRoleDelete(projectId: string, userId: string, roleId: string, options?: any): AxiosPromise<any>
    • summary

      Deletes a user from a project

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • userId: string

        Id of the user

      • roleId: string

        Id of the role

      • Optional options: any

      Returns AxiosPromise<any>

  • projectRoleDelete2: function
    • projectRoleDelete2(projectId: string, options?: any): AxiosPromise<any>
    • summary

      Deletes the current user from a project

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<any>

  • projectRoleGet: function
    • projectRoleGet(projectId: string, options?: any): AxiosPromise<ProjectRoleObject[]>
    • summary

      Gets all roles for the current user and a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<ProjectRoleObject[]>

  • projectRoleIndex: function
    • projectRoleIndex(projectId: string, options?: any): AxiosPromise<ProjectRoleObject[]>
    • summary

      Lists all users in a project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<ProjectRoleObject[]>

  • projectRoleSet: function
    • projectRoleSet(projectRoleObject: ProjectRoleObject, options?: any): AxiosPromise<ProjectRoleObject>
    • summary

      Sets a role for the current user in a project

      throws

      {RequiredError}

      Parameters

      • projectRoleObject: ProjectRoleObject
      • Optional options: any

      Returns AxiosPromise<ProjectRoleObject>

Const ResourceApi

ResourceApi: { resourceDelete: any; resourceGet: any; resourceIndex: any; resourceIsUserResourceCreator: any; resourceSetResourceReadonly: any; resourceStoreToProject: any; resourceUpdate: any } = ...

Type declaration

  • resourceDelete: function
    • resourceDelete(id: string, options?: any): AxiosPromise<any>
    • summary

      Deletes a resource.

      throws

      {RequiredError}

      Parameters

      • id: string

        A GUID as a string that identifies the resource.

      • Optional options: any

      Returns AxiosPromise<any>

  • resourceGet: function
    • resourceGet(id: string, options?: any): AxiosPromise<any>
    • summary

      Returns the resource with a specified id.

      throws

      {RequiredError}

      Parameters

      • id: string

        The resource id.

      • Optional options: any

      Returns AxiosPromise<any>

  • resourceIndex: function
    • resourceIndex(options?: any): AxiosPromise<any>
    • summary

      Returns a list of all resources the current user has access to.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<any>

  • resourceIsUserResourceCreator: function
    • resourceIsUserResourceCreator(id: string, options?: any): AxiosPromise<any>
    • summary

      Returns whether or not the current user is creator of a specified resource.

      throws

      {RequiredError}

      Parameters

      • id: string

        The resource id.

      • Optional options: any

      Returns AxiosPromise<any>

  • resourceSetResourceReadonly: function
    • resourceSetResourceReadonly(id: string, status?: boolean, options?: any): AxiosPromise<any>
    • summary

      Sets a read only status of a given resource.

      throws

      {RequiredError}

      Parameters

      • id: string

        A GUID as a string that identifies the resource.

      • Optional status: boolean
      • Optional options: any

      Returns AxiosPromise<any>

  • resourceStoreToProject: function
    • resourceStoreToProject(projectId: string, resourceObject: ResourceObject, options?: any): AxiosPromise<any>
    • summary

      Stores the provided resource object in a specified project.

      throws

      {RequiredError}

      Parameters

      • projectId: string

        A GUID as a string that identifies the resource.

      • resourceObject: ResourceObject

        Entry representing the user

      • Optional options: any

      Returns AxiosPromise<any>

  • resourceUpdate: function
    • resourceUpdate(id: string, resourceObject: ResourceObject, options?: any): AxiosPromise<any>
    • summary

      Updates a resource.

      throws

      {RequiredError}

      Parameters

      • id: string

        The resource id.

      • resourceObject: ResourceObject

        Entry representing the user

      • Optional options: any

      Returns AxiosPromise<any>

Const ResourceQuotaApi

ResourceQuotaApi: { resourceQuotaGetResourceQuota: any; resourceQuotaUpdateResourceQuota: any } = ...

Type declaration

  • resourceQuotaGetResourceQuota: function
    • resourceQuotaGetResourceQuota(id: string, options?: any): AxiosPromise<ResourceQuotaReturnObject>
    • summary

      Retrieves the resource used and reserved quota for an individual resource.

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the resource.

      • Optional options: any

      Returns AxiosPromise<ResourceQuotaReturnObject>

  • resourceQuotaUpdateResourceQuota: function
    • resourceQuotaUpdateResourceQuota(id: string, updateResourceObject: UpdateResourceObject, options?: any): AxiosPromise<any>
    • summary

      Updates the resource quota for an individual resource.

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the resource.

      • updateResourceObject: UpdateResourceObject

        Contains the resource id and the new quota.

      • Optional options: any

      Returns AxiosPromise<any>

Const ResourceTypeApi

ResourceTypeApi: { resourceTypeGetEnabledResourceTypes: any; resourceTypeGetEnabledResourceTypesAll: any; resourceTypeGetResourceType: any; resourceTypeGetResourceTypes: any } = ...

Type declaration

  • resourceTypeGetEnabledResourceTypes: function
    • resourceTypeGetEnabledResourceTypes(options?: any): AxiosPromise<ResourceTypeInformation[]>
    • summary

      Returns all enabled resource types.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformation[]>

  • resourceTypeGetEnabledResourceTypesAll: function
    • resourceTypeGetEnabledResourceTypesAll(id: string, options?: any): AxiosPromise<ResourceTypeInformation[]>
    • summary

      Returns all enabled resource types according to user's affiliation and allocated quota in the project.

      throws

      {RequiredError}

      Parameters

      • id: string

        Id of the project

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformation[]>

  • resourceTypeGetResourceType: function
    • resourceTypeGetResourceType(id: string, options?: any): AxiosPromise<ResourceTypeInformation>
    • summary

      Returns all fields of the specified resource type.

      throws

      {RequiredError}

      Parameters

      • id: string

        A GUID as a string that identifies the resource.

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformation>

  • resourceTypeGetResourceTypes: function
    • resourceTypeGetResourceTypes(options?: any): AxiosPromise<ResourceTypeInformation[]>
    • summary

      Returns all resource types. Both hidden and active, regardless of user affiliation or quota.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ResourceTypeInformation[]>

Const RoleApi

RoleApi: { roleIndex: any } = ...

Type declaration

  • roleIndex: function
    • roleIndex(options?: any): AxiosPromise<RoleObject[]>
    • summary

      Returns all available roles

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<RoleObject[]>

Const SearchApi

SearchApi: { searchSearch: any } = ...

Type declaration

  • searchSearch: function
    • searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: string[], categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): AxiosPromise<ItemSearchResult[]>
    • summary

      Search Elasticsearch

      throws

      {RequiredError}

      Parameters

      • Optional searchQuery: string
      • Optional includeUsers: boolean
      • Optional useAdvancedSyntax: boolean
      • Optional includedLanguages: string[]
      • Optional categoryFilter: CategoryFilter
      • Optional orderBy: OrderBy
      • Optional pageNumber: number
      • Optional pageSize: number
      • Optional options: any

      Returns AxiosPromise<ItemSearchResult[]>

Const ShibbolethApi

ShibbolethApi: { shibbolethCallback: any; shibbolethLogin: any } = ...

Type declaration

  • shibbolethCallback: function
    • shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): AxiosPromise<any>
    • summary

      Callback method to catch the login

      throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional remoteError: string
      • Optional options: any

      Returns AxiosPromise<any>

  • shibbolethLogin: function
    • shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): AxiosPromise<any>
    • summary

      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.

      throws

      {RequiredError}

      Parameters

      • Optional returnUrl: string
      • Optional entityId: string
      • Optional options: any

      Returns AxiosPromise<any>

Const SubProjectApi

SubProjectApi: { subProjectGet: any; subProjectGetAccessibleParent: any } = ...

Type declaration

  • subProjectGet: function
    • subProjectGet(parentId: string, options?: any): AxiosPromise<any>
    • summary

      This method gets the Id of the parent

      throws

      {RequiredError}

      Parameters

      • parentId: string

        Id of parent

      • Optional options: any

      Returns AxiosPromise<any>

  • subProjectGetAccessibleParent: function
    • subProjectGetAccessibleParent(childId: string, options?: any): AxiosPromise<any>
    • summary

      This method retrieves the accessible Parent

      deprecated
      throws

      {RequiredError}

      Parameters

      • childId: string

        Id of the child

      • Optional options: any

      Returns AxiosPromise<any>

Const TOSApi

TOSApi: { tOSAcceptCurrentTOSVersion: any; tOSAcceptedTOSVersion: any; tOSGetCurrentTOSVersion: any } = ...

Type declaration

  • tOSAcceptCurrentTOSVersion: function
    • tOSAcceptCurrentTOSVersion(options?: any): AxiosPromise<string>
    • summary

      Calling this method accepts the TOS for the current user.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<string>

  • tOSAcceptedTOSVersion: function
    • tOSAcceptedTOSVersion(options?: any): AxiosPromise<Tos>
    • summary

      Returns the TOS Versions accepted by the current user.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<Tos>

  • tOSGetCurrentTOSVersion: function
    • tOSGetCurrentTOSVersion(options?: any): AxiosPromise<string>
    • summary

      Returns the current TOS Version.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<string>

Const TitleApi

TitleApi: { titleIndex: any } = ...

Type declaration

  • titleIndex: function
    • titleIndex(options?: any): AxiosPromise<TitleObject[]>
    • summary

      Returns all available titles.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<TitleObject[]>

Const TokenApi

TokenApi: { tokenAddToken: any; tokenGetTokenValidityBounds: any; tokenGetUserToken: any; tokenGetUserTokens: any; tokenRevokeToken: any } = ...

Type declaration

  • tokenAddToken: function
    • tokenAddToken(addApiTokenParameter: AddApiTokenParameter, options?: any): AxiosPromise<CreatedApiTokenObject>
    • summary

      Add a new token for the user.

      throws

      {RequiredError}

      Parameters

      • addApiTokenParameter: AddApiTokenParameter

        Parsed from json

      • Optional options: any

      Returns AxiosPromise<CreatedApiTokenObject>

  • tokenGetTokenValidityBounds: function
    • tokenGetTokenValidityBounds(options?: any): AxiosPromise<TokenValidityObject>
    • summary

      Get the specified token minumum and maximum validity in days.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<TokenValidityObject>

  • tokenGetUserToken: function
    • tokenGetUserToken(tokenId: string, options?: any): AxiosPromise<ApiTokenObject>
    • summary

      Get the specific token values.

      throws

      {RequiredError}

      Parameters

      • tokenId: string

        User tokenId

      • Optional options: any

      Returns AxiosPromise<ApiTokenObject>

  • tokenGetUserTokens: function
    • tokenGetUserTokens(options?: any): AxiosPromise<ApiTokenObject[]>
    • summary

      List all tokens of the current user.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<ApiTokenObject[]>

  • tokenRevokeToken: function
    • tokenRevokeToken(tokenId: string, options?: any): AxiosPromise<any>
    • summary

      Revoke a specific token.

      throws

      {RequiredError}

      Parameters

      • tokenId: string

        User tokenId

      • Optional options: any

      Returns AxiosPromise<any>

Const TreeApi

TreeApi: { treeGetMetadataWithParameter: any; treeStoreMetadataForFileWithParameter: any } = ...

Type declaration

  • treeGetMetadataWithParameter: function
    • treeGetMetadataWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): AxiosPromise<any>
    • summary

      This method retrieves the metadata

      throws

      {RequiredError}

      Parameters

      • resourceId: string

        Id of a resource

      • Optional path: string
      • Optional mimeType: string
      • Optional options: any

      Returns AxiosPromise<any>

  • treeStoreMetadataForFileWithParameter: function
    • treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): AxiosPromise<any>
    • summary

      This method stores the metadata of the file

      throws

      {RequiredError}

      Parameters

      • resourceId: string

        Id of the resource

      • Optional path: string
      • Optional mimeType: string
      • Optional options: any

      Returns AxiosPromise<any>

Const UserApi

UserApi: { userGetUser: any; userQuery: any; userSetAndReturnMergeToken: any; userUpdateUser: any } = ...

Type declaration

  • userGetUser: function
    • userGetUser(options?: any): AxiosPromise<UserObject>
    • summary

      Retrieves the UserObject.

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<UserObject>

  • userQuery: function
    • userQuery(queryString: string, projectId: string, options?: any): AxiosPromise<UserObject[]>
    • summary

      This method lets someone query the user database using a query string.

      throws

      {RequiredError}

      Parameters

      • queryString: string

        Search String

      • projectId: string

        Project from which the search is triggered

      • Optional options: any

      Returns AxiosPromise<UserObject[]>

  • userSetAndReturnMergeToken: function
    • userSetAndReturnMergeToken(provider: string, options?: any): AxiosPromise<string>
    • summary

      Sets and returns a merge token.

      throws

      {RequiredError}

      Parameters

      • provider: string

        Specifies the provider from which a user should be merged from

      • Optional options: any

      Returns AxiosPromise<string>

  • userUpdateUser: function
    • userUpdateUser(userObject: UserObject, options?: any): AxiosPromise<number>
    • summary

      Updates the User.

      throws

      {RequiredError}

      Parameters

      • userObject: UserObject

        Entry representing the user

      • Optional options: any

      Returns AxiosPromise<number>

Const VisibilityApi

VisibilityApi: { visibilityIndex: any } = ...

Type declaration

  • visibilityIndex: function
    • visibilityIndex(options?: any): AxiosPromise<VisibilityObject[]>
    • summary

      Returns all available visibilities

      throws

      {RequiredError}

      Parameters

      • Optional options: any

      Returns AxiosPromise<VisibilityObject[]>

Const default

default: { AccountApi: { accountGetLoginUrls: any; accountLogout: any }; AdminApi: { adminGetProject: any; adminUpdateQuota: any }; BlobApi: { blobDeleteFileWithParameter: any; blobGetFileWithParameter: any; blobUploadFileWithParameter: any }; ContactChangeApi: { contactChangeChangeContactEmail: any; contactChangeConfirmContactEmail: any; contactChangeConfirmationStatus: any }; DisciplineApi: { disciplineIndex: any }; GitLabApi: { gitLabGetAllProjects: any; gitLabGetBranchesForProject: any; gitLabGetProject: any }; HomeApi: { homeIndex: any }; LanguageApi: { languageIndex: any }; LicenseApi: { licenseIndex: any }; MergeApi: { mergeCallback: any; mergeLogin: any }; MetadataApi: { metadataGetClassInstances: any; metadataGetProfile: any; metadataGetProfiles: any; metadataGetVocabularies: any; metadataGetVocabulary: any; metadataSaveApplicationProfile: any }; NoticeApi: { noticeGetMaintenance: any; noticeGetNotice: any }; ORCiDApi: { oRCiDLoginGET: any; oRCiDLoginPOST: any }; OrganizationApi: { organizationGetOrganization: any; organizationGetROR: any; organizationIndex: any; organizationIsMember: any; organizationIsMember2: any }; PidApi: { pidIsValid: any; pidSendMailToOwner: any }; ProjectApi: { projectCreateApplicationProfile: any; projectDelete: any; projectDeleteInvitation: any; projectGet: any; projectGetBySlug: any; projectGetResources: any; projectGetTopLevelProjects: any; projectIndex: any; projectListInvitations: any; projectResolveInvitation: any; projectSendInvitation: any; projectStore: any; projectUpdate: any }; ProjectQuotaApi: { projectQuotaQuota: any; projectQuotaQuotas: any; projectQuotaUpdateQuota: any }; ProjectRoleApi: { projectRoleDelete: any; projectRoleDelete2: any; projectRoleGet: any; projectRoleIndex: any; projectRoleSet: any }; ResourceApi: { resourceDelete: any; resourceGet: any; resourceIndex: any; resourceIsUserResourceCreator: any; resourceSetResourceReadonly: any; resourceStoreToProject: any; resourceUpdate: any }; ResourceQuotaApi: { resourceQuotaGetResourceQuota: any; resourceQuotaUpdateResourceQuota: any }; ResourceTypeApi: { resourceTypeGetEnabledResourceTypes: any; resourceTypeGetEnabledResourceTypesAll: any; resourceTypeGetResourceType: any; resourceTypeGetResourceTypes: any }; RoleApi: { roleIndex: any }; SearchApi: { searchSearch: any }; ShibbolethApi: { shibbolethCallback: any; shibbolethLogin: any }; SubProjectApi: { subProjectGet: any; subProjectGetAccessibleParent: any }; TOSApi: { tOSAcceptCurrentTOSVersion: any; tOSAcceptedTOSVersion: any; tOSGetCurrentTOSVersion: any }; TitleApi: { titleIndex: any }; TokenApi: { tokenAddToken: any; tokenGetTokenValidityBounds: any; tokenGetUserToken: any; tokenGetUserTokens: any; tokenRevokeToken: any }; TreeApi: { treeGetMetadataWithParameter: any; treeStoreMetadataForFileWithParameter: any }; UserApi: { userGetUser: any; userQuery: any; userSetAndReturnMergeToken: any; userUpdateUser: any }; VisibilityApi: { visibilityIndex: any } } = ...

Type declaration

  • AccountApi: { accountGetLoginUrls: any; accountLogout: any }
    • accountGetLoginUrls: function
      • accountGetLoginUrls(options?: any): AxiosPromise<LoginUrls>
      • summary

        Return relevant URLs for logging the user in

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<LoginUrls>

    • accountLogout: function
      • accountLogout(options?: any): AxiosPromise<any>
      • summary

        Route for logging the user out of Coscine

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<any>

  • AdminApi: { adminGetProject: any; adminUpdateQuota: any }
    • adminGetProject: function
      • adminGetProject(projectString: string, options?: any): AxiosPromise<AdminProjectObject>
      • summary

        Find the project related to the projectString(GUID or slug)

        throws

        {RequiredError}

        Parameters

        • projectString: string

          The project id (GUID) or slug (from URL).

        • Optional options: any

        Returns AxiosPromise<AdminProjectObject>

    • adminUpdateQuota: function
      • adminUpdateQuota(projectId: string, resourceTypeId: string, updateQuotaParameterObject: UpdateQuotaParameterObject, options?: any): AxiosPromise<any>
      • summary

        Update a project maximum and allocated quota

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • resourceTypeId: string

          Id of the resource type

        • updateQuotaParameterObject: UpdateQuotaParameterObject

          JSON object for updating the project maximum and allocated quota.

        • Optional options: any

        Returns AxiosPromise<any>

  • BlobApi: { blobDeleteFileWithParameter: any; blobGetFileWithParameter: any; blobUploadFileWithParameter: any }
    • blobDeleteFileWithParameter: function
      • blobDeleteFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>
      • summary

        This method deletes a given file

        throws

        {RequiredError}

        Parameters

        • resourceId: string

          Id of the resource

        • Optional path: string
        • Optional options: any

        Returns AxiosPromise<any>

    • blobGetFileWithParameter: function
      • blobGetFileWithParameter(resourceId: string, path?: string, options?: any): AxiosPromise<any>
      • summary

        This method checks if the given file exists and returns it

        throws

        {RequiredError}

        Parameters

        • resourceId: string

          Id of the resource

        • Optional path: string
        • Optional options: any

        Returns AxiosPromise<any>

    • blobUploadFileWithParameter: function
      • blobUploadFileWithParameter(resourceId: string, path?: string, files?: any[], options?: any): AxiosPromise<any>
      • summary

        This method uploads a given File

        throws

        {RequiredError}

        Parameters

        • resourceId: string

          Id of the resource

        • Optional path: string
        • Optional files: any[]
        • Optional options: any

        Returns AxiosPromise<any>

  • ContactChangeApi: { contactChangeChangeContactEmail: any; contactChangeConfirmContactEmail: any; contactChangeConfirmationStatus: any }
    • contactChangeChangeContactEmail: function
      • contactChangeChangeContactEmail(body: string, options?: any): AxiosPromise<ContactChangeObject>
      • summary

        This method enables the user to request a change of his or her contact email. After entering a valid email, a confirmation email will be sent to the new address and a notification email will be sent to the present address.

        throws

        {RequiredError}

        Parameters

        • body: string

          A new email as string set by the user.

        • Optional options: any

        Returns AxiosPromise<ContactChangeObject>

    • contactChangeConfirmContactEmail: function
      • contactChangeConfirmContactEmail(verification: string, options?: any): AxiosPromise<UserObject>
      • summary

        Calling this method checks whether or not the entered confirmation token (verification) exists inside the database for the current user. If yes, it updates the EmailAddress field for that user with the New Email that has been requested with the ChangeContactEmail method.

        throws

        {RequiredError}

        Parameters

        • verification: string

          The Confirmation Token as String for a New Email.

        • Optional options: any

        Returns AxiosPromise<UserObject>

    • contactChangeConfirmationStatus: function
      • contactChangeConfirmationStatus(options?: any): AxiosPromise<ContactChangeObject[]>
      • summary

        Calling this method will check if there are pending emails for confirmation for the current user.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ContactChangeObject[]>

  • DisciplineApi: { disciplineIndex: any }
    • disciplineIndex: function
      • disciplineIndex(options?: any): AxiosPromise<DisciplineObject[]>
      • summary

        Returns all available disciplines

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<DisciplineObject[]>

  • GitLabApi: { gitLabGetAllProjects: any; gitLabGetBranchesForProject: any; gitLabGetProject: any }
    • gitLabGetAllProjects: function
      • gitLabGetAllProjects(domain?: string, accessToken?: string, options?: any): AxiosPromise<Project[]>
      • summary

        Returns all GitLab projects, that the user is a member of, based on the provided credentials.

        throws

        {RequiredError}

        Parameters

        • Optional domain: string
        • Optional accessToken: string
        • Optional options: any

        Returns AxiosPromise<Project[]>

    • gitLabGetBranchesForProject: function
      • gitLabGetBranchesForProject(projectId: number, domain?: string, accessToken?: string, options?: any): AxiosPromise<Branch[]>
      • summary

        Returns all GitLab branches of a project, that the user is a member of, based on the provided credentials.

        throws

        {RequiredError}

        Parameters

        • projectId: number

          GitLab Project Identifier

        • Optional domain: string
        • Optional accessToken: string
        • Optional options: any

        Returns AxiosPromise<Branch[]>

    • gitLabGetProject: function
      • gitLabGetProject(projectId: number, domain?: string, accessToken?: string, options?: any): AxiosPromise<Project>
      • summary

        Returns a single GitLab project, that the user is a member of, based on the provided credentials.

        throws

        {RequiredError}

        Parameters

        • projectId: number

          GitLab Project Identifier

        • Optional domain: string
        • Optional accessToken: string
        • Optional options: any

        Returns AxiosPromise<Project>

  • HomeApi: { homeIndex: any }
    • homeIndex: function
      • homeIndex(options?: any): AxiosPromise<any>
      • summary

        The controller that the user is automatically entering when accesing the route .../coscine/api/Coscine.STS/

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<any>

  • LanguageApi: { languageIndex: any }
    • languageIndex: function
      • languageIndex(options?: any): AxiosPromise<LanguageObject[]>
      • summary

        Returns all available languages.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<LanguageObject[]>

  • LicenseApi: { licenseIndex: any }
    • licenseIndex: function
      • licenseIndex(options?: any): AxiosPromise<LicenseObject[]>
      • summary

        Returns all available licenses

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<LicenseObject[]>

  • MergeApi: { mergeCallback: any; mergeLogin: any }
    • mergeCallback: function
      • mergeCallback(returnUrl?: string, options?: any): AxiosPromise<any>
      • throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

    • mergeLogin: function
      • mergeLogin(returnUrl?: string, options?: any): AxiosPromise<any>
      • throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

  • MetadataApi: { metadataGetClassInstances: any; metadataGetProfile: any; metadataGetProfiles: any; metadataGetVocabularies: any; metadataGetVocabulary: any; metadataSaveApplicationProfile: any }
    • metadataGetClassInstances: function
      • metadataGetClassInstances(className: string, options?: any): AxiosPromise<BilingualLabels>
      • summary

        This method returns instances.

        throws

        {RequiredError}

        Parameters

        • className: string

          class name

        • Optional options: any

        Returns AxiosPromise<BilingualLabels>

    • metadataGetProfile: function
      • metadataGetProfile(profile: string, options?: any): AxiosPromise<any>
      • summary

        This method returns the application profile for the given profileUrl.

        throws

        {RequiredError}

        Parameters

        • profile: string

          Url of the application profile

        • Optional options: any

        Returns AxiosPromise<any>

    • metadataGetProfiles: function
      • metadataGetProfiles(options?: any): AxiosPromise<string[]>
      • summary

        This method returns all application profiles.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<string[]>

    • metadataGetVocabularies: function
      • metadataGetVocabularies(options?: any): AxiosPromise<string[]>
      • summary

        This method returns a list of all vocabularies.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<string[]>

    • metadataGetVocabulary: function
      • metadataGetVocabulary(path: string, options?: any): AxiosPromise<BilingualLabels>
      • summary

        This method returns a specific vocabulary.

        throws

        {RequiredError}

        Parameters

        • path: string

          Url of the vocabulary

        • Optional options: any

        Returns AxiosPromise<BilingualLabels>

    • metadataSaveApplicationProfile: function
      • metadataSaveApplicationProfile(applicationProfile: ApplicationProfile, options?: any): AxiosPromise<any>
      • summary

        Create a request for storing a given application profile.

        throws

        {RequiredError}

        Parameters

        • applicationProfile: ApplicationProfile

          Object describing the application profile

        • Optional options: any

        Returns AxiosPromise<any>

  • NoticeApi: { noticeGetMaintenance: any; noticeGetNotice: any }
    • noticeGetMaintenance: function
      • noticeGetMaintenance(options?: any): AxiosPromise<MaintenanceReturnObject>
      • summary

        Returns defined properties of the first entry of the rss feed

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<MaintenanceReturnObject>

    • noticeGetNotice: function
      • noticeGetNotice(documentSlug: string, language?: string, options?: any): AxiosPromise<any>
      • summary

        Returns a notice

        deprecated
        throws

        {RequiredError}

        Parameters

        • documentSlug: string

          Slug defining a configured notice

        • Optional language: string
        • Optional options: any

        Returns AxiosPromise<any>

  • ORCiDApi: { oRCiDLoginGET: any; oRCiDLoginPOST: any }
    • oRCiDLoginGET: function
      • oRCiDLoginGET(returnUrl?: string, options?: any): AxiosPromise<any>
      • summary

        ORCiD Login Route

        throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

    • oRCiDLoginPOST: function
      • oRCiDLoginPOST(oRCiDJWT?: string, returnUrl?: string, options?: any): AxiosPromise<any>
      • summary

        Execute ORCiD validation and login

        throws

        {RequiredError}

        Parameters

        • Optional oRCiDJWT: string
        • Optional returnUrl: string
        • Optional options: any

        Returns AxiosPromise<any>

  • OrganizationApi: { organizationGetOrganization: any; organizationGetROR: any; organizationIndex: any; organizationIsMember: any; organizationIsMember2: any }
    • organizationGetOrganization: function
      • organizationGetOrganization(url: string, options?: any): AxiosPromise<WrapperObject>
      • summary

        Returns a specific organization.

        throws

        {RequiredError}

        Parameters

        • url: string

          Url of the organization.

        • Optional options: any

        Returns AxiosPromise<WrapperObject>

    • organizationGetROR: function
      • organizationGetROR(filter?: string, options?: any): AxiosPromise<WrapperObject>
      • summary

        Returns all labels and urls from the ror graph.

        throws

        {RequiredError}

        Parameters

        • Optional filter: string
        • Optional options: any

        Returns AxiosPromise<WrapperObject>

    • organizationIndex: function
      • organizationIndex(member?: number, filter?: string, options?: any): AxiosPromise<WrapperObject>
      • summary

        Returns all organizations that match the provided criterea.

        throws

        {RequiredError}

        Parameters

        • Optional member: number
        • Optional filter: string
        • Optional options: any

        Returns AxiosPromise<WrapperObject>

    • organizationIsMember: function
      • organizationIsMember(url: string, options?: any): AxiosPromise<IsMemberObject>
      • summary

        Returns true if the current user is a member of the given organization.

        throws

        {RequiredError}

        Parameters

        • url: string

          Url of the organization.

        • Optional options: any

        Returns AxiosPromise<IsMemberObject>

    • organizationIsMember2: function
      • organizationIsMember2(options?: any): AxiosPromise<WrapperObject>
      • summary

        Returns a list of organizations in which the current user is a member.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<WrapperObject>

  • PidApi: { pidIsValid: any; pidSendMailToOwner: any }
    • pidIsValid: function
      • pidIsValid(pid: string, options?: any): AxiosPromise<any>
      • summary

        Returns a 200, if a PID is valid.

        throws

        {RequiredError}

        Parameters

        • pid: string

          PID

        • Optional options: any

        Returns AxiosPromise<any>

    • pidSendMailToOwner: function
      • pidSendMailToOwner(messageObject: MessageObject, options?: any): AxiosPromise<any>
      • summary

        Sends a request to the pid owner.

        throws

        {RequiredError}

        Parameters

        • messageObject: MessageObject

          Entry with the information for the email to the pid owner.

        • Optional options: any

        Returns AxiosPromise<any>

  • ProjectApi: { projectCreateApplicationProfile: any; projectDelete: any; projectDeleteInvitation: any; projectGet: any; projectGetBySlug: any; projectGetResources: any; projectGetTopLevelProjects: any; projectIndex: any; projectListInvitations: any; projectResolveInvitation: any; projectSendInvitation: any; projectStore: any; projectUpdate: any }
    • projectCreateApplicationProfile: function
      • projectCreateApplicationProfile(projectId: string, options?: any): AxiosPromise<any>
      • summary

        Creation of an Application Profile.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Project id of the project

        • Optional options: any

        Returns AxiosPromise<any>

    • projectDelete: function
      • projectDelete(id: string, options?: any): AxiosPromise<any>
      • summary

        Deletes a project

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<any>

    • projectDeleteInvitation: function
      • projectDeleteInvitation(invitationId: string, options?: any): AxiosPromise<any>
      • summary

        Deletes a project invitation.

        throws

        {RequiredError}

        Parameters

        • invitationId: string

          Id of an invitation

        • Optional options: any

        Returns AxiosPromise<any>

    • projectGet: function
      • projectGet(id: string, options?: any): AxiosPromise<ProjectObject>
      • summary

        This returns the project if the user has access to it

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<ProjectObject>

    • projectGetBySlug: function
      • projectGetBySlug(slug: string, options?: any): AxiosPromise<ProjectObject>
      • summary

        This returns the project if the user has access to it

        throws

        {RequiredError}

        Parameters

        • slug: string

          Slug of the project

        • Optional options: any

        Returns AxiosPromise<ProjectObject>

    • projectGetResources: function
      • projectGetResources(id: string, options?: any): AxiosPromise<ResourceObject[]>
      • summary

        Gets all resources in a project

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<ResourceObject[]>

    • projectGetTopLevelProjects: function
      • projectGetTopLevelProjects(options?: any): AxiosPromise<ProjectObject[]>
      • summary

        Retrieves all top level projects

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ProjectObject[]>

    • projectIndex: function
      • projectIndex(options?: any): AxiosPromise<ProjectObject[]>
      • summary

        Returns all available projects (including sub projects)

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ProjectObject[]>

    • projectListInvitations: function
      • projectListInvitations(projectId: string, options?: any): AxiosPromise<InvitationReturnObject[]>
      • summary

        List all invitations of a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<InvitationReturnObject[]>

    • projectResolveInvitation: function
      • projectResolveInvitation(invitationToken: string, options?: any): AxiosPromise<any>
      • summary

        Resolves a project invitation for the current user.

        throws

        {RequiredError}

        Parameters

        • invitationToken: string

          Token for a project invitation stored inside the URL under &quot;.../?invitationToken={token}&quot;

        • Optional options: any

        Returns AxiosPromise<any>

    • projectSendInvitation: function
      • projectSendInvitation(sendInvitationObject: SendInvitationObject, options?: any): AxiosPromise<any>
      • summary

        Creates and sends a project invitation to a specified email.

        throws

        {RequiredError}

        Parameters

        • sendInvitationObject: SendInvitationObject

          Informations for sending an invitation. The invitation token is stored inside the URL under &quot;.../?invitationToken={token}&quot;.

        • Optional options: any

        Returns AxiosPromise<any>

    • projectStore: function
      • projectStore(projectObject: ProjectObject, options?: any): AxiosPromise<any>
      • summary

        Creates a project

        throws

        {RequiredError}

        Parameters

        • projectObject: ProjectObject

          A Project Object

        • Optional options: any

        Returns AxiosPromise<any>

    • projectUpdate: function
      • projectUpdate(id: string, projectObject: ProjectObject, options?: any): AxiosPromise<any>
      • summary

        Updates a project

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • projectObject: ProjectObject

          A Project Object

        • Optional options: any

        Returns AxiosPromise<any>

  • ProjectQuotaApi: { projectQuotaQuota: any; projectQuotaQuotas: any; projectQuotaUpdateQuota: any }
    • projectQuotaQuota: function
      • projectQuotaQuota(id: string, resourceTypeId: string, options?: any): AxiosPromise<ProjectQuotaExtendedReturnObject>
      • summary

        Retrieves the project quota in GiB of a resource type for the selected project together with all individual resources of this resource type.

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • resourceTypeId: string

          Id of the resource type

        • Optional options: any

        Returns AxiosPromise<ProjectQuotaExtendedReturnObject>

    • projectQuotaQuotas: function
      • projectQuotaQuotas(id: string, options?: any): AxiosPromise<ProjectQuotaReturnObject[]>
      • summary

        Retrieves all project quotas in GiB grouped by resource type for the selected project.

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<ProjectQuotaReturnObject[]>

    • projectQuotaUpdateQuota: function
      • projectQuotaUpdateQuota(id: string, resourceTypeId: string, updateProjectQuotaObject: UpdateProjectQuotaObject, options?: any): AxiosPromise<any>
      • summary

        Updates the reserved project quota of a resource type for a selected poject. Quota value in GiB.

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • resourceTypeId: string

          Id of the resource type

        • updateProjectQuotaObject: UpdateProjectQuotaObject

          Object containing the update values.

        • Optional options: any

        Returns AxiosPromise<any>

  • ProjectRoleApi: { projectRoleDelete: any; projectRoleDelete2: any; projectRoleGet: any; projectRoleIndex: any; projectRoleSet: any }
    • projectRoleDelete: function
      • projectRoleDelete(projectId: string, userId: string, roleId: string, options?: any): AxiosPromise<any>
      • summary

        Deletes a user from a project

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • userId: string

          Id of the user

        • roleId: string

          Id of the role

        • Optional options: any

        Returns AxiosPromise<any>

    • projectRoleDelete2: function
      • projectRoleDelete2(projectId: string, options?: any): AxiosPromise<any>
      • summary

        Deletes the current user from a project

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<any>

    • projectRoleGet: function
      • projectRoleGet(projectId: string, options?: any): AxiosPromise<ProjectRoleObject[]>
      • summary

        Gets all roles for the current user and a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<ProjectRoleObject[]>

    • projectRoleIndex: function
      • projectRoleIndex(projectId: string, options?: any): AxiosPromise<ProjectRoleObject[]>
      • summary

        Lists all users in a project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<ProjectRoleObject[]>

    • projectRoleSet: function
      • projectRoleSet(projectRoleObject: ProjectRoleObject, options?: any): AxiosPromise<ProjectRoleObject>
      • summary

        Sets a role for the current user in a project

        throws

        {RequiredError}

        Parameters

        • projectRoleObject: ProjectRoleObject
        • Optional options: any

        Returns AxiosPromise<ProjectRoleObject>

  • ResourceApi: { resourceDelete: any; resourceGet: any; resourceIndex: any; resourceIsUserResourceCreator: any; resourceSetResourceReadonly: any; resourceStoreToProject: any; resourceUpdate: any }
    • resourceDelete: function
      • resourceDelete(id: string, options?: any): AxiosPromise<any>
      • summary

        Deletes a resource.

        throws

        {RequiredError}

        Parameters

        • id: string

          A GUID as a string that identifies the resource.

        • Optional options: any

        Returns AxiosPromise<any>

    • resourceGet: function
      • resourceGet(id: string, options?: any): AxiosPromise<any>
      • summary

        Returns the resource with a specified id.

        throws

        {RequiredError}

        Parameters

        • id: string

          The resource id.

        • Optional options: any

        Returns AxiosPromise<any>

    • resourceIndex: function
      • resourceIndex(options?: any): AxiosPromise<any>
      • summary

        Returns a list of all resources the current user has access to.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<any>

    • resourceIsUserResourceCreator: function
      • resourceIsUserResourceCreator(id: string, options?: any): AxiosPromise<any>
      • summary

        Returns whether or not the current user is creator of a specified resource.

        throws

        {RequiredError}

        Parameters

        • id: string

          The resource id.

        • Optional options: any

        Returns AxiosPromise<any>

    • resourceSetResourceReadonly: function
      • resourceSetResourceReadonly(id: string, status?: boolean, options?: any): AxiosPromise<any>
      • summary

        Sets a read only status of a given resource.

        throws

        {RequiredError}

        Parameters

        • id: string

          A GUID as a string that identifies the resource.

        • Optional status: boolean
        • Optional options: any

        Returns AxiosPromise<any>

    • resourceStoreToProject: function
      • resourceStoreToProject(projectId: string, resourceObject: ResourceObject, options?: any): AxiosPromise<any>
      • summary

        Stores the provided resource object in a specified project.

        throws

        {RequiredError}

        Parameters

        • projectId: string

          A GUID as a string that identifies the resource.

        • resourceObject: ResourceObject

          Entry representing the user

        • Optional options: any

        Returns AxiosPromise<any>

    • resourceUpdate: function
      • resourceUpdate(id: string, resourceObject: ResourceObject, options?: any): AxiosPromise<any>
      • summary

        Updates a resource.

        throws

        {RequiredError}

        Parameters

        • id: string

          The resource id.

        • resourceObject: ResourceObject

          Entry representing the user

        • Optional options: any

        Returns AxiosPromise<any>

  • ResourceQuotaApi: { resourceQuotaGetResourceQuota: any; resourceQuotaUpdateResourceQuota: any }
    • resourceQuotaGetResourceQuota: function
      • resourceQuotaGetResourceQuota(id: string, options?: any): AxiosPromise<ResourceQuotaReturnObject>
      • summary

        Retrieves the resource used and reserved quota for an individual resource.

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the resource.

        • Optional options: any

        Returns AxiosPromise<ResourceQuotaReturnObject>

    • resourceQuotaUpdateResourceQuota: function
      • resourceQuotaUpdateResourceQuota(id: string, updateResourceObject: UpdateResourceObject, options?: any): AxiosPromise<any>
      • summary

        Updates the resource quota for an individual resource.

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the resource.

        • updateResourceObject: UpdateResourceObject

          Contains the resource id and the new quota.

        • Optional options: any

        Returns AxiosPromise<any>

  • ResourceTypeApi: { resourceTypeGetEnabledResourceTypes: any; resourceTypeGetEnabledResourceTypesAll: any; resourceTypeGetResourceType: any; resourceTypeGetResourceTypes: any }
    • resourceTypeGetEnabledResourceTypes: function
      • resourceTypeGetEnabledResourceTypes(options?: any): AxiosPromise<ResourceTypeInformation[]>
      • summary

        Returns all enabled resource types.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformation[]>

    • resourceTypeGetEnabledResourceTypesAll: function
      • resourceTypeGetEnabledResourceTypesAll(id: string, options?: any): AxiosPromise<ResourceTypeInformation[]>
      • summary

        Returns all enabled resource types according to user's affiliation and allocated quota in the project.

        throws

        {RequiredError}

        Parameters

        • id: string

          Id of the project

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformation[]>

    • resourceTypeGetResourceType: function
      • resourceTypeGetResourceType(id: string, options?: any): AxiosPromise<ResourceTypeInformation>
      • summary

        Returns all fields of the specified resource type.

        throws

        {RequiredError}

        Parameters

        • id: string

          A GUID as a string that identifies the resource.

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformation>

    • resourceTypeGetResourceTypes: function
      • resourceTypeGetResourceTypes(options?: any): AxiosPromise<ResourceTypeInformation[]>
      • summary

        Returns all resource types. Both hidden and active, regardless of user affiliation or quota.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ResourceTypeInformation[]>

  • RoleApi: { roleIndex: any }
    • roleIndex: function
      • roleIndex(options?: any): AxiosPromise<RoleObject[]>
      • summary

        Returns all available roles

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<RoleObject[]>

  • SearchApi: { searchSearch: any }
    • searchSearch: function
      • searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: string[], categoryFilter?: CategoryFilter, orderBy?: OrderBy, pageNumber?: number, pageSize?: number, options?: any): AxiosPromise<ItemSearchResult[]>
      • summary

        Search Elasticsearch

        throws

        {RequiredError}

        Parameters

        • Optional searchQuery: string
        • Optional includeUsers: boolean
        • Optional useAdvancedSyntax: boolean
        • Optional includedLanguages: string[]
        • Optional categoryFilter: CategoryFilter
        • Optional orderBy: OrderBy
        • Optional pageNumber: number
        • Optional pageSize: number
        • Optional options: any

        Returns AxiosPromise<ItemSearchResult[]>

  • ShibbolethApi: { shibbolethCallback: any; shibbolethLogin: any }
    • shibbolethCallback: function
      • shibbolethCallback(returnUrl?: string, remoteError?: string, options?: any): AxiosPromise<any>
      • summary

        Callback method to catch the login

        throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional remoteError: string
        • Optional options: any

        Returns AxiosPromise<any>

    • shibbolethLogin: function
      • shibbolethLogin(returnUrl?: string, entityId?: string, options?: any): AxiosPromise<any>
      • summary

        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.

        throws

        {RequiredError}

        Parameters

        • Optional returnUrl: string
        • Optional entityId: string
        • Optional options: any

        Returns AxiosPromise<any>

  • SubProjectApi: { subProjectGet: any; subProjectGetAccessibleParent: any }
    • subProjectGet: function
      • subProjectGet(parentId: string, options?: any): AxiosPromise<any>
      • summary

        This method gets the Id of the parent

        throws

        {RequiredError}

        Parameters

        • parentId: string

          Id of parent

        • Optional options: any

        Returns AxiosPromise<any>

    • subProjectGetAccessibleParent: function
      • subProjectGetAccessibleParent(childId: string, options?: any): AxiosPromise<any>
      • summary

        This method retrieves the accessible Parent

        deprecated
        throws

        {RequiredError}

        Parameters

        • childId: string

          Id of the child

        • Optional options: any

        Returns AxiosPromise<any>

  • TOSApi: { tOSAcceptCurrentTOSVersion: any; tOSAcceptedTOSVersion: any; tOSGetCurrentTOSVersion: any }
    • tOSAcceptCurrentTOSVersion: function
      • tOSAcceptCurrentTOSVersion(options?: any): AxiosPromise<string>
      • summary

        Calling this method accepts the TOS for the current user.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<string>

    • tOSAcceptedTOSVersion: function
      • tOSAcceptedTOSVersion(options?: any): AxiosPromise<Tos>
      • summary

        Returns the TOS Versions accepted by the current user.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<Tos>

    • tOSGetCurrentTOSVersion: function
      • tOSGetCurrentTOSVersion(options?: any): AxiosPromise<string>
      • summary

        Returns the current TOS Version.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<string>

  • TitleApi: { titleIndex: any }
    • titleIndex: function
      • titleIndex(options?: any): AxiosPromise<TitleObject[]>
      • summary

        Returns all available titles.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<TitleObject[]>

  • TokenApi: { tokenAddToken: any; tokenGetTokenValidityBounds: any; tokenGetUserToken: any; tokenGetUserTokens: any; tokenRevokeToken: any }
    • tokenAddToken: function
      • tokenAddToken(addApiTokenParameter: AddApiTokenParameter, options?: any): AxiosPromise<CreatedApiTokenObject>
      • summary

        Add a new token for the user.

        throws

        {RequiredError}

        Parameters

        • addApiTokenParameter: AddApiTokenParameter

          Parsed from json

        • Optional options: any

        Returns AxiosPromise<CreatedApiTokenObject>

    • tokenGetTokenValidityBounds: function
      • tokenGetTokenValidityBounds(options?: any): AxiosPromise<TokenValidityObject>
      • summary

        Get the specified token minumum and maximum validity in days.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<TokenValidityObject>

    • tokenGetUserToken: function
      • tokenGetUserToken(tokenId: string, options?: any): AxiosPromise<ApiTokenObject>
      • summary

        Get the specific token values.

        throws

        {RequiredError}

        Parameters

        • tokenId: string

          User tokenId

        • Optional options: any

        Returns AxiosPromise<ApiTokenObject>

    • tokenGetUserTokens: function
      • tokenGetUserTokens(options?: any): AxiosPromise<ApiTokenObject[]>
      • summary

        List all tokens of the current user.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<ApiTokenObject[]>

    • tokenRevokeToken: function
      • tokenRevokeToken(tokenId: string, options?: any): AxiosPromise<any>
      • summary

        Revoke a specific token.

        throws

        {RequiredError}

        Parameters

        • tokenId: string

          User tokenId

        • Optional options: any

        Returns AxiosPromise<any>

  • TreeApi: { treeGetMetadataWithParameter: any; treeStoreMetadataForFileWithParameter: any }
    • treeGetMetadataWithParameter: function
      • treeGetMetadataWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): AxiosPromise<any>
      • summary

        This method retrieves the metadata

        throws

        {RequiredError}

        Parameters

        • resourceId: string

          Id of a resource

        • Optional path: string
        • Optional mimeType: string
        • Optional options: any

        Returns AxiosPromise<any>

    • treeStoreMetadataForFileWithParameter: function
      • treeStoreMetadataForFileWithParameter(resourceId: string, path?: string, mimeType?: string, options?: any): AxiosPromise<any>
      • summary

        This method stores the metadata of the file

        throws

        {RequiredError}

        Parameters

        • resourceId: string

          Id of the resource

        • Optional path: string
        • Optional mimeType: string
        • Optional options: any

        Returns AxiosPromise<any>

  • UserApi: { userGetUser: any; userQuery: any; userSetAndReturnMergeToken: any; userUpdateUser: any }
    • userGetUser: function
      • userGetUser(options?: any): AxiosPromise<UserObject>
      • summary

        Retrieves the UserObject.

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<UserObject>

    • userQuery: function
      • userQuery(queryString: string, projectId: string, options?: any): AxiosPromise<UserObject[]>
      • summary

        This method lets someone query the user database using a query string.

        throws

        {RequiredError}

        Parameters

        • queryString: string

          Search String

        • projectId: string

          Project from which the search is triggered

        • Optional options: any

        Returns AxiosPromise<UserObject[]>

    • userSetAndReturnMergeToken: function
      • userSetAndReturnMergeToken(provider: string, options?: any): AxiosPromise<string>
      • summary

        Sets and returns a merge token.

        throws

        {RequiredError}

        Parameters

        • provider: string

          Specifies the provider from which a user should be merged from

        • Optional options: any

        Returns AxiosPromise<string>

    • userUpdateUser: function
      • userUpdateUser(userObject: UserObject, options?: any): AxiosPromise<number>
      • summary

        Updates the User.

        throws

        {RequiredError}

        Parameters

        • userObject: UserObject

          Entry representing the user

        • Optional options: any

        Returns AxiosPromise<number>

  • VisibilityApi: { visibilityIndex: any }
    • visibilityIndex: function
      • visibilityIndex(options?: any): AxiosPromise<VisibilityObject[]>
      • summary

        Returns all available visibilities

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns AxiosPromise<VisibilityObject[]>

Generated using TypeDoc