Class GtrClient

Hierarchy

GtrClient

Index

Constructors

Methods

get getAssociatedObjects getObject getObjects recursiveProcessObjectDates

Constructors

constructor

new GtrClient(debug?): GtrClient
Parameters
- debug: boolean = false
Returns GtrClient
- Defined in index.ts:15

Properties

`Protected` baseUrl

baseUrl: string = "https://gtr.ukri.org/gtr/api"

debug

debug: boolean

getCollaboration

getCollaboration: ((id) => Promise<SingleObjectResponse<Collaboration>>)

Type declaration

- (id): Promise<SingleObjectResponse<Collaboration>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Collaboration>>

getCollaborations

getCollaborations: ((params?) => Promise<PaginatedCollaborations>)

Type declaration

- (params?): Promise<PaginatedCollaborations>
- Parameters
  - Optional params: CollaborationsQuery
  Returns Promise<PaginatedCollaborations>

getDissemination

getDissemination: ((id) => Promise<SingleObjectResponse<Dissemination>>)

Type declaration

- (id): Promise<SingleObjectResponse<Dissemination>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Dissemination>>

getDisseminations

getDisseminations: ((params?) => Promise<PaginatedDissemination>)

Type declaration

- (params?): Promise<PaginatedDissemination>
- Parameters
  - Optional params: DisseminationsQuery
  Returns Promise<PaginatedDissemination>

getFund

getFund: ((id) => Promise<SingleObjectResponse<Fund>>)

Type declaration

- (id): Promise<SingleObjectResponse<Fund>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Fund>>

getFunds

getFunds: ((params?) => Promise<PaginatedFunds>)

Type declaration

- (params?): Promise<PaginatedFunds>
- Parameters
  - Optional params: FundsQuery
  Returns Promise<PaginatedFunds>

getFurtherFunding

getFurtherFunding: ((id) => Promise<SingleObjectResponse<FurtherFunding>>)

Type declaration

- (id): Promise<SingleObjectResponse<FurtherFunding>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<FurtherFunding>>

getFurtherFundings

getFurtherFundings: ((params?) => Promise<PaginatedFurtherFunding>)

Type declaration

- (params?): Promise<PaginatedFurtherFunding>
- Parameters
  - Optional params: FurtherFundingsQuery
  Returns Promise<PaginatedFurtherFunding>

getImpactSummaries

getImpactSummaries: ((params?) => Promise<PaginatedImpactSummaries>)

Type declaration

- (params?): Promise<PaginatedImpactSummaries>
- Parameters
  - Optional params: ImpactSummariesQuery
  Returns Promise<PaginatedImpactSummaries>

getImpactSummary

getImpactSummary: ((id) => Promise<SingleObjectResponse<ImpactSummary>>)

Type declaration

- (id): Promise<SingleObjectResponse<ImpactSummary>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<ImpactSummary>>

getIntellectualProperties

getIntellectualProperties: ((params?) => Promise<PaginatedIntellectualProperties>)

Type declaration

- (params?): Promise<PaginatedIntellectualProperties>
- Parameters
  - Optional params: IntellectualPropertiesQuery
  Returns Promise<PaginatedIntellectualProperties>

getIntellectualProperty

getIntellectualProperty: ((id) => Promise<SingleObjectResponse<PolicyInfluence>>)

Type declaration

- (id): Promise<SingleObjectResponse<PolicyInfluence>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PolicyInfluence>>

getKeyFinding

getKeyFinding: ((id) => Promise<SingleObjectResponse<KeyFinding>>)

Type declaration

- (id): Promise<SingleObjectResponse<KeyFinding>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<KeyFinding>>

getKeyFindings

getKeyFindings: ((params?) => Promise<PaginatedKeyFindings>)

Type declaration

- (params?): Promise<PaginatedKeyFindings>
- Parameters
  - Optional params: KeyFindingsQuery
  Returns Promise<PaginatedKeyFindings>

getOrganisation

getOrganisation: ((id) => Promise<SingleObjectResponse<Organisation>>)

Type declaration

- (id): Promise<SingleObjectResponse<Organisation>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Organisation>>

getOrganisations

getOrganisations: ((params?) => Promise<PaginatedOrganisations>)

Type declaration

- (params?): Promise<PaginatedOrganisations>
- Parameters
  - Optional params: OrganisationsQuery
  Returns Promise<PaginatedOrganisations>

getOutcomes

getOutcomes: ((params?) => Promise<PaginatedOutcomes>)

Type declaration

- (params?): Promise<PaginatedOutcomes>
- Parameters
  - Optional params: OutcomesQuery
  Returns Promise<PaginatedOutcomes>

getPeople

getPeople: ((params?) => Promise<PaginatedPersons>)

Type declaration

- (params?): Promise<PaginatedPersons>
- Parameters
  - Optional params: PeopleQuery
  Returns Promise<PaginatedPersons>

getPerson

getPerson: ((id) => Promise<SingleObjectResponse<Person>>)

Type declaration

- (id): Promise<SingleObjectResponse<Person>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Person>>

getPersonOrganisations

getPersonOrganisations: ((id) => Promise<SingleObjectResponse<PaginatedProjects>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedProjects>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedProjects>>

getPersonProjects

getPersonProjects: ((id) => Promise<SingleObjectResponse<PaginatedProjects>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedProjects>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedProjects>>

getPolicyInfluences

getPolicyInfluences: ((params?) => Promise<PaginatedPolicyInfluences>)

Type declaration

- (params?): Promise<PaginatedPolicyInfluences>
- Parameters
  - Optional params: PolicyInfluencesQuery
  Returns Promise<PaginatedPolicyInfluences>

getProduct

getProduct: ((id) => Promise<SingleObjectResponse<Product>>)

Type declaration

- (id): Promise<SingleObjectResponse<Product>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Product>>

getProducts

getProducts: ((params?) => Promise<PaginatedProducts>)

Type declaration

- (params?): Promise<PaginatedProducts>
- Parameters
  - Optional params: ProductsQuery
  Returns Promise<PaginatedProducts>

getProjectCollaborations

getProjectCollaborations: ((id) => Promise<SingleObjectResponse<PaginatedCollaborations>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedCollaborations>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedCollaborations>>

getProjectDisseminations

getProjectDisseminations: ((id) => Promise<SingleObjectResponse<PaginatedDissemination>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedDissemination>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedDissemination>>

getProjectFunds

getProjectFunds: ((id) => Promise<SingleObjectResponse<PaginatedFunds>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedFunds>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedFunds>>

getProjectImpactSummaries

getProjectImpactSummaries: ((id) => Promise<SingleObjectResponse<PaginatedImpactSummaries>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedImpactSummaries>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedImpactSummaries>>

getProjectIntellectualProperties

getProjectIntellectualProperties: ((id) => Promise<SingleObjectResponse<PaginatedIntellectualProperties>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedIntellectualProperties>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedIntellectualProperties>>

getProjectKeyFindings

getProjectKeyFindings: ((id) => Promise<SingleObjectResponse<PaginatedKeyFindings>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedKeyFindings>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedKeyFindings>>

getProjectOrganisations

getProjectOrganisations: ((id) => Promise<SingleObjectResponse<PaginatedProjectOrganisations>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedProjectOrganisations>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedProjectOrganisations>>

getProjectOutcomes

getProjectOutcomes: ((id) => Promise<SingleObjectResponse<PaginatedOutcomes>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedOutcomes>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedOutcomes>>

getProjectPersons

getProjectPersons: ((id) => Promise<SingleObjectResponse<PaginatedPersons>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedPersons>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedPersons>>

getProjectProducts

getProjectProducts: ((id) => Promise<SingleObjectResponse<PaginatedProducts>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedProducts>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedProducts>>

getProjectPublications

getProjectPublications: ((id) => Promise<SingleObjectResponse<PaginatedPublications>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedPublications>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedPublications>>

getProjectResearchMaterials

getProjectResearchMaterials: ((id) => Promise<SingleObjectResponse<PaginatedResearchMaterials>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedResearchMaterials>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedResearchMaterials>>

getProjectSpinOuts

getProjectSpinOuts: ((id) => Promise<SingleObjectResponse<PaginatedSpinOuts>>)

Type declaration

- (id): Promise<SingleObjectResponse<PaginatedSpinOuts>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<PaginatedSpinOuts>>

getProjects

getProjects: ((params?) => Promise<PaginatedProjects>)

Type declaration

- (params?): Promise<PaginatedProjects>
- Parameters
  - Optional params: ProjectsQuery
  Returns Promise<PaginatedProjects>

getPublication

getPublication: ((id) => Promise<SingleObjectResponse<Publication>>)

Type declaration

- (id): Promise<SingleObjectResponse<Publication>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<Publication>>

getPublications

getPublications: ((params?) => Promise<PaginatedPublications>)

Type declaration

- (params?): Promise<PaginatedPublications>
- Parameters
  - Optional params: PublicationsQuery
  Returns Promise<PaginatedPublications>

getResearchMaterial

getResearchMaterial: ((id) => Promise<SingleObjectResponse<ResearchMaterial>>)

Type declaration

- (id): Promise<SingleObjectResponse<ResearchMaterial>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<ResearchMaterial>>

getResearchMaterials

getResearchMaterials: ((params?) => Promise<PaginatedResearchMaterials>)

Type declaration

- (params?): Promise<PaginatedResearchMaterials>
- Parameters
  - Optional params: ResearchMaterialsQuery
  Returns Promise<PaginatedResearchMaterials>

getSpinOut

getSpinOut: ((id) => Promise<SingleObjectResponse<SpinOut>>)

Type declaration

- (id): Promise<SingleObjectResponse<SpinOut>>
- Parameters
  - id: string
  Returns Promise<SingleObjectResponse<SpinOut>>

getSpinouts

getSpinouts: ((params?) => Promise<PaginatedSpinOuts>)

Type declaration

- (params?): Promise<PaginatedSpinOuts>
- Parameters
  - Optional params: SpinoutsQuery
  Returns Promise<PaginatedSpinOuts>

Methods

`Protected` get

get(url, params?): Promise<SingleObjectResponse<any>>
Parameters
- url: string
- params: {
  [name: string]: any;
  } = {}
  - [name: string]: any
Returns Promise<SingleObjectResponse<any>>
- Defined in index.ts:40

`Protected` getAssociatedObjects

getAssociatedObjects(id, path): Promise<any>
Parameters
- id: string
- path: string
Returns Promise<any>
- Defined in index.ts:116

`Protected` getObject

getObject(id, path): Promise<any>
Parameters
- id: string
- path: string
Returns Promise<any>
- Defined in index.ts:106

`Protected` getObjects

getObjects(path, params?): Promise<any>
Parameters
- path: string
- params: {} = {}
Returns Promise<any>
- Defined in index.ts:111

`Protected` recursiveProcessObjectDates

recursiveProcessObjectDates(obj): void
Parameters
- obj: any
Returns void
- Defined in index.ts:83

Generated using TypeDoc