Class MetadataManager

Index

Constructors

Properties

Methods

create delete get getAll update

Constructors

constructor

new MetadataManager(__namedParameters): MetadataManager
Parameters
- __namedParameters: BetterUptime
Returns MetadataManager
- Defined in metadata/MetadataManager.ts:8

Properties

`Private` apiClient

apiClient: AxiosInstance

Methods

create

create(newMetadata): Promise<any>
This will create a new metadata.
Parameters
- newMetadata: any
Returns Promise<any>
- Defined in metadata/MetadataManager.ts:57

delete

delete(metadata_id): Promise<boolean>
Permanently deletes a metadata record.
Parameters
- metadata_id: string
  Metadata ID you want to remove
Returns Promise<boolean>
True if success
- Defined in metadata/MetadataManager.ts:99

get

get(metadata_id): Promise<any>
Returns a single metadata record.
Parameters
- metadata_id: string
Returns Promise<any>
- Defined in metadata/MetadataManager.ts:39

getAll

getAll(__namedParameters?): Promise<any>
List all metadata with an option to filter metadata by owner.
Parameters
- __namedParameters: {
      owner_id?: number;
      owner_type?: number;
      page?: number;
  } = {}
  - Optional owner_id?: number
  - Optional owner_type?: number
  - Optional page?: number
Returns Promise<any>
- Defined in metadata/MetadataManager.ts:15

update

update(metadata_id, newMetadata): Promise<any>
This will update an existing metadata.
Parameters
- metadata_id: string
  Metadata record ID you want to change
- newMetadata: Partial<any>
Returns Promise<any>
- Defined in metadata/MetadataManager.ts:76

Generated using TypeDoc