diff --git a/.gitignore b/.gitignore index aea3f74..d681b9f 100644 --- a/.gitignore +++ b/.gitignore @@ -108,3 +108,4 @@ dist *.DS_Store .npmrc +tmp/ diff --git a/lib/.gitignore b/lib/.gitignore deleted file mode 100644 index 149b576..0000000 --- a/lib/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -wwwroot/*.js -node_modules -typings -dist diff --git a/lib/.npmignore b/lib/.npmignore deleted file mode 100644 index 999d88d..0000000 --- a/lib/.npmignore +++ /dev/null @@ -1 +0,0 @@ -# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/lib/.openapi-generator-ignore b/lib/.openapi-generator-ignore deleted file mode 100644 index 7484ee5..0000000 --- a/lib/.openapi-generator-ignore +++ /dev/null @@ -1,23 +0,0 @@ -# OpenAPI Generator Ignore -# Generated by openapi-generator https://github.com/openapitools/openapi-generator - -# Use this file to prevent files from being overwritten by the generator. -# The patterns follow closely to .gitignore or .dockerignore. - -# As an example, the C# client generator defines ApiClient.cs. -# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: -#ApiClient.cs - -# You can match any string of characters against a directory, file or extension with a single asterisk (*): -#foo/*/qux -# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux - -# You can recursively match patterns against a directory, file or extension with a double asterisk (**): -#foo/**/qux -# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux - -# You can also negate patterns with an exclamation (!). -# For example, you can ignore all files in a docs folder with the file extension .md: -#docs/*.md -# Then explicitly reverse the ignore rule for a single file: -#!docs/README.md diff --git a/lib/.openapi-generator/FILES b/lib/.openapi-generator/FILES deleted file mode 100644 index a80cd4f..0000000 --- a/lib/.openapi-generator/FILES +++ /dev/null @@ -1,8 +0,0 @@ -.gitignore -.npmignore -api.ts -base.ts -common.ts -configuration.ts -git_push.sh -index.ts diff --git a/lib/.openapi-generator/VERSION b/lib/.openapi-generator/VERSION deleted file mode 100644 index 32f3eaa..0000000 --- a/lib/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -5.0.1 \ No newline at end of file diff --git a/lib/api.d.ts b/lib/api.d.ts new file mode 100644 index 0000000..6851d71 --- /dev/null +++ b/lib/api.d.ts @@ -0,0 +1,7087 @@ +/** + * TileDB Storage Platform API + * TileDB Storage Platform REST API + * + * The version of the OpenAPI document: 2.2.19 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +import { Configuration } from './configuration'; +import { AxiosPromise, AxiosInstance } from 'axios'; +import { RequestArgs, BaseAPI } from './base'; +/** + * Model representing aws keys or service role, service roles are currently ignored, but will be preferred option in the future + * @export + * @interface AWSAccessCredentials + */ +export interface AWSAccessCredentials { + /** + * aws secret access key, never returned in get requests + * @type {string} + * @memberof AWSAccessCredentials + */ + secret_access_key?: string; + /** + * aws access key + * @type {string} + * @memberof AWSAccessCredentials + */ + access_key_id?: string; + /** + * aws service role to use for access + * @type {string} + * @memberof AWSAccessCredentials + */ + service_role_arn?: string; + /** + * human readable name + * @type {string} + * @memberof AWSAccessCredentials + */ + name?: string; + /** + * true if this is the default credential to be used within this namespace + * @type {boolean} + * @memberof AWSAccessCredentials + */ + default?: boolean; + /** + * a whitelist of one or more buckets this key should access + * @type {Array} + * @memberof AWSAccessCredentials + */ + buckets?: Array; + /** + * Time when udf dependencies was created (rfc3339) + * @type {string} + * @memberof AWSAccessCredentials + */ + created_at?: string; + /** + * Time when udf dependencies was last updated (rfc3339) + * @type {string} + * @memberof AWSAccessCredentials + */ + updated_at?: string; +} +/** + * Type of activity logged + * @export + * @enum {string} + */ +export declare enum ActivityEventType { + ReadSchema = "read_schema", + MaxBufferSizes = "max_buffer_sizes", + NonEmptyDomain = "non_empty_domain", + QueryRead = "query_read", + QueryWrite = "query_write", + Create = "create", + Delete = "delete", + Register = "register", + Deregister = "deregister", + Udf = "udf", + ArrayMetadataGet = "array_metadata_get", + ArrayMetadataUpdate = "array_metadata_update", + EstimatedResultSizes = "estimated_result_sizes" +} +/** + * actions a user can take on an array + * @export + * @enum {string} + */ +export declare enum ArrayActions { + Read = "read", + Write = "write", + Edit = "edit", + ReadArrayLogs = "read_array_logs", + ReadArrayInfo = "read_array_info", + ReadArraySchema = "read_array_schema" +} +/** + * Actvity of an Array + * @export + * @interface ArrayActivityLog + */ +export interface ArrayActivityLog { + /** + * time event took place (RFC3339) + * @type {string} + * @memberof ArrayActivityLog + */ + event_at?: string; + /** + * + * @type {ActivityEventType} + * @memberof ArrayActivityLog + */ + action?: ActivityEventType; + /** + * User who performed action + * @type {string} + * @memberof ArrayActivityLog + */ + username?: string; + /** + * Bytes sent to client + * @type {number} + * @memberof ArrayActivityLog + */ + bytes_sent?: number; + /** + * Bytes recieved from client + * @type {number} + * @memberof ArrayActivityLog + */ + bytes_received?: number; + /** + * uuid of associated array task + * @type {string} + * @memberof ArrayActivityLog + */ + array_task_id?: string; + /** + * ranges for query + * @type {string} + * @memberof ArrayActivityLog + */ + query_ranges?: string; +} +/** + * Object including array info and pagination metadata + * @export + * @interface ArrayBrowserData + */ +export interface ArrayBrowserData { + /** + * Array Info + * @type {Array} + * @memberof ArrayBrowserData + */ + arrays?: Array; + /** + * + * @type {PaginationMetadata} + * @memberof ArrayBrowserData + */ + pagination_metadata?: PaginationMetadata; +} +/** + * Object for ui array tasks browser page + * @export + * @interface ArrayBrowserSidebar + */ +export interface ArrayBrowserSidebar { + /** + * list of all unique namespaces to display + * @type {Array} + * @memberof ArrayBrowserSidebar + */ + namespaces?: Array; + /** + * A count of \"all\" of category + * @type {number} + * @memberof ArrayBrowserSidebar + */ + result_count_for_all?: number; + /** + * A map that includes the result count by namespace + * @type {object} + * @memberof ArrayBrowserSidebar + */ + result_count_by_namespace?: object; +} +/** + * metadata of an array + * @export + * @interface ArrayInfo + */ +export interface ArrayInfo { + /** + * unique id of registered array + * @type {string} + * @memberof ArrayInfo + */ + id?: string; + /** + * + * @type {FileType} + * @memberof ArrayInfo + */ + file_type?: FileType; + /** + * map of file properties created for this array + * @type {{ [key: string]: string; }} + * @memberof ArrayInfo + */ + file_properties?: { + [key: string]: string; + }; + /** + * uri of array + * @type {string} + * @memberof ArrayInfo + */ + uri?: string; + /** + * namespace array is in + * @type {string} + * @memberof ArrayInfo + */ + namespace?: string; + /** + * size in bytes of array + * @type {number} + * @memberof ArrayInfo + */ + size?: number; + /** + * Datetime array was last accessed in UTC + * @type {string} + * @memberof ArrayInfo + */ + last_accessed?: string; + /** + * description of array + * @type {string} + * @memberof ArrayInfo + */ + description?: string; + /** + * name of array + * @type {string} + * @memberof ArrayInfo + */ + name?: string; + /** + * list of actions user is allowed to do on this array + * @type {Array} + * @memberof ArrayInfo + */ + allowed_actions?: Array; + /** + * list of pricing created for this array + * @type {Array} + * @memberof ArrayInfo + */ + pricing?: Array; + /** + * list of subscriptions created for this array + * @type {Array} + * @memberof ArrayInfo + */ + subscriptions?: Array; + /** + * logo (base64 encoded) for the array. Optional + * @type {string} + * @memberof ArrayInfo + */ + logo?: string; + /** + * the name of the access credentials to use. if unset, the default credentials will be used + * @type {string} + * @memberof ArrayInfo + */ + access_credentials_name?: string; + /** + * Array type (dense, key-value, sparse) + * @type {string} + * @memberof ArrayInfo + */ + type?: string; + /** + * number of unique namespaces this array is shared with + * @type {number} + * @memberof ArrayInfo + */ + share_count?: number; + /** + * Suggests if the array was shared to public by owner + * @type {boolean} + * @memberof ArrayInfo + */ + public_share?: boolean; + /** + * Depends on the namespace asking, denotes the existence of subscription of namespace to this array + * @type {boolean} + * @memberof ArrayInfo + */ + namespace_subscribed?: boolean; + /** + * uri for access through TileDB cloud + * @type {string} + * @memberof ArrayInfo + */ + tiledb_uri?: string; + /** + * optional tags for array + * @type {Array} + * @memberof ArrayInfo + */ + tags?: Array; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof ArrayInfo + */ + license_id?: string; + /** + * License text + * @type {string} + * @memberof ArrayInfo + */ + license_text?: string; + /** + * Suggests if the array is in read_only mode + * @type {boolean} + * @memberof ArrayInfo + */ + read_only?: boolean; +} +/** + * metadata of an array + * @export + * @interface ArrayInfoUpdate + */ +export interface ArrayInfoUpdate { + /** + * description of array + * @type {string} + * @memberof ArrayInfoUpdate + */ + description?: string; + /** + * description of array + * @type {string} + * @memberof ArrayInfoUpdate + */ + name?: string; + /** + * uri of array + * @type {string} + * @memberof ArrayInfoUpdate + */ + uri?: string; + /** + * + * @type {FileType} + * @memberof ArrayInfoUpdate + */ + file_type?: FileType; + /** + * map of file properties created for this array + * @type {{ [key: string]: string; }} + * @memberof ArrayInfoUpdate + */ + file_properties?: { + [key: string]: string; + }; + /** + * the name of the access credentials to use. if unset, the default credentials will be used + * @type {string} + * @memberof ArrayInfoUpdate + */ + access_credentials_name?: string; + /** + * logo (base64 encoded) for the array. Optional + * @type {string} + * @memberof ArrayInfoUpdate + */ + logo?: string; + /** + * optional tags for array + * @type {Array} + * @memberof ArrayInfoUpdate + */ + tags?: Array; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof ArrayInfoUpdate + */ + license_id?: string; + /** + * License text + * @type {string} + * @memberof ArrayInfoUpdate + */ + license_text?: string; +} +/** + * user\'s TileDB array metadata + * @export + * @interface ArrayMetadata + */ +export interface ArrayMetadata { + /** + * List of metadata entries + * @type {Array} + * @memberof ArrayMetadata + */ + ranges?: Array; +} +/** + * key/value pair representing an array metadata map entry + * @export + * @interface ArrayMetadataEntry + */ +export interface ArrayMetadataEntry { + /** + * + * @type {string} + * @memberof ArrayMetadataEntry + */ + key?: string; + /** + * + * @type {string} + * @memberof ArrayMetadataEntry + */ + type?: string; + /** + * + * @type {number} + * @memberof ArrayMetadataEntry + */ + value_num?: number; + /** + * + * @type {Array} + * @memberof ArrayMetadataEntry + */ + value?: Array; + /** + * + * @type {boolean} + * @memberof ArrayMetadataEntry + */ + del?: boolean; +} +/** + * Sample data from array + * @export + * @interface ArraySample + */ +export interface ArraySample { + /** + * + * @type {object} + * @memberof ArraySample + */ + data?: object; +} +/** + * ArraySchema during creation or retrieval + * @export + * @interface ArraySchema + */ +export interface ArraySchema { + /** + * URI of schema + * @type {string} + * @memberof ArraySchema + */ + uri?: string; + /** + * file format version + * @type {Array} + * @memberof ArraySchema + */ + version: Array; + /** + * + * @type {ArrayType} + * @memberof ArraySchema + */ + arrayType: ArrayType; + /** + * + * @type {Layout} + * @memberof ArraySchema + */ + tileOrder: Layout; + /** + * + * @type {Layout} + * @memberof ArraySchema + */ + cellOrder: Layout; + /** + * Capacity of array + * @type {number} + * @memberof ArraySchema + */ + capacity: number; + /** + * + * @type {FilterPipeline} + * @memberof ArraySchema + */ + coordsFilterPipeline: FilterPipeline; + /** + * + * @type {FilterPipeline} + * @memberof ArraySchema + */ + offsetFilterPipeline: FilterPipeline; + /** + * + * @type {Domain} + * @memberof ArraySchema + */ + domain: Domain; + /** + * Attributes of array + * @type {Array} + * @memberof ArraySchema + */ + attributes: Array; + /** + * True if the array allows coordinate duplicates. Applicable only to sparse arrays. + * @type {boolean} + * @memberof ArraySchema + */ + allowsDuplicates?: boolean; +} +/** + * details for sharing a given array + * @export + * @interface ArraySharing + */ +export interface ArraySharing { + /** + * List of permitted actions + * @type {Array} + * @memberof ArraySharing + */ + actions?: Array; + /** + * namespace being granted array access can be a user or organization + * @type {string} + * @memberof ArraySharing + */ + namespace?: string; + /** + * details on if the namespace is a organization or user + * @type {string} + * @memberof ArraySharing + */ + namespace_type?: string; +} +/** + * Synchronous Task to Run + * @export + * @interface ArrayTask + */ +export interface ArrayTask { + /** + * task id + * @type {string} + * @memberof ArrayTask + */ + id?: string; + /** + * Optional task name + * @type {string} + * @memberof ArrayTask + */ + name?: string; + /** + * Optional task description (Tasks purpose) + * @type {string} + * @memberof ArrayTask + */ + description?: string; + /** + * + * @type {ArrayInfo} + * @memberof ArrayTask + */ + array_metadata?: ArrayInfo; + /** + * + * @type {DomainArray} + * @memberof ArrayTask + */ + subarray?: DomainArray; + /** + * memory allocated to task in bytes + * @type {number} + * @memberof ArrayTask + */ + memory?: number; + /** + * millicpu allocated to task + * @type {number} + * @memberof ArrayTask + */ + cpu?: number; + /** + * namespace task is tied to + * @type {string} + * @memberof ArrayTask + */ + namespace?: string; + /** + * + * @type {ArrayTaskStatus} + * @memberof ArrayTask + */ + status?: ArrayTaskStatus; + /** + * Start time RFC3339 for job + * @type {string} + * @memberof ArrayTask + */ + start_time?: string; + /** + * Finish time RFC3339 for job + * @type {string} + * @memberof ArrayTask + */ + finish_time?: string; + /** + * Total accumulated for task in USD, example is $0.12 + * @type {number} + * @memberof ArrayTask + */ + cost?: number; + /** + * Total accumulated for egress task in USD, example is $0.12 + * @type {number} + * @memberof ArrayTask + */ + egress_cost?: number; + /** + * Cost accumulated for access task in USD, example is $0.12 + * @type {number} + * @memberof ArrayTask + */ + access_cost?: number; + /** + * + * @type {Querytype} + * @memberof ArrayTask + */ + query_type?: Querytype; + /** + * Optional actual code that is going to be executed + * @type {string} + * @memberof ArrayTask + */ + udf_code?: string; + /** + * Optional actual language used to express udf_code + * @type {string} + * @memberof ArrayTask + */ + udf_language?: string; + /** + * Optional actual sql query that is going to be executed + * @type {string} + * @memberof ArrayTask + */ + sql_query?: string; + /** + * + * @type {ArrayTaskType} + * @memberof ArrayTask + */ + type?: ArrayTaskType; + /** + * Array activity logs for task + * @type {Array} + * @memberof ArrayTask + */ + activity?: Array; + /** + * logs from array task + * @type {string} + * @memberof ArrayTask + */ + logs?: string; + /** + * duration in nanoseconds of an array task + * @type {number} + * @memberof ArrayTask + */ + duration?: number; + /** + * SQL queries or commands to run before main sql query + * @type {Array} + * @memberof ArrayTask + */ + sql_init_commands?: Array; + /** + * SQL query parameters + * @type {Array} + * @memberof ArrayTask + */ + sql_parameters?: Array; + /** + * + * @type {ResultFormat} + * @memberof ArrayTask + */ + result_format?: ResultFormat; + /** + * string representing the serialization format to use, i.e. cloudpickle version or arrow IPC verison + * @type {string} + * @memberof ArrayTask + */ + result_format_version?: string; +} +/** + * Object for ui array tasks browser page + * @export + * @interface ArrayTaskBrowserSidebar + */ +export interface ArrayTaskBrowserSidebar { + /** + * list of all unique organizations the user is part of that have array tasks + * @type {Array} + * @memberof ArrayTaskBrowserSidebar + */ + organizations?: Array; + /** + * A count of \"all\" + * @type {number} + * @memberof ArrayTaskBrowserSidebar + */ + result_count_for_all?: number; + /** + * A map that includes the result count by namespace + * @type {object} + * @memberof ArrayTaskBrowserSidebar + */ + result_count_by_namespace?: object; +} +/** + * Object including array tasks and metadata + * @export + * @interface ArrayTaskData + */ +export interface ArrayTaskData { + /** + * Array Tasks + * @type {Array} + * @memberof ArrayTaskData + */ + array_tasks?: Array; + /** + * + * @type {PaginationMetadata} + * @memberof ArrayTaskData + */ + pagination_metadata?: PaginationMetadata; +} +/** + * Array task stderr/stdout logs + * @export + * @interface ArrayTaskLog + */ +export interface ArrayTaskLog { + /** + * ID of associated task + * @type {string} + * @memberof ArrayTaskLog + */ + array_task_id?: string; + /** + * logs from array task + * @type {string} + * @memberof ArrayTaskLog + */ + logs?: string; +} +/** + * Status of array task + * @export + * @enum {string} + */ +export declare enum ArrayTaskStatus { + Failed = "FAILED", + Completed = "COMPLETED", + Running = "RUNNING" +} +/** + * Synchronous Task Type + * @export + * @enum {string} + */ +export declare enum ArrayTaskType { + Sql = "SQL", + Udf = "UDF", + Query = "QUERY", + GenericUdf = "GENERIC_UDF" +} +/** + * TileDB array type + * @export + * @enum {string} + */ +export declare enum ArrayType { + Dense = "dense", + Sparse = "sparse" +} +/** + * Attribute of array + * @export + * @interface Attribute + */ +export interface Attribute { + /** + * Attribute name + * @type {string} + * @memberof Attribute + */ + name: string; + /** + * + * @type {Datatype} + * @memberof Attribute + */ + type: Datatype; + /** + * + * @type {FilterPipeline} + * @memberof Attribute + */ + filterPipeline: FilterPipeline; + /** + * Attribute number of values per cell + * @type {number} + * @memberof Attribute + */ + cellValNum: number; + /** + * The default fill value + * @type {Array} + * @memberof Attribute + */ + fillValue?: Array; +} +/** + * Represents an attribute buffer header information + * @export + * @interface AttributeBufferHeader + */ +export interface AttributeBufferHeader { + /** + * Attribute name + * @type {string} + * @memberof AttributeBufferHeader + */ + name: string; + /** + * Number of bytes in the fixed-length attribute data buffer (offsets for var-len attributes) + * @type {number} + * @memberof AttributeBufferHeader + */ + fixedLenBufferSizeInBytes: number; + /** + * Number of bytes in the var-length attribute data buffer + * @type {number} + * @memberof AttributeBufferHeader + */ + varLenBufferSizeInBytes: number; +} +/** + * object representing buffer size of an attribute + * @export + * @interface AttributeBufferSize + */ +export interface AttributeBufferSize { + /** + * name of attribute + * @type {string} + * @memberof AttributeBufferSize + */ + attribute: string; + /** + * buffer size (in bytes) of offset buffer + * @type {number} + * @memberof AttributeBufferSize + */ + offsetBytes: number; + /** + * buffer size (in bytes) of data buffer + * @type {number} + * @memberof AttributeBufferSize + */ + dataBytes: number; +} +/** + * TileDB data type + * @export + * @enum {string} + */ +export declare enum Datatype { + Int32 = "INT32", + Int64 = "INT64", + Float32 = "FLOAT32", + Float64 = "FLOAT64", + Char = "CHAR", + Int8 = "INT8", + Uint8 = "UINT8", + Int16 = "INT16", + Uint16 = "UINT16", + Uint32 = "UINT32", + Uint64 = "UINT64", + StringAscii = "STRING_ASCII", + StringUtf8 = "STRING_UTF8", + StringUtf16 = "STRING_UTF16", + StringUtf32 = "STRING_UTF32", + StringUcs2 = "STRING_UCS2", + StringUcs4 = "STRING_UCS4", + Any = "ANY" +} +/** + * Dimension of array + * @export + * @interface Dimension + */ +export interface Dimension { + /** + * Dimension name + * @type {string} + * @memberof Dimension + */ + name?: string; + /** + * + * @type {Datatype} + * @memberof Dimension + */ + type: Datatype; + /** + * + * @type {DomainArray} + * @memberof Dimension + */ + domain: DomainArray; + /** + * Is tile extent null + * @type {boolean} + * @memberof Dimension + */ + nullTileExtent: boolean; + /** + * + * @type {DimensionTileExtent} + * @memberof Dimension + */ + tileExtent?: DimensionTileExtent; + /** + * + * @type {FilterPipeline} + * @memberof Dimension + */ + filterPipeline?: FilterPipeline; +} +/** + * A single, typed coordinate for a dimension + * @export + * @interface DimensionCoordinate + */ +export interface DimensionCoordinate { + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + int8?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + uint8?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + int16?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + uint16?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + int32?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + uint32?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + int64?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + uint64?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + float32?: number; + /** + * + * @type {number} + * @memberof DimensionCoordinate + */ + float64?: number; +} +/** + * Extent of tile + * @export + * @interface DimensionTileExtent + */ +export interface DimensionTileExtent { + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + int8?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + uint8?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + int16?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + uint16?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + int32?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + uint32?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + int64?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + uint64?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + float32?: number; + /** + * + * @type {number} + * @memberof DimensionTileExtent + */ + float64?: number; +} +/** + * Domain of array + * @export + * @interface Domain + */ +export interface Domain { + /** + * + * @type {Datatype} + * @memberof Domain + */ + type: Datatype; + /** + * + * @type {Layout} + * @memberof Domain + */ + tileOrder: Layout; + /** + * + * @type {Layout} + * @memberof Domain + */ + cellOrder: Layout; + /** + * Array of dimensions + * @type {Array} + * @memberof Domain + */ + dimensions: Array; +} +/** + * Domain object for an array of each type + * @export + * @interface DomainArray + */ +export interface DomainArray { + /** + * + * @type {Array} + * @memberof DomainArray + */ + int8?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + uint8?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + int16?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + uint16?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + int32?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + uint32?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + int64?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + uint64?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + float32?: Array; + /** + * + * @type {Array} + * @memberof DomainArray + */ + float64?: Array; +} +/** + * + * @export + * @interface Favorite + */ +export interface Favorite { + /** + * unique uuid of the favorite + * @type {string} + * @memberof Favorite + */ + id?: string; + /** + * + * @type {FavoriteType} + * @memberof Favorite + */ + object_type?: FavoriteType; + /** + * The namespace the favorite is in. It won\'t be persisted in DB + * @type {string} + * @memberof Favorite + */ + namespace?: string; + /** + * Name of the object. It wont be persisted in DB + * @type {string} + * @memberof Favorite + */ + name?: string; +} +/** + * List of values that FavoriteType can take + * @export + * @enum {string} + */ +export declare enum FavoriteType { + Array = "ARRAY" +} +/** + * + * @export + * @interface FavoriteUpdate + */ +export interface FavoriteUpdate { + /** + * + * @type {string} + * @memberof FavoriteUpdate + */ + name?: string; + /** + * + * @type {string} + * @memberof FavoriteUpdate + */ + namespace?: string; + /** + * + * @type {FavoriteType} + * @memberof FavoriteUpdate + */ + object_type?: FavoriteType; +} +/** + * File property assigned to a specific file (array) + * @export + * @enum {string} + */ +export declare enum FilePropertyName { + Image = "image", + Size = "size", + CodeBlock = "code_block" +} +/** + * File types represented as TileDB arrays + * @export + * @enum {string} + */ +export declare enum FileType { + Notebook = "notebook", + UserDefinedFunction = "user_defined_function" +} +/** + * Filter + * @export + * @interface Filter + */ +export interface Filter { + /** + * + * @type {FilterType} + * @memberof Filter + */ + type: FilterType; + /** + * + * @type {FilterData} + * @memberof Filter + */ + data?: FilterData; +} +/** + * Filter data + * @export + * @interface FilterData + */ +export interface FilterData { + /** + * + * @type {number} + * @memberof FilterData + */ + int8?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + uint8?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + int16?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + uint16?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + int32?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + uint32?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + int64?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + uint64?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + float32?: number; + /** + * + * @type {number} + * @memberof FilterData + */ + float64?: number; +} +/** + * TileDB filter option + * @export + * @enum {string} + */ +export declare enum FilterOption { + CompressionLevel = "COMPRESSION_LEVEL", + BitWidthMaxWindow = "BIT_WIDTH_MAX_WINDOW", + PositiveDeltaMaxWindow = "POSITIVE_DELTA_MAX_WINDOW" +} +/** + * One or more filters to apply + * @export + * @interface FilterPipeline + */ +export interface FilterPipeline { + /** + * + * @type {Array} + * @memberof FilterPipeline + */ + filters?: Array; +} +/** + * TileDB filter types + * @export + * @enum {string} + */ +export declare enum FilterType { + None = "FILTER_NONE", + Gzip = "FILTER_GZIP", + Zstd = "FILTER_ZSTD", + Lz4 = "FILTER_LZ4", + Rle = "FILTER_RLE", + Bzip2 = "FILTER_BZIP2", + DoubleDelta = "FILTER_DOUBLE_DELTA", + BitWidthReduction = "FILTER_BIT_WIDTH_REDUCTION", + Bitshuffle = "FILTER_BITSHUFFLE", + Byteshuffle = "FILTER_BYTESHUFFLE", + PositiveDelta = "FILTER_POSITIVE_DELTA" +} +/** + * User-defined function + * @export + * @interface GenericUDF + */ +export interface GenericUDF { + /** + * name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec + * @type {string} + * @memberof GenericUDF + */ + udf_info_name?: string; + /** + * + * @type {UDFLanguage} + * @memberof GenericUDF + */ + language?: UDFLanguage; + /** + * Type-specific version + * @type {string} + * @memberof GenericUDF + */ + version?: string; + /** + * Docker image name to use for udf + * @type {string} + * @memberof GenericUDF + */ + image_name?: string; + /** + * Type-specific executable text + * @type {string} + * @memberof GenericUDF + */ + exec?: string; + /** + * optional raw text to store of serialized function, used for showing in UI + * @type {string} + * @memberof GenericUDF + */ + exec_raw?: string; + /** + * Argument(s) to pass to udf function, tuple or list of args/kwargs which can be in native or json format + * @type {string} + * @memberof GenericUDF + */ + argument?: string; + /** + * + * @type {ResultFormat} + * @memberof GenericUDF + */ + result_format?: ResultFormat; + /** + * string representing the serialization format to use, i.e. cloudpickle version or arrow IPC verison + * @type {string} + * @memberof GenericUDF + */ + result_format_version?: string; + /** + * name of task, optional + * @type {string} + * @memberof GenericUDF + */ + task_name?: string; + /** + * store results for later retrieval + * @type {boolean} + * @memberof GenericUDF + */ + store_results?: boolean; +} +/** + * Password to update + * @export + * @interface InlineObject + */ +export interface InlineObject { + /** + * password + * @type {string} + * @memberof InlineObject + */ + password?: string; +} +/** + * + * @export + * @interface InlineResponse200 + */ +export interface InlineResponse200 { + /** + * string of stats from tiledb + * @type {string} + * @memberof InlineResponse200 + */ + stats?: string; +} +/** + * Invitations to share or collaborate + * @export + * @interface Invitation + */ +export interface Invitation { + /** + * Unique id of invitation added to magic link + * @type {string} + * @memberof Invitation + */ + id?: string; + /** + * + * @type {InvitationType} + * @memberof Invitation + */ + invitation_type?: InvitationType; + /** + * Namespace of the owner of the invitation (user or organization) + * @type {string} + * @memberof Invitation + */ + owner_namespace_uuid?: string; + /** + * Unique id of the user accepted the invitation + * @type {string} + * @memberof Invitation + */ + user_namespace_uuid?: string; + /** + * Unique id of the organization user accepted the invitation + * @type {string} + * @memberof Invitation + */ + organization_user_uuid?: string; + /** + * Name of the organization, does not persist in database + * @type {string} + * @memberof Invitation + */ + organization_name?: string; + /** + * + * @type {OrganizationRoles} + * @memberof Invitation + */ + organization_role?: OrganizationRoles; + /** + * Unique id of the array + * @type {string} + * @memberof Invitation + */ + array_uuid?: string; + /** + * Name of the array, does not persist in database + * @type {string} + * @memberof Invitation + */ + array_name?: string; + /** + * Email of the individual we send the invitation to + * @type {string} + * @memberof Invitation + */ + email?: string; + /** + * A comma separated list of ArrayActions or NamespaceActions + * @type {string} + * @memberof Invitation + */ + actions?: string; + /** + * + * @type {InvitationStatus} + * @memberof Invitation + */ + status?: InvitationStatus; + /** + * Datetime the invitation was created in UTC + * @type {string} + * @memberof Invitation + */ + created_at?: string; + /** + * Datetime the invitation is expected to expire in UTC + * @type {string} + * @memberof Invitation + */ + expires_at?: string; + /** + * Datetime the invitation was accepted in UTC + * @type {string} + * @memberof Invitation + */ + accepted_at?: string; +} +/** + * Encapsulates information regarding inviting people using email to share array, same permissions for all invitees + * @export + * @interface InvitationArrayShareEmail + */ +export interface InvitationArrayShareEmail { + /** + * List of permitted actions + * @type {Array} + * @memberof InvitationArrayShareEmail + */ + actions: Array; + /** + * + * @type {Array} + * @memberof InvitationArrayShareEmail + */ + invitee_email: Array; +} +/** + * Object including invitations and metadata + * @export + * @interface InvitationData + */ +export interface InvitationData { + /** + * List of invitations + * @type {Array} + * @memberof InvitationData + */ + invitations?: Array; + /** + * + * @type {PaginationMetadata} + * @memberof InvitationData + */ + pagination_metadata?: PaginationMetadata; +} +/** + * Encapsulates information regarding inviting people using email to join organization, same permissions for all invitees + * @export + * @interface InvitationOrganizationJoinEmail + */ +export interface InvitationOrganizationJoinEmail { + /** + * List of permitted actions + * @type {Array} + * @memberof InvitationOrganizationJoinEmail + */ + actions?: Array; + /** + * + * @type {OrganizationRoles} + * @memberof InvitationOrganizationJoinEmail + */ + organization_role: OrganizationRoles; + /** + * + * @type {Array} + * @memberof InvitationOrganizationJoinEmail + */ + invitee_email: Array; +} +/** + * List of values that InvitationStatus can take + * @export + * @enum {string} + */ +export declare enum InvitationStatus { + Pending = "PENDING", + Accepted = "ACCEPTED" +} +/** + * List of values that InvitationType can take + * @export + * @enum {string} + */ +export declare enum InvitationType { + ArrayShare = "ARRAY_SHARE", + JoinOrganization = "JOIN_ORGANIZATION" +} +/** + * Information related to last access of an array + * @export + * @interface LastAccessedArray + */ +export interface LastAccessedArray { + /** + * unique id of array + * @type {string} + * @memberof LastAccessedArray + */ + array_id?: string; + /** + * name of the array + * @type {string} + * @memberof LastAccessedArray + */ + array_name?: string; + /** + * namespace of a user or organization + * @type {string} + * @memberof LastAccessedArray + */ + namespace?: string; + /** + * timestamp (epoch milliseconds) array is last accessed + * @type {number} + * @memberof LastAccessedArray + */ + accessed_time?: number; + /** + * + * @type {ActivityEventType} + * @memberof LastAccessedArray + */ + access_type?: ActivityEventType; +} +/** + * Layout of array + * @export + * @enum {string} + */ +export declare enum Layout { + RowMajor = "row-major", + ColMajor = "col-major", + GlobalOrder = "global-order", + Unordered = "unordered" +} +/** + * a list of max buffer sizes, one per attribute + * @export + * @interface MaxBufferSizes + */ +export interface MaxBufferSizes { + /** + * + * @type {Array} + * @memberof MaxBufferSizes + */ + maxBufferSizes?: Array; +} +/** + * Represents an open array + * @export + * @interface ModelArray + */ +export interface ModelArray { + /** + * timestamp (epoch milliseconds) array is opened at + * @type {number} + * @memberof ModelArray + */ + timestamp: number; + /** + * + * @type {Querytype} + * @memberof ModelArray + */ + queryType: Querytype; + /** + * Array uri + * @type {string} + * @memberof ModelArray + */ + uri: string; +} +/** + * + * @export + * @interface ModelError + */ +export interface ModelError { + /** + * + * @type {number} + * @memberof ModelError + */ + code?: number; + /** + * + * @type {string} + * @memberof ModelError + */ + message?: string; + /** + * + * @type {string} + * @memberof ModelError + */ + request_id?: string; +} +/** + * User-defined function + * @export + * @interface MultiArrayUDF + */ +export interface MultiArrayUDF { + /** + * name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec + * @type {string} + * @memberof MultiArrayUDF + */ + udf_info_name?: string; + /** + * + * @type {UDFLanguage} + * @memberof MultiArrayUDF + */ + language?: UDFLanguage; + /** + * Type-specific version + * @type {string} + * @memberof MultiArrayUDF + */ + version?: string; + /** + * Docker image name to use for udf + * @type {string} + * @memberof MultiArrayUDF + */ + image_name?: string; + /** + * Type-specific executable text + * @type {string} + * @memberof MultiArrayUDF + */ + exec?: string; + /** + * optional raw text to store of serialized function, used for showing in UI + * @type {string} + * @memberof MultiArrayUDF + */ + exec_raw?: string; + /** + * + * @type {ResultFormat} + * @memberof MultiArrayUDF + */ + result_format?: ResultFormat; + /** + * string representing the serialization format to use, i.e. cloudpickle version or arrow IPC verison + * @type {string} + * @memberof MultiArrayUDF + */ + result_format_version?: string; + /** + * name of task, optional + * @type {string} + * @memberof MultiArrayUDF + */ + task_name?: string; + /** + * Argument(s) to pass to udf function, tuple or list of args/kwargs which can be in native or json format + * @type {string} + * @memberof MultiArrayUDF + */ + argument?: string; + /** + * store results for later retrieval + * @type {boolean} + * @memberof MultiArrayUDF + */ + store_results?: boolean; + /** + * + * @type {QueryRanges} + * @memberof MultiArrayUDF + */ + ranges?: QueryRanges; + /** + * + * @type {UDFSubarray} + * @memberof MultiArrayUDF + */ + subarray?: UDFSubarray; + /** + * List of buffers to fetch (attributes + dimensions). Deprecated please set arrays with UDFArrayDetails + * @type {Array} + * @memberof MultiArrayUDF + */ + buffers?: Array; + /** + * Array ranges/buffer into to run UDF on + * @type {Array} + * @memberof MultiArrayUDF + */ + arrays?: Array; +} +/** + * actions a user can take on an organization + * @export + * @enum {string} + */ +export declare enum NamespaceActions { + Read = "read", + Write = "write", + Create = "create", + Delete = "delete", + Edit = "edit", + ReadArrayLogs = "read_array_logs", + ReadJobLogs = "read_job_logs", + ReadObjectLogs = "read_object_logs", + RunJob = "run_job", + DeleteOrganization = "delete_organization", + EditOrganization = "edit_organization", + EditBilling = "edit_billing" +} +/** + * object representing a non-empty domain + * @export + * @interface NonEmptyDomain + */ +export interface NonEmptyDomain { + /** + * + * @type {DomainArray} + * @memberof NonEmptyDomain + */ + nonEmptyDomain: DomainArray; + /** + * Is non-empty domain really empty? + * @type {boolean} + * @memberof NonEmptyDomain + */ + isEmpty: boolean; +} +/** + * Status details of a notebook server + * @export + * @interface NotebookStatus + */ +export interface NotebookStatus { + /** + * namespace of notebook + * @type {string} + * @memberof NotebookStatus + */ + namespace?: string; + /** + * duration notebook has been running in seconds + * @type {number} + * @memberof NotebookStatus + */ + uptime?: number; + /** + * current cpu usage in millicpu + * @type {number} + * @memberof NotebookStatus + */ + cpu_usage?: number; + /** + * memory usage in bytes + * @type {number} + * @memberof NotebookStatus + */ + memory_usage?: number; + /** + * memory allocated to notebook server in bytes + * @type {number} + * @memberof NotebookStatus + */ + memory_limit?: number; + /** + * millicpu allocated to notebook server + * @type {number} + * @memberof NotebookStatus + */ + cpu_count?: number; +} +/** + * Organization + * @export + * @interface Organization + */ +export interface Organization { + /** + * unique id of organization + * @type {string} + * @memberof Organization + */ + id?: string; + /** + * + * @type {OrganizationRoles} + * @memberof Organization + */ + role?: OrganizationRoles; + /** + * organization name must be unique + * @type {string} + * @memberof Organization + */ + name: string; + /** + * Datetime organization was created in UTC + * @type {string} + * @memberof Organization + */ + created_at?: string; + /** + * Datetime organization was updated in UTC + * @type {string} + * @memberof Organization + */ + updated_at?: string; + /** + * Organization logo + * @type {string} + * @memberof Organization + */ + logo?: string; + /** + * Organization description + * @type {string} + * @memberof Organization + */ + description?: string; + /** + * + * @type {Array} + * @memberof Organization + */ + users?: Array; + /** + * list of actions user is allowed to do on this organization + * @type {Array} + * @memberof Organization + */ + allowed_actions?: Array; + /** + * number of registered arrays for this organization + * @type {number} + * @memberof Organization + */ + num_of_arrays?: number; + /** + * List of extra/optional/beta features to enable for namespace + * @type {Array} + * @memberof Organization + */ + enabled_features?: Array; + /** + * A notice that the user has an unpaid subscription + * @type {boolean} + * @memberof Organization + */ + unpaid_subscription?: boolean; + /** + * default s3 path to store newly created notebooks + * @type {string} + * @memberof Organization + */ + default_s3_path?: string; + /** + * Default s3 path credentials name is the credentials name to use along with default_s3_path + * @type {string} + * @memberof Organization + */ + default_s3_path_credentials_name?: string; + /** + * Denotes that the organization is able to apply pricing to arrays by means of Stripe Connect + * @type {boolean} + * @memberof Organization + */ + stripe_connect?: boolean; +} +/** + * role user has in organization + * @export + * @enum {string} + */ +export declare enum OrganizationRoles { + Owner = "owner", + Admin = "admin", + ReadWrite = "read_write", + ReadOnly = "read_only" +} +/** + * user in an organization + * @export + * @interface OrganizationUser + */ +export interface OrganizationUser { + /** + * unique id of user + * @type {string} + * @memberof OrganizationUser + */ + user_id?: string; + /** + * unique id of organization + * @type {string} + * @memberof OrganizationUser + */ + organization_id?: string; + /** + * username for user + * @type {string} + * @memberof OrganizationUser + */ + username?: string; + /** + * name of organization + * @type {string} + * @memberof OrganizationUser + */ + organization_name?: string; + /** + * + * @type {OrganizationRoles} + * @memberof OrganizationUser + */ + role?: OrganizationRoles; + /** + * list of actions user is allowed to do on this organization + * @type {Array} + * @memberof OrganizationUser + */ + allowed_actions?: Array; +} +/** + * + * @export + * @interface PaginationMetadata + */ +export interface PaginationMetadata { + /** + * pagination offset + * @type {number} + * @memberof PaginationMetadata + */ + page?: number; + /** + * pagination limit + * @type {number} + * @memberof PaginationMetadata + */ + per_page?: number; + /** + * number of total pages with current limit + * @type {number} + * @memberof PaginationMetadata + */ + total_pages?: number; + /** + * number of total available items + * @type {number} + * @memberof PaginationMetadata + */ + total_items?: number; +} +/** + * Pricing created by converting an array to product + * @export + * @interface Pricing + */ +export interface Pricing { + /** + * Unique id of plan as defined by Stripe + * @type {string} + * @memberof Pricing + */ + id?: string; + /** + * Unique id of registered array + * @type {string} + * @memberof Pricing + */ + array_uuid?: string; + /** + * Name of pricing + * @type {string} + * @memberof Pricing + */ + pricing_name?: string; + /** + * + * @type {PricingType} + * @memberof Pricing + */ + pricing_type?: PricingType; + /** + * Name of product + * @type {string} + * @memberof Pricing + */ + product_name?: string; + /** + * Extra information about a product which will appear on the credit card statement of the customer + * @type {string} + * @memberof Pricing + */ + product_statement_descriptor?: string; + /** + * + * @type {PricingUnitLabel} + * @memberof Pricing + */ + product_unit_label?: PricingUnitLabel; + /** + * + * @type {PricingCurrency} + * @memberof Pricing + */ + currency?: PricingCurrency; + /** + * + * @type {PricingAggregateUsage} + * @memberof Pricing + */ + aggregate_usage?: PricingAggregateUsage; + /** + * + * @type {PricingInterval} + * @memberof Pricing + */ + interval?: PricingInterval; + /** + * Group of n product unit labels + * @type {number} + * @memberof Pricing + */ + divided_by?: number; + /** + * Price in cents (decimal) per unitlabel + * @type {number} + * @memberof Pricing + */ + charge?: number; + /** + * If pricing is activated + * @type {boolean} + * @memberof Pricing + */ + activated?: boolean; +} +/** + * Specifies a usage aggregation strategy for pricings of usage_type=metered + * @export + * @enum {string} + */ +export declare enum PricingAggregateUsage { + Sum = "sum" +} +/** + * Currency of pricing + * @export + * @enum {string} + */ +export declare enum PricingCurrency { + Usd = "USD" +} +/** + * Interval for pricing + * @export + * @enum {string} + */ +export declare enum PricingInterval { + Month = "month" +} +/** + * Pricing types + * @export + * @enum {string} + */ +export declare enum PricingType { + Egress = "egress", + Access = "access" +} +/** + * Unit label + * @export + * @enum {string} + */ +export declare enum PricingUnitLabel { + Byte = "byte", + Second = "second" +} +/** + * Query parameter to get array metadatas + * @export + * @enum {string} + */ +export declare enum PublicShareFilter { + Exclude = "exclude", + Only = "only" +} +/** + * + * @export + * @interface Query + */ +export interface Query { + /** + * + * @type {Querytype} + * @memberof Query + */ + type: Querytype; + /** + * + * @type {Layout} + * @memberof Query + */ + layout: Layout; + /** + * + * @type {Querystatus} + * @memberof Query + */ + status: Querystatus; + /** + * List of attribute buffer headers + * @type {Array} + * @memberof Query + */ + attributeBufferHeaders: Array; + /** + * + * @type {Writer} + * @memberof Query + */ + writer?: Writer; + /** + * + * @type {QueryReader} + * @memberof Query + */ + reader?: QueryReader; + /** + * + * @type {any} + * @memberof Query + */ + array: any; + /** + * Total number of bytes in fixed size attribute buffers. + * @type {number} + * @memberof Query + */ + totalFixedLengthBufferBytes: number; + /** + * Total number of bytes in variable size attribute buffers. + * @type {number} + * @memberof Query + */ + totalVarLenBufferBytes: number; +} +/** + * Query returning results as json + * @export + * @interface QueryJson + */ +export interface QueryJson { + /** + * + * @type {QueryRanges} + * @memberof QueryJson + */ + query_ranges?: QueryRanges; + /** + * List of fields to return data from, empty means return data for all fields + * @type {Array} + * @memberof QueryJson + */ + fields?: Array; +} +/** + * Subarray bounds to query + * @export + * @interface QueryRanges + */ +export interface QueryRanges { + /** + * + * @type {Layout} + * @memberof QueryRanges + */ + layout?: Layout; + /** + * List of ranges, + * @type {Array>} + * @memberof QueryRanges + */ + ranges?: Array>; +} +/** + * Read struct (can\'t be called reader due to class name conflict) + * @export + * @interface QueryReader + */ +export interface QueryReader { + /** + * + * @type {Layout} + * @memberof QueryReader + */ + layout?: Layout; + /** + * + * @type {Subarray} + * @memberof QueryReader + */ + subarray?: Subarray; + /** + * + * @type {ReadState} + * @memberof QueryReader + */ + readState?: ReadState; + /** + * The offsets format (bytes or elements) to be used. + * @type {string} + * @memberof QueryReader + */ + varOffsetsMode?: string; + /** + * True if an extra element will be added to the end of the offsets buffer. + * @type {boolean} + * @memberof QueryReader + */ + varOffsetsAddExtraElement?: boolean; + /** + * The offsets bitsize (32 or 64) to be used. + * @type {number} + * @memberof QueryReader + */ + varOffsetsBitsize?: number; +} +/** + * Status of query + * @export + * @enum {string} + */ +export declare enum Querystatus { + Failed = "FAILED", + Completed = "COMPLETED", + Inprogress = "INPROGRESS", + Incomplete = "INCOMPLETE", + Uninitialized = "UNINITIALIZED" +} +/** + * Type of query + * @export + * @enum {string} + */ +export declare enum Querytype { + Read = "READ", + Write = "WRITE" +} +/** + * state for reads + * @export + * @interface ReadState + */ +export interface ReadState { + /** + * True if the reader has been initialized. + * @type {boolean} + * @memberof ReadState + */ + initialized?: boolean; + /** + * True if the query produced results that could not fit in some buffer. + * @type {boolean} + * @memberof ReadState + */ + overflowed?: boolean; + /** + * True if the current subarray partition is unsplittable. + * @type {boolean} + * @memberof ReadState + */ + unsplittable?: boolean; + /** + * + * @type {SubarrayPartitioner} + * @memberof ReadState + */ + subarrayPartitioner?: SubarrayPartitioner; +} +/** + * Results type + * @export + * @enum {string} + */ +export declare enum ResultFormat { + Native = "native", + Json = "json", + Arrow = "arrow" +} +/** + * Parameters for running sql query + * @export + * @interface SQLParameters + */ +export interface SQLParameters { + /** + * name of task, optional + * @type {string} + * @memberof SQLParameters + */ + name?: string; + /** + * query to run + * @type {string} + * @memberof SQLParameters + */ + query?: string; + /** + * Output array uri + * @type {string} + * @memberof SQLParameters + */ + output_uri?: string; + /** + * store results for later retrieval + * @type {boolean} + * @memberof SQLParameters + */ + store_results?: boolean; + /** + * + * @type {ResultFormat} + * @memberof SQLParameters + */ + result_format?: ResultFormat; + /** + * string representing the serialization format to use, i.e. cloudpickle version or arrow IPC verisonn + * @type {string} + * @memberof SQLParameters + */ + result_format_version?: string; + /** + * Queries or commands to run before main query + * @type {Array} + * @memberof SQLParameters + */ + init_commands?: Array; + /** + * SQL query parameters + * @type {Array} + * @memberof SQLParameters + */ + parameters?: Array; +} +/** + * Single sign on provider + * @export + * @enum {string} + */ +export declare enum SSOProvider { + Github = "github", + Google = "google", + Stripe = "stripe" +} +/** + * A Subarray + * @export + * @interface Subarray + */ +export interface Subarray { + /** + * + * @type {Layout} + * @memberof Subarray + */ + layout?: Layout; + /** + * List of 1D ranges, one per dimension + * @type {Array} + * @memberof Subarray + */ + ranges?: Array; +} +/** + * The subarray partitioner + * @export + * @interface SubarrayPartitioner + */ +export interface SubarrayPartitioner { + /** + * + * @type {Subarray} + * @memberof SubarrayPartitioner + */ + subarray?: Subarray; + /** + * Result size budget (in bytes) for all attributes. + * @type {Array} + * @memberof SubarrayPartitioner + */ + budget?: Array; + /** + * + * @type {SubarrayPartitionerCurrent} + * @memberof SubarrayPartitioner + */ + current?: SubarrayPartitionerCurrent; + /** + * + * @type {SubarrayPartitionerState} + * @memberof SubarrayPartitioner + */ + state?: SubarrayPartitionerState; + /** + * The memory budget for the fixed-sized attributes and the offsets of the var-sized attributes + * @type {number} + * @memberof SubarrayPartitioner + */ + memoryBudget?: number; + /** + * The memory budget for the var-sized attributes + * @type {number} + * @memberof SubarrayPartitioner + */ + memoryBudgetVar?: number; +} +/** + * The current partition info + * @export + * @interface SubarrayPartitionerCurrent + */ +export interface SubarrayPartitionerCurrent { + /** + * + * @type {Subarray} + * @memberof SubarrayPartitionerCurrent + */ + subarray?: Subarray; + /** + * PartitionInfo start + * @type {number} + * @memberof SubarrayPartitionerCurrent + */ + start?: number; + /** + * PartitionInfo end + * @type {number} + * @memberof SubarrayPartitionerCurrent + */ + end?: number; + /** + * PartitionInfo splitMultiRange + * @type {boolean} + * @memberof SubarrayPartitionerCurrent + */ + splitMultiRange?: boolean; +} +/** + * The state information for the remaining partitions to be produced + * @export + * @interface SubarrayPartitionerState + */ +export interface SubarrayPartitionerState { + /** + * State start + * @type {number} + * @memberof SubarrayPartitionerState + */ + start?: number; + /** + * State end + * @type {number} + * @memberof SubarrayPartitionerState + */ + end?: number; + /** + * State singleRange + * @type {Array} + * @memberof SubarrayPartitionerState + */ + singleRange?: Array; + /** + * State multiRange + * @type {Array} + * @memberof SubarrayPartitionerState + */ + multiRange?: Array; +} +/** + * A set of 1D ranges for a subarray + * @export + * @interface SubarrayRanges + */ +export interface SubarrayRanges { + /** + * + * @type {Datatype} + * @memberof SubarrayRanges + */ + type?: Datatype; + /** + * True if the range is the default range + * @type {boolean} + * @memberof SubarrayRanges + */ + hasDefaultRange?: boolean; + /** + * The bytes of the ranges + * @type {Array} + * @memberof SubarrayRanges + */ + buffer?: Array; +} +/** + * Subscription of a user (customer) to another user\'s arrays + * @export + * @interface Subscription + */ +export interface Subscription { + /** + * Unique id of subscription as defined by Stripe + * @type {string} + * @memberof Subscription + */ + id?: string; + /** + * Unique id of the array (product) owner + * @type {string} + * @memberof Subscription + */ + owner_namespace_uuid?: string; + /** + * Unique id of the array (product) user (customer) + * @type {string} + * @memberof Subscription + */ + customer_namespace_uuid?: string; + /** + * list of pricing used by this subscription + * @type {Array} + * @memberof Subscription + */ + pricing?: Array; +} +/** + * user\'s TileDB config + * @export + * @interface TileDBConfig + */ +export interface TileDBConfig { + /** + * + * @type {{ [key: string]: string; }} + * @memberof TileDBConfig + */ + configs?: { + [key: string]: string; + }; +} +/** + * A api token and its metadata + * @export + * @interface Token + */ +export interface Token { + /** + * A api token + * @type {string} + * @memberof Token + */ + token?: string; + /** + * Name of token to revoke + * @type {string} + * @memberof Token + */ + name?: string; + /** + * datetime the token was created at + * @type {string} + * @memberof Token + */ + issued_at?: string; + /** + * datetime the token when token will expire + * @type {string} + * @memberof Token + */ + expires_at?: string; + /** + * Optional scope to limit token, defaults to all permissions, current supported values are password_reset or * + * @type {string} + * @memberof Token + */ + scope?: string; +} +/** + * A request from a user for an api token + * @export + * @interface TokenRequest + */ +export interface TokenRequest { + /** + * Expiration date for token, if empty token defaults to 30 minutes + * @type {string} + * @memberof TokenRequest + */ + expires?: string; + /** + * Optional name for token, if the name already exists for the user it will be auto incremented (i.e. myToken-1) + * @type {string} + * @memberof TokenRequest + */ + name?: string; + /** + * Optional scope to limit token, defaults to all permissions, current supported values are password_reset or * + * @type {string} + * @memberof TokenRequest + */ + scope?: string; +} +/** + * actions a user can take on an udf + * @export + * @enum {string} + */ +export declare enum UDFActions { + FetchUdf = "fetch_udf", + ShareUdf = "share_udf" +} +/** + * Contains array details for multi-array query including uri, ranges buffers + * @export + * @interface UDFArrayDetails + */ +export interface UDFArrayDetails { + /** + * array to set ranges and buffers on, must be in tiledb:// format + * @type {string} + * @memberof UDFArrayDetails + */ + uri?: string; + /** + * + * @type {QueryRanges} + * @memberof UDFArrayDetails + */ + ranges?: QueryRanges; + /** + * List of buffers to fetch (attributes + dimensions) + * @type {Array} + * @memberof UDFArrayDetails + */ + buffers?: Array; +} +/** + * Defines a set of images related to a specific name + * @export + * @interface UDFImage + */ +export interface UDFImage { + /** + * Unique id of set of images + * @type {string} + * @memberof UDFImage + */ + id?: string; + /** + * name of udf + * @type {string} + * @memberof UDFImage + */ + name?: string; + /** + * + * @type {UDFLanguage} + * @memberof UDFImage + */ + language?: UDFLanguage; +} +/** + * Defines an image that belongs to a set of images having a version + * @export + * @interface UDFImageVersion + */ +export interface UDFImageVersion { + /** + * Unique id of a versioned image + * @type {string} + * @memberof UDFImageVersion + */ + id?: string; + /** + * name of UDFImageVersion + * @type {string} + * @memberof UDFImageVersion + */ + name?: string; + /** + * Unique id of the udf image set + * @type {string} + * @memberof UDFImageVersion + */ + udf_image_uuid?: string; + /** + * Uri of docker image related to current entry + * @type {string} + * @memberof UDFImageVersion + */ + docker_image?: string; + /** + * Image-specific version + * @type {number} + * @memberof UDFImageVersion + */ + version?: number; + /** + * If current image is default version + * @type {boolean} + * @memberof UDFImageVersion + */ + default?: boolean; + /** + * If current image is latest version + * @type {boolean} + * @memberof UDFImageVersion + */ + latest?: boolean; +} +/** + * User-defined function that can persist in db, used and shared multiple times + * @export + * @interface UDFInfo + */ +export interface UDFInfo { + /** + * Unique id of udf + * @type {string} + * @memberof UDFInfo + */ + id?: string; + /** + * name of udf + * @type {string} + * @memberof UDFInfo + */ + name?: string; + /** + * + * @type {UDFLanguage} + * @memberof UDFInfo + */ + language?: UDFLanguage; + /** + * + * @type {UDFType} + * @memberof UDFInfo + */ + type?: UDFType; + /** + * Markdown readme of udfs + * @type {string} + * @memberof UDFInfo + */ + readme?: string; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof UDFInfo + */ + license_id?: string; + /** + * License text + * @type {string} + * @memberof UDFInfo + */ + license_text?: string; + /** + * optional tags for udf + * @type {Array} + * @memberof UDFInfo + */ + tags?: Array; +} +/** + * User-defined function that can persist in db, used and shared multiple times + * @export + * @interface UDFInfoUpdate + */ +export interface UDFInfoUpdate { + /** + * name of udf + * @type {string} + * @memberof UDFInfoUpdate + */ + name?: string; + /** + * + * @type {UDFLanguage} + * @memberof UDFInfoUpdate + */ + language?: UDFLanguage; + /** + * Type-specific version + * @type {string} + * @memberof UDFInfoUpdate + */ + version?: string; + /** + * Docker image name to use for udf + * @type {string} + * @memberof UDFInfoUpdate + */ + image_name?: string; + /** + * + * @type {UDFType} + * @memberof UDFInfoUpdate + */ + type?: UDFType; + /** + * Type-specific executable text + * @type {string} + * @memberof UDFInfoUpdate + */ + exec?: string; + /** + * optional raw text to store of serialized function, used for showing in UI + * @type {string} + * @memberof UDFInfoUpdate + */ + exec_raw?: string; + /** + * Markdown readme of udfs + * @type {string} + * @memberof UDFInfoUpdate + */ + readme?: string; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof UDFInfoUpdate + */ + license_id?: string; + /** + * License text + * @type {string} + * @memberof UDFInfoUpdate + */ + license_text?: string; + /** + * optional tags for udf + * @type {Array} + * @memberof UDFInfoUpdate + */ + tags?: Array; +} +/** + * UDF Type + * @export + * @enum {string} + */ +export declare enum UDFLanguage { + Python = "python", + R = "r" +} +/** + * details for sharing a given udf + * @export + * @interface UDFSharing + */ +export interface UDFSharing { + /** + * List of permitted actions + * @type {Array} + * @memberof UDFSharing + */ + actions?: Array; + /** + * namespace being granted array access can be a user or organization + * @type {string} + * @memberof UDFSharing + */ + namespace?: string; + /** + * details on if the namespace is a organization or user + * @type {string} + * @memberof UDFSharing + */ + namespace_type?: string; +} +/** + * Subarray bounds to query for a UDF to operate on + * @export + * @interface UDFSubarray + */ +export interface UDFSubarray { + /** + * + * @type {Layout} + * @memberof UDFSubarray + */ + layout?: Layout; + /** + * List of ranges, + * @type {Array} + * @memberof UDFSubarray + */ + ranges?: Array; +} +/** + * A dimension range to query + * @export + * @interface UDFSubarrayRange + */ +export interface UDFSubarrayRange { + /** + * The dimension index + * @type {number} + * @memberof UDFSubarrayRange + */ + dimension_id?: number; + /** + * + * @type {DimensionCoordinate} + * @memberof UDFSubarrayRange + */ + range_start?: DimensionCoordinate; + /** + * + * @type {DimensionCoordinate} + * @memberof UDFSubarrayRange + */ + range_end?: DimensionCoordinate; +} +/** + * UDF Type + * @export + * @enum {string} + */ +export declare enum UDFType { + SingleArray = "single_array", + Generic = "generic" +} +/** + * User + * @export + * @interface User + */ +export interface User { + /** + * unique id of user + * @type {string} + * @memberof User + */ + id?: string; + /** + * username must be unique + * @type {string} + * @memberof User + */ + username: string; + /** + * password + * @type {string} + * @memberof User + */ + password?: string; + /** + * the user\'s full, real name + * @type {string} + * @memberof User + */ + name?: string; + /** + * the user\'s email + * @type {string} + * @memberof User + */ + email?: string; + /** + * user\'s email is validated to be correct + * @type {boolean} + * @memberof User + */ + is_valid_email?: boolean; + /** + * Denotes that the user is able to apply pricing to arrays by means of Stripe Connect + * @type {boolean} + * @memberof User + */ + stripe_connect?: boolean; + /** + * the user\'s company + * @type {string} + * @memberof User + */ + company?: string; + /** + * the user\'s logo + * @type {string} + * @memberof User + */ + logo?: string; + /** + * when the user last logged in (set by the server) + * @type {string} + * @memberof User + */ + last_activity_date?: string; + /** + * + * @type {string} + * @memberof User + */ + timezone?: string; + /** + * Array of organizations a user is part of and their roles + * @type {Array} + * @memberof User + */ + organizations?: Array; + /** + * list of actions user is allowed to do on this organization + * @type {Array} + * @memberof User + */ + allowed_actions?: Array; + /** + * List of extra/optional/beta features to enable for namespace + * @type {Array} + * @memberof User + */ + enabled_features?: Array; + /** + * A notice that the user has an unpaid subscription + * @type {boolean} + * @memberof User + */ + unpaid_subscription?: boolean; + /** + * default s3 path to store newly created notebooks + * @type {string} + * @memberof User + */ + default_s3_path?: string; + /** + * Default s3 path credentials name is the credentials name to use along with default_s3_path + * @type {string} + * @memberof User + */ + default_s3_path_credentials_name?: string; + /** + * Override the default namespace charged for actions when no namespace is specified + * @type {string} + * @memberof User + */ + default_namespace_charged?: string; +} +/** + * + * @export + * @interface Writer + */ +export interface Writer { + /** + * + * @type {boolean} + * @memberof Writer + */ + checkCoordDups?: boolean; + /** + * + * @type {boolean} + * @memberof Writer + */ + checkCoordOOB?: boolean; + /** + * + * @type {boolean} + * @memberof Writer + */ + dedupCoords?: boolean; + /** + * + * @type {DomainArray} + * @memberof Writer + */ + subarray?: DomainArray; +} +/** + * ArrayApi - axios parameter creator + * @export + */ +export declare const ArrayApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * get array activity logs + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) + * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) + * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated + * @param {string} [taskId] Array task id To filter activity to + * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arrayActivityLog: (namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any) => Promise; + /** + * Fetch a list of all arrays that are owned directly by user or user\'s organizations + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserOwnedGet: (page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any) => Promise; + /** + * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserOwnedSidebarGet: (options?: any) => Promise; + /** + * Fetch a list of all arrays that have been shared publically + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserPublicGet: (page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any) => Promise; + /** + * Fetch a sidebar of all arrays that have been shared publically + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserPublicSidebarGet: (options?: any) => Promise; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserSharedGet: (page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any) => Promise; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserSharedSidebarGet: (options?: any) => Promise; + /** + * consolidate an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consolidateArray: (namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any) => Promise; + /** + * create a array schema at a specified URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {ArraySchema} arraySchema ArraySchema being created + * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createArray: (namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any) => Promise; + /** + * delete a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteArray: (namespace: string, array: string, contentType: string, options?: any) => Promise; + /** + * deregister a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deregisterArray: (namespace: string, array: string, options?: any) => Promise; + /** + * get all array metadata user has access to + * @param {string} [publicShare] Public share values can be one of exclude, only + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllArrayMetadata: (publicShare?: string, options?: any) => Promise; + /** + * get an ArraySchema using a url encoded uri + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArray: (namespace: string, array: string, contentType: string, options?: any) => Promise; + /** + * get the max buffer sizes of an array for a subarray + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} subarray CSV string of subarray to get max buffer sizes for + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMaxBufferSizes: (namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any) => Promise; + /** + * get metadata from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [length] (optional) limit character length of returned values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMetaDataJson: (namespace: string, array: string, length?: number, options?: any) => Promise; + /** + * get metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMetadata: (namespace: string, array: string, options?: any) => Promise; + /** + * get the non empty domain of an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomain: (namespace: string, array: string, contentType: string, xPayer?: string, options?: any) => Promise; + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomainJson: (namespace: string, array: string, options?: any) => Promise; + /** + * get an sample set of data from the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [samples] Number of sample results to return + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraySampleData: (namespace: string, array: string, samples?: number, options?: any) => Promise; + /** + * Get all sharing details of the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraySharingPolicies: (namespace: string, array: string, options?: any) => Promise; + /** + * get metadata on all arrays in a namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraysInNamespace: (namespace: string, options?: any) => Promise; + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLastAccessedArrays: (options?: any) => Promise; + /** + * register an array at a specified URI registered to the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerArray: (namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any) => Promise; + /** + * Share an array with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareArray: (namespace: string, array: string, arraySharing: ArraySharing, options?: any) => Promise; + /** + * update metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata array metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateArrayMetadata: (namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any) => Promise; + /** + * vacuum an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + vacuumArray: (namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any) => Promise; +}; +/** + * ArrayApi - functional programming interface + * @export + */ +export declare const ArrayApiFp: (configuration?: Configuration) => { + /** + * get array activity logs + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) + * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) + * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated + * @param {string} [taskId] Array task id To filter activity to + * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arrayActivityLog(namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Fetch a list of all arrays that are owned directly by user or user\'s organizations + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserOwnedSidebarGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a list of all arrays that have been shared publically + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a sidebar of all arrays that have been shared publically + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserPublicSidebarGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserSharedSidebarGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * consolidate an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consolidateArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * create a array schema at a specified URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {ArraySchema} arraySchema ArraySchema being created + * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createArray(namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteArray(namespace: string, array: string, contentType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * deregister a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deregisterArray(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get all array metadata user has access to + * @param {string} [publicShare] Public share values can be one of exclude, only + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllArrayMetadata(publicShare?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * get an ArraySchema using a url encoded uri + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArray(namespace: string, array: string, contentType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get the max buffer sizes of an array for a subarray + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} subarray CSV string of subarray to get max buffer sizes for + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMaxBufferSizes(namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get metadata from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [length] (optional) limit character length of returned values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMetaDataJson(namespace: string, array: string, length?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMetadata(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get the non empty domain of an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomain(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomainJson(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get an sample set of data from the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [samples] Number of sample results to return + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraySampleData(namespace: string, array: string, samples?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Get all sharing details of the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraySharingPolicies(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * get metadata on all arrays in a namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraysInNamespace(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLastAccessedArrays(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * register an array at a specified URI registered to the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerArray(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Share an array with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareArray(namespace: string, array: string, arraySharing: ArraySharing, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * update metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata array metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateArrayMetadata(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * vacuum an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + vacuumArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * ArrayApi - factory interface + * @export + */ +export declare const ArrayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * get array activity logs + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) + * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) + * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated + * @param {string} [taskId] Array task id To filter activity to + * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arrayActivityLog(namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any): AxiosPromise>; + /** + * Fetch a list of all arrays that are owned directly by user or user\'s organizations + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): AxiosPromise; + /** + * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserOwnedSidebarGet(options?: any): AxiosPromise; + /** + * Fetch a list of all arrays that have been shared publically + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): AxiosPromise; + /** + * Fetch a sidebar of all arrays that have been shared publically + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserPublicSidebarGet(options?: any): AxiosPromise; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): AxiosPromise; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + arraysBrowserSharedSidebarGet(options?: any): AxiosPromise; + /** + * consolidate an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consolidateArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): AxiosPromise; + /** + * create a array schema at a specified URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {ArraySchema} arraySchema ArraySchema being created + * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createArray(namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any): AxiosPromise; + /** + * delete a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteArray(namespace: string, array: string, contentType: string, options?: any): AxiosPromise; + /** + * deregister a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deregisterArray(namespace: string, array: string, options?: any): AxiosPromise; + /** + * get all array metadata user has access to + * @param {string} [publicShare] Public share values can be one of exclude, only + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllArrayMetadata(publicShare?: string, options?: any): AxiosPromise>; + /** + * get an ArraySchema using a url encoded uri + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArray(namespace: string, array: string, contentType: string, options?: any): AxiosPromise; + /** + * get the max buffer sizes of an array for a subarray + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} subarray CSV string of subarray to get max buffer sizes for + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMaxBufferSizes(namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any): AxiosPromise; + /** + * get metadata from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [length] (optional) limit character length of returned values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMetaDataJson(namespace: string, array: string, length?: number, options?: any): AxiosPromise; + /** + * get metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayMetadata(namespace: string, array: string, options?: any): AxiosPromise; + /** + * get the non empty domain of an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomain(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): AxiosPromise; + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomainJson(namespace: string, array: string, options?: any): AxiosPromise; + /** + * get an sample set of data from the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [samples] Number of sample results to return + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraySampleData(namespace: string, array: string, samples?: number, options?: any): AxiosPromise; + /** + * Get all sharing details of the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraySharingPolicies(namespace: string, array: string, options?: any): AxiosPromise>; + /** + * get metadata on all arrays in a namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArraysInNamespace(namespace: string, options?: any): AxiosPromise>; + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLastAccessedArrays(options?: any): AxiosPromise>; + /** + * register an array at a specified URI registered to the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerArray(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): AxiosPromise; + /** + * Share an array with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareArray(namespace: string, array: string, arraySharing: ArraySharing, options?: any): AxiosPromise; + /** + * update metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata array metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateArrayMetadata(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): AxiosPromise; + /** + * vacuum an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + vacuumArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): AxiosPromise; +}; +/** + * ArrayApi - object-oriented interface + * @export + * @class ArrayApi + * @extends {BaseAPI} + */ +export declare class ArrayApi extends BaseAPI { + /** + * get array activity logs + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) + * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) + * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated + * @param {string} [taskId] Array task id To filter activity to + * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arrayActivityLog(namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any): Promise>; + /** + * Fetch a list of all arrays that are owned directly by user or user\'s organizations + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise>; + /** + * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arraysBrowserOwnedSidebarGet(options?: any): Promise>; + /** + * Fetch a list of all arrays that have been shared publically + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise>; + /** + * Fetch a sidebar of all arrays that have been shared publically + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arraysBrowserPublicSidebarGet(options?: any): Promise>; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [namespace] namespace + * @param {string} [orderby] sort by which field valid values include last_accessed, size, name + * @param {string} [permissions] permissions valid values include read, read_write, write, admin + * @param {Array} [tag] tag to search for, more than one can be included + * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included + * @param {Array} [fileType] file_type to search for, more than one can be included + * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise>; + /** + * Fetch a list of all arrays that have been shared with the user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + arraysBrowserSharedSidebarGet(options?: any): Promise>; + /** + * consolidate an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + consolidateArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): Promise>; + /** + * create a array schema at a specified URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {ArraySchema} arraySchema ArraySchema being created + * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + createArray(namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any): Promise>; + /** + * delete a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + deleteArray(namespace: string, array: string, contentType: string, options?: any): Promise>; + /** + * deregister a array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + deregisterArray(namespace: string, array: string, options?: any): Promise>; + /** + * get all array metadata user has access to + * @param {string} [publicShare] Public share values can be one of exclude, only + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getAllArrayMetadata(publicShare?: string, options?: any): Promise>; + /** + * get an ArraySchema using a url encoded uri + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArray(namespace: string, array: string, contentType: string, options?: any): Promise>; + /** + * get the max buffer sizes of an array for a subarray + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} subarray CSV string of subarray to get max buffer sizes for + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArrayMaxBufferSizes(namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any): Promise>; + /** + * get metadata from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [length] (optional) limit character length of returned values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArrayMetaDataJson(namespace: string, array: string, length?: number, options?: any): Promise>; + /** + * get metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArrayMetadata(namespace: string, array: string, options?: any): Promise>; + /** + * get the non empty domain of an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArrayNonEmptyDomain(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): Promise>; + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArrayNonEmptyDomainJson(namespace: string, array: string, options?: any): Promise>; + /** + * get an sample set of data from the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {number} [samples] Number of sample results to return + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArraySampleData(namespace: string, array: string, samples?: number, options?: any): Promise>; + /** + * Get all sharing details of the array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArraySharingPolicies(namespace: string, array: string, options?: any): Promise>; + /** + * get metadata on all arrays in a namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getArraysInNamespace(namespace: string, options?: any): Promise>; + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + getLastAccessedArrays(options?: any): Promise>; + /** + * register an array at a specified URI registered to the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + registerArray(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): Promise>; + /** + * Share an array with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + shareArray(namespace: string, array: string, arraySharing: ArraySharing, options?: any): Promise>; + /** + * update metadata on an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {ArrayInfoUpdate} arrayMetadata array metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + updateArrayMetadata(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): Promise>; + /** + * vacuum an array at a specified URI + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {TileDBConfig} tiledbConfig tiledb configuration + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + vacuumArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): Promise>; +} +/** + * ArrayTasksApi - axios parameter creator + * @export + */ +export declare const ArrayTasksApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * + * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago + * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayTasksSidebar: (start?: number, end?: number, options?: any) => Promise; +}; +/** + * ArrayTasksApi - functional programming interface + * @export + */ +export declare const ArrayTasksApiFp: (configuration?: Configuration) => { + /** + * + * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago + * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayTasksSidebar(start?: number, end?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * ArrayTasksApi - factory interface + * @export + */ +export declare const ArrayTasksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * + * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago + * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayTasksSidebar(start?: number, end?: number, options?: any): AxiosPromise; +}; +/** + * ArrayTasksApi - object-oriented interface + * @export + * @class ArrayTasksApi + * @extends {BaseAPI} + */ +export declare class ArrayTasksApi extends BaseAPI { + /** + * + * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago + * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayTasksApi + */ + getArrayTasksSidebar(start?: number, end?: number, options?: any): Promise>; +} +/** + * FavoritesApi - axios parameter creator + * @export + */ +export declare const FavoritesApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Delete specific favorite + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteFavoriteId: (id: string, options?: any) => Promise; + /** + * Fetch specific favorite of a user + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFavorite: (id: string, options?: any) => Promise; + /** + * Fetch all favorites of connected user + * @param {string} [type] The type of the desired favorites e.g. arrays + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFavorites: (type?: string, options?: any) => Promise; + /** + * Add a new favorite + * @param {FavoriteUpdate} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postFavorite: (body?: FavoriteUpdate, options?: any) => Promise; +}; +/** + * FavoritesApi - functional programming interface + * @export + */ +export declare const FavoritesApiFp: (configuration?: Configuration) => { + /** + * Delete specific favorite + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteFavoriteId(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch specific favorite of a user + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFavorite(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch all favorites of connected user + * @param {string} [type] The type of the desired favorites e.g. arrays + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFavorites(type?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Add a new favorite + * @param {FavoriteUpdate} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postFavorite(body?: FavoriteUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * FavoritesApi - factory interface + * @export + */ +export declare const FavoritesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Delete specific favorite + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteFavoriteId(id: string, options?: any): AxiosPromise; + /** + * Fetch specific favorite of a user + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFavorite(id: string, options?: any): AxiosPromise; + /** + * Fetch all favorites of connected user + * @param {string} [type] The type of the desired favorites e.g. arrays + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFavorites(type?: string, options?: any): AxiosPromise>; + /** + * Add a new favorite + * @param {FavoriteUpdate} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postFavorite(body?: FavoriteUpdate, options?: any): AxiosPromise; +}; +/** + * FavoritesApi - object-oriented interface + * @export + * @class FavoritesApi + * @extends {BaseAPI} + */ +export declare class FavoritesApi extends BaseAPI { + /** + * Delete specific favorite + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FavoritesApi + */ + deleteFavoriteId(id: string, options?: any): Promise>; + /** + * Fetch specific favorite of a user + * @param {string} id The uuid of the favorite + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FavoritesApi + */ + getFavorite(id: string, options?: any): Promise>; + /** + * Fetch all favorites of connected user + * @param {string} [type] The type of the desired favorites e.g. arrays + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FavoritesApi + */ + getFavorites(type?: string, options?: any): Promise>; + /** + * Add a new favorite + * @param {FavoriteUpdate} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FavoritesApi + */ + postFavorite(body?: FavoriteUpdate, options?: any): Promise>; +} +/** + * InvitationApi - axios parameter creator + * @export + */ +export declare const InvitationApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Accepts invitation + * @param {string} invitation the id of invitation about to be accepted + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + acceptInvitation: (invitation: string, options?: any) => Promise; + /** + * Cancels join organization invitation + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} organization name or uuid of organization + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancelJoinOrganization: (invitation: string, organization: string, options?: any) => Promise; + /** + * Cancels array sharing invitation + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancelShareArrayByInvite: (namespace: string, invitation: string, array: string, options?: any) => Promise; + /** + * Fetch a list of invitations + * @param {string} [organization] name or id of organization to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" + * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" + * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + fetchInvitations: (organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any) => Promise; + /** + * Sends email to multiple recipients with joining information regarding an organization + * @param {string} organization name or uuid of organization + * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + joinOrganization: (organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any) => Promise; + /** + * Sends email to multiple recipients with sharing information regarding an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {InvitationArrayShareEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareArrayByInvite: (namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any) => Promise; +}; +/** + * InvitationApi - functional programming interface + * @export + */ +export declare const InvitationApiFp: (configuration?: Configuration) => { + /** + * Accepts invitation + * @param {string} invitation the id of invitation about to be accepted + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + acceptInvitation(invitation: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Cancels join organization invitation + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} organization name or uuid of organization + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancelJoinOrganization(invitation: string, organization: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Cancels array sharing invitation + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a list of invitations + * @param {string} [organization] name or id of organization to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" + * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" + * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + fetchInvitations(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Sends email to multiple recipients with joining information regarding an organization + * @param {string} organization name or uuid of organization + * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + joinOrganization(organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Sends email to multiple recipients with sharing information regarding an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {InvitationArrayShareEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareArrayByInvite(namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * InvitationApi - factory interface + * @export + */ +export declare const InvitationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Accepts invitation + * @param {string} invitation the id of invitation about to be accepted + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + acceptInvitation(invitation: string, options?: any): AxiosPromise; + /** + * Cancels join organization invitation + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} organization name or uuid of organization + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancelJoinOrganization(invitation: string, organization: string, options?: any): AxiosPromise; + /** + * Cancels array sharing invitation + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options?: any): AxiosPromise; + /** + * Fetch a list of invitations + * @param {string} [organization] name or id of organization to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" + * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" + * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + fetchInvitations(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any): AxiosPromise; + /** + * Sends email to multiple recipients with joining information regarding an organization + * @param {string} organization name or uuid of organization + * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + joinOrganization(organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any): AxiosPromise; + /** + * Sends email to multiple recipients with sharing information regarding an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {InvitationArrayShareEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareArrayByInvite(namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any): AxiosPromise; +}; +/** + * InvitationApi - object-oriented interface + * @export + * @class InvitationApi + * @extends {BaseAPI} + */ +export declare class InvitationApi extends BaseAPI { + /** + * Accepts invitation + * @param {string} invitation the id of invitation about to be accepted + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InvitationApi + */ + acceptInvitation(invitation: string, options?: any): Promise>; + /** + * Cancels join organization invitation + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} organization name or uuid of organization + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InvitationApi + */ + cancelJoinOrganization(invitation: string, organization: string, options?: any): Promise>; + /** + * Cancels array sharing invitation + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} invitation the id of invitation about to be cancelled + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InvitationApi + */ + cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options?: any): Promise>; + /** + * Fetch a list of invitations + * @param {string} [organization] name or id of organization to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" + * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" + * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InvitationApi + */ + fetchInvitations(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any): Promise>; + /** + * Sends email to multiple recipients with joining information regarding an organization + * @param {string} organization name or uuid of organization + * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InvitationApi + */ + joinOrganization(organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any): Promise>; + /** + * Sends email to multiple recipients with sharing information regarding an array + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {InvitationArrayShareEmail} emailInvite list of email recipients + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InvitationApi + */ + shareArrayByInvite(namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any): Promise>; +} +/** + * NotebookApi - axios parameter creator + * @export + */ +export declare const NotebookApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Get status of the notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getNotebookServerStatus: (namespace: string, options?: any) => Promise; + /** + * Shutdown a notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shutdownNotebookServer: (namespace: string, options?: any) => Promise; + /** + * update name on a notebok, moving related s3 object to new location + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of notebook (array) that is url-encoded + * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateNotebookName: (namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any) => Promise; +}; +/** + * NotebookApi - functional programming interface + * @export + */ +export declare const NotebookApiFp: (configuration?: Configuration) => { + /** + * Get status of the notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getNotebookServerStatus(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Shutdown a notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shutdownNotebookServer(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * update name on a notebok, moving related s3 object to new location + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of notebook (array) that is url-encoded + * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateNotebookName(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * NotebookApi - factory interface + * @export + */ +export declare const NotebookApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Get status of the notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getNotebookServerStatus(namespace: string, options?: any): AxiosPromise; + /** + * Shutdown a notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shutdownNotebookServer(namespace: string, options?: any): AxiosPromise; + /** + * update name on a notebok, moving related s3 object to new location + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of notebook (array) that is url-encoded + * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateNotebookName(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any): AxiosPromise; +}; +/** + * NotebookApi - object-oriented interface + * @export + * @class NotebookApi + * @extends {BaseAPI} + */ +export declare class NotebookApi extends BaseAPI { + /** + * Get status of the notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotebookApi + */ + getNotebookServerStatus(namespace: string, options?: any): Promise>; + /** + * Shutdown a notebook server + * @param {string} namespace namespace notebook is in (an organization name or user\'s username) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotebookApi + */ + shutdownNotebookServer(namespace: string, options?: any): Promise>; + /** + * update name on a notebok, moving related s3 object to new location + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of notebook (array) that is url-encoded + * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotebookApi + */ + updateNotebookName(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any): Promise>; +} +/** + * NotebooksApi - axios parameter creator + * @export + */ +export declare const NotebooksApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notebooksNamespaceArrayVersionsGet: (namespace: string, array: string, options?: any) => Promise; +}; +/** + * NotebooksApi - functional programming interface + * @export + */ +export declare const NotebooksApiFp: (configuration?: Configuration) => { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notebooksNamespaceArrayVersionsGet(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; +}; +/** + * NotebooksApi - factory interface + * @export + */ +export declare const NotebooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notebooksNamespaceArrayVersionsGet(namespace: string, array: string, options?: any): AxiosPromise>; +}; +/** + * NotebooksApi - object-oriented interface + * @export + * @class NotebooksApi + * @extends {BaseAPI} + */ +export declare class NotebooksApi extends BaseAPI { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotebooksApi + */ + notebooksNamespaceArrayVersionsGet(namespace: string, array: string, options?: any): Promise>; +} +/** + * OrganizationApi - axios parameter creator + * @export + */ +export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addAWSAccessCredentials: (namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any) => Promise; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addUserToOrganization: (organization: string, user: OrganizationUser, options?: any) => Promise; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentials: (namespace: string, options?: any) => Promise; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentialsByName: (namespace: string, name: string, options?: any) => Promise; + /** + * create a organization, the user creating will be listed as owner + * @param {Organization} organization organization to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createOrganization: (organization: Organization, options?: any) => Promise; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAWSAccessCredentials: (namespace: string, name: string, options?: any) => Promise; + /** + * delete a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteOrganization: (organization: string, options?: any) => Promise; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUserFromOrganization: (organization: string, username: string, options?: any) => Promise; + /** + * get all organizations that the user is member of + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllOrganizations: (options?: any) => Promise; + /** + * get a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganization: (organization: string, options?: any) => Promise; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationUser: (organization: string, username: string, options?: any) => Promise; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAWSAccessCredentials: (namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any) => Promise; + /** + * update a organization + * @param {string} organization organization name or id + * @param {Organization} organizationDetails organization details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateOrganization: (organization: string, organizationDetails: Organization, options?: any) => Promise; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUserInOrganization: (organization: string, username: string, user: OrganizationUser, options?: any) => Promise; +}; +/** + * OrganizationApi - functional programming interface + * @export + */ +export declare const OrganizationApiFp: (configuration?: Configuration) => { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addUserToOrganization(organization: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentials(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * create a organization, the user creating will be listed as owner + * @param {Organization} organization organization to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createOrganization(organization: Organization, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAWSAccessCredentials(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteOrganization(organization: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUserFromOrganization(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get all organizations that the user is member of + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllOrganizations(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * get a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganization(organization: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationUser(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * update a organization + * @param {string} organization organization name or id + * @param {Organization} organizationDetails organization details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateOrganization(organization: string, organizationDetails: Organization, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * OrganizationApi - factory interface + * @export + */ +export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addUserToOrganization(organization: string, user: OrganizationUser, options?: any): AxiosPromise; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentials(namespace: string, options?: any): AxiosPromise>; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): AxiosPromise; + /** + * create a organization, the user creating will be listed as owner + * @param {Organization} organization organization to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createOrganization(organization: Organization, options?: any): AxiosPromise; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAWSAccessCredentials(namespace: string, name: string, options?: any): AxiosPromise; + /** + * delete a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteOrganization(organization: string, options?: any): AxiosPromise; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUserFromOrganization(organization: string, username: string, options?: any): AxiosPromise; + /** + * get all organizations that the user is member of + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAllOrganizations(options?: any): AxiosPromise>; + /** + * get a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganization(organization: string, options?: any): AxiosPromise; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationUser(organization: string, username: string, options?: any): AxiosPromise; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise; + /** + * update a organization + * @param {string} organization organization name or id + * @param {Organization} organizationDetails organization details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateOrganization(organization: string, organizationDetails: Organization, options?: any): AxiosPromise; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): AxiosPromise; +}; +/** + * OrganizationApi - object-oriented interface + * @export + * @class OrganizationApi + * @extends {BaseAPI} + */ +export declare class OrganizationApi extends BaseAPI { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise>; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + addUserToOrganization(organization: string, user: OrganizationUser, options?: any): Promise>; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + checkAWSAccessCredentials(namespace: string, options?: any): Promise>; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): Promise>; + /** + * create a organization, the user creating will be listed as owner + * @param {Organization} organization organization to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + createOrganization(organization: Organization, options?: any): Promise>; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + deleteAWSAccessCredentials(namespace: string, name: string, options?: any): Promise>; + /** + * delete a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + deleteOrganization(organization: string, options?: any): Promise>; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + deleteUserFromOrganization(organization: string, username: string, options?: any): Promise>; + /** + * get all organizations that the user is member of + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + getAllOrganizations(options?: any): Promise>; + /** + * get a organization + * @param {string} organization organization name or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + getOrganization(organization: string, options?: any): Promise>; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + getOrganizationUser(organization: string, username: string, options?: any): Promise>; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise>; + /** + * update a organization + * @param {string} organization organization name or id + * @param {Organization} organizationDetails organization details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + updateOrganization(organization: string, organizationDetails: Organization, options?: any): Promise>; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OrganizationApi + */ + updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): Promise>; +} +/** + * QueryApi - axios parameter creator + * @export + */ +export declare const QueryApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + finalizeQuery: (namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any) => Promise; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEstResultSizes: (namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any) => Promise; + /** + * send a query to run against a specified array/URI registered to a group/project, returns file bytes + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFile: (namespace: string, array: string, contentType: string, xPayer?: string, options?: any) => Promise; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitQuery: (namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any) => Promise; + /** + * send a query to run against a specified array/URI registered to a group/project, returns json results + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {QueryJson} queryJson query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitQueryJson: (namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any) => Promise; +}; +/** + * QueryApi - functional programming interface + * @export + */ +export declare const QueryApiFp: (configuration?: Configuration) => { + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + finalizeQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * send a query to run against a specified array/URI registered to a group/project, returns file bytes + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFile(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * send a query to run against a specified array/URI registered to a group/project, returns json results + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {QueryJson} queryJson query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * QueryApi - factory interface + * @export + */ +export declare const QueryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + finalizeQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise; + /** + * send a query to run against a specified array/URI registered to a group/project, returns file bytes + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFile(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): AxiosPromise; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise; + /** + * send a query to run against a specified array/URI registered to a group/project, returns json results + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {QueryJson} queryJson query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any): AxiosPromise; +}; +/** + * QueryApi - object-oriented interface + * @export + * @class QueryApi + * @extends {BaseAPI} + */ +export declare class QueryApi extends BaseAPI { + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + finalizeQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise>; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise>; + /** + * send a query to run against a specified array/URI registered to a group/project, returns file bytes + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + getFile(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): Promise>; + /** + * send a query to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} type type of query + * @param {string} contentType Content Type of input and return mime + * @param {Query} query query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {number} [openAt] open_at for array in unix epoch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise>; + /** + * send a query to run against a specified array/URI registered to a group/project, returns json results + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {string} contentType Content Type of input and return mime + * @param {QueryJson} queryJson query to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QueryApi + */ + submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any): Promise>; +} +/** + * SqlApi - axios parameter creator + * @export + */ +export declare const SqlApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + runSQL: (namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any) => Promise; +}; +/** + * SqlApi - functional programming interface + * @export + */ +export declare const SqlApiFp: (configuration?: Configuration) => { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; +}; +/** + * SqlApi - factory interface + * @export + */ +export declare const SqlApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): AxiosPromise>; +}; +/** + * SqlApi - object-oriented interface + * @export + * @class SqlApi + * @extends {BaseAPI} + */ +export declare class SqlApi extends BaseAPI { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SqlApi + */ + runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): Promise>; +} +/** + * StatsApi - axios parameter creator + * @export + */ +export declare const StatsApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Fetch libtiledb stat + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTiledbStats: (options?: any) => Promise; +}; +/** + * StatsApi - functional programming interface + * @export + */ +export declare const StatsApiFp: (configuration?: Configuration) => { + /** + * Fetch libtiledb stat + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTiledbStats(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * StatsApi - factory interface + * @export + */ +export declare const StatsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Fetch libtiledb stat + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTiledbStats(options?: any): AxiosPromise; +}; +/** + * StatsApi - object-oriented interface + * @export + * @class StatsApi + * @extends {BaseAPI} + */ +export declare class StatsApi extends BaseAPI { + /** + * Fetch libtiledb stat + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof StatsApi + */ + getTiledbStats(options?: any): Promise>; +} +/** + * TasksApi - axios parameter creator + * @export + */ +export declare const TasksApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + runSQL: (namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any) => Promise; + /** + * Fetch an array task + * @param {string} id task id to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + taskIdGet: (id: string, options?: any) => Promise; + /** + * Retrieve results of an array task + * @param {string} id task id to retrieve stored results + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + taskIdResultGet: (id: string, acceptEncoding?: string, options?: any) => Promise; + /** + * Fetch a list of all array tasks a user has access to + * @param {string} [namespace] namespace to filter + * @param {string} [createdBy] username to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" + * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included + * @param {string} [status] Filter to only return these statuses + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [orderby] sort by which field valid values include start_time, name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tasksGet: (namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, fileType?: Array, excludeFileType?: Array, status?: string, search?: string, orderby?: string, options?: any) => Promise; +}; +/** + * TasksApi - functional programming interface + * @export + */ +export declare const TasksApiFp: (configuration?: Configuration) => { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Fetch an array task + * @param {string} id task id to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + taskIdGet(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Retrieve results of an array task + * @param {string} id task id to retrieve stored results + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + taskIdResultGet(id: string, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a list of all array tasks a user has access to + * @param {string} [namespace] namespace to filter + * @param {string} [createdBy] username to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" + * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included + * @param {string} [status] Filter to only return these statuses + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [orderby] sort by which field valid values include start_time, name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tasksGet(namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, fileType?: Array, excludeFileType?: Array, status?: string, search?: string, orderby?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * TasksApi - factory interface + * @export + */ +export declare const TasksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): AxiosPromise>; + /** + * Fetch an array task + * @param {string} id task id to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + taskIdGet(id: string, options?: any): AxiosPromise; + /** + * Retrieve results of an array task + * @param {string} id task id to retrieve stored results + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + taskIdResultGet(id: string, acceptEncoding?: string, options?: any): AxiosPromise; + /** + * Fetch a list of all array tasks a user has access to + * @param {string} [namespace] namespace to filter + * @param {string} [createdBy] username to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" + * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included + * @param {string} [status] Filter to only return these statuses + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [orderby] sort by which field valid values include start_time, name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tasksGet(namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, fileType?: Array, excludeFileType?: Array, status?: string, search?: string, orderby?: string, options?: any): AxiosPromise; +}; +/** + * TasksApi - object-oriented interface + * @export + * @class TasksApi + * @extends {BaseAPI} + */ +export declare class TasksApi extends BaseAPI { + /** + * Run a sql query + * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) + * @param {SQLParameters} sql sql being submitted + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): Promise>; + /** + * Fetch an array task + * @param {string} id task id to fetch + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + taskIdGet(id: string, options?: any): Promise>; + /** + * Retrieve results of an array task + * @param {string} id task id to retrieve stored results + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + taskIdResultGet(id: string, acceptEncoding?: string, options?: any): Promise>; + /** + * Fetch a list of all array tasks a user has access to + * @param {string} [namespace] namespace to filter + * @param {string} [createdBy] username to filter + * @param {string} [array] name/uri of array that is url-encoded to filter + * @param {number} [start] start time for tasks to filter by + * @param {number} [end] end time for tasks to filter by + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" + * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included + * @param {string} [status] Filter to only return these statuses + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [orderby] sort by which field valid values include start_time, name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + tasksGet(namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, fileType?: Array, excludeFileType?: Array, status?: string, search?: string, orderby?: string, options?: any): Promise>; +} +/** + * UdfApi - axios parameter creator + * @export + */ +export declare const UdfApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * delete a registerd UDF, this will remove all sharing and can not be undone + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUDFInfo: (namespace: string, name: string, options?: any) => Promise; + /** + * get a specific UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfo: (namespace: string, name: string, options?: any) => Promise; + /** + * Get all sharing details of the udf + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfoSharingPolicies: (namespace: string, name: string, options?: any) => Promise; + /** + * register a UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to register + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerUDFInfo: (namespace: string, name: string, udf: UDFInfoUpdate, options?: any) => Promise; + /** + * Share a UDF with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareUDFInfo: (namespace: string, name: string, udfSharing: UDFSharing, options?: any) => Promise; + /** + * submit a generic UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {GenericUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitGenericUDF: (namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any) => Promise; + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitMultiArrayUDF: (namespace: string, udf: MultiArrayUDF, acceptEncoding?: string, options?: any) => Promise; + /** + * send a UDF to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {MultiArrayUDF} udf udf to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {string} [acceptEncoding] Encoding to use + * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitUDF: (namespace: string, array: string, udf: MultiArrayUDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any) => Promise; + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + udfNamespaceArrayVersionsGet: (namespace: string, array: string, options?: any) => Promise; + /** + * updated an existing registerd UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUDFInfo: (namespace: string, name: string, udf: UDFInfoUpdate, options?: any) => Promise; +}; +/** + * UdfApi - functional programming interface + * @export + */ +export declare const UdfApiFp: (configuration?: Configuration) => { + /** + * delete a registerd UDF, this will remove all sharing and can not be undone + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUDFInfo(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get a specific UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfo(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Get all sharing details of the udf + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * register a UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to register + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Share a UDF with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * submit a generic UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {GenericUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitGenericUDF(namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitMultiArrayUDF(namespace: string, udf: MultiArrayUDF, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * send a UDF to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {MultiArrayUDF} udf udf to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {string} [acceptEncoding] Encoding to use + * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitUDF(namespace: string, array: string, udf: MultiArrayUDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + udfNamespaceArrayVersionsGet(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * updated an existing registerd UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * UdfApi - factory interface + * @export + */ +export declare const UdfApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * delete a registerd UDF, this will remove all sharing and can not be undone + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUDFInfo(namespace: string, name: string, options?: any): AxiosPromise; + /** + * get a specific UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfo(namespace: string, name: string, options?: any): AxiosPromise; + /** + * Get all sharing details of the udf + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): AxiosPromise>; + /** + * register a UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to register + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): AxiosPromise; + /** + * Share a UDF with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): AxiosPromise; + /** + * submit a generic UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {GenericUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitGenericUDF(namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any): AxiosPromise; + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitMultiArrayUDF(namespace: string, udf: MultiArrayUDF, acceptEncoding?: string, options?: any): AxiosPromise; + /** + * send a UDF to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {MultiArrayUDF} udf udf to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {string} [acceptEncoding] Encoding to use + * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitUDF(namespace: string, array: string, udf: MultiArrayUDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any): AxiosPromise; + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + udfNamespaceArrayVersionsGet(namespace: string, array: string, options?: any): AxiosPromise>; + /** + * updated an existing registerd UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): AxiosPromise; +}; +/** + * UdfApi - object-oriented interface + * @export + * @class UdfApi + * @extends {BaseAPI} + */ +export declare class UdfApi extends BaseAPI { + /** + * delete a registerd UDF, this will remove all sharing and can not be undone + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + deleteUDFInfo(namespace: string, name: string, options?: any): Promise>; + /** + * get a specific UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + getUDFInfo(namespace: string, name: string, options?: any): Promise>; + /** + * Get all sharing details of the udf + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): Promise>; + /** + * register a UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to register + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): Promise>; + /** + * Share a UDF with a user + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name of UDFInfo + * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): Promise>; + /** + * submit a generic UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {GenericUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + submitGenericUDF(namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any): Promise>; + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + submitMultiArrayUDF(namespace: string, udf: MultiArrayUDF, acceptEncoding?: string, options?: any): Promise>; + /** + * send a UDF to run against a specified array/URI registered to a group/project + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {MultiArrayUDF} udf udf to run + * @param {string} [xPayer] Name of organization or user who should be charged for this request + * @param {string} [acceptEncoding] Encoding to use + * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + submitUDF(namespace: string, array: string, udf: MultiArrayUDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any): Promise>; + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + udfNamespaceArrayVersionsGet(namespace: string, array: string, options?: any): Promise>; + /** + * updated an existing registerd UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} name name to register udf under + * @param {UDFInfoUpdate} udf udf to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): Promise>; +} +/** + * UserApi - axios parameter creator + * @export + */ +export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addAWSAccessCredentials: (namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any) => Promise; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addUserToOrganization: (organization: string, user: OrganizationUser, options?: any) => Promise; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentials: (namespace: string, options?: any) => Promise; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentialsByName: (namespace: string, name: string, options?: any) => Promise; + /** + * confirm user email + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmEmail: (options?: any) => Promise; + /** + * create a user + * @param {User} user user to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createUser: (user: User, options?: any) => Promise; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAWSAccessCredentials: (namespace: string, name: string, options?: any) => Promise; + /** + * delete a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUser: (username: string, options?: any) => Promise; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUserFromOrganization: (organization: string, username: string, options?: any) => Promise; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationUser: (organization: string, username: string, options?: any) => Promise; + /** + * Get session token for user + * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSession: (rememberMe?: string, options?: any) => Promise; + /** + * get a user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUser: (options?: any) => Promise; + /** + * get a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUserWithUsername: (username: string, options?: any) => Promise; + /** + * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token + * @param {TokenRequest} [tokenRequest] token request object + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + requestToken: (tokenRequest?: TokenRequest, options?: any) => Promise; + /** + * reset user password + * @param {InlineObject} user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resetUserPassword: (user: InlineObject, options?: any) => Promise; + /** + * revoke an authorization token + * @param {string} token token name or token itself + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + revokeToken: (token: string, options?: any) => Promise; + /** + * Fetch a list of user tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensGet: (options?: any) => Promise; + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensSessionGet: (options?: any) => Promise; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAWSAccessCredentials: (namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any) => Promise; + /** + * update a user + * @param {string} username username or id + * @param {User} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUser: (username: string, user: User, options?: any) => Promise; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUserInOrganization: (organization: string, username: string, user: OrganizationUser, options?: any) => Promise; +}; +/** + * UserApi - functional programming interface + * @export + */ +export declare const UserApiFp: (configuration?: Configuration) => { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addUserToOrganization(organization: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentials(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * confirm user email + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmEmail(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * create a user + * @param {User} user user to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createUser(user: User, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAWSAccessCredentials(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUser(username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUserFromOrganization(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationUser(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Get session token for user + * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSession(rememberMe?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get a user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * get a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUserWithUsername(username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token + * @param {TokenRequest} [tokenRequest] token request object + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + requestToken(tokenRequest?: TokenRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * reset user password + * @param {InlineObject} user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resetUserPassword(user: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * revoke an authorization token + * @param {string} token token name or token itself + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + revokeToken(token: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * Fetch a list of user tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensSessionGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * update a user + * @param {string} username username or id + * @param {User} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUser(username: string, user: User, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; +}; +/** + * UserApi - factory interface + * @export + */ +export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + addUserToOrganization(organization: string, user: OrganizationUser, options?: any): AxiosPromise; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentials(namespace: string, options?: any): AxiosPromise>; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): AxiosPromise; + /** + * confirm user email + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + confirmEmail(options?: any): AxiosPromise; + /** + * create a user + * @param {User} user user to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createUser(user: User, options?: any): AxiosPromise; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteAWSAccessCredentials(namespace: string, name: string, options?: any): AxiosPromise; + /** + * delete a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUser(username: string, options?: any): AxiosPromise; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteUserFromOrganization(organization: string, username: string, options?: any): AxiosPromise; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOrganizationUser(organization: string, username: string, options?: any): AxiosPromise; + /** + * Get session token for user + * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getSession(rememberMe?: string, options?: any): AxiosPromise; + /** + * get a user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUser(options?: any): AxiosPromise; + /** + * get a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUserWithUsername(username: string, options?: any): AxiosPromise; + /** + * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token + * @param {TokenRequest} [tokenRequest] token request object + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + requestToken(tokenRequest?: TokenRequest, options?: any): AxiosPromise; + /** + * reset user password + * @param {InlineObject} user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + resetUserPassword(user: InlineObject, options?: any): AxiosPromise; + /** + * revoke an authorization token + * @param {string} token token name or token itself + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + revokeToken(token: string, options?: any): AxiosPromise; + /** + * Fetch a list of user tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensGet(options?: any): AxiosPromise>; + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensSessionGet(options?: any): AxiosPromise>; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise; + /** + * update a user + * @param {string} username username or id + * @param {User} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUser(username: string, user: User, options?: any): AxiosPromise; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): AxiosPromise; +}; +/** + * UserApi - object-oriented interface + * @export + * @class UserApi + * @extends {BaseAPI} + */ +export declare class UserApi extends BaseAPI { + /** + * Add aws keys + * @param {string} namespace namespace + * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise>; + /** + * add a user to an organization + * @param {string} organization organization name + * @param {OrganizationUser} user user to add + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + addUserToOrganization(organization: string, user: OrganizationUser, options?: any): Promise>; + /** + * Check if aws keys are set + * @param {string} namespace namespace + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + checkAWSAccessCredentials(namespace: string, options?: any): Promise>; + /** + * Check if aws keys are set by name + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): Promise>; + /** + * confirm user email + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + confirmEmail(options?: any): Promise>; + /** + * create a user + * @param {User} user user to create + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + createUser(user: User, options?: any): Promise>; + /** + * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable + * @param {string} namespace namespace + * @param {string} name name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + deleteAWSAccessCredentials(namespace: string, name: string, options?: any): Promise>; + /** + * delete a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + deleteUser(username: string, options?: any): Promise>; + /** + * delete a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + deleteUserFromOrganization(organization: string, username: string, options?: any): Promise>; + /** + * get a user from an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + getOrganizationUser(organization: string, username: string, options?: any): Promise>; + /** + * Get session token for user + * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + getSession(rememberMe?: string, options?: any): Promise>; + /** + * get a user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + getUser(options?: any): Promise>; + /** + * get a user + * @param {string} username username or id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + getUserWithUsername(username: string, options?: any): Promise>; + /** + * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token + * @param {TokenRequest} [tokenRequest] token request object + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + requestToken(tokenRequest?: TokenRequest, options?: any): Promise>; + /** + * reset user password + * @param {InlineObject} user + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + resetUserPassword(user: InlineObject, options?: any): Promise>; + /** + * revoke an authorization token + * @param {string} token token name or token itself + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + revokeToken(token: string, options?: any): Promise>; + /** + * Fetch a list of user tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + tokensGet(options?: any): Promise>; + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + tokensSessionGet(options?: any): Promise>; + /** + * Update aws keys or associated buckets. This will update the key associations for each array in the namespace + * @param {string} namespace namespace + * @param {string} name name + * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise>; + /** + * update a user + * @param {string} username username or id + * @param {User} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + updateUser(username: string, user: User, options?: any): Promise>; + /** + * update a user in an organization + * @param {string} organization organization name + * @param {string} username username to manipulate + * @param {OrganizationUser} user user details to update + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): Promise>; +} diff --git a/lib/api.js b/lib/api.js index c7b49db..1b4ad78 100644 --- a/lib/api.js +++ b/lib/api.js @@ -5,7 +5,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 + * The version of the OpenAPI document: 2.2.19 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -75,8 +75,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) { } }; exports.__esModule = true; -exports.OrganizationApiAxiosParamCreator = exports.NotebookApi = exports.NotebookApiFactory = exports.NotebookApiFp = exports.NotebookApiAxiosParamCreator = exports.InvitationApi = exports.InvitationApiFactory = exports.InvitationApiFp = exports.InvitationApiAxiosParamCreator = exports.FavoritesApi = exports.FavoritesApiFactory = exports.FavoritesApiFp = exports.FavoritesApiAxiosParamCreator = exports.ArrayTasksApi = exports.ArrayTasksApiFactory = exports.ArrayTasksApiFp = exports.ArrayTasksApiAxiosParamCreator = exports.ArrayApi = exports.ArrayApiFactory = exports.ArrayApiFp = exports.ArrayApiAxiosParamCreator = exports.UDFType = exports.UDFResultType = exports.UDFLanguage = exports.UDFActions = exports.SSOProvider = exports.Querytype = exports.Querystatus = exports.PublicShareFilter = exports.PricingUnitLabel = exports.PricingType = exports.PricingInterval = exports.PricingCurrency = exports.PricingAggregateUsage = exports.OrganizationRoles = exports.NamespaceActions = exports.Layout = exports.InvitationType = exports.InvitationStatus = exports.FilterType = exports.FilterOption = exports.FileType = exports.FilePropertyName = exports.FavoriteType = exports.Datatype = exports.ArrayType = exports.ArrayTaskType = exports.ArrayTaskStatus = exports.ArrayActions = exports.ActivityEventType = void 0; -exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.UdfApi = exports.UdfApiFactory = exports.UdfApiFp = exports.UdfApiAxiosParamCreator = exports.TasksApi = exports.TasksApiFactory = exports.TasksApiFp = exports.TasksApiAxiosParamCreator = exports.StatsApi = exports.StatsApiFactory = exports.StatsApiFp = exports.StatsApiAxiosParamCreator = exports.SqlApi = exports.SqlApiFactory = exports.SqlApiFp = exports.SqlApiAxiosParamCreator = exports.QueryApi = exports.QueryApiFactory = exports.QueryApiFp = exports.QueryApiAxiosParamCreator = exports.OrganizationApi = exports.OrganizationApiFactory = exports.OrganizationApiFp = void 0; +exports.NotebooksApiAxiosParamCreator = exports.NotebookApi = exports.NotebookApiFactory = exports.NotebookApiFp = exports.NotebookApiAxiosParamCreator = exports.InvitationApi = exports.InvitationApiFactory = exports.InvitationApiFp = exports.InvitationApiAxiosParamCreator = exports.FavoritesApi = exports.FavoritesApiFactory = exports.FavoritesApiFp = exports.FavoritesApiAxiosParamCreator = exports.ArrayTasksApi = exports.ArrayTasksApiFactory = exports.ArrayTasksApiFp = exports.ArrayTasksApiAxiosParamCreator = exports.ArrayApi = exports.ArrayApiFactory = exports.ArrayApiFp = exports.ArrayApiAxiosParamCreator = exports.UDFType = exports.UDFLanguage = exports.UDFActions = exports.SSOProvider = exports.ResultFormat = exports.Querytype = exports.Querystatus = exports.PublicShareFilter = exports.PricingUnitLabel = exports.PricingType = exports.PricingInterval = exports.PricingCurrency = exports.PricingAggregateUsage = exports.OrganizationRoles = exports.NamespaceActions = exports.Layout = exports.InvitationType = exports.InvitationStatus = exports.FilterType = exports.FilterOption = exports.FileType = exports.FilePropertyName = exports.FavoriteType = exports.Datatype = exports.ArrayType = exports.ArrayTaskType = exports.ArrayTaskStatus = exports.ArrayActions = exports.ActivityEventType = void 0; +exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.UdfApi = exports.UdfApiFactory = exports.UdfApiFp = exports.UdfApiAxiosParamCreator = exports.TasksApi = exports.TasksApiFactory = exports.TasksApiFp = exports.TasksApiAxiosParamCreator = exports.StatsApi = exports.StatsApiFactory = exports.StatsApiFp = exports.StatsApiAxiosParamCreator = exports.SqlApi = exports.SqlApiFactory = exports.SqlApiFp = exports.SqlApiAxiosParamCreator = exports.QueryApi = exports.QueryApiFactory = exports.QueryApiFp = exports.QueryApiAxiosParamCreator = exports.OrganizationApi = exports.OrganizationApiFactory = exports.OrganizationApiFp = exports.OrganizationApiAxiosParamCreator = exports.NotebooksApi = exports.NotebooksApiFactory = exports.NotebooksApiFp = void 0; var axios_1 = require("axios"); // Some imports not used depending on template conditions // @ts-ignore @@ -381,6 +381,17 @@ var Querytype; Querytype["Read"] = "READ"; Querytype["Write"] = "WRITE"; })(Querytype = exports.Querytype || (exports.Querytype = {})); +/** + * Results type + * @export + * @enum {string} + */ +var ResultFormat; +(function (ResultFormat) { + ResultFormat["Native"] = "native"; + ResultFormat["Json"] = "json"; + ResultFormat["Arrow"] = "arrow"; +})(ResultFormat = exports.ResultFormat || (exports.ResultFormat = {})); /** * Single sign on provider * @export @@ -412,17 +423,6 @@ var UDFLanguage; UDFLanguage["Python"] = "python"; UDFLanguage["R"] = "r"; })(UDFLanguage = exports.UDFLanguage || (exports.UDFLanguage = {})); -/** - * Results type - * @export - * @enum {string} - */ -var UDFResultType; -(function (UDFResultType) { - UDFResultType["Native"] = "native"; - UDFResultType["Json"] = "json"; - UDFResultType["Arrow"] = "arrow"; -})(UDFResultType = exports.UDFResultType || (exports.UDFResultType = {})); /** * UDF Type * @export @@ -570,16 +570,16 @@ var ArrayApiAxiosParamCreator = function (configuration) { localVarQueryParameter['permissions'] = permissions; } if (tag) { - localVarQueryParameter['tag'] = tag.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['tag'] = tag; } if (excludeTag) { - localVarQueryParameter['exclude_tag'] = excludeTag.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['exclude_tag'] = excludeTag; } if (fileType) { - localVarQueryParameter['file_type'] = fileType.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['file_type'] = fileType; } if (excludeFileType) { - localVarQueryParameter['exclude_file_type'] = excludeFileType.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['exclude_file_type'] = excludeFileType; } common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -694,16 +694,16 @@ var ArrayApiAxiosParamCreator = function (configuration) { localVarQueryParameter['permissions'] = permissions; } if (tag) { - localVarQueryParameter['tag'] = tag.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['tag'] = tag; } if (excludeTag) { - localVarQueryParameter['exclude_tag'] = excludeTag.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['exclude_tag'] = excludeTag; } if (fileType) { - localVarQueryParameter['file_type'] = fileType.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['file_type'] = fileType; } if (excludeFileType) { - localVarQueryParameter['exclude_file_type'] = excludeFileType.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['exclude_file_type'] = excludeFileType; } common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -818,16 +818,16 @@ var ArrayApiAxiosParamCreator = function (configuration) { localVarQueryParameter['permissions'] = permissions; } if (tag) { - localVarQueryParameter['tag'] = tag.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['tag'] = tag; } if (excludeTag) { - localVarQueryParameter['exclude_tag'] = excludeTag.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['exclude_tag'] = excludeTag; } if (fileType) { - localVarQueryParameter['file_type'] = fileType.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['file_type'] = fileType; } if (excludeFileType) { - localVarQueryParameter['exclude_file_type'] = excludeFileType.join(base_1.COLLECTION_FORMATS.csv); + localVarQueryParameter['exclude_file_type'] = excludeFileType; } common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -1440,6 +1440,56 @@ var ArrayApiAxiosParamCreator = function (configuration) { }); }); }, + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomainJson: function (namespace, array, options) { + if (options === void 0) { options = {}; } + return __awaiter(_this, void 0, void 0, function () { + var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: + // verify required parameter 'namespace' is not null or undefined + common_1.assertParamExists('getArrayNonEmptyDomainJson', 'namespace', namespace); + // verify required parameter 'array' is not null or undefined + common_1.assertParamExists('getArrayNonEmptyDomainJson', 'array', array); + localVarPath = "/arrays/{namespace}/{array}/non_empty_domain_json" + .replace("{" + "namespace" + "}", encodeURIComponent(String(namespace))) + .replace("{" + "array" + "}", encodeURIComponent(String(array))); + localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); + if (configuration) { + baseOptions = configuration.baseOptions; + } + localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options); + localVarHeaderParameter = {}; + localVarQueryParameter = {}; + // authentication ApiKeyAuth required + return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) + // authentication BasicAuth required + // http basic authentication required + ]; + case 1: + // authentication ApiKeyAuth required + _a.sent(); + // authentication BasicAuth required + // http basic authentication required + common_1.setBasicAuthToObject(localVarRequestOptions, configuration); + common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); + return [2 /*return*/, { + url: common_1.toPathString(localVarUrlObj), + options: localVarRequestOptions + }]; + } + }); + }); + }, /** * get an sample set of data from the array * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -2236,6 +2286,26 @@ var ArrayApiFp = function (configuration) { }); }); }, + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomainJson: function (namespace, array, options) { + return __awaiter(this, void 0, void 0, function () { + var localVarAxiosArgs; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: return [4 /*yield*/, localVarAxiosParamCreator.getArrayNonEmptyDomainJson(namespace, array, options)]; + case 1: + localVarAxiosArgs = _a.sent(); + return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; + } + }); + }); + }, /** * get an sample set of data from the array * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -2612,6 +2682,16 @@ var ArrayApiFactory = function (configuration, basePath, axios) { getArrayNonEmptyDomain: function (namespace, array, contentType, xPayer, options) { return localVarFp.getArrayNonEmptyDomain(namespace, array, contentType, xPayer, options).then(function (request) { return request(axios, basePath); }); }, + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getArrayNonEmptyDomainJson: function (namespace, array, options) { + return localVarFp.getArrayNonEmptyDomainJson(namespace, array, options).then(function (request) { return request(axios, basePath); }); + }, /** * get an sample set of data from the array * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -2946,6 +3026,18 @@ var ArrayApi = /** @class */ (function (_super) { var _this = this; return exports.ArrayApiFp(this.configuration).getArrayNonEmptyDomain(namespace, array, contentType, xPayer, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; + /** + * get non-empty domain from the array in json format + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ArrayApi + */ + ArrayApi.prototype.getArrayNonEmptyDomainJson = function (namespace, array, options) { + var _this = this; + return exports.ArrayApiFp(this.configuration).getArrayNonEmptyDomainJson(namespace, array, options).then(function (request) { return request(_this.axios, _this.basePath); }); + }; /** * get an sample set of data from the array * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -4534,6 +4626,142 @@ var NotebookApi = /** @class */ (function (_super) { return NotebookApi; }(base_1.BaseAPI)); exports.NotebookApi = NotebookApi; +/** + * NotebooksApi - axios parameter creator + * @export + */ +var NotebooksApiAxiosParamCreator = function (configuration) { + var _this = this; + return { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notebooksNamespaceArrayVersionsGet: function (namespace, array, options) { + if (options === void 0) { options = {}; } + return __awaiter(_this, void 0, void 0, function () { + var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: + // verify required parameter 'namespace' is not null or undefined + common_1.assertParamExists('notebooksNamespaceArrayVersionsGet', 'namespace', namespace); + // verify required parameter 'array' is not null or undefined + common_1.assertParamExists('notebooksNamespaceArrayVersionsGet', 'array', array); + localVarPath = "/notebooks/{namespace}/{array}/versions" + .replace("{" + "namespace" + "}", encodeURIComponent(String(namespace))) + .replace("{" + "array" + "}", encodeURIComponent(String(array))); + localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); + if (configuration) { + baseOptions = configuration.baseOptions; + } + localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options); + localVarHeaderParameter = {}; + localVarQueryParameter = {}; + // authentication ApiKeyAuth required + return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) + // authentication BasicAuth required + // http basic authentication required + ]; + case 1: + // authentication ApiKeyAuth required + _a.sent(); + // authentication BasicAuth required + // http basic authentication required + common_1.setBasicAuthToObject(localVarRequestOptions, configuration); + common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); + return [2 /*return*/, { + url: common_1.toPathString(localVarUrlObj), + options: localVarRequestOptions + }]; + } + }); + }); + } + }; +}; +exports.NotebooksApiAxiosParamCreator = NotebooksApiAxiosParamCreator; +/** + * NotebooksApi - functional programming interface + * @export + */ +var NotebooksApiFp = function (configuration) { + var localVarAxiosParamCreator = exports.NotebooksApiAxiosParamCreator(configuration); + return { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notebooksNamespaceArrayVersionsGet: function (namespace, array, options) { + return __awaiter(this, void 0, void 0, function () { + var localVarAxiosArgs; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: return [4 /*yield*/, localVarAxiosParamCreator.notebooksNamespaceArrayVersionsGet(namespace, array, options)]; + case 1: + localVarAxiosArgs = _a.sent(); + return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; + } + }); + }); + } + }; +}; +exports.NotebooksApiFp = NotebooksApiFp; +/** + * NotebooksApi - factory interface + * @export + */ +var NotebooksApiFactory = function (configuration, basePath, axios) { + var localVarFp = exports.NotebooksApiFp(configuration); + return { + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notebooksNamespaceArrayVersionsGet: function (namespace, array, options) { + return localVarFp.notebooksNamespaceArrayVersionsGet(namespace, array, options).then(function (request) { return request(axios, basePath); }); + } + }; +}; +exports.NotebooksApiFactory = NotebooksApiFactory; +/** + * NotebooksApi - object-oriented interface + * @export + * @class NotebooksApi + * @extends {BaseAPI} + */ +var NotebooksApi = /** @class */ (function (_super) { + __extends(NotebooksApi, _super); + function NotebooksApi() { + return _super !== null && _super.apply(this, arguments) || this; + } + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotebooksApi + */ + NotebooksApi.prototype.notebooksNamespaceArrayVersionsGet = function (namespace, array, options) { + var _this = this; + return exports.NotebooksApiFp(this.configuration).notebooksNamespaceArrayVersionsGet(namespace, array, options).then(function (request) { return request(_this.axios, _this.basePath); }); + }; + return NotebooksApi; +}(base_1.BaseAPI)); +exports.NotebooksApi = NotebooksApi; /** * OrganizationApi - axios parameter creator * @export @@ -6932,56 +7160,6 @@ var TasksApiAxiosParamCreator = function (configuration) { }); }); }, - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdRetryPost: function (id, acceptEncoding, options) { - if (options === void 0) { options = {}; } - return __awaiter(_this, void 0, void 0, function () { - var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; - return __generator(this, function (_a) { - switch (_a.label) { - case 0: - // verify required parameter 'id' is not null or undefined - common_1.assertParamExists('taskIdRetryPost', 'id', id); - localVarPath = "/task/{id}/retry" - .replace("{" + "id" + "}", encodeURIComponent(String(id))); - localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); - if (configuration) { - baseOptions = configuration.baseOptions; - } - localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options); - localVarHeaderParameter = {}; - localVarQueryParameter = {}; - // authentication ApiKeyAuth required - return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - // authentication BasicAuth required - // http basic authentication required - ]; - case 1: - // authentication ApiKeyAuth required - _a.sent(); - // authentication BasicAuth required - // http basic authentication required - common_1.setBasicAuthToObject(localVarRequestOptions, configuration); - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); - return [2 /*return*/, { - url: common_1.toPathString(localVarUrlObj), - options: localVarRequestOptions - }]; - } - }); - }); - }, /** * Fetch a list of all array tasks a user has access to * @param {string} [namespace] namespace to filter @@ -6993,13 +7171,15 @@ var TasksApiAxiosParamCreator = function (configuration) { * @param {number} [perPage] pagination limit * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included * @param {string} [status] Filter to only return these statuses * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include start_time, name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - tasksGet: function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options) { + tasksGet: function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options) { if (options === void 0) { options = {}; } return __awaiter(_this, void 0, void 0, function () { var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; @@ -7052,6 +7232,12 @@ var TasksApiAxiosParamCreator = function (configuration) { if (excludeType) { localVarQueryParameter['exclude_type'] = excludeType.join(base_1.COLLECTION_FORMATS.csv); } + if (fileType) { + localVarQueryParameter['file_type'] = fileType; + } + if (excludeFileType) { + localVarQueryParameter['exclude_file_type'] = excludeFileType; + } if (status !== undefined) { localVarQueryParameter['status'] = status; } @@ -7142,26 +7328,6 @@ var TasksApiFp = function (configuration) { }); }); }, - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdRetryPost: function (id, acceptEncoding, options) { - return __awaiter(this, void 0, void 0, function () { - var localVarAxiosArgs; - return __generator(this, function (_a) { - switch (_a.label) { - case 0: return [4 /*yield*/, localVarAxiosParamCreator.taskIdRetryPost(id, acceptEncoding, options)]; - case 1: - localVarAxiosArgs = _a.sent(); - return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; - } - }); - }); - }, /** * Fetch a list of all array tasks a user has access to * @param {string} [namespace] namespace to filter @@ -7173,18 +7339,20 @@ var TasksApiFp = function (configuration) { * @param {number} [perPage] pagination limit * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included * @param {string} [status] Filter to only return these statuses * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include start_time, name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - tasksGet: function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options) { + tasksGet: function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options) { return __awaiter(this, void 0, void 0, function () { var localVarAxiosArgs; return __generator(this, function (_a) { switch (_a.label) { - case 0: return [4 /*yield*/, localVarAxiosParamCreator.tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options)]; + case 0: return [4 /*yield*/, localVarAxiosParamCreator.tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options)]; case 1: localVarAxiosArgs = _a.sent(); return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; @@ -7232,16 +7400,6 @@ var TasksApiFactory = function (configuration, basePath, axios) { taskIdResultGet: function (id, acceptEncoding, options) { return localVarFp.taskIdResultGet(id, acceptEncoding, options).then(function (request) { return request(axios, basePath); }); }, - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdRetryPost: function (id, acceptEncoding, options) { - return localVarFp.taskIdRetryPost(id, acceptEncoding, options).then(function (request) { return request(axios, basePath); }); - }, /** * Fetch a list of all array tasks a user has access to * @param {string} [namespace] namespace to filter @@ -7253,14 +7411,16 @@ var TasksApiFactory = function (configuration, basePath, axios) { * @param {number} [perPage] pagination limit * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included * @param {string} [status] Filter to only return these statuses * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include start_time, name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - tasksGet: function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options) { - return localVarFp.tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options).then(function (request) { return request(axios, basePath); }); + tasksGet: function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options) { + return localVarFp.tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options).then(function (request) { return request(axios, basePath); }); } }; }; @@ -7312,18 +7472,6 @@ var TasksApi = /** @class */ (function (_super) { var _this = this; return exports.TasksApiFp(this.configuration).taskIdResultGet(id, acceptEncoding, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - TasksApi.prototype.taskIdRetryPost = function (id, acceptEncoding, options) { - var _this = this; - return exports.TasksApiFp(this.configuration).taskIdRetryPost(id, acceptEncoding, options).then(function (request) { return request(_this.axios, _this.basePath); }); - }; /** * Fetch a list of all array tasks a user has access to * @param {string} [namespace] namespace to filter @@ -7335,6 +7483,8 @@ var TasksApi = /** @class */ (function (_super) { * @param {number} [perPage] pagination limit * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included + * @param {Array} [fileType] match file_type of task array, more than one can be included + * @param {Array} [excludeFileType] exclude file_type of task arrays, more than one can be included * @param {string} [status] Filter to only return these statuses * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include start_time, name @@ -7342,9 +7492,9 @@ var TasksApi = /** @class */ (function (_super) { * @throws {RequiredError} * @memberof TasksApi */ - TasksApi.prototype.tasksGet = function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options) { + TasksApi.prototype.tasksGet = function (namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options) { var _this = this; - return exports.TasksApiFp(this.configuration).tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options).then(function (request) { return request(_this.axios, _this.basePath); }); + return exports.TasksApiFp(this.configuration).tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, fileType, excludeFileType, status, search, orderby, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; return TasksApi; }(base_1.BaseAPI)); @@ -7671,11 +7821,66 @@ var UdfApiAxiosParamCreator = function (configuration) { }); }); }, + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitMultiArrayUDF: function (namespace, udf, acceptEncoding, options) { + if (options === void 0) { options = {}; } + return __awaiter(_this, void 0, void 0, function () { + var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: + // verify required parameter 'namespace' is not null or undefined + common_1.assertParamExists('submitMultiArrayUDF', 'namespace', namespace); + // verify required parameter 'udf' is not null or undefined + common_1.assertParamExists('submitMultiArrayUDF', 'udf', udf); + localVarPath = "/udfs/arrays/{namespace}" + .replace("{" + "namespace" + "}", encodeURIComponent(String(namespace))); + localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); + if (configuration) { + baseOptions = configuration.baseOptions; + } + localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options); + localVarHeaderParameter = {}; + localVarQueryParameter = {}; + // authentication ApiKeyAuth required + return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) + // authentication BasicAuth required + // http basic authentication required + ]; + case 1: + // authentication ApiKeyAuth required + _a.sent(); + // authentication BasicAuth required + // http basic authentication required + common_1.setBasicAuthToObject(localVarRequestOptions, configuration); + if (acceptEncoding !== undefined && acceptEncoding !== null) { + localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; + common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); + localVarRequestOptions.data = common_1.serializeDataIfNeeded(udf, localVarRequestOptions, configuration); + return [2 /*return*/, { + url: common_1.toPathString(localVarUrlObj), + options: localVarRequestOptions + }]; + } + }); + }); + }, /** * send a UDF to run against a specified array/URI registered to a group/project * @param {string} namespace namespace array is in (an organization name or user\'s username) * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run + * @param {MultiArrayUDF} udf udf to run * @param {string} [xPayer] Name of organization or user who should be charged for this request * @param {string} [acceptEncoding] Encoding to use * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs @@ -7738,6 +7943,56 @@ var UdfApiAxiosParamCreator = function (configuration) { }); }); }, + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + udfNamespaceArrayVersionsGet: function (namespace, array, options) { + if (options === void 0) { options = {}; } + return __awaiter(_this, void 0, void 0, function () { + var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: + // verify required parameter 'namespace' is not null or undefined + common_1.assertParamExists('udfNamespaceArrayVersionsGet', 'namespace', namespace); + // verify required parameter 'array' is not null or undefined + common_1.assertParamExists('udfNamespaceArrayVersionsGet', 'array', array); + localVarPath = "/udf/{namespace}/{array}/versions" + .replace("{" + "namespace" + "}", encodeURIComponent(String(namespace))) + .replace("{" + "array" + "}", encodeURIComponent(String(array))); + localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); + if (configuration) { + baseOptions = configuration.baseOptions; + } + localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options); + localVarHeaderParameter = {}; + localVarQueryParameter = {}; + // authentication ApiKeyAuth required + return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) + // authentication BasicAuth required + // http basic authentication required + ]; + case 1: + // authentication ApiKeyAuth required + _a.sent(); + // authentication BasicAuth required + // http basic authentication required + common_1.setBasicAuthToObject(localVarRequestOptions, configuration); + common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); + return [2 /*return*/, { + url: common_1.toPathString(localVarUrlObj), + options: localVarRequestOptions + }]; + } + }); + }); + }, /** * updated an existing registerd UDF in the given namespace * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -7926,11 +8181,32 @@ var UdfApiFp = function (configuration) { }); }); }, + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitMultiArrayUDF: function (namespace, udf, acceptEncoding, options) { + return __awaiter(this, void 0, void 0, function () { + var localVarAxiosArgs; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: return [4 /*yield*/, localVarAxiosParamCreator.submitMultiArrayUDF(namespace, udf, acceptEncoding, options)]; + case 1: + localVarAxiosArgs = _a.sent(); + return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; + } + }); + }); + }, /** * send a UDF to run against a specified array/URI registered to a group/project * @param {string} namespace namespace array is in (an organization name or user\'s username) * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run + * @param {MultiArrayUDF} udf udf to run * @param {string} [xPayer] Name of organization or user who should be charged for this request * @param {string} [acceptEncoding] Encoding to use * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs @@ -7950,6 +8226,26 @@ var UdfApiFp = function (configuration) { }); }); }, + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + udfNamespaceArrayVersionsGet: function (namespace, array, options) { + return __awaiter(this, void 0, void 0, function () { + var localVarAxiosArgs; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: return [4 /*yield*/, localVarAxiosParamCreator.udfNamespaceArrayVersionsGet(namespace, array, options)]; + case 1: + localVarAxiosArgs = _a.sent(); + return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; + } + }); + }); + }, /** * updated an existing registerd UDF in the given namespace * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -8044,11 +8340,22 @@ var UdfApiFactory = function (configuration, basePath, axios) { submitGenericUDF: function (namespace, udf, acceptEncoding, options) { return localVarFp.submitGenericUDF(namespace, udf, acceptEncoding, options).then(function (request) { return request(axios, basePath); }); }, + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + submitMultiArrayUDF: function (namespace, udf, acceptEncoding, options) { + return localVarFp.submitMultiArrayUDF(namespace, udf, acceptEncoding, options).then(function (request) { return request(axios, basePath); }); + }, /** * send a UDF to run against a specified array/URI registered to a group/project * @param {string} namespace namespace array is in (an organization name or user\'s username) * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run + * @param {MultiArrayUDF} udf udf to run * @param {string} [xPayer] Name of organization or user who should be charged for this request * @param {string} [acceptEncoding] Encoding to use * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs @@ -8058,6 +8365,16 @@ var UdfApiFactory = function (configuration, basePath, axios) { submitUDF: function (namespace, array, udf, xPayer, acceptEncoding, v2, options) { return localVarFp.submitUDF(namespace, array, udf, xPayer, acceptEncoding, v2, options).then(function (request) { return request(axios, basePath); }); }, + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + udfNamespaceArrayVersionsGet: function (namespace, array, options) { + return localVarFp.udfNamespaceArrayVersionsGet(namespace, array, options).then(function (request) { return request(axios, basePath); }); + }, /** * updated an existing registerd UDF in the given namespace * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -8158,11 +8475,24 @@ var UdfApi = /** @class */ (function (_super) { var _this = this; return exports.UdfApiFp(this.configuration).submitGenericUDF(namespace, udf, acceptEncoding, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; + /** + * submit a multi-array UDF in the given namespace + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {MultiArrayUDF} udf udf to run + * @param {string} [acceptEncoding] Encoding to use + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + UdfApi.prototype.submitMultiArrayUDF = function (namespace, udf, acceptEncoding, options) { + var _this = this; + return exports.UdfApiFp(this.configuration).submitMultiArrayUDF(namespace, udf, acceptEncoding, options).then(function (request) { return request(_this.axios, _this.basePath); }); + }; /** * send a UDF to run against a specified array/URI registered to a group/project * @param {string} namespace namespace array is in (an organization name or user\'s username) * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run + * @param {MultiArrayUDF} udf udf to run * @param {string} [xPayer] Name of organization or user who should be charged for this request * @param {string} [acceptEncoding] Encoding to use * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs @@ -8174,6 +8504,18 @@ var UdfApi = /** @class */ (function (_super) { var _this = this; return exports.UdfApiFp(this.configuration).submitUDF(namespace, array, udf, xPayer, acceptEncoding, v2, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; + /** + * retrieve a list of timestamps from the array fragment info listing in milliseconds + * @param {string} namespace namespace array is in (an organization name or user\'s username) + * @param {string} array name/uri of array that is url-encoded + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + UdfApi.prototype.udfNamespaceArrayVersionsGet = function (namespace, array, options) { + var _this = this; + return exports.UdfApiFp(this.configuration).udfNamespaceArrayVersionsGet(namespace, array, options).then(function (request) { return request(_this.axios, _this.basePath); }); + }; /** * updated an existing registerd UDF in the given namespace * @param {string} namespace namespace array is in (an organization name or user\'s username) @@ -8994,6 +9336,48 @@ var UserApiAxiosParamCreator = function (configuration) { }); }); }, + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensSessionGet: function (options) { + if (options === void 0) { options = {}; } + return __awaiter(_this, void 0, void 0, function () { + var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: + localVarPath = "/tokens/session"; + localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); + if (configuration) { + baseOptions = configuration.baseOptions; + } + localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options); + localVarHeaderParameter = {}; + localVarQueryParameter = {}; + // authentication ApiKeyAuth required + return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) + // authentication BasicAuth required + // http basic authentication required + ]; + case 1: + // authentication ApiKeyAuth required + _a.sent(); + // authentication BasicAuth required + // http basic authentication required + common_1.setBasicAuthToObject(localVarRequestOptions, configuration); + common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); + return [2 /*return*/, { + url: common_1.toPathString(localVarUrlObj), + options: localVarRequestOptions + }]; + } + }); + }); + }, /** * Update aws keys or associated buckets. This will update the key associations for each array in the namespace * @param {string} namespace namespace @@ -9491,6 +9875,24 @@ var UserApiFp = function (configuration) { }); }); }, + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensSessionGet: function (options) { + return __awaiter(this, void 0, void 0, function () { + var localVarAxiosArgs; + return __generator(this, function (_a) { + switch (_a.label) { + case 0: return [4 /*yield*/, localVarAxiosParamCreator.tokensSessionGet(options)]; + case 1: + localVarAxiosArgs = _a.sent(); + return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1["default"], base_1.BASE_PATH, configuration)]; + } + }); + }); + }, /** * Update aws keys or associated buckets. This will update the key associations for each array in the namespace * @param {string} namespace namespace @@ -9719,6 +10121,14 @@ var UserApiFactory = function (configuration, basePath, axios) { tokensGet: function (options) { return localVarFp.tokensGet(options).then(function (request) { return request(axios, basePath); }); }, + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tokensSessionGet: function (options) { + return localVarFp.tokensSessionGet(options).then(function (request) { return request(axios, basePath); }); + }, /** * Update aws keys or associated buckets. This will update the key associations for each array in the namespace * @param {string} namespace namespace @@ -9955,6 +10365,16 @@ var UserApi = /** @class */ (function (_super) { var _this = this; return exports.UserApiFp(this.configuration).tokensGet(options).then(function (request) { return request(_this.axios, _this.basePath); }); }; + /** + * Fetch a list of user session tokens + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UserApi + */ + UserApi.prototype.tokensSessionGet = function (options) { + var _this = this; + return exports.UserApiFp(this.configuration).tokensSessionGet(options).then(function (request) { return request(_this.axios, _this.basePath); }); + }; /** * Update aws keys or associated buckets. This will update the key associations for each array in the namespace * @param {string} namespace namespace diff --git a/lib/api.ts b/lib/api.ts deleted file mode 100644 index abbdcc5..0000000 --- a/lib/api.ts +++ /dev/null @@ -1,11467 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * TileDB Storage Platform API - * TileDB Storage Platform REST API - * - * The version of the OpenAPI document: 2.2.9 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from './configuration'; -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; -// Some imports not used depending on template conditions -// @ts-ignore -import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; -// @ts-ignore -import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; - -/** - * Model representing aws keys or service role, service roles are currently ignored, but will be preferred option in the future - * @export - * @interface AWSAccessCredentials - */ -export interface AWSAccessCredentials { - /** - * aws secret access key, never returned in get requests - * @type {string} - * @memberof AWSAccessCredentials - */ - secret_access_key?: string; - /** - * aws access key - * @type {string} - * @memberof AWSAccessCredentials - */ - access_key_id?: string; - /** - * aws service role to use for access - * @type {string} - * @memberof AWSAccessCredentials - */ - service_role_arn?: string; - /** - * human readable name - * @type {string} - * @memberof AWSAccessCredentials - */ - name?: string; - /** - * true if this is the default credential to be used within this namespace - * @type {boolean} - * @memberof AWSAccessCredentials - */ - default?: boolean; - /** - * a whitelist of one or more buckets this key should access - * @type {Array} - * @memberof AWSAccessCredentials - */ - buckets?: Array; - /** - * Time when udf dependencies was created (rfc3339) - * @type {string} - * @memberof AWSAccessCredentials - */ - created_at?: string; - /** - * Time when udf dependencies was last updated (rfc3339) - * @type {string} - * @memberof AWSAccessCredentials - */ - updated_at?: string; -} -/** - * Type of activity logged - * @export - * @enum {string} - */ -export enum ActivityEventType { - ReadSchema = 'read_schema', - MaxBufferSizes = 'max_buffer_sizes', - NonEmptyDomain = 'non_empty_domain', - QueryRead = 'query_read', - QueryWrite = 'query_write', - Create = 'create', - Delete = 'delete', - Register = 'register', - Deregister = 'deregister', - Udf = 'udf', - ArrayMetadataGet = 'array_metadata_get', - ArrayMetadataUpdate = 'array_metadata_update', - EstimatedResultSizes = 'estimated_result_sizes' -} - -/** - * actions a user can take on an array - * @export - * @enum {string} - */ -export enum ArrayActions { - Read = 'read', - Write = 'write', - Edit = 'edit', - ReadArrayLogs = 'read_array_logs', - ReadArrayInfo = 'read_array_info', - ReadArraySchema = 'read_array_schema' -} - -/** - * Actvity of an Array - * @export - * @interface ArrayActivityLog - */ -export interface ArrayActivityLog { - /** - * time event took place (RFC3339) - * @type {string} - * @memberof ArrayActivityLog - */ - event_at?: string; - /** - * - * @type {ActivityEventType} - * @memberof ArrayActivityLog - */ - action?: ActivityEventType; - /** - * User who performed action - * @type {string} - * @memberof ArrayActivityLog - */ - username?: string; - /** - * Bytes sent to client - * @type {number} - * @memberof ArrayActivityLog - */ - bytes_sent?: number; - /** - * Bytes recieved from client - * @type {number} - * @memberof ArrayActivityLog - */ - bytes_received?: number; - /** - * uuid of associated array task - * @type {string} - * @memberof ArrayActivityLog - */ - array_task_id?: string; - /** - * ranges for query - * @type {string} - * @memberof ArrayActivityLog - */ - query_ranges?: string; -} -/** - * Object including array info and pagination metadata - * @export - * @interface ArrayBrowserData - */ -export interface ArrayBrowserData { - /** - * Array Info - * @type {Array} - * @memberof ArrayBrowserData - */ - arrays?: Array; - /** - * - * @type {PaginationMetadata} - * @memberof ArrayBrowserData - */ - pagination_metadata?: PaginationMetadata; -} -/** - * Object for ui array tasks browser page - * @export - * @interface ArrayBrowserSidebar - */ -export interface ArrayBrowserSidebar { - /** - * list of all unique namespaces to display - * @type {Array} - * @memberof ArrayBrowserSidebar - */ - namespaces?: Array; - /** - * A count of \"all\" of category - * @type {number} - * @memberof ArrayBrowserSidebar - */ - result_count_for_all?: number; - /** - * A map that includes the result count by namespace - * @type {object} - * @memberof ArrayBrowserSidebar - */ - result_count_by_namespace?: object; -} -/** - * metadata of an array - * @export - * @interface ArrayInfo - */ -export interface ArrayInfo { - /** - * unique id of registered array - * @type {string} - * @memberof ArrayInfo - */ - id?: string; - /** - * - * @type {FileType} - * @memberof ArrayInfo - */ - file_type?: FileType; - /** - * map of file properties created for this array - * @type {{ [key: string]: string; }} - * @memberof ArrayInfo - */ - file_properties?: { [key: string]: string; }; - /** - * uri of array - * @type {string} - * @memberof ArrayInfo - */ - uri?: string; - /** - * namespace array is in - * @type {string} - * @memberof ArrayInfo - */ - namespace?: string; - /** - * size in bytes of array - * @type {number} - * @memberof ArrayInfo - */ - size?: number; - /** - * Datetime array was last accessed in UTC - * @type {string} - * @memberof ArrayInfo - */ - last_accessed?: string; - /** - * description of array - * @type {string} - * @memberof ArrayInfo - */ - description?: string; - /** - * name of array - * @type {string} - * @memberof ArrayInfo - */ - name?: string; - /** - * list of actions user is allowed to do on this array - * @type {Array} - * @memberof ArrayInfo - */ - allowed_actions?: Array; - /** - * list of pricing created for this array - * @type {Array} - * @memberof ArrayInfo - */ - pricing?: Array; - /** - * list of subscriptions created for this array - * @type {Array} - * @memberof ArrayInfo - */ - subscriptions?: Array; - /** - * logo (base64 encoded) for the array. Optional - * @type {string} - * @memberof ArrayInfo - */ - logo?: string; - /** - * the name of the access credentials to use. if unset, the default credentials will be used - * @type {string} - * @memberof ArrayInfo - */ - access_credentials_name?: string; - /** - * Array type (dense, key-value, sparse) - * @type {string} - * @memberof ArrayInfo - */ - type?: string; - /** - * number of unique namespaces this array is shared with - * @type {number} - * @memberof ArrayInfo - */ - share_count?: number; - /** - * Suggests if the array was shared to public by owner - * @type {boolean} - * @memberof ArrayInfo - */ - public_share?: boolean; - /** - * Depends on the namespace asking, denotes the existence of subscription of namespace to this array - * @type {boolean} - * @memberof ArrayInfo - */ - namespace_subscribed?: boolean; - /** - * uri for access through TileDB cloud - * @type {string} - * @memberof ArrayInfo - */ - tiledb_uri?: string; - /** - * optional tags for array - * @type {Array} - * @memberof ArrayInfo - */ - tags?: Array; - /** - * License identifier from SPDX License List or Custom - * @type {string} - * @memberof ArrayInfo - */ - license_id?: string; - /** - * License text - * @type {string} - * @memberof ArrayInfo - */ - license_text?: string; -} -/** - * metadata of an array - * @export - * @interface ArrayInfoUpdate - */ -export interface ArrayInfoUpdate { - /** - * description of array - * @type {string} - * @memberof ArrayInfoUpdate - */ - description?: string; - /** - * description of array - * @type {string} - * @memberof ArrayInfoUpdate - */ - name?: string; - /** - * uri of array - * @type {string} - * @memberof ArrayInfoUpdate - */ - uri?: string; - /** - * - * @type {FileType} - * @memberof ArrayInfoUpdate - */ - file_type?: FileType; - /** - * map of file properties created for this array - * @type {{ [key: string]: string; }} - * @memberof ArrayInfoUpdate - */ - file_properties?: { [key: string]: string; }; - /** - * the name of the access credentials to use. if unset, the default credentials will be used - * @type {string} - * @memberof ArrayInfoUpdate - */ - access_credentials_name?: string; - /** - * logo (base64 encoded) for the array. Optional - * @type {string} - * @memberof ArrayInfoUpdate - */ - logo?: string; - /** - * optional tags for array - * @type {Array} - * @memberof ArrayInfoUpdate - */ - tags?: Array; - /** - * License identifier from SPDX License List or Custom - * @type {string} - * @memberof ArrayInfoUpdate - */ - license_id?: string; - /** - * License text - * @type {string} - * @memberof ArrayInfoUpdate - */ - license_text?: string; -} -/** - * user\'s TileDB array metadata - * @export - * @interface ArrayMetadata - */ -export interface ArrayMetadata { - /** - * List of metadata entries - * @type {Array} - * @memberof ArrayMetadata - */ - ranges?: Array; -} -/** - * key/value pair representing an array metadata map entry - * @export - * @interface ArrayMetadataEntry - */ -export interface ArrayMetadataEntry { - /** - * - * @type {string} - * @memberof ArrayMetadataEntry - */ - key?: string; - /** - * - * @type {string} - * @memberof ArrayMetadataEntry - */ - type?: string; - /** - * - * @type {number} - * @memberof ArrayMetadataEntry - */ - value_num?: number; - /** - * - * @type {Array} - * @memberof ArrayMetadataEntry - */ - value?: Array; - /** - * - * @type {boolean} - * @memberof ArrayMetadataEntry - */ - del?: boolean; -} -/** - * Sample data from array - * @export - * @interface ArraySample - */ -export interface ArraySample { - /** - * - * @type {object} - * @memberof ArraySample - */ - data?: object; -} -/** - * ArraySchema during creation or retrieval - * @export - * @interface ArraySchema - */ -export interface ArraySchema { - /** - * URI of schema - * @type {string} - * @memberof ArraySchema - */ - uri?: string; - /** - * file format version - * @type {Array} - * @memberof ArraySchema - */ - version: Array; - /** - * - * @type {ArrayType} - * @memberof ArraySchema - */ - arrayType: ArrayType; - /** - * - * @type {Layout} - * @memberof ArraySchema - */ - tileOrder: Layout; - /** - * - * @type {Layout} - * @memberof ArraySchema - */ - cellOrder: Layout; - /** - * Capacity of array - * @type {number} - * @memberof ArraySchema - */ - capacity: number; - /** - * - * @type {FilterPipeline} - * @memberof ArraySchema - */ - coordsFilterPipeline: FilterPipeline; - /** - * - * @type {FilterPipeline} - * @memberof ArraySchema - */ - offsetFilterPipeline: FilterPipeline; - /** - * - * @type {Domain} - * @memberof ArraySchema - */ - domain: Domain; - /** - * Attributes of array - * @type {Array} - * @memberof ArraySchema - */ - attributes: Array; - /** - * True if the array allows coordinate duplicates. Applicable only to sparse arrays. - * @type {boolean} - * @memberof ArraySchema - */ - allowsDuplicates?: boolean; -} -/** - * details for sharing a given array - * @export - * @interface ArraySharing - */ -export interface ArraySharing { - /** - * List of permitted actions - * @type {Array} - * @memberof ArraySharing - */ - actions?: Array; - /** - * namespace being granted array access can be a user or organization - * @type {string} - * @memberof ArraySharing - */ - namespace?: string; - /** - * details on if the namespace is a organization or user - * @type {string} - * @memberof ArraySharing - */ - namespace_type?: string; -} -/** - * Synchronous Task to Run - * @export - * @interface ArrayTask - */ -export interface ArrayTask { - /** - * task id - * @type {string} - * @memberof ArrayTask - */ - id?: string; - /** - * Optional task name - * @type {string} - * @memberof ArrayTask - */ - name?: string; - /** - * Optional task description (Tasks purpose) - * @type {string} - * @memberof ArrayTask - */ - description?: string; - /** - * - * @type {ArrayInfo} - * @memberof ArrayTask - */ - array_metadata?: ArrayInfo; - /** - * - * @type {DomainArray} - * @memberof ArrayTask - */ - subarray?: DomainArray; - /** - * memory allocated to task in bytes - * @type {number} - * @memberof ArrayTask - */ - memory?: number; - /** - * millicpu allocated to task - * @type {number} - * @memberof ArrayTask - */ - cpu?: number; - /** - * namespace task is tied to - * @type {string} - * @memberof ArrayTask - */ - namespace?: string; - /** - * - * @type {ArrayTaskStatus} - * @memberof ArrayTask - */ - status?: ArrayTaskStatus; - /** - * Start time RFC3339 for job - * @type {string} - * @memberof ArrayTask - */ - start_time?: string; - /** - * Finish time RFC3339 for job - * @type {string} - * @memberof ArrayTask - */ - finish_time?: string; - /** - * Cost accumulated for task in USD, example is $0.12 - * @type {number} - * @memberof ArrayTask - */ - cost?: number; - /** - * - * @type {Querytype} - * @memberof ArrayTask - */ - query_type?: Querytype; - /** - * Optional actual code that is going to be executed - * @type {string} - * @memberof ArrayTask - */ - udf_code?: string; - /** - * Optional actual language used to express udf_code - * @type {string} - * @memberof ArrayTask - */ - udf_language?: string; - /** - * Optional actual sql query that is going to be executed - * @type {string} - * @memberof ArrayTask - */ - sql_query?: string; - /** - * - * @type {ArrayTaskType} - * @memberof ArrayTask - */ - type?: ArrayTaskType; - /** - * Array activity logs for task - * @type {Array} - * @memberof ArrayTask - */ - activity?: Array; - /** - * logs from array task - * @type {string} - * @memberof ArrayTask - */ - logs?: string; - /** - * duration in nanoseconds of an array task - * @type {number} - * @memberof ArrayTask - */ - duration?: number; -} -/** - * Object for ui array tasks browser page - * @export - * @interface ArrayTaskBrowserSidebar - */ -export interface ArrayTaskBrowserSidebar { - /** - * list of all unique organizations the user is part of that have array tasks - * @type {Array} - * @memberof ArrayTaskBrowserSidebar - */ - organizations?: Array; - /** - * A count of \"all\" - * @type {number} - * @memberof ArrayTaskBrowserSidebar - */ - result_count_for_all?: number; - /** - * A map that includes the result count by namespace - * @type {object} - * @memberof ArrayTaskBrowserSidebar - */ - result_count_by_namespace?: object; -} -/** - * Object including array tasks and metadata - * @export - * @interface ArrayTaskData - */ -export interface ArrayTaskData { - /** - * Array Tasks - * @type {Array} - * @memberof ArrayTaskData - */ - array_tasks?: Array; - /** - * - * @type {PaginationMetadata} - * @memberof ArrayTaskData - */ - pagination_metadata?: PaginationMetadata; -} -/** - * Array task stderr/stdout logs - * @export - * @interface ArrayTaskLog - */ -export interface ArrayTaskLog { - /** - * ID of associated task - * @type {string} - * @memberof ArrayTaskLog - */ - array_task_id?: string; - /** - * logs from array task - * @type {string} - * @memberof ArrayTaskLog - */ - logs?: string; -} -/** - * Status of array task - * @export - * @enum {string} - */ -export enum ArrayTaskStatus { - Failed = 'FAILED', - Completed = 'COMPLETED', - Running = 'RUNNING' -} - -/** - * Synchronous Task Type - * @export - * @enum {string} - */ -export enum ArrayTaskType { - Sql = 'SQL', - Udf = 'UDF', - Query = 'QUERY', - GenericUdf = 'GENERIC_UDF' -} - -/** - * TileDB array type - * @export - * @enum {string} - */ -export enum ArrayType { - Dense = 'dense', - Sparse = 'sparse' -} - -/** - * Attribute of array - * @export - * @interface Attribute - */ -export interface Attribute { - /** - * Attribute name - * @type {string} - * @memberof Attribute - */ - name: string; - /** - * - * @type {Datatype} - * @memberof Attribute - */ - type: Datatype; - /** - * - * @type {FilterPipeline} - * @memberof Attribute - */ - filterPipeline: FilterPipeline; - /** - * Attribute number of values per cell - * @type {number} - * @memberof Attribute - */ - cellValNum: number; - /** - * The default fill value - * @type {Array} - * @memberof Attribute - */ - fillValue?: Array; -} -/** - * Represents an attribute buffer header information - * @export - * @interface AttributeBufferHeader - */ -export interface AttributeBufferHeader { - /** - * Attribute name - * @type {string} - * @memberof AttributeBufferHeader - */ - name: string; - /** - * Number of bytes in the fixed-length attribute data buffer (offsets for var-len attributes) - * @type {number} - * @memberof AttributeBufferHeader - */ - fixedLenBufferSizeInBytes: number; - /** - * Number of bytes in the var-length attribute data buffer - * @type {number} - * @memberof AttributeBufferHeader - */ - varLenBufferSizeInBytes: number; -} -/** - * object representing buffer size of an attribute - * @export - * @interface AttributeBufferSize - */ -export interface AttributeBufferSize { - /** - * name of attribute - * @type {string} - * @memberof AttributeBufferSize - */ - attribute: string; - /** - * buffer size (in bytes) of offset buffer - * @type {number} - * @memberof AttributeBufferSize - */ - offsetBytes: number; - /** - * buffer size (in bytes) of data buffer - * @type {number} - * @memberof AttributeBufferSize - */ - dataBytes: number; -} -/** - * TileDB data type - * @export - * @enum {string} - */ -export enum Datatype { - Int32 = 'INT32', - Int64 = 'INT64', - Float32 = 'FLOAT32', - Float64 = 'FLOAT64', - Char = 'CHAR', - Int8 = 'INT8', - Uint8 = 'UINT8', - Int16 = 'INT16', - Uint16 = 'UINT16', - Uint32 = 'UINT32', - Uint64 = 'UINT64', - StringAscii = 'STRING_ASCII', - StringUtf8 = 'STRING_UTF8', - StringUtf16 = 'STRING_UTF16', - StringUtf32 = 'STRING_UTF32', - StringUcs2 = 'STRING_UCS2', - StringUcs4 = 'STRING_UCS4', - Any = 'ANY' -} - -/** - * Dimension of array - * @export - * @interface Dimension - */ -export interface Dimension { - /** - * Dimension name - * @type {string} - * @memberof Dimension - */ - name?: string; - /** - * - * @type {Datatype} - * @memberof Dimension - */ - type: Datatype; - /** - * - * @type {DomainArray} - * @memberof Dimension - */ - domain: DomainArray; - /** - * Is tile extent null - * @type {boolean} - * @memberof Dimension - */ - nullTileExtent: boolean; - /** - * - * @type {DimensionTileExtent} - * @memberof Dimension - */ - tileExtent?: DimensionTileExtent; - /** - * - * @type {FilterPipeline} - * @memberof Dimension - */ - filterPipeline?: FilterPipeline; -} -/** - * A single, typed coordinate for a dimension - * @export - * @interface DimensionCoordinate - */ -export interface DimensionCoordinate { - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - int8?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - uint8?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - int16?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - uint16?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - int32?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - uint32?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - int64?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - uint64?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - float32?: number; - /** - * - * @type {number} - * @memberof DimensionCoordinate - */ - float64?: number; -} -/** - * Extent of tile - * @export - * @interface DimensionTileExtent - */ -export interface DimensionTileExtent { - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - int8?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - uint8?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - int16?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - uint16?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - int32?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - uint32?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - int64?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - uint64?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - float32?: number; - /** - * - * @type {number} - * @memberof DimensionTileExtent - */ - float64?: number; -} -/** - * Domain of array - * @export - * @interface Domain - */ -export interface Domain { - /** - * - * @type {Datatype} - * @memberof Domain - */ - type: Datatype; - /** - * - * @type {Layout} - * @memberof Domain - */ - tileOrder: Layout; - /** - * - * @type {Layout} - * @memberof Domain - */ - cellOrder: Layout; - /** - * Array of dimensions - * @type {Array} - * @memberof Domain - */ - dimensions: Array; -} -/** - * Domain object for an array of each type - * @export - * @interface DomainArray - */ -export interface DomainArray { - /** - * - * @type {Array} - * @memberof DomainArray - */ - int8?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - uint8?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - int16?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - uint16?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - int32?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - uint32?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - int64?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - uint64?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - float32?: Array; - /** - * - * @type {Array} - * @memberof DomainArray - */ - float64?: Array; -} -/** - * - * @export - * @interface Favorite - */ -export interface Favorite { - /** - * unique uuid of the favorite - * @type {string} - * @memberof Favorite - */ - id?: string; - /** - * - * @type {FavoriteType} - * @memberof Favorite - */ - object_type?: FavoriteType; - /** - * The namespace the favorite is in. It won\'t be persisted in DB - * @type {string} - * @memberof Favorite - */ - namespace?: string; - /** - * Name of the object. It wont be persisted in DB - * @type {string} - * @memberof Favorite - */ - name?: string; -} -/** - * List of values that FavoriteType can take - * @export - * @enum {string} - */ -export enum FavoriteType { - Array = 'ARRAY' -} - -/** - * - * @export - * @interface FavoriteUpdate - */ -export interface FavoriteUpdate { - /** - * - * @type {string} - * @memberof FavoriteUpdate - */ - name?: string; - /** - * - * @type {string} - * @memberof FavoriteUpdate - */ - namespace?: string; - /** - * - * @type {FavoriteType} - * @memberof FavoriteUpdate - */ - object_type?: FavoriteType; -} -/** - * File property assigned to a specific file (array) - * @export - * @enum {string} - */ -export enum FilePropertyName { - Image = 'image', - Size = 'size', - CodeBlock = 'code_block' -} - -/** - * File types represented as TileDB arrays - * @export - * @enum {string} - */ -export enum FileType { - Notebook = 'notebook', - UserDefinedFunction = 'user_defined_function' -} - -/** - * Filter - * @export - * @interface Filter - */ -export interface Filter { - /** - * - * @type {FilterType} - * @memberof Filter - */ - type: FilterType; - /** - * - * @type {FilterData} - * @memberof Filter - */ - data?: FilterData; -} -/** - * Filter data - * @export - * @interface FilterData - */ -export interface FilterData { - /** - * - * @type {number} - * @memberof FilterData - */ - int8?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - uint8?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - int16?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - uint16?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - int32?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - uint32?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - int64?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - uint64?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - float32?: number; - /** - * - * @type {number} - * @memberof FilterData - */ - float64?: number; -} -/** - * TileDB filter option - * @export - * @enum {string} - */ -export enum FilterOption { - CompressionLevel = 'COMPRESSION_LEVEL', - BitWidthMaxWindow = 'BIT_WIDTH_MAX_WINDOW', - PositiveDeltaMaxWindow = 'POSITIVE_DELTA_MAX_WINDOW' -} - -/** - * One or more filters to apply - * @export - * @interface FilterPipeline - */ -export interface FilterPipeline { - /** - * - * @type {Array} - * @memberof FilterPipeline - */ - filters?: Array; -} -/** - * TileDB filter types - * @export - * @enum {string} - */ -export enum FilterType { - None = 'FILTER_NONE', - Gzip = 'FILTER_GZIP', - Zstd = 'FILTER_ZSTD', - Lz4 = 'FILTER_LZ4', - Rle = 'FILTER_RLE', - Bzip2 = 'FILTER_BZIP2', - DoubleDelta = 'FILTER_DOUBLE_DELTA', - BitWidthReduction = 'FILTER_BIT_WIDTH_REDUCTION', - Bitshuffle = 'FILTER_BITSHUFFLE', - Byteshuffle = 'FILTER_BYTESHUFFLE', - PositiveDelta = 'FILTER_POSITIVE_DELTA' -} - -/** - * User-defined function - * @export - * @interface GenericUDF - */ -export interface GenericUDF { - /** - * name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec - * @type {string} - * @memberof GenericUDF - */ - udf_info_name?: string; - /** - * - * @type {UDFLanguage} - * @memberof GenericUDF - */ - language?: UDFLanguage; - /** - * Type-specific version - * @type {string} - * @memberof GenericUDF - */ - version?: string; - /** - * Docker image name to use for udf - * @type {string} - * @memberof GenericUDF - */ - image_name?: string; - /** - * Type-specific executable text - * @type {string} - * @memberof GenericUDF - */ - exec?: string; - /** - * optional raw text to store of serialized function, used for showing in UI - * @type {string} - * @memberof GenericUDF - */ - exec_raw?: string; - /** - * Argument(s) to pass to udf function, tuple or list of args/kwargs which can be in native or json format - * @type {string} - * @memberof GenericUDF - */ - argument?: string; - /** - * - * @type {UDFResultType} - * @memberof GenericUDF - */ - result_format?: UDFResultType; - /** - * string representing the serialization format to use, i.e. cloudpickle version or arrow IPC verison - * @type {string} - * @memberof GenericUDF - */ - result_format_version?: string; - /** - * name of task, optional - * @type {string} - * @memberof GenericUDF - */ - task_name?: string; - /** - * store results for later retrieval - * @type {boolean} - * @memberof GenericUDF - */ - store_results?: boolean; -} -/** - * Password to update - * @export - * @interface InlineObject - */ -export interface InlineObject { - /** - * password - * @type {string} - * @memberof InlineObject - */ - password?: string; -} -/** - * - * @export - * @interface InlineResponse200 - */ -export interface InlineResponse200 { - /** - * string of stats from tiledb - * @type {string} - * @memberof InlineResponse200 - */ - stats?: string; -} -/** - * Invitations to share or collaborate - * @export - * @interface Invitation - */ -export interface Invitation { - /** - * Unique id of invitation added to magic link - * @type {string} - * @memberof Invitation - */ - id?: string; - /** - * - * @type {InvitationType} - * @memberof Invitation - */ - invitation_type?: InvitationType; - /** - * Namespace of the owner of the invitation (user or organization) - * @type {string} - * @memberof Invitation - */ - owner_namespace_uuid?: string; - /** - * Unique id of the user accepted the invitation - * @type {string} - * @memberof Invitation - */ - user_namespace_uuid?: string; - /** - * Unique id of the organization user accepted the invitation - * @type {string} - * @memberof Invitation - */ - organization_user_uuid?: string; - /** - * Name of the organization, does not persist in database - * @type {string} - * @memberof Invitation - */ - organization_name?: string; - /** - * - * @type {OrganizationRoles} - * @memberof Invitation - */ - organization_role?: OrganizationRoles; - /** - * Unique id of the array - * @type {string} - * @memberof Invitation - */ - array_uuid?: string; - /** - * Name of the array, does not persist in database - * @type {string} - * @memberof Invitation - */ - array_name?: string; - /** - * Email of the individual we send the invitation to - * @type {string} - * @memberof Invitation - */ - email?: string; - /** - * A comma separated list of ArrayActions or NamespaceActions - * @type {string} - * @memberof Invitation - */ - actions?: string; - /** - * - * @type {InvitationStatus} - * @memberof Invitation - */ - status?: InvitationStatus; - /** - * Datetime the invitation was created in UTC - * @type {string} - * @memberof Invitation - */ - created_at?: string; - /** - * Datetime the invitation is expected to expire in UTC - * @type {string} - * @memberof Invitation - */ - expires_at?: string; - /** - * Datetime the invitation was accepted in UTC - * @type {string} - * @memberof Invitation - */ - accepted_at?: string; -} -/** - * Encapsulates information regarding inviting people using email to share array, same permissions for all invitees - * @export - * @interface InvitationArrayShareEmail - */ -export interface InvitationArrayShareEmail { - /** - * List of permitted actions - * @type {Array} - * @memberof InvitationArrayShareEmail - */ - actions: Array; - /** - * - * @type {Array} - * @memberof InvitationArrayShareEmail - */ - invitee_email: Array; -} -/** - * Object including invitations and metadata - * @export - * @interface InvitationData - */ -export interface InvitationData { - /** - * List of invitations - * @type {Array} - * @memberof InvitationData - */ - invitations?: Array; - /** - * - * @type {PaginationMetadata} - * @memberof InvitationData - */ - pagination_metadata?: PaginationMetadata; -} -/** - * Encapsulates information regarding inviting people using email to join organization, same permissions for all invitees - * @export - * @interface InvitationOrganizationJoinEmail - */ -export interface InvitationOrganizationJoinEmail { - /** - * List of permitted actions - * @type {Array} - * @memberof InvitationOrganizationJoinEmail - */ - actions?: Array; - /** - * - * @type {OrganizationRoles} - * @memberof InvitationOrganizationJoinEmail - */ - organization_role: OrganizationRoles; - /** - * - * @type {Array} - * @memberof InvitationOrganizationJoinEmail - */ - invitee_email: Array; -} -/** - * List of values that InvitationStatus can take - * @export - * @enum {string} - */ -export enum InvitationStatus { - Pending = 'PENDING', - Accepted = 'ACCEPTED' -} - -/** - * List of values that InvitationType can take - * @export - * @enum {string} - */ -export enum InvitationType { - ArrayShare = 'ARRAY_SHARE', - JoinOrganization = 'JOIN_ORGANIZATION' -} - -/** - * Information related to last access of an array - * @export - * @interface LastAccessedArray - */ -export interface LastAccessedArray { - /** - * unique id of array - * @type {string} - * @memberof LastAccessedArray - */ - array_id?: string; - /** - * name of the array - * @type {string} - * @memberof LastAccessedArray - */ - array_name?: string; - /** - * namespace of a user or organization - * @type {string} - * @memberof LastAccessedArray - */ - namespace?: string; - /** - * timestamp (epoch milliseconds) array is last accessed - * @type {number} - * @memberof LastAccessedArray - */ - accessed_time?: number; - /** - * - * @type {ActivityEventType} - * @memberof LastAccessedArray - */ - access_type?: ActivityEventType; -} -/** - * Layout of array - * @export - * @enum {string} - */ -export enum Layout { - RowMajor = 'row-major', - ColMajor = 'col-major', - GlobalOrder = 'global-order', - Unordered = 'unordered' -} - -/** - * a list of max buffer sizes, one per attribute - * @export - * @interface MaxBufferSizes - */ -export interface MaxBufferSizes { - /** - * - * @type {Array} - * @memberof MaxBufferSizes - */ - maxBufferSizes?: Array; -} -/** - * Represents an open array - * @export - * @interface ModelArray - */ -export interface ModelArray { - /** - * timestamp (epoch milliseconds) array is opened at - * @type {number} - * @memberof ModelArray - */ - timestamp: number; - /** - * - * @type {Querytype} - * @memberof ModelArray - */ - queryType: Querytype; - /** - * Array uri - * @type {string} - * @memberof ModelArray - */ - uri: string; -} -/** - * - * @export - * @interface ModelError - */ -export interface ModelError { - /** - * - * @type {number} - * @memberof ModelError - */ - code?: number; - /** - * - * @type {string} - * @memberof ModelError - */ - message?: string; - /** - * - * @type {string} - * @memberof ModelError - */ - request_id?: string; -} -/** - * actions a user can take on an organization - * @export - * @enum {string} - */ -export enum NamespaceActions { - Read = 'read', - Write = 'write', - Create = 'create', - Delete = 'delete', - Edit = 'edit', - ReadArrayLogs = 'read_array_logs', - ReadJobLogs = 'read_job_logs', - ReadObjectLogs = 'read_object_logs', - RunJob = 'run_job', - DeleteOrganization = 'delete_organization', - EditOrganization = 'edit_organization', - EditBilling = 'edit_billing' -} - -/** - * object representing a non-empty domain - * @export - * @interface NonEmptyDomain - */ -export interface NonEmptyDomain { - /** - * - * @type {DomainArray} - * @memberof NonEmptyDomain - */ - nonEmptyDomain: DomainArray; - /** - * Is non-empty domain really empty? - * @type {boolean} - * @memberof NonEmptyDomain - */ - isEmpty: boolean; -} -/** - * Status details of a notebook server - * @export - * @interface NotebookStatus - */ -export interface NotebookStatus { - /** - * namespace of notebook - * @type {string} - * @memberof NotebookStatus - */ - namespace?: string; - /** - * duration notebook has been running in seconds - * @type {number} - * @memberof NotebookStatus - */ - uptime?: number; - /** - * current cpu usage in millicpu - * @type {number} - * @memberof NotebookStatus - */ - cpu_usage?: number; - /** - * memory usage in bytes - * @type {number} - * @memberof NotebookStatus - */ - memory_usage?: number; - /** - * memory allocated to notebook server in bytes - * @type {number} - * @memberof NotebookStatus - */ - memory_limit?: number; - /** - * millicpu allocated to notebook server - * @type {number} - * @memberof NotebookStatus - */ - cpu_count?: number; -} -/** - * Organization - * @export - * @interface Organization - */ -export interface Organization { - /** - * unique id of organization - * @type {string} - * @memberof Organization - */ - id?: string; - /** - * - * @type {OrganizationRoles} - * @memberof Organization - */ - role?: OrganizationRoles; - /** - * organization name must be unique - * @type {string} - * @memberof Organization - */ - name: string; - /** - * Datetime organization was created in UTC - * @type {string} - * @memberof Organization - */ - created_at?: string; - /** - * Datetime organization was updated in UTC - * @type {string} - * @memberof Organization - */ - updated_at?: string; - /** - * Organization logo - * @type {string} - * @memberof Organization - */ - logo?: string; - /** - * Organization description - * @type {string} - * @memberof Organization - */ - description?: string; - /** - * - * @type {Array} - * @memberof Organization - */ - users?: Array; - /** - * list of actions user is allowed to do on this organization - * @type {Array} - * @memberof Organization - */ - allowed_actions?: Array; - /** - * number of registered arrays for this organization - * @type {number} - * @memberof Organization - */ - num_of_arrays?: number; - /** - * List of extra/optional/beta features to enable for namespace - * @type {Array} - * @memberof Organization - */ - enabled_features?: Array; - /** - * A notice that the user has an unpaid subscription - * @type {boolean} - * @memberof Organization - */ - unpaid_subscription?: boolean; - /** - * default s3 path to store newly created notebooks - * @type {string} - * @memberof Organization - */ - default_s3_path?: string; - /** - * Default s3 path credentials name is the credentials name to use along with default_s3_path - * @type {string} - * @memberof Organization - */ - default_s3_path_credentials_name?: string; - /** - * Denotes that the organization is able to apply pricing to arrays by means of Stripe Connect - * @type {boolean} - * @memberof Organization - */ - stripe_connect?: boolean; -} -/** - * role user has in organization - * @export - * @enum {string} - */ -export enum OrganizationRoles { - Owner = 'owner', - Admin = 'admin', - ReadWrite = 'read_write', - ReadOnly = 'read_only' -} - -/** - * user in an organization - * @export - * @interface OrganizationUser - */ -export interface OrganizationUser { - /** - * unique id of user - * @type {string} - * @memberof OrganizationUser - */ - user_id?: string; - /** - * unique id of organization - * @type {string} - * @memberof OrganizationUser - */ - organization_id?: string; - /** - * username for user - * @type {string} - * @memberof OrganizationUser - */ - username?: string; - /** - * name of organization - * @type {string} - * @memberof OrganizationUser - */ - organization_name?: string; - /** - * - * @type {OrganizationRoles} - * @memberof OrganizationUser - */ - role?: OrganizationRoles; - /** - * list of actions user is allowed to do on this organization - * @type {Array} - * @memberof OrganizationUser - */ - allowed_actions?: Array; -} -/** - * - * @export - * @interface PaginationMetadata - */ -export interface PaginationMetadata { - /** - * pagination offset - * @type {number} - * @memberof PaginationMetadata - */ - page?: number; - /** - * pagination limit - * @type {number} - * @memberof PaginationMetadata - */ - per_page?: number; - /** - * number of total pages with current limit - * @type {number} - * @memberof PaginationMetadata - */ - total_pages?: number; - /** - * number of total available items - * @type {number} - * @memberof PaginationMetadata - */ - total_items?: number; -} -/** - * Pricing created by converting an array to product - * @export - * @interface Pricing - */ -export interface Pricing { - /** - * Unique id of plan as defined by Stripe - * @type {string} - * @memberof Pricing - */ - id?: string; - /** - * Unique id of registered array - * @type {string} - * @memberof Pricing - */ - array_uuid?: string; - /** - * Name of pricing - * @type {string} - * @memberof Pricing - */ - pricing_name?: string; - /** - * - * @type {PricingType} - * @memberof Pricing - */ - pricing_type?: PricingType; - /** - * Name of product - * @type {string} - * @memberof Pricing - */ - product_name?: string; - /** - * Extra information about a product which will appear on the credit card statement of the customer - * @type {string} - * @memberof Pricing - */ - product_statement_descriptor?: string; - /** - * - * @type {PricingUnitLabel} - * @memberof Pricing - */ - product_unit_label?: PricingUnitLabel; - /** - * - * @type {PricingCurrency} - * @memberof Pricing - */ - currency?: PricingCurrency; - /** - * - * @type {PricingAggregateUsage} - * @memberof Pricing - */ - aggregate_usage?: PricingAggregateUsage; - /** - * - * @type {PricingInterval} - * @memberof Pricing - */ - interval?: PricingInterval; - /** - * Group of n product unit labels - * @type {number} - * @memberof Pricing - */ - divided_by?: number; - /** - * Price in cents (decimal) per unitlabel - * @type {number} - * @memberof Pricing - */ - charge?: number; - /** - * If pricing is activated - * @type {boolean} - * @memberof Pricing - */ - activated?: boolean; -} -/** - * Specifies a usage aggregation strategy for pricings of usage_type=metered - * @export - * @enum {string} - */ -export enum PricingAggregateUsage { - Sum = 'sum' -} - -/** - * Currency of pricing - * @export - * @enum {string} - */ -export enum PricingCurrency { - Usd = 'USD' -} - -/** - * Interval for pricing - * @export - * @enum {string} - */ -export enum PricingInterval { - Month = 'month' -} - -/** - * Pricing types - * @export - * @enum {string} - */ -export enum PricingType { - Egress = 'egress', - Access = 'access' -} - -/** - * Unit label - * @export - * @enum {string} - */ -export enum PricingUnitLabel { - Byte = 'byte', - Second = 'second' -} - -/** - * Query parameter to get array metadatas - * @export - * @enum {string} - */ -export enum PublicShareFilter { - Exclude = 'exclude', - Only = 'only' -} - -/** - * - * @export - * @interface Query - */ -export interface Query { - /** - * - * @type {Querytype} - * @memberof Query - */ - type: Querytype; - /** - * - * @type {Layout} - * @memberof Query - */ - layout: Layout; - /** - * - * @type {Querystatus} - * @memberof Query - */ - status: Querystatus; - /** - * List of attribute buffer headers - * @type {Array} - * @memberof Query - */ - attributeBufferHeaders: Array; - /** - * - * @type {Writer} - * @memberof Query - */ - writer?: Writer; - /** - * - * @type {QueryReader} - * @memberof Query - */ - reader?: QueryReader; - /** - * - * @type {any} - * @memberof Query - */ - array: any; - /** - * Total number of bytes in fixed size attribute buffers. - * @type {number} - * @memberof Query - */ - totalFixedLengthBufferBytes: number; - /** - * Total number of bytes in variable size attribute buffers. - * @type {number} - * @memberof Query - */ - totalVarLenBufferBytes: number; -} -/** - * Query returning results as json - * @export - * @interface QueryJson - */ -export interface QueryJson { - /** - * - * @type {QueryRanges} - * @memberof QueryJson - */ - query_ranges?: QueryRanges; - /** - * List of fields to return data from, empty means return data for all fields - * @type {Array} - * @memberof QueryJson - */ - fields?: Array; -} -/** - * Subarray bounds to query - * @export - * @interface QueryRanges - */ -export interface QueryRanges { - /** - * - * @type {Layout} - * @memberof QueryRanges - */ - layout?: Layout; - /** - * List of ranges, - * @type {Array>} - * @memberof QueryRanges - */ - ranges?: Array>; -} -/** - * Read struct (can\'t be called reader due to class name conflict) - * @export - * @interface QueryReader - */ -export interface QueryReader { - /** - * - * @type {Layout} - * @memberof QueryReader - */ - layout?: Layout; - /** - * - * @type {Subarray} - * @memberof QueryReader - */ - subarray?: Subarray; - /** - * - * @type {ReadState} - * @memberof QueryReader - */ - readState?: ReadState; - /** - * The offsets format (bytes or elements) to be used. - * @type {string} - * @memberof QueryReader - */ - varOffsetsMode?: string; - /** - * True if an extra element will be added to the end of the offsets buffer. - * @type {boolean} - * @memberof QueryReader - */ - varOffsetsAddExtraElement?: boolean; - /** - * The offsets bitsize (32 or 64) to be used. - * @type {number} - * @memberof QueryReader - */ - varOffsetsBitsize?: number; -} -/** - * Status of query - * @export - * @enum {string} - */ -export enum Querystatus { - Failed = 'FAILED', - Completed = 'COMPLETED', - Inprogress = 'INPROGRESS', - Incomplete = 'INCOMPLETE', - Uninitialized = 'UNINITIALIZED' -} - -/** - * Type of query - * @export - * @enum {string} - */ -export enum Querytype { - Read = 'READ', - Write = 'WRITE' -} - -/** - * state for reads - * @export - * @interface ReadState - */ -export interface ReadState { - /** - * True if the reader has been initialized. - * @type {boolean} - * @memberof ReadState - */ - initialized?: boolean; - /** - * True if the query produced results that could not fit in some buffer. - * @type {boolean} - * @memberof ReadState - */ - overflowed?: boolean; - /** - * True if the current subarray partition is unsplittable. - * @type {boolean} - * @memberof ReadState - */ - unsplittable?: boolean; - /** - * - * @type {SubarrayPartitioner} - * @memberof ReadState - */ - subarrayPartitioner?: SubarrayPartitioner; -} -/** - * Parameters for running sql query - * @export - * @interface SQLParameters - */ -export interface SQLParameters { - /** - * name of task, optional - * @type {string} - * @memberof SQLParameters - */ - name?: string; - /** - * query to run - * @type {string} - * @memberof SQLParameters - */ - query?: string; - /** - * Output array uri - * @type {string} - * @memberof SQLParameters - */ - output_uri?: string; - /** - * store results for later retrieval - * @type {boolean} - * @memberof SQLParameters - */ - store_results?: boolean; -} -/** - * Single sign on provider - * @export - * @enum {string} - */ -export enum SSOProvider { - Github = 'github', - Google = 'google', - Stripe = 'stripe' -} - -/** - * A Subarray - * @export - * @interface Subarray - */ -export interface Subarray { - /** - * - * @type {Layout} - * @memberof Subarray - */ - layout?: Layout; - /** - * List of 1D ranges, one per dimension - * @type {Array} - * @memberof Subarray - */ - ranges?: Array; -} -/** - * The subarray partitioner - * @export - * @interface SubarrayPartitioner - */ -export interface SubarrayPartitioner { - /** - * - * @type {Subarray} - * @memberof SubarrayPartitioner - */ - subarray?: Subarray; - /** - * Result size budget (in bytes) for all attributes. - * @type {Array} - * @memberof SubarrayPartitioner - */ - budget?: Array; - /** - * - * @type {SubarrayPartitionerCurrent} - * @memberof SubarrayPartitioner - */ - current?: SubarrayPartitionerCurrent; - /** - * - * @type {SubarrayPartitionerState} - * @memberof SubarrayPartitioner - */ - state?: SubarrayPartitionerState; - /** - * The memory budget for the fixed-sized attributes and the offsets of the var-sized attributes - * @type {number} - * @memberof SubarrayPartitioner - */ - memoryBudget?: number; - /** - * The memory budget for the var-sized attributes - * @type {number} - * @memberof SubarrayPartitioner - */ - memoryBudgetVar?: number; -} -/** - * The current partition info - * @export - * @interface SubarrayPartitionerCurrent - */ -export interface SubarrayPartitionerCurrent { - /** - * - * @type {Subarray} - * @memberof SubarrayPartitionerCurrent - */ - subarray?: Subarray; - /** - * PartitionInfo start - * @type {number} - * @memberof SubarrayPartitionerCurrent - */ - start?: number; - /** - * PartitionInfo end - * @type {number} - * @memberof SubarrayPartitionerCurrent - */ - end?: number; - /** - * PartitionInfo splitMultiRange - * @type {boolean} - * @memberof SubarrayPartitionerCurrent - */ - splitMultiRange?: boolean; -} -/** - * The state information for the remaining partitions to be produced - * @export - * @interface SubarrayPartitionerState - */ -export interface SubarrayPartitionerState { - /** - * State start - * @type {number} - * @memberof SubarrayPartitionerState - */ - start?: number; - /** - * State end - * @type {number} - * @memberof SubarrayPartitionerState - */ - end?: number; - /** - * State singleRange - * @type {Array} - * @memberof SubarrayPartitionerState - */ - singleRange?: Array; - /** - * State multiRange - * @type {Array} - * @memberof SubarrayPartitionerState - */ - multiRange?: Array; -} -/** - * A set of 1D ranges for a subarray - * @export - * @interface SubarrayRanges - */ -export interface SubarrayRanges { - /** - * - * @type {Datatype} - * @memberof SubarrayRanges - */ - type?: Datatype; - /** - * True if the range is the default range - * @type {boolean} - * @memberof SubarrayRanges - */ - hasDefaultRange?: boolean; - /** - * The bytes of the ranges - * @type {Array} - * @memberof SubarrayRanges - */ - buffer?: Array; -} -/** - * Subscription of a user (customer) to another user\'s arrays - * @export - * @interface Subscription - */ -export interface Subscription { - /** - * Unique id of subscription as defined by Stripe - * @type {string} - * @memberof Subscription - */ - id?: string; - /** - * Unique id of the array (product) owner - * @type {string} - * @memberof Subscription - */ - owner_namespace_uuid?: string; - /** - * Unique id of the array (product) user (customer) - * @type {string} - * @memberof Subscription - */ - customer_namespace_uuid?: string; - /** - * list of pricing used by this subscription - * @type {Array} - * @memberof Subscription - */ - pricing?: Array; -} -/** - * user\'s TileDB config - * @export - * @interface TileDBConfig - */ -export interface TileDBConfig { - /** - * - * @type {{ [key: string]: string; }} - * @memberof TileDBConfig - */ - configs?: { [key: string]: string; }; -} -/** - * A api token and its metadata - * @export - * @interface Token - */ -export interface Token { - /** - * A api token - * @type {string} - * @memberof Token - */ - token?: string; - /** - * Name of token to revoke - * @type {string} - * @memberof Token - */ - name?: string; - /** - * datetime the token was created at - * @type {string} - * @memberof Token - */ - issued_at?: string; - /** - * datetime the token when token will expire - * @type {string} - * @memberof Token - */ - expires_at?: string; - /** - * Optional scope to limit token, defaults to all permissions, current supported values are password_reset or * - * @type {string} - * @memberof Token - */ - scope?: string; -} -/** - * A request from a user for an api token - * @export - * @interface TokenRequest - */ -export interface TokenRequest { - /** - * Expiration date for token, if empty token defaults to 30 minutes - * @type {string} - * @memberof TokenRequest - */ - expires?: string; - /** - * Optional name for token, if the name already exists for the user it will be auto incremented (i.e. myToken-1) - * @type {string} - * @memberof TokenRequest - */ - name?: string; - /** - * Optional scope to limit token, defaults to all permissions, current supported values are password_reset or * - * @type {string} - * @memberof TokenRequest - */ - scope?: string; -} -/** - * User-defined function - * @export - * @interface UDF - */ -export interface UDF { - /** - * name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec - * @type {string} - * @memberof UDF - */ - udf_info_name?: string; - /** - * - * @type {UDFLanguage} - * @memberof UDF - */ - language?: UDFLanguage; - /** - * Type-specific version - * @type {string} - * @memberof UDF - */ - version?: string; - /** - * Docker image name to use for udf - * @type {string} - * @memberof UDF - */ - image_name?: string; - /** - * - * @type {QueryRanges} - * @memberof UDF - */ - ranges?: QueryRanges; - /** - * - * @type {UDFSubarray} - * @memberof UDF - */ - subarray?: UDFSubarray; - /** - * Type-specific executable text - * @type {string} - * @memberof UDF - */ - exec?: string; - /** - * optional raw text to store of serialized function, used for showing in UI - * @type {string} - * @memberof UDF - */ - exec_raw?: string; - /** - * List of buffers to fetch (attributes + coordinates) - * @type {Array} - * @memberof UDF - */ - buffers?: Array; - /** - * - * @type {UDFResultType} - * @memberof UDF - */ - result_format?: UDFResultType; - /** - * string representing the serialization format to use, i.e. cloudpickle version or arrow IPC verison - * @type {string} - * @memberof UDF - */ - result_format_version?: string; - /** - * name of task, optional - * @type {string} - * @memberof UDF - */ - task_name?: string; - /** - * Argument(s) to pass to udf function, tuple or list of args/kwargs which can be in native or json format - * @type {string} - * @memberof UDF - */ - argument?: string; - /** - * store results for later retrieval - * @type {boolean} - * @memberof UDF - */ - store_results?: boolean; -} -/** - * actions a user can take on an udf - * @export - * @enum {string} - */ -export enum UDFActions { - FetchUdf = 'fetch_udf', - ShareUdf = 'share_udf' -} - -/** - * Defines a set of images related to a specific name - * @export - * @interface UDFImage - */ -export interface UDFImage { - /** - * Unique id of set of images - * @type {string} - * @memberof UDFImage - */ - id?: string; - /** - * name of udf - * @type {string} - * @memberof UDFImage - */ - name?: string; - /** - * - * @type {UDFLanguage} - * @memberof UDFImage - */ - language?: UDFLanguage; -} -/** - * Defines an image that belongs to a set of images having a version - * @export - * @interface UDFImageVersion - */ -export interface UDFImageVersion { - /** - * Unique id of a versioned image - * @type {string} - * @memberof UDFImageVersion - */ - id?: string; - /** - * name of UDFImageVersion - * @type {string} - * @memberof UDFImageVersion - */ - name?: string; - /** - * Unique id of the udf image set - * @type {string} - * @memberof UDFImageVersion - */ - udf_image_uuid?: string; - /** - * Uri of docker image related to current entry - * @type {string} - * @memberof UDFImageVersion - */ - docker_image?: string; - /** - * Image-specific version - * @type {number} - * @memberof UDFImageVersion - */ - version?: number; - /** - * If current image is default version - * @type {boolean} - * @memberof UDFImageVersion - */ - default?: boolean; - /** - * If current image is latest version - * @type {boolean} - * @memberof UDFImageVersion - */ - latest?: boolean; -} -/** - * User-defined function that can persist in db, used and shared multiple times - * @export - * @interface UDFInfo - */ -export interface UDFInfo { - /** - * Unique id of udf - * @type {string} - * @memberof UDFInfo - */ - id?: string; - /** - * name of udf - * @type {string} - * @memberof UDFInfo - */ - name?: string; - /** - * - * @type {UDFLanguage} - * @memberof UDFInfo - */ - language?: UDFLanguage; - /** - * - * @type {UDFType} - * @memberof UDFInfo - */ - type?: UDFType; - /** - * Markdown readme of udfs - * @type {string} - * @memberof UDFInfo - */ - readme?: string; - /** - * License identifier from SPDX License List or Custom - * @type {string} - * @memberof UDFInfo - */ - license_id?: string; - /** - * License text - * @type {string} - * @memberof UDFInfo - */ - license_text?: string; - /** - * optional tags for udf - * @type {Array} - * @memberof UDFInfo - */ - tags?: Array; -} -/** - * User-defined function that can persist in db, used and shared multiple times - * @export - * @interface UDFInfoUpdate - */ -export interface UDFInfoUpdate { - /** - * name of udf - * @type {string} - * @memberof UDFInfoUpdate - */ - name?: string; - /** - * - * @type {UDFLanguage} - * @memberof UDFInfoUpdate - */ - language?: UDFLanguage; - /** - * Type-specific version - * @type {string} - * @memberof UDFInfoUpdate - */ - version?: string; - /** - * Docker image name to use for udf - * @type {string} - * @memberof UDFInfoUpdate - */ - image_name?: string; - /** - * - * @type {UDFType} - * @memberof UDFInfoUpdate - */ - type?: UDFType; - /** - * Type-specific executable text - * @type {string} - * @memberof UDFInfoUpdate - */ - exec?: string; - /** - * optional raw text to store of serialized function, used for showing in UI - * @type {string} - * @memberof UDFInfoUpdate - */ - exec_raw?: string; - /** - * Markdown readme of udfs - * @type {string} - * @memberof UDFInfoUpdate - */ - readme?: string; - /** - * License identifier from SPDX License List or Custom - * @type {string} - * @memberof UDFInfoUpdate - */ - license_id?: string; - /** - * License text - * @type {string} - * @memberof UDFInfoUpdate - */ - license_text?: string; - /** - * optional tags for udf - * @type {Array} - * @memberof UDFInfoUpdate - */ - tags?: Array; -} -/** - * UDF Type - * @export - * @enum {string} - */ -export enum UDFLanguage { - Python = 'python', - R = 'r' -} - -/** - * Results type - * @export - * @enum {string} - */ -export enum UDFResultType { - Native = 'native', - Json = 'json', - Arrow = 'arrow' -} - -/** - * details for sharing a given udf - * @export - * @interface UDFSharing - */ -export interface UDFSharing { - /** - * List of permitted actions - * @type {Array} - * @memberof UDFSharing - */ - actions?: Array; - /** - * namespace being granted array access can be a user or organization - * @type {string} - * @memberof UDFSharing - */ - namespace?: string; - /** - * details on if the namespace is a organization or user - * @type {string} - * @memberof UDFSharing - */ - namespace_type?: string; -} -/** - * Subarray bounds to query for a UDF to operate on - * @export - * @interface UDFSubarray - */ -export interface UDFSubarray { - /** - * - * @type {Layout} - * @memberof UDFSubarray - */ - layout?: Layout; - /** - * List of ranges, - * @type {Array} - * @memberof UDFSubarray - */ - ranges?: Array; -} -/** - * A dimension range to query - * @export - * @interface UDFSubarrayRange - */ -export interface UDFSubarrayRange { - /** - * The dimension index - * @type {number} - * @memberof UDFSubarrayRange - */ - dimension_id?: number; - /** - * - * @type {DimensionCoordinate} - * @memberof UDFSubarrayRange - */ - range_start?: DimensionCoordinate; - /** - * - * @type {DimensionCoordinate} - * @memberof UDFSubarrayRange - */ - range_end?: DimensionCoordinate; -} -/** - * UDF Type - * @export - * @enum {string} - */ -export enum UDFType { - SingleArray = 'single_array', - Generic = 'generic' -} - -/** - * User - * @export - * @interface User - */ -export interface User { - /** - * unique id of user - * @type {string} - * @memberof User - */ - id?: string; - /** - * username must be unique - * @type {string} - * @memberof User - */ - username: string; - /** - * password - * @type {string} - * @memberof User - */ - password?: string; - /** - * the user\'s full, real name - * @type {string} - * @memberof User - */ - name?: string; - /** - * the user\'s email - * @type {string} - * @memberof User - */ - email?: string; - /** - * user\'s email is validated to be correct - * @type {boolean} - * @memberof User - */ - is_valid_email?: boolean; - /** - * Denotes that the user is able to apply pricing to arrays by means of Stripe Connect - * @type {boolean} - * @memberof User - */ - stripe_connect?: boolean; - /** - * the user\'s company - * @type {string} - * @memberof User - */ - company?: string; - /** - * the user\'s logo - * @type {string} - * @memberof User - */ - logo?: string; - /** - * when the user last logged in (set by the server) - * @type {string} - * @memberof User - */ - last_activity_date?: string; - /** - * - * @type {string} - * @memberof User - */ - timezone?: string; - /** - * Array of organizations a user is part of and their roles - * @type {Array} - * @memberof User - */ - organizations?: Array; - /** - * list of actions user is allowed to do on this organization - * @type {Array} - * @memberof User - */ - allowed_actions?: Array; - /** - * List of extra/optional/beta features to enable for namespace - * @type {Array} - * @memberof User - */ - enabled_features?: Array; - /** - * A notice that the user has an unpaid subscription - * @type {boolean} - * @memberof User - */ - unpaid_subscription?: boolean; - /** - * default s3 path to store newly created notebooks - * @type {string} - * @memberof User - */ - default_s3_path?: string; - /** - * Default s3 path credentials name is the credentials name to use along with default_s3_path - * @type {string} - * @memberof User - */ - default_s3_path_credentials_name?: string; - /** - * Override the default namespace charged for actions when no namespace is specified - * @type {string} - * @memberof User - */ - default_namespace_charged?: string; -} -/** - * - * @export - * @interface Writer - */ -export interface Writer { - /** - * - * @type {boolean} - * @memberof Writer - */ - checkCoordDups?: boolean; - /** - * - * @type {boolean} - * @memberof Writer - */ - checkCoordOOB?: boolean; - /** - * - * @type {boolean} - * @memberof Writer - */ - dedupCoords?: boolean; - /** - * - * @type {DomainArray} - * @memberof Writer - */ - subarray?: DomainArray; -} - -/** - * ArrayApi - axios parameter creator - * @export - */ -export const ArrayApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * get array activity logs - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) - * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) - * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated - * @param {string} [taskId] Array task id To filter activity to - * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arrayActivityLog: async (namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('arrayActivityLog', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('arrayActivityLog', 'array', array) - const localVarPath = `/arrays/{namespace}/{array}/activity` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (end !== undefined) { - localVarQueryParameter['end'] = end; - } - - if (eventTypes !== undefined) { - localVarQueryParameter['event_types'] = eventTypes; - } - - if (taskId !== undefined) { - localVarQueryParameter['task_id'] = taskId; - } - - if (hasTaskId !== undefined) { - localVarQueryParameter['has_task_id'] = hasTaskId; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of all arrays that are owned directly by user or user\'s organizations - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserOwnedGet: async (page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options: any = {}): Promise => { - const localVarPath = `/arrays/browser/owned`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (page !== undefined) { - localVarQueryParameter['page'] = page; - } - - if (perPage !== undefined) { - localVarQueryParameter['per_page'] = perPage; - } - - if (search !== undefined) { - localVarQueryParameter['search'] = search; - } - - if (namespace !== undefined) { - localVarQueryParameter['namespace'] = namespace; - } - - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } - - if (permissions !== undefined) { - localVarQueryParameter['permissions'] = permissions; - } - - if (tag) { - localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); - } - - if (excludeTag) { - localVarQueryParameter['exclude_tag'] = excludeTag.join(COLLECTION_FORMATS.csv); - } - - if (fileType) { - localVarQueryParameter['file_type'] = fileType.join(COLLECTION_FORMATS.csv); - } - - if (excludeFileType) { - localVarQueryParameter['exclude_file_type'] = excludeFileType.join(COLLECTION_FORMATS.csv); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserOwnedSidebarGet: async (options: any = {}): Promise => { - const localVarPath = `/arrays/browser/owned/sidebar`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of all arrays that have been shared publically - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserPublicGet: async (page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options: any = {}): Promise => { - const localVarPath = `/arrays/browser/public`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (page !== undefined) { - localVarQueryParameter['page'] = page; - } - - if (perPage !== undefined) { - localVarQueryParameter['per_page'] = perPage; - } - - if (search !== undefined) { - localVarQueryParameter['search'] = search; - } - - if (namespace !== undefined) { - localVarQueryParameter['namespace'] = namespace; - } - - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } - - if (permissions !== undefined) { - localVarQueryParameter['permissions'] = permissions; - } - - if (tag) { - localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); - } - - if (excludeTag) { - localVarQueryParameter['exclude_tag'] = excludeTag.join(COLLECTION_FORMATS.csv); - } - - if (fileType) { - localVarQueryParameter['file_type'] = fileType.join(COLLECTION_FORMATS.csv); - } - - if (excludeFileType) { - localVarQueryParameter['exclude_file_type'] = excludeFileType.join(COLLECTION_FORMATS.csv); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a sidebar of all arrays that have been shared publically - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserPublicSidebarGet: async (options: any = {}): Promise => { - const localVarPath = `/arrays/browser/public/sidebar`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of all arrays that have been shared with the user - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserSharedGet: async (page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options: any = {}): Promise => { - const localVarPath = `/arrays/browser/shared`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (page !== undefined) { - localVarQueryParameter['page'] = page; - } - - if (perPage !== undefined) { - localVarQueryParameter['per_page'] = perPage; - } - - if (search !== undefined) { - localVarQueryParameter['search'] = search; - } - - if (namespace !== undefined) { - localVarQueryParameter['namespace'] = namespace; - } - - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } - - if (permissions !== undefined) { - localVarQueryParameter['permissions'] = permissions; - } - - if (tag) { - localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); - } - - if (excludeTag) { - localVarQueryParameter['exclude_tag'] = excludeTag.join(COLLECTION_FORMATS.csv); - } - - if (fileType) { - localVarQueryParameter['file_type'] = fileType.join(COLLECTION_FORMATS.csv); - } - - if (excludeFileType) { - localVarQueryParameter['exclude_file_type'] = excludeFileType.join(COLLECTION_FORMATS.csv); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of all arrays that have been shared with the user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserSharedSidebarGet: async (options: any = {}): Promise => { - const localVarPath = `/arrays/browser/shared/sidebar`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * consolidate an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - consolidateArray: async (namespace: string, array: string, tiledbConfig: TileDBConfig, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('consolidateArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('consolidateArray', 'array', array) - // verify required parameter 'tiledbConfig' is not null or undefined - assertParamExists('consolidateArray', 'tiledbConfig', tiledbConfig) - const localVarPath = `/arrays/{namespace}/{array}/consolidate` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tiledbConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * create a array schema at a specified URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {ArraySchema} arraySchema ArraySchema being created - * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createArray: async (namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('createArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('createArray', 'array', array) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('createArray', 'contentType', contentType) - // verify required parameter 'arraySchema' is not null or undefined - assertParamExists('createArray', 'arraySchema', arraySchema) - const localVarPath = `/arrays/{namespace}/{array}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xTILEDBCLOUDACCESSCREDENTIALSNAME !== undefined && xTILEDBCLOUDACCESSCREDENTIALSNAME !== null) { - localVarHeaderParameter['X-TILEDB-CLOUD-ACCESS-CREDENTIALS-NAME'] = String(xTILEDBCLOUDACCESSCREDENTIALSNAME); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(arraySchema, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteArray: async (namespace: string, array: string, contentType: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('deleteArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('deleteArray', 'array', array) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('deleteArray', 'contentType', contentType) - const localVarPath = `/arrays/{namespace}/{array}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * deregister a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deregisterArray: async (namespace: string, array: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('deregisterArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('deregisterArray', 'array', array) - const localVarPath = `/arrays/{namespace}/{array}/deregister` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get all array metadata user has access to - * @param {string} [publicShare] Public share values can be one of exclude, only - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAllArrayMetadata: async (publicShare?: string, options: any = {}): Promise => { - const localVarPath = `/arrays`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (publicShare !== undefined) { - localVarQueryParameter['public_share'] = publicShare; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get an ArraySchema using a url encoded uri - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArray: async (namespace: string, array: string, contentType: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArray', 'array', array) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('getArray', 'contentType', contentType) - const localVarPath = `/arrays/{namespace}/{array}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get the max buffer sizes of an array for a subarray - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} subarray CSV string of subarray to get max buffer sizes for - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayMaxBufferSizes: async (namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArrayMaxBufferSizes', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArrayMaxBufferSizes', 'array', array) - // verify required parameter 'subarray' is not null or undefined - assertParamExists('getArrayMaxBufferSizes', 'subarray', subarray) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('getArrayMaxBufferSizes', 'contentType', contentType) - const localVarPath = `/arrays/{namespace}/{array}/max_buffer_sizes` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (subarray !== undefined) { - localVarQueryParameter['subarray'] = subarray; - } - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get metadata from the array in json format - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [length] (optional) limit character length of returned values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayMetaDataJson: async (namespace: string, array: string, length?: number, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArrayMetaDataJson', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArrayMetaDataJson', 'array', array) - const localVarPath = `/arrays/{namespace}/{array}/metadata_json` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (length !== undefined) { - localVarQueryParameter['length'] = length; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayMetadata: async (namespace: string, array: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArrayMetadata', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArrayMetadata', 'array', array) - const localVarPath = `/arrays/{namespace}/{array}/metadata` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get the non empty domain of an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayNonEmptyDomain: async (namespace: string, array: string, contentType: string, xPayer?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArrayNonEmptyDomain', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArrayNonEmptyDomain', 'array', array) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('getArrayNonEmptyDomain', 'contentType', contentType) - const localVarPath = `/arrays/{namespace}/{array}/non_empty_domain` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get an sample set of data from the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [samples] Number of sample results to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArraySampleData: async (namespace: string, array: string, samples?: number, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArraySampleData', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArraySampleData', 'array', array) - const localVarPath = `/arrays/{namespace}/{array}/sample` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (samples !== undefined) { - localVarQueryParameter['samples'] = samples; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get all sharing details of the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArraySharingPolicies: async (namespace: string, array: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArraySharingPolicies', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getArraySharingPolicies', 'array', array) - const localVarPath = `/arrays/{namespace}/{array}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get metadata on all arrays in a namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArraysInNamespace: async (namespace: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getArraysInNamespace', 'namespace', namespace) - const localVarPath = `/arrays/{namespace}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getLastAccessedArrays: async (options: any = {}): Promise => { - const localVarPath = `/arrays/last_accessed`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * register an array at a specified URI registered to the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - registerArray: async (namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('registerArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('registerArray', 'array', array) - // verify required parameter 'arrayMetadata' is not null or undefined - assertParamExists('registerArray', 'arrayMetadata', arrayMetadata) - const localVarPath = `/arrays/{namespace}/{array}/register` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(arrayMetadata, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Share an array with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shareArray: async (namespace: string, array: string, arraySharing: ArraySharing, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('shareArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('shareArray', 'array', array) - // verify required parameter 'arraySharing' is not null or undefined - assertParamExists('shareArray', 'arraySharing', arraySharing) - const localVarPath = `/arrays/{namespace}/{array}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(arraySharing, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * update metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata array metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateArrayMetadata: async (namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('updateArrayMetadata', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('updateArrayMetadata', 'array', array) - // verify required parameter 'arrayMetadata' is not null or undefined - assertParamExists('updateArrayMetadata', 'arrayMetadata', arrayMetadata) - const localVarPath = `/arrays/{namespace}/{array}/metadata` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(arrayMetadata, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * vacuum an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - vacuumArray: async (namespace: string, array: string, tiledbConfig: TileDBConfig, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('vacuumArray', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('vacuumArray', 'array', array) - // verify required parameter 'tiledbConfig' is not null or undefined - assertParamExists('vacuumArray', 'tiledbConfig', tiledbConfig) - const localVarPath = `/arrays/{namespace}/{array}/vacuum` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tiledbConfig, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * ArrayApi - functional programming interface - * @export - */ -export const ArrayApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ArrayApiAxiosParamCreator(configuration) - return { - /** - * get array activity logs - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) - * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) - * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated - * @param {string} [taskId] Array task id To filter activity to - * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arrayActivityLog(namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arrayActivityLog(namespace, array, start, end, eventTypes, taskId, hasTaskId, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of all arrays that are owned directly by user or user\'s organizations - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arraysBrowserOwnedSidebarGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arraysBrowserOwnedSidebarGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of all arrays that have been shared publically - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a sidebar of all arrays that have been shared publically - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arraysBrowserPublicSidebarGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arraysBrowserPublicSidebarGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of all arrays that have been shared with the user - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of all arrays that have been shared with the user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async arraysBrowserSharedSidebarGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.arraysBrowserSharedSidebarGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * consolidate an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async consolidateArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.consolidateArray(namespace, array, tiledbConfig, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * create a array schema at a specified URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {ArraySchema} arraySchema ArraySchema being created - * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createArray(namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createArray(namespace, array, contentType, arraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteArray(namespace: string, array: string, contentType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteArray(namespace, array, contentType, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * deregister a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deregisterArray(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deregisterArray(namespace, array, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get all array metadata user has access to - * @param {string} [publicShare] Public share values can be one of exclude, only - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getAllArrayMetadata(publicShare?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllArrayMetadata(publicShare, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get an ArraySchema using a url encoded uri - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArray(namespace: string, array: string, contentType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArray(namespace, array, contentType, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get the max buffer sizes of an array for a subarray - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} subarray CSV string of subarray to get max buffer sizes for - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArrayMaxBufferSizes(namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArrayMaxBufferSizes(namespace, array, subarray, contentType, xPayer, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get metadata from the array in json format - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [length] (optional) limit character length of returned values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArrayMetaDataJson(namespace: string, array: string, length?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArrayMetaDataJson(namespace, array, length, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArrayMetadata(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArrayMetadata(namespace, array, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get the non empty domain of an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArrayNonEmptyDomain(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArrayNonEmptyDomain(namespace, array, contentType, xPayer, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get an sample set of data from the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [samples] Number of sample results to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArraySampleData(namespace: string, array: string, samples?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArraySampleData(namespace, array, samples, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Get all sharing details of the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArraySharingPolicies(namespace: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArraySharingPolicies(namespace, array, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get metadata on all arrays in a namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArraysInNamespace(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArraysInNamespace(namespace, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getLastAccessedArrays(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getLastAccessedArrays(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * register an array at a specified URI registered to the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async registerArray(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.registerArray(namespace, array, arrayMetadata, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Share an array with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async shareArray(namespace: string, array: string, arraySharing: ArraySharing, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.shareArray(namespace, array, arraySharing, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * update metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata array metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateArrayMetadata(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateArrayMetadata(namespace, array, arrayMetadata, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * vacuum an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async vacuumArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.vacuumArray(namespace, array, tiledbConfig, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * ArrayApi - factory interface - * @export - */ -export const ArrayApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ArrayApiFp(configuration) - return { - /** - * get array activity logs - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) - * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) - * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated - * @param {string} [taskId] Array task id To filter activity to - * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arrayActivityLog(namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any): AxiosPromise> { - return localVarFp.arrayActivityLog(namespace, array, start, end, eventTypes, taskId, hasTaskId, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of all arrays that are owned directly by user or user\'s organizations - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): AxiosPromise { - return localVarFp.arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserOwnedSidebarGet(options?: any): AxiosPromise { - return localVarFp.arraysBrowserOwnedSidebarGet(options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of all arrays that have been shared publically - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): AxiosPromise { - return localVarFp.arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a sidebar of all arrays that have been shared publically - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserPublicSidebarGet(options?: any): AxiosPromise { - return localVarFp.arraysBrowserPublicSidebarGet(options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of all arrays that have been shared with the user - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any): AxiosPromise { - return localVarFp.arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of all arrays that have been shared with the user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - arraysBrowserSharedSidebarGet(options?: any): AxiosPromise { - return localVarFp.arraysBrowserSharedSidebarGet(options).then((request) => request(axios, basePath)); - }, - /** - * consolidate an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - consolidateArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): AxiosPromise { - return localVarFp.consolidateArray(namespace, array, tiledbConfig, options).then((request) => request(axios, basePath)); - }, - /** - * create a array schema at a specified URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {ArraySchema} arraySchema ArraySchema being created - * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createArray(namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any): AxiosPromise { - return localVarFp.createArray(namespace, array, contentType, arraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME, options).then((request) => request(axios, basePath)); - }, - /** - * delete a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteArray(namespace: string, array: string, contentType: string, options?: any): AxiosPromise { - return localVarFp.deleteArray(namespace, array, contentType, options).then((request) => request(axios, basePath)); - }, - /** - * deregister a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deregisterArray(namespace: string, array: string, options?: any): AxiosPromise { - return localVarFp.deregisterArray(namespace, array, options).then((request) => request(axios, basePath)); - }, - /** - * get all array metadata user has access to - * @param {string} [publicShare] Public share values can be one of exclude, only - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAllArrayMetadata(publicShare?: string, options?: any): AxiosPromise> { - return localVarFp.getAllArrayMetadata(publicShare, options).then((request) => request(axios, basePath)); - }, - /** - * get an ArraySchema using a url encoded uri - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArray(namespace: string, array: string, contentType: string, options?: any): AxiosPromise { - return localVarFp.getArray(namespace, array, contentType, options).then((request) => request(axios, basePath)); - }, - /** - * get the max buffer sizes of an array for a subarray - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} subarray CSV string of subarray to get max buffer sizes for - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayMaxBufferSizes(namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any): AxiosPromise { - return localVarFp.getArrayMaxBufferSizes(namespace, array, subarray, contentType, xPayer, options).then((request) => request(axios, basePath)); - }, - /** - * get metadata from the array in json format - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [length] (optional) limit character length of returned values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayMetaDataJson(namespace: string, array: string, length?: number, options?: any): AxiosPromise { - return localVarFp.getArrayMetaDataJson(namespace, array, length, options).then((request) => request(axios, basePath)); - }, - /** - * get metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayMetadata(namespace: string, array: string, options?: any): AxiosPromise { - return localVarFp.getArrayMetadata(namespace, array, options).then((request) => request(axios, basePath)); - }, - /** - * get the non empty domain of an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayNonEmptyDomain(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): AxiosPromise { - return localVarFp.getArrayNonEmptyDomain(namespace, array, contentType, xPayer, options).then((request) => request(axios, basePath)); - }, - /** - * get an sample set of data from the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [samples] Number of sample results to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArraySampleData(namespace: string, array: string, samples?: number, options?: any): AxiosPromise { - return localVarFp.getArraySampleData(namespace, array, samples, options).then((request) => request(axios, basePath)); - }, - /** - * Get all sharing details of the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArraySharingPolicies(namespace: string, array: string, options?: any): AxiosPromise> { - return localVarFp.getArraySharingPolicies(namespace, array, options).then((request) => request(axios, basePath)); - }, - /** - * get metadata on all arrays in a namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArraysInNamespace(namespace: string, options?: any): AxiosPromise> { - return localVarFp.getArraysInNamespace(namespace, options).then((request) => request(axios, basePath)); - }, - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getLastAccessedArrays(options?: any): AxiosPromise> { - return localVarFp.getLastAccessedArrays(options).then((request) => request(axios, basePath)); - }, - /** - * register an array at a specified URI registered to the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - registerArray(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): AxiosPromise { - return localVarFp.registerArray(namespace, array, arrayMetadata, options).then((request) => request(axios, basePath)); - }, - /** - * Share an array with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shareArray(namespace: string, array: string, arraySharing: ArraySharing, options?: any): AxiosPromise { - return localVarFp.shareArray(namespace, array, arraySharing, options).then((request) => request(axios, basePath)); - }, - /** - * update metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata array metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateArrayMetadata(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any): AxiosPromise { - return localVarFp.updateArrayMetadata(namespace, array, arrayMetadata, options).then((request) => request(axios, basePath)); - }, - /** - * vacuum an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - vacuumArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any): AxiosPromise { - return localVarFp.vacuumArray(namespace, array, tiledbConfig, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * ArrayApi - object-oriented interface - * @export - * @class ArrayApi - * @extends {BaseAPI} - */ -export class ArrayApi extends BaseAPI { - /** - * get array activity logs - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [start] Start time of window of fetch logs, unix epoch in seconds (default: seven days ago) - * @param {number} [end] End time of window of fetch logs, unix epoch in seconds (default: current utc timestamp) - * @param {string} [eventTypes] Event values can be one or more of the following read, write, create, delete, register, deregister, comma separated - * @param {string} [taskId] Array task id To filter activity to - * @param {boolean} [hasTaskId] Excludes activity log results that does not contain an array task uuid - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arrayActivityLog(namespace: string, array: string, start?: number, end?: number, eventTypes?: string, taskId?: string, hasTaskId?: boolean, options?: any) { - return ArrayApiFp(this.configuration).arrayActivityLog(namespace, array, start, end, eventTypes, taskId, hasTaskId, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of all arrays that are owned directly by user or user\'s organizations - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arraysBrowserOwnedSidebarGet(options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserOwnedSidebarGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of all arrays that have been shared publically - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a sidebar of all arrays that have been shared publically - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arraysBrowserPublicSidebarGet(options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserPublicSidebarGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of all arrays that have been shared with the user - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [namespace] namespace - * @param {string} [orderby] sort by which field valid values include last_accessed, size, name - * @param {string} [permissions] permissions valid values include read, read_write, write, admin - * @param {Array} [tag] tag to search for, more than one can be included - * @param {Array} [excludeTag] tags to exclude matching array in results, more than one can be included - * @param {Array} [fileType] file_type to search for, more than one can be included - * @param {Array} [excludeFileType] file_type to exclude matching array in results, more than one can be included - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, fileType?: Array, excludeFileType?: Array, options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, fileType, excludeFileType, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of all arrays that have been shared with the user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public arraysBrowserSharedSidebarGet(options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserSharedSidebarGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * consolidate an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public consolidateArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any) { - return ArrayApiFp(this.configuration).consolidateArray(namespace, array, tiledbConfig, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * create a array schema at a specified URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {ArraySchema} arraySchema ArraySchema being created - * @param {string} [xTILEDBCLOUDACCESSCREDENTIALSNAME] Optional registered access credentials to use for creation - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public createArray(namespace: string, array: string, contentType: string, arraySchema: ArraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME?: string, options?: any) { - return ArrayApiFp(this.configuration).createArray(namespace, array, contentType, arraySchema, xTILEDBCLOUDACCESSCREDENTIALSNAME, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public deleteArray(namespace: string, array: string, contentType: string, options?: any) { - return ArrayApiFp(this.configuration).deleteArray(namespace, array, contentType, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * deregister a array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public deregisterArray(namespace: string, array: string, options?: any) { - return ArrayApiFp(this.configuration).deregisterArray(namespace, array, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get all array metadata user has access to - * @param {string} [publicShare] Public share values can be one of exclude, only - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getAllArrayMetadata(publicShare?: string, options?: any) { - return ArrayApiFp(this.configuration).getAllArrayMetadata(publicShare, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get an ArraySchema using a url encoded uri - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArray(namespace: string, array: string, contentType: string, options?: any) { - return ArrayApiFp(this.configuration).getArray(namespace, array, contentType, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get the max buffer sizes of an array for a subarray - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} subarray CSV string of subarray to get max buffer sizes for - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArrayMaxBufferSizes(namespace: string, array: string, subarray: string, contentType: string, xPayer?: string, options?: any) { - return ArrayApiFp(this.configuration).getArrayMaxBufferSizes(namespace, array, subarray, contentType, xPayer, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get metadata from the array in json format - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [length] (optional) limit character length of returned values - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArrayMetaDataJson(namespace: string, array: string, length?: number, options?: any) { - return ArrayApiFp(this.configuration).getArrayMetaDataJson(namespace, array, length, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArrayMetadata(namespace: string, array: string, options?: any) { - return ArrayApiFp(this.configuration).getArrayMetadata(namespace, array, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get the non empty domain of an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArrayNonEmptyDomain(namespace: string, array: string, contentType: string, xPayer?: string, options?: any) { - return ArrayApiFp(this.configuration).getArrayNonEmptyDomain(namespace, array, contentType, xPayer, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get an sample set of data from the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {number} [samples] Number of sample results to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArraySampleData(namespace: string, array: string, samples?: number, options?: any) { - return ArrayApiFp(this.configuration).getArraySampleData(namespace, array, samples, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get all sharing details of the array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArraySharingPolicies(namespace: string, array: string, options?: any) { - return ArrayApiFp(this.configuration).getArraySharingPolicies(namespace, array, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get metadata on all arrays in a namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getArraysInNamespace(namespace: string, options?: any) { - return ArrayApiFp(this.configuration).getArraysInNamespace(namespace, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public getLastAccessedArrays(options?: any) { - return ArrayApiFp(this.configuration).getLastAccessedArrays(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * register an array at a specified URI registered to the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata metadata associated with array - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public registerArray(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any) { - return ArrayApiFp(this.configuration).registerArray(namespace, array, arrayMetadata, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Share an array with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArraySharing} arraySharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the array will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public shareArray(namespace: string, array: string, arraySharing: ArraySharing, options?: any) { - return ArrayApiFp(this.configuration).shareArray(namespace, array, arraySharing, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * update metadata on an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {ArrayInfoUpdate} arrayMetadata array metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public updateArrayMetadata(namespace: string, array: string, arrayMetadata: ArrayInfoUpdate, options?: any) { - return ArrayApiFp(this.configuration).updateArrayMetadata(namespace, array, arrayMetadata, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * vacuum an array at a specified URI - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {TileDBConfig} tiledbConfig tiledb configuration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayApi - */ - public vacuumArray(namespace: string, array: string, tiledbConfig: TileDBConfig, options?: any) { - return ArrayApiFp(this.configuration).vacuumArray(namespace, array, tiledbConfig, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * ArrayTasksApi - axios parameter creator - * @export - */ -export const ArrayTasksApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago - * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayTasksSidebar: async (start?: number, end?: number, options: any = {}): Promise => { - const localVarPath = `/tasks/sidebar`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (end !== undefined) { - localVarQueryParameter['end'] = end; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * ArrayTasksApi - functional programming interface - * @export - */ -export const ArrayTasksApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = ArrayTasksApiAxiosParamCreator(configuration) - return { - /** - * - * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago - * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getArrayTasksSidebar(start?: number, end?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getArrayTasksSidebar(start, end, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * ArrayTasksApi - factory interface - * @export - */ -export const ArrayTasksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = ArrayTasksApiFp(configuration) - return { - /** - * - * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago - * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getArrayTasksSidebar(start?: number, end?: number, options?: any): AxiosPromise { - return localVarFp.getArrayTasksSidebar(start, end, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * ArrayTasksApi - object-oriented interface - * @export - * @class ArrayTasksApi - * @extends {BaseAPI} - */ -export class ArrayTasksApi extends BaseAPI { - /** - * - * @param {number} [start] Fetch tasks created after this time, unix epoch in seconds, default 7 days ago - * @param {number} [end] Fetch tasks created before this time, unix epoch in seconds, default now - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ArrayTasksApi - */ - public getArrayTasksSidebar(start?: number, end?: number, options?: any) { - return ArrayTasksApiFp(this.configuration).getArrayTasksSidebar(start, end, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * FavoritesApi - axios parameter creator - * @export - */ -export const FavoritesApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Delete specific favorite - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteFavoriteId: async (id: string, options: any = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('deleteFavoriteId', 'id', id) - const localVarPath = `/favorites/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch specific favorite of a user - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFavorite: async (id: string, options: any = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getFavorite', 'id', id) - const localVarPath = `/favorites/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch all favorites of connected user - * @param {string} [type] The type of the desired favorites e.g. arrays - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFavorites: async (type?: string, options: any = {}): Promise => { - const localVarPath = `/favorites`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Add a new favorite - * @param {FavoriteUpdate} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - postFavorite: async (body?: FavoriteUpdate, options: any = {}): Promise => { - const localVarPath = `/favorites`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * FavoritesApi - functional programming interface - * @export - */ -export const FavoritesApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = FavoritesApiAxiosParamCreator(configuration) - return { - /** - * Delete specific favorite - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteFavoriteId(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFavoriteId(id, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch specific favorite of a user - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getFavorite(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFavorite(id, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch all favorites of connected user - * @param {string} [type] The type of the desired favorites e.g. arrays - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getFavorites(type?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFavorites(type, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Add a new favorite - * @param {FavoriteUpdate} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async postFavorite(body?: FavoriteUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postFavorite(body, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * FavoritesApi - factory interface - * @export - */ -export const FavoritesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = FavoritesApiFp(configuration) - return { - /** - * Delete specific favorite - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteFavoriteId(id: string, options?: any): AxiosPromise { - return localVarFp.deleteFavoriteId(id, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch specific favorite of a user - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFavorite(id: string, options?: any): AxiosPromise { - return localVarFp.getFavorite(id, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch all favorites of connected user - * @param {string} [type] The type of the desired favorites e.g. arrays - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFavorites(type?: string, options?: any): AxiosPromise> { - return localVarFp.getFavorites(type, options).then((request) => request(axios, basePath)); - }, - /** - * Add a new favorite - * @param {FavoriteUpdate} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - postFavorite(body?: FavoriteUpdate, options?: any): AxiosPromise { - return localVarFp.postFavorite(body, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * FavoritesApi - object-oriented interface - * @export - * @class FavoritesApi - * @extends {BaseAPI} - */ -export class FavoritesApi extends BaseAPI { - /** - * Delete specific favorite - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FavoritesApi - */ - public deleteFavoriteId(id: string, options?: any) { - return FavoritesApiFp(this.configuration).deleteFavoriteId(id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch specific favorite of a user - * @param {string} id The uuid of the favorite - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FavoritesApi - */ - public getFavorite(id: string, options?: any) { - return FavoritesApiFp(this.configuration).getFavorite(id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch all favorites of connected user - * @param {string} [type] The type of the desired favorites e.g. arrays - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FavoritesApi - */ - public getFavorites(type?: string, options?: any) { - return FavoritesApiFp(this.configuration).getFavorites(type, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Add a new favorite - * @param {FavoriteUpdate} [body] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FavoritesApi - */ - public postFavorite(body?: FavoriteUpdate, options?: any) { - return FavoritesApiFp(this.configuration).postFavorite(body, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * InvitationApi - axios parameter creator - * @export - */ -export const InvitationApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Accepts invitation - * @param {string} invitation the id of invitation about to be accepted - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - acceptInvitation: async (invitation: string, options: any = {}): Promise => { - // verify required parameter 'invitation' is not null or undefined - assertParamExists('acceptInvitation', 'invitation', invitation) - const localVarPath = `/invitations/{invitation}` - .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Cancels join organization invitation - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} organization name or uuid of organization - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancelJoinOrganization: async (invitation: string, organization: string, options: any = {}): Promise => { - // verify required parameter 'invitation' is not null or undefined - assertParamExists('cancelJoinOrganization', 'invitation', invitation) - // verify required parameter 'organization' is not null or undefined - assertParamExists('cancelJoinOrganization', 'organization', organization) - const localVarPath = `/invitations/{invitation}/{organization}/join` - .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))) - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Cancels array sharing invitation - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancelShareArrayByInvite: async (namespace: string, invitation: string, array: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('cancelShareArrayByInvite', 'namespace', namespace) - // verify required parameter 'invitation' is not null or undefined - assertParamExists('cancelShareArrayByInvite', 'invitation', invitation) - // verify required parameter 'array' is not null or undefined - assertParamExists('cancelShareArrayByInvite', 'array', array) - const localVarPath = `/invitations/{invitation}/{namespace}/{array}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of invitations - * @param {string} [organization] name or id of organization to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" - * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" - * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - fetchInvitations: async (organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options: any = {}): Promise => { - const localVarPath = `/invitations`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (organization !== undefined) { - localVarQueryParameter['organization'] = organization; - } - - if (array !== undefined) { - localVarQueryParameter['array'] = array; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (end !== undefined) { - localVarQueryParameter['end'] = end; - } - - if (page !== undefined) { - localVarQueryParameter['page'] = page; - } - - if (perPage !== undefined) { - localVarQueryParameter['per_page'] = perPage; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Sends email to multiple recipients with joining information regarding an organization - * @param {string} organization name or uuid of organization - * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - joinOrganization: async (organization: string, emailInvite: InvitationOrganizationJoinEmail, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('joinOrganization', 'organization', organization) - // verify required parameter 'emailInvite' is not null or undefined - assertParamExists('joinOrganization', 'emailInvite', emailInvite) - const localVarPath = `/invitations/{organization}/join` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(emailInvite, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Sends email to multiple recipients with sharing information regarding an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {InvitationArrayShareEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shareArrayByInvite: async (namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('shareArrayByInvite', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('shareArrayByInvite', 'array', array) - // verify required parameter 'emailInvite' is not null or undefined - assertParamExists('shareArrayByInvite', 'emailInvite', emailInvite) - const localVarPath = `/invitations/{namespace}/{array}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(emailInvite, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * InvitationApi - functional programming interface - * @export - */ -export const InvitationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = InvitationApiAxiosParamCreator(configuration) - return { - /** - * Accepts invitation - * @param {string} invitation the id of invitation about to be accepted - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async acceptInvitation(invitation: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.acceptInvitation(invitation, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Cancels join organization invitation - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} organization name or uuid of organization - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async cancelJoinOrganization(invitation: string, organization: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelJoinOrganization(invitation, organization, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Cancels array sharing invitation - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelShareArrayByInvite(namespace, invitation, array, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of invitations - * @param {string} [organization] name or id of organization to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" - * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" - * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async fetchInvitations(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.fetchInvitations(organization, array, start, end, page, perPage, type, status, orderby, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Sends email to multiple recipients with joining information regarding an organization - * @param {string} organization name or uuid of organization - * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async joinOrganization(organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.joinOrganization(organization, emailInvite, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Sends email to multiple recipients with sharing information regarding an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {InvitationArrayShareEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async shareArrayByInvite(namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.shareArrayByInvite(namespace, array, emailInvite, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * InvitationApi - factory interface - * @export - */ -export const InvitationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = InvitationApiFp(configuration) - return { - /** - * Accepts invitation - * @param {string} invitation the id of invitation about to be accepted - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - acceptInvitation(invitation: string, options?: any): AxiosPromise { - return localVarFp.acceptInvitation(invitation, options).then((request) => request(axios, basePath)); - }, - /** - * Cancels join organization invitation - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} organization name or uuid of organization - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancelJoinOrganization(invitation: string, organization: string, options?: any): AxiosPromise { - return localVarFp.cancelJoinOrganization(invitation, organization, options).then((request) => request(axios, basePath)); - }, - /** - * Cancels array sharing invitation - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options?: any): AxiosPromise { - return localVarFp.cancelShareArrayByInvite(namespace, invitation, array, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of invitations - * @param {string} [organization] name or id of organization to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" - * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" - * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - fetchInvitations(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any): AxiosPromise { - return localVarFp.fetchInvitations(organization, array, start, end, page, perPage, type, status, orderby, options).then((request) => request(axios, basePath)); - }, - /** - * Sends email to multiple recipients with joining information regarding an organization - * @param {string} organization name or uuid of organization - * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - joinOrganization(organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any): AxiosPromise { - return localVarFp.joinOrganization(organization, emailInvite, options).then((request) => request(axios, basePath)); - }, - /** - * Sends email to multiple recipients with sharing information regarding an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {InvitationArrayShareEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shareArrayByInvite(namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any): AxiosPromise { - return localVarFp.shareArrayByInvite(namespace, array, emailInvite, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * InvitationApi - object-oriented interface - * @export - * @class InvitationApi - * @extends {BaseAPI} - */ -export class InvitationApi extends BaseAPI { - /** - * Accepts invitation - * @param {string} invitation the id of invitation about to be accepted - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof InvitationApi - */ - public acceptInvitation(invitation: string, options?: any) { - return InvitationApiFp(this.configuration).acceptInvitation(invitation, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Cancels join organization invitation - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} organization name or uuid of organization - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof InvitationApi - */ - public cancelJoinOrganization(invitation: string, organization: string, options?: any) { - return InvitationApiFp(this.configuration).cancelJoinOrganization(invitation, organization, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Cancels array sharing invitation - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} array name/uri of array that is url-encoded - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof InvitationApi - */ - public cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options?: any) { - return InvitationApiFp(this.configuration).cancelShareArrayByInvite(namespace, invitation, array, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of invitations - * @param {string} [organization] name or id of organization to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] invitation type, \"ARRAY_SHARE\", \"JOIN_ORGANIZATION\" - * @param {string} [status] Filter to only return \"PENDING\", \"ACCEPTED\" - * @param {string} [orderby] sort by which field valid values include timestamp, array_name, organization_name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof InvitationApi - */ - public fetchInvitations(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options?: any) { - return InvitationApiFp(this.configuration).fetchInvitations(organization, array, start, end, page, perPage, type, status, orderby, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Sends email to multiple recipients with joining information regarding an organization - * @param {string} organization name or uuid of organization - * @param {InvitationOrganizationJoinEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof InvitationApi - */ - public joinOrganization(organization: string, emailInvite: InvitationOrganizationJoinEmail, options?: any) { - return InvitationApiFp(this.configuration).joinOrganization(organization, emailInvite, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Sends email to multiple recipients with sharing information regarding an array - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {InvitationArrayShareEmail} emailInvite list of email recipients - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof InvitationApi - */ - public shareArrayByInvite(namespace: string, array: string, emailInvite: InvitationArrayShareEmail, options?: any) { - return InvitationApiFp(this.configuration).shareArrayByInvite(namespace, array, emailInvite, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * NotebookApi - axios parameter creator - * @export - */ -export const NotebookApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get status of the notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getNotebookServerStatus: async (namespace: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getNotebookServerStatus', 'namespace', namespace) - const localVarPath = `/notebooks/server/{namespace}/status` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Shutdown a notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shutdownNotebookServer: async (namespace: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('shutdownNotebookServer', 'namespace', namespace) - const localVarPath = `/notebooks/server/{namespace}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * update name on a notebok, moving related s3 object to new location - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of notebook (array) that is url-encoded - * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateNotebookName: async (namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('updateNotebookName', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('updateNotebookName', 'array', array) - // verify required parameter 'notebookMetadata' is not null or undefined - assertParamExists('updateNotebookName', 'notebookMetadata', notebookMetadata) - const localVarPath = `/notebooks/{namespace}/{array}/rename` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(notebookMetadata, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * NotebookApi - functional programming interface - * @export - */ -export const NotebookApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = NotebookApiAxiosParamCreator(configuration) - return { - /** - * Get status of the notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getNotebookServerStatus(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getNotebookServerStatus(namespace, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Shutdown a notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async shutdownNotebookServer(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.shutdownNotebookServer(namespace, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * update name on a notebok, moving related s3 object to new location - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of notebook (array) that is url-encoded - * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateNotebookName(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateNotebookName(namespace, array, notebookMetadata, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * NotebookApi - factory interface - * @export - */ -export const NotebookApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = NotebookApiFp(configuration) - return { - /** - * Get status of the notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getNotebookServerStatus(namespace: string, options?: any): AxiosPromise { - return localVarFp.getNotebookServerStatus(namespace, options).then((request) => request(axios, basePath)); - }, - /** - * Shutdown a notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shutdownNotebookServer(namespace: string, options?: any): AxiosPromise { - return localVarFp.shutdownNotebookServer(namespace, options).then((request) => request(axios, basePath)); - }, - /** - * update name on a notebok, moving related s3 object to new location - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of notebook (array) that is url-encoded - * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateNotebookName(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any): AxiosPromise { - return localVarFp.updateNotebookName(namespace, array, notebookMetadata, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * NotebookApi - object-oriented interface - * @export - * @class NotebookApi - * @extends {BaseAPI} - */ -export class NotebookApi extends BaseAPI { - /** - * Get status of the notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof NotebookApi - */ - public getNotebookServerStatus(namespace: string, options?: any) { - return NotebookApiFp(this.configuration).getNotebookServerStatus(namespace, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Shutdown a notebook server - * @param {string} namespace namespace notebook is in (an organization name or user\'s username) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof NotebookApi - */ - public shutdownNotebookServer(namespace: string, options?: any) { - return NotebookApiFp(this.configuration).shutdownNotebookServer(namespace, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * update name on a notebok, moving related s3 object to new location - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of notebook (array) that is url-encoded - * @param {ArrayInfoUpdate} notebookMetadata notebook (array) metadata to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof NotebookApi - */ - public updateNotebookName(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options?: any) { - return NotebookApiFp(this.configuration).updateNotebookName(namespace, array, notebookMetadata, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * OrganizationApi - axios parameter creator - * @export - */ -export const OrganizationApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addAWSAccessCredentials: async (namespace: string, awsAccessCredentials: AWSAccessCredentials, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('addAWSAccessCredentials', 'namespace', namespace) - // verify required parameter 'awsAccessCredentials' is not null or undefined - assertParamExists('addAWSAccessCredentials', 'awsAccessCredentials', awsAccessCredentials) - const localVarPath = `/credentials/{namespace}/aws` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(awsAccessCredentials, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addUserToOrganization: async (organization: string, user: OrganizationUser, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('addUserToOrganization', 'organization', organization) - // verify required parameter 'user' is not null or undefined - assertParamExists('addUserToOrganization', 'user', user) - const localVarPath = `/organizations/{organization}/user` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentials: async (namespace: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('checkAWSAccessCredentials', 'namespace', namespace) - const localVarPath = `/credentials/{namespace}/aws` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentialsByName: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('checkAWSAccessCredentialsByName', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('checkAWSAccessCredentialsByName', 'name', name) - const localVarPath = `/credentials/{namespace}/aws/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * create a organization, the user creating will be listed as owner - * @param {Organization} organization organization to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createOrganization: async (organization: Organization, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('createOrganization', 'organization', organization) - const localVarPath = `/organization`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(organization, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteAWSAccessCredentials: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('deleteAWSAccessCredentials', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteAWSAccessCredentials', 'name', name) - const localVarPath = `/credentials/{namespace}/aws/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteOrganization: async (organization: string, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('deleteOrganization', 'organization', organization) - const localVarPath = `/organizations/{organization}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUserFromOrganization: async (organization: string, username: string, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('deleteUserFromOrganization', 'organization', organization) - // verify required parameter 'username' is not null or undefined - assertParamExists('deleteUserFromOrganization', 'username', username) - const localVarPath = `/organizations/{organization}/{username}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get all organizations that the user is member of - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAllOrganizations: async (options: any = {}): Promise => { - const localVarPath = `/organizations`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOrganization: async (organization: string, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('getOrganization', 'organization', organization) - const localVarPath = `/organizations/{organization}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOrganizationUser: async (organization: string, username: string, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('getOrganizationUser', 'organization', organization) - // verify required parameter 'username' is not null or undefined - assertParamExists('getOrganizationUser', 'username', username) - const localVarPath = `/organizations/{organization}/{username}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateAWSAccessCredentials: async (namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('updateAWSAccessCredentials', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('updateAWSAccessCredentials', 'name', name) - // verify required parameter 'awsAccessCredentials' is not null or undefined - assertParamExists('updateAWSAccessCredentials', 'awsAccessCredentials', awsAccessCredentials) - const localVarPath = `/credentials/{namespace}/aws/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(awsAccessCredentials, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * update a organization - * @param {string} organization organization name or id - * @param {Organization} organizationDetails organization details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateOrganization: async (organization: string, organizationDetails: Organization, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('updateOrganization', 'organization', organization) - // verify required parameter 'organizationDetails' is not null or undefined - assertParamExists('updateOrganization', 'organizationDetails', organizationDetails) - const localVarPath = `/organizations/{organization}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(organizationDetails, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUserInOrganization: async (organization: string, username: string, user: OrganizationUser, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('updateUserInOrganization', 'organization', organization) - // verify required parameter 'username' is not null or undefined - assertParamExists('updateUserInOrganization', 'username', username) - // verify required parameter 'user' is not null or undefined - assertParamExists('updateUserInOrganization', 'user', user) - const localVarPath = `/organizations/{organization}/{username}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * OrganizationApi - functional programming interface - * @export - */ -export const OrganizationApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = OrganizationApiAxiosParamCreator(configuration) - return { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAWSAccessCredentials(namespace, awsAccessCredentials, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async addUserToOrganization(organization: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addUserToOrganization(organization, user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async checkAWSAccessCredentials(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.checkAWSAccessCredentials(namespace, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.checkAWSAccessCredentialsByName(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * create a organization, the user creating will be listed as owner - * @param {Organization} organization organization to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createOrganization(organization: Organization, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createOrganization(organization, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteAWSAccessCredentials(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAWSAccessCredentials(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteOrganization(organization: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOrganization(organization, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteUserFromOrganization(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserFromOrganization(organization, username, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get all organizations that the user is member of - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getAllOrganizations(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getAllOrganizations(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getOrganization(organization: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganization(organization, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getOrganizationUser(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationUser(organization, username, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAWSAccessCredentials(namespace, name, awsAccessCredentials, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * update a organization - * @param {string} organization organization name or id - * @param {Organization} organizationDetails organization details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateOrganization(organization: string, organizationDetails: Organization, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateOrganization(organization, organizationDetails, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserInOrganization(organization, username, user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * OrganizationApi - factory interface - * @export - */ -export const OrganizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = OrganizationApiFp(configuration) - return { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise { - return localVarFp.addAWSAccessCredentials(namespace, awsAccessCredentials, options).then((request) => request(axios, basePath)); - }, - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addUserToOrganization(organization: string, user: OrganizationUser, options?: any): AxiosPromise { - return localVarFp.addUserToOrganization(organization, user, options).then((request) => request(axios, basePath)); - }, - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentials(namespace: string, options?: any): AxiosPromise> { - return localVarFp.checkAWSAccessCredentials(namespace, options).then((request) => request(axios, basePath)); - }, - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): AxiosPromise { - return localVarFp.checkAWSAccessCredentialsByName(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * create a organization, the user creating will be listed as owner - * @param {Organization} organization organization to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createOrganization(organization: Organization, options?: any): AxiosPromise { - return localVarFp.createOrganization(organization, options).then((request) => request(axios, basePath)); - }, - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteAWSAccessCredentials(namespace: string, name: string, options?: any): AxiosPromise { - return localVarFp.deleteAWSAccessCredentials(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * delete a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteOrganization(organization: string, options?: any): AxiosPromise { - return localVarFp.deleteOrganization(organization, options).then((request) => request(axios, basePath)); - }, - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUserFromOrganization(organization: string, username: string, options?: any): AxiosPromise { - return localVarFp.deleteUserFromOrganization(organization, username, options).then((request) => request(axios, basePath)); - }, - /** - * get all organizations that the user is member of - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getAllOrganizations(options?: any): AxiosPromise> { - return localVarFp.getAllOrganizations(options).then((request) => request(axios, basePath)); - }, - /** - * get a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOrganization(organization: string, options?: any): AxiosPromise { - return localVarFp.getOrganization(organization, options).then((request) => request(axios, basePath)); - }, - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOrganizationUser(organization: string, username: string, options?: any): AxiosPromise { - return localVarFp.getOrganizationUser(organization, username, options).then((request) => request(axios, basePath)); - }, - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise { - return localVarFp.updateAWSAccessCredentials(namespace, name, awsAccessCredentials, options).then((request) => request(axios, basePath)); - }, - /** - * update a organization - * @param {string} organization organization name or id - * @param {Organization} organizationDetails organization details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateOrganization(organization: string, organizationDetails: Organization, options?: any): AxiosPromise { - return localVarFp.updateOrganization(organization, organizationDetails, options).then((request) => request(axios, basePath)); - }, - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): AxiosPromise { - return localVarFp.updateUserInOrganization(organization, username, user, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * OrganizationApi - object-oriented interface - * @export - * @class OrganizationApi - * @extends {BaseAPI} - */ -export class OrganizationApi extends BaseAPI { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any) { - return OrganizationApiFp(this.configuration).addAWSAccessCredentials(namespace, awsAccessCredentials, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public addUserToOrganization(organization: string, user: OrganizationUser, options?: any) { - return OrganizationApiFp(this.configuration).addUserToOrganization(organization, user, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public checkAWSAccessCredentials(namespace: string, options?: any) { - return OrganizationApiFp(this.configuration).checkAWSAccessCredentials(namespace, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any) { - return OrganizationApiFp(this.configuration).checkAWSAccessCredentialsByName(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * create a organization, the user creating will be listed as owner - * @param {Organization} organization organization to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public createOrganization(organization: Organization, options?: any) { - return OrganizationApiFp(this.configuration).createOrganization(organization, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public deleteAWSAccessCredentials(namespace: string, name: string, options?: any) { - return OrganizationApiFp(this.configuration).deleteAWSAccessCredentials(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public deleteOrganization(organization: string, options?: any) { - return OrganizationApiFp(this.configuration).deleteOrganization(organization, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public deleteUserFromOrganization(organization: string, username: string, options?: any) { - return OrganizationApiFp(this.configuration).deleteUserFromOrganization(organization, username, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get all organizations that the user is member of - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public getAllOrganizations(options?: any) { - return OrganizationApiFp(this.configuration).getAllOrganizations(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get a organization - * @param {string} organization organization name or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public getOrganization(organization: string, options?: any) { - return OrganizationApiFp(this.configuration).getOrganization(organization, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public getOrganizationUser(organization: string, username: string, options?: any) { - return OrganizationApiFp(this.configuration).getOrganizationUser(organization, username, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any) { - return OrganizationApiFp(this.configuration).updateAWSAccessCredentials(namespace, name, awsAccessCredentials, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * update a organization - * @param {string} organization organization name or id - * @param {Organization} organizationDetails organization details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public updateOrganization(organization: string, organizationDetails: Organization, options?: any) { - return OrganizationApiFp(this.configuration).updateOrganization(organization, organizationDetails, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OrganizationApi - */ - public updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any) { - return OrganizationApiFp(this.configuration).updateUserInOrganization(organization, username, user, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * QueryApi - axios parameter creator - * @export - */ -export const QueryApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - finalizeQuery: async (namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('finalizeQuery', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('finalizeQuery', 'array', array) - // verify required parameter 'type' is not null or undefined - assertParamExists('finalizeQuery', 'type', type) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('finalizeQuery', 'contentType', contentType) - // verify required parameter 'query' is not null or undefined - assertParamExists('finalizeQuery', 'query', query) - const localVarPath = `/arrays/{namespace}/{array}/query/finalize` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (openAt !== undefined) { - localVarQueryParameter['open_at'] = openAt; - } - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(query, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getEstResultSizes: async (namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getEstResultSizes', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getEstResultSizes', 'array', array) - // verify required parameter 'type' is not null or undefined - assertParamExists('getEstResultSizes', 'type', type) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('getEstResultSizes', 'contentType', contentType) - // verify required parameter 'query' is not null or undefined - assertParamExists('getEstResultSizes', 'query', query) - const localVarPath = `/arrays/{namespace}/{array}/query/est_result_sizes` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (openAt !== undefined) { - localVarQueryParameter['open_at'] = openAt; - } - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(query, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * send a query to run against a specified array/URI registered to a group/project, returns file bytes - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFile: async (namespace: string, array: string, contentType: string, xPayer?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getFile', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('getFile', 'array', array) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('getFile', 'contentType', contentType) - const localVarPath = `/arrays/{namespace}/{array}/query/get_file` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitQuery: async (namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('submitQuery', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('submitQuery', 'array', array) - // verify required parameter 'type' is not null or undefined - assertParamExists('submitQuery', 'type', type) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('submitQuery', 'contentType', contentType) - // verify required parameter 'query' is not null or undefined - assertParamExists('submitQuery', 'query', query) - const localVarPath = `/arrays/{namespace}/{array}/query/submit` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (openAt !== undefined) { - localVarQueryParameter['open_at'] = openAt; - } - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(query, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * send a query to run against a specified array/URI registered to a group/project, returns json results - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {QueryJson} queryJson query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitQueryJson: async (namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('submitQueryJson', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('submitQueryJson', 'array', array) - // verify required parameter 'contentType' is not null or undefined - assertParamExists('submitQueryJson', 'contentType', contentType) - // verify required parameter 'queryJson' is not null or undefined - assertParamExists('submitQueryJson', 'queryJson', queryJson) - const localVarPath = `/arrays/{namespace}/{array}/query/submit_query_json` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (contentType !== undefined && contentType !== null) { - localVarHeaderParameter['Content-Type'] = String(contentType); - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(queryJson, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * QueryApi - functional programming interface - * @export - */ -export const QueryApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = QueryApiAxiosParamCreator(configuration) - return { - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async finalizeQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.finalizeQuery(namespace, array, type, contentType, query, xPayer, openAt, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * send a query to run against a specified array/URI registered to a group/project, returns file bytes - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getFile(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFile(namespace, array, contentType, xPayer, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitQuery(namespace, array, type, contentType, query, xPayer, openAt, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * send a query to run against a specified array/URI registered to a group/project, returns json results - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {QueryJson} queryJson query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitQueryJson(namespace, array, contentType, queryJson, xPayer, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * QueryApi - factory interface - * @export - */ -export const QueryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = QueryApiFp(configuration) - return { - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - finalizeQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise { - return localVarFp.finalizeQuery(namespace, array, type, contentType, query, xPayer, openAt, options).then((request) => request(axios, basePath)); - }, - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise { - return localVarFp.getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt, options).then((request) => request(axios, basePath)); - }, - /** - * send a query to run against a specified array/URI registered to a group/project, returns file bytes - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFile(namespace: string, array: string, contentType: string, xPayer?: string, options?: any): AxiosPromise { - return localVarFp.getFile(namespace, array, contentType, xPayer, options).then((request) => request(axios, basePath)); - }, - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise { - return localVarFp.submitQuery(namespace, array, type, contentType, query, xPayer, openAt, options).then((request) => request(axios, basePath)); - }, - /** - * send a query to run against a specified array/URI registered to a group/project, returns json results - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {QueryJson} queryJson query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any): AxiosPromise { - return localVarFp.submitQueryJson(namespace, array, contentType, queryJson, xPayer, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * QueryApi - object-oriented interface - * @export - * @class QueryApi - * @extends {BaseAPI} - */ -export class QueryApi extends BaseAPI { - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof QueryApi - */ - public finalizeQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any) { - return QueryApiFp(this.configuration).finalizeQuery(namespace, array, type, contentType, query, xPayer, openAt, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof QueryApi - */ - public getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any) { - return QueryApiFp(this.configuration).getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * send a query to run against a specified array/URI registered to a group/project, returns file bytes - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof QueryApi - */ - public getFile(namespace: string, array: string, contentType: string, xPayer?: string, options?: any) { - return QueryApiFp(this.configuration).getFile(namespace, array, contentType, xPayer, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * send a query to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} type type of query - * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {number} [openAt] open_at for array in unix epoch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof QueryApi - */ - public submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any) { - return QueryApiFp(this.configuration).submitQuery(namespace, array, type, contentType, query, xPayer, openAt, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * send a query to run against a specified array/URI registered to a group/project, returns json results - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {string} contentType Content Type of input and return mime - * @param {QueryJson} queryJson query to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof QueryApi - */ - public submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options?: any) { - return QueryApiFp(this.configuration).submitQueryJson(namespace, array, contentType, queryJson, xPayer, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * SqlApi - axios parameter creator - * @export - */ -export const SqlApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - runSQL: async (namespace: string, sql: SQLParameters, acceptEncoding?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('runSQL', 'namespace', namespace) - // verify required parameter 'sql' is not null or undefined - assertParamExists('runSQL', 'sql', sql) - const localVarPath = `/sql/{namespace}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sql, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * SqlApi - functional programming interface - * @export - */ -export const SqlApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = SqlApiAxiosParamCreator(configuration) - return { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.runSQL(namespace, sql, acceptEncoding, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * SqlApi - factory interface - * @export - */ -export const SqlApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = SqlApiFp(configuration) - return { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): AxiosPromise> { - return localVarFp.runSQL(namespace, sql, acceptEncoding, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * SqlApi - object-oriented interface - * @export - * @class SqlApi - * @extends {BaseAPI} - */ -export class SqlApi extends BaseAPI { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof SqlApi - */ - public runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any) { - return SqlApiFp(this.configuration).runSQL(namespace, sql, acceptEncoding, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * StatsApi - axios parameter creator - * @export - */ -export const StatsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Fetch libtiledb stat - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getTiledbStats: async (options: any = {}): Promise => { - const localVarPath = `/.stats`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * StatsApi - functional programming interface - * @export - */ -export const StatsApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = StatsApiAxiosParamCreator(configuration) - return { - /** - * Fetch libtiledb stat - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getTiledbStats(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTiledbStats(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * StatsApi - factory interface - * @export - */ -export const StatsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = StatsApiFp(configuration) - return { - /** - * Fetch libtiledb stat - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getTiledbStats(options?: any): AxiosPromise { - return localVarFp.getTiledbStats(options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * StatsApi - object-oriented interface - * @export - * @class StatsApi - * @extends {BaseAPI} - */ -export class StatsApi extends BaseAPI { - /** - * Fetch libtiledb stat - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof StatsApi - */ - public getTiledbStats(options?: any) { - return StatsApiFp(this.configuration).getTiledbStats(options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * TasksApi - axios parameter creator - * @export - */ -export const TasksApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - runSQL: async (namespace: string, sql: SQLParameters, acceptEncoding?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('runSQL', 'namespace', namespace) - // verify required parameter 'sql' is not null or undefined - assertParamExists('runSQL', 'sql', sql) - const localVarPath = `/sql/{namespace}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(sql, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch an array task - * @param {string} id task id to fetch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdGet: async (id: string, options: any = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('taskIdGet', 'id', id) - const localVarPath = `/task/{id}` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retrieve results of an array task - * @param {string} id task id to retrieve stored results - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdResultGet: async (id: string, acceptEncoding?: string, options: any = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('taskIdResultGet', 'id', id) - const localVarPath = `/task/{id}/result` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdRetryPost: async (id: string, acceptEncoding?: string, options: any = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('taskIdRetryPost', 'id', id) - const localVarPath = `/task/{id}/retry` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of all array tasks a user has access to - * @param {string} [namespace] namespace to filter - * @param {string} [createdBy] username to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" - * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included - * @param {string} [status] Filter to only return these statuses - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [orderby] sort by which field valid values include start_time, name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - tasksGet: async (namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, status?: string, search?: string, orderby?: string, options: any = {}): Promise => { - const localVarPath = `/tasks`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (namespace !== undefined) { - localVarQueryParameter['namespace'] = namespace; - } - - if (createdBy !== undefined) { - localVarQueryParameter['created_by'] = createdBy; - } - - if (array !== undefined) { - localVarQueryParameter['array'] = array; - } - - if (start !== undefined) { - localVarQueryParameter['start'] = start; - } - - if (end !== undefined) { - localVarQueryParameter['end'] = end; - } - - if (page !== undefined) { - localVarQueryParameter['page'] = page; - } - - if (perPage !== undefined) { - localVarQueryParameter['per_page'] = perPage; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (excludeType) { - localVarQueryParameter['exclude_type'] = excludeType.join(COLLECTION_FORMATS.csv); - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - if (search !== undefined) { - localVarQueryParameter['search'] = search; - } - - if (orderby !== undefined) { - localVarQueryParameter['orderby'] = orderby; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * TasksApi - functional programming interface - * @export - */ -export const TasksApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = TasksApiAxiosParamCreator(configuration) - return { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.runSQL(namespace, sql, acceptEncoding, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch an array task - * @param {string} id task id to fetch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async taskIdGet(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.taskIdGet(id, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Retrieve results of an array task - * @param {string} id task id to retrieve stored results - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async taskIdResultGet(id: string, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.taskIdResultGet(id, acceptEncoding, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async taskIdRetryPost(id: string, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.taskIdRetryPost(id, acceptEncoding, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of all array tasks a user has access to - * @param {string} [namespace] namespace to filter - * @param {string} [createdBy] username to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" - * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included - * @param {string} [status] Filter to only return these statuses - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [orderby] sort by which field valid values include start_time, name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async tasksGet(namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, status?: string, search?: string, orderby?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * TasksApi - factory interface - * @export - */ -export const TasksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = TasksApiFp(configuration) - return { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any): AxiosPromise> { - return localVarFp.runSQL(namespace, sql, acceptEncoding, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch an array task - * @param {string} id task id to fetch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdGet(id: string, options?: any): AxiosPromise { - return localVarFp.taskIdGet(id, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve results of an array task - * @param {string} id task id to retrieve stored results - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdResultGet(id: string, acceptEncoding?: string, options?: any): AxiosPromise { - return localVarFp.taskIdResultGet(id, acceptEncoding, options).then((request) => request(axios, basePath)); - }, - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - taskIdRetryPost(id: string, acceptEncoding?: string, options?: any): AxiosPromise { - return localVarFp.taskIdRetryPost(id, acceptEncoding, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of all array tasks a user has access to - * @param {string} [namespace] namespace to filter - * @param {string} [createdBy] username to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" - * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included - * @param {string} [status] Filter to only return these statuses - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [orderby] sort by which field valid values include start_time, name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - tasksGet(namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, status?: string, search?: string, orderby?: string, options?: any): AxiosPromise { - return localVarFp.tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * TasksApi - object-oriented interface - * @export - * @class TasksApi - * @extends {BaseAPI} - */ -export class TasksApi extends BaseAPI { - /** - * Run a sql query - * @param {string} namespace namespace to run task under is in (an organization name or user\'s username) - * @param {SQLParameters} sql sql being submitted - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public runSQL(namespace: string, sql: SQLParameters, acceptEncoding?: string, options?: any) { - return TasksApiFp(this.configuration).runSQL(namespace, sql, acceptEncoding, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch an array task - * @param {string} id task id to fetch - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public taskIdGet(id: string, options?: any) { - return TasksApiFp(this.configuration).taskIdGet(id, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retrieve results of an array task - * @param {string} id task id to retrieve stored results - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public taskIdResultGet(id: string, acceptEncoding?: string, options?: any) { - return TasksApiFp(this.configuration).taskIdResultGet(id, acceptEncoding, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Retry an array task - * @param {string} id task id to retry - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public taskIdRetryPost(id: string, acceptEncoding?: string, options?: any) { - return TasksApiFp(this.configuration).taskIdRetryPost(id, acceptEncoding, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of all array tasks a user has access to - * @param {string} [namespace] namespace to filter - * @param {string} [createdBy] username to filter - * @param {string} [array] name/uri of array that is url-encoded to filter - * @param {number} [start] start time for tasks to filter by - * @param {number} [end] end time for tasks to filter by - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" - * @param {Array} [excludeType] task_type to exclude matching array in results, more than one can be included - * @param {string} [status] Filter to only return these statuses - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [orderby] sort by which field valid values include start_time, name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public tasksGet(namespace?: string, createdBy?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, excludeType?: Array, status?: string, search?: string, orderby?: string, options?: any) { - return TasksApiFp(this.configuration).tasksGet(namespace, createdBy, array, start, end, page, perPage, type, excludeType, status, search, orderby, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * UdfApi - axios parameter creator - * @export - */ -export const UdfApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * delete a registerd UDF, this will remove all sharing and can not be undone - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUDFInfo: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('deleteUDFInfo', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteUDFInfo', 'name', name) - const localVarPath = `/udf/{namespace}/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get a specific UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUDFInfo: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getUDFInfo', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('getUDFInfo', 'name', name) - const localVarPath = `/udf/{namespace}/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get all sharing details of the udf - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUDFInfoSharingPolicies: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('getUDFInfoSharingPolicies', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('getUDFInfoSharingPolicies', 'name', name) - const localVarPath = `/udf/{namespace}/{name}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * register a UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to register - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - registerUDFInfo: async (namespace: string, name: string, udf: UDFInfoUpdate, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('registerUDFInfo', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('registerUDFInfo', 'name', name) - // verify required parameter 'udf' is not null or undefined - assertParamExists('registerUDFInfo', 'udf', udf) - const localVarPath = `/udf/{namespace}/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(udf, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Share a UDF with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shareUDFInfo: async (namespace: string, name: string, udfSharing: UDFSharing, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('shareUDFInfo', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('shareUDFInfo', 'name', name) - // verify required parameter 'udfSharing' is not null or undefined - assertParamExists('shareUDFInfo', 'udfSharing', udfSharing) - const localVarPath = `/udf/{namespace}/{name}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(udfSharing, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * submit a generic UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {GenericUDF} udf udf to run - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitGenericUDF: async (namespace: string, udf: GenericUDF, acceptEncoding?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('submitGenericUDF', 'namespace', namespace) - // verify required parameter 'udf' is not null or undefined - assertParamExists('submitGenericUDF', 'udf', udf) - const localVarPath = `/udfs/generic/{namespace}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(udf, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * send a UDF to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {string} [acceptEncoding] Encoding to use - * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitUDF: async (namespace: string, array: string, udf: UDF, xPayer?: string, acceptEncoding?: string, v2?: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('submitUDF', 'namespace', namespace) - // verify required parameter 'array' is not null or undefined - assertParamExists('submitUDF', 'array', array) - // verify required parameter 'udf' is not null or undefined - assertParamExists('submitUDF', 'udf', udf) - const localVarPath = `/arrays/{namespace}/{array}/udf/submit` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (v2 !== undefined) { - localVarQueryParameter['v2'] = v2; - } - - if (xPayer !== undefined && xPayer !== null) { - localVarHeaderParameter['X-Payer'] = String(xPayer); - } - - if (acceptEncoding !== undefined && acceptEncoding !== null) { - localVarHeaderParameter['Accept-Encoding'] = String(acceptEncoding); - } - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(udf, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * updated an existing registerd UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUDFInfo: async (namespace: string, name: string, udf: UDFInfoUpdate, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('updateUDFInfo', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('updateUDFInfo', 'name', name) - // verify required parameter 'udf' is not null or undefined - assertParamExists('updateUDFInfo', 'udf', udf) - const localVarPath = `/udf/{namespace}/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(udf, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * UdfApi - functional programming interface - * @export - */ -export const UdfApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UdfApiAxiosParamCreator(configuration) - return { - /** - * delete a registerd UDF, this will remove all sharing and can not be undone - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteUDFInfo(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUDFInfo(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get a specific UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUDFInfo(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUDFInfo(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Get all sharing details of the udf - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUDFInfoSharingPolicies(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * register a UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to register - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.registerUDFInfo(namespace, name, udf, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Share a UDF with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.shareUDFInfo(namespace, name, udfSharing, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * submit a generic UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {GenericUDF} udf udf to run - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitGenericUDF(namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitGenericUDF(namespace, udf, acceptEncoding, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * send a UDF to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {string} [acceptEncoding] Encoding to use - * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitUDF(namespace: string, array: string, udf: UDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitUDF(namespace, array, udf, xPayer, acceptEncoding, v2, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * updated an existing registerd UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUDFInfo(namespace, name, udf, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * UdfApi - factory interface - * @export - */ -export const UdfApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UdfApiFp(configuration) - return { - /** - * delete a registerd UDF, this will remove all sharing and can not be undone - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUDFInfo(namespace: string, name: string, options?: any): AxiosPromise { - return localVarFp.deleteUDFInfo(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * get a specific UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUDFInfo(namespace: string, name: string, options?: any): AxiosPromise { - return localVarFp.getUDFInfo(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * Get all sharing details of the udf - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): AxiosPromise> { - return localVarFp.getUDFInfoSharingPolicies(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * register a UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to register - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): AxiosPromise { - return localVarFp.registerUDFInfo(namespace, name, udf, options).then((request) => request(axios, basePath)); - }, - /** - * Share a UDF with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): AxiosPromise { - return localVarFp.shareUDFInfo(namespace, name, udfSharing, options).then((request) => request(axios, basePath)); - }, - /** - * submit a generic UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {GenericUDF} udf udf to run - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitGenericUDF(namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any): AxiosPromise { - return localVarFp.submitGenericUDF(namespace, udf, acceptEncoding, options).then((request) => request(axios, basePath)); - }, - /** - * send a UDF to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {string} [acceptEncoding] Encoding to use - * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitUDF(namespace: string, array: string, udf: UDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any): AxiosPromise { - return localVarFp.submitUDF(namespace, array, udf, xPayer, acceptEncoding, v2, options).then((request) => request(axios, basePath)); - }, - /** - * updated an existing registerd UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): AxiosPromise { - return localVarFp.updateUDFInfo(namespace, name, udf, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * UdfApi - object-oriented interface - * @export - * @class UdfApi - * @extends {BaseAPI} - */ -export class UdfApi extends BaseAPI { - /** - * delete a registerd UDF, this will remove all sharing and can not be undone - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public deleteUDFInfo(namespace: string, name: string, options?: any) { - return UdfApiFp(this.configuration).deleteUDFInfo(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get a specific UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public getUDFInfo(namespace: string, name: string, options?: any) { - return UdfApiFp(this.configuration).getUDFInfo(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get all sharing details of the udf - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public getUDFInfoSharingPolicies(namespace: string, name: string, options?: any) { - return UdfApiFp(this.configuration).getUDFInfoSharingPolicies(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * register a UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to register - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any) { - return UdfApiFp(this.configuration).registerUDFInfo(namespace, name, udf, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Share a UDF with a user - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name of UDFInfo - * @param {UDFSharing} udfSharing Namespace and list of permissions to share with. An empty list of permissions will remove the namespace, if permissions already exist they will be deleted then new ones added. In the event of a failure, the new polcies will be rolled back to prevent partial policies, and its likely the udf will not be shared with the namespace at all - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any) { - return UdfApiFp(this.configuration).shareUDFInfo(namespace, name, udfSharing, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * submit a generic UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {GenericUDF} udf udf to run - * @param {string} [acceptEncoding] Encoding to use - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public submitGenericUDF(namespace: string, udf: GenericUDF, acceptEncoding?: string, options?: any) { - return UdfApiFp(this.configuration).submitGenericUDF(namespace, udf, acceptEncoding, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * send a UDF to run against a specified array/URI registered to a group/project - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} array name/uri of array that is url-encoded - * @param {UDF} udf udf to run - * @param {string} [xPayer] Name of organization or user who should be charged for this request - * @param {string} [acceptEncoding] Encoding to use - * @param {string} [v2] flag to indicate if v2 array udfs should be used, currently in beta testing. Setting any value will enable v2 array udfs - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public submitUDF(namespace: string, array: string, udf: UDF, xPayer?: string, acceptEncoding?: string, v2?: string, options?: any) { - return UdfApiFp(this.configuration).submitUDF(namespace, array, udf, xPayer, acceptEncoding, v2, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * updated an existing registerd UDF in the given namespace - * @param {string} namespace namespace array is in (an organization name or user\'s username) - * @param {string} name name to register udf under - * @param {UDFInfoUpdate} udf udf to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any) { - return UdfApiFp(this.configuration).updateUDFInfo(namespace, name, udf, options).then((request) => request(this.axios, this.basePath)); - } -} - - -/** - * UserApi - axios parameter creator - * @export - */ -export const UserApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addAWSAccessCredentials: async (namespace: string, awsAccessCredentials: AWSAccessCredentials, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('addAWSAccessCredentials', 'namespace', namespace) - // verify required parameter 'awsAccessCredentials' is not null or undefined - assertParamExists('addAWSAccessCredentials', 'awsAccessCredentials', awsAccessCredentials) - const localVarPath = `/credentials/{namespace}/aws` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(awsAccessCredentials, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addUserToOrganization: async (organization: string, user: OrganizationUser, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('addUserToOrganization', 'organization', organization) - // verify required parameter 'user' is not null or undefined - assertParamExists('addUserToOrganization', 'user', user) - const localVarPath = `/organizations/{organization}/user` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentials: async (namespace: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('checkAWSAccessCredentials', 'namespace', namespace) - const localVarPath = `/credentials/{namespace}/aws` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentialsByName: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('checkAWSAccessCredentialsByName', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('checkAWSAccessCredentialsByName', 'name', name) - const localVarPath = `/credentials/{namespace}/aws/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * confirm user email - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - confirmEmail: async (options: any = {}): Promise => { - const localVarPath = `/user/confirm_email`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * create a user - * @param {User} user user to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createUser: async (user: User, options: any = {}): Promise => { - // verify required parameter 'user' is not null or undefined - assertParamExists('createUser', 'user', user) - const localVarPath = `/user`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteAWSAccessCredentials: async (namespace: string, name: string, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('deleteAWSAccessCredentials', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('deleteAWSAccessCredentials', 'name', name) - const localVarPath = `/credentials/{namespace}/aws/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUser: async (username: string, options: any = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('deleteUser', 'username', username) - const localVarPath = `/users/{username}` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUserFromOrganization: async (organization: string, username: string, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('deleteUserFromOrganization', 'organization', organization) - // verify required parameter 'username' is not null or undefined - assertParamExists('deleteUserFromOrganization', 'username', username) - const localVarPath = `/organizations/{organization}/{username}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOrganizationUser: async (organization: string, username: string, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('getOrganizationUser', 'organization', organization) - // verify required parameter 'username' is not null or undefined - assertParamExists('getOrganizationUser', 'username', username) - const localVarPath = `/organizations/{organization}/{username}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get session token for user - * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSession: async (rememberMe?: string, options: any = {}): Promise => { - const localVarPath = `/session`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - if (rememberMe !== undefined) { - localVarQueryParameter['remember_me'] = rememberMe; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get a user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUser: async (options: any = {}): Promise => { - const localVarPath = `/user`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * get a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUserWithUsername: async (username: string, options: any = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('getUserWithUsername', 'username', username) - const localVarPath = `/users/{username}` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token - * @param {TokenRequest} [tokenRequest] token request object - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - requestToken: async (tokenRequest?: TokenRequest, options: any = {}): Promise => { - const localVarPath = `/token`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(tokenRequest, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * reset user password - * @param {InlineObject} user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - resetUserPassword: async (user: InlineObject, options: any = {}): Promise => { - // verify required parameter 'user' is not null or undefined - assertParamExists('resetUserPassword', 'user', user) - const localVarPath = `/user/password_reset`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * revoke an authorization token - * @param {string} token token name or token itself - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - revokeToken: async (token: string, options: any = {}): Promise => { - // verify required parameter 'token' is not null or undefined - assertParamExists('revokeToken', 'token', token) - const localVarPath = `/tokens/{token}` - .replace(`{${"token"}}`, encodeURIComponent(String(token))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Fetch a list of user tokens - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - tokensGet: async (options: any = {}): Promise => { - const localVarPath = `/tokens`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateAWSAccessCredentials: async (namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options: any = {}): Promise => { - // verify required parameter 'namespace' is not null or undefined - assertParamExists('updateAWSAccessCredentials', 'namespace', namespace) - // verify required parameter 'name' is not null or undefined - assertParamExists('updateAWSAccessCredentials', 'name', name) - // verify required parameter 'awsAccessCredentials' is not null or undefined - assertParamExists('updateAWSAccessCredentials', 'awsAccessCredentials', awsAccessCredentials) - const localVarPath = `/credentials/{namespace}/aws/{name}` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(awsAccessCredentials, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * update a user - * @param {string} username username or id - * @param {User} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUser: async (username: string, user: User, options: any = {}): Promise => { - // verify required parameter 'username' is not null or undefined - assertParamExists('updateUser', 'username', username) - // verify required parameter 'user' is not null or undefined - assertParamExists('updateUser', 'user', user) - const localVarPath = `/users/{username}` - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUserInOrganization: async (organization: string, username: string, user: OrganizationUser, options: any = {}): Promise => { - // verify required parameter 'organization' is not null or undefined - assertParamExists('updateUserInOrganization', 'organization', organization) - // verify required parameter 'username' is not null or undefined - assertParamExists('updateUserInOrganization', 'username', username) - // verify required parameter 'user' is not null or undefined - assertParamExists('updateUserInOrganization', 'user', user) - const localVarPath = `/organizations/{organization}/{username}` - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) - .replace(`{${"username"}}`, encodeURIComponent(String(username))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - await setApiKeyToObject(localVarHeaderParameter, "X-TILEDB-REST-API-KEY", configuration) - - // authentication BasicAuth required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(user, localVarRequestOptions, configuration) - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - } -}; - -/** - * UserApi - functional programming interface - * @export - */ -export const UserApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) - return { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addAWSAccessCredentials(namespace, awsAccessCredentials, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async addUserToOrganization(organization: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addUserToOrganization(organization, user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async checkAWSAccessCredentials(namespace: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.checkAWSAccessCredentials(namespace, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.checkAWSAccessCredentialsByName(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * confirm user email - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async confirmEmail(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.confirmEmail(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * create a user - * @param {User} user user to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createUser(user: User, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createUser(user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteAWSAccessCredentials(namespace: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAWSAccessCredentials(namespace, name, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteUser(username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUser(username, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteUserFromOrganization(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserFromOrganization(organization, username, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getOrganizationUser(organization: string, username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationUser(organization, username, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Get session token for user - * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getSession(rememberMe?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getSession(rememberMe, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get a user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUser(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * get a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUserWithUsername(username: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getUserWithUsername(username, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token - * @param {TokenRequest} [tokenRequest] token request object - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async requestToken(tokenRequest?: TokenRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.requestToken(tokenRequest, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * reset user password - * @param {InlineObject} user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async resetUserPassword(user: InlineObject, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.resetUserPassword(user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * revoke an authorization token - * @param {string} token token name or token itself - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async revokeToken(token: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.revokeToken(token, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Fetch a list of user tokens - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async tokensGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.tokensGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateAWSAccessCredentials(namespace, name, awsAccessCredentials, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * update a user - * @param {string} username username or id - * @param {User} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateUser(username: string, user: User, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(username, user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUserInOrganization(organization, username, user, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - } -}; - -/** - * UserApi - factory interface - * @export - */ -export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = UserApiFp(configuration) - return { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise { - return localVarFp.addAWSAccessCredentials(namespace, awsAccessCredentials, options).then((request) => request(axios, basePath)); - }, - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - addUserToOrganization(organization: string, user: OrganizationUser, options?: any): AxiosPromise { - return localVarFp.addUserToOrganization(organization, user, options).then((request) => request(axios, basePath)); - }, - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentials(namespace: string, options?: any): AxiosPromise> { - return localVarFp.checkAWSAccessCredentials(namespace, options).then((request) => request(axios, basePath)); - }, - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any): AxiosPromise { - return localVarFp.checkAWSAccessCredentialsByName(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * confirm user email - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - confirmEmail(options?: any): AxiosPromise { - return localVarFp.confirmEmail(options).then((request) => request(axios, basePath)); - }, - /** - * create a user - * @param {User} user user to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createUser(user: User, options?: any): AxiosPromise { - return localVarFp.createUser(user, options).then((request) => request(axios, basePath)); - }, - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteAWSAccessCredentials(namespace: string, name: string, options?: any): AxiosPromise { - return localVarFp.deleteAWSAccessCredentials(namespace, name, options).then((request) => request(axios, basePath)); - }, - /** - * delete a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUser(username: string, options?: any): AxiosPromise { - return localVarFp.deleteUser(username, options).then((request) => request(axios, basePath)); - }, - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteUserFromOrganization(organization: string, username: string, options?: any): AxiosPromise { - return localVarFp.deleteUserFromOrganization(organization, username, options).then((request) => request(axios, basePath)); - }, - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOrganizationUser(organization: string, username: string, options?: any): AxiosPromise { - return localVarFp.getOrganizationUser(organization, username, options).then((request) => request(axios, basePath)); - }, - /** - * Get session token for user - * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSession(rememberMe?: string, options?: any): AxiosPromise { - return localVarFp.getSession(rememberMe, options).then((request) => request(axios, basePath)); - }, - /** - * get a user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUser(options?: any): AxiosPromise { - return localVarFp.getUser(options).then((request) => request(axios, basePath)); - }, - /** - * get a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUserWithUsername(username: string, options?: any): AxiosPromise { - return localVarFp.getUserWithUsername(username, options).then((request) => request(axios, basePath)); - }, - /** - * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token - * @param {TokenRequest} [tokenRequest] token request object - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - requestToken(tokenRequest?: TokenRequest, options?: any): AxiosPromise { - return localVarFp.requestToken(tokenRequest, options).then((request) => request(axios, basePath)); - }, - /** - * reset user password - * @param {InlineObject} user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - resetUserPassword(user: InlineObject, options?: any): AxiosPromise { - return localVarFp.resetUserPassword(user, options).then((request) => request(axios, basePath)); - }, - /** - * revoke an authorization token - * @param {string} token token name or token itself - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - revokeToken(token: string, options?: any): AxiosPromise { - return localVarFp.revokeToken(token, options).then((request) => request(axios, basePath)); - }, - /** - * Fetch a list of user tokens - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - tokensGet(options?: any): AxiosPromise> { - return localVarFp.tokensGet(options).then((request) => request(axios, basePath)); - }, - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any): AxiosPromise { - return localVarFp.updateAWSAccessCredentials(namespace, name, awsAccessCredentials, options).then((request) => request(axios, basePath)); - }, - /** - * update a user - * @param {string} username username or id - * @param {User} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUser(username: string, user: User, options?: any): AxiosPromise { - return localVarFp.updateUser(username, user, options).then((request) => request(axios, basePath)); - }, - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any): AxiosPromise { - return localVarFp.updateUserInOrganization(organization, username, user, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} - */ -export class UserApi extends BaseAPI { - /** - * Add aws keys - * @param {string} namespace namespace - * @param {AWSAccessCredentials} awsAccessCredentials aws access credentials to store for a namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public addAWSAccessCredentials(namespace: string, awsAccessCredentials: AWSAccessCredentials, options?: any) { - return UserApiFp(this.configuration).addAWSAccessCredentials(namespace, awsAccessCredentials, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * add a user to an organization - * @param {string} organization organization name - * @param {OrganizationUser} user user to add - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public addUserToOrganization(organization: string, user: OrganizationUser, options?: any) { - return UserApiFp(this.configuration).addUserToOrganization(organization, user, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Check if aws keys are set - * @param {string} namespace namespace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public checkAWSAccessCredentials(namespace: string, options?: any) { - return UserApiFp(this.configuration).checkAWSAccessCredentials(namespace, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Check if aws keys are set by name - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public checkAWSAccessCredentialsByName(namespace: string, name: string, options?: any) { - return UserApiFp(this.configuration).checkAWSAccessCredentialsByName(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * confirm user email - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public confirmEmail(options?: any) { - return UserApiFp(this.configuration).confirmEmail(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * create a user - * @param {User} user user to create - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public createUser(user: User, options?: any) { - return UserApiFp(this.configuration).createUser(user, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a AWS Access credentials in a namespace. This will likely cause arrays to become unreachable - * @param {string} namespace namespace - * @param {string} name name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public deleteAWSAccessCredentials(namespace: string, name: string, options?: any) { - return UserApiFp(this.configuration).deleteAWSAccessCredentials(namespace, name, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public deleteUser(username: string, options?: any) { - return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * delete a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public deleteUserFromOrganization(organization: string, username: string, options?: any) { - return UserApiFp(this.configuration).deleteUserFromOrganization(organization, username, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get a user from an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public getOrganizationUser(organization: string, username: string, options?: any) { - return UserApiFp(this.configuration).getOrganizationUser(organization, username, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Get session token for user - * @param {string} [rememberMe] flag to create a token with expiration of 30 days, default is false - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public getSession(rememberMe?: string, options?: any) { - return UserApiFp(this.configuration).getSession(rememberMe, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get a user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public getUser(options?: any) { - return UserApiFp(this.configuration).getUser(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * get a user - * @param {string} username username or id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public getUserWithUsername(username: string, options?: any) { - return UserApiFp(this.configuration).getUserWithUsername(username, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Request an authorization token, optionally taken a TokenRequest object to set parameters on the token - * @param {TokenRequest} [tokenRequest] token request object - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public requestToken(tokenRequest?: TokenRequest, options?: any) { - return UserApiFp(this.configuration).requestToken(tokenRequest, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * reset user password - * @param {InlineObject} user - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public resetUserPassword(user: InlineObject, options?: any) { - return UserApiFp(this.configuration).resetUserPassword(user, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * revoke an authorization token - * @param {string} token token name or token itself - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public revokeToken(token: string, options?: any) { - return UserApiFp(this.configuration).revokeToken(token, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Fetch a list of user tokens - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public tokensGet(options?: any) { - return UserApiFp(this.configuration).tokensGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * Update aws keys or associated buckets. This will update the key associations for each array in the namespace - * @param {string} namespace namespace - * @param {string} name name - * @param {AWSAccessCredentials} awsAccessCredentials aws credentials to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public updateAWSAccessCredentials(namespace: string, name: string, awsAccessCredentials: AWSAccessCredentials, options?: any) { - return UserApiFp(this.configuration).updateAWSAccessCredentials(namespace, name, awsAccessCredentials, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * update a user - * @param {string} username username or id - * @param {User} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public updateUser(username: string, user: User, options?: any) { - return UserApiFp(this.configuration).updateUser(username, user, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * update a user in an organization - * @param {string} organization organization name - * @param {string} username username to manipulate - * @param {OrganizationUser} user user details to update - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UserApi - */ - public updateUserInOrganization(organization: string, username: string, user: OrganizationUser, options?: any) { - return UserApiFp(this.configuration).updateUserInOrganization(organization, username, user, options).then((request) => request(this.axios, this.basePath)); - } -} - - diff --git a/lib/base.d.ts b/lib/base.d.ts new file mode 100644 index 0000000..b320a06 --- /dev/null +++ b/lib/base.d.ts @@ -0,0 +1,55 @@ +/** + * TileDB Storage Platform API + * TileDB Storage Platform REST API + * + * The version of the OpenAPI document: 2.2.19 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +import { Configuration } from "./configuration"; +import { AxiosInstance } from 'axios'; +export declare const BASE_PATH: string; +/** + * + * @export + */ +export declare const COLLECTION_FORMATS: { + csv: string; + ssv: string; + tsv: string; + pipes: string; +}; +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + options: any; +} +/** + * + * @export + * @class BaseAPI + */ +export declare class BaseAPI { + protected basePath: string; + protected axios: AxiosInstance; + protected configuration: Configuration | undefined; + constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); +} +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export declare class RequiredError extends Error { + field: string; + name: "RequiredError"; + constructor(field: string, msg?: string); +} diff --git a/lib/base.js b/lib/base.js index 89883ef..7565ff1 100644 --- a/lib/base.js +++ b/lib/base.js @@ -5,7 +5,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 + * The version of the OpenAPI document: 2.2.19 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/lib/base.ts b/lib/base.ts deleted file mode 100644 index 71b41c1..0000000 --- a/lib/base.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * TileDB Storage Platform API - * TileDB Storage Platform REST API - * - * The version of the OpenAPI document: 2.2.9 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from "./configuration"; -// Some imports not used depending on template conditions -// @ts-ignore -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; - -export const BASE_PATH = "https://api.tiledb.com/v1".replace(/\/+$/, ""); - -/** - * - * @export - */ -export const COLLECTION_FORMATS = { - csv: ",", - ssv: " ", - tsv: "\t", - pipes: "|", -}; - -/** - * - * @export - * @interface RequestArgs - */ -export interface RequestArgs { - url: string; - options: any; -} - -/** - * - * @export - * @class BaseAPI - */ -export class BaseAPI { - protected configuration: Configuration | undefined; - - constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { - if (configuration) { - this.configuration = configuration; - this.basePath = configuration.basePath || this.basePath; - } - } -}; - -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ -export class RequiredError extends Error { - name: "RequiredError" = "RequiredError"; - constructor(public field: string, msg?: string) { - super(msg); - } -} diff --git a/lib/common.d.ts b/lib/common.d.ts new file mode 100644 index 0000000..bec2e75 --- /dev/null +++ b/lib/common.d.ts @@ -0,0 +1,65 @@ +/** + * TileDB Storage Platform API + * TileDB Storage Platform REST API + * + * The version of the OpenAPI document: 2.2.19 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +import { Configuration } from "./configuration"; +import { RequestArgs } from "./base"; +import { AxiosInstance } from 'axios'; +/** + * + * @export + */ +export declare const DUMMY_BASE_URL = "https://example.com"; +/** + * + * @throws {RequiredError} + * @export + */ +export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void; +/** + * + * @export + */ +export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise; +/** + * + * @export + */ +export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void; +/** + * + * @export + */ +export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise; +/** + * + * @export + */ +export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise; +/** + * + * @export + */ +export declare const setSearchParams: (url: URL, ...objects: any[]) => void; +/** + * + * @export + */ +export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any; +/** + * + * @export + */ +export declare const toPathString: (url: URL) => string; +/** + * + * @export + */ +export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => (axios?: AxiosInstance, basePath?: string) => Promise>; diff --git a/lib/common.js b/lib/common.js index 09ad464..16ebb85 100644 --- a/lib/common.js +++ b/lib/common.js @@ -5,7 +5,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 + * The version of the OpenAPI document: 2.2.19 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/lib/common.ts b/lib/common.ts deleted file mode 100644 index 9dcf927..0000000 --- a/lib/common.ts +++ /dev/null @@ -1,131 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * TileDB Storage Platform API - * TileDB Storage Platform REST API - * - * The version of the OpenAPI document: 2.2.9 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -import { Configuration } from "./configuration"; -import { RequiredError,　RequestArgs } from "./base"; -import { AxiosInstance } from 'axios'; - -/** - * - * @export - */ -export const DUMMY_BASE_URL = 'https://example.com' - -/** - * - * @throws {RequiredError} - * @export - */ -export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { - if (paramValue === null || paramValue === undefined) { - throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); - } -} - -/** - * - * @export - */ -export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? await configuration.apiKey(keyParamName) - : await configuration.apiKey; - object[keyParamName] = localVarApiKeyValue; - } -} - -/** - * - * @export - */ -export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { - if (configuration && (configuration.username || configuration.password)) { - object["auth"] = { username: configuration.username, password: configuration.password }; - } -} - -/** - * - * @export - */ -export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const accessToken = typeof configuration.accessToken === 'function' - ? await configuration.accessToken() - : await configuration.accessToken; - object["Authorization"] = "Bearer " + accessToken; - } -} - -/** - * - * @export - */ -export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { - if (configuration && configuration.accessToken) { - const localVarAccessTokenValue = typeof configuration.accessToken === 'function' - ? await configuration.accessToken(name, scopes) - : await configuration.accessToken; - object["Authorization"] = "Bearer " + localVarAccessTokenValue; - } -} - -/** - * - * @export - */ -export const setSearchParams = function (url: URL, ...objects: any[]) { - const searchParams = new URLSearchParams(url.search); - for (const object of objects) { - for (const key in object) { - searchParams.set(key, object[key]); - } - } - url.search = searchParams.toString(); -} - -/** - * - * @export - */ -export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { - const nonString = typeof value !== 'string'; - const needsSerialization = nonString && configuration && configuration.isJsonMime - ? configuration.isJsonMime(requestOptions.headers['Content-Type']) - : nonString; - return needsSerialization - ? JSON.stringify(value !== undefined ? value : {}) - : (value || ""); -} - -/** - * - * @export - */ -export const toPathString = function (url: URL) { - return url.pathname + url.search + url.hash -} - -/** - * - * @export - */ -export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url}; - return axios.request(axiosRequestArgs); - }; -} diff --git a/lib/configuration.ts b/lib/configuration.d.ts similarity index 75% rename from lib/configuration.ts rename to lib/configuration.d.ts index fc2c7c7..d01a755 100644 --- a/lib/configuration.ts +++ b/lib/configuration.d.ts @@ -1,18 +1,14 @@ -/* tslint:disable */ -/* eslint-disable */ /** * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 - * + * The version of the OpenAPI document: 2.2.19 + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - - export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; @@ -22,8 +18,7 @@ export interface ConfigurationParameters { baseOptions?: any; formDataCtor?: new () => any; } - -export class Configuration { +export declare class Configuration { /** * parameter for apiKey security * @param name security name @@ -73,17 +68,7 @@ export class Configuration { * @type {new () => FormData} */ formDataCtor?: new () => any; - - constructor(param: ConfigurationParameters = {}) { - this.apiKey = param.apiKey; - this.username = param.username; - this.password = param.password; - this.accessToken = param.accessToken; - this.basePath = param.basePath; - this.baseOptions = param.baseOptions; - this.formDataCtor = param.formDataCtor; - } - + constructor(param?: ConfigurationParameters); /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: @@ -94,8 +79,5 @@ export class Configuration { * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ - public isJsonMime?(mime: string): boolean { - const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); - return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); - } -} \ No newline at end of file + isJsonMime?(mime: string): boolean; +} diff --git a/lib/configuration.js b/lib/configuration.js index ee66337..edbcd8d 100644 --- a/lib/configuration.js +++ b/lib/configuration.js @@ -5,7 +5,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 + * The version of the OpenAPI document: 2.2.19 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/lib/git_push.sh b/lib/git_push.sh deleted file mode 100644 index ced3be2..0000000 --- a/lib/git_push.sh +++ /dev/null @@ -1,58 +0,0 @@ -#!/bin/sh -# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ -# -# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" - -git_user_id=$1 -git_repo_id=$2 -release_note=$3 -git_host=$4 - -if [ "$git_host" = "" ]; then - git_host="github.com" - echo "[INFO] No command line input provided. Set \$git_host to $git_host" -fi - -if [ "$git_user_id" = "" ]; then - git_user_id="GIT_USER_ID" - echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" -fi - -if [ "$git_repo_id" = "" ]; then - git_repo_id="GIT_REPO_ID" - echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" -fi - -if [ "$release_note" = "" ]; then - release_note="Minor update" - echo "[INFO] No command line input provided. Set \$release_note to $release_note" -fi - -# Initialize the local directory as a Git repository -git init - -# Adds the files in the local repository and stages them for commit. -git add . - -# Commits the tracked changes and prepares them to be pushed to a remote repository. -git commit -m "$release_note" - -# Sets the new remote -git_remote=`git remote` -if [ "$git_remote" = "" ]; then # git remote not defined - - if [ "$GIT_TOKEN" = "" ]; then - echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." - git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git - else - git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git - fi - -fi - -git pull origin master - -# Pushes (Forces) the changes in the local repository up to the remote repository -echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" -git push origin master 2>&1 | grep -v 'To https' - diff --git a/lib/index.ts b/lib/index.d.ts similarity index 75% rename from lib/index.ts rename to lib/index.d.ts index b844f85..9145c5f 100644 --- a/lib/index.ts +++ b/lib/index.d.ts @@ -1,18 +1,13 @@ -/* tslint:disable */ -/* eslint-disable */ /** * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 - * + * The version of the OpenAPI document: 2.2.19 + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ - - export * from "./api"; export * from "./configuration"; - diff --git a/lib/index.js b/lib/index.js index f9f8e48..12afa95 100644 --- a/lib/index.js +++ b/lib/index.js @@ -5,7 +5,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.2.9 + * The version of the OpenAPI document: 2.2.19 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/package.json b/package.json index e9e1e66..e92a250 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,11 @@ { "name": "@tiledb-inc/tiledb-cloud", - "version": "0.1.1", + "version": "0.1.2", "description": "JavaScript client for the TileDB Cloud Service.", "main": "lib/index.js", "scripts": { - "generate-openapi": "openapi-generator-cli generate -i ../TileDB-Cloud-API-Spec/openapi-v1.yaml -o ./lib -g typescript-axios -t ./openapi-templates --reserved-words-mappings default=default --type-mappings=Array=any", - "build": "npm run generate-openapi && tsc lib/index.ts", + "generate-openapi": "openapi-generator-cli generate -i ../TileDB-Cloud-API-Spec/openapi-v1.yaml -o ./tmp -g typescript-axios -t ./openapi-templates --reserved-words-mappings default=default --type-mappings=Array=any", + "build": "npm run generate-openapi && tsc tmp/index.ts --declaration --outDir ./lib", "test": "jest" }, "dependencies": {