UNPKG

@galv/galv

Version:

Galv API client using Typescript-Axios

1,889 lines (1,818 loc) 1.03 MB
/* tslint:disable */ /* eslint-disable */ /** * Battery Data API * A standard API for accessing battery experiment datasets and metadata * * The version of the OpenAPI document: 2.11.4 * Contact: martin.robinson@cs.ox.ac.uk * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base'; /** * * @export * @interface ActivationResponse */ export interface ActivationResponse { /** * * @type {string} * @memberof ActivationResponse */ 'detail': string; } /** * * @export * @interface AdditionalS3StorageType */ export interface AdditionalS3StorageType { /** * Canonical URL for this object * @type {string} * @memberof AdditionalS3StorageType */ 'url': string; /** * Auto-assigned object identifier * @type {string} * @memberof AdditionalS3StorageType */ 'id': string; /** * Human-friendly identifier for the storage type * @type {string} * @memberof AdditionalS3StorageType */ 'name'?: string | null; /** * Lab this Storage belongs to * @type {string} * @memberof AdditionalS3StorageType */ 'lab': string; /** * Maximum storage capacity in bytes * @type {number} * @memberof AdditionalS3StorageType */ 'quota_bytes': number; /** * * @type {number} * @memberof AdditionalS3StorageType */ 'bytes_used': number; /** * Priority for storage allocation. Higher values are higher priority. * @type {number} * @memberof AdditionalS3StorageType */ 'priority'?: number; /** * Whether this storage type is enabled for writing to * @type {boolean} * @memberof AdditionalS3StorageType */ 'enabled'?: boolean; /** * Secret key for S3 storage * @type {string} * @memberof AdditionalS3StorageType */ 'secret_key': string; /** * Access key for S3 storage * @type {string} * @memberof AdditionalS3StorageType */ 'access_key': string; /** * Name of the S3 bucket to store files in * @type {string} * @memberof AdditionalS3StorageType */ 'bucket_name'?: string | null; /** * Directory within the S3 bucket to store files in * @type {string} * @memberof AdditionalS3StorageType */ 'location'?: string; /** * Region for the S3 bucket. Only one of custom domain or region should be set. * @type {string} * @memberof AdditionalS3StorageType */ 'region_name'?: string; /** * Custom domain for the S3 bucket. * @type {string} * @memberof AdditionalS3StorageType */ 'custom_domain'?: string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof AdditionalS3StorageType */ 'permissions': AdditionalS3StorageTypePermissions; } /** * * @export * @interface AdditionalS3StorageTypePermissions */ export interface AdditionalS3StorageTypePermissions { /** * * @type {boolean} * @memberof AdditionalS3StorageTypePermissions */ 'read'?: boolean; /** * * @type {boolean} * @memberof AdditionalS3StorageTypePermissions */ 'write'?: boolean; /** * * @type {boolean} * @memberof AdditionalS3StorageTypePermissions */ 'create'?: boolean; /** * * @type {boolean} * @memberof AdditionalS3StorageTypePermissions */ 'destroy'?: boolean; } /** * * @export * @interface AdditionalS3StorageTypeRequest */ export interface AdditionalS3StorageTypeRequest { /** * Human-friendly identifier for the storage type * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'name'?: string | null; /** * Lab this Storage belongs to * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'lab': string; /** * Maximum storage capacity in bytes * @type {number} * @memberof AdditionalS3StorageTypeRequest */ 'quota_bytes': number; /** * Priority for storage allocation. Higher values are higher priority. * @type {number} * @memberof AdditionalS3StorageTypeRequest */ 'priority'?: number; /** * Whether this storage type is enabled for writing to * @type {boolean} * @memberof AdditionalS3StorageTypeRequest */ 'enabled'?: boolean; /** * Secret key for S3 storage * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'secret_key': string; /** * Access key for S3 storage * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'access_key': string; /** * Name of the S3 bucket to store files in * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'bucket_name'?: string | null; /** * Directory within the S3 bucket to store files in * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'location'?: string; /** * Region for the S3 bucket. Only one of custom domain or region should be set. * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'region_name'?: string; /** * Custom domain for the S3 bucket. * @type {string} * @memberof AdditionalS3StorageTypeRequest */ 'custom_domain'?: string | null; } /** * * @export * @interface ArbitraryFile */ export interface ArbitraryFile { /** * Canonical URL for this object * @type {string} * @memberof ArbitraryFile */ 'url': string; /** * Auto-assigned object identifier * @type {string} * @memberof ArbitraryFile */ 'id': string; /** * The name of the file * @type {string} * @memberof ArbitraryFile */ 'name': string; /** * The description of the file * @type {string} * @memberof ArbitraryFile */ 'description'?: string | null; /** * File * @type {string} * @memberof ArbitraryFile */ 'file': string | null; /** * Team this resource belongs to * @type {string} * @memberof ArbitraryFile */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof ArbitraryFile */ 'read_access_level'?: ArbitraryFileReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof ArbitraryFile */ 'edit_access_level'?: ArbitraryFileEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof ArbitraryFile */ 'delete_access_level'?: ArbitraryFileDeleteAccessLevelEnum; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof ArbitraryFile */ 'permissions': AdditionalS3StorageTypePermissions; } export const ArbitraryFileReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type ArbitraryFileReadAccessLevelEnum = typeof ArbitraryFileReadAccessLevelEnum[keyof typeof ArbitraryFileReadAccessLevelEnum]; export const ArbitraryFileEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type ArbitraryFileEditAccessLevelEnum = typeof ArbitraryFileEditAccessLevelEnum[keyof typeof ArbitraryFileEditAccessLevelEnum]; export const ArbitraryFileDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type ArbitraryFileDeleteAccessLevelEnum = typeof ArbitraryFileDeleteAccessLevelEnum[keyof typeof ArbitraryFileDeleteAccessLevelEnum]; /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface Cell */ export interface Cell { /** * * @type {string} * @memberof Cell */ 'url': string; /** * * @type {string} * @memberof Cell */ 'id': string; /** * Unique identifier (e.g. serial number) for the cell * @type {string} * @memberof Cell */ 'identifier': string; /** * Cell Family this Cell belongs to * @type {string} * @memberof Cell */ 'family': string; /** * Cycler Tests using this Cell * @type {Array<string>} * @memberof Cell */ 'cycler_tests': Array<string>; /** * * @type {boolean} * @memberof Cell */ 'in_use': boolean; /** * Team this resource belongs to * @type {string} * @memberof Cell */ 'team': string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof Cell */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof Cell */ 'read_access_level'?: CellReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof Cell */ 'edit_access_level'?: CellEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof Cell */ 'delete_access_level'?: CellDeleteAccessLevelEnum; /** * * @type {{ [key: string]: any; }} * @memberof Cell */ 'custom_properties'?: { [key: string]: any; }; } export const CellReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type CellReadAccessLevelEnum = typeof CellReadAccessLevelEnum[keyof typeof CellReadAccessLevelEnum]; export const CellEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type CellEditAccessLevelEnum = typeof CellEditAccessLevelEnum[keyof typeof CellEditAccessLevelEnum]; export const CellDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type CellDeleteAccessLevelEnum = typeof CellDeleteAccessLevelEnum[keyof typeof CellDeleteAccessLevelEnum]; /** * * @export * @interface CellChemistriesList200Response */ export interface CellChemistriesList200Response { /** * * @type {number} * @memberof CellChemistriesList200Response */ 'count': number; /** * * @type {string} * @memberof CellChemistriesList200Response */ 'next'?: string | null; /** * * @type {string} * @memberof CellChemistriesList200Response */ 'previous'?: string | null; /** * * @type {Array<string>} * @memberof CellChemistriesList200Response */ 'results': Array<string>; } /** * For use with AutoCompleteEntry models: Simply returns the value field. Read-only. * @export * @interface CellChemistriesText */ export interface CellChemistriesText { /** * * @type {number} * @memberof CellChemistriesText */ 'id': number; /** * * @type {string} * @memberof CellChemistriesText */ 'created': string; /** * * @type {string} * @memberof CellChemistriesText */ 'modified': string; /** * * @type {string} * @memberof CellChemistriesText */ 'value': string; /** * * @type {{ [key: string]: any; }} * @memberof CellChemistriesText */ 'ld_value'?: { [key: string]: any; } | null; /** * * @type {boolean} * @memberof CellChemistriesText */ 'include_in_autocomplete'?: boolean; } /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface CellFamily */ export interface CellFamily { /** * * @type {string} * @memberof CellFamily */ 'url': string; /** * * @type {string} * @memberof CellFamily */ 'id': string; /** * Manufacturer name * @type {string} * @memberof CellFamily */ 'manufacturer': string; /** * Model number * @type {string} * @memberof CellFamily */ 'model': string; /** * Link to the datasheet * @type {string} * @memberof CellFamily */ 'datasheet'?: string | null; /** * Chemistry type * @type {string} * @memberof CellFamily */ 'chemistry': string; /** * Nominal voltage of the cells (in volts) * @type {number} * @memberof CellFamily */ 'nominal_voltage_v'?: number | null; /** * Nominal capacity of the cells (in amp hours) * @type {number} * @memberof CellFamily */ 'nominal_capacity_ah'?: number | null; /** * Initial AC impedance of the cells (in ohms) * @type {number} * @memberof CellFamily */ 'initial_ac_impedance_o'?: number | null; /** * Initial DC resistance of the cells (in ohms) * @type {number} * @memberof CellFamily */ 'initial_dc_resistance_o'?: number | null; /** * Energy density of the cells (in watt hours per kilogram) * @type {number} * @memberof CellFamily */ 'energy_density_wh_per_kg'?: number | null; /** * Power density of the cells (in watts per kilogram) * @type {number} * @memberof CellFamily */ 'power_density_w_per_kg'?: number | null; /** * Physical form factor * @type {string} * @memberof CellFamily */ 'form_factor': string; /** * Cells belonging to this Cell Family * @type {Array<string>} * @memberof CellFamily */ 'cells': Array<string>; /** * * @type {boolean} * @memberof CellFamily */ 'in_use': boolean; /** * Team this resource belongs to * @type {string} * @memberof CellFamily */ 'team': string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof CellFamily */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof CellFamily */ 'read_access_level'?: CellFamilyReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof CellFamily */ 'edit_access_level'?: CellFamilyEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof CellFamily */ 'delete_access_level'?: CellFamilyDeleteAccessLevelEnum; /** * * @type {{ [key: string]: any; }} * @memberof CellFamily */ 'custom_properties'?: { [key: string]: any; }; } export const CellFamilyReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type CellFamilyReadAccessLevelEnum = typeof CellFamilyReadAccessLevelEnum[keyof typeof CellFamilyReadAccessLevelEnum]; export const CellFamilyEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type CellFamilyEditAccessLevelEnum = typeof CellFamilyEditAccessLevelEnum[keyof typeof CellFamilyEditAccessLevelEnum]; export const CellFamilyDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type CellFamilyDeleteAccessLevelEnum = typeof CellFamilyDeleteAccessLevelEnum[keyof typeof CellFamilyDeleteAccessLevelEnum]; /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface CellFamilyRequest */ export interface CellFamilyRequest { /** * Manufacturer name * @type {string} * @memberof CellFamilyRequest */ 'manufacturer': string; /** * Model number * @type {string} * @memberof CellFamilyRequest */ 'model': string; /** * Link to the datasheet * @type {string} * @memberof CellFamilyRequest */ 'datasheet'?: string | null; /** * Chemistry type * @type {string} * @memberof CellFamilyRequest */ 'chemistry': string; /** * Nominal voltage of the cells (in volts) * @type {number} * @memberof CellFamilyRequest */ 'nominal_voltage_v'?: number | null; /** * Nominal capacity of the cells (in amp hours) * @type {number} * @memberof CellFamilyRequest */ 'nominal_capacity_ah'?: number | null; /** * Initial AC impedance of the cells (in ohms) * @type {number} * @memberof CellFamilyRequest */ 'initial_ac_impedance_o'?: number | null; /** * Initial DC resistance of the cells (in ohms) * @type {number} * @memberof CellFamilyRequest */ 'initial_dc_resistance_o'?: number | null; /** * Energy density of the cells (in watt hours per kilogram) * @type {number} * @memberof CellFamilyRequest */ 'energy_density_wh_per_kg'?: number | null; /** * Power density of the cells (in watts per kilogram) * @type {number} * @memberof CellFamilyRequest */ 'power_density_w_per_kg'?: number | null; /** * Physical form factor * @type {string} * @memberof CellFamilyRequest */ 'form_factor': string; /** * Team this resource belongs to * @type {string} * @memberof CellFamilyRequest */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof CellFamilyRequest */ 'read_access_level'?: CellFamilyRequestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof CellFamilyRequest */ 'edit_access_level'?: CellFamilyRequestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof CellFamilyRequest */ 'delete_access_level'?: CellFamilyRequestDeleteAccessLevelEnum; /** * * @type {{ [key: string]: any; }} * @memberof CellFamilyRequest */ 'custom_properties'?: { [key: string]: any; }; } export const CellFamilyRequestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type CellFamilyRequestReadAccessLevelEnum = typeof CellFamilyRequestReadAccessLevelEnum[keyof typeof CellFamilyRequestReadAccessLevelEnum]; export const CellFamilyRequestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type CellFamilyRequestEditAccessLevelEnum = typeof CellFamilyRequestEditAccessLevelEnum[keyof typeof CellFamilyRequestEditAccessLevelEnum]; export const CellFamilyRequestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type CellFamilyRequestDeleteAccessLevelEnum = typeof CellFamilyRequestDeleteAccessLevelEnum[keyof typeof CellFamilyRequestDeleteAccessLevelEnum]; /** * For use with AutoCompleteEntry models: Simply returns the value field. Read-only. * @export * @interface CellFormFactorsText */ export interface CellFormFactorsText { /** * * @type {number} * @memberof CellFormFactorsText */ 'id': number; /** * * @type {string} * @memberof CellFormFactorsText */ 'created': string; /** * * @type {string} * @memberof CellFormFactorsText */ 'modified': string; /** * * @type {string} * @memberof CellFormFactorsText */ 'value': string; /** * * @type {{ [key: string]: any; }} * @memberof CellFormFactorsText */ 'ld_value'?: { [key: string]: any; } | null; /** * * @type {boolean} * @memberof CellFormFactorsText */ 'include_in_autocomplete'?: boolean; } /** * For use with AutoCompleteEntry models: Simply returns the value field. Read-only. * @export * @interface CellManufacturersText */ export interface CellManufacturersText { /** * * @type {number} * @memberof CellManufacturersText */ 'id': number; /** * * @type {string} * @memberof CellManufacturersText */ 'created': string; /** * * @type {string} * @memberof CellManufacturersText */ 'modified': string; /** * * @type {string} * @memberof CellManufacturersText */ 'value': string; /** * * @type {{ [key: string]: any; }} * @memberof CellManufacturersText */ 'ld_value'?: { [key: string]: any; } | null; /** * * @type {boolean} * @memberof CellManufacturersText */ 'include_in_autocomplete'?: boolean; } /** * For use with AutoCompleteEntry models: Simply returns the value field. Read-only. * @export * @interface CellModelsText */ export interface CellModelsText { /** * * @type {number} * @memberof CellModelsText */ 'id': number; /** * * @type {string} * @memberof CellModelsText */ 'created': string; /** * * @type {string} * @memberof CellModelsText */ 'modified': string; /** * * @type {string} * @memberof CellModelsText */ 'value': string; /** * * @type {{ [key: string]: any; }} * @memberof CellModelsText */ 'ld_value'?: { [key: string]: any; } | null; /** * * @type {boolean} * @memberof CellModelsText */ 'include_in_autocomplete'?: boolean; } /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface CellRequest */ export interface CellRequest { /** * Unique identifier (e.g. serial number) for the cell * @type {string} * @memberof CellRequest */ 'identifier': string; /** * Cell Family this Cell belongs to * @type {string} * @memberof CellRequest */ 'family': string; /** * Team this resource belongs to * @type {string} * @memberof CellRequest */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof CellRequest */ 'read_access_level'?: CellRequestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof CellRequest */ 'edit_access_level'?: CellRequestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof CellRequest */ 'delete_access_level'?: CellRequestDeleteAccessLevelEnum; /** * * @type {{ [key: string]: any; }} * @memberof CellRequest */ 'custom_properties'?: { [key: string]: any; }; } export const CellRequestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type CellRequestReadAccessLevelEnum = typeof CellRequestReadAccessLevelEnum[keyof typeof CellRequestReadAccessLevelEnum]; export const CellRequestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type CellRequestEditAccessLevelEnum = typeof CellRequestEditAccessLevelEnum[keyof typeof CellRequestEditAccessLevelEnum]; export const CellRequestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type CellRequestDeleteAccessLevelEnum = typeof CellRequestDeleteAccessLevelEnum[keyof typeof CellRequestDeleteAccessLevelEnum]; /** * * @export * @interface ColumnMapping */ export interface ColumnMapping { /** * * @type {string} * @memberof ColumnMapping */ 'url': string; /** * * @type {string} * @memberof ColumnMapping */ 'id': string; /** * * @type {string} * @memberof ColumnMapping */ 'name': string; /** * Mapping of column names to Column objects. Each key is a column name in the file, and each value is a dictionary with the following keys: `column_type` (required): the ID of the DataColumnType object to map to, `new_name` (optional): a new name for the column (defaults to column_type\'s name) and cannot be specified for required columns (recommended to use a lowercase style with units in square brackets e.g. `speed_increase[m.s-1]`), `multiplier` (optional): a multiplier to apply to the column, `addition` (optional): a value to add to the column. Multiplier and addition are only used for numerical (int/float) columns. The new value is calculated as `new_value = (old_value + addition) * multiplier`. Columns will be renamed to match the DataColumnType name. **Columns not in the map will be coerced to float datatype.** * @type {{ [key: string]: any; }} * @memberof ColumnMapping */ 'map': { [key: string]: any; }; /** * * @type {{ [key: string]: any; }} * @memberof ColumnMapping */ 'rendered_map': { [key: string]: any; }; /** * * @type {boolean} * @memberof ColumnMapping */ 'is_valid': boolean; /** * * @type {Array<string>} * @memberof ColumnMapping */ 'missing_required_columns': Array<string>; /** * * @type {boolean} * @memberof ColumnMapping */ 'in_use': boolean; /** * Team this resource belongs to * @type {string} * @memberof ColumnMapping */ 'team': string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof ColumnMapping */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof ColumnMapping */ 'read_access_level'?: ColumnMappingReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof ColumnMapping */ 'edit_access_level'?: ColumnMappingEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof ColumnMapping */ 'delete_access_level'?: ColumnMappingDeleteAccessLevelEnum; } export const ColumnMappingReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type ColumnMappingReadAccessLevelEnum = typeof ColumnMappingReadAccessLevelEnum[keyof typeof ColumnMappingReadAccessLevelEnum]; export const ColumnMappingEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type ColumnMappingEditAccessLevelEnum = typeof ColumnMappingEditAccessLevelEnum[keyof typeof ColumnMappingEditAccessLevelEnum]; export const ColumnMappingDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type ColumnMappingDeleteAccessLevelEnum = typeof ColumnMappingDeleteAccessLevelEnum[keyof typeof ColumnMappingDeleteAccessLevelEnum]; /** * * @export * @interface ColumnMappingRequest */ export interface ColumnMappingRequest { /** * * @type {string} * @memberof ColumnMappingRequest */ 'name': string; /** * Mapping of column names to Column objects. Each key is a column name in the file, and each value is a dictionary with the following keys: `column_type` (required): the ID of the DataColumnType object to map to, `new_name` (optional): a new name for the column (defaults to column_type\'s name) and cannot be specified for required columns (recommended to use a lowercase style with units in square brackets e.g. `speed_increase[m.s-1]`), `multiplier` (optional): a multiplier to apply to the column, `addition` (optional): a value to add to the column. Multiplier and addition are only used for numerical (int/float) columns. The new value is calculated as `new_value = (old_value + addition) * multiplier`. Columns will be renamed to match the DataColumnType name. **Columns not in the map will be coerced to float datatype.** * @type {{ [key: string]: any; }} * @memberof ColumnMappingRequest */ 'map': { [key: string]: any; }; /** * Team this resource belongs to * @type {string} * @memberof ColumnMappingRequest */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof ColumnMappingRequest */ 'read_access_level'?: ColumnMappingRequestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof ColumnMappingRequest */ 'edit_access_level'?: ColumnMappingRequestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof ColumnMappingRequest */ 'delete_access_level'?: ColumnMappingRequestDeleteAccessLevelEnum; } export const ColumnMappingRequestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type ColumnMappingRequestReadAccessLevelEnum = typeof ColumnMappingRequestReadAccessLevelEnum[keyof typeof ColumnMappingRequestReadAccessLevelEnum]; export const ColumnMappingRequestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type ColumnMappingRequestEditAccessLevelEnum = typeof ColumnMappingRequestEditAccessLevelEnum[keyof typeof ColumnMappingRequestEditAccessLevelEnum]; export const ColumnMappingRequestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type ColumnMappingRequestDeleteAccessLevelEnum = typeof ColumnMappingRequestDeleteAccessLevelEnum[keyof typeof ColumnMappingRequestDeleteAccessLevelEnum]; /** * * @export * @interface CreateKnoxTokenRequest */ export interface CreateKnoxTokenRequest { /** * Time to live (s) * @type {number} * @memberof CreateKnoxTokenRequest */ 'ttl'?: number; /** * * @type {string} * @memberof CreateKnoxTokenRequest */ 'name': string; } /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface CyclerTest */ export interface CyclerTest { /** * * @type {string} * @memberof CyclerTest */ 'url': string; /** * * @type {string} * @memberof CyclerTest */ 'id': string; /** * Cell this Cycler Test uses * @type {string} * @memberof CyclerTest */ 'cell': string; /** * Equipment this Cycler Test uses * @type {Array<string>} * @memberof CyclerTest */ 'equipment': Array<string>; /** * Files harvested for this Cycler Test * @type {Array<string>} * @memberof CyclerTest */ 'files': Array<string>; /** * Schedule this Cycler Test uses * @type {string} * @memberof CyclerTest */ 'schedule': string; /** * Rendered schedule * @type {Array<string>} * @memberof CyclerTest */ 'rendered_schedule': Array<string> | null; /** * Team this resource belongs to * @type {string} * @memberof CyclerTest */ 'team': string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof CyclerTest */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof CyclerTest */ 'read_access_level'?: CyclerTestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof CyclerTest */ 'edit_access_level'?: CyclerTestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof CyclerTest */ 'delete_access_level'?: CyclerTestDeleteAccessLevelEnum; /** * * @type {{ [key: string]: any; }} * @memberof CyclerTest */ 'custom_properties'?: { [key: string]: any; }; } export const CyclerTestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type CyclerTestReadAccessLevelEnum = typeof CyclerTestReadAccessLevelEnum[keyof typeof CyclerTestReadAccessLevelEnum]; export const CyclerTestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type CyclerTestEditAccessLevelEnum = typeof CyclerTestEditAccessLevelEnum[keyof typeof CyclerTestEditAccessLevelEnum]; export const CyclerTestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type CyclerTestDeleteAccessLevelEnum = typeof CyclerTestDeleteAccessLevelEnum[keyof typeof CyclerTestDeleteAccessLevelEnum]; /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface CyclerTestRequest */ export interface CyclerTestRequest { /** * Cell this Cycler Test uses * @type {string} * @memberof CyclerTestRequest */ 'cell': string; /** * Equipment this Cycler Test uses * @type {Array<string>} * @memberof CyclerTestRequest */ 'equipment': Array<string>; /** * Files harvested for this Cycler Test * @type {Array<string>} * @memberof CyclerTestRequest */ 'files': Array<string>; /** * Schedule this Cycler Test uses * @type {string} * @memberof CyclerTestRequest */ 'schedule': string; /** * Team this resource belongs to * @type {string} * @memberof CyclerTestRequest */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof CyclerTestRequest */ 'read_access_level'?: CyclerTestRequestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof CyclerTestRequest */ 'edit_access_level'?: CyclerTestRequestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof CyclerTestRequest */ 'delete_access_level'?: CyclerTestRequestDeleteAccessLevelEnum; /** * * @type {{ [key: string]: any; }} * @memberof CyclerTestRequest */ 'custom_properties'?: { [key: string]: any; }; } export const CyclerTestRequestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type CyclerTestRequestReadAccessLevelEnum = typeof CyclerTestRequestReadAccessLevelEnum[keyof typeof CyclerTestRequestReadAccessLevelEnum]; export const CyclerTestRequestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type CyclerTestRequestEditAccessLevelEnum = typeof CyclerTestRequestEditAccessLevelEnum[keyof typeof CyclerTestRequestEditAccessLevelEnum]; export const CyclerTestRequestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type CyclerTestRequestDeleteAccessLevelEnum = typeof CyclerTestRequestDeleteAccessLevelEnum[keyof typeof CyclerTestRequestDeleteAccessLevelEnum]; /** * * @export * @interface DataColumnType */ export interface DataColumnType { /** * Canonical URL for this object * @type {string} * @memberof DataColumnType */ 'url': string; /** * Auto-assigned object identifier * @type {number} * @memberof DataColumnType */ 'id': number; /** * Human-friendly identifier * @type {string} * @memberof DataColumnType */ 'name': string; /** * Origins and purpose * @type {string} * @memberof DataColumnType */ 'description': string; /** * Whether the Column is included in the initial list of known Column Types * @type {boolean} * @memberof DataColumnType */ 'is_default': boolean; /** * Whether the Column must be present in every Dataset * @type {boolean} * @memberof DataColumnType */ 'is_required': boolean; /** * * @type {string} * @memberof DataColumnType */ 'unit': string; /** * Type of the data in this column. * @type {string} * @memberof DataColumnType */ 'data_type'?: DataColumnTypeDataTypeEnum; /** * Team this resource belongs to * @type {string} * @memberof DataColumnType */ 'team': string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof DataColumnType */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof DataColumnType */ 'read_access_level'?: DataColumnTypeReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof DataColumnType */ 'edit_access_level'?: DataColumnTypeEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof DataColumnType */ 'delete_access_level'?: DataColumnTypeDeleteAccessLevelEnum; } export const DataColumnTypeDataTypeEnum = { Int: 'int', Float: 'float', Str: 'str', Bool: 'bool', Datetime64Ns: 'datetime64[ns]' } as const; export type DataColumnTypeDataTypeEnum = typeof DataColumnTypeDataTypeEnum[keyof typeof DataColumnTypeDataTypeEnum]; export const DataColumnTypeReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type DataColumnTypeReadAccessLevelEnum = typeof DataColumnTypeReadAccessLevelEnum[keyof typeof DataColumnTypeReadAccessLevelEnum]; export const DataColumnTypeEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type DataColumnTypeEditAccessLevelEnum = typeof DataColumnTypeEditAccessLevelEnum[keyof typeof DataColumnTypeEditAccessLevelEnum]; export const DataColumnTypeDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type DataColumnTypeDeleteAccessLevelEnum = typeof DataColumnTypeDeleteAccessLevelEnum[keyof typeof DataColumnTypeDeleteAccessLevelEnum]; /** * * @export * @interface DataColumnTypeRequest */ export interface DataColumnTypeRequest { /** * Human-friendly identifier * @type {string} * @memberof DataColumnTypeRequest */ 'name': string; /** * Origins and purpose * @type {string} * @memberof DataColumnTypeRequest */ 'description': string; /** * * @type {string} * @memberof DataColumnTypeRequest */ 'unit': string; /** * Type of the data in this column. * @type {string} * @memberof DataColumnTypeRequest */ 'data_type'?: DataColumnTypeRequestDataTypeEnum; /** * Team this resource belongs to * @type {string} * @memberof DataColumnTypeRequest */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof DataColumnTypeRequest */ 'read_access_level'?: DataColumnTypeRequestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof DataColumnTypeRequest */ 'edit_access_level'?: DataColumnTypeRequestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof DataColumnTypeRequest */ 'delete_access_level'?: DataColumnTypeRequestDeleteAccessLevelEnum; } export const DataColumnTypeRequestDataTypeEnum = { Int: 'int', Float: 'float', Str: 'str', Bool: 'bool', Datetime64Ns: 'datetime64[ns]' } as const; export type DataColumnTypeRequestDataTypeEnum = typeof DataColumnTypeRequestDataTypeEnum[keyof typeof DataColumnTypeRequestDataTypeEnum]; export const DataColumnTypeRequestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type DataColumnTypeRequestReadAccessLevelEnum = typeof DataColumnTypeRequestReadAccessLevelEnum[keyof typeof DataColumnTypeRequestReadAccessLevelEnum]; export const DataColumnTypeRequestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type DataColumnTypeRequestEditAccessLevelEnum = typeof DataColumnTypeRequestEditAccessLevelEnum[keyof typeof DataColumnTypeRequestEditAccessLevelEnum]; export const DataColumnTypeRequestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type DataColumnTypeRequestDeleteAccessLevelEnum = typeof DataColumnTypeRequestDeleteAccessLevelEnum[keyof typeof DataColumnTypeRequestDeleteAccessLevelEnum]; /** * * @export * @interface DataUnit */ export interface DataUnit { /** * Canonical URL for this object * @type {string} * @memberof DataUnit */ 'url': string; /** * Auto-assigned object identifier * @type {number} * @memberof DataUnit */ 'id': number; /** * Common name * @type {string} * @memberof DataUnit */ 'name': string; /** * Symbol * @type {string} * @memberof DataUnit */ 'symbol': string; /** * What the Unit signifies, and how it is used * @type {string} * @memberof DataUnit */ 'description': string; /** * Whether the Unit is included in the initial list of Units * @type {boolean} * @memberof DataUnit */ 'is_default': boolean; /** * Team this resource belongs to * @type {string} * @memberof DataUnit */ 'team': string | null; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof DataUnit */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof DataUnit */ 'read_access_level'?: DataUnitReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof DataUnit */ 'edit_access_level'?: DataUnitEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof DataUnit */ 'delete_access_level'?: DataUnitDeleteAccessLevelEnum; } export const DataUnitReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type DataUnitReadAccessLevelEnum = typeof DataUnitReadAccessLevelEnum[keyof typeof DataUnitReadAccessLevelEnum]; export const DataUnitEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type DataUnitEditAccessLevelEnum = typeof DataUnitEditAccessLevelEnum[keyof typeof DataUnitEditAccessLevelEnum]; export const DataUnitDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type DataUnitDeleteAccessLevelEnum = typeof DataUnitDeleteAccessLevelEnum[keyof typeof DataUnitDeleteAccessLevelEnum]; /** * * @export * @interface DataUnitRequest */ export interface DataUnitRequest { /** * Common name * @type {string} * @memberof DataUnitRequest */ 'name': string; /** * Symbol * @type {string} * @memberof DataUnitRequest */ 'symbol': string; /** * What the Unit signifies, and how it is used * @type {string} * @memberof DataUnitRequest */ 'description': string; /** * Team this resource belongs to * @type {string} * @memberof DataUnitRequest */ 'team': string | null; /** * Minimum user level required to read this resource * @type {number} * @memberof DataUnitRequest */ 'read_access_level'?: DataUnitRequestReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof DataUnitRequest */ 'edit_access_level'?: DataUnitRequestEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof DataUnitRequest */ 'delete_access_level'?: DataUnitRequestDeleteAccessLevelEnum; } export const DataUnitRequestReadAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_0: 0, NUMBER_null: null } as const; export type DataUnitRequestReadAccessLevelEnum = typeof DataUnitRequestReadAccessLevelEnum[keyof typeof DataUnitRequestReadAccessLevelEnum]; export const DataUnitRequestEditAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_2: 2, NUMBER_1: 1, NUMBER_null: null } as const; export type DataUnitRequestEditAccessLevelEnum = typeof DataUnitRequestEditAccessLevelEnum[keyof typeof DataUnitRequestEditAccessLevelEnum]; export const DataUnitRequestDeleteAccessLevelEnum = { NUMBER_4: 4, NUMBER_3: 3, NUMBER_null: null } as const; export type DataUnitRequestDeleteAccessLevelEnum = typeof DataUnitRequestDeleteAccessLevelEnum[keyof typeof DataUnitRequestDeleteAccessLevelEnum]; /** * A ModelSerializer that maps unrecognised properties in the input to an \'custom_properties\' JSONField, and unpacks the \'custom_properties\' JSONField into the output. The Meta.model must have a custom_properties JSONField. * @export * @interface Equipment */ export interface Equipment { /** * * @type {string} * @memberof Equipment */ 'url': string; /** * * @type {string} * @memberof Equipment */ 'id': string; /** * Unique identifier (e.g. serial number) for the equipment * @type {string} * @memberof Equipment */ 'identifier': string; /** * Equipment Family this Equipment belongs to * @type {string} * @memberof Equipment */ 'family': string; /** * Date of last calibration * @type {string} * @memberof Equipment */ 'calibration_date'?: string | null; /** * * @type {boolean} * @memberof Equipment */ 'in_use': boolean; /** * Team this resource belongs to * @type {string} * @memberof Equipment */ 'team': string | null; /** * Cycler Tests using this Equipment * @type {Array<string>} * @memberof Equipment */ 'cycler_tests': Array<string>; /** * * @type {AdditionalS3StorageTypePermissions} * @memberof Equipment */ 'permissions': AdditionalS3StorageTypePermissions; /** * Minimum user level required to read this resource * @type {number} * @memberof Equipment */ 'read_access_level'?: EquipmentReadAccessLevelEnum; /** * Minimum user level required to edit this resource * @type {number} * @memberof Equipment */ 'edit_access_level'?: EquipmentEditAccessLevelEnum; /** * Minimum user level required to create this resource * @type {number} * @memberof Equipment */ 'delete_access_level'?: EquipmentDeleteAccessLevelEnum;