From f7c5344102f2d68198d48366f6b67daf53360174 Mon Sep 17 00:00:00 2001 From: Alex Diktampanidis Date: Fri, 2 Oct 2020 02:39:14 +0300 Subject: [PATCH 1/2] Generated from api spec 2.0.13 --- package.json | 2 +- src/README.md | 4 +- src/api.ts | 1925 ++++++++++++++++++++++++++++++++--------- src/base.ts | 2 +- src/configuration.ts | 2 +- src/index.ts | 2 +- src/package-lock.json | 14 +- src/package.json | 2 +- 8 files changed, 1527 insertions(+), 426 deletions(-) diff --git a/package.json b/package.json index ea43642..164528d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@tiledb-inc/tiledb-cloud", - "version": "0.0.5", + "version": "0.0.7", "description": "JavaScript client for the TileDB Cloud Service.", "main": "lib/index.js", "dependencies": { diff --git a/src/README.md b/src/README.md index ac63ff2..b429d84 100644 --- a/src/README.md +++ b/src/README.md @@ -1,4 +1,4 @@ -## @tiledb-inc/tiledb-cloud@2.0.2 +## @tiledb-inc/tiledb-cloud@2.0.13 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: @@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co _published:_ ``` -npm install @tiledb-inc/tiledb-cloud@2.0.2 --save +npm install @tiledb-inc/tiledb-cloud@2.0.13 --save ``` _unPublished (not recommended):_ diff --git a/src/api.ts b/src/api.ts index afc71ea..38c0382 100644 --- a/src/api.ts +++ b/src/api.ts @@ -3,7 +3,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.0.2 + * The version of the OpenAPI document: 2.0.13 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -298,6 +298,12 @@ export interface ArrayInfo { * @memberof ArrayInfo */ publicShare?: boolean; + /** + * Depends on the namespace asking, denotes the existence of subscription of namespace to this array + * @type {boolean} + * @memberof ArrayInfo + */ + namespaceSubscribed?: boolean; /** * uri for access through TileDB cloud * @type {string} @@ -310,6 +316,18 @@ export interface ArrayInfo { * @memberof ArrayInfo */ tags?: Array; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof ArrayInfo + */ + licenseId?: string; + /** + * License text + * @type {string} + * @memberof ArrayInfo + */ + licenseText?: string; } /** * metadata of an array @@ -353,6 +371,18 @@ export interface ArrayInfoUpdate { * @memberof ArrayInfoUpdate */ tags?: Array; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof ArrayInfoUpdate + */ + licenseId?: string; + /** + * License text + * @type {string} + * @memberof ArrayInfoUpdate + */ + licenseText?: string; } /** * user\'s TileDB array metadata @@ -762,6 +792,12 @@ export interface Attribute { * @memberof Attribute */ cellValNum: number; + /** + * The default fill value + * @type {Array} + * @memberof Attribute + */ + fillValue?: Array; } /** * Represents an attribute buffer header information @@ -1114,6 +1150,71 @@ export interface DomainArray { */ float64?: Array; } +/** + * + * @export + * @interface Favorite + */ +export interface Favorite { + /** + * unique uuid of the favorite + * @type {string} + * @memberof Favorite + */ + id?: string; + /** + * + * @type {FavoriteType} + * @memberof Favorite + */ + objectType?: 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 + */ + objectType?: FavoriteType; +} /** * Filter * @export @@ -1250,11 +1351,11 @@ export enum FilterType { */ export interface GenericUDF { /** - * name of registered udf to run, format is {namespace}/{udf_name}. Can not be used with exec + * name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec * @type {string} * @memberof GenericUDF */ - registeredUdf?: string; + udfInfoName?: string; /** * * @type {UDFLanguage} @@ -1655,6 +1756,19 @@ export interface NonEmptyDomain { */ isEmpty: boolean; } +/** + * Settings for a namespace\'s notebooks + * @export + * @interface NotebookSettings + */ +export interface NotebookSettings { + /** + * default s3 path to store newly created notebooks + * @type {string} + * @memberof NotebookSettings + */ + defaultS3Path?: string; +} /** * Status details of a notebook server * @export @@ -1770,6 +1884,18 @@ export interface Organization { * @memberof Organization */ enabledFeatures?: Array; + /** + * A notice that the user has an unpaid subscription + * @type {boolean} + * @memberof Organization + */ + unpaidSubscription?: boolean; + /** + * + * @type {NotebookSettings} + * @memberof Organization + */ + notebookSettings?: NotebookSettings; } /** * role user has in organization @@ -1894,7 +2020,7 @@ export interface Pricing { */ productName?: string; /** - * Extra information about a product which will appear on your customer’s credit card statement + * Extra information about a product which will appear on the credit card statement of the customer * @type {string} * @memberof Pricing */ @@ -2060,6 +2186,44 @@ export interface Query { */ totalVarLenBufferBytes: number; } +/** + * Query returning results as json + * @export + * @interface QueryJson + */ +export interface QueryJson { + /** + * + * @type {QueryRanges} + * @memberof QueryJson + */ + queryRanges?: 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 @@ -2424,11 +2588,11 @@ export interface TokenRequest { */ export interface UDF { /** - * name of registered udf to run, format is {namespace}/{udf_name}. Can not be used with exec + * name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec * @type {string} * @memberof UDF */ - registeredUdf?: string; + udfInfoName?: string; /** * * @type {UDFLanguage} @@ -2501,175 +2665,371 @@ export enum UDFActions { } /** - * UDF Type + * Defines a set of images related to a specific name * @export - * @enum {string} + * @interface UDFImage */ -export enum UDFLanguage { - Python = 'python' +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; } - /** - * Object including udfs and metadata + * Defines an image that belongs to a set of images having a version * @export - * @interface UDFListingData + * @interface UDFImageVersion */ -export interface UDFListingData { +export interface UDFImageVersion { /** - * Registered UDFs - * @type {Array} - * @memberof UDFListingData + * Unique id of a versioned image + * @type {string} + * @memberof UDFImageVersion */ - udfs?: Array; + id?: string; /** - * - * @type {PaginationMetadata} - * @memberof UDFListingData + * name of UDFImageVersion + * @type {string} + * @memberof UDFImageVersion */ - paginationMetadata?: PaginationMetadata; + name?: string; + /** + * Unique id of the udf image set + * @type {string} + * @memberof UDFImageVersion + */ + udfImageUuid?: string; + /** + * Uri of docker image related to current entry + * @type {string} + * @memberof UDFImageVersion + */ + dockerImage?: 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; } /** - * Subarray bounds to query for a UDF to operate on + * User-defined function that can persist in db, used and shared multiple times * @export - * @interface UDFRanges + * @interface UDFInfo */ -export interface UDFRanges { +export interface UDFInfo { + /** + * Unique id of udf + * @type {string} + * @memberof UDFInfo + */ + id?: string; + /** + * name of udf + * @type {string} + * @memberof UDFInfo + */ + name?: string; /** * - * @type {Layout} - * @memberof UDFRanges + * @type {UDFLanguage} + * @memberof UDFInfo */ - layout?: Layout; + language?: UDFLanguage; /** - * List of ranges, - * @type {Array>} - * @memberof UDFRanges + * + * @type {UDFType} + * @memberof UDFInfo */ - ranges?: Array>; + type?: UDFType; + /** + * Markdown readme of udfs + * @type {string} + * @memberof UDFInfo + */ + readme?: string; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof UDFInfo + */ + licenseId?: string; + /** + * License text + * @type {string} + * @memberof UDFInfo + */ + licenseText?: string; + /** + * optional tags for udf + * @type {Array} + * @memberof UDFInfo + */ + tags?: Array; } /** - * User-defined function + * User-defined function that can persist in db, used and shared multiple times * @export - * @interface UDFRegistration + * @interface UDFInfoUpdate */ -export interface UDFRegistration { +export interface UDFInfoUpdate { /** * name of udf * @type {string} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ name?: string; /** * * @type {UDFLanguage} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ language?: UDFLanguage; /** * Type-specific version * @type {string} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ version?: string; /** * Docker image name to use for udf * @type {string} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ imageName?: string; /** * * @type {UDFType} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ type?: UDFType; /** * Type-specific executable text * @type {string} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ exec?: string; /** * optional raw text to store of serialized function, used for showing in UI * @type {string} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ execRaw?: string; /** * Markdown readme of udfs * @type {string} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ readme?: string; + /** + * License identifier from SPDX License List or Custom + * @type {string} + * @memberof UDFInfoUpdate + */ + licenseId?: string; + /** + * License text + * @type {string} + * @memberof UDFInfoUpdate + */ + licenseText?: string; /** * optional tags for udf * @type {Array} - * @memberof UDFRegistration + * @memberof UDFInfoUpdate */ tags?: Array; } /** - * Results type - * @export - * @enum {string} - */ -export enum UDFResultType { - Native = 'native', - Json = 'json' -} - -/** - * details for sharing a given udf + * Version of User-defined function that can persist in db * @export - * @interface UDFSharing + * @interface UDFInfoVersion */ -export interface UDFSharing { +export interface UDFInfoVersion { /** - * List of permitted actions - * @type {Array} - * @memberof UDFSharing + * Unique id of a versioned udf + * @type {string} + * @memberof UDFInfoVersion */ - actions?: Array; + id?: string; /** - * namespace being granted array access can be a user or organization + * Unique id of the versioned image used by current udf version * @type {string} - * @memberof UDFSharing + * @memberof UDFInfoVersion */ - namespace?: string; + udfImageUuid?: string; /** - * details on if the namespace is a organization or user + * name of udf version * @type {string} - * @memberof UDFSharing + * @memberof UDFInfoVersion */ - namespaceType?: string; -} -/** - * Subarray bounds to query for a UDF to operate on - * @export - * @interface UDFSubarray - */ -export interface UDFSubarray { + name?: string; /** - * - * @type {Layout} - * @memberof UDFSubarray + * Type-specific version + * @type {string} + * @memberof UDFInfoVersion */ - layout?: Layout; + version?: string; /** - * List of ranges, - * @type {Array} - * @memberof UDFSubarray + * Docker image name to use for udf + * @type {string} + * @memberof UDFInfoVersion */ - ranges?: Array; -} -/** - * A dimension range to query - * @export - * @interface UDFSubarrayRange - */ -export interface UDFSubarrayRange { + imageName?: string; /** - * The dimension index + * Type-specific executable text + * @type {string} + * @memberof UDFInfoVersion + */ + exec?: string; + /** + * optional raw text to store of serialized function, used for showing in UI + * @type {string} + * @memberof UDFInfoVersion + */ + execRaw?: string; + /** + * If current image version is default version + * @type {boolean} + * @memberof UDFInfoVersion + */ + _default?: boolean; +} +/** + * UDF Type + * @export + * @enum {string} + */ +export enum UDFLanguage { + Python = 'python' +} + +/** + * Object including udfs and metadata + * @export + * @interface UDFListingData + */ +export interface UDFListingData { + /** + * List of UDFInfo + * @type {Array} + * @memberof UDFListingData + */ + udfInfoList?: Array; + /** + * + * @type {PaginationMetadata} + * @memberof UDFListingData + */ + paginationMetadata?: PaginationMetadata; +} +/** + * Subarray bounds to query for a UDF to operate on + * @export + * @interface UDFRanges + */ +export interface UDFRanges { + /** + * + * @type {Layout} + * @memberof UDFRanges + */ + layout?: Layout; + /** + * List of ranges, + * @type {Array>} + * @memberof UDFRanges + */ + ranges?: Array>; +} +/** + * Results type + * @export + * @enum {string} + */ +export enum UDFResultType { + Native = 'native', + Json = 'json' +} + +/** + * 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 + */ + namespaceType?: 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 */ @@ -2739,6 +3099,18 @@ export interface User { * @memberof User */ isValidEmail?: boolean; + /** + * Denotes that the user is able to apply pricing to arrays by means of Stripe Connect + * @type {boolean} + * @memberof User + */ + stripeConnect?: boolean; + /** + * the user\'s company + * @type {string} + * @memberof User + */ + company?: string; /** * the user\'s logo * @type {string} @@ -2775,6 +3147,18 @@ export interface User { * @memberof User */ enabledFeatures?: Array; + /** + * A notice that the user has an unpaid subscription + * @type {boolean} + * @memberof User + */ + unpaidSubscription?: boolean; + /** + * + * @type {NotebookSettings} + * @memberof User + */ + notebookSettings?: NotebookSettings; } /** * @@ -2896,11 +3280,12 @@ export const ArrayApiAxiosParamCreator = function (configuration?: Configuration * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options: any = {}): RequestArgs { + arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options: any = {}): RequestArgs { const localVarPath = `/arrays/browser/owned`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; @@ -2949,8 +3334,12 @@ export const ArrayApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['permissions'] = permissions; } - if (tag !== undefined) { - localVarQueryParameter['tag'] = tag; + if (tag) { + localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); + } + + if (excludeTag) { + localVarQueryParameter['exclude_tag'] = excludeTag.join(COLLECTION_FORMATS.csv); } @@ -3015,11 +3404,12 @@ export const ArrayApiAxiosParamCreator = function (configuration?: Configuration * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options: any = {}): RequestArgs { + arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options: any = {}): RequestArgs { const localVarPath = `/arrays/browser/public`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; @@ -3068,8 +3458,12 @@ export const ArrayApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['permissions'] = permissions; } - if (tag !== undefined) { - localVarQueryParameter['tag'] = tag; + if (tag) { + localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); + } + + if (excludeTag) { + localVarQueryParameter['exclude_tag'] = excludeTag.join(COLLECTION_FORMATS.csv); } @@ -3134,11 +3528,12 @@ export const ArrayApiAxiosParamCreator = function (configuration?: Configuration * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options: any = {}): RequestArgs { + arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options: any = {}): RequestArgs { const localVarPath = `/arrays/browser/shared`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; @@ -3187,8 +3582,12 @@ export const ArrayApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['permissions'] = permissions; } - if (tag !== undefined) { - localVarQueryParameter['tag'] = tag; + if (tag) { + localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); + } + + if (excludeTag) { + localVarQueryParameter['exclude_tag'] = excludeTag.join(COLLECTION_FORMATS.csv); } @@ -4229,12 +4628,13 @@ export const ArrayApiFp = function(configuration?: Configuration) { * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = ArrayApiAxiosParamCreator(configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, options); + arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = ArrayApiAxiosParamCreator(configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -4260,12 +4660,13 @@ export const ArrayApiFp = function(configuration?: Configuration) { * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = ArrayApiAxiosParamCreator(configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, options); + arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = ArrayApiAxiosParamCreator(configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -4291,12 +4692,13 @@ export const ArrayApiFp = function(configuration?: Configuration) { * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = ArrayApiAxiosParamCreator(configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, options); + arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = ArrayApiAxiosParamCreator(configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -4579,12 +4981,13 @@ export const ArrayApiFactory = function (configuration?: Configuration, basePath * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any): AxiosPromise { - return ArrayApiFp(configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, options)(axios, basePath); + arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any): AxiosPromise { + return ArrayApiFp(configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options)(axios, basePath); }, /** * Fetch a sidebar for arrays that are owned directly by user or user\'s organizations @@ -4602,12 +5005,13 @@ export const ArrayApiFactory = function (configuration?: Configuration, basePath * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any): AxiosPromise { - return ArrayApiFp(configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, options)(axios, basePath); + arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any): AxiosPromise { + return ArrayApiFp(configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options)(axios, basePath); }, /** * Fetch a sidebar of all arrays that have been shared publically @@ -4625,12 +5029,13 @@ export const ArrayApiFactory = function (configuration?: Configuration, basePath * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} */ - arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any): AxiosPromise { - return ArrayApiFp(configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, options)(axios, basePath); + arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any): AxiosPromise { + return ArrayApiFp(configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options)(axios, basePath); }, /** * Fetch a list of all arrays that have been shared with the user @@ -4844,13 +5249,14 @@ export class ArrayApi extends BaseAPI { * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArrayApi */ - public arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, options)(this.axios, this.basePath); + public arraysBrowserOwnedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any) { + return ArrayApiFp(this.configuration).arraysBrowserOwnedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options)(this.axios, this.basePath); } /** @@ -4871,13 +5277,14 @@ export class ArrayApi extends BaseAPI { * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArrayApi */ - public arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, options)(this.axios, this.basePath); + public arraysBrowserPublicGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any) { + return ArrayApiFp(this.configuration).arraysBrowserPublicGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options)(this.axios, this.basePath); } /** @@ -4898,13 +5305,14 @@ export class ArrayApi extends BaseAPI { * @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 {string} [tag] tag to search for, more than one can be included + * @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 {*} [options] Override http request option. * @throws {RequiredError} * @memberof ArrayApi */ - public arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: string, options?: any) { - return ArrayApiFp(this.configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, options)(this.axios, this.basePath); + public arraysBrowserSharedGet(page?: number, perPage?: number, search?: string, namespace?: string, orderby?: string, permissions?: string, tag?: Array, excludeTag?: Array, options?: any) { + return ArrayApiFp(this.configuration).arraysBrowserSharedGet(page, perPage, search, namespace, orderby, permissions, tag, excludeTag, options)(this.axios, this.basePath); } /** @@ -5248,30 +5656,30 @@ export class ArrayTasksApi extends BaseAPI { /** - * InvitationApi - axios parameter creator + * FavoritesApi - axios parameter creator * @export */ -export const InvitationApiAxiosParamCreator = function (configuration?: Configuration) { +export const FavoritesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Accepts invitation - * @param {string} invitation the id of invitation about to be accepted + * Delete specific favorite + * @param {string} id The uuid of the favorite * @param {*} [options] Override http request option. * @throws {RequiredError} */ - acceptInvitation(invitation: string, options: any = {}): RequestArgs { - // verify required parameter 'invitation' is not null or undefined - if (invitation === null || invitation === undefined) { - throw new RequiredError('invitation','Required parameter invitation was null or undefined when calling acceptInvitation.'); + deleteFavoriteId(id: string, options: any = {}): RequestArgs { + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError('id','Required parameter id was null or undefined when calling deleteFavoriteId.'); } - const localVarPath = `/invitations/{invitation}` - .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))); + const localVarPath = `/favorites/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -5302,30 +5710,24 @@ export const InvitationApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Cancels join organization invitation - * @param {string} invitation the id of invitation about to be cancelled - * @param {string} organization name or uuid of organization + * Fetch specific favorite of a user + * @param {string} id The uuid of the favorite * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelJoinOrganization(invitation: string, organization: string, options: any = {}): RequestArgs { - // verify required parameter 'invitation' is not null or undefined - if (invitation === null || invitation === undefined) { - throw new RequiredError('invitation','Required parameter invitation was null or undefined when calling cancelJoinOrganization.'); - } - // verify required parameter 'organization' is not null or undefined - if (organization === null || organization === undefined) { - throw new RequiredError('organization','Required parameter organization was null or undefined when calling cancelJoinOrganization.'); + getFavorite(id: string, options: any = {}): RequestArgs { + // verify required parameter 'id' is not null or undefined + if (id === null || id === undefined) { + throw new RequiredError('id','Required parameter id was null or undefined when calling getFavorite.'); } - const localVarPath = `/invitations/{invitation}/{organization}/join` - .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))) - .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); + const localVarPath = `/favorites/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -5356,36 +5758,19 @@ export const InvitationApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * 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 + * 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} */ - cancelShareArrayByInvite(namespace: string, invitation: string, array: string, options: any = {}): RequestArgs { - // verify required parameter 'namespace' is not null or undefined - if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling cancelShareArrayByInvite.'); - } - // verify required parameter 'invitation' is not null or undefined - if (invitation === null || invitation === undefined) { - throw new RequiredError('invitation','Required parameter invitation was null or undefined when calling cancelShareArrayByInvite.'); - } - // verify required parameter 'array' is not null or undefined - if (array === null || array === undefined) { - throw new RequiredError('array','Required parameter array was null or undefined when calling cancelShareArrayByInvite.'); - } - const localVarPath = `/invitations/{invitation}/{namespace}/{array}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))) - .replace(`{${"array"}}`, encodeURIComponent(String(array))); + getFavorites(type?: string, options: any = {}): RequestArgs { + const localVarPath = `/favorites`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -5403,6 +5788,10 @@ export const InvitationApiAxiosParamCreator = function (configuration?: Configur localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; } + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; @@ -5416,27 +5805,19 @@ export const InvitationApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * 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 + * Add a new favorite + * @param {FavoriteUpdate} [body] * @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 = {}): RequestArgs { - const localVarPath = `/invitations`; + postFavorite(body?: FavoriteUpdate, options: any = {}): RequestArgs { + const localVarPath = `/favorites`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -5454,55 +5835,441 @@ export const InvitationApiAxiosParamCreator = function (configuration?: Configur localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; } - 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; - } - + localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 delete localVarUrlObj.search; localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || ""); return { url: globalImportUrl.format(localVarUrlObj), options: localVarRequestOptions, }; }, - /** + } +}; + +/** + * FavoritesApi - functional programming interface + * @export + */ +export const FavoritesApiFp = function(configuration?: 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): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = FavoritesApiAxiosParamCreator(configuration).deleteFavoriteId(id, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * 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): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = FavoritesApiAxiosParamCreator(configuration).getFavorite(id, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * 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): (axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = FavoritesApiAxiosParamCreator(configuration).getFavorites(type, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + /** + * Add a new favorite + * @param {FavoriteUpdate} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postFavorite(body?: FavoriteUpdate, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = FavoritesApiAxiosParamCreator(configuration).postFavorite(body, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, + } +}; + +/** + * FavoritesApi - factory interface + * @export + */ +export const FavoritesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + 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 FavoritesApiFp(configuration).deleteFavoriteId(id, options)(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 FavoritesApiFp(configuration).getFavorite(id, options)(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 FavoritesApiFp(configuration).getFavorites(type, options)(axios, basePath); + }, + /** + * Add a new favorite + * @param {FavoriteUpdate} [body] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postFavorite(body?: FavoriteUpdate, options?: any): AxiosPromise { + return FavoritesApiFp(configuration).postFavorite(body, options)(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)(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)(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)(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)(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(invitation: string, options: any = {}): RequestArgs { + // verify required parameter 'invitation' is not null or undefined + if (invitation === null || invitation === undefined) { + throw new RequiredError('invitation','Required parameter invitation was null or undefined when calling acceptInvitation.'); + } + const localVarPath = `/invitations/{invitation}` + .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + url: globalImportUrl.format(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(invitation: string, organization: string, options: any = {}): RequestArgs { + // verify required parameter 'invitation' is not null or undefined + if (invitation === null || invitation === undefined) { + throw new RequiredError('invitation','Required parameter invitation was null or undefined when calling cancelJoinOrganization.'); + } + // verify required parameter 'organization' is not null or undefined + if (organization === null || organization === undefined) { + throw new RequiredError('organization','Required parameter organization was null or undefined when calling cancelJoinOrganization.'); + } + const localVarPath = `/invitations/{invitation}/{organization}/join` + .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))) + .replace(`{${"organization"}}`, encodeURIComponent(String(organization))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + url: globalImportUrl.format(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(namespace: string, invitation: string, array: string, options: any = {}): RequestArgs { + // verify required parameter 'namespace' is not null or undefined + if (namespace === null || namespace === undefined) { + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling cancelShareArrayByInvite.'); + } + // verify required parameter 'invitation' is not null or undefined + if (invitation === null || invitation === undefined) { + throw new RequiredError('invitation','Required parameter invitation was null or undefined when calling cancelShareArrayByInvite.'); + } + // verify required parameter 'array' is not null or undefined + if (array === null || array === undefined) { + throw new RequiredError('array','Required parameter array was null or undefined when calling cancelShareArrayByInvite.'); + } + const localVarPath = `/invitations/{invitation}/{namespace}/{array}/share` + .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) + .replace(`{${"invitation"}}`, encodeURIComponent(String(invitation))) + .replace(`{${"array"}}`, encodeURIComponent(String(array))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + url: globalImportUrl.format(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(organization?: string, array?: string, start?: number, end?: number, page?: number, perPage?: number, type?: string, status?: string, orderby?: string, options: any = {}): RequestArgs { + const localVarPath = `/invitations`; + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + 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; + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + url: globalImportUrl.format(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 @@ -5990,6 +6757,69 @@ export const NotebookApiAxiosParamCreator = function (configuration?: Configurat delete localVarUrlObj.search; localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + return { + url: globalImportUrl.format(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(namespace: string, array: string, notebookMetadata: ArrayInfoUpdate, options: any = {}): RequestArgs { + // verify required parameter 'namespace' is not null or undefined + if (namespace === null || namespace === undefined) { + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling updateNotebookName.'); + } + // verify required parameter 'array' is not null or undefined + if (array === null || array === undefined) { + throw new RequiredError('array','Required parameter array was null or undefined when calling updateNotebookName.'); + } + // verify required parameter 'notebookMetadata' is not null or undefined + if (notebookMetadata === null || notebookMetadata === undefined) { + throw new RequiredError('notebookMetadata','Required parameter notebookMetadata was null or undefined when calling updateNotebookName.'); + } + const localVarPath = `/notebooks/{namespace}/{array}/rename` + .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) + .replace(`{${"array"}}`, encodeURIComponent(String(array))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + const needsSerialization = (typeof notebookMetadata !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(notebookMetadata !== undefined ? notebookMetadata : {}) : (notebookMetadata || ""); + return { url: globalImportUrl.format(localVarUrlObj), options: localVarRequestOptions, @@ -6030,6 +6860,21 @@ export const NotebookApiFp = function(configuration?: Configuration) { return axios.request(axiosRequestArgs); }; }, + /** + * 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): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = NotebookApiAxiosParamCreator(configuration).updateNotebookName(namespace, array, notebookMetadata, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, } }; @@ -6057,6 +6902,17 @@ export const NotebookApiFactory = function (configuration?: Configuration, baseP shutdownNotebookServer(namespace: string, options?: any): AxiosPromise { return NotebookApiFp(configuration).shutdownNotebookServer(namespace, options)(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 NotebookApiFp(configuration).updateNotebookName(namespace, array, notebookMetadata, options)(axios, basePath); + }, }; }; @@ -6089,6 +6945,19 @@ export class NotebookApi extends BaseAPI { return NotebookApiFp(this.configuration).shutdownNotebookServer(namespace, options)(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)(this.axios, this.basePath); + } + } @@ -7483,25 +8352,184 @@ export const QueryApiAxiosParamCreator = function (configuration?: Configuration getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options: any = {}): RequestArgs { // verify required parameter 'namespace' is not null or undefined if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getEstResultSizes.'); + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getEstResultSizes.'); + } + // verify required parameter 'array' is not null or undefined + if (array === null || array === undefined) { + throw new RequiredError('array','Required parameter array was null or undefined when calling getEstResultSizes.'); + } + // verify required parameter 'type' is not null or undefined + if (type === null || type === undefined) { + throw new RequiredError('type','Required parameter type was null or undefined when calling getEstResultSizes.'); + } + // verify required parameter 'contentType' is not null or undefined + if (contentType === null || contentType === undefined) { + throw new RequiredError('contentType','Required parameter contentType was null or undefined when calling getEstResultSizes.'); + } + // verify required parameter 'query' is not null or undefined + if (query === null || query === undefined) { + throw new RequiredError('query','Required parameter query was null or undefined when calling getEstResultSizes.'); + } + const localVarPath = `/arrays/{namespace}/{array}/query/est_result_sizes` + .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) + .replace(`{${"array"}}`, encodeURIComponent(String(array))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + 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'; + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + const needsSerialization = (typeof query !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(query !== undefined ? query : {}) : (query || ""); + + return { + url: globalImportUrl.format(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(namespace: string, array: string, contentType: string, xPayer?: string, options: any = {}): RequestArgs { + // verify required parameter 'namespace' is not null or undefined + if (namespace === null || namespace === undefined) { + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getFile.'); + } + // verify required parameter 'array' is not null or undefined + if (array === null || array === undefined) { + throw new RequiredError('array','Required parameter array was null or undefined when calling getFile.'); + } + // verify required parameter 'contentType' is not null or undefined + if (contentType === null || contentType === undefined) { + throw new RequiredError('contentType','Required parameter contentType was null or undefined when calling getFile.'); + } + const localVarPath = `/arrays/{namespace}/{array}/query/get_file` + .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) + .replace(`{${"array"}}`, encodeURIComponent(String(array))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; + } + + if (contentType !== undefined && contentType !== null) { + localVarHeaderParameter['Content-Type'] = String(contentType); + } + + if (xPayer !== undefined && xPayer !== null) { + localVarHeaderParameter['X-Payer'] = String(xPayer); + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + url: globalImportUrl.format(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(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options: any = {}): RequestArgs { + // verify required parameter 'namespace' is not null or undefined + if (namespace === null || namespace === undefined) { + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling submitQuery.'); } // verify required parameter 'array' is not null or undefined if (array === null || array === undefined) { - throw new RequiredError('array','Required parameter array was null or undefined when calling getEstResultSizes.'); + throw new RequiredError('array','Required parameter array was null or undefined when calling submitQuery.'); } // verify required parameter 'type' is not null or undefined if (type === null || type === undefined) { - throw new RequiredError('type','Required parameter type was null or undefined when calling getEstResultSizes.'); + throw new RequiredError('type','Required parameter type was null or undefined when calling submitQuery.'); } // verify required parameter 'contentType' is not null or undefined if (contentType === null || contentType === undefined) { - throw new RequiredError('contentType','Required parameter contentType was null or undefined when calling getEstResultSizes.'); + throw new RequiredError('contentType','Required parameter contentType was null or undefined when calling submitQuery.'); } // verify required parameter 'query' is not null or undefined if (query === null || query === undefined) { - throw new RequiredError('query','Required parameter query was null or undefined when calling getEstResultSizes.'); + throw new RequiredError('query','Required parameter query was null or undefined when calling submitQuery.'); } - const localVarPath = `/arrays/{namespace}/{array}/query/est_result_sizes` + const localVarPath = `/arrays/{namespace}/{array}/query/submit` .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) .replace(`{${"array"}}`, encodeURIComponent(String(array))); const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -7560,39 +8588,33 @@ export const QueryApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * send a query to run against a specified array/URI registered to a group/project + * 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} type type of query * @param {string} contentType Content Type of input and return mime - * @param {Query} query query to run + * @param {QueryJson} queryJson 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 = {}): RequestArgs { + submitQueryJson(namespace: string, array: string, contentType: string, queryJson: QueryJson, xPayer?: string, options: any = {}): RequestArgs { // verify required parameter 'namespace' is not null or undefined if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling submitQuery.'); + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling submitQueryJson.'); } // verify required parameter 'array' is not null or undefined if (array === null || array === undefined) { - throw new RequiredError('array','Required parameter array was null or undefined when calling submitQuery.'); - } - // verify required parameter 'type' is not null or undefined - if (type === null || type === undefined) { - throw new RequiredError('type','Required parameter type was null or undefined when calling submitQuery.'); + throw new RequiredError('array','Required parameter array was null or undefined when calling submitQueryJson.'); } // verify required parameter 'contentType' is not null or undefined if (contentType === null || contentType === undefined) { - throw new RequiredError('contentType','Required parameter contentType was null or undefined when calling submitQuery.'); + throw new RequiredError('contentType','Required parameter contentType was null or undefined when calling submitQueryJson.'); } - // verify required parameter 'query' is not null or undefined - if (query === null || query === undefined) { - throw new RequiredError('query','Required parameter query was null or undefined when calling submitQuery.'); + // verify required parameter 'queryJson' is not null or undefined + if (queryJson === null || queryJson === undefined) { + throw new RequiredError('queryJson','Required parameter queryJson was null or undefined when calling submitQueryJson.'); } - const localVarPath = `/arrays/{namespace}/{array}/query/submit` + const localVarPath = `/arrays/{namespace}/{array}/query/submit_query_json` .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) .replace(`{${"array"}}`, encodeURIComponent(String(array))); const localVarUrlObj = globalImportUrl.parse(localVarPath, true); @@ -7618,14 +8640,6 @@ export const QueryApiAxiosParamCreator = function (configuration?: Configuration localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; } - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (openAt !== undefined) { - localVarQueryParameter['open_at'] = openAt; - } - if (contentType !== undefined && contentType !== null) { localVarHeaderParameter['Content-Type'] = String(contentType); } @@ -7642,8 +8656,8 @@ export const QueryApiAxiosParamCreator = function (configuration?: Configuration // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 delete localVarUrlObj.search; localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - const needsSerialization = (typeof query !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(query !== undefined ? query : {}) : (query || ""); + const needsSerialization = (typeof queryJson !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; + localVarRequestOptions.data = needsSerialization ? JSON.stringify(queryJson !== undefined ? queryJson : {}) : (queryJson || ""); return { url: globalImportUrl.format(localVarUrlObj), @@ -7697,6 +8711,22 @@ export const QueryApiFp = function(configuration?: Configuration) { return axios.request(axiosRequestArgs); }; }, + /** + * 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): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = QueryApiAxiosParamCreator(configuration).getFile(namespace, array, contentType, xPayer, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, /** * 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) @@ -7716,6 +8746,23 @@ export const QueryApiFp = function(configuration?: Configuration) { return axios.request(axiosRequestArgs); }; }, + /** + * 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): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = QueryApiAxiosParamCreator(configuration).submitQueryJson(namespace, array, contentType, queryJson, xPayer, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, } }; @@ -7755,6 +8802,18 @@ export const QueryApiFactory = function (configuration?: Configuration, basePath getEstResultSizes(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise { return QueryApiFp(configuration).getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt, options)(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 QueryApiFp(configuration).getFile(namespace, array, contentType, xPayer, options)(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) @@ -7770,6 +8829,19 @@ export const QueryApiFactory = function (configuration?: Configuration, basePath submitQuery(namespace: string, array: string, type: string, contentType: string, query: Query, xPayer?: string, openAt?: number, options?: any): AxiosPromise { return QueryApiFp(configuration).submitQuery(namespace, array, type, contentType, query, xPayer, openAt, options)(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 QueryApiFp(configuration).submitQueryJson(namespace, array, contentType, queryJson, xPayer, options)(axios, basePath); + }, }; }; @@ -7814,6 +8886,20 @@ export class QueryApi extends BaseAPI { return QueryApiFp(this.configuration).getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt, options)(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)(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) @@ -7831,6 +8917,21 @@ export class QueryApi extends BaseAPI { return QueryApiFp(this.configuration).submitQuery(namespace, array, type, contentType, query, xPayer, openAt, options)(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)(this.axios, this.basePath); + } + } @@ -8473,14 +9574,14 @@ export const UdfApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUDF(namespace: string, name: string, options: any = {}): RequestArgs { + getUDFInfo(namespace: string, name: string, options: any = {}): RequestArgs { // verify required parameter 'namespace' is not null or undefined if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getUDF.'); + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getUDFInfo.'); } // verify required parameter 'name' is not null or undefined if (name === null || name === undefined) { - throw new RequiredError('name','Required parameter name was null or undefined when calling getUDF.'); + throw new RequiredError('name','Required parameter name was null or undefined when calling getUDFInfo.'); } const localVarPath = `/udf/{namespace}/{name}` .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) @@ -8510,60 +9611,6 @@ export const UdfApiAxiosParamCreator = function (configuration?: Configuration) - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; - - return { - url: globalImportUrl.format(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 registered ud - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUDFSharingPolicies(namespace: string, name: string, options: any = {}): RequestArgs { - // verify required parameter 'namespace' is not null or undefined - if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getUDFSharingPolicies.'); - } - // verify required parameter 'name' is not null or undefined - if (name === null || name === undefined) { - throw new RequiredError('name','Required parameter name was null or undefined when calling getUDFSharingPolicies.'); - } - const localVarPath = `/udf/{namespace}/{name}/share` - .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) - .replace(`{${"name"}}`, encodeURIComponent(String(name))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication ApiKeyAuth required - if (configuration && configuration.apiKey) { - const localVarApiKeyValue = typeof configuration.apiKey === 'function' - ? configuration.apiKey("X-TILEDB-REST-API-KEY") - : configuration.apiKey; - localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; - } - - // authentication BasicAuth required - // http basic authentication required - if (configuration && (configuration.username || configuration.password)) { - localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; - } - - - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 delete localVarUrlObj.search; @@ -8583,11 +9630,11 @@ export const UdfApiAxiosParamCreator = function (configuration?: Configuration) * @param {string} [type] udf type, \"generic\", \"single_array\" * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include created_at, last_used, name - * @param {string} [tag] tag to search for, more than one can be included + * @param {Array} [tag] tag to search for, more than one can be included * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUDFs(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: string, options: any = {}): RequestArgs { + getUDFInfoList(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: Array, options: any = {}): RequestArgs { const localVarPath = `/udfs`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; @@ -8640,8 +9687,62 @@ export const UdfApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['orderby'] = orderby; } - if (tag !== undefined) { - localVarQueryParameter['tag'] = tag; + if (tag) { + localVarQueryParameter['tag'] = tag.join(COLLECTION_FORMATS.csv); + } + + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + url: globalImportUrl.format(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(namespace: string, name: string, options: any = {}): RequestArgs { + // verify required parameter 'namespace' is not null or undefined + if (namespace === null || namespace === undefined) { + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling getUDFInfoSharingPolicies.'); + } + // verify required parameter 'name' is not null or undefined + if (name === null || name === undefined) { + throw new RequiredError('name','Required parameter name was null or undefined when calling getUDFInfoSharingPolicies.'); + } + const localVarPath = `/udf/{namespace}/{name}/share` + .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) + .replace(`{${"name"}}`, encodeURIComponent(String(name))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("X-TILEDB-REST-API-KEY") + : configuration.apiKey; + localVarHeaderParameter["X-TILEDB-REST-API-KEY"] = localVarApiKeyValue; + } + + // authentication BasicAuth required + // http basic authentication required + if (configuration && (configuration.username || configuration.password)) { + localVarRequestOptions["auth"] = { username: configuration.username, password: configuration.password }; } @@ -8660,22 +9761,22 @@ export const UdfApiAxiosParamCreator = function (configuration?: 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 {UDFRegistration} udf udf to register + * @param {UDFInfoUpdate} udf udf to register * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerUDF(namespace: string, name: string, udf: UDFRegistration, options: any = {}): RequestArgs { + registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options: any = {}): RequestArgs { // verify required parameter 'namespace' is not null or undefined if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling registerUDF.'); + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling registerUDFInfo.'); } // verify required parameter 'name' is not null or undefined if (name === null || name === undefined) { - throw new RequiredError('name','Required parameter name was null or undefined when calling registerUDF.'); + throw new RequiredError('name','Required parameter name was null or undefined when calling registerUDFInfo.'); } // verify required parameter 'udf' is not null or undefined if (udf === null || udf === undefined) { - throw new RequiredError('udf','Required parameter udf was null or undefined when calling registerUDF.'); + throw new RequiredError('udf','Required parameter udf was null or undefined when calling registerUDFInfo.'); } const localVarPath = `/udf/{namespace}/{name}` .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) @@ -8722,23 +9823,23 @@ export const UdfApiAxiosParamCreator = function (configuration?: 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 registered ud + * @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} */ - shareUDF(namespace: string, name: string, udfSharing: UDFSharing, options: any = {}): RequestArgs { + shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options: any = {}): RequestArgs { // verify required parameter 'namespace' is not null or undefined if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling shareUDF.'); + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling shareUDFInfo.'); } // verify required parameter 'name' is not null or undefined if (name === null || name === undefined) { - throw new RequiredError('name','Required parameter name was null or undefined when calling shareUDF.'); + throw new RequiredError('name','Required parameter name was null or undefined when calling shareUDFInfo.'); } // verify required parameter 'udfSharing' is not null or undefined if (udfSharing === null || udfSharing === undefined) { - throw new RequiredError('udfSharing','Required parameter udfSharing was null or undefined when calling shareUDF.'); + throw new RequiredError('udfSharing','Required parameter udfSharing was null or undefined when calling shareUDFInfo.'); } const localVarPath = `/udf/{namespace}/{name}/share` .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) @@ -8921,22 +10022,22 @@ export const UdfApiAxiosParamCreator = function (configuration?: 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 {UDFRegistration} udf udf to update + * @param {UDFInfoUpdate} udf udf to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updatedRegisteredUDF(namespace: string, name: string, udf: UDFRegistration, options: any = {}): RequestArgs { + updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options: any = {}): RequestArgs { // verify required parameter 'namespace' is not null or undefined if (namespace === null || namespace === undefined) { - throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling updatedRegisteredUDF.'); + throw new RequiredError('namespace','Required parameter namespace was null or undefined when calling updateUDFInfo.'); } // verify required parameter 'name' is not null or undefined if (name === null || name === undefined) { - throw new RequiredError('name','Required parameter name was null or undefined when calling updatedRegisteredUDF.'); + throw new RequiredError('name','Required parameter name was null or undefined when calling updateUDFInfo.'); } // verify required parameter 'udf' is not null or undefined if (udf === null || udf === undefined) { - throw new RequiredError('udf','Required parameter udf was null or undefined when calling updatedRegisteredUDF.'); + throw new RequiredError('udf','Required parameter udf was null or undefined when calling updateUDFInfo.'); } const localVarPath = `/udf/{namespace}/{name}` .replace(`{${"namespace"}}`, encodeURIComponent(String(namespace))) @@ -8996,42 +10097,42 @@ export const UdfApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUDF(namespace: string, name: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).getUDF(namespace, name, options); + getUDFInfo(namespace: string, name: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).getUDFInfo(namespace, name, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, /** - * 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 registered ud + * get a all UDFs accessible to the user + * @param {string} [namespace] namespace to filter + * @param {string} [createdBy] username to filter + * @param {number} [page] pagination offset + * @param {number} [perPage] pagination limit + * @param {string} [type] udf type, \"generic\", \"single_array\" + * @param {string} [search] search string that will look at name, namespace or description fields + * @param {string} [orderby] sort by which field valid values include created_at, last_used, name + * @param {Array} [tag] tag to search for, more than one can be included * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUDFSharingPolicies(namespace: string, name: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).getUDFSharingPolicies(namespace, name, options); + getUDFInfoList(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: Array, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).getUDFInfoList(namespace, createdBy, page, perPage, type, search, orderby, tag, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); }; }, /** - * get a all UDFs accessible to the user - * @param {string} [namespace] namespace to filter - * @param {string} [createdBy] username to filter - * @param {number} [page] pagination offset - * @param {number} [perPage] pagination limit - * @param {string} [type] udf type, \"generic\", \"single_array\" - * @param {string} [search] search string that will look at name, namespace or description fields - * @param {string} [orderby] sort by which field valid values include created_at, last_used, name - * @param {string} [tag] tag to search for, more than one can be included + * 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} */ - getUDFs(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).getUDFs(namespace, createdBy, page, perPage, type, search, orderby, tag, options); + getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).getUDFInfoSharingPolicies(namespace, name, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -9041,12 +10142,12 @@ export const UdfApiFp = function(configuration?: 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 {UDFRegistration} udf udf to register + * @param {UDFInfoUpdate} udf udf to register * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerUDF(namespace: string, name: string, udf: UDFRegistration, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).registerUDF(namespace, name, udf, options); + registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).registerUDFInfo(namespace, name, udf, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -9055,13 +10156,13 @@ export const UdfApiFp = function(configuration?: 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 registered ud + * @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} */ - shareUDF(namespace: string, name: string, udfSharing: UDFSharing, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).shareUDF(namespace, name, udfSharing, options); + shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).shareUDFInfo(namespace, name, udfSharing, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -9103,12 +10204,12 @@ export const UdfApiFp = function(configuration?: 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 {UDFRegistration} udf udf to update + * @param {UDFInfoUpdate} udf udf to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updatedRegisteredUDF(namespace: string, name: string, udf: UDFRegistration, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { - const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).updatedRegisteredUDF(namespace, name, udf, options); + updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = UdfApiAxiosParamCreator(configuration).updateUDFInfo(namespace, name, udf, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; return axios.request(axiosRequestArgs); @@ -9130,18 +10231,8 @@ export const UdfApiFactory = function (configuration?: Configuration, basePath?: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUDF(namespace: string, name: string, options?: any): AxiosPromise { - return UdfApiFp(configuration).getUDF(namespace, name, options)(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 registered ud - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUDFSharingPolicies(namespace: string, name: string, options?: any): AxiosPromise> { - return UdfApiFp(configuration).getUDFSharingPolicies(namespace, name, options)(axios, basePath); + getUDFInfo(namespace: string, name: string, options?: any): AxiosPromise { + return UdfApiFp(configuration).getUDFInfo(namespace, name, options)(axios, basePath); }, /** * get a all UDFs accessible to the user @@ -9152,34 +10243,44 @@ export const UdfApiFactory = function (configuration?: Configuration, basePath?: * @param {string} [type] udf type, \"generic\", \"single_array\" * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include created_at, last_used, name - * @param {string} [tag] tag to search for, more than one can be included + * @param {Array} [tag] tag to search for, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUDFInfoList(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: Array, options?: any): AxiosPromise { + return UdfApiFp(configuration).getUDFInfoList(namespace, createdBy, page, perPage, type, search, orderby, tag, options)(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} */ - getUDFs(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: string, options?: any): AxiosPromise { - return UdfApiFp(configuration).getUDFs(namespace, createdBy, page, perPage, type, search, orderby, tag, options)(axios, basePath); + getUDFInfoSharingPolicies(namespace: string, name: string, options?: any): AxiosPromise> { + return UdfApiFp(configuration).getUDFInfoSharingPolicies(namespace, name, options)(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 {UDFRegistration} udf udf to register + * @param {UDFInfoUpdate} udf udf to register * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerUDF(namespace: string, name: string, udf: UDFRegistration, options?: any): AxiosPromise { - return UdfApiFp(configuration).registerUDF(namespace, name, udf, options)(axios, basePath); + registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): AxiosPromise { + return UdfApiFp(configuration).registerUDFInfo(namespace, name, udf, options)(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 registered ud + * @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} */ - shareUDF(namespace: string, name: string, udfSharing: UDFSharing, options?: any): AxiosPromise { - return UdfApiFp(configuration).shareUDF(namespace, name, udfSharing, options)(axios, basePath); + shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any): AxiosPromise { + return UdfApiFp(configuration).shareUDFInfo(namespace, name, udfSharing, options)(axios, basePath); }, /** * submit a generic UDF in the given namespace @@ -9209,12 +10310,12 @@ export const UdfApiFactory = function (configuration?: Configuration, 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 {UDFRegistration} udf udf to update + * @param {UDFInfoUpdate} udf udf to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updatedRegisteredUDF(namespace: string, name: string, udf: UDFRegistration, options?: any): AxiosPromise { - return UdfApiFp(configuration).updatedRegisteredUDF(namespace, name, udf, options)(axios, basePath); + updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any): AxiosPromise { + return UdfApiFp(configuration).updateUDFInfo(namespace, name, udf, options)(axios, basePath); }, }; }; @@ -9234,20 +10335,8 @@ export class UdfApi extends BaseAPI { * @throws {RequiredError} * @memberof UdfApi */ - public getUDF(namespace: string, name: string, options?: any) { - return UdfApiFp(this.configuration).getUDF(namespace, name, options)(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 registered ud - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof UdfApi - */ - public getUDFSharingPolicies(namespace: string, name: string, options?: any) { - return UdfApiFp(this.configuration).getUDFSharingPolicies(namespace, name, options)(this.axios, this.basePath); + public getUDFInfo(namespace: string, name: string, options?: any) { + return UdfApiFp(this.configuration).getUDFInfo(namespace, name, options)(this.axios, this.basePath); } /** @@ -9259,39 +10348,51 @@ export class UdfApi extends BaseAPI { * @param {string} [type] udf type, \"generic\", \"single_array\" * @param {string} [search] search string that will look at name, namespace or description fields * @param {string} [orderby] sort by which field valid values include created_at, last_used, name - * @param {string} [tag] tag to search for, more than one can be included + * @param {Array} [tag] tag to search for, more than one can be included + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof UdfApi + */ + public getUDFInfoList(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: Array, options?: any) { + return UdfApiFp(this.configuration).getUDFInfoList(namespace, createdBy, page, perPage, type, search, orderby, tag, options)(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 getUDFs(namespace?: string, createdBy?: string, page?: number, perPage?: number, type?: string, search?: string, orderby?: string, tag?: string, options?: any) { - return UdfApiFp(this.configuration).getUDFs(namespace, createdBy, page, perPage, type, search, orderby, tag, options)(this.axios, this.basePath); + public getUDFInfoSharingPolicies(namespace: string, name: string, options?: any) { + return UdfApiFp(this.configuration).getUDFInfoSharingPolicies(namespace, name, options)(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 {UDFRegistration} udf udf to register + * @param {UDFInfoUpdate} udf udf to register * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UdfApi */ - public registerUDF(namespace: string, name: string, udf: UDFRegistration, options?: any) { - return UdfApiFp(this.configuration).registerUDF(namespace, name, udf, options)(this.axios, this.basePath); + public registerUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any) { + return UdfApiFp(this.configuration).registerUDFInfo(namespace, name, udf, options)(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 registered ud + * @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 shareUDF(namespace: string, name: string, udfSharing: UDFSharing, options?: any) { - return UdfApiFp(this.configuration).shareUDF(namespace, name, udfSharing, options)(this.axios, this.basePath); + public shareUDFInfo(namespace: string, name: string, udfSharing: UDFSharing, options?: any) { + return UdfApiFp(this.configuration).shareUDFInfo(namespace, name, udfSharing, options)(this.axios, this.basePath); } /** @@ -9326,13 +10427,13 @@ export class UdfApi extends BaseAPI { * 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 {UDFRegistration} udf udf to update + * @param {UDFInfoUpdate} udf udf to update * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UdfApi */ - public updatedRegisteredUDF(namespace: string, name: string, udf: UDFRegistration, options?: any) { - return UdfApiFp(this.configuration).updatedRegisteredUDF(namespace, name, udf, options)(this.axios, this.basePath); + public updateUDFInfo(namespace: string, name: string, udf: UDFInfoUpdate, options?: any) { + return UdfApiFp(this.configuration).updateUDFInfo(namespace, name, udf, options)(this.axios, this.basePath); } } diff --git a/src/base.ts b/src/base.ts index 012c379..15bce47 100644 --- a/src/base.ts +++ b/src/base.ts @@ -3,7 +3,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.0.2 + * The version of the OpenAPI document: 2.0.13 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/configuration.ts b/src/configuration.ts index 41e8d4b..1ff4a8b 100644 --- a/src/configuration.ts +++ b/src/configuration.ts @@ -3,7 +3,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.0.2 + * The version of the OpenAPI document: 2.0.13 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/index.ts b/src/index.ts index ac25727..6c78442 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3,7 +3,7 @@ * TileDB Storage Platform API * TileDB Storage Platform REST API * - * The version of the OpenAPI document: 2.0.2 + * The version of the OpenAPI document: 2.0.13 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/package-lock.json b/src/package-lock.json index 8ea627d..39fb012 100644 --- a/src/package-lock.json +++ b/src/package-lock.json @@ -1,13 +1,13 @@ { "name": "@tiledb-inc/tiledb-cloud", - "version": "2.0.2", + "version": "2.0.13", "lockfileVersion": 1, "requires": true, "dependencies": { "@types/node": { - "version": "12.12.42", - "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.42.tgz", - "integrity": "sha512-R/9QdYFLL9dE9l5cWWzWIZByVGFd7lk7JVOJ7KD+E1SJ4gni7XJRLz9QTjyYQiHIqEAgku9VgxdLjMlhhUaAFg==", + "version": "12.12.62", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.62.tgz", + "integrity": "sha512-qAfo81CsD7yQIM9mVyh6B/U47li5g7cfpVQEDMfQeF8pSZVwzbhwU3crc0qG4DmpsebpJPR49AKOExQyJ05Cpg==", "dev": true }, "axios": { @@ -46,9 +46,9 @@ "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" }, "typescript": { - "version": "3.9.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.3.tgz", - "integrity": "sha512-D/wqnB2xzNFIcoBG9FG8cXRDjiqSTbG2wd8DMZeQyJlP1vfTkIxH4GKveWaEBYySKIg+USu+E+EDIR47SqnaMQ==", + "version": "3.9.7", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.7.tgz", + "integrity": "sha512-BLbiRkiBzAwsjut4x/dsibSTB6yWpwT5qWmC2OfuCg3GgVQCSgMs4vEctYPhsaGtd0AeuuHMkjZ2h2WG8MSzRw==", "dev": true } } diff --git a/src/package.json b/src/package.json index cbade45..941f554 100644 --- a/src/package.json +++ b/src/package.json @@ -1,6 +1,6 @@ { "name": "@tiledb-inc/tiledb-cloud", - "version": "2.0.2", + "version": "2.0.13", "description": "OpenAPI client for @tiledb-inc/tiledb-cloud", "author": "OpenAPI-Generator Contributors", "keywords": [ From cec89a66cbf927befe92de3b34421046582c01ff Mon Sep 17 00:00:00 2001 From: Alex Diktampanidis Date: Fri, 2 Oct 2020 18:19:37 +0300 Subject: [PATCH 2/2] Removes auto-generated README --- src/README.md | 45 --------------------------------------------- update_generated.sh | 4 ++-- 2 files changed, 2 insertions(+), 47 deletions(-) delete mode 100644 src/README.md diff --git a/src/README.md b/src/README.md deleted file mode 100644 index b429d84..0000000 --- a/src/README.md +++ /dev/null @@ -1,45 +0,0 @@ -## @tiledb-inc/tiledb-cloud@2.0.13 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run ```npm publish``` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install @tiledb-inc/tiledb-cloud@2.0.13 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save diff --git a/update_generated.sh b/update_generated.sh index f66c54a..664eb21 100644 --- a/update_generated.sh +++ b/update_generated.sh @@ -59,8 +59,8 @@ docker run --rm \ node:12.6.0 /bin/bash -c "cd /js && npm install && npm run build" # Copy src to working our directory -cp -r ${OUTPUT_PATH}/ ${TARGET_PATH}/src -cp -r ${OUTPUT_PATH}/dist ${TARGET_PATH}/lib +rsync -av ${OUTPUT_PATH}/ ${TARGET_PATH}/src --exclude=README.md +rsync -av ${OUTPUT_PATH}/dist ${TARGET_PATH}/lib echo echo "Output copied from '${OUTPUT_PATH}' to '${TARGET_PATH}'"