diff --git a/.eslintrc.js b/.eslintrc.js index 879fb22ece..dd2aaa6d1b 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -48,11 +48,6 @@ module.exports = { group: 'internal', position: 'after', }, - { - pattern: 'apiSrc/**', - group: 'internal', - position: 'after', - }, ], warnOnUnassignedImports: true, pathGroupsExcludedImportTypes: ['builtin'], diff --git a/jest.config.cjs b/jest.config.cjs index 44a71be626..e78c86f22a 100644 --- a/jest.config.cjs +++ b/jest.config.cjs @@ -54,6 +54,7 @@ module.exports = { '/node_modules/', '/redisinsight/api', '/redisinsight/ui/src/packages', + '/redisinsight/ui/src/api-client', ], resolver: '/jest-resolver.js', reporters: [ diff --git a/redisinsight/api/openapitools.json b/redisinsight/api/openapitools.json new file mode 100644 index 0000000000..a82623d645 --- /dev/null +++ b/redisinsight/api/openapitools.json @@ -0,0 +1,7 @@ +{ + "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", + "spaces": 2, + "generator-cli": { + "version": "7.14.0" + } +} diff --git a/redisinsight/api/package.json b/redisinsight/api/package.json index e091612c9a..8a9f8fec5c 100644 --- a/redisinsight/api/package.json +++ b/redisinsight/api/package.json @@ -21,6 +21,7 @@ "format": "prettier --write \"src/**/*.ts\"", "minify:prod": "node ./esbuild.js --production", "minify:dev": "node ./esbuild.js --watch", + "generate-client": "openapi-generator-cli generate -i http://localhost:5540/api/docs-json -g typescript-axios -o ../ui/src/api-client", "lint": "eslint --ext .ts .", "start": "nest start", "start:dev": "cross-env NODE_ENV=development nest start --watch", @@ -106,6 +107,7 @@ "@nestjs/cli": "^11.0.6", "@nestjs/schematics": "^11.0.5", "@nestjs/testing": "^11.0.20", + "@openapitools/openapi-generator-cli": "^2.21.0", "@types/adm-zip": "^0.5.0", "@types/express": "^5.0.0", "@types/ioredis-mock": "^8", @@ -172,7 +174,6 @@ ], "moduleNameMapper": { "src/(.*)": "/$1", - "apiSrc/(.*)": "/$1", "tests/(.*)": "/__tests__/$1" }, "reporters": [ diff --git a/redisinsight/api/package.tmp.json b/redisinsight/api/package.tmp.json index e8ddb93979..d519b12641 100644 --- a/redisinsight/api/package.tmp.json +++ b/redisinsight/api/package.tmp.json @@ -51,7 +51,6 @@ "testEnvironment": "node", "moduleNameMapper": { "src/(.*)": "/$1", - "apiSrc/(.*)": "/$1", "tests/(.*)": "/__tests__/$1" }, "setupFilesAfterEnv": ["../test/jest.setup.ts"] diff --git a/redisinsight/api/src/common/decorators/index.ts b/redisinsight/api/src/common/decorators/index.ts index 979514f5e4..9d009de008 100644 --- a/redisinsight/api/src/common/decorators/index.ts +++ b/redisinsight/api/src/common/decorators/index.ts @@ -10,3 +10,4 @@ export * from './is-bigger-than.decorator'; export * from './is-github-link.decorator'; export * from './database-management.decorator'; export * from './no-duplicates.decorator'; +export * from './redis-string-schema.decorator'; diff --git a/redisinsight/api/src/common/decorators/redis-string-schema.decorator.ts b/redisinsight/api/src/common/decorators/redis-string-schema.decorator.ts new file mode 100644 index 0000000000..0bc4ac92d8 --- /dev/null +++ b/redisinsight/api/src/common/decorators/redis-string-schema.decorator.ts @@ -0,0 +1,32 @@ +import { ApiProperty } from '@nestjs/swagger'; + +export const REDIS_STRING_SCHEMA = { + type: String, + oneOf: [ + { type: 'string' }, + { + type: 'object', + properties: { + type: { type: 'string', enum: ['Buffer'], example: 'Buffer' }, + data: { + type: 'array', + items: { type: 'number' }, + example: [61, 101, 49], + }, + }, + required: ['type', 'data'], + }, + ], +}; + +export const ApiRedisString = ( + description: string = undefined, + isArray = false, + required = true, +) => + ApiProperty({ + description, + isArray, + required, + ...REDIS_STRING_SCHEMA, + }); diff --git a/redisinsight/api/src/modules/browser/hash/dto/delete.fields-from-hash.dto.ts b/redisinsight/api/src/modules/browser/hash/dto/delete.fields-from-hash.dto.ts index c87fb9c64a..8d6a45f792 100644 --- a/redisinsight/api/src/modules/browser/hash/dto/delete.fields-from-hash.dto.ts +++ b/redisinsight/api/src/modules/browser/hash/dto/delete.fields-from-hash.dto.ts @@ -1,15 +1,14 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; -import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class DeleteFieldsFromHashDto extends KeyDto { - @ApiProperty({ - description: 'Hash fields', - type: String, - isArray: true, - }) + @ApiRedisString('Hash fields', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/hash/dto/hash-field.dto.ts b/redisinsight/api/src/modules/browser/hash/dto/hash-field.dto.ts index 40abb17e9d..e295e64c01 100644 --- a/redisinsight/api/src/modules/browser/hash/dto/hash-field.dto.ts +++ b/redisinsight/api/src/modules/browser/hash/dto/hash-field.dto.ts @@ -1,23 +1,21 @@ -import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; +import { ApiPropertyOptional } from '@nestjs/swagger'; import { IsDefined, IsInt, IsOptional, Max, Min } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { MAX_TTL_NUMBER } from 'src/constants'; export class HashFieldDto { - @ApiProperty({ - description: 'Field', - type: String, - }) + @ApiRedisString('Field') @IsDefined() @IsRedisString() @RedisStringType() field: RedisString; - @ApiProperty({ - description: 'Field', - type: String, - }) + @ApiRedisString('Field') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/hash/hash.controller.ts b/redisinsight/api/src/modules/browser/hash/hash.controller.ts index b57d1e199a..6dfbfe502e 100644 --- a/redisinsight/api/src/modules/browser/hash/hash.controller.ts +++ b/redisinsight/api/src/modules/browser/hash/hash.controller.ts @@ -41,6 +41,9 @@ export class HashController extends BrowserBaseController { @ApiOperation({ description: 'Set key to hold Hash data type' }) @ApiRedisParams() @ApiBody({ type: CreateHashWithExpireDto }) + @ApiOkResponse({ + description: 'Hash key created successfully', + }) @ApiQueryRedisStringEncoding() async createHash( @BrowserClientMetadata() clientMetadata: ClientMetadata, @@ -75,6 +78,9 @@ export class HashController extends BrowserBaseController { }) @ApiRedisParams() @ApiBody({ type: AddFieldsToHashDto }) + @ApiOkResponse({ + description: 'Fields added to hash successfully', + }) @ApiQueryRedisStringEncoding() async addMember( @BrowserClientMetadata() clientMetadata: ClientMetadata, @@ -89,6 +95,9 @@ export class HashController extends BrowserBaseController { }) @ApiRedisParams() @ApiBody({ type: UpdateHashFieldsTtlDto }) + @ApiOkResponse({ + description: 'Hash fields TTL updated successfully', + }) @ApiQueryRedisStringEncoding() async updateTtl( @BrowserClientMetadata() clientMetadata: ClientMetadata, @@ -103,6 +112,10 @@ export class HashController extends BrowserBaseController { }) @ApiRedisParams() @ApiBody({ type: DeleteFieldsFromHashDto }) + @ApiOkResponse({ + description: 'Fields removed from hash', + type: DeleteFieldsFromHashResponse, + }) @ApiQueryRedisStringEncoding() async deleteFields( @BrowserClientMetadata() clientMetadata: ClientMetadata, diff --git a/redisinsight/api/src/modules/browser/keys/dto/delete.keys.dto.ts b/redisinsight/api/src/modules/browser/keys/dto/delete.keys.dto.ts index d5623c1c54..22079d7efa 100644 --- a/redisinsight/api/src/modules/browser/keys/dto/delete.keys.dto.ts +++ b/redisinsight/api/src/modules/browser/keys/dto/delete.keys.dto.ts @@ -1,14 +1,13 @@ -import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class DeleteKeysDto { - @ApiProperty({ - description: 'Key name', - type: String, - isArray: true, - }) + @ApiRedisString('Key name', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts b/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts index affc174c87..0437bf40eb 100644 --- a/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts +++ b/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.dto.ts @@ -1,6 +1,10 @@ -import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; +import { ApiPropertyOptional } from '@nestjs/swagger'; import { IsDefined, IsEnum, IsOptional } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { KeyDto, RedisDataType } from './key.dto'; @@ -16,12 +20,7 @@ export class GetKeyInfoDto extends KeyDto { } export class GetKeysInfoDto { - @ApiProperty({ - description: 'List of keys', - type: String, - isArray: true, - example: ['keys', 'key2'], - }) + @ApiRedisString('List of keys', true) @IsDefined() @IsRedisString({ each: true }) @RedisStringType({ each: true }) diff --git a/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.response.ts b/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.response.ts index 8c97933a58..890fe32968 100644 --- a/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.response.ts +++ b/redisinsight/api/src/modules/browser/keys/dto/get.keys-info.response.ts @@ -1,11 +1,9 @@ import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { RedisStringType, ApiRedisString } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class GetKeyInfoResponse { - @ApiProperty({ - type: String, - }) + @ApiRedisString() @RedisStringType() name: RedisString; diff --git a/redisinsight/api/src/modules/browser/keys/dto/key.dto.ts b/redisinsight/api/src/modules/browser/keys/dto/key.dto.ts index 7b3550c5f0..c0e92c9daa 100644 --- a/redisinsight/api/src/modules/browser/keys/dto/key.dto.ts +++ b/redisinsight/api/src/modules/browser/keys/dto/key.dto.ts @@ -1,6 +1,9 @@ -import { ApiProperty } from '@nestjs/swagger'; import { IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export enum RedisDataType { @@ -16,10 +19,7 @@ export enum RedisDataType { } export class KeyDto { - @ApiProperty({ - description: 'Key Name', - type: String, - }) + @ApiRedisString('Key Name') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/keys/dto/rename.key.dto.ts b/redisinsight/api/src/modules/browser/keys/dto/rename.key.dto.ts index cecf0938b5..69522bf547 100644 --- a/redisinsight/api/src/modules/browser/keys/dto/rename.key.dto.ts +++ b/redisinsight/api/src/modules/browser/keys/dto/rename.key.dto.ts @@ -1,14 +1,14 @@ -import { ApiProperty } from '@nestjs/swagger'; import { IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { KeyDto } from './key.dto'; export class RenameKeyDto extends KeyDto { - @ApiProperty({ - description: 'New key name', - type: String, - }) + @ApiRedisString('New key name') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/keys/dto/rename.key.response.ts b/redisinsight/api/src/modules/browser/keys/dto/rename.key.response.ts index 468a23bc8e..267f35037a 100644 --- a/redisinsight/api/src/modules/browser/keys/dto/rename.key.response.ts +++ b/redisinsight/api/src/modules/browser/keys/dto/rename.key.response.ts @@ -1,13 +1,13 @@ -import { ApiProperty } from '@nestjs/swagger'; import { IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class KeyResponse { - @ApiProperty({ - description: 'Key Name', - type: String, - }) + @ApiRedisString('keyName') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/keys/keys.controller.ts b/redisinsight/api/src/modules/browser/keys/keys.controller.ts index ebc1eaf6c7..97ef2e1a8f 100644 --- a/redisinsight/api/src/modules/browser/keys/keys.controller.ts +++ b/redisinsight/api/src/modules/browser/keys/keys.controller.ts @@ -44,6 +44,7 @@ export class KeysController { @ApiOkResponse({ description: 'Keys list', type: GetKeysWithDetailsResponse, + isArray: true, }) @ApiQueryRedisStringEncoding() async getKeys( @@ -60,7 +61,8 @@ export class KeysController { @ApiRedisParams() @ApiOkResponse({ description: 'Info for multiple keys', - type: GetKeysWithDetailsResponse, + type: GetKeyInfoResponse, + isArray: true, }) @ApiQueryRedisStringEncoding() async getKeysInfo( diff --git a/redisinsight/api/src/modules/browser/list/dto/delete.list-elements.response.ts b/redisinsight/api/src/modules/browser/list/dto/delete.list-elements.response.ts index 31b6b25948..7e9b473981 100644 --- a/redisinsight/api/src/modules/browser/list/dto/delete.list-elements.response.ts +++ b/redisinsight/api/src/modules/browser/list/dto/delete.list-elements.response.ts @@ -1,13 +1,8 @@ -import { ApiProperty } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class DeleteListElementsResponse { - @ApiProperty({ - type: String, - isArray: true, - description: 'Removed elements from list', - }) + @ApiRedisString('Removed elements from list', true) @RedisStringType({ each: true }) elements: RedisString[]; } diff --git a/redisinsight/api/src/modules/browser/list/dto/get.list-element.response.ts b/redisinsight/api/src/modules/browser/list/dto/get.list-element.response.ts index a491b69a9e..132a90ad4e 100644 --- a/redisinsight/api/src/modules/browser/list/dto/get.list-element.response.ts +++ b/redisinsight/api/src/modules/browser/list/dto/get.list-element.response.ts @@ -1,13 +1,9 @@ import { KeyResponse } from 'src/modules/browser/keys/dto'; -import { ApiProperty } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class GetListElementResponse extends KeyResponse { - @ApiProperty({ - type: () => String, - description: 'Element value', - }) + @ApiRedisString('Element value') @RedisStringType() value: RedisString; } diff --git a/redisinsight/api/src/modules/browser/list/dto/get.list-elements.response.ts b/redisinsight/api/src/modules/browser/list/dto/get.list-elements.response.ts index b4005b0281..50523e74a0 100644 --- a/redisinsight/api/src/modules/browser/list/dto/get.list-elements.response.ts +++ b/redisinsight/api/src/modules/browser/list/dto/get.list-elements.response.ts @@ -1,6 +1,6 @@ import { KeyResponse } from 'src/modules/browser/keys/dto'; import { ApiProperty } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class GetListElementsResponse extends KeyResponse { @@ -10,11 +10,7 @@ export class GetListElementsResponse extends KeyResponse { }) total: number; - @ApiProperty({ - type: () => String, - description: 'Array of elements.', - isArray: true, - }) + @ApiRedisString('Elements', true) @RedisStringType({ each: true }) elements: RedisString[]; } diff --git a/redisinsight/api/src/modules/browser/list/dto/push.element-to-list.dto.ts b/redisinsight/api/src/modules/browser/list/dto/push.element-to-list.dto.ts index c48bc89fa0..9d630e4a62 100644 --- a/redisinsight/api/src/modules/browser/list/dto/push.element-to-list.dto.ts +++ b/redisinsight/api/src/modules/browser/list/dto/push.element-to-list.dto.ts @@ -1,7 +1,11 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; -import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; +import { ApiPropertyOptional } from '@nestjs/swagger'; import { IsArray, IsDefined, IsEnum } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export enum ListElementDestination { @@ -10,11 +14,7 @@ export enum ListElementDestination { } export class PushElementToListDto extends KeyDto { - @ApiProperty({ - description: 'List element(s)', - type: String, - isArray: true, - }) + @ApiRedisString('List element(s)', true) @IsDefined() @IsArray() @IsRedisString({ each: true }) diff --git a/redisinsight/api/src/modules/browser/list/dto/set.list-element.dto.ts b/redisinsight/api/src/modules/browser/list/dto/set.list-element.dto.ts index cc8ba74815..66ea37a178 100644 --- a/redisinsight/api/src/modules/browser/list/dto/set.list-element.dto.ts +++ b/redisinsight/api/src/modules/browser/list/dto/set.list-element.dto.ts @@ -1,14 +1,15 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; import { ApiProperty } from '@nestjs/swagger'; import { IsDefined, IsInt, IsNotEmpty, Min } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class SetListElementDto extends KeyDto { - @ApiProperty({ - description: 'List element', - type: String, - }) + @ApiRedisString('List element') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/list/dto/set.list-element.response.ts b/redisinsight/api/src/modules/browser/list/dto/set.list-element.response.ts index 7b7c3bd833..283eea6ff6 100644 --- a/redisinsight/api/src/modules/browser/list/dto/set.list-element.response.ts +++ b/redisinsight/api/src/modules/browser/list/dto/set.list-element.response.ts @@ -1,5 +1,5 @@ import { ApiProperty } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class SetListElementResponse { @@ -10,10 +10,7 @@ export class SetListElementResponse { }) index: number; - @ApiProperty({ - description: 'List element', - type: String, - }) + @ApiRedisString('List element') @RedisStringType() element: RedisString; } diff --git a/redisinsight/api/src/modules/browser/list/list.controller.ts b/redisinsight/api/src/modules/browser/list/list.controller.ts index 4b4adcb41e..ca274c84c9 100644 --- a/redisinsight/api/src/modules/browser/list/list.controller.ts +++ b/redisinsight/api/src/modules/browser/list/list.controller.ts @@ -105,6 +105,10 @@ export class ListController extends BrowserBaseController { description: 'Update list element by index.', }) @ApiRedisParams() + @ApiOkResponse({ + description: 'Updated list element.', + type: SetListElementResponse, + }) @ApiBody({ type: SetListElementDto }) @ApiQueryRedisStringEncoding() async updateElement( @@ -131,7 +135,7 @@ export class ListController extends BrowserBaseController { { status: 200, description: 'Specified elements of the list stored at key.', - type: GetListElementsResponse, + type: GetListElementResponse, }, ], }) @@ -153,7 +157,7 @@ export class ListController extends BrowserBaseController { { status: 200, description: 'Removed elements.', - type: GetListElementsResponse, + type: DeleteListElementsResponse, }, ], }) diff --git a/redisinsight/api/src/modules/browser/redisearch/dto/create.redisearch-index.dto.ts b/redisinsight/api/src/modules/browser/redisearch/dto/create.redisearch-index.dto.ts index 886344d549..62effaae44 100644 --- a/redisinsight/api/src/modules/browser/redisearch/dto/create.redisearch-index.dto.ts +++ b/redisinsight/api/src/modules/browser/redisearch/dto/create.redisearch-index.dto.ts @@ -6,7 +6,11 @@ import { IsOptional, ValidateNested, } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { Type } from 'class-transformer'; @@ -25,10 +29,7 @@ export enum RedisearchIndexDataType { } export class CreateRedisearchIndexFieldDto { - @ApiProperty({ - description: 'Name of field to be indexed', - type: String, - }) + @ApiRedisString('Name of field to be indexed') @IsDefined() @RedisStringType() @IsRedisString() @@ -48,10 +49,7 @@ export class CreateRedisearchIndexFieldDto { } export class CreateRedisearchIndexDto { - @ApiProperty({ - description: 'Index Name', - type: String, - }) + @ApiRedisString('Index Name') @IsDefined() @RedisStringType() @IsRedisString() @@ -69,11 +67,7 @@ export class CreateRedisearchIndexDto { }) type: RedisearchIndexKeyType; - @ApiPropertyOptional({ - description: 'Keys prefixes to find keys for index', - isArray: true, - type: String, - }) + @ApiRedisString('Keys prefixes to find keys for index', true, false) @IsOptional() @RedisStringType({ each: true }) @IsRedisString({ each: true }) diff --git a/redisinsight/api/src/modules/browser/redisearch/dto/index.info.dto.ts b/redisinsight/api/src/modules/browser/redisearch/dto/index.info.dto.ts index 413004534d..bf84db1194 100644 --- a/redisinsight/api/src/modules/browser/redisearch/dto/index.info.dto.ts +++ b/redisinsight/api/src/modules/browser/redisearch/dto/index.info.dto.ts @@ -1,14 +1,15 @@ import { ApiProperty } from '@nestjs/swagger'; import { IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { Expose } from 'class-transformer'; export class IndexInfoRequestBodyDto { - @ApiProperty({ - description: 'Index name', - type: String, - }) + @ApiRedisString('Key Name') @IsDefined() @RedisStringType() @IsRedisString() diff --git a/redisinsight/api/src/modules/browser/redisearch/dto/list.redisearch-indexes.response.ts b/redisinsight/api/src/modules/browser/redisearch/dto/list.redisearch-indexes.response.ts index 86056f5263..dab06e9944 100644 --- a/redisinsight/api/src/modules/browser/redisearch/dto/list.redisearch-indexes.response.ts +++ b/redisinsight/api/src/modules/browser/redisearch/dto/list.redisearch-indexes.response.ts @@ -1,12 +1,8 @@ -import { ApiProperty } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class ListRedisearchIndexesResponse { - @ApiProperty({ - description: 'Indexes names', - type: String, - }) + @ApiRedisString('Indexes names', true) @RedisStringType({ each: true }) indexes: RedisString[]; } diff --git a/redisinsight/api/src/modules/browser/redisearch/dto/search.redisearch.dto.ts b/redisinsight/api/src/modules/browser/redisearch/dto/search.redisearch.dto.ts index 0f68b4d0b5..4f23254731 100644 --- a/redisinsight/api/src/modules/browser/redisearch/dto/search.redisearch.dto.ts +++ b/redisinsight/api/src/modules/browser/redisearch/dto/search.redisearch.dto.ts @@ -1,13 +1,14 @@ import { ApiProperty } from '@nestjs/swagger'; import { IsDefined, IsInt, IsString } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class SearchRedisearchDto { - @ApiProperty({ - description: 'Index Name', - type: String, - }) + @ApiRedisString('Index Name') @IsDefined() @RedisStringType() @IsRedisString() diff --git a/redisinsight/api/src/modules/browser/rejson-rl/dto/get.rejson-rl.response.ts b/redisinsight/api/src/modules/browser/rejson-rl/dto/get.rejson-rl.response.ts index 17db6bc9be..94f480135f 100644 --- a/redisinsight/api/src/modules/browser/rejson-rl/dto/get.rejson-rl.response.ts +++ b/redisinsight/api/src/modules/browser/rejson-rl/dto/get.rejson-rl.response.ts @@ -1,6 +1,12 @@ -import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; +import { + ApiExtraModels, + ApiProperty, + ApiPropertyOptional, + getSchemaPath, +} from '@nestjs/swagger'; import { SafeRejsonRlDataDto } from './safe.rejson-rl-data.dto'; +@ApiExtraModels(SafeRejsonRlDataDto) export class GetRejsonRlResponseDto { @ApiProperty({ type: Boolean, @@ -21,8 +27,17 @@ export class GetRejsonRlResponseDto { path?: string; @ApiProperty({ - type: () => SafeRejsonRlDataDto, - isArray: true, + oneOf: [ + { + type: 'array', + items: { $ref: getSchemaPath(SafeRejsonRlDataDto) }, + }, + { type: 'string' }, + { type: 'number' }, + { type: 'boolean' }, + { type: 'null' }, + ], + description: 'JSON data that can be of various types', }) data: SafeRejsonRlDataDto[] | string | number | boolean | null; } diff --git a/redisinsight/api/src/modules/browser/rejson-rl/dto/safe.rejson-rl-data.dto.ts b/redisinsight/api/src/modules/browser/rejson-rl/dto/safe.rejson-rl-data.dto.ts index d77f087db7..b69a5e10da 100644 --- a/redisinsight/api/src/modules/browser/rejson-rl/dto/safe.rejson-rl-data.dto.ts +++ b/redisinsight/api/src/modules/browser/rejson-rl/dto/safe.rejson-rl-data.dto.ts @@ -1,6 +1,6 @@ import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; -enum RejsonRlDataType { +export enum RejsonRlDataType { String = 'string', Number = 'number', Integer = 'integer', diff --git a/redisinsight/api/src/modules/browser/rejson-rl/rejson-rl.controller.ts b/redisinsight/api/src/modules/browser/rejson-rl/rejson-rl.controller.ts index 7d7806a9c2..456ea9683c 100644 --- a/redisinsight/api/src/modules/browser/rejson-rl/rejson-rl.controller.ts +++ b/redisinsight/api/src/modules/browser/rejson-rl/rejson-rl.controller.ts @@ -91,6 +91,13 @@ export class RejsonRlController extends BrowserBaseController { @ApiRedisInstanceOperation({ description: 'Removes path in the REJSON-RL', statusCode: 200, + responses: [ + { + status: 200, + description: 'Ok', + type: RemoveRejsonRlResponse, + }, + ], }) async remove( @BrowserClientMetadata() clientMetadata: ClientMetadata, diff --git a/redisinsight/api/src/modules/browser/set/dto/add.members-to-set.dto.ts b/redisinsight/api/src/modules/browser/set/dto/add.members-to-set.dto.ts index 5519f74e6a..434697358d 100644 --- a/redisinsight/api/src/modules/browser/set/dto/add.members-to-set.dto.ts +++ b/redisinsight/api/src/modules/browser/set/dto/add.members-to-set.dto.ts @@ -1,15 +1,14 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; -import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class AddMembersToSetDto extends KeyDto { - @ApiProperty({ - description: 'Set members', - isArray: true, - type: String, - }) + @ApiRedisString('Set members', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/set/dto/delete.members-from-set.dto.ts b/redisinsight/api/src/modules/browser/set/dto/delete.members-from-set.dto.ts index 02fb8d1547..945d7d8754 100644 --- a/redisinsight/api/src/modules/browser/set/dto/delete.members-from-set.dto.ts +++ b/redisinsight/api/src/modules/browser/set/dto/delete.members-from-set.dto.ts @@ -1,15 +1,15 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class DeleteMembersFromSetDto extends KeyDto { - @ApiProperty({ - description: 'Key members', - type: String, - isArray: true, - }) + @ApiRedisString('Key members', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/set/dto/get.set-members.response.ts b/redisinsight/api/src/modules/browser/set/dto/get.set-members.response.ts index 7713d59d43..e336d52ef2 100644 --- a/redisinsight/api/src/modules/browser/set/dto/get.set-members.response.ts +++ b/redisinsight/api/src/modules/browser/set/dto/get.set-members.response.ts @@ -1,6 +1,6 @@ import { ApiProperty } from '@nestjs/swagger'; import { KeyResponse } from 'src/modules/browser/keys/dto'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class SetScanResponse extends KeyResponse { @@ -13,11 +13,7 @@ export class SetScanResponse extends KeyResponse { }) nextCursor: number; - @ApiProperty({ - type: () => String, - description: 'Array of members.', - isArray: true, - }) + @ApiRedisString('Array of members', true) @RedisStringType({ each: true }) members: RedisString[]; } diff --git a/redisinsight/api/src/modules/browser/set/set.controller.ts b/redisinsight/api/src/modules/browser/set/set.controller.ts index 7dfb2df66f..ffe7a3fbbd 100644 --- a/redisinsight/api/src/modules/browser/set/set.controller.ts +++ b/redisinsight/api/src/modules/browser/set/set.controller.ts @@ -39,6 +39,9 @@ export class SetController extends BrowserBaseController { @ApiOperation({ description: 'Set key to hold Set data type' }) @ApiRedisParams() @ApiBody({ type: CreateSetWithExpireDto }) + @ApiOkResponse({ + description: 'Set key created successfully', + }) @ApiQueryRedisStringEncoding() async createSet( @BrowserClientMetadata() clientMetadata: ClientMetadata, @@ -73,6 +76,9 @@ export class SetController extends BrowserBaseController { }) @ApiRedisParams() @ApiBody({ type: AddMembersToSetDto }) + @ApiOkResponse({ + description: 'Members added to set successfully', + }) @ApiQueryRedisStringEncoding() async addMembers( @BrowserClientMetadata() clientMetadata: ClientMetadata, @@ -87,6 +93,10 @@ export class SetController extends BrowserBaseController { }) @ApiRedisParams() @ApiBody({ type: DeleteMembersFromSetDto }) + @ApiOkResponse({ + description: 'Members removed from set', + type: DeleteMembersFromSetResponse, + }) @ApiQueryRedisStringEncoding() async deleteMembers( @BrowserClientMetadata() clientMetadata: ClientMetadata, diff --git a/redisinsight/api/src/modules/browser/stream/controllers/consumer.controller.ts b/redisinsight/api/src/modules/browser/stream/controllers/consumer.controller.ts index 6a958490a5..e731ad4375 100644 --- a/redisinsight/api/src/modules/browser/stream/controllers/consumer.controller.ts +++ b/redisinsight/api/src/modules/browser/stream/controllers/consumer.controller.ts @@ -15,7 +15,6 @@ import { ClaimPendingEntriesResponse, ClaimPendingEntryDto, ConsumerDto, - ConsumerGroupDto, DeleteConsumersDto, GetConsumersDto, GetPendingEntriesDto, @@ -44,7 +43,7 @@ export class ConsumerController extends BrowserBaseController { responses: [ { status: 200, - type: ConsumerGroupDto, + type: ConsumerDto, isArray: true, }, ], diff --git a/redisinsight/api/src/modules/browser/stream/dto/ack.pending-entries.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/ack.pending-entries.dto.ts index a420c17a82..57667a2782 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/ack.pending-entries.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/ack.pending-entries.dto.ts @@ -1,16 +1,14 @@ -import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined, IsNotEmpty } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { GetConsumersDto } from './get.consumers.dto'; export class AckPendingEntriesDto extends GetConsumersDto { - @ApiProperty({ - description: 'Entries IDs', - type: String, - isArray: true, - example: ['1650985323741-0', '1650985323770-0'], - }) + @ApiRedisString('Entries IDs', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/stream/dto/claim.pending-entry.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/claim.pending-entry.dto.ts index 2cc301f340..b201a5fb61 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/claim.pending-entry.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/claim.pending-entry.dto.ts @@ -11,25 +11,21 @@ import { NotEquals, ValidateIf, } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class ClaimPendingEntryDto extends KeyDto { - @ApiProperty({ - type: String, - description: 'Consumer group name', - example: 'group-1', - }) + @ApiRedisString('Consumer group name') @IsNotEmpty() @IsRedisString() @RedisStringType() groupName: RedisString; - @ApiProperty({ - type: String, - description: 'Consumer name', - example: 'consumer-1', - }) + @ApiRedisString('Consumer name') @IsNotEmpty() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/stream/dto/create.consumer-groups.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/create.consumer-groups.dto.ts index 97c82aafdd..b3e94607fc 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/create.consumer-groups.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/create.consumer-groups.dto.ts @@ -1,5 +1,9 @@ import { ApiProperty } from '@nestjs/swagger'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { ArrayNotEmpty, @@ -12,11 +16,7 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; import { Type } from 'class-transformer'; export class ConsumerGroupDto { - @ApiProperty({ - type: String, - description: 'Consumer Group name', - example: 'group', - }) + @ApiRedisString('Consumer Group name') @RedisStringType() name: RedisString; @@ -57,11 +57,7 @@ export class ConsumerGroupDto { } export class CreateConsumerGroupDto { - @ApiProperty({ - type: String, - description: 'Consumer group name', - example: 'group', - }) + @ApiRedisString('Consumer group name') @IsNotEmpty() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/stream/dto/delete.consumer-groups.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/delete.consumer-groups.dto.ts index 530534a0cb..858f7f04da 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/delete.consumer-groups.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/delete.consumer-groups.dto.ts @@ -1,16 +1,14 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; -import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class DeleteConsumerGroupsDto extends KeyDto { - @ApiProperty({ - description: 'Consumer group names', - type: String, - isArray: true, - example: ['Group-1', 'Group-1'], - }) + @ApiRedisString('Consumer group names', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/stream/dto/delete.consumers.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/delete.consumers.dto.ts index a94bf9ea22..8cd13b28a7 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/delete.consumers.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/delete.consumers.dto.ts @@ -1,16 +1,14 @@ -import { ApiProperty } from '@nestjs/swagger'; import { ArrayNotEmpty, IsArray, IsDefined, IsNotEmpty } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { GetConsumersDto } from './get.consumers.dto'; export class DeleteConsumersDto extends GetConsumersDto { - @ApiProperty({ - description: 'Names of consumers to delete', - type: String, - isArray: true, - example: ['consumer-1', 'consumer-2'], - }) + @ApiRedisString('Names of consumers to delete', true) @IsDefined() @IsArray() @ArrayNotEmpty() diff --git a/redisinsight/api/src/modules/browser/stream/dto/get.consumers.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/get.consumers.dto.ts index 0ab097f480..e3cfa0aa27 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/get.consumers.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/get.consumers.dto.ts @@ -1,15 +1,15 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; import { ApiProperty } from '@nestjs/swagger'; import { IsNotEmpty } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class ConsumerDto { - @ApiProperty({ - type: String, - description: "The consumer's name", - example: 'consumer-2', - }) + @ApiRedisString("The consumer's name") @RedisStringType() name: RedisString; @@ -32,11 +32,7 @@ export class ConsumerDto { } export class GetConsumersDto extends KeyDto { - @ApiProperty({ - type: String, - description: 'Consumer group name', - example: 'group-1', - }) + @ApiRedisString('Consumer group name') @IsNotEmpty() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/stream/dto/get.pending-entries.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/get.pending-entries.dto.ts index 31d7dd603e..2591e88f82 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/get.pending-entries.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/get.pending-entries.dto.ts @@ -5,7 +5,11 @@ import { } from '@nestjs/swagger'; import { KeyDto } from 'src/modules/browser/keys/dto'; import { IsInt, IsNotEmpty, IsString, Min } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { GetConsumersDto } from './get.consumers.dto'; @@ -17,11 +21,7 @@ export class PendingEntryDto { }) id: string; - @ApiProperty({ - type: String, - description: 'Consumer name', - example: 'consumer-1', - }) + @ApiRedisString('Consumer name') @RedisStringType() consumerName: RedisString; @@ -46,11 +46,7 @@ export class GetPendingEntriesDto extends IntersectionType( KeyDto, GetConsumersDto, ) { - @ApiProperty({ - type: String, - description: 'Consumer name', - example: 'consumer-1', - }) + @ApiRedisString('Consumer name') @IsNotEmpty() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/stream/dto/stream-entry.dto.ts b/redisinsight/api/src/modules/browser/stream/dto/stream-entry.dto.ts index 7316a26e24..b0ed7fa2b6 100644 --- a/redisinsight/api/src/modules/browser/stream/dto/stream-entry.dto.ts +++ b/redisinsight/api/src/modules/browser/stream/dto/stream-entry.dto.ts @@ -7,27 +7,23 @@ import { IsString, ValidateNested, } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; import { Type } from 'class-transformer'; export class StreamEntryFieldDto { - @ApiProperty({ - type: String, - description: 'Entry field name', - example: 'field1', - }) + @ApiRedisString('Entry field name') @IsDefined() @IsNotEmpty() @IsRedisString() @RedisStringType() name: RedisString; - @ApiProperty({ - type: String, - description: 'Entry value', - example: 'value1', - }) + @ApiRedisString('Entry value') @IsDefined() @IsNotEmpty() @IsRedisString() @@ -47,7 +43,8 @@ export class StreamEntryDto { id: string; @ApiProperty({ - type: Object, + type: StreamEntryFieldDto, + isArray: true, description: 'Entry fields', example: [ { name: 'field1', value: 'value1' }, diff --git a/redisinsight/api/src/modules/browser/string/dto/get.string-value.response.ts b/redisinsight/api/src/modules/browser/string/dto/get.string-value.response.ts index bd97d3e316..9aa1372af6 100644 --- a/redisinsight/api/src/modules/browser/string/dto/get.string-value.response.ts +++ b/redisinsight/api/src/modules/browser/string/dto/get.string-value.response.ts @@ -1,13 +1,9 @@ import { KeyResponse } from 'src/modules/browser/keys/dto'; -import { ApiProperty } from '@nestjs/swagger'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class GetStringValueResponse extends KeyResponse { - @ApiProperty({ - description: 'Key value', - type: String, - }) + @ApiRedisString('Key value') @RedisStringType() value: RedisString; } diff --git a/redisinsight/api/src/modules/browser/string/dto/set.string.dto.ts b/redisinsight/api/src/modules/browser/string/dto/set.string.dto.ts index e719d90e30..bb41e93601 100644 --- a/redisinsight/api/src/modules/browser/string/dto/set.string.dto.ts +++ b/redisinsight/api/src/modules/browser/string/dto/set.string.dto.ts @@ -1,14 +1,14 @@ import { KeyDto } from 'src/modules/browser/keys/dto'; -import { ApiProperty } from '@nestjs/swagger'; import { IsDefined } from 'class-validator'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { RedisString } from 'src/common/constants'; export class SetStringDto extends KeyDto { - @ApiProperty({ - description: 'Key value', - type: String, - }) + @ApiRedisString('Key value') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/browser/z-set/dto/z-set-member.dto.ts b/redisinsight/api/src/modules/browser/z-set/dto/z-set-member.dto.ts index b7d5c7cc9a..9ea310081b 100644 --- a/redisinsight/api/src/modules/browser/z-set/dto/z-set-member.dto.ts +++ b/redisinsight/api/src/modules/browser/z-set/dto/z-set-member.dto.ts @@ -1,6 +1,7 @@ import { ApiProperty } from '@nestjs/swagger'; import { IsDefined } from 'class-validator'; import { + ApiRedisString, IsRedisString, isZSetScore, RedisStringType, @@ -8,10 +9,7 @@ import { import { RedisString } from 'src/common/constants'; export class ZSetMemberDto { - @ApiProperty({ - type: String, - description: 'Member name value.', - }) + @ApiRedisString('Member name value') @IsDefined() @IsRedisString() @RedisStringType() diff --git a/redisinsight/api/src/modules/cloud/auth/cloud-auth.controller.ts b/redisinsight/api/src/modules/cloud/auth/cloud-auth.controller.ts index e2dd0e42d9..1f9f771b05 100644 --- a/redisinsight/api/src/modules/cloud/auth/cloud-auth.controller.ts +++ b/redisinsight/api/src/modules/cloud/auth/cloud-auth.controller.ts @@ -6,23 +6,61 @@ import { ValidationPipe, Render, } from '@nestjs/common'; -import { ApiTags } from '@nestjs/swagger'; +import { ApiTags, ApiQuery, ApiExtraModels } from '@nestjs/swagger'; import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator'; import { CloudAuthService } from 'src/modules/cloud/auth/cloud-auth.service'; +import { CloudOauthCallbackQueryDto } from './dto/cloud-oauth-callback-query.dto'; +import { CloudAuthResponse } from './models/cloud-auth-response'; +import { CloudAuthRequestOptions } from './models'; @ApiTags('Cloud Auth') -@Controller('cloud') +@ApiExtraModels(CloudAuthRequestOptions) +@Controller('cloud/auth') @UsePipes(new ValidationPipe({ transform: true })) export class CloudAuthController { constructor(private readonly cloudAuthService: CloudAuthService) {} @Get('oauth/callback') @ApiEndpoint({ - description: 'OAuth callback', + description: + 'OAuth callback endpoint for handling OAuth authorization code flow', statusCode: 200, + responses: [ + { + status: 200, + description: 'OAuth callback processed successfully', + type: CloudAuthResponse, + }, + ], + }) + @ApiQuery({ + name: 'code', + description: 'Authorization code from OAuth provider', + required: false, + type: String, + }) + @ApiQuery({ + name: 'state', + description: 'State parameter to prevent CSRF attacks', + required: false, + type: String, + }) + @ApiQuery({ + name: 'error', + description: 'Error code if OAuth flow failed', + required: false, + type: String, + }) + @ApiQuery({ + name: 'error_description', + description: 'Human-readable error description', + required: false, + type: String, }) @Render('cloud_oauth_callback') - async callback(@Query() query) { + async callback( + @Query() query: CloudOauthCallbackQueryDto, + ): Promise { return this.cloudAuthService.handleCallback(query); } } diff --git a/redisinsight/api/src/modules/cloud/auth/cloud-auth.service.ts b/redisinsight/api/src/modules/cloud/auth/cloud-auth.service.ts index 4ba2bcae0d..5a05a3e3a1 100644 --- a/redisinsight/api/src/modules/cloud/auth/cloud-auth.service.ts +++ b/redisinsight/api/src/modules/cloud/auth/cloud-auth.service.ts @@ -1,4 +1,4 @@ -import { Injectable, Logger } from '@nestjs/common'; +import { HttpException, Injectable, Logger } from '@nestjs/common'; import axios from 'axios'; import { GoogleIdpCloudAuthStrategy } from 'src/modules/cloud/auth/auth-strategy/google-idp.cloud.auth-strategy'; import { @@ -31,6 +31,7 @@ import { EventEmitter2 } from '@nestjs/event-emitter'; import { CloudAuthServerEvent } from 'src/modules/cloud/common/constants'; import { CloudApiUnauthorizedException } from 'src/modules/cloud/common/exceptions'; import { CloudOauthSsoUnsupportedEmailException } from 'src/modules/cloud/auth/exceptions/cloud-oauth.sso-unsupported-email.exception'; +import { CloudOauthCallbackQueryDto } from './dto/cloud-oauth-callback-query.dto'; @Injectable() export class CloudAuthService { @@ -57,10 +58,16 @@ export class CloudAuthService { }; } + /** + * Get the appropriate error based on OAuth authorization server redirect error + * @param query OAuth callback query with error information + * @param authRequest The original auth request + * @returns The appropriate error instance + */ static getAuthorizationServerRedirectError( - query: { error_description: string; error: string }, + query: CloudOauthCallbackQueryDto, authRequest?: CloudAuthRequest, - ) { + ): HttpException { if (query?.error_description?.indexOf('canceled') > -1) { return new CloudOauthCanceledException(); } @@ -83,6 +90,12 @@ export class CloudAuthService { }); } + /** + * Get the appropriate authentication strategy based on the identity provider type + * @param strategy Identity provider type + * @returns The authentication strategy for the specified provider + * @throws CloudOauthUnknownAuthorizationRequestException if the strategy is unknown + */ getAuthStrategy(strategy: CloudAuthIdpType): CloudAuthStrategy { switch (strategy) { case CloudAuthIdpType.Google: @@ -100,15 +113,16 @@ export class CloudAuthService { /** * Returns authorization url to open in the native browser to initialize oauth flow - * @param sessionMetadata - * @param options + * @param sessionMetadata Session metadata for the request + * @param options Authentication request options + * @returns Authorization URL for OAuth flow */ async getAuthorizationUrl( sessionMetadata: SessionMetadata, options: CloudAuthRequestOptions, ): Promise { try { - const authRequest: any = await this.getAuthStrategy( + const authRequest: CloudAuthRequest = await this.getAuthStrategy( options?.strategy, ).generateAuthRequest(sessionMetadata, options); authRequest.callback = options?.callback; @@ -167,10 +181,12 @@ export class CloudAuthService { /** * Get some useful not sensitive information about auth request for analytics purpose * Will not remove auth request from the pool - * @param query + * @param query OAuth callback query parameters * @private */ - private async getAuthRequestInfo(query): Promise { + private async getAuthRequestInfo( + query: CloudOauthCallbackQueryDto, + ): Promise { if (!this.authRequests.has(query?.state)) { this.logger.log( `${query?.state ? 'Auth Request matching query state not found' : 'Query state field is empty'}`, @@ -191,9 +207,11 @@ export class CloudAuthService { * Process oauth callback * Exchanges code and modify user session * Generates proper errors - * @param query + * @param query OAuth callback query parameters */ - private async callback(query): Promise { + private async callback( + query: CloudOauthCallbackQueryDto, + ): Promise<(result: CloudAuthResponse) => Promise> { if (!this.authRequests.has(query?.state)) { this.logger.log( `${query?.state ? 'Auth Request matching query state not found' : 'Query state field is empty'}`, @@ -265,11 +283,11 @@ export class CloudAuthService { /** * Handle OAuth callback from Web or by deep link - * @param query - * @param from + * @param query OAuth callback query parameters + * @param from Source of the callback request */ async handleCallback( - query, + query: CloudOauthCallbackQueryDto, from = CloudSsoFeatureStrategy.DeepLink, ): Promise { this.logger.log( @@ -280,7 +298,7 @@ export class CloudAuthService { message: 'Successfully authenticated', }; - let callback; + let callback: (result: CloudAuthResponse) => Promise; let reqInfo: CloudAuthRequestInfo; try { reqInfo = await this.getAuthRequestInfo(query); @@ -313,7 +331,7 @@ export class CloudAuthService { if (!callback) { this.logger.log('Callback is undefined'); } - callback?.(result)?.catch((e: Error) => + callback(result)?.catch((e: Error) => this.logger.error('Async callback failed', e), ); } catch (e) { @@ -374,11 +392,20 @@ export class CloudAuthService { } } - isRequestInProgress(query) { + /** + * Check if a request is currently in progress + * @param query OAuth callback query parameters + * @returns True if the request is in progress + */ + isRequestInProgress(query: CloudOauthCallbackQueryDto): boolean { return !!this.inProgressRequests.has(query?.state); } - finishInProgressRequest(query) { + /** + * Mark a request as finished + * @param query OAuth callback query parameters + */ + finishInProgressRequest(query: CloudOauthCallbackQueryDto): void { this.inProgressRequests.delete(query?.state); } } diff --git a/redisinsight/api/src/modules/cloud/auth/dto/cloud-oauth-callback-query.dto.ts b/redisinsight/api/src/modules/cloud/auth/dto/cloud-oauth-callback-query.dto.ts new file mode 100644 index 0000000000..d78ea5b8c2 --- /dev/null +++ b/redisinsight/api/src/modules/cloud/auth/dto/cloud-oauth-callback-query.dto.ts @@ -0,0 +1,40 @@ +import { ApiPropertyOptional } from '@nestjs/swagger'; +import { IsOptional, IsString } from 'class-validator'; + +export class CloudOauthCallbackQueryDto { + @ApiPropertyOptional({ + description: 'Authorization code from OAuth provider', + type: String, + example: 'abc123def456', + }) + @IsOptional() + @IsString() + code?: string; + + @ApiPropertyOptional({ + description: 'State parameter to prevent CSRF attacks', + type: String, + example: 'state_p6vA6A5tF36Jf6twH2cBOqtt7n', + }) + @IsOptional() + @IsString() + state?: string; + + @ApiPropertyOptional({ + description: 'Error code if OAuth flow failed', + type: String, + example: 'access_denied', + }) + @IsOptional() + @IsString() + error?: string; + + @ApiPropertyOptional({ + description: 'Human-readable error description', + type: String, + example: 'The user denied the request', + }) + @IsOptional() + @IsString() + error_description?: string; +} diff --git a/redisinsight/api/src/modules/cloud/auth/dto/index.ts b/redisinsight/api/src/modules/cloud/auth/dto/index.ts new file mode 100644 index 0000000000..1ce190c2ea --- /dev/null +++ b/redisinsight/api/src/modules/cloud/auth/dto/index.ts @@ -0,0 +1 @@ +export * from './cloud-oauth-callback-query.dto'; diff --git a/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request-info.ts b/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request-info.ts index 7585dbc991..49d55a4a3d 100644 --- a/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request-info.ts +++ b/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request-info.ts @@ -1,8 +1,29 @@ -import { PickType } from '@nestjs/swagger'; -import { CloudAuthRequest } from 'src/modules/cloud/auth/models/cloud-auth-request'; +import { PickType, ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; +import { CloudAuthRequest, CloudAuthIdpType } from 'src/modules/cloud/auth/models/cloud-auth-request'; +import { SessionMetadata } from 'src/common/models'; export class CloudAuthRequestInfo extends PickType(CloudAuthRequest, [ 'idpType', 'action', 'sessionMetadata', -] as const) {} +] as const) { + @ApiProperty({ + description: 'Identity provider type', + enum: CloudAuthIdpType, + example: CloudAuthIdpType.Google, + }) + idpType: CloudAuthIdpType; + + @ApiPropertyOptional({ + description: 'Action to perform after authentication', + type: String, + example: 'signIn', + }) + action?: string; + + @ApiProperty({ + description: 'Session metadata', + type: Object, + }) + sessionMetadata: SessionMetadata; +} diff --git a/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request.ts b/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request.ts index c705f54116..6ff58ae8e6 100644 --- a/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request.ts +++ b/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-request.ts @@ -1,4 +1,6 @@ +import { ApiProperty, ApiPropertyOptional, ApiTags } from '@nestjs/swagger'; import { SessionMetadata } from 'src/common/models'; +import { CloudAuthResponse } from './cloud-auth-response'; export enum CloudAuthIdpType { Google = 'google', @@ -6,20 +8,60 @@ export enum CloudAuthIdpType { Sso = 'sso', } +@ApiTags('Cloud Auth') export class CloudAuthRequestOptions { + @ApiProperty({ + description: 'OAuth identity provider strategy', + enum: CloudAuthIdpType, + example: CloudAuthIdpType.Google, + }) strategy: CloudAuthIdpType; + @ApiPropertyOptional({ + description: 'Action to perform after authentication', + type: String, + example: 'signIn', + }) action?: string; + @ApiPropertyOptional({ + description: 'Additional data for the authentication request', + type: Object, + example: { email: 'user@example.com' }, + }) data?: Record; - callback?: Function; + @ApiPropertyOptional({ + description: 'Callback function to execute after authentication', + type: Function, + }) + callback?: (result: CloudAuthResponse) => Promise; } export class CloudAuthRequest extends CloudAuthRequestOptions { + @ApiProperty({ + description: 'Identity provider type', + enum: CloudAuthIdpType, + example: CloudAuthIdpType.Google, + }) idpType: CloudAuthIdpType; + @ApiProperty({ + description: 'Session metadata', + type: Object, + }) sessionMetadata: SessionMetadata; + @ApiProperty({ + description: 'Creation timestamp of the auth request', + type: Date, + }) createdAt: Date; + + @ApiProperty({ + description: 'OAuth state parameter for CSRF protection', + type: String, + example: 'state_p6vA6A5tF36Jf6twH2cBOtt7n', + }) + state: string; } diff --git a/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-response.ts b/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-response.ts index 091ecdde98..ab12fb0d06 100644 --- a/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-response.ts +++ b/redisinsight/api/src/modules/cloud/auth/models/cloud-auth-response.ts @@ -1,12 +1,32 @@ +import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; + export enum CloudAuthStatus { Succeed = 'succeed', Failed = 'failed', } export class CloudAuthResponse { + @ApiProperty({ + description: 'Authentication status', + enum: CloudAuthStatus, + example: CloudAuthStatus.Succeed, + }) status: CloudAuthStatus; + @ApiPropertyOptional({ + description: 'Success or informational message', + type: String, + example: 'Successfully authenticated', + }) message?: string; + @ApiPropertyOptional({ + description: 'Error details if authentication failed', + oneOf: [ + { type: 'object' }, + { type: 'string' }, + ], + example: { code: 'OAUTH_ERROR', message: 'Authentication failed' }, + }) error?: object | string; } diff --git a/redisinsight/api/src/modules/cloud/subscription/dto/plans.cloud-subscription.dto.ts b/redisinsight/api/src/modules/cloud/subscription/dto/plans.cloud-subscription.dto.ts index d397e1ae92..ff6c187212 100644 --- a/redisinsight/api/src/modules/cloud/subscription/dto/plans.cloud-subscription.dto.ts +++ b/redisinsight/api/src/modules/cloud/subscription/dto/plans.cloud-subscription.dto.ts @@ -1,5 +1,9 @@ +import { ApiProperty } from '@nestjs/swagger'; import { CloudSubscriptionPlan, CloudSubscriptionRegion } from '../models'; export class CloudSubscriptionPlanResponse extends CloudSubscriptionPlan { + @ApiProperty({ + type: CloudSubscriptionRegion, + }) details: CloudSubscriptionRegion; } diff --git a/redisinsight/api/src/modules/cloud/user/models/cloud-user-account.ts b/redisinsight/api/src/modules/cloud/user/models/cloud-user-account.ts index e0322866f3..49ee440674 100644 --- a/redisinsight/api/src/modules/cloud/user/models/cloud-user-account.ts +++ b/redisinsight/api/src/modules/cloud/user/models/cloud-user-account.ts @@ -1,16 +1,33 @@ +import { ApiProperty } from '@nestjs/swagger'; import { Expose } from 'class-transformer'; import { TransformGroup } from 'src/common/constants'; export class CloudUserAccount { @Expose() + @ApiProperty({ + description: 'Account id', + type: Number, + }) id: number; @Expose() + @ApiProperty({ + description: 'Account name', + type: String, + }) name: string; @Expose({ groups: [TransformGroup.Secure] }) + @ApiProperty({ + description: 'Cloud API key', + type: String, + }) capiKey?: string; // api_access_key @Expose({ groups: [TransformGroup.Secure] }) + @ApiProperty({ + description: 'Cloud API secret', + type: String, + }) capiSecret?: string; } diff --git a/redisinsight/api/src/modules/cloud/user/models/cloud-user.ts b/redisinsight/api/src/modules/cloud/user/models/cloud-user.ts index 20e674ff86..671e2688db 100644 --- a/redisinsight/api/src/modules/cloud/user/models/cloud-user.ts +++ b/redisinsight/api/src/modules/cloud/user/models/cloud-user.ts @@ -1,3 +1,5 @@ +import { ApiPropertyOptional } from '@nestjs/swagger'; + import { Expose, Type } from 'class-transformer'; import { CloudUserAccount } from 'src/modules/cloud/user/models/cloud-user-account'; import { TransformGroup } from 'src/common/constants'; @@ -5,22 +7,47 @@ import { CloudCapiKey } from 'src/modules/cloud/capi-key/model'; export class CloudUser { @Expose() + @ApiPropertyOptional({ + description: 'User id', + type: Number, + }) id?: number; @Expose() + @ApiPropertyOptional({ + description: 'User name', + type: String, + }) name?: string; @Expose() + @ApiPropertyOptional({ + description: 'Current account id', + type: Number, + }) currentAccountId?: number; @Type(() => CloudCapiKey) @Expose({ groups: [TransformGroup.Secure] }) + @ApiPropertyOptional({ + description: 'Cloud API key', + type: CloudCapiKey, + }) capiKey?: CloudCapiKey; @Type(() => CloudUserAccount) @Expose() + @ApiPropertyOptional({ + description: 'User accounts', + type: CloudUserAccount, + isArray: true, + }) accounts?: CloudUserAccount[] = []; @Expose() + @ApiPropertyOptional({ + description: 'Additional user data', + type: Object, + }) data?: Record; } diff --git a/redisinsight/api/src/modules/cluster-monitor/models/cluster-details.ts b/redisinsight/api/src/modules/cluster-monitor/models/cluster-details.ts index 4f089fe096..701b2511cf 100644 --- a/redisinsight/api/src/modules/cluster-monitor/models/cluster-details.ts +++ b/redisinsight/api/src/modules/cluster-monitor/models/cluster-details.ts @@ -1,4 +1,4 @@ -import { ApiProperty } from '@nestjs/swagger'; +import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; import { ClusterNodeDetails } from 'src/modules/cluster-monitor/models/cluster-node-details'; export class ClusterDetails { @@ -17,7 +17,7 @@ export class ClusterDetails { }) mode: string; - @ApiProperty({ + @ApiPropertyOptional({ type: String, description: 'Username from the connection or undefined in case when connected with default user', @@ -40,35 +40,35 @@ export class ClusterDetails { state: string; @ApiProperty({ - type: String, + type: Number, description: 'cluster_slots_assigned from CLUSTER INFO command', example: 16384, }) slotsAssigned: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_slots_ok from CLUSTER INFO command', example: 16384, }) slotsOk: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_slots_pfail from CLUSTER INFO command', example: 0, }) slotsPFail: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_slots_fail from CLUSTER INFO command', example: 0, }) slotsFail: number; @ApiProperty({ - type: String, + type: Number, description: 'Calculated from (16384 - cluster_slots_assigned from CLUSTER INFO command)', example: 0, @@ -76,42 +76,42 @@ export class ClusterDetails { slotsUnassigned: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_stats_messages_sent from CLUSTER INFO command', example: 2451, }) statsMessagesSent: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_stats_messages_received from CLUSTER INFO command', example: 2451, }) statsMessagesReceived: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_current_epoch from CLUSTER INFO command', example: 6, }) currentEpoch: number; @ApiProperty({ - type: String, + type: Number, description: 'cluster_my_epoch from CLUSTER INFO command', example: 2, }) myEpoch: number; @ApiProperty({ - type: String, + type: Number, description: 'Number of shards. cluster_size from CLUSTER INFO command', example: 3, }) size: number; @ApiProperty({ - type: String, + type: Number, description: 'All nodes number in the Cluster. cluster_known_nodes from CLUSTER INFO command', example: 9, diff --git a/redisinsight/api/src/modules/cluster-monitor/models/cluster-node-details.ts b/redisinsight/api/src/modules/cluster-monitor/models/cluster-node-details.ts index 0a4a79b46e..8fd5219456 100644 --- a/redisinsight/api/src/modules/cluster-monitor/models/cluster-node-details.ts +++ b/redisinsight/api/src/modules/cluster-monitor/models/cluster-node-details.ts @@ -1,4 +1,4 @@ -import { ApiProperty } from '@nestjs/swagger'; +import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger'; export enum NodeRole { Primary = 'primary', @@ -54,7 +54,7 @@ export class ClusterNodeDetails { }) role: NodeRole; - @ApiProperty({ + @ApiPropertyOptional({ type: String, description: 'ID of primary node (for replica only)', example: 'c33218e9ff2faf8749bfb6585ba1e6d40a4e94fb', @@ -68,7 +68,7 @@ export class ClusterNodeDetails { }) health: HealthStatus; - @ApiProperty({ + @ApiPropertyOptional({ type: String, isArray: true, description: @@ -139,7 +139,7 @@ export class ClusterNodeDetails { }) networkOutKbps: number; - @ApiProperty({ + @ApiPropertyOptional({ type: Number, description: 'Ratio for cache hits and misses [0 - 1]. Ideally should be close to 1', @@ -156,7 +156,7 @@ export class ClusterNodeDetails { }) replicationOffset: number; - @ApiProperty({ + @ApiPropertyOptional({ type: Number, description: 'For replicas only. Determines on how much replica is behind of primary.', @@ -171,7 +171,7 @@ export class ClusterNodeDetails { }) uptimeSec: number; - @ApiProperty({ + @ApiPropertyOptional({ type: () => ClusterNodeDetails, isArray: true, description: 'For primary nodes only. Replica node(s) details', diff --git a/redisinsight/api/src/modules/custom-tutorial/custom-tutorial.controller.ts b/redisinsight/api/src/modules/custom-tutorial/custom-tutorial.controller.ts index 5d60780d45..1f151cba2d 100644 --- a/redisinsight/api/src/modules/custom-tutorial/custom-tutorial.controller.ts +++ b/redisinsight/api/src/modules/custom-tutorial/custom-tutorial.controller.ts @@ -50,7 +50,8 @@ export class CustomTutorialController { statusCode: 201, responses: [ { - type: Object, + status: 201, + type: RootCustomTutorialManifest, }, ], }) @@ -67,7 +68,8 @@ export class CustomTutorialController { statusCode: 200, responses: [ { - type: Object, + status: 200, + type: RootCustomTutorialManifest, }, ], }) diff --git a/redisinsight/api/src/modules/database-analysis/database-analysis.controller.ts b/redisinsight/api/src/modules/database-analysis/database-analysis.controller.ts index fe7cd26450..efa960d3e9 100644 --- a/redisinsight/api/src/modules/database-analysis/database-analysis.controller.ts +++ b/redisinsight/api/src/modules/database-analysis/database-analysis.controller.ts @@ -10,7 +10,7 @@ import { ValidationPipe, } from '@nestjs/common'; import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator'; -import { ApiTags } from '@nestjs/swagger'; +import { ApiTags, ApiParam } from '@nestjs/swagger'; import { DatabaseAnalysisService } from 'src/modules/database-analysis/database-analysis.service'; import { DatabaseAnalysis, @@ -46,6 +46,11 @@ export class DatabaseAnalysisController { }) @Post() @ApiQueryRedisStringEncoding() + @ApiParam({ + name: 'dbInstance', + description: 'Database instance id', + type: String, + }) async create( @ClientMetadataParam() clientMetadata: ClientMetadata, @Body() dto: CreateDatabaseAnalysisDto, @@ -65,22 +70,33 @@ export class DatabaseAnalysisController { }) @Get(':id') @ApiQueryRedisStringEncoding() + @ApiParam({ + name: 'dbInstance', + description: 'Database instance id', + type: String, + }) + @ApiParam({ name: 'id', description: 'Analysis id', type: String }) async get(@Param('id') id: string): Promise { return this.service.get(id); } @ApiEndpoint({ statusCode: 200, - description: 'Get database analysis', + description: 'Get database analysis list', responses: [ { status: 200, - type: DatabaseAnalysis, + type: [ShortDatabaseAnalysis], }, ], }) @Get('') @ApiQueryRedisStringEncoding() + @ApiParam({ + name: 'dbInstance', + description: 'Database instance id', + type: String, + }) async list( @Param('dbInstance') databaseId: string, ): Promise { @@ -89,16 +105,22 @@ export class DatabaseAnalysisController { @Patch(':id') @ApiEndpoint({ - description: 'Update database instance by id', + description: 'Update database analysis by id', statusCode: 200, responses: [ { status: 200, - description: "Updated database instance' response", + description: 'Updated database analysis response', type: DatabaseAnalysis, }, ], }) + @ApiParam({ + name: 'dbInstance', + description: 'Database instance id', + type: String, + }) + @ApiParam({ name: 'id', description: 'Analysis id', type: String }) @UsePipes( new ValidationPipe({ transform: true, diff --git a/redisinsight/api/src/modules/database-analysis/models/database-analysis.ts b/redisinsight/api/src/modules/database-analysis/models/database-analysis.ts index 9bde33b852..bd7a54f8ce 100644 --- a/redisinsight/api/src/modules/database-analysis/models/database-analysis.ts +++ b/redisinsight/api/src/modules/database-analysis/models/database-analysis.ts @@ -77,6 +77,7 @@ export class DatabaseAnalysis { @ApiProperty({ description: 'Top namespaces by keys number', type: () => NspSummary, + isArray: true, }) @Expose() @Type(() => NspSummary) @@ -85,6 +86,7 @@ export class DatabaseAnalysis { @ApiProperty({ description: 'Top namespaces by memory', type: () => NspSummary, + isArray: true, }) @Expose() @Type(() => NspSummary) diff --git a/redisinsight/api/src/modules/database-analysis/models/key.ts b/redisinsight/api/src/modules/database-analysis/models/key.ts index 31ee96c534..7b08245e8b 100644 --- a/redisinsight/api/src/modules/database-analysis/models/key.ts +++ b/redisinsight/api/src/modules/database-analysis/models/key.ts @@ -1,14 +1,14 @@ import { RedisString } from 'src/common/constants'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; import { ApiProperty } from '@nestjs/swagger'; import { Expose } from 'class-transformer'; export class Key { - @ApiProperty({ - description: 'Key name', - type: String, - example: 'key1', - }) + @ApiRedisString('Key Name') @IsRedisString() @Expose() @RedisStringType() diff --git a/redisinsight/api/src/modules/database-analysis/models/nsp-summary.ts b/redisinsight/api/src/modules/database-analysis/models/nsp-summary.ts index d1fb151e14..146b7e8a56 100644 --- a/redisinsight/api/src/modules/database-analysis/models/nsp-summary.ts +++ b/redisinsight/api/src/modules/database-analysis/models/nsp-summary.ts @@ -1,15 +1,11 @@ import { NspTypeSummary } from 'src/modules/database-analysis/models/nsp-type-summary'; import { RedisString } from 'src/common/constants'; import { Expose, Type } from 'class-transformer'; -import { RedisStringType } from 'src/common/decorators'; +import { ApiRedisString, RedisStringType } from 'src/common/decorators'; import { ApiProperty } from '@nestjs/swagger'; export class NspSummary { - @ApiProperty({ - description: 'Namespace', - type: String, - example: 'device', - }) + @ApiRedisString('Namespace') @RedisStringType() @Expose() nsp: RedisString; diff --git a/redisinsight/api/src/modules/database-recommendation/database-recommendation.controller.ts b/redisinsight/api/src/modules/database-recommendation/database-recommendation.controller.ts index c236f73932..760defbf95 100644 --- a/redisinsight/api/src/modules/database-recommendation/database-recommendation.controller.ts +++ b/redisinsight/api/src/modules/database-recommendation/database-recommendation.controller.ts @@ -96,7 +96,7 @@ export class DatabaseRecommendationController { { status: 200, description: 'Delete many recommendations by ids response', - type: DeleteDatabaseRecommendationDto, + type: DeleteDatabaseRecommendationResponse, }, ], }) diff --git a/redisinsight/api/src/modules/database-recommendation/models/database-recommendation-params.ts b/redisinsight/api/src/modules/database-recommendation/models/database-recommendation-params.ts index 71f0f0b6a0..2b139f3994 100644 --- a/redisinsight/api/src/modules/database-recommendation/models/database-recommendation-params.ts +++ b/redisinsight/api/src/modules/database-recommendation/models/database-recommendation-params.ts @@ -1,7 +1,12 @@ import { RedisString } from 'src/common/constants'; -import { IsRedisString, RedisStringType } from 'src/common/decorators'; +import { + ApiRedisString, + IsRedisString, + RedisStringType, +} from 'src/common/decorators'; export class DatabaseRecommendationParams { + @ApiRedisString('keys', true) @IsRedisString({ each: true }) @RedisStringType({ each: true }) keys?: RedisString[]; diff --git a/redisinsight/api/src/modules/database/models/database.ts b/redisinsight/api/src/modules/database/models/database.ts index a51d8c2faa..36052c265a 100644 --- a/redisinsight/api/src/modules/database/models/database.ts +++ b/redisinsight/api/src/modules/database/models/database.ts @@ -144,7 +144,7 @@ export class Database { @ApiProperty({ description: 'Time of the last connection to the database.', - type: String, + type: Date, format: 'date-time', example: '2021-01-06T12:44:39.000Z', }) diff --git a/redisinsight/api/src/modules/pub-sub/dto/message.dto.ts b/redisinsight/api/src/modules/pub-sub/dto/message.dto.ts new file mode 100644 index 0000000000..7d28f8f1f5 --- /dev/null +++ b/redisinsight/api/src/modules/pub-sub/dto/message.dto.ts @@ -0,0 +1,22 @@ +import { ApiProperty } from '@nestjs/swagger'; +import { IMessage } from 'src/modules/pub-sub/interfaces/message.interface'; + +export class MessageDto implements IMessage { + @ApiProperty({ + description: 'Message content', + type: String, + }) + message: string; + + @ApiProperty({ + description: 'Channel name', + type: String, + }) + channel: string; + + @ApiProperty({ + description: 'Timestamp', + type: Number, + }) + time: number; +} diff --git a/redisinsight/api/src/modules/pub-sub/dto/messages.response.ts b/redisinsight/api/src/modules/pub-sub/dto/messages.response.ts index e02ea99aa4..406d65641d 100644 --- a/redisinsight/api/src/modules/pub-sub/dto/messages.response.ts +++ b/redisinsight/api/src/modules/pub-sub/dto/messages.response.ts @@ -1,7 +1,17 @@ +import { ApiProperty } from '@nestjs/swagger'; import { IMessage } from 'src/modules/pub-sub/interfaces/message.interface'; +import { MessageDto } from './message.dto'; export class MessagesResponse { + @ApiProperty({ + description: 'Array of messages.', + type: [MessageDto], + }) messages: IMessage[]; + @ApiProperty({ + description: 'Number of messages.', + type: Number, + }) count: number; } diff --git a/redisinsight/api/src/modules/pub-sub/dto/publish.response.ts b/redisinsight/api/src/modules/pub-sub/dto/publish.response.ts index 85b3fbbd39..e9e3304ee6 100644 --- a/redisinsight/api/src/modules/pub-sub/dto/publish.response.ts +++ b/redisinsight/api/src/modules/pub-sub/dto/publish.response.ts @@ -1,3 +1,9 @@ +import { ApiProperty } from '@nestjs/swagger'; + export class PublishResponse { + @ApiProperty({ + description: 'Number of clients message ws delivered', + type: Number, + }) affected: number; } diff --git a/redisinsight/api/src/modules/slow-log/slow-log.controller.ts b/redisinsight/api/src/modules/slow-log/slow-log.controller.ts index 9e22a3c74e..2f85b43705 100644 --- a/redisinsight/api/src/modules/slow-log/slow-log.controller.ts +++ b/redisinsight/api/src/modules/slow-log/slow-log.controller.ts @@ -41,7 +41,7 @@ export class SlowLogController { }) clientMetadata: ClientMetadata, @Query() getSlowLogsDto: GetSlowLogsDto, - ): Promise { + ): Promise { return this.service.getSlowLogs(clientMetadata, getSlowLogsDto); } diff --git a/redisinsight/api/test/api/deps.ts b/redisinsight/api/test/api/deps.ts index 53d6fcde93..b044d1bf47 100644 --- a/redisinsight/api/test/api/deps.ts +++ b/redisinsight/api/test/api/deps.ts @@ -37,6 +37,7 @@ global['jest'] = { fn: dummyJest, }; +// @ts-ignore global['expect'] = { any: () => {}, }; diff --git a/redisinsight/api/test/api/plugins/POST-databases-id-plugins-command_executions.test.ts b/redisinsight/api/test/api/plugins/POST-databases-id-plugins-command_executions.test.ts index deace2d759..6c10927631 100644 --- a/redisinsight/api/test/api/plugins/POST-databases-id-plugins-command_executions.test.ts +++ b/redisinsight/api/test/api/plugins/POST-databases-id-plugins-command_executions.test.ts @@ -227,8 +227,8 @@ describe('POST /databases/:instanceId/plugins/command-executions', () => { checkFn: async ({ body }) => { expect(body.result.length).to.eql(1); - // @ts-expect-error const count = await repo.count({ + // @ts-expect-error databaseId: constants.TEST_INSTANCE_ID, }); expect(count).to.lte(30); diff --git a/redisinsight/api/test/helpers/server.ts b/redisinsight/api/test/helpers/server.ts index b743b31d33..74f13ee262 100644 --- a/redisinsight/api/test/helpers/server.ts +++ b/redisinsight/api/test/helpers/server.ts @@ -49,6 +49,7 @@ export const getServer = async () => { const app = moduleFixture.createNestApplication(); // set qs as parser to support nested objects in the query string + // @ts-expect-error TODO: check if method is deprecated app.set('query parser', qs.parse); app.use(bodyParser.json({ limit: '512mb' })); app.use(bodyParser.urlencoded({ limit: '512mb', extended: true })); diff --git a/redisinsight/api/tsconfig.json b/redisinsight/api/tsconfig.json index 76d0ec4972..11bb9a8079 100644 --- a/redisinsight/api/tsconfig.json +++ b/redisinsight/api/tsconfig.json @@ -15,7 +15,6 @@ "incremental": true, "paths": { "src/*": ["src/*"], - "apiSrc/*": ["src/*"], "tests/*": ["__tests__/*"] } } diff --git a/redisinsight/api/yarn.lock b/redisinsight/api/yarn.lock index 96561de864..a3fda6a16c 100644 --- a/redisinsight/api/yarn.lock +++ b/redisinsight/api/yarn.lock @@ -494,6 +494,11 @@ dependencies: regenerator-runtime "^0.14.0" +"@babel/runtime@^7.21.0": + version "7.27.6" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.27.6.tgz#ec4070a04d76bae8ddbb10770ba55714a417b7c6" + integrity sha512-vbavdySgbTTrmFE+EsiqUTzlOr5bzlnJtUv9PynGCAKvfQqjIXbvFdumPM/GxMDfyuGMJaJAU6TO4zc1Jf1i8Q== + "@babel/template@^7.22.15", "@babel/template@^7.3.3": version "7.22.15" resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.22.15.tgz#09576efc3830f0430f4548ef971dde1350ef2f38" @@ -1064,6 +1069,18 @@ resolved "https://registry.yarnpkg.com/@ioredis/commands/-/commands-1.2.0.tgz#6d61b3097470af1fdbbe622795b8921d42018e11" integrity sha512-Sx1pU8EM64o2BrqNpEO1CNLtKQwyhuXuqyfH7oGKCk+1a33d2r5saW8zNwm3j6BTExtjrv2BxTgzzkMwts6vGg== +"@isaacs/balanced-match@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz#3081dadbc3460661b751e7591d7faea5df39dd29" + integrity sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ== + +"@isaacs/brace-expansion@^5.0.0": + version "5.0.0" + resolved "https://registry.yarnpkg.com/@isaacs/brace-expansion/-/brace-expansion-5.0.0.tgz#4b3dabab7d8e75a429414a96bd67bf4c1d13e0f3" + integrity sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA== + dependencies: + "@isaacs/balanced-match" "^4.0.1" + "@isaacs/cliui@^8.0.2": version "8.0.2" resolved "https://registry.yarnpkg.com/@isaacs/cliui/-/cliui-8.0.2.tgz#b37667b7bc181c168782259bab42474fbf52b550" @@ -1391,6 +1408,11 @@ resolved "https://registry.yarnpkg.com/@mochajs/json-file-reporter/-/json-file-reporter-1.3.0.tgz#63a53bcda93d75f5c5c74af60e45da063931370b" integrity sha512-evIxpeP8EOixo/T2xh5xYEIzwbEHk8YNJfRUm1KeTs8F3bMjgNn2580Ogze9yisXNlTxu88JiJJYzXjjg5NdLA== +"@nestjs/axios@4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@nestjs/axios/-/axios-4.0.0.tgz#520ff7c6238e635658fe334ee62db9d1b9c5546f" + integrity sha512-1cB+Jyltu/uUPNQrpUimRHEQHrnQrpLzVj6dU3dgn6iDDDdahr10TgHFGTmw5VuJ9GzKZsCLDL78VSwJAs/9JQ== + "@nestjs/cli@^11.0.6": version "11.0.6" resolved "https://registry.yarnpkg.com/@nestjs/cli/-/cli-11.0.6.tgz#0ca7bd9a13499d5c42bfba82f33a49542bfdfc52" @@ -1416,6 +1438,17 @@ webpack "5.98.0" webpack-node-externals "3.0.0" +"@nestjs/common@11.1.3": + version "11.1.3" + resolved "https://registry.yarnpkg.com/@nestjs/common/-/common-11.1.3.tgz#d954644da5f4d1b601e48ee71a0d3e3405d81ea1" + integrity sha512-ogEK+GriWodIwCw6buQ1rpcH4Kx+G7YQ9EwuPySI3rS05pSdtQ++UhucjusSI9apNidv+QURBztJkRecwwJQXg== + dependencies: + uid "2.0.2" + file-type "21.0.0" + iterare "1.2.1" + load-esm "1.0.2" + tslib "2.8.1" + "@nestjs/common@^11.0.20": version "11.0.20" resolved "https://registry.yarnpkg.com/@nestjs/common/-/common-11.0.20.tgz#e67e73f261ee79a0c4daa2c303712731667d0129" @@ -1427,6 +1460,18 @@ load-esm "1.0.2" tslib "2.8.1" +"@nestjs/core@11.1.3": + version "11.1.3" + resolved "https://registry.yarnpkg.com/@nestjs/core/-/core-11.1.3.tgz#42a9c6261ff70ef49afa809c526134cae22021e8" + integrity sha512-5lTni0TCh8x7bXETRD57pQFnKnEg1T6M+VLE7wAmyQRIecKQU+2inRGZD+A4v2DC1I04eA0WffP0GKLxjOKlzw== + dependencies: + uid "2.0.2" + "@nuxt/opencollective" "0.4.1" + fast-safe-stringify "2.1.1" + iterare "1.2.1" + path-to-regexp "8.2.0" + tslib "2.8.1" + "@nestjs/core@^11.0.20": version "11.0.20" resolved "https://registry.yarnpkg.com/@nestjs/core/-/core-11.0.20.tgz#1a053474d0128b4ba8d2edd136add6854bb09f4c" @@ -1576,6 +1621,15 @@ dependencies: consola "^3.2.3" +"@nuxtjs/opencollective@0.3.2": + version "0.3.2" + resolved "https://registry.yarnpkg.com/@nuxtjs/opencollective/-/opencollective-0.3.2.tgz#620ce1044f7ac77185e825e1936115bb38e2681c" + integrity sha512-um0xL3fO7Mf4fDxcqx9KryrB7zgRM5JSlvGN5AGkP6JLM5XEKyjeAiPbNxdXVXQ16isuAhYpvP88NgL2BGd6aA== + dependencies: + chalk "^4.1.0" + consola "^2.15.0" + node-fetch "^2.6.1" + "@okta/okta-auth-js@^7.12.1": version "7.12.1" resolved "https://registry.yarnpkg.com/@okta/okta-auth-js/-/okta-auth-js-7.12.1.tgz#876b57d08c43b7cf6cae0d749e8edb9817daea57" @@ -1597,6 +1651,30 @@ webcrypto-shim "^0.1.5" xhr2 "0.1.3" +"@openapitools/openapi-generator-cli@^2.21.0": + version "2.21.0" + resolved "https://registry.yarnpkg.com/@openapitools/openapi-generator-cli/-/openapi-generator-cli-2.21.0.tgz#70732e0e771e337bac0f290895340256ee90c96d" + integrity sha512-NdDvCd7hya+UucxH7G94Jf6tmA6641I4CF/T3xtFhM+NQQNWAP5tpiOBN4Ub9ocU6cCgQgXdWl4EpwlEwW7JDQ== + dependencies: + "@nestjs/axios" "4.0.0" + "@nestjs/common" "11.1.3" + "@nestjs/core" "11.1.3" + "@nuxtjs/opencollective" "0.3.2" + axios "1.10.0" + chalk "4.1.2" + commander "8.3.0" + compare-versions "4.1.4" + concurrently "6.5.1" + console.table "0.10.0" + fs-extra "11.3.0" + glob "11.0.3" + inquirer "8.2.6" + lodash "4.17.21" + proxy-agent "6.5.0" + reflect-metadata "0.2.2" + rxjs "7.8.2" + tslib "2.8.1" + "@peculiar/asn1-schema@^2.3.6": version "2.3.6" resolved "https://registry.yarnpkg.com/@peculiar/asn1-schema/-/asn1-schema-2.3.6.tgz#3dd3c2ade7f702a9a94dfb395c192f5fa5d6b922" @@ -1744,7 +1822,7 @@ resolved "https://registry.yarnpkg.com/@sqltools/formatter/-/formatter-1.2.5.tgz#3abc203c79b8c3e90fd6c156a0c62d5403520e12" integrity sha512-Uy0+khmZqUrUGm5dmMqVlnvufZRSK0FbYzVgp0UMstm+F5+W2/jnEEQyc9vo1ZR/E5ZI/B1WjjoTqBqwJL6Krw== -"@tokenizer/inflate@^0.2.6": +"@tokenizer/inflate@^0.2.6", "@tokenizer/inflate@^0.2.7": version "0.2.7" resolved "https://registry.yarnpkg.com/@tokenizer/inflate/-/inflate-0.2.7.tgz#32dd9dfc9abe457c89b3d9b760fc0690c85a103b" integrity sha512-MADQgmZT1eKjp06jpI2yozxaU9uVs4GzzgSL+uEq7bVcJ9V1ZXQkeGNql1fsSI0gMy1vhvNTNbUqrx+pZfJVmg== @@ -1763,6 +1841,11 @@ resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-1.1.2.tgz#ccb91445360179a04e7fe6aff78c00ffc1eeaf82" integrity sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw== +"@tootallnate/quickjs-emscripten@^0.23.0": + version "0.23.0" + resolved "https://registry.yarnpkg.com/@tootallnate/quickjs-emscripten/-/quickjs-emscripten-0.23.0.tgz#db4ecfd499a9765ab24002c3b696d02e6d32a12c" + integrity sha512-C5Mc6rdnsaJDjO3UpGW/CQTHtCKaYlScZTly4JIu97Jxo/odCiH0ITnDXSJPTOrEKk/ycSZ0AOgTmkDtkOsvIA== + "@tsconfig/node10@^1.0.7": version "1.0.11" resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.11.tgz#6ee46400685f130e278128c7b38b7e031ff5b2f2" @@ -2413,6 +2496,11 @@ agent-base@6, agent-base@^6.0.2: dependencies: debug "4" +agent-base@^7.1.0, agent-base@^7.1.2: + version "7.1.4" + resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-7.1.4.tgz#e3cd76d4c548ee895d3c3fd8dc1f6c5b9032e7a8" + integrity sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ== + agentkeepalive@^4.1.3: version "4.5.0" resolved "https://registry.yarnpkg.com/agentkeepalive/-/agentkeepalive-4.5.0.tgz#2673ad1389b3c418c5a20c5d7364f93ca04be923" @@ -2675,6 +2763,13 @@ assertion-error@^1.1.0: resolved "https://registry.yarnpkg.com/assertion-error/-/assertion-error-1.1.0.tgz#e60b6b0e8f301bd97e5375215bda406c85118c0b" integrity sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw== +ast-types@^0.13.4: + version "0.13.4" + resolved "https://registry.yarnpkg.com/ast-types/-/ast-types-0.13.4.tgz#ee0d77b343263965ecc3fb62da16e7222b2b6782" + integrity sha512-x1FCFnFifvYDDzTaLII71vG5uvDwgtmDTEVWAxrgeiR8VjMONcCXJx7E+USjDtHlwFmt9MysbqgF9b9Vjr6w+w== + dependencies: + tslib "^2.0.1" + astral-regex@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/astral-regex/-/astral-regex-2.0.0.tgz#483143c567aeed4785759c0865786dc77d7d2e31" @@ -2700,6 +2795,15 @@ available-typed-arrays@^1.0.5: resolved "https://registry.yarnpkg.com/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz#92f95616501069d07d10edb2fc37d3e1c65123b7" integrity sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw== +axios@1.10.0: + version "1.10.0" + resolved "https://registry.yarnpkg.com/axios/-/axios-1.10.0.tgz#af320aee8632eaf2a400b6a1979fa75856f38d54" + integrity sha512-/1xYAC4MP/HEG+3duIhFr4ZQXR4sQXOIe+o6sdqzeykGLx6Upp/1p8MHqhINOvGeP7xyNHe7tsiJByc4SSVUxw== + dependencies: + follow-redirects "^1.15.6" + form-data "^4.0.0" + proxy-from-env "^1.1.0" + axios@^1.8.4: version "1.8.4" resolved "https://registry.yarnpkg.com/axios/-/axios-1.8.4.tgz#78990bb4bc63d2cae072952d374835950a82f447" @@ -2784,6 +2888,11 @@ base64id@2.0.0, base64id@~2.0.0: resolved "https://registry.yarnpkg.com/base64id/-/base64id-2.0.0.tgz#2770ac6bc47d312af97a8bf9a634342e0cd25cb6" integrity sha512-lGe34o6EHj9y3Kts9R4ZYs/Gr+6N7MCaMlIFA3F1R2O5/m7K06AxfSeO5530PEERE6/WyEg3lsuyw4GHlPZHog== +basic-ftp@^5.0.2: + version "5.0.5" + resolved "https://registry.yarnpkg.com/basic-ftp/-/basic-ftp-5.0.5.tgz#14a474f5fffecca1f4f406f1c26b18f800225ac0" + integrity sha512-4Bcg1P8xhUuqcii/S0Z9wiHIrQVPMermM1any+MX5GeGD7faD3/msQUDGLol9wOcz4/jbg/WJnGqoJF6LiBdtg== + bcrypt-pbkdf@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz#a4301d389b6a43f9b67ff3ca11a3f6637e360e9e" @@ -2972,7 +3081,7 @@ buffer@^6.0.3: base64-js "^1.3.1" ieee754 "^1.2.1" -busboy@^1.0.0, busboy@^1.6.0: +busboy@^1.6.0: version "1.6.0" resolved "https://registry.yarnpkg.com/busboy/-/busboy-1.6.0.tgz#966ea36a9502e43cdb9146962523b92f531f6893" integrity sha512-8SFQbg/0hQ9xy3UNTB0YEnsNBbWfhf7RtnzpL7TkBiTBRfrQ9Fxcnz7VJsleJpyp6rVLvXiuORqjlHi5q+PYuA== @@ -3096,6 +3205,14 @@ chai@^4.3.4: pathval "^1.1.1" type-detect "^4.0.8" +chalk@4.1.2, chalk@^4.0.0, chalk@^4.0.2, chalk@^4.1.0, chalk@^4.1.1, chalk@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" + integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + chalk@^2.0.0, chalk@^2.3.0, chalk@^2.4.2: version "2.4.2" resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" @@ -3105,14 +3222,6 @@ chalk@^2.0.0, chalk@^2.3.0, chalk@^2.4.2: escape-string-regexp "^1.0.5" supports-color "^5.3.0" -chalk@^4.0.0, chalk@^4.0.2, chalk@^4.1.0, chalk@^4.1.2: - version "4.1.2" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" - integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== - dependencies: - ansi-styles "^4.1.0" - supports-color "^7.1.0" - char-regex@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf" @@ -3219,6 +3328,11 @@ cli-table3@0.6.5: optionalDependencies: "@colors/colors" "1.5.0" +cli-width@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-3.0.0.tgz#a2f48437a2caa9a22436e794bf071ec9e61cedf6" + integrity sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw== + cli-width@^4.1.0: version "4.1.0" resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-4.1.0.tgz#42daac41d3c254ef38ad8ac037672130173691c5" @@ -3355,6 +3469,11 @@ commander@4.1.1: resolved "https://registry.yarnpkg.com/commander/-/commander-4.1.1.tgz#9fd602bd936294e9e9ef46a3f4d6964044b18068" integrity sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA== +commander@8.3.0: + version "8.3.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66" + integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww== + commander@^2.20.0: version "2.20.3" resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" @@ -3376,6 +3495,11 @@ commondir@^1.0.1: resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b" integrity sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg== +compare-versions@4.1.4: + version "4.1.4" + resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-4.1.4.tgz#3571f4d610924d4414846a4183d386c8f3d51112" + integrity sha512-FemMreK9xNyL8gQevsdRMrvO4lFCkQP7qbuktn1q8ndcNk1+0mz7lgE7b/sNvbhVgY4w6tMN1FDp6aADjqw2rw== + component-emitter@^1.2.0, component-emitter@^1.3.0: version "1.3.0" resolved "https://registry.yarnpkg.com/component-emitter/-/component-emitter-1.3.0.tgz#16e4070fba8ae29b679f2215853ee181ab2eabc0" @@ -3396,6 +3520,20 @@ concat-stream@^2.0.0: readable-stream "^3.0.2" typedarray "^0.0.6" +concurrently@6.5.1: + version "6.5.1" + resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-6.5.1.tgz#4518c67f7ac680cf5c34d5adf399a2a2047edc8c" + integrity sha512-FlSwNpGjWQfRwPLXvJ/OgysbBxPkWpiVjy1042b0U7on7S7qwwMIILRj7WTN1mTgqa582bG6NFuScOoh6Zgdag== + dependencies: + chalk "^4.1.0" + date-fns "^2.16.1" + lodash "^4.17.21" + rxjs "^6.6.3" + spawn-command "^0.0.2-1" + supports-color "^8.1.0" + tree-kill "^1.2.2" + yargs "^16.2.0" + concurrently@^5.3.0: version "5.3.0" resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-5.3.0.tgz#7500de6410d043c912b2da27de3202cb489b1e7b" @@ -3426,6 +3564,11 @@ connect-timeout@^1.9.0: on-finished "~2.3.0" on-headers "~1.0.1" +consola@^2.15.0: + version "2.15.3" + resolved "https://registry.yarnpkg.com/consola/-/consola-2.15.3.tgz#2e11f98d6a4be71ff72e0bdf07bd23e12cb61550" + integrity sha512-9vAdYbHj6x2fLKC4+oPH0kFzY/orMZyG2Aj+kNylHxKGJ/Ed4dpNyAQYwJOdqO4zdM7XpVHmyejQDcQHrnuXbw== + consola@^3.2.3: version "3.4.0" resolved "https://registry.yarnpkg.com/consola/-/consola-3.4.0.tgz#4cfc9348fd85ed16a17940b3032765e31061ab88" @@ -3436,6 +3579,13 @@ console-control-strings@^1.1.0: resolved "https://registry.yarnpkg.com/console-control-strings/-/console-control-strings-1.1.0.tgz#3d7cf4464db6446ea644bf4b39507f9851008e8e" integrity sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ== +console.table@0.10.0: + version "0.10.0" + resolved "https://registry.yarnpkg.com/console.table/-/console.table-0.10.0.tgz#0917025588875befd70cf2eff4bef2c6e2d75d04" + integrity sha512-dPyZofqggxuvSf7WXvNjuRfnsOk1YazkVP8FdxH4tcH2c37wc79/Yl6Bhr7Lsu00KMgy2ql/qCMuNu8xctZM8g== + dependencies: + easy-table "1.1.0" + content-disposition@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-1.0.0.tgz#844426cb398f934caefcbb172200126bc7ceace2" @@ -3548,7 +3698,7 @@ cross-fetch@^4.0.0: dependencies: node-fetch "^2.6.12" -cross-spawn@^7.0.0, cross-spawn@^7.0.1, cross-spawn@^7.0.2, cross-spawn@^7.0.3, cross-spawn@^7.0.5: +cross-spawn@^7.0.0, cross-spawn@^7.0.1, cross-spawn@^7.0.2, cross-spawn@^7.0.3, cross-spawn@^7.0.5, cross-spawn@^7.0.6: version "7.0.6" resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f" integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA== @@ -3562,11 +3712,23 @@ crypt@0.0.2: resolved "https://registry.yarnpkg.com/crypt/-/crypt-0.0.2.tgz#88d7ff7ec0dfb86f713dc87bbb42d044d3e6c41b" integrity sha512-mCxBlsHFYh9C+HVpiEacem8FEBnMXgU9gy4zmNC+SXAZNB/1idgp/aulFJ4FgCi7GPEVbfyng092GqL2k2rmow== +data-uri-to-buffer@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/data-uri-to-buffer/-/data-uri-to-buffer-6.0.2.tgz#8a58bb67384b261a38ef18bea1810cb01badd28b" + integrity sha512-7hvf7/GW8e86rW0ptuwS3OcBGDjIi6SZva7hCyWC0yYry2cOPmLIjXAUHI6DK2HsnwJd9ifmt57i8eV2n4YNpw== + date-fns@^2.0.1, date-fns@^2.29.3: version "2.29.3" resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.29.3.tgz#27402d2fc67eb442b511b70bbdf98e6411cd68a8" integrity sha512-dDCnyH2WnnKusqvZZ6+jA1O51Ibt8ZMRNkDZdyAyK4YfbDwa/cEmuztzG5pk6hqlp9aSBPYcjOlktquahGwGeA== +date-fns@^2.16.1: + version "2.30.0" + resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.30.0.tgz#f367e644839ff57894ec6ac480de40cae4b0f4d0" + integrity sha512-fnULvOpxnC5/Vg3NCiWelDsLiUc9bRwAPs/+LfTLNvetFCtCTN+yQz15C/fs4AwX1R9K5GLtLfn8QW+dWisaAw== + dependencies: + "@babel/runtime" "^7.21.0" + debug@2.6.9: version "2.6.9" resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f" @@ -3696,6 +3858,15 @@ define-properties@^1.1.3, define-properties@^1.1.4, define-properties@^1.2.0: has-property-descriptors "^1.0.0" object-keys "^1.1.1" +degenerator@^5.0.0: + version "5.0.1" + resolved "https://registry.yarnpkg.com/degenerator/-/degenerator-5.0.1.tgz#9403bf297c6dad9a1ece409b37db27954f91f2f5" + integrity sha512-TllpMR/t0M5sqCXfj85i4XaAzxmS5tVA16dqvdkMwGmzI+dXLXnw3J+3Vdv7VKw+ThlTMboK6i9rnZ6Nntj5CQ== + dependencies: + ast-types "^0.13.4" + escodegen "^2.1.0" + esprima "^4.0.1" + delayed-stream@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" @@ -3804,6 +3975,13 @@ eastasianwidth@^0.2.0: resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" integrity sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA== +easy-table@1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/easy-table/-/easy-table-1.1.0.tgz#86f9ab4c102f0371b7297b92a651d5824bc8cb73" + integrity sha512-oq33hWOSSnl2Hoh00tZWaIPi1ievrD9aFG82/IgjlycAnW9hHx5PkJiXpxPsgEE+H7BsbVQXFVFST8TEXS6/pA== + optionalDependencies: + wcwidth ">=1.0.1" + ecdsa-sig-formatter@1.0.11: version "1.0.11" resolved "https://registry.yarnpkg.com/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz#ae0f0fa2d85045ef14a817daa3ce9acd0489e5bf" @@ -4135,6 +4313,17 @@ escape-string-regexp@^4.0.0: resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== +escodegen@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/escodegen/-/escodegen-2.1.0.tgz#ba93bbb7a43986d29d6041f99f5262da773e2e17" + integrity sha512-2NlIDTwUWJN0mRPQOdtQBzbUHvdGY2P1VXSyU83Q3xKxM7WHX2Ql8dKq782Q9TgQUNOLEzEYu9bzLNj1q88I5w== + dependencies: + esprima "^4.0.1" + estraverse "^5.2.0" + esutils "^2.0.2" + optionalDependencies: + source-map "~0.6.1" + eslint-config-airbnb-base@^14.2.0, eslint-config-airbnb-base@^14.2.1: version "14.2.1" resolved "https://registry.yarnpkg.com/eslint-config-airbnb-base/-/eslint-config-airbnb-base-14.2.1.tgz#8a2eb38455dc5a312550193b319cdaeef042cd1e" @@ -4467,7 +4656,7 @@ extend@^3.0.0: resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.2.tgz#f8b1136b4071fbd8eb140aff858b1019ec2915fa" integrity sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g== -external-editor@^3.1.0: +external-editor@^3.0.3, external-editor@^3.1.0: version "3.1.0" resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-3.1.0.tgz#cb03f740befae03ea4d283caed2741a83f335495" integrity sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew== @@ -4555,6 +4744,13 @@ fflate@^0.8.2: resolved "https://registry.yarnpkg.com/fflate/-/fflate-0.8.2.tgz#fc8631f5347812ad6028bbe4a2308b2792aa1dea" integrity sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A== +figures@^3.0.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af" + integrity sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== + dependencies: + escape-string-regexp "^1.0.5" + file-entry-cache@^6.0.1: version "6.0.1" resolved "https://registry.yarnpkg.com/file-entry-cache/-/file-entry-cache-6.0.1.tgz#211b2dd9659cb0394b073e7323ac3c933d522027" @@ -4577,6 +4773,16 @@ file-type@20.4.1: token-types "^6.0.0" uint8array-extras "^1.4.0" +file-type@21.0.0: + version "21.0.0" + resolved "https://registry.yarnpkg.com/file-type/-/file-type-21.0.0.tgz#b6c5990064bc4b704f8e5c9b6010c59064d268bc" + integrity sha512-ek5xNX2YBYlXhiUXui3D/BXa3LdqPmoLJ7rqEx2bKJ7EAUEfmXgW0Das7Dc6Nr9MvqaOnIqiPV0mZk/r/UpNAg== + dependencies: + "@tokenizer/inflate" "^0.2.7" + strtok3 "^10.2.2" + token-types "^6.0.0" + uint8array-extras "^1.4.0" + file-type@^16.5.4: version "16.5.4" resolved "https://registry.yarnpkg.com/file-type/-/file-type-16.5.4.tgz#474fb4f704bee427681f98dd390058a172a6c2fd" @@ -4713,6 +4919,14 @@ foreground-child@^3.1.0: cross-spawn "^7.0.0" signal-exit "^4.0.1" +foreground-child@^3.3.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/foreground-child/-/foreground-child-3.3.1.tgz#32e8e9ed1b68a3497befb9ac2b6adf92a638576f" + integrity sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw== + dependencies: + cross-spawn "^7.0.6" + signal-exit "^4.0.1" + fork-ts-checker-webpack-plugin@9.1.0: version "9.1.0" resolved "https://registry.yarnpkg.com/fork-ts-checker-webpack-plugin/-/fork-ts-checker-webpack-plugin-9.1.0.tgz#433481c1c228c56af111172fcad7df79318c915a" @@ -4779,6 +4993,15 @@ fs-constants@^1.0.0: resolved "https://registry.yarnpkg.com/fs-constants/-/fs-constants-1.0.0.tgz#6be0de9be998ce16af8afc24497b9ee9b7ccd9ad" integrity sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow== +fs-extra@11.3.0: + version "11.3.0" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-11.3.0.tgz#0daced136bbaf65a555a326719af931adc7a314d" + integrity sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew== + dependencies: + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + fs-extra@^10.0.0: version "10.1.0" resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-10.1.0.tgz#02873cfbc4084dde127eaa5f9905eef2325d1abf" @@ -4936,6 +5159,15 @@ get-symbol-description@^1.0.0: call-bind "^1.0.2" get-intrinsic "^1.1.1" +get-uri@^6.0.1: + version "6.0.5" + resolved "https://registry.yarnpkg.com/get-uri/-/get-uri-6.0.5.tgz#714892aa4a871db671abc5395e5e9447bc306a16" + integrity sha512-b1O07XYq8eRuVzBNgJLstU6FYc1tS6wnMtF1I1D9lE8LxZSOGZ7LhxN54yPP6mGw5f2CkXY2BQUL9Fx41qvcIg== + dependencies: + basic-ftp "^5.0.2" + data-uri-to-buffer "^6.0.2" + debug "^4.3.4" + github-from-package@0.0.0: version "0.0.0" resolved "https://registry.yarnpkg.com/github-from-package/-/github-from-package-0.0.0.tgz#97fb5d96bfde8973313f20e8288ef9a167fa64ce" @@ -4965,6 +5197,18 @@ glob@11.0.1: package-json-from-dist "^1.0.0" path-scurry "^2.0.0" +glob@11.0.3: + version "11.0.3" + resolved "https://registry.yarnpkg.com/glob/-/glob-11.0.3.tgz#9d8087e6d72ddb3c4707b1d2778f80ea3eaefcd6" + integrity sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA== + dependencies: + foreground-child "^3.3.1" + jackspeak "^4.1.1" + minimatch "^10.0.3" + minipass "^7.1.2" + package-json-from-dist "^1.0.0" + path-scurry "^2.0.0" + glob@^10.4.5: version "10.4.5" resolved "https://registry.yarnpkg.com/glob/-/glob-10.4.5.tgz#f4d9f0b90ffdbab09c9d77f5f29b4262517b0956" @@ -5189,6 +5433,14 @@ http-proxy-agent@^4.0.1: agent-base "6" debug "4" +http-proxy-agent@^7.0.0, http-proxy-agent@^7.0.1: + version "7.0.2" + resolved "https://registry.yarnpkg.com/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz#9a8b1f246866c028509486585f62b8f2c18c270e" + integrity sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig== + dependencies: + agent-base "^7.1.0" + debug "^4.3.4" + https-proxy-agent@^5.0.0: version "5.0.1" resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz#c59ef224a04fe8b754f3db0063a25ea30d0005d6" @@ -5197,6 +5449,14 @@ https-proxy-agent@^5.0.0: agent-base "6" debug "4" +https-proxy-agent@^7.0.6: + version "7.0.6" + resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz#da8dfeac7da130b05c2ba4b59c9b6cd66611a6b9" + integrity sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw== + dependencies: + agent-base "^7.1.2" + debug "4" + human-signals@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" @@ -5299,6 +5559,27 @@ ini@~1.3.0: resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.8.tgz#a29da425b48806f34767a4efce397269af28432c" integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== +inquirer@8.2.6: + version "8.2.6" + resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-8.2.6.tgz#733b74888195d8d400a67ac332011b5fae5ea562" + integrity sha512-M1WuAmb7pn9zdFRtQYk26ZBoY043Sse0wVDdk4Bppr+JOXyQYybdtvK+l9wUibhtjdjvtoiNy8tk+EgsYIUqKg== + dependencies: + ansi-escapes "^4.2.1" + chalk "^4.1.1" + cli-cursor "^3.1.0" + cli-width "^3.0.0" + external-editor "^3.0.3" + figures "^3.0.0" + lodash "^4.17.21" + mute-stream "0.0.8" + ora "^5.4.1" + run-async "^2.4.0" + rxjs "^7.5.5" + string-width "^4.1.0" + strip-ansi "^6.0.0" + through "^2.3.6" + wrap-ansi "^6.0.1" + internal-slot@^1.0.5: version "1.0.5" resolved "https://registry.yarnpkg.com/internal-slot/-/internal-slot-1.0.5.tgz#f2a2ee21f668f8627a4667f309dc0f4fb6674986" @@ -5696,6 +5977,13 @@ jackspeak@^4.0.1: dependencies: "@isaacs/cliui" "^8.0.2" +jackspeak@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/jackspeak/-/jackspeak-4.1.1.tgz#96876030f450502047fc7e8c7fcf8ce8124e43ae" + integrity sha512-zptv57P3GpL+O0I7VdMJNBZCu+BPHVQUk55Ft8/QCJjTVxrnJHuVuX/0Bl2A6/+2oyR/ZMEuFKwmzqqZ/U5nPQ== + dependencies: + "@isaacs/cliui" "^8.0.2" + jake@^10.8.5: version "10.9.2" resolved "https://registry.yarnpkg.com/jake/-/jake-10.9.2.tgz#6ae487e6a69afec3a5e167628996b59f35ae2b7f" @@ -6456,6 +6744,11 @@ lru-cache@^6.0.0: dependencies: yallist "^4.0.0" +lru-cache@^7.14.1: + version "7.18.3" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.18.3.tgz#f793896e0fd0e954a59dfdd82f0773808df6aa89" + integrity sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA== + magic-string@0.30.17: version "0.30.17" resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.30.17.tgz#450a449673d2460e5bbcfba9a61916a1714c7453" @@ -6636,6 +6929,13 @@ minimatch@^10.0.0: dependencies: brace-expansion "^2.0.1" +minimatch@^10.0.3: + version "10.0.3" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-10.0.3.tgz#cf7a0314a16c4d9ab73a7730a0e8e3c3502d47aa" + integrity sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw== + dependencies: + "@isaacs/brace-expansion" "^5.0.0" + minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1, minimatch@^3.1.2, minimatch@^5.1.6: version "3.1.2" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" @@ -6731,7 +7031,7 @@ mkdirp-classic@^0.5.2, mkdirp-classic@^0.5.3: resolved "https://registry.yarnpkg.com/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz#fa10c9115cc6d8865be221ba47ee9bed78601113" integrity sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A== -mkdirp@^0.5.4: +mkdirp@^0.5.6: version "0.5.6" resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.6.tgz#7def03d2432dcae4ba1d611445c48396062255f6" integrity sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw== @@ -6813,18 +7113,23 @@ ms@^2.0.0, ms@^2.1.1, ms@^2.1.3: resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== -multer@2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/multer/-/multer-2.0.0.tgz#47076aa0f7c2c2fd273715e767c6962bf7f94326" - integrity sha512-bS8rPZurbAuHGAnApbM9d4h1wSoYqrOqkE+6a64KLMK9yWU7gJXBDDVklKQ3TPi9DRb85cRs6yXaC0+cjxRtRg== +multer@2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/multer/-/multer-2.0.1.tgz#3ed335ed2b96240e3df9e23780c91cfcf5d29202" + integrity sha512-Ug8bXeTIUlxurg8xLTEskKShvcKDZALo1THEX5E41pYCD2sCVub5/kIRIGqWNoqV6szyLyQKV6mD4QUrWE5GCQ== dependencies: append-field "^1.0.0" - busboy "^1.0.0" - concat-stream "^1.5.2" - mkdirp "^0.5.4" + busboy "^1.6.0" + concat-stream "^2.0.0" + mkdirp "^0.5.6" object-assign "^4.1.1" - type-is "^1.6.4" - xtend "^4.0.0" + type-is "^1.6.18" + xtend "^4.0.2" + +mute-stream@0.0.8: + version "0.0.8" + resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.8.tgz#1630c42b2251ff81e2a283de96a5497ea92e5e0d" + integrity sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA== mute-stream@^2.0.0: version "2.0.0" @@ -6894,6 +7199,11 @@ nestjs-form-data@~1.9.93: mkdirp "^1.0.4" type-is "^1.6.18" +netmask@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/netmask/-/netmask-2.0.2.tgz#8b01a07644065d536383835823bc52004ebac5e7" + integrity sha512-dBpDMdxv9Irdq66304OLfEmQ9tbNRFnFTuZiLo+bD+r332bBmMJ8GBLXklIXXgxd3+v9+KUnZaUR5PJMa75Gsg== + nock@^13.3.0: version "13.3.0" resolved "https://registry.yarnpkg.com/nock/-/nock-13.3.0.tgz#b13069c1a03f1ad63120f994b04bfd2556925768" @@ -6947,7 +7257,7 @@ node-fetch@2.6.12: dependencies: whatwg-url "^5.0.0" -node-fetch@^2.6.12, node-fetch@^2.6.7: +node-fetch@^2.6.1, node-fetch@^2.6.12, node-fetch@^2.6.7: version "2.7.0" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.7.0.tgz#d0f0fa6e3e2dc1d27efcd8ad99d550bda94d187d" integrity sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A== @@ -7203,7 +7513,7 @@ optionator@^0.9.1: type-check "^0.4.0" word-wrap "^1.2.3" -ora@5.4.1: +ora@5.4.1, ora@^5.4.1: version "5.4.1" resolved "https://registry.yarnpkg.com/ora/-/ora-5.4.1.tgz#1b2678426af4ac4a509008e5e4ac9e9959db9e18" integrity sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ== @@ -7302,6 +7612,28 @@ p-try@^2.0.0: resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== +pac-proxy-agent@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/pac-proxy-agent/-/pac-proxy-agent-7.2.0.tgz#9cfaf33ff25da36f6147a20844230ec92c06e5df" + integrity sha512-TEB8ESquiLMc0lV8vcd5Ql/JAKAoyzHFXaStwjkzpOpC5Yv+pIzLfHvjTSdf3vpa2bMiUQrg9i6276yn8666aA== + dependencies: + "@tootallnate/quickjs-emscripten" "^0.23.0" + agent-base "^7.1.2" + debug "^4.3.4" + get-uri "^6.0.1" + http-proxy-agent "^7.0.0" + https-proxy-agent "^7.0.6" + pac-resolver "^7.0.1" + socks-proxy-agent "^8.0.5" + +pac-resolver@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/pac-resolver/-/pac-resolver-7.0.1.tgz#54675558ea368b64d210fd9c92a640b5f3b8abb6" + integrity sha512-5NPgf87AT2STgwa2ntRMr45jTKrYBGkVU36yT0ig/n/GMAa3oPqhZfIQ2kMEimReg0+t9kZViDVZ83qfVUlckg== + dependencies: + degenerator "^5.0.0" + netmask "^2.0.2" + package-hash@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/package-hash/-/package-hash-4.0.0.tgz#3537f654665ec3cc38827387fc904c163c54f506" @@ -7593,6 +7925,20 @@ proxy-addr@^2.0.7, proxy-addr@~2.0.7: forwarded "0.2.0" ipaddr.js "1.9.1" +proxy-agent@6.5.0: + version "6.5.0" + resolved "https://registry.yarnpkg.com/proxy-agent/-/proxy-agent-6.5.0.tgz#9e49acba8e4ee234aacb539f89ed9c23d02f232d" + integrity sha512-TmatMXdr2KlRiA2CyDu8GqR8EjahTG3aY3nXjdzFyoZbmB8hrBsTyMezhULIXKnC0jpfjlmiZ3+EaCzoInSu/A== + dependencies: + agent-base "^7.1.2" + debug "^4.3.4" + http-proxy-agent "^7.0.1" + https-proxy-agent "^7.0.6" + lru-cache "^7.14.1" + pac-proxy-agent "^7.1.0" + proxy-from-env "^1.1.0" + socks-proxy-agent "^8.0.5" + proxy-from-env@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2" @@ -7747,7 +8093,7 @@ readable-stream@4.5.2: process "^0.11.10" string_decoder "^1.3.0" -readable-stream@^2.0.1, readable-stream@^2.2.2, readable-stream@^2.3.5: +readable-stream@^2.0.1, readable-stream@^2.3.5: version "2.3.8" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.8.tgz#91125e8042bba1b9887f49345f6277027ce8be9b" integrity sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA== @@ -7810,6 +8156,11 @@ redis@^4.6.10: "@redis/search" "1.1.5" "@redis/time-series" "1.0.5" +reflect-metadata@0.2.2: + version "0.2.2" + resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.2.2.tgz#400c845b6cba87a21f2c65c4aeb158f4fa4d9c5b" + integrity sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q== + reflect-metadata@^0.1.13: version "0.1.13" resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.1.13.tgz#67ae3ca57c972a2aa1642b10fe363fe32d49dc08" @@ -7946,6 +8297,11 @@ router@^2.2.0: parseurl "^1.3.3" path-to-regexp "^8.0.0" +run-async@^2.4.0: + version "2.4.1" + resolved "https://registry.yarnpkg.com/run-async/-/run-async-2.4.1.tgz#8440eccf99ea3e70bd409d49aab88e10c189a455" + integrity sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ== + run-parallel@^1.1.9: version "1.2.0" resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" @@ -7960,7 +8316,14 @@ rxjs@7.8.1, rxjs@^7.5.6: dependencies: tslib "^2.1.0" -rxjs@^6.5.2: +rxjs@7.8.2, rxjs@^7.5.5: + version "7.8.2" + resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-7.8.2.tgz#955bc473ed8af11a002a2be52071bf475638607b" + integrity sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA== + dependencies: + tslib "^2.1.0" + +rxjs@^6.5.2, rxjs@^6.6.3: version "6.6.7" resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-6.6.7.tgz#90ac018acabf491bf65044235d5863c4dab804c9" integrity sha512-hTdwr+7yYNIT5n4AMYp85KA6yw2Va0FLa3Rguvbpa4W3I5xynaBZo41cM3XM+4Q6fRMj3sBYIR1VAmZMXYJvRQ== @@ -8300,6 +8663,15 @@ socks-proxy-agent@^6.0.0: debug "^4.3.3" socks "^2.6.2" +socks-proxy-agent@^8.0.5: + version "8.0.5" + resolved "https://registry.yarnpkg.com/socks-proxy-agent/-/socks-proxy-agent-8.0.5.tgz#b9cdb4e7e998509d7659d689ce7697ac21645bee" + integrity sha512-HehCEsotFqbPW9sJ8WVYB6UbmIMv7kUUORIF2Nncq4VQvBfNBLibW9YZR5dlYCSUhwcD628pRllm7n+E+YTzJw== + dependencies: + agent-base "^7.1.2" + debug "^4.3.4" + socks "^2.8.3" + socks@^2.6.2: version "2.8.3" resolved "https://registry.yarnpkg.com/socks/-/socks-2.8.3.tgz#1ebd0f09c52ba95a09750afe3f3f9f724a800cb5" @@ -8308,6 +8680,14 @@ socks@^2.6.2: ip-address "^9.0.5" smart-buffer "^4.2.0" +socks@^2.8.3: + version "2.8.6" + resolved "https://registry.yarnpkg.com/socks/-/socks-2.8.6.tgz#e335486a2552f34f932f0c27d8dbb93f2be867aa" + integrity sha512-pe4Y2yzru68lXCb38aAqRf5gvN8YdjP1lok5o0J7BOHljkyCGKVz7H3vpVIXKD27rj2giOJ7DwVyk/GWrPHDWA== + dependencies: + ip-address "^9.0.5" + smart-buffer "^4.2.0" + source-map-support@0.5.13: version "0.5.13" resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.13.tgz#31b24a9c2e73c2de85066c0feb7d44767ed52932" @@ -8329,7 +8709,7 @@ source-map@0.7.4: resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.7.4.tgz#a9bbe705c9d8846f4e08ff6765acf0f1b0898656" integrity sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA== -source-map@^0.6.0, source-map@^0.6.1: +source-map@^0.6.0, source-map@^0.6.1, source-map@~0.6.1: version "0.6.1" resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== @@ -8600,6 +8980,13 @@ strtok3@^10.2.0: "@tokenizer/token" "^0.3.0" peek-readable "^7.0.0" +strtok3@^10.2.2: + version "10.3.1" + resolved "https://registry.yarnpkg.com/strtok3/-/strtok3-10.3.1.tgz#80fe431a4ee652de4e33f14e11e15fd5170a627d" + integrity sha512-3JWEZM6mfix/GCJBBUrkA8p2Id2pBkyTkVCJKto55w080QBKZ+8R171fGrbiSp+yMO/u6F8/yUh7K4V9K+YCnw== + dependencies: + "@tokenizer/token" "^0.3.0" + strtok3@^6.2.4: version "6.3.0" resolved "https://registry.yarnpkg.com/strtok3/-/strtok3-6.3.0.tgz#358b80ffe6d5d5620e19a073aa78ce947a90f9a0" @@ -8653,7 +9040,7 @@ supports-color@^7.1.0: dependencies: has-flag "^4.0.0" -supports-color@^8.0.0, supports-color@^8.1.1: +supports-color@^8.0.0, supports-color@^8.1.0, supports-color@^8.1.1: version "8.1.1" resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== @@ -8797,6 +9184,11 @@ thenify-all@^1.0.0: dependencies: any-promise "^1.0.0" +through@^2.3.6: + version "2.3.8" + resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" + integrity sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg== + tiny-emitter@1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/tiny-emitter/-/tiny-emitter-1.1.0.tgz#ab405a21ffed814a76c19739648093d70654fecb" @@ -8955,7 +9347,7 @@ tsconfig-paths@^3.14.1, tsconfig-paths@^3.9.0: minimist "^1.2.6" strip-bom "^3.0.0" -tslib@2.8.1: +tslib@2.8.1, tslib@^2.0.1: version "2.8.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== @@ -9033,7 +9425,7 @@ type-fest@^0.8.0: resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.8.1.tgz#09e249ebde851d3b1e48d27c105444667f17b83d" integrity sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA== -type-is@^1.6.18, type-is@^1.6.4, type-is@~1.6.18: +type-is@^1.6.18, type-is@~1.6.18: version "1.6.18" resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131" integrity sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g== @@ -9287,7 +9679,7 @@ watchpack@^2.4.1: glob-to-regexp "^0.4.1" graceful-fs "^4.1.2" -wcwidth@^1.0.1: +wcwidth@>=1.0.1, wcwidth@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/wcwidth/-/wcwidth-1.0.1.tgz#f0b0dcf915bc5ff1528afadb2c0e17b532da2fe8" integrity sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg== @@ -9473,7 +9865,7 @@ wrap-ansi@^5.1.0: string-width "^3.0.0" strip-ansi "^5.0.0" -wrap-ansi@^6.2.0: +wrap-ansi@^6.0.1, wrap-ansi@^6.2.0: version "6.2.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== @@ -9543,7 +9935,7 @@ xmlhttprequest-ssl@~2.1.1: resolved "https://registry.yarnpkg.com/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.1.1.tgz#0d045c3b2babad8e7db1af5af093f5d0d60df99a" integrity sha512-ptjR8YSJIXoA3Mbv5po7RtSYHO6mZr8s7i5VGmEk7QY2pQWyT1o0N+W1gKbOyJPUCGXGnuw0wqe8f0L6Y0ny7g== -xtend@^4.0.0: +xtend@^4.0.2: version "4.0.2" resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54" integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ== @@ -9642,7 +10034,7 @@ yargs@^15.0.2: y18n "^4.0.0" yargs-parser "^18.1.2" -yargs@^16.0.0: +yargs@^16.0.0, yargs@^16.2.0: version "16.2.0" resolved "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz#1c82bf0f6b6a66eafce7ef30e376f49a12477f66" integrity sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw== diff --git a/redisinsight/desktop/src/lib/cloud/cloud-oauth.handlers.ts b/redisinsight/desktop/src/lib/cloud/cloud-oauth.handlers.ts index 821b0db832..c42664a623 100644 --- a/redisinsight/desktop/src/lib/cloud/cloud-oauth.handlers.ts +++ b/redisinsight/desktop/src/lib/cloud/cloud-oauth.handlers.ts @@ -5,22 +5,36 @@ import { UrlWithParsedQuery } from 'url' import { wrapErrorMessageSensitiveData } from 'desktopSrc/utils' import { IpcOnEvent, IpcInvokeEvent } from 'uiSrc/electron/constants' - -import { CloudOauthUnexpectedErrorException } from 'apiSrc/modules/cloud/auth/exceptions' import { CloudAuthRequestOptions, CloudAuthResponse, - CloudAuthStatus, -} from 'apiSrc/modules/cloud/auth/models' -import { DEFAULT_SESSION_ID, DEFAULT_USER_ID } from 'apiSrc/common/constants' + CloudAuthResponseStatusEnum as CloudAuthStatus, +} from 'uiSrc/api-client' + import { createAuthStrategy } from '../auth/auth.factory' import { getWindows } from '../window/browserWindow' const authStrategy = createAuthStrategy() +// ref: /api/src/common/constants/user.ts +const DEFAULT_USER_ID = '1' +const DEFAULT_SESSION_ID = '1' +// ref: /api/src/modules/cloud/auth/exceptions/cloud-oauth.unexpected-error.exception.ts +class CloudOauthUnexpectedErrorException { + constructor(private message = 'Cloud OAuth unexpected error') {} + + getResponse() { + return { + message: this.message, + statusCode: 500, + error: 'CloudOauthUnexpectedError', + errorCode: 11008, // CustomErrorCodes.CloudOauthUnexpectedError + } + } +} export const getOauthIpcErrorResponse = ( error: any, -): { status: CloudAuthStatus.Failed; error: {} } => { +): { status: CloudAuthStatus; error: {} } => { let errorResponse = new CloudOauthUnexpectedErrorException().getResponse() if (error?.getResponse) { diff --git a/redisinsight/desktop/src/lib/server/server.ts b/redisinsight/desktop/src/lib/server/server.ts index f592956868..f30d42208c 100644 --- a/redisinsight/desktop/src/lib/server/server.ts +++ b/redisinsight/desktop/src/lib/server/server.ts @@ -4,7 +4,6 @@ import { wrapErrorMessageSensitiveData } from 'desktopSrc/utils' import { configMain as config } from 'desktopSrc/config' import { createAuthStrategy } from 'desktopSrc/lib/auth/auth.factory' import { AuthStrategy } from 'desktopSrc/lib/auth/auth.interface' -import { AbstractWindowAuthStrategy } from 'apiSrc/modules/auth/window-auth/strategies/abstract.window.auth.strategy' import { WindowAuthModule } from '../../../../api/dist/src/modules/auth/window-auth/window-auth.module' import { WindowAuthService } from '../../../../api/dist/src/modules/auth/window-auth/window-auth.service' import server from '../../../../api/dist/src/main' @@ -14,7 +13,7 @@ const port = config?.defaultPort let gracefulShutdown: Function let beApp: any -export class ElectronWindowAuthStrategy extends AbstractWindowAuthStrategy { +export class ElectronWindowAuthStrategy { async isAuthorized(id: string): Promise { return getWindows()?.has(id) } diff --git a/redisinsight/desktop/vite.main.config.ts b/redisinsight/desktop/vite.main.config.ts index a12cea967c..3df112c749 100644 --- a/redisinsight/desktop/vite.main.config.ts +++ b/redisinsight/desktop/vite.main.config.ts @@ -14,10 +14,8 @@ export default defineConfig({ const relativePath = source.replace('desktopSrc/', '') return path.join(__dirname, 'src', relativePath) } - if (source.startsWith('apiSrc/') || source.includes('api/dist/src/')) { - const modulePath = source.includes('apiSrc/') - ? source.replace('apiSrc/', '') - : source.split('api/dist/src/')[1] + if (source.includes('api/dist/src/')) { + const modulePath = source.split('api/dist/src/')[1] return { id: path.join(apiDistPath, modulePath), diff --git a/redisinsight/desktop/vite.renderer.config.ts b/redisinsight/desktop/vite.renderer.config.ts index e5b0d1603e..f3513dc846 100644 --- a/redisinsight/desktop/vite.renderer.config.ts +++ b/redisinsight/desktop/vite.renderer.config.ts @@ -26,7 +26,6 @@ export default defineConfig({ resolve: { alias: { uiSrc: path.resolve(__dirname, '../ui/src'), - apiSrc: path.resolve(__dirname, '../api/src'), }, }, optimizeDeps: { diff --git a/redisinsight/ui/.eslintrc.js b/redisinsight/ui/.eslintrc.js index aac8b29001..74227ca108 100644 --- a/redisinsight/ui/.eslintrc.js +++ b/redisinsight/ui/.eslintrc.js @@ -110,11 +110,6 @@ module.exports = { group: 'internal', position: 'after', }, - { - pattern: 'apiSrc/**', - group: 'internal', - position: 'after', - }, { pattern: '{.,..}/*.scss', // same directory only // pattern: '{.,..}/**/*\.scss' // same & outside directories (e.g. import '../foo/foo.scss') diff --git a/redisinsight/ui/src/api-client/.gitignore b/redisinsight/ui/src/api-client/.gitignore new file mode 100644 index 0000000000..149b576547 --- /dev/null +++ b/redisinsight/ui/src/api-client/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/redisinsight/ui/src/api-client/.npmignore b/redisinsight/ui/src/api-client/.npmignore new file mode 100644 index 0000000000..999d88df69 --- /dev/null +++ b/redisinsight/ui/src/api-client/.npmignore @@ -0,0 +1 @@ +# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file diff --git a/redisinsight/ui/src/api-client/.openapi-generator-ignore b/redisinsight/ui/src/api-client/.openapi-generator-ignore new file mode 100644 index 0000000000..7484ee590a --- /dev/null +++ b/redisinsight/ui/src/api-client/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/redisinsight/ui/src/api-client/.openapi-generator/FILES b/redisinsight/ui/src/api-client/.openapi-generator/FILES new file mode 100644 index 0000000000..1ad9273c01 --- /dev/null +++ b/redisinsight/ui/src/api-client/.openapi-generator/FILES @@ -0,0 +1,300 @@ +.gitignore +.npmignore +.openapi-generator-ignore +api.ts +base.ts +common.ts +configuration.ts +docs/AIApi.md +docs/AckPendingEntriesDto.md +docs/AckPendingEntriesResponse.md +docs/AddFieldsToHashDto.md +docs/AddMembersToSetDto.md +docs/AddMembersToZSetDto.md +docs/AddRedisEnterpriseDatabaseResponse.md +docs/AddRedisEnterpriseDatabasesDto.md +docs/AddStreamEntriesDto.md +docs/AddStreamEntriesResponse.md +docs/AdditionalRedisModule.md +docs/AiChat.md +docs/AiChatMessage.md +docs/AnalysisProgress.md +docs/AnalyticsApi.md +docs/BrowserBrowserHistoryApi.md +docs/BrowserHashApi.md +docs/BrowserHistory.md +docs/BrowserKeysApi.md +docs/BrowserListApi.md +docs/BrowserREJSONRLApi.md +docs/BrowserRediSearchApi.md +docs/BrowserSetApi.md +docs/BrowserStreamsApi.md +docs/BrowserStringApi.md +docs/BrowserZSetApi.md +docs/BulkActionsApi.md +docs/CLIApi.md +docs/CaCertificate.md +docs/ClaimPendingEntriesResponse.md +docs/ClaimPendingEntryDto.md +docs/ClientCertificate.md +docs/CloudAccountInfo.md +docs/CloudAuthApi.md +docs/CloudAuthRequestOptions.md +docs/CloudAuthResponse.md +docs/CloudAuthResponseError.md +docs/CloudAutodiscoveryApi.md +docs/CloudCAPIKeysApi.md +docs/CloudCapiKey.md +docs/CloudDatabase.md +docs/CloudDatabaseDetails.md +docs/CloudJobInfo.md +docs/CloudJobsApi.md +docs/CloudSubscription.md +docs/CloudSubscriptionApi.md +docs/CloudSubscriptionPlanResponse.md +docs/CloudSubscriptionRegion.md +docs/CloudUser.md +docs/CloudUserAccount.md +docs/CloudUserApi.md +docs/ClusterConnectionDetailsDto.md +docs/ClusterDetails.md +docs/ClusterMonitorApi.md +docs/ClusterNodeDetails.md +docs/CommandExecution.md +docs/CommandExecutionFilter.md +docs/CommandExecutionResult.md +docs/CommandsApi.md +docs/ConsumerDto.md +docs/ConsumerDtoName.md +docs/ConsumerGroupDto.md +docs/ConsumerGroupDtoName.md +docs/CreateBasicSshOptionsDto.md +docs/CreateCaCertificateDto.md +docs/CreateCertSshOptionsDto.md +docs/CreateCliClientResponse.md +docs/CreateClientCertificateDto.md +docs/CreateCloudJobDto.md +docs/CreateCloudJobDtoData.md +docs/CreateCommandExecutionDto.md +docs/CreateCommandExecutionsDto.md +docs/CreateConsumerGroupDto.md +docs/CreateConsumerGroupsDto.md +docs/CreateDatabaseAnalysisDto.md +docs/CreateDatabaseCloudJobDataDto.md +docs/CreateDatabaseDto.md +docs/CreateDatabaseDtoCaCert.md +docs/CreateDatabaseDtoClientCert.md +docs/CreateDatabaseDtoSshOptions.md +docs/CreateHashWithExpireDto.md +docs/CreateListWithExpireDto.md +docs/CreateListWithExpireDtoElementsInner.md +docs/CreateListWithExpireDtoKeyName.md +docs/CreateListWithExpireDtoKeyNameOneOf.md +docs/CreateOrUpdateDatabaseSettingDto.md +docs/CreatePluginStateDto.md +docs/CreateRdiDto.md +docs/CreateRedisearchIndexDto.md +docs/CreateRedisearchIndexDtoIndex.md +docs/CreateRedisearchIndexFieldDto.md +docs/CreateRedisearchIndexFieldDtoName.md +docs/CreateRejsonRlWithExpireDto.md +docs/CreateSentinelDatabaseDto.md +docs/CreateSentinelDatabaseResponse.md +docs/CreateSentinelDatabasesDto.md +docs/CreateSetWithExpireDto.md +docs/CreateStreamDto.md +docs/CreateSubscriptionAndDatabaseCloudJobDataDto.md +docs/CreateTagDto.md +docs/CreateZSetWithExpireDto.md +docs/CustomTutorialManifest.md +docs/CustomTutorialManifestArgs.md +docs/Database.md +docs/DatabaseAnalysis.md +docs/DatabaseAnalysisApi.md +docs/DatabaseApi.md +docs/DatabaseDatabaseSettingsApi.md +docs/DatabaseImportResponse.md +docs/DatabaseImportResult.md +docs/DatabaseInstancesApi.md +docs/DatabaseOverview.md +docs/DatabaseRecommendation.md +docs/DatabaseRecommendationsApi.md +docs/DatabaseRecommendationsResponse.md +docs/DatabaseResponse.md +docs/DatabaseSettings.md +docs/DeleteBrowserHistoryItemsDto.md +docs/DeleteBrowserHistoryItemsResponse.md +docs/DeleteClientResponse.md +docs/DeleteConsumerGroupsDto.md +docs/DeleteConsumerGroupsResponse.md +docs/DeleteConsumersDto.md +docs/DeleteDatabaseRecommendationDto.md +docs/DeleteDatabaseRecommendationResponse.md +docs/DeleteDatabasesDto.md +docs/DeleteFieldsFromHashDto.md +docs/DeleteFieldsFromHashResponse.md +docs/DeleteKeysDto.md +docs/DeleteKeysResponse.md +docs/DeleteListElementsDto.md +docs/DeleteListElementsResponse.md +docs/DeleteMembersFromSetDto.md +docs/DeleteMembersFromSetResponse.md +docs/DeleteMembersFromZSetDto.md +docs/DeleteMembersFromZSetResponse.md +docs/DeleteStreamEntriesDto.md +docs/DeleteStreamEntriesResponse.md +docs/DiscoverCloudDatabasesDto.md +docs/DiscoverSentinelMastersDto.md +docs/Endpoint.md +docs/ExportDatabase.md +docs/ExportDatabasesDto.md +docs/FieldStatisticsDto.md +docs/GetAgreementsSpecResponse.md +docs/GetAppSettingsResponse.md +docs/GetCloudSubscriptionDatabasesDto.md +docs/GetConsumersDto.md +docs/GetConsumersDtoGroupName.md +docs/GetHashFieldsDto.md +docs/GetHashFieldsResponse.md +docs/GetKeyInfoDto.md +docs/GetKeyInfoResponse.md +docs/GetKeysDto.md +docs/GetKeysInfoDto.md +docs/GetKeysWithDetailsResponse.md +docs/GetListElementResponse.md +docs/GetListElementResponseValue.md +docs/GetListElementsDto.md +docs/GetListElementsResponse.md +docs/GetPendingEntriesDto.md +docs/GetPendingEntriesDtoConsumerName.md +docs/GetRejsonRlDto.md +docs/GetRejsonRlResponseDto.md +docs/GetRejsonRlResponseDtoData.md +docs/GetServerInfoResponse.md +docs/GetSetMembersDto.md +docs/GetSetMembersResponse.md +docs/GetStreamEntriesDto.md +docs/GetStreamEntriesResponse.md +docs/GetStringInfoDto.md +docs/GetStringValueResponse.md +docs/GetUserAgreementsResponse.md +docs/GetZSetMembersDto.md +docs/GetZSetResponse.md +docs/HashFieldDto.md +docs/HashFieldDtoField.md +docs/HashFieldTtlDto.md +docs/ImportCloudDatabaseDto.md +docs/ImportCloudDatabaseResponse.md +docs/ImportCloudDatabasesDto.md +docs/ImportDatabaseCloudJobDataDto.md +docs/IndexAttibuteDto.md +docs/IndexDefinitionDto.md +docs/IndexInfoDto.md +docs/IndexInfoRequestBodyDto.md +docs/IndexOptionsDto.md +docs/InfoApi.md +docs/Key.md +docs/KeyDto.md +docs/KeyTtlResponse.md +docs/ListRedisearchIndexesResponse.md +docs/ModifyDatabaseRecommendationDto.md +docs/ModifyRejsonRlArrAppendDto.md +docs/ModifyRejsonRlSetDto.md +docs/NotificationsApi.md +docs/NotificationsDto.md +docs/NspSummary.md +docs/NspSummaryNsp.md +docs/NspTypeSummary.md +docs/PendingEntryDto.md +docs/PickTypeClass.md +docs/Plugin.md +docs/PluginCommandExecution.md +docs/PluginState.md +docs/PluginVisualization.md +docs/PluginsApi.md +docs/PluginsResponse.md +docs/ProfilerApi.md +docs/PubSubApi.md +docs/PublishDto.md +docs/PublishResponse.md +docs/PushElementToListDto.md +docs/PushListElementsResponse.md +docs/PushListElementsResponseKeyName.md +docs/RDIApi.md +docs/Rdi.md +docs/RdiDryRunJobDto.md +docs/RdiDryRunJobResponseDto.md +docs/RdiTemplateResponseDto.md +docs/RdiTestConnectionsResponseDto.md +docs/ReadNotificationsDto.md +docs/Recommendation.md +docs/RecommendationVoteDto.md +docs/RedisDatabaseInfoResponse.md +docs/RedisDatabaseStatsDto.md +docs/RedisEnterpriseClusterApi.md +docs/RedisEnterpriseDatabase.md +docs/RedisNodeInfoResponse.md +docs/RedisOSSSentinelApi.md +docs/RemoveRejsonRlDto.md +docs/RemoveRejsonRlResponse.md +docs/RenameKeyDto.md +docs/RenameKeyDtoNewKeyName.md +docs/RenameKeyResponse.md +docs/ResultsSummary.md +docs/RootCustomTutorialManifest.md +docs/SafeRejsonRlDataDto.md +docs/ScanFilter.md +docs/SearchRedisearchDto.md +docs/SearchZSetMembersDto.md +docs/SearchZSetMembersResponse.md +docs/SendAiChatMessageDto.md +docs/SendAiQueryMessageDto.md +docs/SendCommandDto.md +docs/SendCommandResponse.md +docs/SendEventDto.md +docs/SentinelMaster.md +docs/SentinelMasterResponse.md +docs/SetListElementDto.md +docs/SetListElementDtoElement.md +docs/SetListElementResponse.md +docs/SetStringDto.md +docs/SetStringWithExpireDto.md +docs/SetStringWithExpireDtoValue.md +docs/SettingsApi.md +docs/ShortCommandExecution.md +docs/ShortDatabaseAnalysis.md +docs/SimpleSummary.md +docs/SimpleTypeSummary.md +docs/SlowLog.md +docs/SlowLogConfig.md +docs/SlowLogsApi.md +docs/SshOptions.md +docs/SshOptionsResponse.md +docs/StreamEntryDto.md +docs/StreamEntryFieldDto.md +docs/StreamEntryFieldDtoName.md +docs/StreamEntryFieldDtoValue.md +docs/SumGroup.md +docs/TAGSApi.md +docs/TLSCertificatesApi.md +docs/Tag.md +docs/TutorialsApi.md +docs/UpdateConsumerGroupDto.md +docs/UpdateDatabaseDto.md +docs/UpdateHashFieldsTtlDto.md +docs/UpdateKeyTtlDto.md +docs/UpdateMemberInZSetDto.md +docs/UpdateRdiDto.md +docs/UpdateSentinelMasterDto.md +docs/UpdateSettingsDto.md +docs/UpdateSlowLogConfigDto.md +docs/UpdateSshOptionsDto.md +docs/UpdateTagDto.md +docs/UploadImportFileByPathDto.md +docs/UseCaCertificateDto.md +docs/UseClientCertificateDto.md +docs/WorkbenchApi.md +docs/ZSetMemberDto.md +docs/ZSetMemberDtoName.md +git_push.sh +index.ts diff --git a/redisinsight/ui/src/api-client/.openapi-generator/VERSION b/redisinsight/ui/src/api-client/.openapi-generator/VERSION new file mode 100644 index 0000000000..e465da4315 --- /dev/null +++ b/redisinsight/ui/src/api-client/.openapi-generator/VERSION @@ -0,0 +1 @@ +7.14.0 diff --git a/redisinsight/ui/src/api-client/api.ts b/redisinsight/ui/src/api-client/api.ts new file mode 100644 index 0000000000..cdb8eb9c54 --- /dev/null +++ b/redisinsight/ui/src/api-client/api.ts @@ -0,0 +1,25314 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Redis Insight Backend API + * Redis Insight Backend API + * + * The version of the OpenAPI document: 2.70.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from './configuration'; +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; +// Some imports not used depending on template conditions +// @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; +// @ts-ignore +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; + +/** + * + * @export + * @interface AckPendingEntriesDto + */ +export interface AckPendingEntriesDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof AckPendingEntriesDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof AckPendingEntriesDto + */ + 'groupName': GetConsumersDtoGroupName; + /** + * Entries IDs + * @type {Array} + * @memberof AckPendingEntriesDto + */ + 'entries': Array; +} +/** + * + * @export + * @interface AckPendingEntriesResponse + */ +export interface AckPendingEntriesResponse { + /** + * Number of affected entries + * @type {number} + * @memberof AckPendingEntriesResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface AddFieldsToHashDto + */ +export interface AddFieldsToHashDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof AddFieldsToHashDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Hash fields + * @type {Array} + * @memberof AddFieldsToHashDto + */ + 'fields': Array; +} +/** + * + * @export + * @interface AddMembersToSetDto + */ +export interface AddMembersToSetDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof AddMembersToSetDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Set members + * @type {Array} + * @memberof AddMembersToSetDto + */ + 'members': Array; +} +/** + * + * @export + * @interface AddMembersToZSetDto + */ +export interface AddMembersToZSetDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof AddMembersToZSetDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * ZSet members + * @type {Array} + * @memberof AddMembersToZSetDto + */ + 'members': Array; +} +/** + * + * @export + * @interface AddRedisEnterpriseDatabaseResponse + */ +export interface AddRedisEnterpriseDatabaseResponse { + /** + * The unique ID of the database + * @type {number} + * @memberof AddRedisEnterpriseDatabaseResponse + */ + 'uid': number; + /** + * Add Redis Enterprise database status + * @type {string} + * @memberof AddRedisEnterpriseDatabaseResponse + */ + 'status': AddRedisEnterpriseDatabaseResponseStatusEnum; + /** + * Message + * @type {string} + * @memberof AddRedisEnterpriseDatabaseResponse + */ + 'message': string; + /** + * The database details. + * @type {RedisEnterpriseDatabase} + * @memberof AddRedisEnterpriseDatabaseResponse + */ + 'databaseDetails'?: RedisEnterpriseDatabase; + /** + * Error + * @type {object} + * @memberof AddRedisEnterpriseDatabaseResponse + */ + 'error'?: object; +} + +export const AddRedisEnterpriseDatabaseResponseStatusEnum = { + Success: 'success', + Fail: 'fail' +} as const; + +export type AddRedisEnterpriseDatabaseResponseStatusEnum = typeof AddRedisEnterpriseDatabaseResponseStatusEnum[keyof typeof AddRedisEnterpriseDatabaseResponseStatusEnum]; + +/** + * + * @export + * @interface AddRedisEnterpriseDatabasesDto + */ +export interface AddRedisEnterpriseDatabasesDto { + /** + * The hostname of your Redis Enterprise. + * @type {string} + * @memberof AddRedisEnterpriseDatabasesDto + */ + 'host': string; + /** + * The port your Redis Enterprise cluster is available on. + * @type {number} + * @memberof AddRedisEnterpriseDatabasesDto + */ + 'port': number; + /** + * The admin e-mail/username + * @type {string} + * @memberof AddRedisEnterpriseDatabasesDto + */ + 'username': string; + /** + * The admin password + * @type {string} + * @memberof AddRedisEnterpriseDatabasesDto + */ + 'password': string; + /** + * The unique IDs of the databases. + * @type {Array} + * @memberof AddRedisEnterpriseDatabasesDto + */ + 'uids': Array; +} +/** + * + * @export + * @interface AddStreamEntriesDto + */ +export interface AddStreamEntriesDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof AddStreamEntriesDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Entries to push + * @type {Array} + * @memberof AddStreamEntriesDto + */ + 'entries': Array; +} +/** + * + * @export + * @interface AddStreamEntriesResponse + */ +export interface AddStreamEntriesResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof AddStreamEntriesResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * Entries IDs + * @type {Array} + * @memberof AddStreamEntriesResponse + */ + 'entries': Array; +} +/** + * + * @export + * @interface AdditionalRedisModule + */ +export interface AdditionalRedisModule { + /** + * Name of the module. + * @type {string} + * @memberof AdditionalRedisModule + */ + 'name': string; + /** + * Integer representation of a module version. + * @type {number} + * @memberof AdditionalRedisModule + */ + 'version'?: number; + /** + * Semantic versioning representation of a module version. + * @type {string} + * @memberof AdditionalRedisModule + */ + 'semanticVersion'?: string; +} +/** + * + * @export + * @interface AiChat + */ +export interface AiChat { + /** + * + * @type {string} + * @memberof AiChat + */ + 'id': string; + /** + * + * @type {Array} + * @memberof AiChat + */ + 'messages': Array; +} +/** + * + * @export + * @interface AiChatMessage + */ +export interface AiChatMessage { + /** + * + * @type {string} + * @memberof AiChatMessage + */ + 'type': AiChatMessageTypeEnum; + /** + * + * @type {string} + * @memberof AiChatMessage + */ + 'content': string; + /** + * + * @type {object} + * @memberof AiChatMessage + */ + 'context': object; +} + +export const AiChatMessageTypeEnum = { + HumanMessage: 'HumanMessage', + AiMessage: 'AIMessage' +} as const; + +export type AiChatMessageTypeEnum = typeof AiChatMessageTypeEnum[keyof typeof AiChatMessageTypeEnum]; + +/** + * + * @export + * @interface AnalysisProgress + */ +export interface AnalysisProgress { + /** + * Total keys in the database + * @type {number} + * @memberof AnalysisProgress + */ + 'total': number; + /** + * Total keys scanned for entire database + * @type {number} + * @memberof AnalysisProgress + */ + 'scanned': number; + /** + * Total keys processed for entire database. (Filtered keys returned by scan command) + * @type {number} + * @memberof AnalysisProgress + */ + 'processed': number; +} +/** + * + * @export + * @interface BrowserHistory + */ +export interface BrowserHistory { + /** + * History id + * @type {string} + * @memberof BrowserHistory + */ + 'id': string; + /** + * Database id + * @type {string} + * @memberof BrowserHistory + */ + 'databaseId': string; + /** + * Filters for scan operation + * @type {ScanFilter} + * @memberof BrowserHistory + */ + 'filter': ScanFilter; + /** + * Mode of history + * @type {string} + * @memberof BrowserHistory + */ + 'mode': BrowserHistoryModeEnum; + /** + * History created date (ISO string) + * @type {string} + * @memberof BrowserHistory + */ + 'createdAt': string; +} + +export const BrowserHistoryModeEnum = { + Pattern: 'pattern', + Redisearch: 'redisearch' +} as const; + +export type BrowserHistoryModeEnum = typeof BrowserHistoryModeEnum[keyof typeof BrowserHistoryModeEnum]; + +/** + * + * @export + * @interface CaCertificate + */ +export interface CaCertificate { + /** + * Certificate id + * @type {string} + * @memberof CaCertificate + */ + 'id': string; + /** + * Certificate name + * @type {string} + * @memberof CaCertificate + */ + 'name': string; + /** + * Certificate body + * @type {string} + * @memberof CaCertificate + */ + 'certificate': string; + /** + * Whether the certificate was created from a file or environment variables at startup + * @type {boolean} + * @memberof CaCertificate + */ + 'isPreSetup'?: boolean; +} +/** + * + * @export + * @interface ClaimPendingEntriesResponse + */ +export interface ClaimPendingEntriesResponse { + /** + * Entries IDs were affected by claim command + * @type {Array} + * @memberof ClaimPendingEntriesResponse + */ + 'affected': Array; +} +/** + * + * @export + * @interface ClaimPendingEntryDto + */ +export interface ClaimPendingEntryDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof ClaimPendingEntryDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof ClaimPendingEntryDto + */ + 'groupName': GetConsumersDtoGroupName; + /** + * + * @type {GetPendingEntriesDtoConsumerName} + * @memberof ClaimPendingEntryDto + */ + 'consumerName': GetPendingEntriesDtoConsumerName; + /** + * Claim only if its idle time is greater the minimum idle time + * @type {number} + * @memberof ClaimPendingEntryDto + */ + 'minIdleTime': number; + /** + * Entries IDs + * @type {Array} + * @memberof ClaimPendingEntryDto + */ + 'entries': Array; + /** + * Set the idle time (last time it was delivered) of the message + * @type {number} + * @memberof ClaimPendingEntryDto + */ + 'idle'?: number; + /** + * This is the same as IDLE but instead of a relative amount of milliseconds, it sets the idle time to a specific Unix time (in milliseconds) + * @type {number} + * @memberof ClaimPendingEntryDto + */ + 'time'?: number; + /** + * Set the retry counter to the specified value. This counter is incremented every time a message is delivered again. Normally XCLAIM does not alter this counter, which is just served to clients when the XPENDING command is called: this way clients can detect anomalies, like messages that are never processed for some reason after a big number of delivery attempts + * @type {number} + * @memberof ClaimPendingEntryDto + */ + 'retryCount'?: number; + /** + * Creates the pending message entry in the PEL even if certain specified IDs are not already in the PEL assigned to a different client + * @type {boolean} + * @memberof ClaimPendingEntryDto + */ + 'force'?: boolean; +} +/** + * + * @export + * @interface ClientCertificate + */ +export interface ClientCertificate { + /** + * Certificate id + * @type {string} + * @memberof ClientCertificate + */ + 'id': string; + /** + * Certificate name + * @type {string} + * @memberof ClientCertificate + */ + 'name': string; + /** + * Certificate body + * @type {string} + * @memberof ClientCertificate + */ + 'certificate': string; + /** + * Key body + * @type {string} + * @memberof ClientCertificate + */ + 'key': string; + /** + * Whether the certificate was created from a file or environment variables at startup + * @type {boolean} + * @memberof ClientCertificate + */ + 'isPreSetup'?: boolean; +} +/** + * + * @export + * @interface CloudAccountInfo + */ +export interface CloudAccountInfo { + /** + * Account id + * @type {number} + * @memberof CloudAccountInfo + */ + 'accountId': number; + /** + * Account name + * @type {string} + * @memberof CloudAccountInfo + */ + 'accountName': string; + /** + * Account owner name + * @type {string} + * @memberof CloudAccountInfo + */ + 'ownerName': string; + /** + * Account owner email + * @type {string} + * @memberof CloudAccountInfo + */ + 'ownerEmail': string; +} +/** + * + * @export + * @interface CloudAuthRequestOptions + */ +export interface CloudAuthRequestOptions { + /** + * OAuth identity provider strategy + * @type {string} + * @memberof CloudAuthRequestOptions + */ + 'strategy': CloudAuthRequestOptionsStrategyEnum; + /** + * Action to perform after authentication + * @type {string} + * @memberof CloudAuthRequestOptions + */ + 'action'?: string; + /** + * Additional data for the authentication request + * @type {object} + * @memberof CloudAuthRequestOptions + */ + 'data'?: object; + /** + * Callback function to execute after authentication + * @type {object} + * @memberof CloudAuthRequestOptions + */ + 'callback'?: object; +} + +export const CloudAuthRequestOptionsStrategyEnum = { + Google: 'google', + Github: 'github', + Sso: 'sso' +} as const; + +export type CloudAuthRequestOptionsStrategyEnum = typeof CloudAuthRequestOptionsStrategyEnum[keyof typeof CloudAuthRequestOptionsStrategyEnum]; + +/** + * + * @export + * @interface CloudAuthResponse + */ +export interface CloudAuthResponse { + /** + * Authentication status + * @type {string} + * @memberof CloudAuthResponse + */ + 'status': CloudAuthResponseStatusEnum; + /** + * Success or informational message + * @type {string} + * @memberof CloudAuthResponse + */ + 'message'?: string; + /** + * + * @type {CloudAuthResponseError} + * @memberof CloudAuthResponse + */ + 'error'?: CloudAuthResponseError; +} + +export const CloudAuthResponseStatusEnum = { + Succeed: 'succeed', + Failed: 'failed' +} as const; + +export type CloudAuthResponseStatusEnum = typeof CloudAuthResponseStatusEnum[keyof typeof CloudAuthResponseStatusEnum]; + +/** + * @type CloudAuthResponseError + * Error details if authentication failed + * @export + */ +export type CloudAuthResponseError = object | string; + +/** + * + * @export + * @interface CloudCapiKey + */ +export interface CloudCapiKey { + /** + * + * @type {string} + * @memberof CloudCapiKey + */ + 'id': string; + /** + * + * @type {string} + * @memberof CloudCapiKey + */ + 'userId': string; + /** + * Autogenerated name of capi key (Redisinsight-- + * @type {string} + * @memberof CloudCapiKey + */ + 'name': string; + /** + * + * @type {number} + * @memberof CloudCapiKey + */ + 'cloudAccountId': number; + /** + * + * @type {number} + * @memberof CloudCapiKey + */ + 'cloudUserId': number; + /** + * + * @type {string} + * @memberof CloudCapiKey + */ + 'capiKey': string; + /** + * + * @type {string} + * @memberof CloudCapiKey + */ + 'capiSecret': string; + /** + * + * @type {boolean} + * @memberof CloudCapiKey + */ + 'valid': boolean; + /** + * + * @type {string} + * @memberof CloudCapiKey + */ + 'createdAt': string; + /** + * + * @type {string} + * @memberof CloudCapiKey + */ + 'lastUsed': string; +} +/** + * + * @export + * @interface CloudDatabase + */ +export interface CloudDatabase { + /** + * Subscription id + * @type {number} + * @memberof CloudDatabase + */ + 'subscriptionId': number; + /** + * Subscription type + * @type {string} + * @memberof CloudDatabase + */ + 'subscriptionType': CloudDatabaseSubscriptionTypeEnum; + /** + * Database id + * @type {number} + * @memberof CloudDatabase + */ + 'databaseId': number; + /** + * Database name + * @type {string} + * @memberof CloudDatabase + */ + 'name': string; + /** + * Address your Redis Cloud database is available on + * @type {string} + * @memberof CloudDatabase + */ + 'publicEndpoint': string; + /** + * Database status + * @type {string} + * @memberof CloudDatabase + */ + 'status': CloudDatabaseStatusEnum; + /** + * Is ssl authentication enabled or not + * @type {boolean} + * @memberof CloudDatabase + */ + 'sslClientAuthentication': boolean; + /** + * Information about the modules loaded to the database + * @type {Array} + * @memberof CloudDatabase + */ + 'modules': Array; + /** + * Additional database options + * @type {object} + * @memberof CloudDatabase + */ + 'options': object; + /** + * Tags associated with the database. + * @type {Array} + * @memberof CloudDatabase + */ + 'tags': Array; +} + +export const CloudDatabaseSubscriptionTypeEnum = { + Flexible: 'flexible', + Fixed: 'fixed' +} as const; + +export type CloudDatabaseSubscriptionTypeEnum = typeof CloudDatabaseSubscriptionTypeEnum[keyof typeof CloudDatabaseSubscriptionTypeEnum]; +export const CloudDatabaseStatusEnum = { + Draft: 'draft', + Pending: 'pending', + CreationFailed: 'creation-failed', + Active: 'active', + ActiveChangePending: 'active-change-pending', + ImportPending: 'import-pending', + DeletePending: 'delete-pending', + Recovery: 'recovery' +} as const; + +export type CloudDatabaseStatusEnum = typeof CloudDatabaseStatusEnum[keyof typeof CloudDatabaseStatusEnum]; + +/** + * + * @export + * @interface CloudDatabaseDetails + */ +export interface CloudDatabaseDetails { + /** + * Database id from the cloud + * @type {number} + * @memberof CloudDatabaseDetails + */ + 'cloudId': number; + /** + * Subscription id from the cloud + * @type {number} + * @memberof CloudDatabaseDetails + */ + 'subscriptionId': number; + /** + * Subscription type + * @type {string} + * @memberof CloudDatabaseDetails + */ + 'subscriptionType': CloudDatabaseDetailsSubscriptionTypeEnum; + /** + * Plan memory limit + * @type {number} + * @memberof CloudDatabaseDetails + */ + 'planMemoryLimit'?: number; + /** + * Memory limit units + * @type {string} + * @memberof CloudDatabaseDetails + */ + 'memoryLimitMeasurementUnit'?: string; + /** + * Is free database + * @type {boolean} + * @memberof CloudDatabaseDetails + */ + 'free'?: boolean; + /** + * Is subscription using bdb packages + * @type {boolean} + * @memberof CloudDatabaseDetails + */ + 'isBdbPackage'?: boolean; +} + +export const CloudDatabaseDetailsSubscriptionTypeEnum = { + Flexible: 'flexible', + Fixed: 'fixed' +} as const; + +export type CloudDatabaseDetailsSubscriptionTypeEnum = typeof CloudDatabaseDetailsSubscriptionTypeEnum[keyof typeof CloudDatabaseDetailsSubscriptionTypeEnum]; + +/** + * + * @export + * @interface CloudJobInfo + */ +export interface CloudJobInfo { + /** + * + * @type {string} + * @memberof CloudJobInfo + */ + 'id': string; + /** + * + * @type {string} + * @memberof CloudJobInfo + */ + 'name': CloudJobInfoNameEnum; + /** + * + * @type {string} + * @memberof CloudJobInfo + */ + 'status': CloudJobInfoStatusEnum; + /** + * Children job if any + * @type {CloudJobInfo} + * @memberof CloudJobInfo + */ + 'child'?: CloudJobInfo; + /** + * Error if any + * @type {object} + * @memberof CloudJobInfo + */ + 'error'?: object; + /** + * Job result + * @type {object} + * @memberof CloudJobInfo + */ + 'result'?: object; + /** + * Job step + * @type {string} + * @memberof CloudJobInfo + */ + 'step'?: string; +} + +export const CloudJobInfoNameEnum = { + CreateFreeSubscriptionAndDatabase: 'CREATE_FREE_SUBSCRIPTION_AND_DATABASE', + CreateFreeDatabase: 'CREATE_FREE_DATABASE', + CreateFreeSubscription: 'CREATE_FREE_SUBSCRIPTION', + ImportFreeDatabase: 'IMPORT_FREE_DATABASE', + WaitForActiveDatabase: 'WAIT_FOR_ACTIVE_DATABASE', + WaitForActiveSubscription: 'WAIT_FOR_ACTIVE_SUBSCRIPTION', + WaitForTask: 'WAIT_FOR_TASK', + Unknown: 'UNKNOWN' +} as const; + +export type CloudJobInfoNameEnum = typeof CloudJobInfoNameEnum[keyof typeof CloudJobInfoNameEnum]; +export const CloudJobInfoStatusEnum = { + Initializing: 'initializing', + Running: 'running', + Finished: 'finished', + Failed: 'failed' +} as const; + +export type CloudJobInfoStatusEnum = typeof CloudJobInfoStatusEnum[keyof typeof CloudJobInfoStatusEnum]; + +/** + * + * @export + * @interface CloudSubscription + */ +export interface CloudSubscription { + /** + * Subscription id + * @type {number} + * @memberof CloudSubscription + */ + 'id': number; + /** + * Subscription name + * @type {string} + * @memberof CloudSubscription + */ + 'name': string; + /** + * Subscription type + * @type {string} + * @memberof CloudSubscription + */ + 'type': CloudSubscriptionTypeEnum; + /** + * Number of databases in subscription + * @type {number} + * @memberof CloudSubscription + */ + 'numberOfDatabases': number; + /** + * Subscription status + * @type {string} + * @memberof CloudSubscription + */ + 'status': CloudSubscriptionStatusEnum; + /** + * Subscription provider + * @type {string} + * @memberof CloudSubscription + */ + 'provider'?: string; + /** + * Subscription region + * @type {string} + * @memberof CloudSubscription + */ + 'region'?: string; + /** + * Subscription price + * @type {number} + * @memberof CloudSubscription + */ + 'price'?: number; + /** + * Determines if subscription is 0 price + * @type {boolean} + * @memberof CloudSubscription + */ + 'free'?: boolean; +} + +export const CloudSubscriptionTypeEnum = { + Flexible: 'flexible', + Fixed: 'fixed' +} as const; + +export type CloudSubscriptionTypeEnum = typeof CloudSubscriptionTypeEnum[keyof typeof CloudSubscriptionTypeEnum]; +export const CloudSubscriptionStatusEnum = { + Active: 'active', + NotActivated: 'not_activated', + Deleting: 'deleting', + Pending: 'pending', + Error: 'error' +} as const; + +export type CloudSubscriptionStatusEnum = typeof CloudSubscriptionStatusEnum[keyof typeof CloudSubscriptionStatusEnum]; + +/** + * + * @export + * @interface CloudSubscriptionPlanResponse + */ +export interface CloudSubscriptionPlanResponse { + /** + * + * @type {number} + * @memberof CloudSubscriptionPlanResponse + */ + 'id': number; + /** + * + * @type {number} + * @memberof CloudSubscriptionPlanResponse + */ + 'regionId': number; + /** + * Subscription type + * @type {string} + * @memberof CloudSubscriptionPlanResponse + */ + 'type': CloudSubscriptionPlanResponseTypeEnum; + /** + * + * @type {string} + * @memberof CloudSubscriptionPlanResponse + */ + 'name': string; + /** + * + * @type {string} + * @memberof CloudSubscriptionPlanResponse + */ + 'provider': string; + /** + * + * @type {string} + * @memberof CloudSubscriptionPlanResponse + */ + 'region'?: string; + /** + * + * @type {number} + * @memberof CloudSubscriptionPlanResponse + */ + 'price'?: number; + /** + * + * @type {CloudSubscriptionRegion} + * @memberof CloudSubscriptionPlanResponse + */ + 'details': CloudSubscriptionRegion; +} + +export const CloudSubscriptionPlanResponseTypeEnum = { + Flexible: 'flexible', + Fixed: 'fixed' +} as const; + +export type CloudSubscriptionPlanResponseTypeEnum = typeof CloudSubscriptionPlanResponseTypeEnum[keyof typeof CloudSubscriptionPlanResponseTypeEnum]; + +/** + * + * @export + * @interface CloudSubscriptionRegion + */ +export interface CloudSubscriptionRegion { + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'id': string; + /** + * + * @type {number} + * @memberof CloudSubscriptionRegion + */ + 'regionId': number; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'name': string; + /** + * + * @type {number} + * @memberof CloudSubscriptionRegion + */ + 'displayOrder': number; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'region'?: string; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'provider'?: string; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'cloud'?: string; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'countryName'?: string; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'cityName'?: string; + /** + * + * @type {string} + * @memberof CloudSubscriptionRegion + */ + 'flag'?: string; +} +/** + * + * @export + * @interface CloudUser + */ +export interface CloudUser { + /** + * User id + * @type {number} + * @memberof CloudUser + */ + 'id'?: number; + /** + * User name + * @type {string} + * @memberof CloudUser + */ + 'name'?: string; + /** + * Current account id + * @type {number} + * @memberof CloudUser + */ + 'currentAccountId'?: number; + /** + * Cloud API key + * @type {CloudCapiKey} + * @memberof CloudUser + */ + 'capiKey'?: CloudCapiKey; + /** + * User accounts + * @type {Array} + * @memberof CloudUser + */ + 'accounts'?: Array; + /** + * Additional user data + * @type {object} + * @memberof CloudUser + */ + 'data'?: object; +} +/** + * + * @export + * @interface CloudUserAccount + */ +export interface CloudUserAccount { + /** + * Account id + * @type {number} + * @memberof CloudUserAccount + */ + 'id': number; + /** + * Account name + * @type {string} + * @memberof CloudUserAccount + */ + 'name': string; + /** + * Cloud API key + * @type {string} + * @memberof CloudUserAccount + */ + 'capiKey': string; + /** + * Cloud API secret + * @type {string} + * @memberof CloudUserAccount + */ + 'capiSecret': string; +} +/** + * + * @export + * @interface ClusterConnectionDetailsDto + */ +export interface ClusterConnectionDetailsDto { + /** + * The hostname of your Redis Enterprise. + * @type {string} + * @memberof ClusterConnectionDetailsDto + */ + 'host': string; + /** + * The port your Redis Enterprise cluster is available on. + * @type {number} + * @memberof ClusterConnectionDetailsDto + */ + 'port': number; + /** + * The admin e-mail/username + * @type {string} + * @memberof ClusterConnectionDetailsDto + */ + 'username': string; + /** + * The admin password + * @type {string} + * @memberof ClusterConnectionDetailsDto + */ + 'password': string; +} +/** + * + * @export + * @interface ClusterDetails + */ +export interface ClusterDetails { + /** + * Redis version + * @type {string} + * @memberof ClusterDetails + */ + 'version': string; + /** + * Redis mode. Currently one of: standalone, cluster or sentinel + * @type {string} + * @memberof ClusterDetails + */ + 'mode': string; + /** + * Username from the connection or undefined in case when connected with default user + * @type {string} + * @memberof ClusterDetails + */ + 'user'?: string; + /** + * Maximum value uptime_in_seconds from all nodes + * @type {number} + * @memberof ClusterDetails + */ + 'uptimeSec': number; + /** + * cluster_state from CLUSTER INFO command + * @type {string} + * @memberof ClusterDetails + */ + 'state': string; + /** + * cluster_slots_assigned from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'slotsAssigned': number; + /** + * cluster_slots_ok from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'slotsOk': number; + /** + * cluster_slots_pfail from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'slotsPFail': number; + /** + * cluster_slots_fail from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'slotsFail': number; + /** + * Calculated from (16384 - cluster_slots_assigned from CLUSTER INFO command) + * @type {number} + * @memberof ClusterDetails + */ + 'slotsUnassigned': number; + /** + * cluster_stats_messages_sent from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'statsMessagesSent': number; + /** + * cluster_stats_messages_received from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'statsMessagesReceived': number; + /** + * cluster_current_epoch from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'currentEpoch': number; + /** + * cluster_my_epoch from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'myEpoch': number; + /** + * Number of shards. cluster_size from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'size': number; + /** + * All nodes number in the Cluster. cluster_known_nodes from CLUSTER INFO command + * @type {number} + * @memberof ClusterDetails + */ + 'knownNodes': number; + /** + * Details per each node + * @type {Array} + * @memberof ClusterDetails + */ + 'nodes': Array; +} +/** + * + * @export + * @interface ClusterNodeDetails + */ +export interface ClusterNodeDetails { + /** + * Node id + * @type {string} + * @memberof ClusterNodeDetails + */ + 'id': string; + /** + * Redis version + * @type {string} + * @memberof ClusterNodeDetails + */ + 'version': string; + /** + * Redis mode + * @type {string} + * @memberof ClusterNodeDetails + */ + 'mode': string; + /** + * Node IP address + * @type {string} + * @memberof ClusterNodeDetails + */ + 'host': string; + /** + * Node IP address + * @type {number} + * @memberof ClusterNodeDetails + */ + 'port': number; + /** + * Node role in cluster + * @type {string} + * @memberof ClusterNodeDetails + */ + 'role': ClusterNodeDetailsRoleEnum; + /** + * ID of primary node (for replica only) + * @type {string} + * @memberof ClusterNodeDetails + */ + 'primary'?: string; + /** + * Node\'s current health status + * @type {string} + * @memberof ClusterNodeDetails + */ + 'health': ClusterNodeDetailsHealthEnum; + /** + * Array of assigned slots or slots ranges. Shown for primary nodes only + * @type {Array} + * @memberof ClusterNodeDetails + */ + 'slots'?: Array; + /** + * Total keys stored inside this node + * @type {number} + * @memberof ClusterNodeDetails + */ + 'totalKeys': number; + /** + * Memory used by node. \"memory.used_memory\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'usedMemory': number; + /** + * Current operations per second. \"stats.instantaneous_ops_per_sec\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'opsPerSecond': number; + /** + * Total connections received by node. \"stats.total_connections_received\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'connectionsReceived': number; + /** + * Currently connected clients. \"clients.connected_clients\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'connectedClients': number; + /** + * Total commands processed by node. \"stats.total_commands_processed\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'commandsProcessed': number; + /** + * Current input network usage in KB/s. \"stats.instantaneous_input_kbps\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'networkInKbps': number; + /** + * Current output network usage in KB/s. \"stats.instantaneous_output_kbps\" from INFO command + * @type {number} + * @memberof ClusterNodeDetails + */ + 'networkOutKbps': number; + /** + * Ratio for cache hits and misses [0 - 1]. Ideally should be close to 1 + * @type {number} + * @memberof ClusterNodeDetails + */ + 'cacheHitRatio'?: number; + /** + * The replication offset of this node. This information can be used to send commands to the most up to date replicas. + * @type {number} + * @memberof ClusterNodeDetails + */ + 'replicationOffset': number; + /** + * For replicas only. Determines on how much replica is behind of primary. + * @type {number} + * @memberof ClusterNodeDetails + */ + 'replicationLag'?: number; + /** + * Current node uptime_in_seconds + * @type {number} + * @memberof ClusterNodeDetails + */ + 'uptimeSec': number; + /** + * For primary nodes only. Replica node(s) details + * @type {Array} + * @memberof ClusterNodeDetails + */ + 'replicas'?: Array; +} + +export const ClusterNodeDetailsRoleEnum = { + Primary: 'primary', + Replica: 'replica' +} as const; + +export type ClusterNodeDetailsRoleEnum = typeof ClusterNodeDetailsRoleEnum[keyof typeof ClusterNodeDetailsRoleEnum]; +export const ClusterNodeDetailsHealthEnum = { + Online: 'online', + Offline: 'offline', + Loading: 'loading' +} as const; + +export type ClusterNodeDetailsHealthEnum = typeof ClusterNodeDetailsHealthEnum[keyof typeof ClusterNodeDetailsHealthEnum]; + +/** + * + * @export + * @interface CommandExecution + */ +export interface CommandExecution { + /** + * Command execution id + * @type {string} + * @memberof CommandExecution + */ + 'id': string; + /** + * Database id + * @type {string} + * @memberof CommandExecution + */ + 'databaseId': string; + /** + * Redis command + * @type {string} + * @memberof CommandExecution + */ + 'command': string; + /** + * Workbench mode + * @type {string} + * @memberof CommandExecution + */ + 'mode'?: CommandExecutionModeEnum; + /** + * Workbench result mode + * @type {string} + * @memberof CommandExecution + */ + 'resultsMode'?: CommandExecutionResultsModeEnum; + /** + * Workbench executions summary + * @type {ResultsSummary} + * @memberof CommandExecution + */ + 'summary'?: ResultsSummary; + /** + * Command execution result + * @type {Array} + * @memberof CommandExecution + */ + 'result': Array; + /** + * Result did not stored in db + * @type {boolean} + * @memberof CommandExecution + */ + 'isNotStored'?: boolean; + /** + * Date of command execution + * @type {string} + * @memberof CommandExecution + */ + 'createdAt': string; + /** + * Workbench command execution time + * @type {number} + * @memberof CommandExecution + */ + 'executionTime'?: number; + /** + * Logical database number. + * @type {number} + * @memberof CommandExecution + */ + 'db'?: number; + /** + * Command execution type. Used to distinguish between search and workbench + * @type {string} + * @memberof CommandExecution + */ + 'type'?: CommandExecutionTypeEnum; +} + +export const CommandExecutionModeEnum = { + Raw: 'RAW', + Ascii: 'ASCII' +} as const; + +export type CommandExecutionModeEnum = typeof CommandExecutionModeEnum[keyof typeof CommandExecutionModeEnum]; +export const CommandExecutionResultsModeEnum = { + Default: 'DEFAULT', + GroupMode: 'GROUP_MODE', + Silent: 'SILENT' +} as const; + +export type CommandExecutionResultsModeEnum = typeof CommandExecutionResultsModeEnum[keyof typeof CommandExecutionResultsModeEnum]; +export const CommandExecutionTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; + +export type CommandExecutionTypeEnum = typeof CommandExecutionTypeEnum[keyof typeof CommandExecutionTypeEnum]; + +/** + * + * @export + * @interface CommandExecutionFilter + */ +export interface CommandExecutionFilter { + /** + * Command execution type. Used to distinguish between search and workbench + * @type {string} + * @memberof CommandExecutionFilter + */ + 'type'?: CommandExecutionFilterTypeEnum; +} + +export const CommandExecutionFilterTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; + +export type CommandExecutionFilterTypeEnum = typeof CommandExecutionFilterTypeEnum[keyof typeof CommandExecutionFilterTypeEnum]; + +/** + * + * @export + * @interface CommandExecutionResult + */ +export interface CommandExecutionResult { + /** + * Redis CLI command execution status + * @type {string} + * @memberof CommandExecutionResult + */ + 'status': CommandExecutionResultStatusEnum; + /** + * Redis response + * @type {string} + * @memberof CommandExecutionResult + */ + 'response': string; + /** + * Flag showing if response was replaced with message notification about response size limit threshold + * @type {boolean} + * @memberof CommandExecutionResult + */ + 'sizeLimitExceeded': boolean; +} + +export const CommandExecutionResultStatusEnum = { + Success: 'success', + Fail: 'fail' +} as const; + +export type CommandExecutionResultStatusEnum = typeof CommandExecutionResultStatusEnum[keyof typeof CommandExecutionResultStatusEnum]; + +/** + * + * @export + * @interface ConsumerDto + */ +export interface ConsumerDto { + /** + * + * @type {ConsumerDtoName} + * @memberof ConsumerDto + */ + 'name': ConsumerDtoName; + /** + * The number of pending messages for the client, which are messages that were delivered but are yet to be acknowledged + * @type {number} + * @memberof ConsumerDto + */ + 'pending': number; + /** + * The number of milliseconds that have passed since the consumer last interacted with the server + * @type {number} + * @memberof ConsumerDto + */ + 'idle': number; +} +/** + * @type ConsumerDtoName + * The consumer\'s name + * @export + */ +export type ConsumerDtoName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface ConsumerGroupDto + */ +export interface ConsumerGroupDto { + /** + * + * @type {ConsumerGroupDtoName} + * @memberof ConsumerGroupDto + */ + 'name': ConsumerGroupDtoName; + /** + * Number of consumers + * @type {number} + * @memberof ConsumerGroupDto + */ + 'consumers': number; + /** + * Number of pending messages + * @type {number} + * @memberof ConsumerGroupDto + */ + 'pending': number; + /** + * Smallest Id of the message that is pending in the group + * @type {string} + * @memberof ConsumerGroupDto + */ + 'smallestPendingId': string; + /** + * Greatest Id of the message that is pending in the group + * @type {string} + * @memberof ConsumerGroupDto + */ + 'greatestPendingId': string; + /** + * Id of last delivered message + * @type {string} + * @memberof ConsumerGroupDto + */ + 'lastDeliveredId': string; +} +/** + * @type ConsumerGroupDtoName + * Consumer Group name + * @export + */ +export type ConsumerGroupDtoName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface CreateBasicSshOptionsDto + */ +export interface CreateBasicSshOptionsDto { + /** + * The hostname of SSH server + * @type {string} + * @memberof CreateBasicSshOptionsDto + */ + 'host': string; + /** + * The port of SSH server + * @type {number} + * @memberof CreateBasicSshOptionsDto + */ + 'port': number; + /** + * SSH username + * @type {string} + * @memberof CreateBasicSshOptionsDto + */ + 'username'?: string; + /** + * The SSH password + * @type {string} + * @memberof CreateBasicSshOptionsDto + */ + 'password'?: string; +} +/** + * + * @export + * @interface CreateCaCertificateDto + */ +export interface CreateCaCertificateDto { + /** + * Certificate name + * @type {string} + * @memberof CreateCaCertificateDto + */ + 'name': string; + /** + * Certificate body + * @type {string} + * @memberof CreateCaCertificateDto + */ + 'certificate': string; + /** + * Whether the certificate was created from a file or environment variables at startup + * @type {boolean} + * @memberof CreateCaCertificateDto + */ + 'isPreSetup'?: boolean; +} +/** + * + * @export + * @interface CreateCertSshOptionsDto + */ +export interface CreateCertSshOptionsDto { + /** + * The hostname of SSH server + * @type {string} + * @memberof CreateCertSshOptionsDto + */ + 'host': string; + /** + * The port of SSH server + * @type {number} + * @memberof CreateCertSshOptionsDto + */ + 'port': number; + /** + * SSH username + * @type {string} + * @memberof CreateCertSshOptionsDto + */ + 'username'?: string; + /** + * The SSH private key + * @type {string} + * @memberof CreateCertSshOptionsDto + */ + 'privateKey'?: string; + /** + * The SSH passphrase + * @type {string} + * @memberof CreateCertSshOptionsDto + */ + 'passphrase'?: string; +} +/** + * + * @export + * @interface CreateCliClientResponse + */ +export interface CreateCliClientResponse { + /** + * Client uuid + * @type {string} + * @memberof CreateCliClientResponse + */ + 'uuid': string; +} +/** + * + * @export + * @interface CreateClientCertificateDto + */ +export interface CreateClientCertificateDto { + /** + * Certificate name + * @type {string} + * @memberof CreateClientCertificateDto + */ + 'name': string; + /** + * Certificate body + * @type {string} + * @memberof CreateClientCertificateDto + */ + 'certificate': string; + /** + * Key body + * @type {string} + * @memberof CreateClientCertificateDto + */ + 'key': string; + /** + * Whether the certificate was created from a file or environment variables at startup + * @type {boolean} + * @memberof CreateClientCertificateDto + */ + 'isPreSetup'?: boolean; +} +/** + * + * @export + * @interface CreateCloudJobDto + */ +export interface CreateCloudJobDto { + /** + * Job name to create + * @type {string} + * @memberof CreateCloudJobDto + */ + 'name': CreateCloudJobDtoNameEnum; + /** + * Mod in which to run the job. + * @type {string} + * @memberof CreateCloudJobDto + */ + 'runMode': CreateCloudJobDtoRunModeEnum; + /** + * + * @type {CreateCloudJobDtoData} + * @memberof CreateCloudJobDto + */ + 'data'?: CreateCloudJobDtoData; +} + +export const CreateCloudJobDtoNameEnum = { + CreateFreeSubscriptionAndDatabase: 'CREATE_FREE_SUBSCRIPTION_AND_DATABASE', + CreateFreeDatabase: 'CREATE_FREE_DATABASE', + CreateFreeSubscription: 'CREATE_FREE_SUBSCRIPTION', + ImportFreeDatabase: 'IMPORT_FREE_DATABASE', + WaitForActiveDatabase: 'WAIT_FOR_ACTIVE_DATABASE', + WaitForActiveSubscription: 'WAIT_FOR_ACTIVE_SUBSCRIPTION', + WaitForTask: 'WAIT_FOR_TASK', + Unknown: 'UNKNOWN' +} as const; + +export type CreateCloudJobDtoNameEnum = typeof CreateCloudJobDtoNameEnum[keyof typeof CreateCloudJobDtoNameEnum]; +export const CreateCloudJobDtoRunModeEnum = { + Async: 'async', + Sync: 'sync' +} as const; + +export type CreateCloudJobDtoRunModeEnum = typeof CreateCloudJobDtoRunModeEnum[keyof typeof CreateCloudJobDtoRunModeEnum]; + +/** + * @type CreateCloudJobDtoData + * Any data for create a job. + * @export + */ +export type CreateCloudJobDtoData = CreateDatabaseCloudJobDataDto | CreateSubscriptionAndDatabaseCloudJobDataDto | ImportDatabaseCloudJobDataDto; + +/** + * + * @export + * @interface CreateCommandExecutionDto + */ +export interface CreateCommandExecutionDto { + /** + * Redis command + * @type {string} + * @memberof CreateCommandExecutionDto + */ + 'command': string; + /** + * Workbench mode + * @type {string} + * @memberof CreateCommandExecutionDto + */ + 'mode'?: CreateCommandExecutionDtoModeEnum; + /** + * Workbench result mode + * @type {string} + * @memberof CreateCommandExecutionDto + */ + 'resultsMode'?: CreateCommandExecutionDtoResultsModeEnum; + /** + * Command execution type. Used to distinguish between search and workbench + * @type {string} + * @memberof CreateCommandExecutionDto + */ + 'type'?: CreateCommandExecutionDtoTypeEnum; +} + +export const CreateCommandExecutionDtoModeEnum = { + Raw: 'RAW', + Ascii: 'ASCII' +} as const; + +export type CreateCommandExecutionDtoModeEnum = typeof CreateCommandExecutionDtoModeEnum[keyof typeof CreateCommandExecutionDtoModeEnum]; +export const CreateCommandExecutionDtoResultsModeEnum = { + Default: 'DEFAULT', + GroupMode: 'GROUP_MODE', + Silent: 'SILENT' +} as const; + +export type CreateCommandExecutionDtoResultsModeEnum = typeof CreateCommandExecutionDtoResultsModeEnum[keyof typeof CreateCommandExecutionDtoResultsModeEnum]; +export const CreateCommandExecutionDtoTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; + +export type CreateCommandExecutionDtoTypeEnum = typeof CreateCommandExecutionDtoTypeEnum[keyof typeof CreateCommandExecutionDtoTypeEnum]; + +/** + * + * @export + * @interface CreateCommandExecutionsDto + */ +export interface CreateCommandExecutionsDto { + /** + * Workbench mode + * @type {string} + * @memberof CreateCommandExecutionsDto + */ + 'mode'?: CreateCommandExecutionsDtoModeEnum; + /** + * Workbench result mode + * @type {string} + * @memberof CreateCommandExecutionsDto + */ + 'resultsMode'?: CreateCommandExecutionsDtoResultsModeEnum; + /** + * Command execution type. Used to distinguish between search and workbench + * @type {string} + * @memberof CreateCommandExecutionsDto + */ + 'type'?: CreateCommandExecutionsDtoTypeEnum; + /** + * Redis commands + * @type {Array} + * @memberof CreateCommandExecutionsDto + */ + 'commands': Array; +} + +export const CreateCommandExecutionsDtoModeEnum = { + Raw: 'RAW', + Ascii: 'ASCII' +} as const; + +export type CreateCommandExecutionsDtoModeEnum = typeof CreateCommandExecutionsDtoModeEnum[keyof typeof CreateCommandExecutionsDtoModeEnum]; +export const CreateCommandExecutionsDtoResultsModeEnum = { + Default: 'DEFAULT', + GroupMode: 'GROUP_MODE', + Silent: 'SILENT' +} as const; + +export type CreateCommandExecutionsDtoResultsModeEnum = typeof CreateCommandExecutionsDtoResultsModeEnum[keyof typeof CreateCommandExecutionsDtoResultsModeEnum]; +export const CreateCommandExecutionsDtoTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; + +export type CreateCommandExecutionsDtoTypeEnum = typeof CreateCommandExecutionsDtoTypeEnum[keyof typeof CreateCommandExecutionsDtoTypeEnum]; + +/** + * + * @export + * @interface CreateConsumerGroupDto + */ +export interface CreateConsumerGroupDto { + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof CreateConsumerGroupDto + */ + 'name': GetConsumersDtoGroupName; + /** + * Id of last delivered message + * @type {string} + * @memberof CreateConsumerGroupDto + */ + 'lastDeliveredId': string; +} +/** + * + * @export + * @interface CreateConsumerGroupsDto + */ +export interface CreateConsumerGroupsDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateConsumerGroupsDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * List of consumer groups to create + * @type {Array} + * @memberof CreateConsumerGroupsDto + */ + 'consumerGroups': Array; +} +/** + * + * @export + * @interface CreateDatabaseAnalysisDto + */ +export interface CreateDatabaseAnalysisDto { + /** + * Namespace delimiter + * @type {string} + * @memberof CreateDatabaseAnalysisDto + */ + 'delimiter': string; + /** + * Filters for scan operation + * @type {ScanFilter} + * @memberof CreateDatabaseAnalysisDto + */ + 'filter': ScanFilter; +} +/** + * + * @export + * @interface CreateDatabaseCloudJobDataDto + */ +export interface CreateDatabaseCloudJobDataDto { + /** + * Subscription id for create a database. + * @type {number} + * @memberof CreateDatabaseCloudJobDataDto + */ + 'subscriptionId': number; +} +/** + * + * @export + * @interface CreateDatabaseDto + */ +export interface CreateDatabaseDto { + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof CreateDatabaseDto + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof CreateDatabaseDto + */ + 'port': number; + /** + * A name for your Redis database. + * @type {string} + * @memberof CreateDatabaseDto + */ + 'name': string; + /** + * Logical database number. + * @type {number} + * @memberof CreateDatabaseDto + */ + 'db'?: number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof CreateDatabaseDto + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof CreateDatabaseDto + */ + 'password'?: string; + /** + * Connection timeout + * @type {number} + * @memberof CreateDatabaseDto + */ + 'timeout'?: number; + /** + * The database name from provider + * @type {string} + * @memberof CreateDatabaseDto + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof CreateDatabaseDto + */ + 'provider'?: string; + /** + * Redis OSS Sentinel master group. + * @type {SentinelMaster} + * @memberof CreateDatabaseDto + */ + 'sentinelMaster'?: SentinelMaster; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof CreateDatabaseDto + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof CreateDatabaseDto + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof CreateDatabaseDto + */ + 'verifyServerCert'?: boolean; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof CreateDatabaseDto + */ + 'ssh'?: boolean; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof CreateDatabaseDto + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Database compressor + * @type {string} + * @memberof CreateDatabaseDto + */ + 'compressor'?: CreateDatabaseDtoCompressorEnum; + /** + * Key name format + * @type {string} + * @memberof CreateDatabaseDto + */ + 'keyNameFormat'?: CreateDatabaseDtoKeyNameFormatEnum; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof CreateDatabaseDto + */ + 'forceStandalone'?: boolean; + /** + * + * @type {CreateDatabaseDtoCaCert} + * @memberof CreateDatabaseDto + */ + 'caCert'?: CreateDatabaseDtoCaCert; + /** + * + * @type {CreateDatabaseDtoClientCert} + * @memberof CreateDatabaseDto + */ + 'clientCert'?: CreateDatabaseDtoClientCert; + /** + * + * @type {CreateDatabaseDtoSshOptions} + * @memberof CreateDatabaseDto + */ + 'sshOptions'?: CreateDatabaseDtoSshOptions; + /** + * Tags associated with the database. + * @type {Array} + * @memberof CreateDatabaseDto + */ + 'tags'?: Array; +} + +export const CreateDatabaseDtoCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type CreateDatabaseDtoCompressorEnum = typeof CreateDatabaseDtoCompressorEnum[keyof typeof CreateDatabaseDtoCompressorEnum]; +export const CreateDatabaseDtoKeyNameFormatEnum = { + Unicode: 'Unicode', + Hex: 'HEX' +} as const; + +export type CreateDatabaseDtoKeyNameFormatEnum = typeof CreateDatabaseDtoKeyNameFormatEnum[keyof typeof CreateDatabaseDtoKeyNameFormatEnum]; + +/** + * @type CreateDatabaseDtoCaCert + * CA Certificate + * @export + */ +export type CreateDatabaseDtoCaCert = CreateCaCertificateDto | UseCaCertificateDto; + +/** + * @type CreateDatabaseDtoClientCert + * Client Certificate + * @export + */ +export type CreateDatabaseDtoClientCert = CreateClientCertificateDto | UseCaCertificateDto; + +/** + * @type CreateDatabaseDtoSshOptions + * SSH Options + * @export + */ +export type CreateDatabaseDtoSshOptions = CreateBasicSshOptionsDto | CreateCertSshOptionsDto; + +/** + * + * @export + * @interface CreateHashWithExpireDto + */ +export interface CreateHashWithExpireDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateHashWithExpireDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Hash fields + * @type {Array} + * @memberof CreateHashWithExpireDto + */ + 'fields': Array; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof CreateHashWithExpireDto + */ + 'expire'?: number; +} +/** + * + * @export + * @interface CreateListWithExpireDto + */ +export interface CreateListWithExpireDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateListWithExpireDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * List element(s) + * @type {Array} + * @memberof CreateListWithExpireDto + */ + 'elements': Array; + /** + * In order to append elements to the end of the list, use the TAIL value, to prepend use HEAD value. Default: TAIL (when not specified) + * @type {string} + * @memberof CreateListWithExpireDto + */ + 'destination'?: CreateListWithExpireDtoDestinationEnum; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof CreateListWithExpireDto + */ + 'expire'?: number; +} + +export const CreateListWithExpireDtoDestinationEnum = { + Tail: 'TAIL', + Head: 'HEAD' +} as const; + +export type CreateListWithExpireDtoDestinationEnum = typeof CreateListWithExpireDtoDestinationEnum[keyof typeof CreateListWithExpireDtoDestinationEnum]; + +/** + * @type CreateListWithExpireDtoElementsInner + * @export + */ +export type CreateListWithExpireDtoElementsInner = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * @type CreateListWithExpireDtoKeyName + * Key Name + * @export + */ +export type CreateListWithExpireDtoKeyName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface CreateListWithExpireDtoKeyNameOneOf + */ +export interface CreateListWithExpireDtoKeyNameOneOf { + /** + * + * @type {string} + * @memberof CreateListWithExpireDtoKeyNameOneOf + */ + 'type': CreateListWithExpireDtoKeyNameOneOfTypeEnum; + /** + * + * @type {Array} + * @memberof CreateListWithExpireDtoKeyNameOneOf + */ + 'data': Array; +} + +export const CreateListWithExpireDtoKeyNameOneOfTypeEnum = { + Buffer: 'Buffer' +} as const; + +export type CreateListWithExpireDtoKeyNameOneOfTypeEnum = typeof CreateListWithExpireDtoKeyNameOneOfTypeEnum[keyof typeof CreateListWithExpireDtoKeyNameOneOfTypeEnum]; + +/** + * + * @export + * @interface CreateOrUpdateDatabaseSettingDto + */ +export interface CreateOrUpdateDatabaseSettingDto { + /** + * Applied settings by user, by database + * @type {object} + * @memberof CreateOrUpdateDatabaseSettingDto + */ + 'data': object; +} +/** + * + * @export + * @interface CreatePluginStateDto + */ +export interface CreatePluginStateDto { + /** + * State can be anything except \"undefined\" + * @type {string} + * @memberof CreatePluginStateDto + */ + 'state': string; +} +/** + * + * @export + * @interface CreateRdiDto + */ +export interface CreateRdiDto { + /** + * Base url of API to connect to (for API type only) + * @type {string} + * @memberof CreateRdiDto + */ + 'url'?: string; + /** + * A name to associate with RDI + * @type {string} + * @memberof CreateRdiDto + */ + 'name': string; + /** + * RDI or API username + * @type {string} + * @memberof CreateRdiDto + */ + 'username'?: string; + /** + * RDI or API password + * @type {string} + * @memberof CreateRdiDto + */ + 'password'?: string; +} +/** + * + * @export + * @interface CreateRedisearchIndexDto + */ +export interface CreateRedisearchIndexDto { + /** + * + * @type {CreateRedisearchIndexDtoIndex} + * @memberof CreateRedisearchIndexDto + */ + 'index': CreateRedisearchIndexDtoIndex; + /** + * Type of keys to index + * @type {string} + * @memberof CreateRedisearchIndexDto + */ + 'type': CreateRedisearchIndexDtoTypeEnum; + /** + * Keys prefixes to find keys for index + * @type {Array} + * @memberof CreateRedisearchIndexDto + */ + 'prefixes'?: Array; + /** + * Fields to index + * @type {Array} + * @memberof CreateRedisearchIndexDto + */ + 'fields': Array; +} + +export const CreateRedisearchIndexDtoTypeEnum = { + Hash: 'hash', + Json: 'json' +} as const; + +export type CreateRedisearchIndexDtoTypeEnum = typeof CreateRedisearchIndexDtoTypeEnum[keyof typeof CreateRedisearchIndexDtoTypeEnum]; + +/** + * @type CreateRedisearchIndexDtoIndex + * Index Name + * @export + */ +export type CreateRedisearchIndexDtoIndex = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface CreateRedisearchIndexFieldDto + */ +export interface CreateRedisearchIndexFieldDto { + /** + * + * @type {CreateRedisearchIndexFieldDtoName} + * @memberof CreateRedisearchIndexFieldDto + */ + 'name': CreateRedisearchIndexFieldDtoName; + /** + * Type of how data must be indexed + * @type {string} + * @memberof CreateRedisearchIndexFieldDto + */ + 'type': CreateRedisearchIndexFieldDtoTypeEnum; +} + +export const CreateRedisearchIndexFieldDtoTypeEnum = { + Text: 'text', + Tag: 'tag', + Numeric: 'numeric', + Geo: 'geo', + Geoshape: 'geoshape', + Vector: 'vector' +} as const; + +export type CreateRedisearchIndexFieldDtoTypeEnum = typeof CreateRedisearchIndexFieldDtoTypeEnum[keyof typeof CreateRedisearchIndexFieldDtoTypeEnum]; + +/** + * @type CreateRedisearchIndexFieldDtoName + * Name of field to be indexed + * @export + */ +export type CreateRedisearchIndexFieldDtoName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface CreateRejsonRlWithExpireDto + */ +export interface CreateRejsonRlWithExpireDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateRejsonRlWithExpireDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Valid json string + * @type {string} + * @memberof CreateRejsonRlWithExpireDto + */ + 'data': string; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof CreateRejsonRlWithExpireDto + */ + 'expire'?: number; +} +/** + * + * @export + * @interface CreateSentinelDatabaseDto + */ +export interface CreateSentinelDatabaseDto { + /** + * The name under which the base will be saved in the application. + * @type {string} + * @memberof CreateSentinelDatabaseDto + */ + 'alias': string; + /** + * Sentinel master group name. + * @type {string} + * @memberof CreateSentinelDatabaseDto + */ + 'name': string; + /** + * The username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof CreateSentinelDatabaseDto + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof CreateSentinelDatabaseDto + */ + 'password'?: string; + /** + * Logical database number. + * @type {number} + * @memberof CreateSentinelDatabaseDto + */ + 'db'?: number; +} +/** + * + * @export + * @interface CreateSentinelDatabaseResponse + */ +export interface CreateSentinelDatabaseResponse { + /** + * Database instance id. + * @type {string} + * @memberof CreateSentinelDatabaseResponse + */ + 'id'?: string; + /** + * Sentinel master group name. + * @type {string} + * @memberof CreateSentinelDatabaseResponse + */ + 'name': string; + /** + * Add Sentinel Master status + * @type {string} + * @memberof CreateSentinelDatabaseResponse + */ + 'status': CreateSentinelDatabaseResponseStatusEnum; + /** + * Message + * @type {string} + * @memberof CreateSentinelDatabaseResponse + */ + 'message': string; + /** + * Error + * @type {object} + * @memberof CreateSentinelDatabaseResponse + */ + 'error'?: object; +} + +export const CreateSentinelDatabaseResponseStatusEnum = { + Success: 'success', + Fail: 'fail' +} as const; + +export type CreateSentinelDatabaseResponseStatusEnum = typeof CreateSentinelDatabaseResponseStatusEnum[keyof typeof CreateSentinelDatabaseResponseStatusEnum]; + +/** + * + * @export + * @interface CreateSentinelDatabasesDto + */ +export interface CreateSentinelDatabasesDto { + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof CreateSentinelDatabasesDto + */ + 'port': number; + /** + * Logical database number. + * @type {number} + * @memberof CreateSentinelDatabasesDto + */ + 'db'?: number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'password'?: string; + /** + * Connection timeout + * @type {number} + * @memberof CreateSentinelDatabasesDto + */ + 'timeout'?: number; + /** + * The database name from provider + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'provider'?: string; + /** + * Redis OSS Sentinel master group. + * @type {SentinelMaster} + * @memberof CreateSentinelDatabasesDto + */ + 'sentinelMaster'?: SentinelMaster; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof CreateSentinelDatabasesDto + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof CreateSentinelDatabasesDto + */ + 'verifyServerCert'?: boolean; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof CreateSentinelDatabasesDto + */ + 'ssh'?: boolean; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof CreateSentinelDatabasesDto + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Database compressor + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'compressor'?: CreateSentinelDatabasesDtoCompressorEnum; + /** + * Key name format + * @type {string} + * @memberof CreateSentinelDatabasesDto + */ + 'keyNameFormat'?: CreateSentinelDatabasesDtoKeyNameFormatEnum; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof CreateSentinelDatabasesDto + */ + 'forceStandalone'?: boolean; + /** + * + * @type {CreateDatabaseDtoCaCert} + * @memberof CreateSentinelDatabasesDto + */ + 'caCert'?: CreateDatabaseDtoCaCert; + /** + * + * @type {CreateDatabaseDtoClientCert} + * @memberof CreateSentinelDatabasesDto + */ + 'clientCert'?: CreateDatabaseDtoClientCert; + /** + * + * @type {CreateDatabaseDtoSshOptions} + * @memberof CreateSentinelDatabasesDto + */ + 'sshOptions'?: CreateDatabaseDtoSshOptions; + /** + * Tags associated with the database. + * @type {Array} + * @memberof CreateSentinelDatabasesDto + */ + 'tags'?: Array; + /** + * The Sentinel master group list. + * @type {Array} + * @memberof CreateSentinelDatabasesDto + */ + 'masters': Array; +} + +export const CreateSentinelDatabasesDtoCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type CreateSentinelDatabasesDtoCompressorEnum = typeof CreateSentinelDatabasesDtoCompressorEnum[keyof typeof CreateSentinelDatabasesDtoCompressorEnum]; +export const CreateSentinelDatabasesDtoKeyNameFormatEnum = { + Unicode: 'Unicode', + Hex: 'HEX' +} as const; + +export type CreateSentinelDatabasesDtoKeyNameFormatEnum = typeof CreateSentinelDatabasesDtoKeyNameFormatEnum[keyof typeof CreateSentinelDatabasesDtoKeyNameFormatEnum]; + +/** + * + * @export + * @interface CreateSetWithExpireDto + */ +export interface CreateSetWithExpireDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateSetWithExpireDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Set members + * @type {Array} + * @memberof CreateSetWithExpireDto + */ + 'members': Array; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof CreateSetWithExpireDto + */ + 'expire'?: number; +} +/** + * + * @export + * @interface CreateStreamDto + */ +export interface CreateStreamDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateStreamDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Entries to push + * @type {Array} + * @memberof CreateStreamDto + */ + 'entries': Array; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof CreateStreamDto + */ + 'expire'?: number; +} +/** + * + * @export + * @interface CreateSubscriptionAndDatabaseCloudJobDataDto + */ +export interface CreateSubscriptionAndDatabaseCloudJobDataDto { + /** + * Plan id for create a subscription. + * @type {number} + * @memberof CreateSubscriptionAndDatabaseCloudJobDataDto + */ + 'planId': number; + /** + * Use recommended settings + * @type {boolean} + * @memberof CreateSubscriptionAndDatabaseCloudJobDataDto + */ + 'isRecommendedSettings'?: boolean; +} +/** + * + * @export + * @interface CreateTagDto + */ +export interface CreateTagDto { + /** + * Key of the tag. + * @type {string} + * @memberof CreateTagDto + */ + 'key': string; + /** + * Value of the tag. + * @type {string} + * @memberof CreateTagDto + */ + 'value': string; +} +/** + * + * @export + * @interface CreateZSetWithExpireDto + */ +export interface CreateZSetWithExpireDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof CreateZSetWithExpireDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * ZSet members + * @type {Array} + * @memberof CreateZSetWithExpireDto + */ + 'members': Array; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof CreateZSetWithExpireDto + */ + 'expire'?: number; +} +/** + * + * @export + * @interface CustomTutorialManifest + */ +export interface CustomTutorialManifest { + /** + * + * @type {string} + * @memberof CustomTutorialManifest + */ + 'id': string; + /** + * + * @type {string} + * @memberof CustomTutorialManifest + */ + 'type': CustomTutorialManifestTypeEnum; + /** + * + * @type {string} + * @memberof CustomTutorialManifest + */ + 'label': string; + /** + * + * @type {string} + * @memberof CustomTutorialManifest + */ + 'summary': string; + /** + * + * @type {CustomTutorialManifestArgs} + * @memberof CustomTutorialManifest + */ + 'args'?: CustomTutorialManifestArgs; + /** + * + * @type {CustomTutorialManifest} + * @memberof CustomTutorialManifest + */ + 'children'?: CustomTutorialManifest; +} + +export const CustomTutorialManifestTypeEnum = { + CodeButton: 'code-button', + Group: 'group', + InternalLink: 'internal-link' +} as const; + +export type CustomTutorialManifestTypeEnum = typeof CustomTutorialManifestTypeEnum[keyof typeof CustomTutorialManifestTypeEnum]; + +/** + * + * @export + * @interface CustomTutorialManifestArgs + */ +export interface CustomTutorialManifestArgs { + /** + * + * @type {boolean} + * @memberof CustomTutorialManifestArgs + */ + 'path'?: boolean; + /** + * + * @type {boolean} + * @memberof CustomTutorialManifestArgs + */ + 'initialIsOpen'?: boolean; + /** + * + * @type {boolean} + * @memberof CustomTutorialManifestArgs + */ + 'withBorder'?: boolean; +} +/** + * + * @export + * @interface Database + */ +export interface Database { + /** + * Database id. + * @type {string} + * @memberof Database + */ + 'id': string; + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof Database + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof Database + */ + 'port': number; + /** + * A name for your Redis database. + * @type {string} + * @memberof Database + */ + 'name': string; + /** + * Logical database number. + * @type {number} + * @memberof Database + */ + 'db'?: number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof Database + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof Database + */ + 'password'?: string; + /** + * Connection timeout + * @type {number} + * @memberof Database + */ + 'timeout'?: number; + /** + * Connection Type + * @type {string} + * @memberof Database + */ + 'connectionType': DatabaseConnectionTypeEnum; + /** + * The database name from provider + * @type {string} + * @memberof Database + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof Database + */ + 'provider'?: string; + /** + * Time of the last connection to the database. + * @type {string} + * @memberof Database + */ + 'lastConnection': string; + /** + * Date of creation + * @type {string} + * @memberof Database + */ + 'createdAt': string; + /** + * Redis OSS Sentinel master group. + * @type {SentinelMaster} + * @memberof Database + */ + 'sentinelMaster'?: SentinelMaster; + /** + * OSS Cluster Nodes + * @type {Array} + * @memberof Database + */ + 'nodes'?: Array; + /** + * Loaded Redis modules. + * @type {Array} + * @memberof Database + */ + 'modules'?: Array; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof Database + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof Database + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof Database + */ + 'verifyServerCert'?: boolean; + /** + * CA Certificate + * @type {CaCertificate} + * @memberof Database + */ + 'caCert'?: CaCertificate; + /** + * Client Certificate + * @type {ClientCertificate} + * @memberof Database + */ + 'clientCert'?: ClientCertificate; + /** + * A new created connection + * @type {boolean} + * @memberof Database + */ + 'new'?: boolean; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof Database + */ + 'ssh'?: boolean; + /** + * SSH options + * @type {SshOptions} + * @memberof Database + */ + 'sshOptions'?: SshOptions; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof Database + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Database compressor + * @type {string} + * @memberof Database + */ + 'compressor'?: DatabaseCompressorEnum; + /** + * Key name format + * @type {string} + * @memberof Database + */ + 'keyNameFormat'?: DatabaseKeyNameFormatEnum; + /** + * The version your Redis server + * @type {string} + * @memberof Database + */ + 'version'?: string; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof Database + */ + 'forceStandalone'?: boolean; + /** + * Tags associated with the database. + * @type {Array} + * @memberof Database + */ + 'tags'?: Array; + /** + * Whether the database was created from a file or environment variables at startup + * @type {boolean} + * @memberof Database + */ + 'isPreSetup'?: boolean; +} + +export const DatabaseConnectionTypeEnum = { + Standalone: 'STANDALONE', + Cluster: 'CLUSTER', + Sentinel: 'SENTINEL', + NotConnected: 'NOT CONNECTED' +} as const; + +export type DatabaseConnectionTypeEnum = typeof DatabaseConnectionTypeEnum[keyof typeof DatabaseConnectionTypeEnum]; +export const DatabaseCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type DatabaseCompressorEnum = typeof DatabaseCompressorEnum[keyof typeof DatabaseCompressorEnum]; +export const DatabaseKeyNameFormatEnum = { + Unicode: 'Unicode', + Hex: 'HEX' +} as const; + +export type DatabaseKeyNameFormatEnum = typeof DatabaseKeyNameFormatEnum[keyof typeof DatabaseKeyNameFormatEnum]; + +/** + * + * @export + * @interface DatabaseAnalysis + */ +export interface DatabaseAnalysis { + /** + * Analysis id + * @type {string} + * @memberof DatabaseAnalysis + */ + 'id': string; + /** + * Database id + * @type {string} + * @memberof DatabaseAnalysis + */ + 'databaseId': string; + /** + * Filters for scan operation + * @type {ScanFilter} + * @memberof DatabaseAnalysis + */ + 'filter': ScanFilter; + /** + * Namespace delimiter + * @type {string} + * @memberof DatabaseAnalysis + */ + 'delimiter': string; + /** + * Analysis progress + * @type {AnalysisProgress} + * @memberof DatabaseAnalysis + */ + 'progress': AnalysisProgress; + /** + * Analysis created date (ISO string) + * @type {string} + * @memberof DatabaseAnalysis + */ + 'createdAt': string; + /** + * Total keys with details by types + * @type {SimpleSummary} + * @memberof DatabaseAnalysis + */ + 'totalKeys': SimpleSummary; + /** + * Total memory with details by types + * @type {SimpleSummary} + * @memberof DatabaseAnalysis + */ + 'totalMemory': SimpleSummary; + /** + * Top namespaces by keys number + * @type {Array} + * @memberof DatabaseAnalysis + */ + 'topKeysNsp': Array; + /** + * Top namespaces by memory + * @type {Array} + * @memberof DatabaseAnalysis + */ + 'topMemoryNsp': Array; + /** + * Top keys by key length (string length, list elements count, etc.) + * @type {Array} + * @memberof DatabaseAnalysis + */ + 'topKeysLength': Array; + /** + * Top keys by memory used + * @type {Array} + * @memberof DatabaseAnalysis + */ + 'topKeysMemory': Array; + /** + * Expiration groups + * @type {Array} + * @memberof DatabaseAnalysis + */ + 'expirationGroups': Array; + /** + * Recommendations + * @type {Array} + * @memberof DatabaseAnalysis + */ + 'recommendations': Array; + /** + * Logical database number. + * @type {number} + * @memberof DatabaseAnalysis + */ + 'db'?: number; +} +/** + * + * @export + * @interface DatabaseImportResponse + */ +export interface DatabaseImportResponse { + /** + * Total elements processed from the import file + * @type {number} + * @memberof DatabaseImportResponse + */ + 'total': number; + /** + * List of successfully imported database + * @type {DatabaseImportResult} + * @memberof DatabaseImportResponse + */ + 'success': DatabaseImportResult; + /** + * List of partially imported database + * @type {DatabaseImportResult} + * @memberof DatabaseImportResponse + */ + 'partial': DatabaseImportResult; + /** + * List of databases failed to import + * @type {DatabaseImportResult} + * @memberof DatabaseImportResponse + */ + 'fail': DatabaseImportResult; +} +/** + * + * @export + * @interface DatabaseImportResult + */ +export interface DatabaseImportResult { + /** + * Entry index from original json + * @type {number} + * @memberof DatabaseImportResult + */ + 'index': number; + /** + * Import status + * @type {string} + * @memberof DatabaseImportResult + */ + 'status': DatabaseImportResultStatusEnum; + /** + * Database host + * @type {string} + * @memberof DatabaseImportResult + */ + 'host'?: string; + /** + * Database port + * @type {number} + * @memberof DatabaseImportResult + */ + 'port'?: number; + /** + * Error message if any + * @type {string} + * @memberof DatabaseImportResult + */ + 'errors'?: string; +} + +export const DatabaseImportResultStatusEnum = { + Success: 'success', + Partial: 'partial', + Fail: 'fail' +} as const; + +export type DatabaseImportResultStatusEnum = typeof DatabaseImportResultStatusEnum[keyof typeof DatabaseImportResultStatusEnum]; + +/** + * + * @export + * @interface DatabaseOverview + */ +export interface DatabaseOverview { + /** + * Redis database version + * @type {string} + * @memberof DatabaseOverview + */ + 'version': string; + /** + * Total number of bytes allocated by Redis primary shards + * @type {number} + * @memberof DatabaseOverview + */ + 'usedMemory'?: number; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof DatabaseOverview + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Total number of keys inside Redis primary shards + * @type {number} + * @memberof DatabaseOverview + */ + 'totalKeys'?: number; + /** + * Nested object with total number of keys per logical database + * @type {number} + * @memberof DatabaseOverview + */ + 'totalKeysPerDb'?: number; + /** + * Median for connected clients in the all shards + * @type {number} + * @memberof DatabaseOverview + */ + 'connectedClients'?: number; + /** + * Sum of current commands per second in the all shards + * @type {number} + * @memberof DatabaseOverview + */ + 'opsPerSecond'?: number; + /** + * Sum of current network input in the all shards (kbps) + * @type {number} + * @memberof DatabaseOverview + */ + 'networkInKbps'?: number; + /** + * Sum of current network out in the all shards (kbps) + * @type {number} + * @memberof DatabaseOverview + */ + 'networkOutKbps'?: number; + /** + * Sum of current cpu usage in the all shards (%) + * @type {number} + * @memberof DatabaseOverview + */ + 'cpuUsagePercentage'?: number; + /** + * Database server name + * @type {string} + * @memberof DatabaseOverview + */ + 'serverName': string; +} +/** + * + * @export + * @interface DatabaseRecommendation + */ +export interface DatabaseRecommendation { + /** + * Recommendation id + * @type {string} + * @memberof DatabaseRecommendation + */ + 'id': string; + /** + * Recommendation name + * @type {string} + * @memberof DatabaseRecommendation + */ + 'name': string; + /** + * Database ID to which recommendation belongs + * @type {string} + * @memberof DatabaseRecommendation + */ + 'databaseId': string; + /** + * Determines if recommendation was shown to user + * @type {boolean} + * @memberof DatabaseRecommendation + */ + 'read'?: boolean; + /** + * Should this recommendation shown to user + * @type {boolean} + * @memberof DatabaseRecommendation + */ + 'disabled'?: boolean; + /** + * Recommendation vote + * @type {string} + * @memberof DatabaseRecommendation + */ + 'vote'?: DatabaseRecommendationVoteEnum; + /** + * Should this recommendation hidden + * @type {boolean} + * @memberof DatabaseRecommendation + */ + 'hide'?: boolean; + /** + * Additional recommendation params + * @type {object} + * @memberof DatabaseRecommendation + */ + 'params'?: object; +} + +export const DatabaseRecommendationVoteEnum = { + VeryUseful: 'very useful', + Useful: 'useful', + NotUseful: 'not useful' +} as const; + +export type DatabaseRecommendationVoteEnum = typeof DatabaseRecommendationVoteEnum[keyof typeof DatabaseRecommendationVoteEnum]; + +/** + * + * @export + * @interface DatabaseRecommendationsResponse + */ +export interface DatabaseRecommendationsResponse { + /** + * Ordered recommendations list + * @type {Array} + * @memberof DatabaseRecommendationsResponse + */ + 'recommendations': Array; + /** + * Number of unread recommendations + * @type {number} + * @memberof DatabaseRecommendationsResponse + */ + 'totalUnread': number; +} +/** + * + * @export + * @interface DatabaseResponse + */ +export interface DatabaseResponse { + /** + * Database id. + * @type {string} + * @memberof DatabaseResponse + */ + 'id': string; + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof DatabaseResponse + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof DatabaseResponse + */ + 'port': number; + /** + * A name for your Redis database. + * @type {string} + * @memberof DatabaseResponse + */ + 'name': string; + /** + * Logical database number. + * @type {number} + * @memberof DatabaseResponse + */ + 'db'?: number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof DatabaseResponse + */ + 'username'?: string; + /** + * Connection timeout + * @type {number} + * @memberof DatabaseResponse + */ + 'timeout'?: number; + /** + * Connection Type + * @type {string} + * @memberof DatabaseResponse + */ + 'connectionType': DatabaseResponseConnectionTypeEnum; + /** + * The database name from provider + * @type {string} + * @memberof DatabaseResponse + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof DatabaseResponse + */ + 'provider'?: string; + /** + * Time of the last connection to the database. + * @type {string} + * @memberof DatabaseResponse + */ + 'lastConnection': string; + /** + * Date of creation + * @type {string} + * @memberof DatabaseResponse + */ + 'createdAt': string; + /** + * OSS Cluster Nodes + * @type {Array} + * @memberof DatabaseResponse + */ + 'nodes'?: Array; + /** + * Loaded Redis modules. + * @type {Array} + * @memberof DatabaseResponse + */ + 'modules'?: Array; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof DatabaseResponse + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof DatabaseResponse + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof DatabaseResponse + */ + 'verifyServerCert'?: boolean; + /** + * CA Certificate + * @type {CaCertificate} + * @memberof DatabaseResponse + */ + 'caCert'?: CaCertificate; + /** + * Client Certificate + * @type {ClientCertificate} + * @memberof DatabaseResponse + */ + 'clientCert'?: ClientCertificate; + /** + * A new created connection + * @type {boolean} + * @memberof DatabaseResponse + */ + 'new'?: boolean; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof DatabaseResponse + */ + 'ssh'?: boolean; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof DatabaseResponse + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Database compressor + * @type {string} + * @memberof DatabaseResponse + */ + 'compressor'?: DatabaseResponseCompressorEnum; + /** + * Key name format + * @type {string} + * @memberof DatabaseResponse + */ + 'keyNameFormat'?: DatabaseResponseKeyNameFormatEnum; + /** + * The version your Redis server + * @type {string} + * @memberof DatabaseResponse + */ + 'version'?: string; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof DatabaseResponse + */ + 'forceStandalone'?: boolean; + /** + * Tags associated with the database. + * @type {Array} + * @memberof DatabaseResponse + */ + 'tags'?: Array; + /** + * Whether the database was created from a file or environment variables at startup + * @type {boolean} + * @memberof DatabaseResponse + */ + 'isPreSetup'?: boolean; + /** + * The database password flag (true if password was set) + * @type {boolean} + * @memberof DatabaseResponse + */ + 'password'?: boolean; + /** + * Ssh options + * @type {SshOptionsResponse} + * @memberof DatabaseResponse + */ + 'sshOptions'?: SshOptionsResponse; + /** + * Sentinel master + * @type {SentinelMasterResponse} + * @memberof DatabaseResponse + */ + 'sentinelMaster'?: SentinelMasterResponse; +} + +export const DatabaseResponseConnectionTypeEnum = { + Standalone: 'STANDALONE', + Cluster: 'CLUSTER', + Sentinel: 'SENTINEL', + NotConnected: 'NOT CONNECTED' +} as const; + +export type DatabaseResponseConnectionTypeEnum = typeof DatabaseResponseConnectionTypeEnum[keyof typeof DatabaseResponseConnectionTypeEnum]; +export const DatabaseResponseCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type DatabaseResponseCompressorEnum = typeof DatabaseResponseCompressorEnum[keyof typeof DatabaseResponseCompressorEnum]; +export const DatabaseResponseKeyNameFormatEnum = { + Unicode: 'Unicode', + Hex: 'HEX' +} as const; + +export type DatabaseResponseKeyNameFormatEnum = typeof DatabaseResponseKeyNameFormatEnum[keyof typeof DatabaseResponseKeyNameFormatEnum]; + +/** + * + * @export + * @interface DatabaseSettings + */ +export interface DatabaseSettings { + /** + * Database id + * @type {string} + * @memberof DatabaseSettings + */ + 'databaseId': string; + /** + * Applied settings by user, by database + * @type {object} + * @memberof DatabaseSettings + */ + 'data': object; +} +/** + * + * @export + * @interface DeleteBrowserHistoryItemsDto + */ +export interface DeleteBrowserHistoryItemsDto { + /** + * The unique ID of the browser history requested + * @type {Array} + * @memberof DeleteBrowserHistoryItemsDto + */ + 'ids': Array; +} +/** + * + * @export + * @interface DeleteBrowserHistoryItemsResponse + */ +export interface DeleteBrowserHistoryItemsResponse { + /** + * Number of affected browser history items + * @type {number} + * @memberof DeleteBrowserHistoryItemsResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteClientResponse + */ +export interface DeleteClientResponse { + /** + * Number of affected clients + * @type {number} + * @memberof DeleteClientResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteConsumerGroupsDto + */ +export interface DeleteConsumerGroupsDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteConsumerGroupsDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Consumer group names + * @type {Array} + * @memberof DeleteConsumerGroupsDto + */ + 'consumerGroups': Array; +} +/** + * + * @export + * @interface DeleteConsumerGroupsResponse + */ +export interface DeleteConsumerGroupsResponse { + /** + * Number of deleted consumer groups + * @type {number} + * @memberof DeleteConsumerGroupsResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteConsumersDto + */ +export interface DeleteConsumersDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteConsumersDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof DeleteConsumersDto + */ + 'groupName': GetConsumersDtoGroupName; + /** + * Names of consumers to delete + * @type {Array} + * @memberof DeleteConsumersDto + */ + 'consumerNames': Array; +} +/** + * + * @export + * @interface DeleteDatabaseRecommendationDto + */ +export interface DeleteDatabaseRecommendationDto { + /** + * The unique IDs of the database recommendation requested + * @type {Array} + * @memberof DeleteDatabaseRecommendationDto + */ + 'ids': Array; +} +/** + * + * @export + * @interface DeleteDatabaseRecommendationResponse + */ +export interface DeleteDatabaseRecommendationResponse { + /** + * Number of affected recommendations + * @type {number} + * @memberof DeleteDatabaseRecommendationResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteDatabasesDto + */ +export interface DeleteDatabasesDto { + /** + * The unique ID of the database requested + * @type {Array} + * @memberof DeleteDatabasesDto + */ + 'ids': Array; +} +/** + * + * @export + * @interface DeleteFieldsFromHashDto + */ +export interface DeleteFieldsFromHashDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteFieldsFromHashDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Hash fields + * @type {Array} + * @memberof DeleteFieldsFromHashDto + */ + 'fields': Array; +} +/** + * + * @export + * @interface DeleteFieldsFromHashResponse + */ +export interface DeleteFieldsFromHashResponse { + /** + * Number of affected fields + * @type {number} + * @memberof DeleteFieldsFromHashResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteKeysDto + */ +export interface DeleteKeysDto { + /** + * Key name + * @type {Array} + * @memberof DeleteKeysDto + */ + 'keyNames': Array; +} +/** + * + * @export + * @interface DeleteKeysResponse + */ +export interface DeleteKeysResponse { + /** + * Number of affected keys + * @type {number} + * @memberof DeleteKeysResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteListElementsDto + */ +export interface DeleteListElementsDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteListElementsDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * In order to remove last elements of the list, use the TAIL value, else HEAD value + * @type {string} + * @memberof DeleteListElementsDto + */ + 'destination': DeleteListElementsDtoDestinationEnum; + /** + * Specifying the number of elements to remove from list. + * @type {number} + * @memberof DeleteListElementsDto + */ + 'count': number; +} + +export const DeleteListElementsDtoDestinationEnum = { + Tail: 'TAIL', + Head: 'HEAD' +} as const; + +export type DeleteListElementsDtoDestinationEnum = typeof DeleteListElementsDtoDestinationEnum[keyof typeof DeleteListElementsDtoDestinationEnum]; + +/** + * + * @export + * @interface DeleteListElementsResponse + */ +export interface DeleteListElementsResponse { + /** + * Removed elements from list + * @type {Array} + * @memberof DeleteListElementsResponse + */ + 'elements': Array; +} +/** + * + * @export + * @interface DeleteMembersFromSetDto + */ +export interface DeleteMembersFromSetDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteMembersFromSetDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Key members + * @type {Array} + * @memberof DeleteMembersFromSetDto + */ + 'members': Array; +} +/** + * + * @export + * @interface DeleteMembersFromSetResponse + */ +export interface DeleteMembersFromSetResponse { + /** + * Number of affected members + * @type {number} + * @memberof DeleteMembersFromSetResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteMembersFromZSetDto + */ +export interface DeleteMembersFromZSetDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteMembersFromZSetDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Key members + * @type {Array} + * @memberof DeleteMembersFromZSetDto + */ + 'members': Array; +} +/** + * + * @export + * @interface DeleteMembersFromZSetResponse + */ +export interface DeleteMembersFromZSetResponse { + /** + * Number of affected members + * @type {number} + * @memberof DeleteMembersFromZSetResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DeleteStreamEntriesDto + */ +export interface DeleteStreamEntriesDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof DeleteStreamEntriesDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Entries IDs + * @type {Array} + * @memberof DeleteStreamEntriesDto + */ + 'entries': Array; +} +/** + * + * @export + * @interface DeleteStreamEntriesResponse + */ +export interface DeleteStreamEntriesResponse { + /** + * Number of deleted entries + * @type {number} + * @memberof DeleteStreamEntriesResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface DiscoverCloudDatabasesDto + */ +export interface DiscoverCloudDatabasesDto { + /** + * Subscriptions where to discover databases + * @type {Array} + * @memberof DiscoverCloudDatabasesDto + */ + 'subscriptions': Array; +} +/** + * + * @export + * @interface DiscoverSentinelMastersDto + */ +export interface DiscoverSentinelMastersDto { + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof DiscoverSentinelMastersDto + */ + 'port': number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'password'?: string; + /** + * Connection timeout + * @type {number} + * @memberof DiscoverSentinelMastersDto + */ + 'timeout'?: number; + /** + * The database name from provider + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'provider'?: string; + /** + * Redis OSS Sentinel master group. + * @type {SentinelMaster} + * @memberof DiscoverSentinelMastersDto + */ + 'sentinelMaster'?: SentinelMaster; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof DiscoverSentinelMastersDto + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof DiscoverSentinelMastersDto + */ + 'verifyServerCert'?: boolean; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof DiscoverSentinelMastersDto + */ + 'ssh'?: boolean; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof DiscoverSentinelMastersDto + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Database compressor + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'compressor'?: DiscoverSentinelMastersDtoCompressorEnum; + /** + * Key name format + * @type {string} + * @memberof DiscoverSentinelMastersDto + */ + 'keyNameFormat'?: DiscoverSentinelMastersDtoKeyNameFormatEnum; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof DiscoverSentinelMastersDto + */ + 'forceStandalone'?: boolean; + /** + * + * @type {CreateDatabaseDtoCaCert} + * @memberof DiscoverSentinelMastersDto + */ + 'caCert'?: CreateDatabaseDtoCaCert; + /** + * + * @type {CreateDatabaseDtoClientCert} + * @memberof DiscoverSentinelMastersDto + */ + 'clientCert'?: CreateDatabaseDtoClientCert; + /** + * + * @type {CreateDatabaseDtoSshOptions} + * @memberof DiscoverSentinelMastersDto + */ + 'sshOptions'?: CreateDatabaseDtoSshOptions; + /** + * Tags associated with the database. + * @type {Array} + * @memberof DiscoverSentinelMastersDto + */ + 'tags'?: Array; +} + +export const DiscoverSentinelMastersDtoCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type DiscoverSentinelMastersDtoCompressorEnum = typeof DiscoverSentinelMastersDtoCompressorEnum[keyof typeof DiscoverSentinelMastersDtoCompressorEnum]; +export const DiscoverSentinelMastersDtoKeyNameFormatEnum = { + Unicode: 'Unicode', + Hex: 'HEX' +} as const; + +export type DiscoverSentinelMastersDtoKeyNameFormatEnum = typeof DiscoverSentinelMastersDtoKeyNameFormatEnum[keyof typeof DiscoverSentinelMastersDtoKeyNameFormatEnum]; + +/** + * + * @export + * @interface Endpoint + */ +export interface Endpoint { + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof Endpoint + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof Endpoint + */ + 'port': number; +} +/** + * + * @export + * @interface ExportDatabase + */ +export interface ExportDatabase { + /** + * Database id. + * @type {string} + * @memberof ExportDatabase + */ + 'id': string; + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof ExportDatabase + */ + 'host': string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof ExportDatabase + */ + 'port': number; + /** + * A name for your Redis database. + * @type {string} + * @memberof ExportDatabase + */ + 'name': string; + /** + * Logical database number. + * @type {number} + * @memberof ExportDatabase + */ + 'db'?: number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof ExportDatabase + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof ExportDatabase + */ + 'password'?: string; + /** + * Connection Type + * @type {string} + * @memberof ExportDatabase + */ + 'connectionType': ExportDatabaseConnectionTypeEnum; + /** + * The database name from provider + * @type {string} + * @memberof ExportDatabase + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof ExportDatabase + */ + 'provider'?: string; + /** + * Time of the last connection to the database. + * @type {string} + * @memberof ExportDatabase + */ + 'lastConnection': string; + /** + * Redis OSS Sentinel master group. + * @type {SentinelMaster} + * @memberof ExportDatabase + */ + 'sentinelMaster'?: SentinelMaster; + /** + * Loaded Redis modules. + * @type {Array} + * @memberof ExportDatabase + */ + 'modules'?: Array; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof ExportDatabase + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof ExportDatabase + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof ExportDatabase + */ + 'verifyServerCert'?: boolean; + /** + * CA Certificate + * @type {CaCertificate} + * @memberof ExportDatabase + */ + 'caCert'?: CaCertificate; + /** + * Client Certificate + * @type {ClientCertificate} + * @memberof ExportDatabase + */ + 'clientCert'?: ClientCertificate; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof ExportDatabase + */ + 'ssh'?: boolean; + /** + * SSH options + * @type {SshOptions} + * @memberof ExportDatabase + */ + 'sshOptions'?: SshOptions; + /** + * Database compressor + * @type {string} + * @memberof ExportDatabase + */ + 'compressor'?: ExportDatabaseCompressorEnum; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof ExportDatabase + */ + 'forceStandalone'?: boolean; + /** + * Tags associated with the database. + * @type {Array} + * @memberof ExportDatabase + */ + 'tags'?: Array; +} + +export const ExportDatabaseConnectionTypeEnum = { + Standalone: 'STANDALONE', + Cluster: 'CLUSTER', + Sentinel: 'SENTINEL', + NotConnected: 'NOT CONNECTED' +} as const; + +export type ExportDatabaseConnectionTypeEnum = typeof ExportDatabaseConnectionTypeEnum[keyof typeof ExportDatabaseConnectionTypeEnum]; +export const ExportDatabaseCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type ExportDatabaseCompressorEnum = typeof ExportDatabaseCompressorEnum[keyof typeof ExportDatabaseCompressorEnum]; + +/** + * + * @export + * @interface ExportDatabasesDto + */ +export interface ExportDatabasesDto { + /** + * The unique IDs of the databases requested + * @type {Array} + * @memberof ExportDatabasesDto + */ + 'ids': Array; + /** + * Export passwords and certificate bodies + * @type {boolean} + * @memberof ExportDatabasesDto + */ + 'withSecrets'?: boolean; +} +/** + * + * @export + * @interface FieldStatisticsDto + */ +export interface FieldStatisticsDto { + /** + * Field identifier + * @type {string} + * @memberof FieldStatisticsDto + */ + 'identifier': string; + /** + * Field attribute + * @type {string} + * @memberof FieldStatisticsDto + */ + 'attribute': string; + /** + * Field errors + * @type {object} + * @memberof FieldStatisticsDto + */ + 'Index Errors': object; +} +/** + * + * @export + * @interface GetAgreementsSpecResponse + */ +export interface GetAgreementsSpecResponse { + /** + * Version of agreements specification. + * @type {string} + * @memberof GetAgreementsSpecResponse + */ + 'version': string; + /** + * Agreements specification. + * @type {object} + * @memberof GetAgreementsSpecResponse + */ + 'agreements': object; +} +/** + * + * @export + * @interface GetAppSettingsResponse + */ +export interface GetAppSettingsResponse { + /** + * Applied application theme. + * @type {string} + * @memberof GetAppSettingsResponse + */ + 'theme': string; + /** + * Applied application date format + * @type {string} + * @memberof GetAppSettingsResponse + */ + 'dateFormat': string; + /** + * Applied application timezone + * @type {string} + * @memberof GetAppSettingsResponse + */ + 'timezone': GetAppSettingsResponseTimezoneEnum; + /** + * Applied the threshold for scan operation. + * @type {number} + * @memberof GetAppSettingsResponse + */ + 'scanThreshold': number; + /** + * Applied the batch of the commands for workbench. + * @type {number} + * @memberof GetAppSettingsResponse + */ + 'batchSize': number; + /** + * Flag indicating that terms and conditions are accepted via environment variable + * @type {boolean} + * @memberof GetAppSettingsResponse + */ + 'acceptTermsAndConditionsOverwritten': boolean; + /** + * Agreements set by the user. + * @type {GetUserAgreementsResponse} + * @memberof GetAppSettingsResponse + */ + 'agreements': GetUserAgreementsResponse; +} + +export const GetAppSettingsResponseTimezoneEnum = { + Local: 'local', + Utc: 'UTC' +} as const; + +export type GetAppSettingsResponseTimezoneEnum = typeof GetAppSettingsResponseTimezoneEnum[keyof typeof GetAppSettingsResponseTimezoneEnum]; + +/** + * + * @export + * @interface GetCloudSubscriptionDatabasesDto + */ +export interface GetCloudSubscriptionDatabasesDto { + /** + * Subscription Id + * @type {number} + * @memberof GetCloudSubscriptionDatabasesDto + */ + 'subscriptionId': number; + /** + * Subscription Id + * @type {string} + * @memberof GetCloudSubscriptionDatabasesDto + */ + 'subscriptionType': GetCloudSubscriptionDatabasesDtoSubscriptionTypeEnum; + /** + * + * @type {boolean} + * @memberof GetCloudSubscriptionDatabasesDto + */ + 'free'?: boolean; +} + +export const GetCloudSubscriptionDatabasesDtoSubscriptionTypeEnum = { + Flexible: 'flexible', + Fixed: 'fixed' +} as const; + +export type GetCloudSubscriptionDatabasesDtoSubscriptionTypeEnum = typeof GetCloudSubscriptionDatabasesDtoSubscriptionTypeEnum[keyof typeof GetCloudSubscriptionDatabasesDtoSubscriptionTypeEnum]; + +/** + * + * @export + * @interface GetConsumersDto + */ +export interface GetConsumersDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetConsumersDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof GetConsumersDto + */ + 'groupName': GetConsumersDtoGroupName; +} +/** + * @type GetConsumersDtoGroupName + * Consumer group name + * @export + */ +export type GetConsumersDtoGroupName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface GetHashFieldsDto + */ +export interface GetHashFieldsDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetHashFieldsDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. + * @type {number} + * @memberof GetHashFieldsDto + */ + 'cursor': number; + /** + * Specifying the number of elements to return. + * @type {number} + * @memberof GetHashFieldsDto + */ + 'count'?: number; + /** + * Iterate only elements matching a given pattern. + * @type {string} + * @memberof GetHashFieldsDto + */ + 'match'?: string; +} +/** + * + * @export + * @interface GetHashFieldsResponse + */ +export interface GetHashFieldsResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetHashFieldsResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. + * @type {number} + * @memberof GetHashFieldsResponse + */ + 'nextCursor': number; + /** + * Array of members. + * @type {Array} + * @memberof GetHashFieldsResponse + */ + 'fields': Array; + /** + * The number of fields in the currently-selected hash. + * @type {number} + * @memberof GetHashFieldsResponse + */ + 'total': number; +} +/** + * + * @export + * @interface GetKeyInfoDto + */ +export interface GetKeyInfoDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetKeyInfoDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Flag to determine if size should be requested and shown in the response + * @type {boolean} + * @memberof GetKeyInfoDto + */ + 'includeSize'?: boolean; +} +/** + * + * @export + * @interface GetKeyInfoResponse + */ +export interface GetKeyInfoResponse { + /** + * + * @type {CreateListWithExpireDtoElementsInner} + * @memberof GetKeyInfoResponse + */ + 'name': CreateListWithExpireDtoElementsInner; + /** + * + * @type {string} + * @memberof GetKeyInfoResponse + */ + 'type': string; + /** + * The remaining time to live of a key. If the property has value of -1, then the key has no expiration time (no limit). + * @type {number} + * @memberof GetKeyInfoResponse + */ + 'ttl': number; + /** + * The number of bytes that a key and its value require to be stored in RAM. + * @type {number} + * @memberof GetKeyInfoResponse + */ + 'size': number; + /** + * The length of the value stored in a key. + * @type {number} + * @memberof GetKeyInfoResponse + */ + 'length'?: number; +} +/** + * + * @export + * @interface GetKeysDto + */ +export interface GetKeysDto { + /** + * Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. + * @type {string} + * @memberof GetKeysDto + */ + 'cursor': string; + /** + * Specifying the number of elements to return. + * @type {number} + * @memberof GetKeysDto + */ + 'count'?: number; + /** + * Iterate only elements matching a given pattern. + * @type {string} + * @memberof GetKeysDto + */ + 'match'?: string; + /** + * Iterate through the database looking for keys of a specific type. + * @type {string} + * @memberof GetKeysDto + */ + 'type'?: GetKeysDtoTypeEnum; + /** + * Fetch keys info (type, size, ttl, length) + * @type {boolean} + * @memberof GetKeysDto + */ + 'keysInfo'?: boolean; + /** + * The maximum number of keys to scan + * @type {number} + * @memberof GetKeysDto + */ + 'scanThreshold'?: number; +} + +export const GetKeysDtoTypeEnum = { + String: 'string', + Hash: 'hash', + List: 'list', + Set: 'set', + Zset: 'zset', + Stream: 'stream', + ReJsonRl: 'ReJSON-RL', + Graphdata: 'graphdata', + TsdbType: 'TSDB-TYPE' +} as const; + +export type GetKeysDtoTypeEnum = typeof GetKeysDtoTypeEnum[keyof typeof GetKeysDtoTypeEnum]; + +/** + * + * @export + * @interface GetKeysInfoDto + */ +export interface GetKeysInfoDto { + /** + * List of keys + * @type {Array} + * @memberof GetKeysInfoDto + */ + 'keys': Array; + /** + * Iterate through the database looking for keys of a specific type. + * @type {string} + * @memberof GetKeysInfoDto + */ + 'type'?: GetKeysInfoDtoTypeEnum; + /** + * Flag to determine if keys should be requested and shown in the response + * @type {boolean} + * @memberof GetKeysInfoDto + */ + 'includeSize'?: boolean; + /** + * Flag to determine if TTL should be requested and shown in the response + * @type {boolean} + * @memberof GetKeysInfoDto + */ + 'includeTTL'?: boolean; +} + +export const GetKeysInfoDtoTypeEnum = { + String: 'string', + Hash: 'hash', + List: 'list', + Set: 'set', + Zset: 'zset', + Stream: 'stream', + ReJsonRl: 'ReJSON-RL', + Graphdata: 'graphdata', + TsdbType: 'TSDB-TYPE' +} as const; + +export type GetKeysInfoDtoTypeEnum = typeof GetKeysInfoDtoTypeEnum[keyof typeof GetKeysInfoDtoTypeEnum]; + +/** + * + * @export + * @interface GetKeysWithDetailsResponse + */ +export interface GetKeysWithDetailsResponse { + /** + * The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. + * @type {number} + * @memberof GetKeysWithDetailsResponse + */ + 'cursor': number; + /** + * The number of keys in the currently-selected database. + * @type {number} + * @memberof GetKeysWithDetailsResponse + */ + 'total': number; + /** + * The number of keys we tried to scan. Be aware that scanned is sum of COUNT parameters from redis commands + * @type {number} + * @memberof GetKeysWithDetailsResponse + */ + 'scanned': number; + /** + * Array of Keys. + * @type {Array} + * @memberof GetKeysWithDetailsResponse + */ + 'keys': Array; + /** + * Node host. In case when we are working with cluster + * @type {string} + * @memberof GetKeysWithDetailsResponse + */ + 'host'?: string; + /** + * Node port. In case when we are working with cluster + * @type {number} + * @memberof GetKeysWithDetailsResponse + */ + 'port'?: number; + /** + * The maximum number of results. For RediSearch this number is a value from \"FT.CONFIG GET maxsearchresults\" command. + * @type {number} + * @memberof GetKeysWithDetailsResponse + */ + 'maxResults'?: number; +} +/** + * + * @export + * @interface GetListElementResponse + */ +export interface GetListElementResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetListElementResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * + * @type {GetListElementResponseValue} + * @memberof GetListElementResponse + */ + 'value': GetListElementResponseValue; +} +/** + * @type GetListElementResponseValue + * Element value + * @export + */ +export type GetListElementResponseValue = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface GetListElementsDto + */ +export interface GetListElementsDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetListElementsDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Specifying the number of elements to skip. + * @type {number} + * @memberof GetListElementsDto + */ + 'offset': number; + /** + * Specifying the number of elements to return from starting at offset. + * @type {number} + * @memberof GetListElementsDto + */ + 'count': number; +} +/** + * + * @export + * @interface GetListElementsResponse + */ +export interface GetListElementsResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetListElementsResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * The number of elements in the currently-selected list. + * @type {number} + * @memberof GetListElementsResponse + */ + 'total': number; + /** + * Elements + * @type {Array} + * @memberof GetListElementsResponse + */ + 'elements': Array; +} +/** + * + * @export + * @interface GetPendingEntriesDto + */ +export interface GetPendingEntriesDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetPendingEntriesDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof GetPendingEntriesDto + */ + 'groupName': GetConsumersDtoGroupName; + /** + * + * @type {GetPendingEntriesDtoConsumerName} + * @memberof GetPendingEntriesDto + */ + 'consumerName': GetPendingEntriesDtoConsumerName; + /** + * Specifying the start id + * @type {string} + * @memberof GetPendingEntriesDto + */ + 'start'?: string; + /** + * Specifying the end id + * @type {string} + * @memberof GetPendingEntriesDto + */ + 'end'?: string; + /** + * Specifying the number of pending messages to return. + * @type {number} + * @memberof GetPendingEntriesDto + */ + 'count'?: number; +} +/** + * @type GetPendingEntriesDtoConsumerName + * Consumer name + * @export + */ +export type GetPendingEntriesDtoConsumerName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface GetRejsonRlDto + */ +export interface GetRejsonRlDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetRejsonRlDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Path to look for data + * @type {string} + * @memberof GetRejsonRlDto + */ + 'path'?: string; + /** + * Don\'t check for json size and return whole json in path when enabled + * @type {boolean} + * @memberof GetRejsonRlDto + */ + 'forceRetrieve'?: boolean; +} +/** + * + * @export + * @interface GetRejsonRlResponseDto + */ +export interface GetRejsonRlResponseDto { + /** + * Determines if json value was downloaded + * @type {boolean} + * @memberof GetRejsonRlResponseDto + */ + 'downloaded': boolean; + /** + * Type of data in the requested path + * @type {string} + * @memberof GetRejsonRlResponseDto + */ + 'type'?: string; + /** + * Requested path + * @type {string} + * @memberof GetRejsonRlResponseDto + */ + 'path'?: string; + /** + * + * @type {GetRejsonRlResponseDtoData} + * @memberof GetRejsonRlResponseDto + */ + 'data': GetRejsonRlResponseDtoData | null; +} +/** + * @type GetRejsonRlResponseDtoData + * JSON data that can be of various types + * @export + */ +export type GetRejsonRlResponseDtoData = Array | boolean | number | string; + +/** + * + * @export + * @interface GetServerInfoResponse + */ +export interface GetServerInfoResponse { + /** + * Server identifier. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'id': string; + /** + * Time of the first server launch. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'createDateTime': string; + /** + * Version of the application. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'appVersion': string; + /** + * The operating system platform. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'osPlatform': string; + /** + * Application build type. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'buildType': string; + /** + * Application package type. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'packageType': GetServerInfoResponsePackageTypeEnum; + /** + * Application type. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'appType': GetServerInfoResponseAppTypeEnum; + /** + * Fixed Redis database id. + * @type {string} + * @memberof GetServerInfoResponse + */ + 'fixedDatabaseId'?: string; + /** + * List of available encryption strategies + * @type {Array} + * @memberof GetServerInfoResponse + */ + 'encryptionStrategies': Array; + /** + * Server session id. + * @type {number} + * @memberof GetServerInfoResponse + */ + 'sessionId': number; +} + +export const GetServerInfoResponsePackageTypeEnum = { + Flatpak: 'flatpak', + Snap: 'snap', + UnknownLinux: 'unknown-linux', + AppImage: 'app-image', + Mas: 'mas', + UnknownDarwin: 'unknown-darwin', + WindowsStore: 'windows-store', + UnknownWindows: 'unknown-windows', + Unknown: 'unknown' +} as const; + +export type GetServerInfoResponsePackageTypeEnum = typeof GetServerInfoResponsePackageTypeEnum[keyof typeof GetServerInfoResponsePackageTypeEnum]; +export const GetServerInfoResponseAppTypeEnum = { + RedisStackWeb: 'REDIS_STACK_WEB', + RedisStackElectron: 'REDIS_STACK_ELECTRON', + Electron: 'ELECTRON', + ElectronEnterprise: 'ELECTRON_ENTERPRISE', + Docker: 'DOCKER', + VsCode: 'VS_CODE', + VsCodeEnterprise: 'VS_CODE_ENTERPRISE', + Unknown: 'UNKNOWN' +} as const; + +export type GetServerInfoResponseAppTypeEnum = typeof GetServerInfoResponseAppTypeEnum[keyof typeof GetServerInfoResponseAppTypeEnum]; + +/** + * + * @export + * @interface GetSetMembersDto + */ +export interface GetSetMembersDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetSetMembersDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. + * @type {number} + * @memberof GetSetMembersDto + */ + 'cursor': number; + /** + * Specifying the number of elements to return. + * @type {number} + * @memberof GetSetMembersDto + */ + 'count'?: number; + /** + * Iterate only elements matching a given pattern. + * @type {string} + * @memberof GetSetMembersDto + */ + 'match'?: string; +} +/** + * + * @export + * @interface GetSetMembersResponse + */ +export interface GetSetMembersResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetSetMembersResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. + * @type {number} + * @memberof GetSetMembersResponse + */ + 'nextCursor': number; + /** + * Array of members + * @type {Array} + * @memberof GetSetMembersResponse + */ + 'members': Array; + /** + * The number of members in the currently-selected set. + * @type {number} + * @memberof GetSetMembersResponse + */ + 'total': number; +} +/** + * + * @export + * @interface GetStreamEntriesDto + */ +export interface GetStreamEntriesDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetStreamEntriesDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Specifying the start id + * @type {string} + * @memberof GetStreamEntriesDto + */ + 'start'?: string; + /** + * Specifying the end id + * @type {string} + * @memberof GetStreamEntriesDto + */ + 'end'?: string; + /** + * Specifying the number of entries to return. + * @type {number} + * @memberof GetStreamEntriesDto + */ + 'count'?: number; + /** + * Get entries sort by IDs order. + * @type {string} + * @memberof GetStreamEntriesDto + */ + 'sortOrder': GetStreamEntriesDtoSortOrderEnum; +} + +export const GetStreamEntriesDtoSortOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; + +export type GetStreamEntriesDtoSortOrderEnum = typeof GetStreamEntriesDtoSortOrderEnum[keyof typeof GetStreamEntriesDtoSortOrderEnum]; + +/** + * + * @export + * @interface GetStreamEntriesResponse + */ +export interface GetStreamEntriesResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetStreamEntriesResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * Total number of entries + * @type {number} + * @memberof GetStreamEntriesResponse + */ + 'total': number; + /** + * Last generated id in the stream + * @type {string} + * @memberof GetStreamEntriesResponse + */ + 'lastGeneratedId': string; + /** + * First stream entry + * @type {StreamEntryDto} + * @memberof GetStreamEntriesResponse + */ + 'firstEntry': StreamEntryDto; + /** + * Last stream entry + * @type {StreamEntryDto} + * @memberof GetStreamEntriesResponse + */ + 'lastEntry': StreamEntryDto; + /** + * Stream entries + * @type {Array} + * @memberof GetStreamEntriesResponse + */ + 'entries': Array; +} +/** + * + * @export + * @interface GetStringInfoDto + */ +export interface GetStringInfoDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetStringInfoDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Start of string + * @type {number} + * @memberof GetStringInfoDto + */ + 'start': number; + /** + * End of string + * @type {number} + * @memberof GetStringInfoDto + */ + 'end': number; +} +/** + * + * @export + * @interface GetStringValueResponse + */ +export interface GetStringValueResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetStringValueResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * + * @type {SetStringWithExpireDtoValue} + * @memberof GetStringValueResponse + */ + 'value': SetStringWithExpireDtoValue; +} +/** + * + * @export + * @interface GetUserAgreementsResponse + */ +export interface GetUserAgreementsResponse { + /** + * Last version on agreements set by the user. + * @type {string} + * @memberof GetUserAgreementsResponse + */ + 'version': string; +} +/** + * + * @export + * @interface GetZSetMembersDto + */ +export interface GetZSetMembersDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof GetZSetMembersDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Specifying the number of elements to skip. + * @type {number} + * @memberof GetZSetMembersDto + */ + 'offset': number; + /** + * Specifying the number of elements to return from starting at offset. + * @type {number} + * @memberof GetZSetMembersDto + */ + 'count': number; + /** + * Get elements sorted by score. In order to sort the members from the highest to the lowest score, use the DESC value, else ASC value + * @type {string} + * @memberof GetZSetMembersDto + */ + 'sortOrder': GetZSetMembersDtoSortOrderEnum; +} + +export const GetZSetMembersDtoSortOrderEnum = { + Asc: 'ASC', + Desc: 'DESC' +} as const; + +export type GetZSetMembersDtoSortOrderEnum = typeof GetZSetMembersDtoSortOrderEnum[keyof typeof GetZSetMembersDtoSortOrderEnum]; + +/** + * + * @export + * @interface GetZSetResponse + */ +export interface GetZSetResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof GetZSetResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * The number of members in the currently-selected z-set. + * @type {number} + * @memberof GetZSetResponse + */ + 'total': number; + /** + * Array of Members. + * @type {Array} + * @memberof GetZSetResponse + */ + 'members': Array; +} +/** + * + * @export + * @interface HashFieldDto + */ +export interface HashFieldDto { + /** + * + * @type {HashFieldDtoField} + * @memberof HashFieldDto + */ + 'field': HashFieldDtoField; + /** + * + * @type {HashFieldDtoField} + * @memberof HashFieldDto + */ + 'value': HashFieldDtoField; + /** + * Set timeout on field in seconds + * @type {number} + * @memberof HashFieldDto + */ + 'expire'?: number; +} +/** + * @type HashFieldDtoField + * Field + * @export + */ +export type HashFieldDtoField = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface HashFieldTtlDto + */ +export interface HashFieldTtlDto { + /** + * + * @type {HashFieldDtoField} + * @memberof HashFieldTtlDto + */ + 'field': HashFieldDtoField; + /** + * Set a timeout on key in seconds. After the timeout has expired, the field will automatically be deleted. If the property has value of -1, then the field timeout will be removed. + * @type {number} + * @memberof HashFieldTtlDto + */ + 'expire': number; +} +/** + * + * @export + * @interface ImportCloudDatabaseDto + */ +export interface ImportCloudDatabaseDto { + /** + * Subscription id + * @type {number} + * @memberof ImportCloudDatabaseDto + */ + 'subscriptionId': number; + /** + * Database id + * @type {number} + * @memberof ImportCloudDatabaseDto + */ + 'databaseId': number; + /** + * + * @type {boolean} + * @memberof ImportCloudDatabaseDto + */ + 'free'?: boolean; +} +/** + * + * @export + * @interface ImportCloudDatabaseResponse + */ +export interface ImportCloudDatabaseResponse { + /** + * Subscription id + * @type {number} + * @memberof ImportCloudDatabaseResponse + */ + 'subscriptionId': number; + /** + * Database id + * @type {number} + * @memberof ImportCloudDatabaseResponse + */ + 'databaseId': number; + /** + * Add Redis Cloud database status + * @type {string} + * @memberof ImportCloudDatabaseResponse + */ + 'status': ImportCloudDatabaseResponseStatusEnum; + /** + * Message + * @type {string} + * @memberof ImportCloudDatabaseResponse + */ + 'message': string; + /** + * The database details. + * @type {CloudDatabase} + * @memberof ImportCloudDatabaseResponse + */ + 'databaseDetails'?: CloudDatabase; + /** + * Error + * @type {object} + * @memberof ImportCloudDatabaseResponse + */ + 'error'?: object; +} + +export const ImportCloudDatabaseResponseStatusEnum = { + Success: 'success', + Fail: 'fail' +} as const; + +export type ImportCloudDatabaseResponseStatusEnum = typeof ImportCloudDatabaseResponseStatusEnum[keyof typeof ImportCloudDatabaseResponseStatusEnum]; + +/** + * + * @export + * @interface ImportCloudDatabasesDto + */ +export interface ImportCloudDatabasesDto { + /** + * Cloud databases list. + * @type {Array} + * @memberof ImportCloudDatabasesDto + */ + 'databases': Array; +} +/** + * + * @export + * @interface ImportDatabaseCloudJobDataDto + */ +export interface ImportDatabaseCloudJobDataDto { + /** + * Subscription id of database + * @type {number} + * @memberof ImportDatabaseCloudJobDataDto + */ + 'subscriptionId': number; + /** + * Database id to import + * @type {number} + * @memberof ImportDatabaseCloudJobDataDto + */ + 'databaseId': number; + /** + * Subscription region + * @type {string} + * @memberof ImportDatabaseCloudJobDataDto + */ + 'region': string; + /** + * Subscription provider + * @type {string} + * @memberof ImportDatabaseCloudJobDataDto + */ + 'provider': string; +} +/** + * + * @export + * @interface IndexAttibuteDto + */ +export interface IndexAttibuteDto { + /** + * Field identifier + * @type {string} + * @memberof IndexAttibuteDto + */ + 'identifier': string; + /** + * Field attribute + * @type {string} + * @memberof IndexAttibuteDto + */ + 'attribute': string; + /** + * Field type + * @type {string} + * @memberof IndexAttibuteDto + */ + 'type': string; + /** + * Field weight + * @type {string} + * @memberof IndexAttibuteDto + */ + 'WEIGHT': string; + /** + * Field can be sorted + * @type {boolean} + * @memberof IndexAttibuteDto + */ + 'SORTABLE': boolean; + /** + * Attributes can have the NOINDEX option, which means they will not be indexed. + * @type {boolean} + * @memberof IndexAttibuteDto + */ + 'NOINDEX': boolean; + /** + * Attribute is case sensitive + * @type {boolean} + * @memberof IndexAttibuteDto + */ + 'CASESENSITIVE': boolean; + /** + * By default, for hashes (not with JSON) SORTABLE applies a normalization to the indexed value (characters set to lowercase, removal of diacritics). + * @type {boolean} + * @memberof IndexAttibuteDto + */ + 'UNF': boolean; + /** + * Text attributes can have the NOSTEM argument that disables stemming when indexing its values. This may be ideal for things like proper names. + * @type {boolean} + * @memberof IndexAttibuteDto + */ + 'NOSTEM': boolean; + /** + * Indicates how the text contained in the attribute is to be split into individual tags. The default is ,. The value must be a single character. + * @type {string} + * @memberof IndexAttibuteDto + */ + 'SEPARATOR': string; +} +/** + * + * @export + * @interface IndexDefinitionDto + */ +export interface IndexDefinitionDto { + /** + * key_type, hash or JSON + * @type {string} + * @memberof IndexDefinitionDto + */ + 'key_type': string; + /** + * Index prefixes given during create + * @type {Array} + * @memberof IndexDefinitionDto + */ + 'prefixes': Array; + /** + * Index default_score + * @type {string} + * @memberof IndexDefinitionDto + */ + 'default_score': string; +} +/** + * + * @export + * @interface IndexInfoDto + */ +export interface IndexInfoDto { + /** + * The index name that was defined when index was created + * @type {string} + * @memberof IndexInfoDto + */ + 'index_name': string; + /** + * The index options selected during FT.CREATE such as FILTER {filter}, LANGUAGE {default_lang}, etc. + * @type {IndexOptionsDto} + * @memberof IndexInfoDto + */ + 'index_options': IndexOptionsDto; + /** + * Includes key_type, hash or JSON; prefixes, if any; and default_score. + * @type {IndexDefinitionDto} + * @memberof IndexInfoDto + */ + 'index_definition': IndexDefinitionDto; + /** + * The index schema field names, types, and attributes. + * @type {Array} + * @memberof IndexInfoDto + */ + 'attributes': Array; + /** + * The number of documents. + * @type {string} + * @memberof IndexInfoDto + */ + 'num_docs': string; + /** + * The maximum document ID. + * @type {string} + * @memberof IndexInfoDto + */ + 'max_doc_id': string; + /** + * The number of distinct terms. + * @type {string} + * @memberof IndexInfoDto + */ + 'num_terms': string; + /** + * The total number of records. + * @type {string} + * @memberof IndexInfoDto + */ + 'num_records': string; + /** + * The memory used by the inverted index, which is the core data structure used for searching in RediSearch. The size is given in megabytes. + * @type {string} + * @memberof IndexInfoDto + */ + 'inverted_sz_mb': string; + /** + * The memory used by the vector index, which stores any vectors associated with each document. + * @type {string} + * @memberof IndexInfoDto + */ + 'vector_index_sz_mb': string; + /** + * The total number of blocks in the inverted index. + * @type {string} + * @memberof IndexInfoDto + */ + 'total_inverted_index_blocks': string; + /** + * The memory used by the offset vectors, which store positional information for terms in documents. + * @type {string} + * @memberof IndexInfoDto + */ + 'offset_vectors_sz_mb': string; + /** + * The memory used by the document table, which contains metadata about each document in the index. + * @type {string} + * @memberof IndexInfoDto + */ + 'doc_table_size_mb': string; + /** + * The memory used by sortable values, which are values associated with documents and used for sorting purposes. + * @type {string} + * @memberof IndexInfoDto + */ + 'sortable_values_size_mb': string; + /** + * Tag overhead memory usage in mb + * @type {string} + * @memberof IndexInfoDto + */ + 'tag_overhead_sz_mb': string; + /** + * Text overhead memory usage in mb + * @type {string} + * @memberof IndexInfoDto + */ + 'text_overhead_sz_mb': string; + /** + * Total index memory size in mb + * @type {string} + * @memberof IndexInfoDto + */ + 'total_index_memory_sz_mb': string; + /** + * The memory used by the key table, which stores the mapping between document IDs and Redis keys + * @type {string} + * @memberof IndexInfoDto + */ + 'key_table_size_mb': string; + /** + * The memory used by GEO-related fields. + * @type {string} + * @memberof IndexInfoDto + */ + 'geoshapes_sz_mb': string; + /** + * The average number of records (including deletions) per document. + * @type {string} + * @memberof IndexInfoDto + */ + 'records_per_doc_avg': string; + /** + * The average size of each record in bytes. + * @type {string} + * @memberof IndexInfoDto + */ + 'bytes_per_record_avg': string; + /** + * The average number of offsets (position information) per term. + * @type {string} + * @memberof IndexInfoDto + */ + 'offsets_per_term_avg': string; + /** + * The average number of bits used for offsets per record. + * @type {string} + * @memberof IndexInfoDto + */ + 'offset_bits_per_record_avg': string; + /** + * The number of failures encountered during indexing. + * @type {string} + * @memberof IndexInfoDto + */ + 'hash_indexing_failures': string; + /** + * The total time taken for indexing in seconds. + * @type {string} + * @memberof IndexInfoDto + */ + 'total_indexing_time': string; + /** + * Indicates whether the index is currently being generated. + * @type {string} + * @memberof IndexInfoDto + */ + 'indexing': string; + /** + * The percentage of the index that has been successfully generated. + * @type {string} + * @memberof IndexInfoDto + */ + 'percent_indexed': string; + /** + * The number of times the index has been used. + * @type {number} + * @memberof IndexInfoDto + */ + 'number_of_uses': number; + /** + * The index deletion flag. A value of 1 indicates index deletion is in progress. + * @type {number} + * @memberof IndexInfoDto + */ + 'cleaning': number; + /** + * Garbage collection statistics + * @type {object} + * @memberof IndexInfoDto + */ + 'gc_stats': object; + /** + * Cursor statistics + * @type {object} + * @memberof IndexInfoDto + */ + 'cursor_stats': object; + /** + * Dialect statistics: the number of times the index was searched using each DIALECT, 1 - 4. + * @type {object} + * @memberof IndexInfoDto + */ + 'dialect_stats': object; + /** + * Index error statistics, including indexing failures, last indexing error, and last indexing error key. + * @type {object} + * @memberof IndexInfoDto + */ + 'Index Errors': object; + /** + * Dialect statistics: the number of times the index was searched using each DIALECT, 1 - 4. + * @type {Array} + * @memberof IndexInfoDto + */ + 'field statistics': Array; +} +/** + * + * @export + * @interface IndexInfoRequestBodyDto + */ +export interface IndexInfoRequestBodyDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof IndexInfoRequestBodyDto + */ + 'index': CreateListWithExpireDtoKeyName; +} +/** + * + * @export + * @interface IndexOptionsDto + */ +export interface IndexOptionsDto { + /** + * is a filter expression with the full RediSearch aggregation expression language. + * @type {string} + * @memberof IndexOptionsDto + */ + 'filter': string; + /** + * if set, indicates the default language for documents in the index. Default is English. + * @type {string} + * @memberof IndexOptionsDto + */ + 'default_lang': string; +} +/** + * + * @export + * @interface Key + */ +export interface Key { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof Key + */ + 'name': CreateListWithExpireDtoKeyName; + /** + * Key type + * @type {string} + * @memberof Key + */ + 'type': string; + /** + * Memory used by key in bytes + * @type {number} + * @memberof Key + */ + 'memory': number; + /** + * Number of characters, elements, etc. based on type + * @type {number} + * @memberof Key + */ + 'length': number; + /** + * Key ttl + * @type {number} + * @memberof Key + */ + 'ttl': number; +} +/** + * + * @export + * @interface KeyDto + */ +export interface KeyDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof KeyDto + */ + 'keyName': CreateListWithExpireDtoKeyName; +} +/** + * + * @export + * @interface KeyTtlResponse + */ +export interface KeyTtlResponse { + /** + * The remaining time to live of a key that has a timeout. If value equals -2 then the key does not exist or has deleted. If value equals -1 then the key has no associated expire (No limit). + * @type {number} + * @memberof KeyTtlResponse + */ + 'ttl': number; +} +/** + * + * @export + * @interface ListRedisearchIndexesResponse + */ +export interface ListRedisearchIndexesResponse { + /** + * Indexes names + * @type {Array} + * @memberof ListRedisearchIndexesResponse + */ + 'indexes': Array; +} +/** + * + * @export + * @interface ModifyDatabaseRecommendationDto + */ +export interface ModifyDatabaseRecommendationDto { + /** + * Recommendation vote + * @type {string} + * @memberof ModifyDatabaseRecommendationDto + */ + 'vote'?: ModifyDatabaseRecommendationDtoVoteEnum; + /** + * Hide recommendation + * @type {boolean} + * @memberof ModifyDatabaseRecommendationDto + */ + 'hide'?: boolean; +} + +export const ModifyDatabaseRecommendationDtoVoteEnum = { + VeryUseful: 'very useful', + Useful: 'useful', + NotUseful: 'not useful' +} as const; + +export type ModifyDatabaseRecommendationDtoVoteEnum = typeof ModifyDatabaseRecommendationDtoVoteEnum[keyof typeof ModifyDatabaseRecommendationDtoVoteEnum]; + +/** + * + * @export + * @interface ModifyRejsonRlArrAppendDto + */ +export interface ModifyRejsonRlArrAppendDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof ModifyRejsonRlArrAppendDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Path of the json field + * @type {string} + * @memberof ModifyRejsonRlArrAppendDto + */ + 'path': string; + /** + * Array of valid serialized jsons + * @type {Array} + * @memberof ModifyRejsonRlArrAppendDto + */ + 'data': Array; +} +/** + * + * @export + * @interface ModifyRejsonRlSetDto + */ +export interface ModifyRejsonRlSetDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof ModifyRejsonRlSetDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Path of the json field + * @type {string} + * @memberof ModifyRejsonRlSetDto + */ + 'path': string; + /** + * Array of valid serialized jsons + * @type {string} + * @memberof ModifyRejsonRlSetDto + */ + 'data': string; +} +/** + * + * @export + * @interface NotificationsDto + */ +export interface NotificationsDto { + /** + * Ordered notifications list + * @type {Array} + * @memberof NotificationsDto + */ + 'notifications': Array; + /** + * Number of unread notifications + * @type {number} + * @memberof NotificationsDto + */ + 'totalUnread': number; +} +/** + * + * @export + * @interface NspSummary + */ +export interface NspSummary { + /** + * + * @type {NspSummaryNsp} + * @memberof NspSummary + */ + 'nsp': NspSummaryNsp; + /** + * Total memory used by namespace in bytes + * @type {number} + * @memberof NspSummary + */ + 'memory': number; + /** + * Total keys inside namespace + * @type {number} + * @memberof NspSummary + */ + 'keys': number; + /** + * Top namespaces by keys number + * @type {Array} + * @memberof NspSummary + */ + 'types': Array; +} +/** + * @type NspSummaryNsp + * Namespace + * @export + */ +export type NspSummaryNsp = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface NspTypeSummary + */ +export interface NspTypeSummary { + /** + * Type name + * @type {string} + * @memberof NspTypeSummary + */ + 'type': string; + /** + * Total memory in bytes inside particular data type + * @type {number} + * @memberof NspTypeSummary + */ + 'memory': number; + /** + * Total keys inside particular data type + * @type {number} + * @memberof NspTypeSummary + */ + 'keys': number; +} +/** + * + * @export + * @interface PendingEntryDto + */ +export interface PendingEntryDto { + /** + * Entry ID + * @type {string} + * @memberof PendingEntryDto + */ + 'id': string; + /** + * + * @type {GetPendingEntriesDtoConsumerName} + * @memberof PendingEntryDto + */ + 'consumerName': GetPendingEntriesDtoConsumerName; + /** + * The number of milliseconds that elapsed since the last time this message was delivered to this consumer + * @type {number} + * @memberof PendingEntryDto + */ + 'idle': number; + /** + * The number of times this message was delivered + * @type {number} + * @memberof PendingEntryDto + */ + 'delivered': number; +} +/** + * + * @export + * @interface PickTypeClass + */ +export interface PickTypeClass { + /** + * + * @type {string} + * @memberof PickTypeClass + */ + 'id': string; +} +/** + * + * @export + * @interface Plugin + */ +export interface Plugin { + /** + * Determine if plugin is built into Redisinsight + * @type {boolean} + * @memberof Plugin + */ + 'internal'?: boolean; + /** + * Module name from manifest + * @type {string} + * @memberof Plugin + */ + 'name': string; + /** + * Plugins base url + * @type {string} + * @memberof Plugin + */ + 'baseUrl': string; + /** + * Uri to main js file on the local server + * @type {string} + * @memberof Plugin + */ + 'main': string; + /** + * Uri to css file on the local server + * @type {string} + * @memberof Plugin + */ + 'styles': string; + /** + * Visualization field from manifest + * @type {Array} + * @memberof Plugin + */ + 'visualizations': Array; +} +/** + * + * @export + * @interface PluginCommandExecution + */ +export interface PluginCommandExecution { + /** + * Database id + * @type {string} + * @memberof PluginCommandExecution + */ + 'databaseId'?: string; + /** + * Redis command + * @type {string} + * @memberof PluginCommandExecution + */ + 'command'?: string; + /** + * Workbench mode + * @type {string} + * @memberof PluginCommandExecution + */ + 'mode'?: PluginCommandExecutionModeEnum; + /** + * Workbench result mode + * @type {string} + * @memberof PluginCommandExecution + */ + 'resultsMode'?: PluginCommandExecutionResultsModeEnum; + /** + * Workbench executions summary + * @type {ResultsSummary} + * @memberof PluginCommandExecution + */ + 'summary'?: ResultsSummary; + /** + * Command execution result + * @type {Array} + * @memberof PluginCommandExecution + */ + 'result'?: Array; + /** + * Result did not stored in db + * @type {boolean} + * @memberof PluginCommandExecution + */ + 'isNotStored'?: boolean; + /** + * Workbench command execution time + * @type {number} + * @memberof PluginCommandExecution + */ + 'executionTime'?: number; + /** + * Logical database number. + * @type {number} + * @memberof PluginCommandExecution + */ + 'db'?: number; + /** + * Command execution type. Used to distinguish between search and workbench + * @type {string} + * @memberof PluginCommandExecution + */ + 'type'?: PluginCommandExecutionTypeEnum; +} + +export const PluginCommandExecutionModeEnum = { + Raw: 'RAW', + Ascii: 'ASCII' +} as const; + +export type PluginCommandExecutionModeEnum = typeof PluginCommandExecutionModeEnum[keyof typeof PluginCommandExecutionModeEnum]; +export const PluginCommandExecutionResultsModeEnum = { + Default: 'DEFAULT', + GroupMode: 'GROUP_MODE', + Silent: 'SILENT' +} as const; + +export type PluginCommandExecutionResultsModeEnum = typeof PluginCommandExecutionResultsModeEnum[keyof typeof PluginCommandExecutionResultsModeEnum]; +export const PluginCommandExecutionTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; + +export type PluginCommandExecutionTypeEnum = typeof PluginCommandExecutionTypeEnum[keyof typeof PluginCommandExecutionTypeEnum]; + +/** + * + * @export + * @interface PluginState + */ +export interface PluginState { + /** + * Plugin visualization id. Should be unique per all plugins + * @type {string} + * @memberof PluginState + */ + 'visualizationId': string; + /** + * Command Execution id + * @type {string} + * @memberof PluginState + */ + 'commandExecutionId': string; + /** + * Stored state + * @type {string} + * @memberof PluginState + */ + 'state': string; + /** + * Date of creation + * @type {string} + * @memberof PluginState + */ + 'createdAt': string; + /** + * Date of updating + * @type {string} + * @memberof PluginState + */ + 'updatedAt': string; +} +/** + * + * @export + * @interface PluginVisualization + */ +export interface PluginVisualization { + /** + * + * @type {string} + * @memberof PluginVisualization + */ + 'id': string; + /** + * + * @type {string} + * @memberof PluginVisualization + */ + 'name': string; + /** + * + * @type {string} + * @memberof PluginVisualization + */ + 'activationMethod': string; + /** + * + * @type {Array} + * @memberof PluginVisualization + */ + 'matchCommands': Array; + /** + * + * @type {boolean} + * @memberof PluginVisualization + */ + 'default': boolean; + /** + * + * @type {string} + * @memberof PluginVisualization + */ + 'iconDark': string; + /** + * + * @type {string} + * @memberof PluginVisualization + */ + 'iconLight': string; +} +/** + * + * @export + * @interface PluginsResponse + */ +export interface PluginsResponse { + /** + * Uri to static resources required for plugins + * @type {string} + * @memberof PluginsResponse + */ + 'static': string; + /** + * List of available plugins + * @type {Array} + * @memberof PluginsResponse + */ + 'plugins': Array; +} +/** + * + * @export + * @interface PublishDto + */ +export interface PublishDto { + /** + * Message to send + * @type {string} + * @memberof PublishDto + */ + 'message': string; + /** + * Chanel name + * @type {string} + * @memberof PublishDto + */ + 'channel': string; +} +/** + * + * @export + * @interface PublishResponse + */ +export interface PublishResponse { + /** + * Number of clients message ws delivered + * @type {number} + * @memberof PublishResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface PushElementToListDto + */ +export interface PushElementToListDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof PushElementToListDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * List element(s) + * @type {Array} + * @memberof PushElementToListDto + */ + 'elements': Array; + /** + * In order to append elements to the end of the list, use the TAIL value, to prepend use HEAD value. Default: TAIL (when not specified) + * @type {string} + * @memberof PushElementToListDto + */ + 'destination'?: PushElementToListDtoDestinationEnum; +} + +export const PushElementToListDtoDestinationEnum = { + Tail: 'TAIL', + Head: 'HEAD' +} as const; + +export type PushElementToListDtoDestinationEnum = typeof PushElementToListDtoDestinationEnum[keyof typeof PushElementToListDtoDestinationEnum]; + +/** + * + * @export + * @interface PushListElementsResponse + */ +export interface PushListElementsResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof PushListElementsResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * The number of elements in the list after current operation. + * @type {number} + * @memberof PushListElementsResponse + */ + 'total': number; +} +/** + * @type PushListElementsResponseKeyName + * keyName + * @export + */ +export type PushListElementsResponseKeyName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface Rdi + */ +export interface Rdi { + /** + * RDI id. + * @type {string} + * @memberof Rdi + */ + 'id': string; + /** + * Base url of API to connect to (for API type only) + * @type {string} + * @memberof Rdi + */ + 'url'?: string; + /** + * A name to associate with RDI + * @type {string} + * @memberof Rdi + */ + 'name': string; + /** + * RDI or API username + * @type {string} + * @memberof Rdi + */ + 'username'?: string; + /** + * RDI or API password + * @type {string} + * @memberof Rdi + */ + 'password'?: string; + /** + * Time of the last connection to RDI. + * @type {string} + * @memberof Rdi + */ + 'lastConnection': string; + /** + * The version of RDI being used + * @type {string} + * @memberof Rdi + */ + 'version'?: string; +} +/** + * + * @export + * @interface RdiDryRunJobDto + */ +export interface RdiDryRunJobDto { + /** + * Input data + * @type {object} + * @memberof RdiDryRunJobDto + */ + 'input_data': object; + /** + * Job file + * @type {object} + * @memberof RdiDryRunJobDto + */ + 'job': object; +} +/** + * + * @export + * @interface RdiDryRunJobResponseDto + */ +export interface RdiDryRunJobResponseDto { + /** + * Dry run job transformations result + * @type {object} + * @memberof RdiDryRunJobResponseDto + */ + 'transformations': object; + /** + * Dry run job commands result + * @type {object} + * @memberof RdiDryRunJobResponseDto + */ + 'commands': object; +} +/** + * + * @export + * @interface RdiTemplateResponseDto + */ +export interface RdiTemplateResponseDto { + /** + * Template for rdi file + * @type {string} + * @memberof RdiTemplateResponseDto + */ + 'template': string; +} +/** + * + * @export + * @interface RdiTestConnectionsResponseDto + */ +export interface RdiTestConnectionsResponseDto { + /** + * Sources connection results + * @type {object} + * @memberof RdiTestConnectionsResponseDto + */ + 'sources': object; + /** + * Targets connection results + * @type {object} + * @memberof RdiTestConnectionsResponseDto + */ + 'targets': object; +} +/** + * + * @export + * @interface ReadNotificationsDto + */ +export interface ReadNotificationsDto { + /** + * Timestamp of notification + * @type {number} + * @memberof ReadNotificationsDto + */ + 'timestamp'?: number; + /** + * Type of notification + * @type {string} + * @memberof ReadNotificationsDto + */ + 'type'?: ReadNotificationsDtoTypeEnum; +} + +export const ReadNotificationsDtoTypeEnum = { + Global: 'global' +} as const; + +export type ReadNotificationsDtoTypeEnum = typeof ReadNotificationsDtoTypeEnum[keyof typeof ReadNotificationsDtoTypeEnum]; + +/** + * + * @export + * @interface Recommendation + */ +export interface Recommendation { + /** + * Recommendation name + * @type {string} + * @memberof Recommendation + */ + 'name': string; + /** + * Additional recommendation params + * @type {object} + * @memberof Recommendation + */ + 'params'?: object; + /** + * User vote + * @type {string} + * @memberof Recommendation + */ + 'vote'?: string; +} +/** + * + * @export + * @interface RecommendationVoteDto + */ +export interface RecommendationVoteDto { + /** + * Recommendation name + * @type {string} + * @memberof RecommendationVoteDto + */ + 'name': string; + /** + * User vote + * @type {string} + * @memberof RecommendationVoteDto + */ + 'vote': string; +} +/** + * + * @export + * @interface RedisDatabaseInfoResponse + */ +export interface RedisDatabaseInfoResponse { + /** + * Redis database version + * @type {string} + * @memberof RedisDatabaseInfoResponse + */ + 'version': string; + /** + * Value is \"master\" if the instance is replica of no one, or \"slave\" if the instance is a replica of some master instance + * @type {string} + * @memberof RedisDatabaseInfoResponse + */ + 'role'?: RedisDatabaseInfoResponseRoleEnum; + /** + * Redis database info from server section + * @type {object} + * @memberof RedisDatabaseInfoResponse + */ + 'server'?: object; + /** + * Various Redis stats + * @type {RedisDatabaseStatsDto} + * @memberof RedisDatabaseInfoResponse + */ + 'stats'?: RedisDatabaseStatsDto; + /** + * The number of Redis databases + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'databases'?: number; + /** + * Total number of bytes allocated by Redis using + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'usedMemory'?: number; + /** + * Total number of keys inside Redis database + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'totalKeys'?: number; + /** + * Number of client connections (excluding connections from replicas) + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'connectedClients'?: number; + /** + * Number of seconds since Redis server start + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'uptimeInSeconds'?: number; + /** + * The cache hit ratio represents the efficiency of cache usage + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'hitRatio'?: number; + /** + * The number of the cached lua scripts + * @type {number} + * @memberof RedisDatabaseInfoResponse + */ + 'cashedScripts'?: number; + /** + * Nodes info + * @type {Array} + * @memberof RedisDatabaseInfoResponse + */ + 'nodes'?: Array; +} + +export const RedisDatabaseInfoResponseRoleEnum = { + Master: 'master', + Slave: 'slave' +} as const; + +export type RedisDatabaseInfoResponseRoleEnum = typeof RedisDatabaseInfoResponseRoleEnum[keyof typeof RedisDatabaseInfoResponseRoleEnum]; + +/** + * + * @export + * @interface RedisDatabaseStatsDto + */ +export interface RedisDatabaseStatsDto { + /** + * + * @type {string} + * @memberof RedisDatabaseStatsDto + */ + 'instantaneous_input_kbps': string; + /** + * + * @type {string} + * @memberof RedisDatabaseStatsDto + */ + 'instantaneous_ops_per_sec': string; + /** + * + * @type {string} + * @memberof RedisDatabaseStatsDto + */ + 'instantaneous_output_kbps': string; + /** + * + * @type {number} + * @memberof RedisDatabaseStatsDto + */ + 'maxmemory_policy': number; + /** + * Redis database mode + * @type {string} + * @memberof RedisDatabaseStatsDto + */ + 'numberOfKeysRange': string; + /** + * Redis database role + * @type {string} + * @memberof RedisDatabaseStatsDto + */ + 'uptime_in_days': string; +} +/** + * + * @export + * @interface RedisEnterpriseDatabase + */ +export interface RedisEnterpriseDatabase { + /** + * The unique ID of the database. + * @type {number} + * @memberof RedisEnterpriseDatabase + */ + 'uid': number; + /** + * Name of database in cluster. + * @type {string} + * @memberof RedisEnterpriseDatabase + */ + 'name': string; + /** + * DNS name your Redis Enterprise cluster database is available on. + * @type {string} + * @memberof RedisEnterpriseDatabase + */ + 'dnsName': string; + /** + * Address your Redis Enterprise cluster database is available on. + * @type {string} + * @memberof RedisEnterpriseDatabase + */ + 'address': string; + /** + * The port your Redis Enterprise cluster database is available on. + * @type {number} + * @memberof RedisEnterpriseDatabase + */ + 'port': number; + /** + * Database status + * @type {string} + * @memberof RedisEnterpriseDatabase + */ + 'status': RedisEnterpriseDatabaseStatusEnum; + /** + * Information about the modules loaded to the database + * @type {Array} + * @memberof RedisEnterpriseDatabase + */ + 'modules': Array; + /** + * Is TLS mode enabled? + * @type {boolean} + * @memberof RedisEnterpriseDatabase + */ + 'tls': boolean; + /** + * Additional database options + * @type {object} + * @memberof RedisEnterpriseDatabase + */ + 'options': object; + /** + * Tags associated with the database. + * @type {Array} + * @memberof RedisEnterpriseDatabase + */ + 'tags': Array; +} + +export const RedisEnterpriseDatabaseStatusEnum = { + Pending: 'pending', + CreationFailed: 'creation-failed', + Active: 'active', + ActiveChangePending: 'active-change-pending', + ImportPending: 'import-pending', + DeletePending: 'delete-pending', + Recovery: 'recovery' +} as const; + +export type RedisEnterpriseDatabaseStatusEnum = typeof RedisEnterpriseDatabaseStatusEnum[keyof typeof RedisEnterpriseDatabaseStatusEnum]; + +/** + * + * @export + * @interface RedisNodeInfoResponse + */ +export interface RedisNodeInfoResponse { + /** + * Redis database version + * @type {string} + * @memberof RedisNodeInfoResponse + */ + 'version': string; + /** + * Value is \"master\" if the instance is replica of no one, or \"slave\" if the instance is a replica of some master instance + * @type {string} + * @memberof RedisNodeInfoResponse + */ + 'role'?: RedisNodeInfoResponseRoleEnum; + /** + * Redis database info from server section + * @type {object} + * @memberof RedisNodeInfoResponse + */ + 'server'?: object; + /** + * Various Redis stats + * @type {RedisDatabaseStatsDto} + * @memberof RedisNodeInfoResponse + */ + 'stats'?: RedisDatabaseStatsDto; + /** + * The number of Redis databases + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'databases'?: number; + /** + * Total number of bytes allocated by Redis using + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'usedMemory'?: number; + /** + * Total number of keys inside Redis database + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'totalKeys'?: number; + /** + * Number of client connections (excluding connections from replicas) + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'connectedClients'?: number; + /** + * Number of seconds since Redis server start + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'uptimeInSeconds'?: number; + /** + * The cache hit ratio represents the efficiency of cache usage + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'hitRatio'?: number; + /** + * The number of the cached lua scripts + * @type {number} + * @memberof RedisNodeInfoResponse + */ + 'cashedScripts'?: number; +} + +export const RedisNodeInfoResponseRoleEnum = { + Master: 'master', + Slave: 'slave' +} as const; + +export type RedisNodeInfoResponseRoleEnum = typeof RedisNodeInfoResponseRoleEnum[keyof typeof RedisNodeInfoResponseRoleEnum]; + +/** + * + * @export + * @interface RemoveRejsonRlDto + */ +export interface RemoveRejsonRlDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof RemoveRejsonRlDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Path of the json field + * @type {string} + * @memberof RemoveRejsonRlDto + */ + 'path': string; +} +/** + * + * @export + * @interface RemoveRejsonRlResponse + */ +export interface RemoveRejsonRlResponse { + /** + * Integer , specifically the number of paths deleted (0 or 1). + * @type {number} + * @memberof RemoveRejsonRlResponse + */ + 'affected': number; +} +/** + * + * @export + * @interface RenameKeyDto + */ +export interface RenameKeyDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof RenameKeyDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {RenameKeyDtoNewKeyName} + * @memberof RenameKeyDto + */ + 'newKeyName': RenameKeyDtoNewKeyName; +} +/** + * @type RenameKeyDtoNewKeyName + * New key name + * @export + */ +export type RenameKeyDtoNewKeyName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface RenameKeyResponse + */ +export interface RenameKeyResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof RenameKeyResponse + */ + 'keyName': PushListElementsResponseKeyName; +} +/** + * + * @export + * @interface ResultsSummary + */ +export interface ResultsSummary { + /** + * Total number of commands executed + * @type {number} + * @memberof ResultsSummary + */ + 'total': number; + /** + * Total number of successful commands executed + * @type {number} + * @memberof ResultsSummary + */ + 'success': number; + /** + * Total number of failed commands executed + * @type {number} + * @memberof ResultsSummary + */ + 'fail': number; +} +/** + * + * @export + * @interface RootCustomTutorialManifest + */ +export interface RootCustomTutorialManifest { + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'id': string; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'type': RootCustomTutorialManifestTypeEnum; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'label': string; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'summary': string; + /** + * + * @type {CustomTutorialManifestArgs} + * @memberof RootCustomTutorialManifest + */ + 'args'?: CustomTutorialManifestArgs; + /** + * + * @type {CustomTutorialManifest} + * @memberof RootCustomTutorialManifest + */ + 'children'?: CustomTutorialManifest; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + '_actions'?: RootCustomTutorialManifestActionsEnum; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + '_path'?: string; + /** + * + * @type {Array} + * @memberof RootCustomTutorialManifest + */ + 'keywords'?: Array; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'author'?: string; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'url'?: string; + /** + * + * @type {Array} + * @memberof RootCustomTutorialManifest + */ + 'industry'?: Array; + /** + * + * @type {string} + * @memberof RootCustomTutorialManifest + */ + 'description'?: string; +} + +export const RootCustomTutorialManifestTypeEnum = { + CodeButton: 'code-button', + Group: 'group', + InternalLink: 'internal-link' +} as const; + +export type RootCustomTutorialManifestTypeEnum = typeof RootCustomTutorialManifestTypeEnum[keyof typeof RootCustomTutorialManifestTypeEnum]; +export const RootCustomTutorialManifestActionsEnum = { + Create: 'create', + Delete: 'delete', + Sync: 'sync' +} as const; + +export type RootCustomTutorialManifestActionsEnum = typeof RootCustomTutorialManifestActionsEnum[keyof typeof RootCustomTutorialManifestActionsEnum]; + +/** + * + * @export + * @interface SafeRejsonRlDataDto + */ +export interface SafeRejsonRlDataDto { + /** + * Key inside json data + * @type {string} + * @memberof SafeRejsonRlDataDto + */ + 'key': string; + /** + * Path of the json field + * @type {string} + * @memberof SafeRejsonRlDataDto + */ + 'path': string; + /** + * Number of properties/elements inside field (for object and arrays only) + * @type {number} + * @memberof SafeRejsonRlDataDto + */ + 'cardinality'?: number; + /** + * Type of the field + * @type {string} + * @memberof SafeRejsonRlDataDto + */ + 'type': SafeRejsonRlDataDtoTypeEnum; + /** + * Any value + * @type {string} + * @memberof SafeRejsonRlDataDto + */ + 'value'?: string; +} + +export const SafeRejsonRlDataDtoTypeEnum = { + String: 'string', + Number: 'number', + Integer: 'integer', + Boolean: 'boolean', + Null: 'null', + Array: 'array', + Object: 'object' +} as const; + +export type SafeRejsonRlDataDtoTypeEnum = typeof SafeRejsonRlDataDtoTypeEnum[keyof typeof SafeRejsonRlDataDtoTypeEnum]; + +/** + * + * @export + * @interface ScanFilter + */ +export interface ScanFilter { + /** + * Key type + * @type {string} + * @memberof ScanFilter + */ + 'type': string; + /** + * Match glob patterns + * @type {string} + * @memberof ScanFilter + */ + 'match': string; +} +/** + * + * @export + * @interface SearchRedisearchDto + */ +export interface SearchRedisearchDto { + /** + * + * @type {CreateRedisearchIndexDtoIndex} + * @memberof SearchRedisearchDto + */ + 'index': CreateRedisearchIndexDtoIndex; + /** + * Query to search inside data fields + * @type {string} + * @memberof SearchRedisearchDto + */ + 'query': string; + /** + * Limit number of results to be returned + * @type {number} + * @memberof SearchRedisearchDto + */ + 'limit': number; + /** + * Offset position to start searching + * @type {number} + * @memberof SearchRedisearchDto + */ + 'offset': number; +} +/** + * + * @export + * @interface SearchZSetMembersDto + */ +export interface SearchZSetMembersDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof SearchZSetMembersDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. + * @type {number} + * @memberof SearchZSetMembersDto + */ + 'cursor': number; + /** + * Specifying the number of elements to return. + * @type {number} + * @memberof SearchZSetMembersDto + */ + 'count'?: number; + /** + * Iterate only elements matching a given pattern. + * @type {string} + * @memberof SearchZSetMembersDto + */ + 'match': string; +} +/** + * + * @export + * @interface SearchZSetMembersResponse + */ +export interface SearchZSetMembersResponse { + /** + * + * @type {PushListElementsResponseKeyName} + * @memberof SearchZSetMembersResponse + */ + 'keyName': PushListElementsResponseKeyName; + /** + * The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. + * @type {number} + * @memberof SearchZSetMembersResponse + */ + 'nextCursor': number; + /** + * Array of Members. + * @type {Array} + * @memberof SearchZSetMembersResponse + */ + 'members': Array; + /** + * The number of members in the currently-selected z-set. + * @type {number} + * @memberof SearchZSetMembersResponse + */ + 'total': number; +} +/** + * + * @export + * @interface SendAiChatMessageDto + */ +export interface SendAiChatMessageDto { + /** + * Message content + * @type {string} + * @memberof SendAiChatMessageDto + */ + 'content': string; +} +/** + * + * @export + * @interface SendAiQueryMessageDto + */ +export interface SendAiQueryMessageDto { + /** + * Message content + * @type {string} + * @memberof SendAiQueryMessageDto + */ + 'content': string; +} +/** + * + * @export + * @interface SendCommandDto + */ +export interface SendCommandDto { + /** + * Redis CLI command + * @type {string} + * @memberof SendCommandDto + */ + 'command': string; + /** + * Define output format + * @type {string} + * @memberof SendCommandDto + */ + 'outputFormat'?: SendCommandDtoOutputFormatEnum; +} + +export const SendCommandDtoOutputFormatEnum = { + Text: 'TEXT', + Raw: 'RAW' +} as const; + +export type SendCommandDtoOutputFormatEnum = typeof SendCommandDtoOutputFormatEnum[keyof typeof SendCommandDtoOutputFormatEnum]; + +/** + * + * @export + * @interface SendCommandResponse + */ +export interface SendCommandResponse { + /** + * Redis CLI response + * @type {string} + * @memberof SendCommandResponse + */ + 'response': string; + /** + * Redis CLI command execution status + * @type {string} + * @memberof SendCommandResponse + */ + 'status': SendCommandResponseStatusEnum; +} + +export const SendCommandResponseStatusEnum = { + Success: 'success', + Fail: 'fail' +} as const; + +export type SendCommandResponseStatusEnum = typeof SendCommandResponseStatusEnum[keyof typeof SendCommandResponseStatusEnum]; + +/** + * + * @export + * @interface SendEventDto + */ +export interface SendEventDto { + /** + * Telemetry event name. + * @type {string} + * @memberof SendEventDto + */ + 'event': string; + /** + * Telemetry event data. + * @type {object} + * @memberof SendEventDto + */ + 'eventData'?: object; + /** + * Does not track the specific user in any way? + * @type {boolean} + * @memberof SendEventDto + */ + 'nonTracking'?: boolean; + /** + * User data. + * @type {object} + * @memberof SendEventDto + */ + 'traits'?: object; +} +/** + * + * @export + * @interface SentinelMaster + */ +export interface SentinelMaster { + /** + * Sentinel master group name. Identifies a group of Redis instances composed of a master and one or more slaves. + * @type {string} + * @memberof SentinelMaster + */ + 'name': string; + /** + * Sentinel username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof SentinelMaster + */ + 'username'?: string; + /** + * The password for your Redis Sentinel master. If your master doesn’t require a password, leave this field empty. + * @type {string} + * @memberof SentinelMaster + */ + 'password'?: string; + /** + * The hostname of Sentinel master. + * @type {string} + * @memberof SentinelMaster + */ + 'host'?: string; + /** + * The port Sentinel master. + * @type {number} + * @memberof SentinelMaster + */ + 'port'?: number; + /** + * Sentinel master status + * @type {string} + * @memberof SentinelMaster + */ + 'status'?: SentinelMasterStatusEnum; + /** + * The number of slaves. + * @type {number} + * @memberof SentinelMaster + */ + 'numberOfSlaves'?: number; + /** + * Sentinel master endpoints. + * @type {Array} + * @memberof SentinelMaster + */ + 'nodes'?: Array; +} + +export const SentinelMasterStatusEnum = { + Active: 'active', + Down: 'down' +} as const; + +export type SentinelMasterStatusEnum = typeof SentinelMasterStatusEnum[keyof typeof SentinelMasterStatusEnum]; + +/** + * + * @export + * @interface SentinelMasterResponse + */ +export interface SentinelMasterResponse { + /** + * Sentinel master group name. Identifies a group of Redis instances composed of a master and one or more slaves. + * @type {string} + * @memberof SentinelMasterResponse + */ + 'name': string; + /** + * Sentinel username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof SentinelMasterResponse + */ + 'username'?: string; + /** + * The hostname of Sentinel master. + * @type {string} + * @memberof SentinelMasterResponse + */ + 'host'?: string; + /** + * The port Sentinel master. + * @type {number} + * @memberof SentinelMasterResponse + */ + 'port'?: number; + /** + * Sentinel master status + * @type {string} + * @memberof SentinelMasterResponse + */ + 'status'?: SentinelMasterResponseStatusEnum; + /** + * The number of slaves. + * @type {number} + * @memberof SentinelMasterResponse + */ + 'numberOfSlaves'?: number; + /** + * Sentinel master endpoints. + * @type {Array} + * @memberof SentinelMasterResponse + */ + 'nodes'?: Array; + /** + * The password for your Redis Sentinel master. If your master doesn’t require a password, leave this field empty. + * @type {boolean} + * @memberof SentinelMasterResponse + */ + 'password'?: boolean; +} + +export const SentinelMasterResponseStatusEnum = { + Active: 'active', + Down: 'down' +} as const; + +export type SentinelMasterResponseStatusEnum = typeof SentinelMasterResponseStatusEnum[keyof typeof SentinelMasterResponseStatusEnum]; + +/** + * + * @export + * @interface SetListElementDto + */ +export interface SetListElementDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof SetListElementDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {SetListElementDtoElement} + * @memberof SetListElementDto + */ + 'element': SetListElementDtoElement; + /** + * Element index + * @type {number} + * @memberof SetListElementDto + */ + 'index': number; +} +/** + * @type SetListElementDtoElement + * List element + * @export + */ +export type SetListElementDtoElement = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface SetListElementResponse + */ +export interface SetListElementResponse { + /** + * Element index + * @type {number} + * @memberof SetListElementResponse + */ + 'index': number; + /** + * + * @type {SetListElementDtoElement} + * @memberof SetListElementResponse + */ + 'element': SetListElementDtoElement; +} +/** + * + * @export + * @interface SetStringDto + */ +export interface SetStringDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof SetStringDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {SetStringWithExpireDtoValue} + * @memberof SetStringDto + */ + 'value': SetStringWithExpireDtoValue; +} +/** + * + * @export + * @interface SetStringWithExpireDto + */ +export interface SetStringWithExpireDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof SetStringWithExpireDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {SetStringWithExpireDtoValue} + * @memberof SetStringWithExpireDto + */ + 'value': SetStringWithExpireDtoValue; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. + * @type {number} + * @memberof SetStringWithExpireDto + */ + 'expire'?: number; +} +/** + * @type SetStringWithExpireDtoValue + * Key value + * @export + */ +export type SetStringWithExpireDtoValue = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface ShortCommandExecution + */ +export interface ShortCommandExecution { + /** + * Command execution id + * @type {string} + * @memberof ShortCommandExecution + */ + 'id'?: string; + /** + * Database id + * @type {string} + * @memberof ShortCommandExecution + */ + 'databaseId'?: string; + /** + * Redis command + * @type {string} + * @memberof ShortCommandExecution + */ + 'command'?: string; + /** + * Workbench mode + * @type {string} + * @memberof ShortCommandExecution + */ + 'mode'?: ShortCommandExecutionModeEnum; + /** + * Workbench result mode + * @type {string} + * @memberof ShortCommandExecution + */ + 'resultsMode'?: ShortCommandExecutionResultsModeEnum; + /** + * Workbench executions summary + * @type {ResultsSummary} + * @memberof ShortCommandExecution + */ + 'summary'?: ResultsSummary; + /** + * Result did not stored in db + * @type {boolean} + * @memberof ShortCommandExecution + */ + 'isNotStored'?: boolean; + /** + * Date of command execution + * @type {string} + * @memberof ShortCommandExecution + */ + 'createdAt'?: string; + /** + * Workbench command execution time + * @type {number} + * @memberof ShortCommandExecution + */ + 'executionTime'?: number; + /** + * Logical database number. + * @type {number} + * @memberof ShortCommandExecution + */ + 'db'?: number; + /** + * Command execution type. Used to distinguish between search and workbench + * @type {string} + * @memberof ShortCommandExecution + */ + 'type'?: ShortCommandExecutionTypeEnum; +} + +export const ShortCommandExecutionModeEnum = { + Raw: 'RAW', + Ascii: 'ASCII' +} as const; + +export type ShortCommandExecutionModeEnum = typeof ShortCommandExecutionModeEnum[keyof typeof ShortCommandExecutionModeEnum]; +export const ShortCommandExecutionResultsModeEnum = { + Default: 'DEFAULT', + GroupMode: 'GROUP_MODE', + Silent: 'SILENT' +} as const; + +export type ShortCommandExecutionResultsModeEnum = typeof ShortCommandExecutionResultsModeEnum[keyof typeof ShortCommandExecutionResultsModeEnum]; +export const ShortCommandExecutionTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; + +export type ShortCommandExecutionTypeEnum = typeof ShortCommandExecutionTypeEnum[keyof typeof ShortCommandExecutionTypeEnum]; + +/** + * + * @export + * @interface ShortDatabaseAnalysis + */ +export interface ShortDatabaseAnalysis { + /** + * Analysis id + * @type {string} + * @memberof ShortDatabaseAnalysis + */ + 'id'?: string; + /** + * Analysis created date (ISO string) + * @type {string} + * @memberof ShortDatabaseAnalysis + */ + 'createdAt'?: string; + /** + * Logical database number. + * @type {number} + * @memberof ShortDatabaseAnalysis + */ + 'db'?: number; +} +/** + * + * @export + * @interface SimpleSummary + */ +export interface SimpleSummary { + /** + * Total number + * @type {number} + * @memberof SimpleSummary + */ + 'total': number; + /** + * Array with totals by type + * @type {Array} + * @memberof SimpleSummary + */ + 'types': Array; +} +/** + * + * @export + * @interface SimpleTypeSummary + */ +export interface SimpleTypeSummary { + /** + * Type name + * @type {string} + * @memberof SimpleTypeSummary + */ + 'type': string; + /** + * Total inside this type of data + * @type {number} + * @memberof SimpleTypeSummary + */ + 'total': number; +} +/** + * + * @export + * @interface SlowLog + */ +export interface SlowLog { + /** + * Unique slowlog Id calculated by Redis + * @type {number} + * @memberof SlowLog + */ + 'id': number; + /** + * Time when command was executed + * @type {number} + * @memberof SlowLog + */ + 'time': number; + /** + * Time needed to execute this command in microseconds + * @type {number} + * @memberof SlowLog + */ + 'durationUs': number; + /** + * Command with args + * @type {string} + * @memberof SlowLog + */ + 'args': string; + /** + * Client that executed this command + * @type {string} + * @memberof SlowLog + */ + 'source': string; + /** + * Client name if defined + * @type {string} + * @memberof SlowLog + */ + 'client'?: string; +} +/** + * + * @export + * @interface SlowLogConfig + */ +export interface SlowLogConfig { + /** + * Max logs to store inside Redis slowlog + * @type {number} + * @memberof SlowLogConfig + */ + 'slowlogMaxLen'?: number; + /** + * Store logs with execution time greater than this value (in microseconds) + * @type {number} + * @memberof SlowLogConfig + */ + 'slowlogLogSlowerThan'?: number; +} +/** + * + * @export + * @interface SshOptions + */ +export interface SshOptions { + /** + * The hostname of SSH server + * @type {string} + * @memberof SshOptions + */ + 'host': string; + /** + * The port of SSH server + * @type {number} + * @memberof SshOptions + */ + 'port': number; + /** + * SSH username + * @type {string} + * @memberof SshOptions + */ + 'username'?: string; + /** + * The SSH password + * @type {string} + * @memberof SshOptions + */ + 'password'?: string; + /** + * The SSH private key + * @type {string} + * @memberof SshOptions + */ + 'privateKey'?: string; + /** + * The SSH passphrase + * @type {string} + * @memberof SshOptions + */ + 'passphrase'?: string; +} +/** + * + * @export + * @interface SshOptionsResponse + */ +export interface SshOptionsResponse { + /** + * The hostname of SSH server + * @type {string} + * @memberof SshOptionsResponse + */ + 'host': string; + /** + * The port of SSH server + * @type {number} + * @memberof SshOptionsResponse + */ + 'port': number; + /** + * SSH username + * @type {string} + * @memberof SshOptionsResponse + */ + 'username'?: string; + /** + * The SSH password flag (true if password was set) + * @type {boolean} + * @memberof SshOptionsResponse + */ + 'password'?: boolean; + /** + * The SSH passphrase flag (true if password was set) + * @type {boolean} + * @memberof SshOptionsResponse + */ + 'passphrase'?: boolean; + /** + * The SSH private key + * @type {boolean} + * @memberof SshOptionsResponse + */ + 'privateKey'?: boolean; +} +/** + * + * @export + * @interface StreamEntryDto + */ +export interface StreamEntryDto { + /** + * Entry ID + * @type {string} + * @memberof StreamEntryDto + */ + 'id': string; + /** + * Entry fields + * @type {Array} + * @memberof StreamEntryDto + */ + 'fields': Array; +} +/** + * + * @export + * @interface StreamEntryFieldDto + */ +export interface StreamEntryFieldDto { + /** + * + * @type {StreamEntryFieldDtoName} + * @memberof StreamEntryFieldDto + */ + 'name': StreamEntryFieldDtoName; + /** + * + * @type {StreamEntryFieldDtoValue} + * @memberof StreamEntryFieldDto + */ + 'value': StreamEntryFieldDtoValue; +} +/** + * @type StreamEntryFieldDtoName + * Entry field name + * @export + */ +export type StreamEntryFieldDtoName = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * @type StreamEntryFieldDtoValue + * Entry value + * @export + */ +export type StreamEntryFieldDtoValue = CreateListWithExpireDtoKeyNameOneOf | string; + +/** + * + * @export + * @interface SumGroup + */ +export interface SumGroup { + /** + * Group Label + * @type {string} + * @memberof SumGroup + */ + 'label': string; + /** + * Sum of data (e.g. memory, or number of keys) + * @type {number} + * @memberof SumGroup + */ + 'total': number; + /** + * Group threshold during analyzing (all values less then (<) threshold) + * @type {number} + * @memberof SumGroup + */ + 'threshold': number; +} +/** + * + * @export + * @interface Tag + */ +export interface Tag { + /** + * Tag id. + * @type {string} + * @memberof Tag + */ + 'id': string; + /** + * Key of the tag. + * @type {string} + * @memberof Tag + */ + 'key': string; + /** + * Value of the tag. + * @type {string} + * @memberof Tag + */ + 'value': string; + /** + * Creation date of the tag. + * @type {string} + * @memberof Tag + */ + 'createdAt': string; + /** + * Last update date of the tag. + * @type {string} + * @memberof Tag + */ + 'updatedAt': string; +} +/** + * + * @export + * @interface UpdateConsumerGroupDto + */ +export interface UpdateConsumerGroupDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof UpdateConsumerGroupDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * + * @type {GetConsumersDtoGroupName} + * @memberof UpdateConsumerGroupDto + */ + 'name': GetConsumersDtoGroupName; + /** + * Id of last delivered message + * @type {string} + * @memberof UpdateConsumerGroupDto + */ + 'lastDeliveredId': string; +} +/** + * + * @export + * @interface UpdateDatabaseDto + */ +export interface UpdateDatabaseDto { + /** + * The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'host'?: string; + /** + * The port your Redis database is available on. + * @type {number} + * @memberof UpdateDatabaseDto + */ + 'port'?: number; + /** + * A name for your Redis database. + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'name'?: string; + /** + * Logical database number. + * @type {number} + * @memberof UpdateDatabaseDto + */ + 'db'?: number; + /** + * Database username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'username'?: string; + /** + * The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'password'?: string; + /** + * The database name from provider + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'nameFromProvider'?: string; + /** + * The redis database hosting provider + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'provider'?: string; + /** + * Use TLS to connect. + * @type {boolean} + * @memberof UpdateDatabaseDto + */ + 'tls'?: boolean; + /** + * SNI servername + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'tlsServername'?: string; + /** + * The certificate returned by the server needs to be verified. + * @type {boolean} + * @memberof UpdateDatabaseDto + */ + 'verifyServerCert'?: boolean; + /** + * Use SSH tunnel to connect. + * @type {boolean} + * @memberof UpdateDatabaseDto + */ + 'ssh'?: boolean; + /** + * Cloud details + * @type {CloudDatabaseDetails} + * @memberof UpdateDatabaseDto + */ + 'cloudDetails'?: CloudDatabaseDetails; + /** + * Database compressor + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'compressor'?: UpdateDatabaseDtoCompressorEnum; + /** + * Key name format + * @type {string} + * @memberof UpdateDatabaseDto + */ + 'keyNameFormat'?: UpdateDatabaseDtoKeyNameFormatEnum; + /** + * Force client connection as standalone + * @type {boolean} + * @memberof UpdateDatabaseDto + */ + 'forceStandalone'?: boolean; + /** + * + * @type {CreateDatabaseDtoCaCert} + * @memberof UpdateDatabaseDto + */ + 'caCert'?: CreateDatabaseDtoCaCert; + /** + * + * @type {CreateDatabaseDtoClientCert} + * @memberof UpdateDatabaseDto + */ + 'clientCert'?: CreateDatabaseDtoClientCert; + /** + * Tags associated with the database. + * @type {Array} + * @memberof UpdateDatabaseDto + */ + 'tags'?: Array; + /** + * Updated ssh options fields + * @type {UpdateSshOptionsDto} + * @memberof UpdateDatabaseDto + */ + 'sshOptions'?: UpdateSshOptionsDto; + /** + * Connection timeout + * @type {number} + * @memberof UpdateDatabaseDto + */ + 'timeout'?: number; + /** + * Updated sentinel master fields + * @type {UpdateSentinelMasterDto} + * @memberof UpdateDatabaseDto + */ + 'sentinelMaster'?: UpdateSentinelMasterDto; +} + +export const UpdateDatabaseDtoCompressorEnum = { + None: 'NONE', + Gzip: 'GZIP', + Zstd: 'ZSTD', + Lz4: 'LZ4', + Snappy: 'SNAPPY', + Brotli: 'Brotli', + PhpgzCompress: 'PHPGZCompress' +} as const; + +export type UpdateDatabaseDtoCompressorEnum = typeof UpdateDatabaseDtoCompressorEnum[keyof typeof UpdateDatabaseDtoCompressorEnum]; +export const UpdateDatabaseDtoKeyNameFormatEnum = { + Unicode: 'Unicode', + Hex: 'HEX' +} as const; + +export type UpdateDatabaseDtoKeyNameFormatEnum = typeof UpdateDatabaseDtoKeyNameFormatEnum[keyof typeof UpdateDatabaseDtoKeyNameFormatEnum]; + +/** + * + * @export + * @interface UpdateHashFieldsTtlDto + */ +export interface UpdateHashFieldsTtlDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof UpdateHashFieldsTtlDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Hash fields + * @type {Array} + * @memberof UpdateHashFieldsTtlDto + */ + 'fields': Array; +} +/** + * + * @export + * @interface UpdateKeyTtlDto + */ +export interface UpdateKeyTtlDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof UpdateKeyTtlDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. If the property has value of -1, then the key timeout will be removed. + * @type {number} + * @memberof UpdateKeyTtlDto + */ + 'ttl': number; +} +/** + * + * @export + * @interface UpdateMemberInZSetDto + */ +export interface UpdateMemberInZSetDto { + /** + * + * @type {CreateListWithExpireDtoKeyName} + * @memberof UpdateMemberInZSetDto + */ + 'keyName': CreateListWithExpireDtoKeyName; + /** + * ZSet member + * @type {ZSetMemberDto} + * @memberof UpdateMemberInZSetDto + */ + 'member': ZSetMemberDto; +} +/** + * + * @export + * @interface UpdateRdiDto + */ +export interface UpdateRdiDto { + /** + * A name to associate with RDI + * @type {string} + * @memberof UpdateRdiDto + */ + 'name'?: string; + /** + * RDI or API username + * @type {string} + * @memberof UpdateRdiDto + */ + 'username'?: string; + /** + * RDI or API password + * @type {string} + * @memberof UpdateRdiDto + */ + 'password'?: string; +} +/** + * + * @export + * @interface UpdateSentinelMasterDto + */ +export interface UpdateSentinelMasterDto { + /** + * Sentinel username, if your database is ACL enabled, otherwise leave this field empty. + * @type {string} + * @memberof UpdateSentinelMasterDto + */ + 'username'?: string; + /** + * The password for your Redis Sentinel master. If your master doesn’t require a password, leave this field empty. + * @type {string} + * @memberof UpdateSentinelMasterDto + */ + 'password'?: string; +} +/** + * + * @export + * @interface UpdateSettingsDto + */ +export interface UpdateSettingsDto { + /** + * Application theme. + * @type {string} + * @memberof UpdateSettingsDto + */ + 'theme'?: string; + /** + * Application date format. + * @type {string} + * @memberof UpdateSettingsDto + */ + 'dateFormat'?: string; + /** + * Application timezone. + * @type {string} + * @memberof UpdateSettingsDto + */ + 'timezone'?: string; + /** + * Threshold for scan operation. + * @type {number} + * @memberof UpdateSettingsDto + */ + 'scanThreshold'?: number; + /** + * Batch for workbench pipeline. + * @type {number} + * @memberof UpdateSettingsDto + */ + 'batchSize'?: number; + /** + * Agreements + * @type {object} + * @memberof UpdateSettingsDto + */ + 'agreements'?: object; + /** + * Reason describing why analytics are enabled + * @type {string} + * @memberof UpdateSettingsDto + */ + 'analyticsReason'?: string; +} +/** + * + * @export + * @interface UpdateSlowLogConfigDto + */ +export interface UpdateSlowLogConfigDto { + /** + * Max logs to store inside Redis slowlog + * @type {number} + * @memberof UpdateSlowLogConfigDto + */ + 'slowlogMaxLen'?: number; + /** + * Store logs with execution time greater than this value (in microseconds) + * @type {number} + * @memberof UpdateSlowLogConfigDto + */ + 'slowlogLogSlowerThan'?: number; +} +/** + * + * @export + * @interface UpdateSshOptionsDto + */ +export interface UpdateSshOptionsDto { + /** + * The hostname of SSH server + * @type {string} + * @memberof UpdateSshOptionsDto + */ + 'host'?: string; + /** + * The port of SSH server + * @type {number} + * @memberof UpdateSshOptionsDto + */ + 'port'?: number; + /** + * SSH username + * @type {string} + * @memberof UpdateSshOptionsDto + */ + 'username'?: string; + /** + * The SSH password + * @type {string} + * @memberof UpdateSshOptionsDto + */ + 'password'?: string; + /** + * The SSH private key + * @type {string} + * @memberof UpdateSshOptionsDto + */ + 'privateKey'?: string; + /** + * The SSH passphrase + * @type {string} + * @memberof UpdateSshOptionsDto + */ + 'passphrase'?: string; +} +/** + * + * @export + * @interface UpdateTagDto + */ +export interface UpdateTagDto { + /** + * Key of the tag. + * @type {string} + * @memberof UpdateTagDto + */ + 'key'?: string; + /** + * Value of the tag. + * @type {string} + * @memberof UpdateTagDto + */ + 'value'?: string; +} +/** + * + * @export + * @interface UploadImportFileByPathDto + */ +export interface UploadImportFileByPathDto { + /** + * Internal path to data file + * @type {string} + * @memberof UploadImportFileByPathDto + */ + 'path': string; +} +/** + * + * @export + * @interface UseCaCertificateDto + */ +export interface UseCaCertificateDto { + /** + * Certificate id + * @type {string} + * @memberof UseCaCertificateDto + */ + 'id': string; +} +/** + * + * @export + * @interface UseClientCertificateDto + */ +export interface UseClientCertificateDto { + /** + * Certificate id + * @type {string} + * @memberof UseClientCertificateDto + */ + 'id': string; +} +/** + * + * @export + * @interface ZSetMemberDto + */ +export interface ZSetMemberDto { + /** + * + * @type {ZSetMemberDtoName} + * @memberof ZSetMemberDto + */ + 'name': ZSetMemberDtoName; + /** + * Member score value. + * @type {number} + * @memberof ZSetMemberDto + */ + 'score': number; +} +/** + * @type ZSetMemberDtoName + * Member name value + * @export + */ +export type ZSetMemberDtoName = CreateListWithExpireDtoKeyNameOneOf | string; + + +/** + * AIApi - axios parameter creator + * @export + */ +export const AIApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create a new chat + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerCreate: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/ai/assistant/chats`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Reset chat + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerDelete: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('aiChatControllerDelete', 'id', id) + const localVarPath = `/api/ai/assistant/chats/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get chat history + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerGetHistory: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('aiChatControllerGetHistory', 'id', id) + const localVarPath = `/api/ai/assistant/chats/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Post a message + * @summary + * @param {string} id + * @param {SendAiChatMessageDto} sendAiChatMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerPostMessage: async (id: string, sendAiChatMessageDto: SendAiChatMessageDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('aiChatControllerPostMessage', 'id', id) + // verify required parameter 'sendAiChatMessageDto' is not null or undefined + assertParamExists('aiChatControllerPostMessage', 'sendAiChatMessageDto', sendAiChatMessageDto) + const localVarPath = `/api/ai/assistant/chats/{id}/messages` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendAiChatMessageDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiQueryControllerClearHistory: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('aiQueryControllerClearHistory', 'id', id) + const localVarPath = `/api/ai/expert/{id}/messages` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiQueryControllerGetHistory: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('aiQueryControllerGetHistory', 'id', id) + const localVarPath = `/api/ai/expert/{id}/messages` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {SendAiQueryMessageDto} sendAiQueryMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiQueryControllerStreamQuestion: async (id: string, sendAiQueryMessageDto: SendAiQueryMessageDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('aiQueryControllerStreamQuestion', 'id', id) + // verify required parameter 'sendAiQueryMessageDto' is not null or undefined + assertParamExists('aiQueryControllerStreamQuestion', 'sendAiQueryMessageDto', sendAiQueryMessageDto) + const localVarPath = `/api/ai/expert/{id}/messages` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendAiQueryMessageDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * AIApi - functional programming interface + * @export + */ +export const AIApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AIApiAxiosParamCreator(configuration) + return { + /** + * Create a new chat + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiChatControllerCreate(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiChatControllerCreate(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiChatControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Reset chat + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiChatControllerDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiChatControllerDelete(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiChatControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get chat history + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiChatControllerGetHistory(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiChatControllerGetHistory(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiChatControllerGetHistory']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Post a message + * @summary + * @param {string} id + * @param {SendAiChatMessageDto} sendAiChatMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiChatControllerPostMessage(id: string, sendAiChatMessageDto: SendAiChatMessageDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiChatControllerPostMessage(id, sendAiChatMessageDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiChatControllerPostMessage']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiQueryControllerClearHistory(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiQueryControllerClearHistory(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiQueryControllerClearHistory']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiQueryControllerGetHistory(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiQueryControllerGetHistory(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiQueryControllerGetHistory']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {SendAiQueryMessageDto} sendAiQueryMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async aiQueryControllerStreamQuestion(id: string, sendAiQueryMessageDto: SendAiQueryMessageDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.aiQueryControllerStreamQuestion(id, sendAiQueryMessageDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AIApi.aiQueryControllerStreamQuestion']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AIApi - factory interface + * @export + */ +export const AIApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AIApiFp(configuration) + return { + /** + * Create a new chat + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerCreate(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiChatControllerCreate(options).then((request) => request(axios, basePath)); + }, + /** + * Reset chat + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiChatControllerDelete(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get chat history + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerGetHistory(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiChatControllerGetHistory(id, options).then((request) => request(axios, basePath)); + }, + /** + * Post a message + * @summary + * @param {string} id + * @param {SendAiChatMessageDto} sendAiChatMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiChatControllerPostMessage(id: string, sendAiChatMessageDto: SendAiChatMessageDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiChatControllerPostMessage(id, sendAiChatMessageDto, options).then((request) => request(axios, basePath)); + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiQueryControllerClearHistory(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiQueryControllerClearHistory(id, options).then((request) => request(axios, basePath)); + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiQueryControllerGetHistory(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiQueryControllerGetHistory(id, options).then((request) => request(axios, basePath)); + }, + /** + * Generate new query + * @summary + * @param {string} id + * @param {SendAiQueryMessageDto} sendAiQueryMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + aiQueryControllerStreamQuestion(id: string, sendAiQueryMessageDto: SendAiQueryMessageDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.aiQueryControllerStreamQuestion(id, sendAiQueryMessageDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * AIApi - object-oriented interface + * @export + * @class AIApi + * @extends {BaseAPI} + */ +export class AIApi extends BaseAPI { + /** + * Create a new chat + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiChatControllerCreate(options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiChatControllerCreate(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Reset chat + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiChatControllerDelete(id: string, options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiChatControllerDelete(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get chat history + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiChatControllerGetHistory(id: string, options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiChatControllerGetHistory(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Post a message + * @summary + * @param {string} id + * @param {SendAiChatMessageDto} sendAiChatMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiChatControllerPostMessage(id: string, sendAiChatMessageDto: SendAiChatMessageDto, options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiChatControllerPostMessage(id, sendAiChatMessageDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiQueryControllerClearHistory(id: string, options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiQueryControllerClearHistory(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Generate new query + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiQueryControllerGetHistory(id: string, options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiQueryControllerGetHistory(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Generate new query + * @summary + * @param {string} id + * @param {SendAiQueryMessageDto} sendAiQueryMessageDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AIApi + */ + public aiQueryControllerStreamQuestion(id: string, sendAiQueryMessageDto: SendAiQueryMessageDto, options?: RawAxiosRequestConfig) { + return AIApiFp(this.configuration).aiQueryControllerStreamQuestion(id, sendAiQueryMessageDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * AnalyticsApi - axios parameter creator + * @export + */ +export const AnalyticsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Send telemetry event + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + analyticsControllerSendEvent: async (sendEventDto: SendEventDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sendEventDto' is not null or undefined + assertParamExists('analyticsControllerSendEvent', 'sendEventDto', sendEventDto) + const localVarPath = `/api/analytics/send-event`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendEventDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Send telemetry page + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + analyticsControllerSendPage: async (sendEventDto: SendEventDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'sendEventDto' is not null or undefined + assertParamExists('analyticsControllerSendPage', 'sendEventDto', sendEventDto) + const localVarPath = `/api/analytics/send-page`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendEventDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * AnalyticsApi - functional programming interface + * @export + */ +export const AnalyticsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = AnalyticsApiAxiosParamCreator(configuration) + return { + /** + * Send telemetry event + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async analyticsControllerSendEvent(sendEventDto: SendEventDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.analyticsControllerSendEvent(sendEventDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.analyticsControllerSendEvent']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Send telemetry page + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async analyticsControllerSendPage(sendEventDto: SendEventDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.analyticsControllerSendPage(sendEventDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.analyticsControllerSendPage']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * AnalyticsApi - factory interface + * @export + */ +export const AnalyticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = AnalyticsApiFp(configuration) + return { + /** + * Send telemetry event + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + analyticsControllerSendEvent(sendEventDto: SendEventDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.analyticsControllerSendEvent(sendEventDto, options).then((request) => request(axios, basePath)); + }, + /** + * Send telemetry page + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + analyticsControllerSendPage(sendEventDto: SendEventDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.analyticsControllerSendPage(sendEventDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * AnalyticsApi - object-oriented interface + * @export + * @class AnalyticsApi + * @extends {BaseAPI} + */ +export class AnalyticsApi extends BaseAPI { + /** + * Send telemetry event + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AnalyticsApi + */ + public analyticsControllerSendEvent(sendEventDto: SendEventDto, options?: RawAxiosRequestConfig) { + return AnalyticsApiFp(this.configuration).analyticsControllerSendEvent(sendEventDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Send telemetry page + * @summary + * @param {SendEventDto} sendEventDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof AnalyticsApi + */ + public analyticsControllerSendPage(sendEventDto: SendEventDto, options?: RawAxiosRequestConfig) { + return AnalyticsApiFp(this.configuration).analyticsControllerSendPage(sendEventDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * BrowserBrowserHistoryApi - axios parameter creator + * @export + */ +export const BrowserBrowserHistoryApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete bulk browser history items + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {DeleteBrowserHistoryItemsDto} deleteBrowserHistoryItemsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + browserHistoryControllerBulkDelete: async (dbInstance: string, mode: string, deleteBrowserHistoryItemsDto: DeleteBrowserHistoryItemsDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('browserHistoryControllerBulkDelete', 'dbInstance', dbInstance) + // verify required parameter 'mode' is not null or undefined + assertParamExists('browserHistoryControllerBulkDelete', 'mode', mode) + // verify required parameter 'deleteBrowserHistoryItemsDto' is not null or undefined + assertParamExists('browserHistoryControllerBulkDelete', 'deleteBrowserHistoryItemsDto', deleteBrowserHistoryItemsDto) + const localVarPath = `/api/databases/{dbInstance}/history` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (mode !== undefined) { + localVarQueryParameter['mode'] = mode; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteBrowserHistoryItemsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete browser history item by id + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + browserHistoryControllerDelete: async (dbInstance: string, mode: string, id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('browserHistoryControllerDelete', 'dbInstance', dbInstance) + // verify required parameter 'mode' is not null or undefined + assertParamExists('browserHistoryControllerDelete', 'mode', mode) + // verify required parameter 'id' is not null or undefined + assertParamExists('browserHistoryControllerDelete', 'id', id) + const localVarPath = `/api/databases/{dbInstance}/history/{id}` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (mode !== undefined) { + localVarQueryParameter['mode'] = mode; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get browser history + * @summary + * @param {string} dbInstance + * @param {BrowserHistoryControllerListModeEnum} mode + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + browserHistoryControllerList: async (dbInstance: string, mode: BrowserHistoryControllerListModeEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('browserHistoryControllerList', 'dbInstance', dbInstance) + // verify required parameter 'mode' is not null or undefined + assertParamExists('browserHistoryControllerList', 'mode', mode) + const localVarPath = `/api/databases/{dbInstance}/history` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (mode !== undefined) { + localVarQueryParameter['mode'] = mode; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserBrowserHistoryApi - functional programming interface + * @export + */ +export const BrowserBrowserHistoryApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserBrowserHistoryApiAxiosParamCreator(configuration) + return { + /** + * Delete bulk browser history items + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {DeleteBrowserHistoryItemsDto} deleteBrowserHistoryItemsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async browserHistoryControllerBulkDelete(dbInstance: string, mode: string, deleteBrowserHistoryItemsDto: DeleteBrowserHistoryItemsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.browserHistoryControllerBulkDelete(dbInstance, mode, deleteBrowserHistoryItemsDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserBrowserHistoryApi.browserHistoryControllerBulkDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete browser history item by id + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async browserHistoryControllerDelete(dbInstance: string, mode: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.browserHistoryControllerDelete(dbInstance, mode, id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserBrowserHistoryApi.browserHistoryControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get browser history + * @summary + * @param {string} dbInstance + * @param {BrowserHistoryControllerListModeEnum} mode + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async browserHistoryControllerList(dbInstance: string, mode: BrowserHistoryControllerListModeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.browserHistoryControllerList(dbInstance, mode, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserBrowserHistoryApi.browserHistoryControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserBrowserHistoryApi - factory interface + * @export + */ +export const BrowserBrowserHistoryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserBrowserHistoryApiFp(configuration) + return { + /** + * Delete bulk browser history items + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {DeleteBrowserHistoryItemsDto} deleteBrowserHistoryItemsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + browserHistoryControllerBulkDelete(dbInstance: string, mode: string, deleteBrowserHistoryItemsDto: DeleteBrowserHistoryItemsDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.browserHistoryControllerBulkDelete(dbInstance, mode, deleteBrowserHistoryItemsDto, options).then((request) => request(axios, basePath)); + }, + /** + * Delete browser history item by id + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + browserHistoryControllerDelete(dbInstance: string, mode: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.browserHistoryControllerDelete(dbInstance, mode, id, options).then((request) => request(axios, basePath)); + }, + /** + * Get browser history + * @summary + * @param {string} dbInstance + * @param {BrowserHistoryControllerListModeEnum} mode + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + browserHistoryControllerList(dbInstance: string, mode: BrowserHistoryControllerListModeEnum, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.browserHistoryControllerList(dbInstance, mode, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserBrowserHistoryApi - object-oriented interface + * @export + * @class BrowserBrowserHistoryApi + * @extends {BaseAPI} + */ +export class BrowserBrowserHistoryApi extends BaseAPI { + /** + * Delete bulk browser history items + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {DeleteBrowserHistoryItemsDto} deleteBrowserHistoryItemsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserBrowserHistoryApi + */ + public browserHistoryControllerBulkDelete(dbInstance: string, mode: string, deleteBrowserHistoryItemsDto: DeleteBrowserHistoryItemsDto, options?: RawAxiosRequestConfig) { + return BrowserBrowserHistoryApiFp(this.configuration).browserHistoryControllerBulkDelete(dbInstance, mode, deleteBrowserHistoryItemsDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete browser history item by id + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} mode Search mode + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserBrowserHistoryApi + */ + public browserHistoryControllerDelete(dbInstance: string, mode: string, id: string, options?: RawAxiosRequestConfig) { + return BrowserBrowserHistoryApiFp(this.configuration).browserHistoryControllerDelete(dbInstance, mode, id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get browser history + * @summary + * @param {string} dbInstance + * @param {BrowserHistoryControllerListModeEnum} mode + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserBrowserHistoryApi + */ + public browserHistoryControllerList(dbInstance: string, mode: BrowserHistoryControllerListModeEnum, options?: RawAxiosRequestConfig) { + return BrowserBrowserHistoryApiFp(this.configuration).browserHistoryControllerList(dbInstance, mode, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const BrowserHistoryControllerListModeEnum = { + Pattern: 'pattern', + Redisearch: 'redisearch' +} as const; +export type BrowserHistoryControllerListModeEnum = typeof BrowserHistoryControllerListModeEnum[keyof typeof BrowserHistoryControllerListModeEnum]; + + +/** + * BrowserHashApi - axios parameter creator + * @export + */ +export const BrowserHashApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add the specified fields to the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerAddMemberEncodingEnum} encoding + * @param {AddFieldsToHashDto} addFieldsToHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerAddMember: async (dbInstance: string, encoding: HashControllerAddMemberEncodingEnum, addFieldsToHashDto: AddFieldsToHashDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('hashControllerAddMember', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('hashControllerAddMember', 'encoding', encoding) + // verify required parameter 'addFieldsToHashDto' is not null or undefined + assertParamExists('hashControllerAddMember', 'addFieldsToHashDto', addFieldsToHashDto) + const localVarPath = `/api/databases/{dbInstance}/hash` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(addFieldsToHashDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Set key to hold Hash data type + * @summary + * @param {string} dbInstance + * @param {HashControllerCreateHashEncodingEnum} encoding + * @param {CreateHashWithExpireDto} createHashWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerCreateHash: async (dbInstance: string, encoding: HashControllerCreateHashEncodingEnum, createHashWithExpireDto: CreateHashWithExpireDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('hashControllerCreateHash', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('hashControllerCreateHash', 'encoding', encoding) + // verify required parameter 'createHashWithExpireDto' is not null or undefined + assertParamExists('hashControllerCreateHash', 'createHashWithExpireDto', createHashWithExpireDto) + const localVarPath = `/api/databases/{dbInstance}/hash` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createHashWithExpireDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Remove the specified fields from the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerDeleteFieldsEncodingEnum} encoding + * @param {DeleteFieldsFromHashDto} deleteFieldsFromHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerDeleteFields: async (dbInstance: string, encoding: HashControllerDeleteFieldsEncodingEnum, deleteFieldsFromHashDto: DeleteFieldsFromHashDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('hashControllerDeleteFields', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('hashControllerDeleteFields', 'encoding', encoding) + // verify required parameter 'deleteFieldsFromHashDto' is not null or undefined + assertParamExists('hashControllerDeleteFields', 'deleteFieldsFromHashDto', deleteFieldsFromHashDto) + const localVarPath = `/api/databases/{dbInstance}/hash/fields` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteFieldsFromHashDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get specified fields of the hash stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {HashControllerGetMembersEncodingEnum} encoding + * @param {GetHashFieldsDto} getHashFieldsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerGetMembers: async (dbInstance: string, encoding: HashControllerGetMembersEncodingEnum, getHashFieldsDto: GetHashFieldsDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('hashControllerGetMembers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('hashControllerGetMembers', 'encoding', encoding) + // verify required parameter 'getHashFieldsDto' is not null or undefined + assertParamExists('hashControllerGetMembers', 'getHashFieldsDto', getHashFieldsDto) + const localVarPath = `/api/databases/{dbInstance}/hash/get-fields` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getHashFieldsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update hash fields ttl + * @summary + * @param {string} dbInstance + * @param {HashControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateHashFieldsTtlDto} updateHashFieldsTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerUpdateTtl: async (dbInstance: string, encoding: HashControllerUpdateTtlEncodingEnum, updateHashFieldsTtlDto: UpdateHashFieldsTtlDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('hashControllerUpdateTtl', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('hashControllerUpdateTtl', 'encoding', encoding) + // verify required parameter 'updateHashFieldsTtlDto' is not null or undefined + assertParamExists('hashControllerUpdateTtl', 'updateHashFieldsTtlDto', updateHashFieldsTtlDto) + const localVarPath = `/api/databases/{dbInstance}/hash/ttl` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateHashFieldsTtlDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserHashApi - functional programming interface + * @export + */ +export const BrowserHashApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserHashApiAxiosParamCreator(configuration) + return { + /** + * Add the specified fields to the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerAddMemberEncodingEnum} encoding + * @param {AddFieldsToHashDto} addFieldsToHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async hashControllerAddMember(dbInstance: string, encoding: HashControllerAddMemberEncodingEnum, addFieldsToHashDto: AddFieldsToHashDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.hashControllerAddMember(dbInstance, encoding, addFieldsToHashDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserHashApi.hashControllerAddMember']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Set key to hold Hash data type + * @summary + * @param {string} dbInstance + * @param {HashControllerCreateHashEncodingEnum} encoding + * @param {CreateHashWithExpireDto} createHashWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async hashControllerCreateHash(dbInstance: string, encoding: HashControllerCreateHashEncodingEnum, createHashWithExpireDto: CreateHashWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.hashControllerCreateHash(dbInstance, encoding, createHashWithExpireDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserHashApi.hashControllerCreateHash']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove the specified fields from the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerDeleteFieldsEncodingEnum} encoding + * @param {DeleteFieldsFromHashDto} deleteFieldsFromHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async hashControllerDeleteFields(dbInstance: string, encoding: HashControllerDeleteFieldsEncodingEnum, deleteFieldsFromHashDto: DeleteFieldsFromHashDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.hashControllerDeleteFields(dbInstance, encoding, deleteFieldsFromHashDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserHashApi.hashControllerDeleteFields']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get specified fields of the hash stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {HashControllerGetMembersEncodingEnum} encoding + * @param {GetHashFieldsDto} getHashFieldsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async hashControllerGetMembers(dbInstance: string, encoding: HashControllerGetMembersEncodingEnum, getHashFieldsDto: GetHashFieldsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.hashControllerGetMembers(dbInstance, encoding, getHashFieldsDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserHashApi.hashControllerGetMembers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update hash fields ttl + * @summary + * @param {string} dbInstance + * @param {HashControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateHashFieldsTtlDto} updateHashFieldsTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async hashControllerUpdateTtl(dbInstance: string, encoding: HashControllerUpdateTtlEncodingEnum, updateHashFieldsTtlDto: UpdateHashFieldsTtlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.hashControllerUpdateTtl(dbInstance, encoding, updateHashFieldsTtlDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserHashApi.hashControllerUpdateTtl']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserHashApi - factory interface + * @export + */ +export const BrowserHashApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserHashApiFp(configuration) + return { + /** + * Add the specified fields to the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerAddMemberEncodingEnum} encoding + * @param {AddFieldsToHashDto} addFieldsToHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerAddMember(dbInstance: string, encoding: HashControllerAddMemberEncodingEnum, addFieldsToHashDto: AddFieldsToHashDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.hashControllerAddMember(dbInstance, encoding, addFieldsToHashDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Set key to hold Hash data type + * @summary + * @param {string} dbInstance + * @param {HashControllerCreateHashEncodingEnum} encoding + * @param {CreateHashWithExpireDto} createHashWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerCreateHash(dbInstance: string, encoding: HashControllerCreateHashEncodingEnum, createHashWithExpireDto: CreateHashWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.hashControllerCreateHash(dbInstance, encoding, createHashWithExpireDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Remove the specified fields from the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerDeleteFieldsEncodingEnum} encoding + * @param {DeleteFieldsFromHashDto} deleteFieldsFromHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerDeleteFields(dbInstance: string, encoding: HashControllerDeleteFieldsEncodingEnum, deleteFieldsFromHashDto: DeleteFieldsFromHashDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.hashControllerDeleteFields(dbInstance, encoding, deleteFieldsFromHashDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get specified fields of the hash stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {HashControllerGetMembersEncodingEnum} encoding + * @param {GetHashFieldsDto} getHashFieldsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerGetMembers(dbInstance: string, encoding: HashControllerGetMembersEncodingEnum, getHashFieldsDto: GetHashFieldsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.hashControllerGetMembers(dbInstance, encoding, getHashFieldsDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Update hash fields ttl + * @summary + * @param {string} dbInstance + * @param {HashControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateHashFieldsTtlDto} updateHashFieldsTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + hashControllerUpdateTtl(dbInstance: string, encoding: HashControllerUpdateTtlEncodingEnum, updateHashFieldsTtlDto: UpdateHashFieldsTtlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.hashControllerUpdateTtl(dbInstance, encoding, updateHashFieldsTtlDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserHashApi - object-oriented interface + * @export + * @class BrowserHashApi + * @extends {BaseAPI} + */ +export class BrowserHashApi extends BaseAPI { + /** + * Add the specified fields to the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerAddMemberEncodingEnum} encoding + * @param {AddFieldsToHashDto} addFieldsToHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserHashApi + */ + public hashControllerAddMember(dbInstance: string, encoding: HashControllerAddMemberEncodingEnum, addFieldsToHashDto: AddFieldsToHashDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserHashApiFp(this.configuration).hashControllerAddMember(dbInstance, encoding, addFieldsToHashDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Set key to hold Hash data type + * @summary + * @param {string} dbInstance + * @param {HashControllerCreateHashEncodingEnum} encoding + * @param {CreateHashWithExpireDto} createHashWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserHashApi + */ + public hashControllerCreateHash(dbInstance: string, encoding: HashControllerCreateHashEncodingEnum, createHashWithExpireDto: CreateHashWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserHashApiFp(this.configuration).hashControllerCreateHash(dbInstance, encoding, createHashWithExpireDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove the specified fields from the Hash stored at key + * @summary + * @param {string} dbInstance + * @param {HashControllerDeleteFieldsEncodingEnum} encoding + * @param {DeleteFieldsFromHashDto} deleteFieldsFromHashDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserHashApi + */ + public hashControllerDeleteFields(dbInstance: string, encoding: HashControllerDeleteFieldsEncodingEnum, deleteFieldsFromHashDto: DeleteFieldsFromHashDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserHashApiFp(this.configuration).hashControllerDeleteFields(dbInstance, encoding, deleteFieldsFromHashDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get specified fields of the hash stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {HashControllerGetMembersEncodingEnum} encoding + * @param {GetHashFieldsDto} getHashFieldsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserHashApi + */ + public hashControllerGetMembers(dbInstance: string, encoding: HashControllerGetMembersEncodingEnum, getHashFieldsDto: GetHashFieldsDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserHashApiFp(this.configuration).hashControllerGetMembers(dbInstance, encoding, getHashFieldsDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update hash fields ttl + * @summary + * @param {string} dbInstance + * @param {HashControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateHashFieldsTtlDto} updateHashFieldsTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserHashApi + */ + public hashControllerUpdateTtl(dbInstance: string, encoding: HashControllerUpdateTtlEncodingEnum, updateHashFieldsTtlDto: UpdateHashFieldsTtlDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserHashApiFp(this.configuration).hashControllerUpdateTtl(dbInstance, encoding, updateHashFieldsTtlDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const HashControllerAddMemberEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type HashControllerAddMemberEncodingEnum = typeof HashControllerAddMemberEncodingEnum[keyof typeof HashControllerAddMemberEncodingEnum]; +/** + * @export + */ +export const HashControllerCreateHashEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type HashControllerCreateHashEncodingEnum = typeof HashControllerCreateHashEncodingEnum[keyof typeof HashControllerCreateHashEncodingEnum]; +/** + * @export + */ +export const HashControllerDeleteFieldsEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type HashControllerDeleteFieldsEncodingEnum = typeof HashControllerDeleteFieldsEncodingEnum[keyof typeof HashControllerDeleteFieldsEncodingEnum]; +/** + * @export + */ +export const HashControllerGetMembersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type HashControllerGetMembersEncodingEnum = typeof HashControllerGetMembersEncodingEnum[keyof typeof HashControllerGetMembersEncodingEnum]; +/** + * @export + */ +export const HashControllerUpdateTtlEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type HashControllerUpdateTtlEncodingEnum = typeof HashControllerUpdateTtlEncodingEnum[keyof typeof HashControllerUpdateTtlEncodingEnum]; + + +/** + * BrowserKeysApi - axios parameter creator + * @export + */ +export const BrowserKeysApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete key + * @summary + * @param {string} dbInstance + * @param {KeysControllerDeleteKeyEncodingEnum} encoding + * @param {DeleteKeysDto} deleteKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerDeleteKey: async (dbInstance: string, encoding: KeysControllerDeleteKeyEncodingEnum, deleteKeysDto: DeleteKeysDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('keysControllerDeleteKey', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('keysControllerDeleteKey', 'encoding', encoding) + // verify required parameter 'deleteKeysDto' is not null or undefined + assertParamExists('keysControllerDeleteKey', 'deleteKeysDto', deleteKeysDto) + const localVarPath = `/api/databases/{dbInstance}/keys` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteKeysDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get key info + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeyInfoEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerGetKeyInfo: async (dbInstance: string, encoding: KeysControllerGetKeyInfoEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('keysControllerGetKeyInfo', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('keysControllerGetKeyInfo', 'encoding', encoding) + // verify required parameter 'getKeyInfoDto' is not null or undefined + assertParamExists('keysControllerGetKeyInfo', 'getKeyInfoDto', getKeyInfoDto) + const localVarPath = `/api/databases/{dbInstance}/keys/get-info` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getKeyInfoDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get keys by cursor position + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysEncodingEnum} encoding + * @param {GetKeysDto} getKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerGetKeys: async (dbInstance: string, encoding: KeysControllerGetKeysEncodingEnum, getKeysDto: GetKeysDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('keysControllerGetKeys', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('keysControllerGetKeys', 'encoding', encoding) + // verify required parameter 'getKeysDto' is not null or undefined + assertParamExists('keysControllerGetKeys', 'getKeysDto', getKeysDto) + const localVarPath = `/api/databases/{dbInstance}/keys` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getKeysDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get info for multiple keys + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysInfoEncodingEnum} encoding + * @param {GetKeysInfoDto} getKeysInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerGetKeysInfo: async (dbInstance: string, encoding: KeysControllerGetKeysInfoEncodingEnum, getKeysInfoDto: GetKeysInfoDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('keysControllerGetKeysInfo', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('keysControllerGetKeysInfo', 'encoding', encoding) + // verify required parameter 'getKeysInfoDto' is not null or undefined + assertParamExists('keysControllerGetKeysInfo', 'getKeysInfoDto', getKeysInfoDto) + const localVarPath = `/api/databases/{dbInstance}/keys/get-metadata` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getKeysInfoDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Rename key + * @summary + * @param {string} dbInstance + * @param {KeysControllerRenameKeyEncodingEnum} encoding + * @param {RenameKeyDto} renameKeyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerRenameKey: async (dbInstance: string, encoding: KeysControllerRenameKeyEncodingEnum, renameKeyDto: RenameKeyDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('keysControllerRenameKey', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('keysControllerRenameKey', 'encoding', encoding) + // verify required parameter 'renameKeyDto' is not null or undefined + assertParamExists('keysControllerRenameKey', 'renameKeyDto', renameKeyDto) + const localVarPath = `/api/databases/{dbInstance}/keys/name` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(renameKeyDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update the remaining time to live of a key + * @summary + * @param {string} dbInstance + * @param {KeysControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateKeyTtlDto} updateKeyTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerUpdateTtl: async (dbInstance: string, encoding: KeysControllerUpdateTtlEncodingEnum, updateKeyTtlDto: UpdateKeyTtlDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('keysControllerUpdateTtl', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('keysControllerUpdateTtl', 'encoding', encoding) + // verify required parameter 'updateKeyTtlDto' is not null or undefined + assertParamExists('keysControllerUpdateTtl', 'updateKeyTtlDto', updateKeyTtlDto) + const localVarPath = `/api/databases/{dbInstance}/keys/ttl` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateKeyTtlDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserKeysApi - functional programming interface + * @export + */ +export const BrowserKeysApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserKeysApiAxiosParamCreator(configuration) + return { + /** + * Delete key + * @summary + * @param {string} dbInstance + * @param {KeysControllerDeleteKeyEncodingEnum} encoding + * @param {DeleteKeysDto} deleteKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async keysControllerDeleteKey(dbInstance: string, encoding: KeysControllerDeleteKeyEncodingEnum, deleteKeysDto: DeleteKeysDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.keysControllerDeleteKey(dbInstance, encoding, deleteKeysDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserKeysApi.keysControllerDeleteKey']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get key info + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeyInfoEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async keysControllerGetKeyInfo(dbInstance: string, encoding: KeysControllerGetKeyInfoEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.keysControllerGetKeyInfo(dbInstance, encoding, getKeyInfoDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserKeysApi.keysControllerGetKeyInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get keys by cursor position + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysEncodingEnum} encoding + * @param {GetKeysDto} getKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async keysControllerGetKeys(dbInstance: string, encoding: KeysControllerGetKeysEncodingEnum, getKeysDto: GetKeysDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.keysControllerGetKeys(dbInstance, encoding, getKeysDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserKeysApi.keysControllerGetKeys']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get info for multiple keys + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysInfoEncodingEnum} encoding + * @param {GetKeysInfoDto} getKeysInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async keysControllerGetKeysInfo(dbInstance: string, encoding: KeysControllerGetKeysInfoEncodingEnum, getKeysInfoDto: GetKeysInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.keysControllerGetKeysInfo(dbInstance, encoding, getKeysInfoDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserKeysApi.keysControllerGetKeysInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Rename key + * @summary + * @param {string} dbInstance + * @param {KeysControllerRenameKeyEncodingEnum} encoding + * @param {RenameKeyDto} renameKeyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async keysControllerRenameKey(dbInstance: string, encoding: KeysControllerRenameKeyEncodingEnum, renameKeyDto: RenameKeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.keysControllerRenameKey(dbInstance, encoding, renameKeyDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserKeysApi.keysControllerRenameKey']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update the remaining time to live of a key + * @summary + * @param {string} dbInstance + * @param {KeysControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateKeyTtlDto} updateKeyTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async keysControllerUpdateTtl(dbInstance: string, encoding: KeysControllerUpdateTtlEncodingEnum, updateKeyTtlDto: UpdateKeyTtlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.keysControllerUpdateTtl(dbInstance, encoding, updateKeyTtlDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserKeysApi.keysControllerUpdateTtl']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserKeysApi - factory interface + * @export + */ +export const BrowserKeysApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserKeysApiFp(configuration) + return { + /** + * Delete key + * @summary + * @param {string} dbInstance + * @param {KeysControllerDeleteKeyEncodingEnum} encoding + * @param {DeleteKeysDto} deleteKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerDeleteKey(dbInstance: string, encoding: KeysControllerDeleteKeyEncodingEnum, deleteKeysDto: DeleteKeysDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.keysControllerDeleteKey(dbInstance, encoding, deleteKeysDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get key info + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeyInfoEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerGetKeyInfo(dbInstance: string, encoding: KeysControllerGetKeyInfoEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.keysControllerGetKeyInfo(dbInstance, encoding, getKeyInfoDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get keys by cursor position + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysEncodingEnum} encoding + * @param {GetKeysDto} getKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerGetKeys(dbInstance: string, encoding: KeysControllerGetKeysEncodingEnum, getKeysDto: GetKeysDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.keysControllerGetKeys(dbInstance, encoding, getKeysDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get info for multiple keys + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysInfoEncodingEnum} encoding + * @param {GetKeysInfoDto} getKeysInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerGetKeysInfo(dbInstance: string, encoding: KeysControllerGetKeysInfoEncodingEnum, getKeysInfoDto: GetKeysInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.keysControllerGetKeysInfo(dbInstance, encoding, getKeysInfoDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Rename key + * @summary + * @param {string} dbInstance + * @param {KeysControllerRenameKeyEncodingEnum} encoding + * @param {RenameKeyDto} renameKeyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerRenameKey(dbInstance: string, encoding: KeysControllerRenameKeyEncodingEnum, renameKeyDto: RenameKeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.keysControllerRenameKey(dbInstance, encoding, renameKeyDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Update the remaining time to live of a key + * @summary + * @param {string} dbInstance + * @param {KeysControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateKeyTtlDto} updateKeyTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + keysControllerUpdateTtl(dbInstance: string, encoding: KeysControllerUpdateTtlEncodingEnum, updateKeyTtlDto: UpdateKeyTtlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.keysControllerUpdateTtl(dbInstance, encoding, updateKeyTtlDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserKeysApi - object-oriented interface + * @export + * @class BrowserKeysApi + * @extends {BaseAPI} + */ +export class BrowserKeysApi extends BaseAPI { + /** + * Delete key + * @summary + * @param {string} dbInstance + * @param {KeysControllerDeleteKeyEncodingEnum} encoding + * @param {DeleteKeysDto} deleteKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserKeysApi + */ + public keysControllerDeleteKey(dbInstance: string, encoding: KeysControllerDeleteKeyEncodingEnum, deleteKeysDto: DeleteKeysDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserKeysApiFp(this.configuration).keysControllerDeleteKey(dbInstance, encoding, deleteKeysDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get key info + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeyInfoEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserKeysApi + */ + public keysControllerGetKeyInfo(dbInstance: string, encoding: KeysControllerGetKeyInfoEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserKeysApiFp(this.configuration).keysControllerGetKeyInfo(dbInstance, encoding, getKeyInfoDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get keys by cursor position + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysEncodingEnum} encoding + * @param {GetKeysDto} getKeysDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserKeysApi + */ + public keysControllerGetKeys(dbInstance: string, encoding: KeysControllerGetKeysEncodingEnum, getKeysDto: GetKeysDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserKeysApiFp(this.configuration).keysControllerGetKeys(dbInstance, encoding, getKeysDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get info for multiple keys + * @summary + * @param {string} dbInstance + * @param {KeysControllerGetKeysInfoEncodingEnum} encoding + * @param {GetKeysInfoDto} getKeysInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserKeysApi + */ + public keysControllerGetKeysInfo(dbInstance: string, encoding: KeysControllerGetKeysInfoEncodingEnum, getKeysInfoDto: GetKeysInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserKeysApiFp(this.configuration).keysControllerGetKeysInfo(dbInstance, encoding, getKeysInfoDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Rename key + * @summary + * @param {string} dbInstance + * @param {KeysControllerRenameKeyEncodingEnum} encoding + * @param {RenameKeyDto} renameKeyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserKeysApi + */ + public keysControllerRenameKey(dbInstance: string, encoding: KeysControllerRenameKeyEncodingEnum, renameKeyDto: RenameKeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserKeysApiFp(this.configuration).keysControllerRenameKey(dbInstance, encoding, renameKeyDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update the remaining time to live of a key + * @summary + * @param {string} dbInstance + * @param {KeysControllerUpdateTtlEncodingEnum} encoding + * @param {UpdateKeyTtlDto} updateKeyTtlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserKeysApi + */ + public keysControllerUpdateTtl(dbInstance: string, encoding: KeysControllerUpdateTtlEncodingEnum, updateKeyTtlDto: UpdateKeyTtlDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserKeysApiFp(this.configuration).keysControllerUpdateTtl(dbInstance, encoding, updateKeyTtlDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const KeysControllerDeleteKeyEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type KeysControllerDeleteKeyEncodingEnum = typeof KeysControllerDeleteKeyEncodingEnum[keyof typeof KeysControllerDeleteKeyEncodingEnum]; +/** + * @export + */ +export const KeysControllerGetKeyInfoEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type KeysControllerGetKeyInfoEncodingEnum = typeof KeysControllerGetKeyInfoEncodingEnum[keyof typeof KeysControllerGetKeyInfoEncodingEnum]; +/** + * @export + */ +export const KeysControllerGetKeysEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type KeysControllerGetKeysEncodingEnum = typeof KeysControllerGetKeysEncodingEnum[keyof typeof KeysControllerGetKeysEncodingEnum]; +/** + * @export + */ +export const KeysControllerGetKeysInfoEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type KeysControllerGetKeysInfoEncodingEnum = typeof KeysControllerGetKeysInfoEncodingEnum[keyof typeof KeysControllerGetKeysInfoEncodingEnum]; +/** + * @export + */ +export const KeysControllerRenameKeyEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type KeysControllerRenameKeyEncodingEnum = typeof KeysControllerRenameKeyEncodingEnum[keyof typeof KeysControllerRenameKeyEncodingEnum]; +/** + * @export + */ +export const KeysControllerUpdateTtlEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type KeysControllerUpdateTtlEncodingEnum = typeof KeysControllerUpdateTtlEncodingEnum[keyof typeof KeysControllerUpdateTtlEncodingEnum]; + + +/** + * BrowserListApi - axios parameter creator + * @export + */ +export const BrowserListApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Set key to hold list data type + * @summary + * @param {string} dbInstance + * @param {ListControllerCreateListEncodingEnum} encoding + * @param {CreateListWithExpireDto} createListWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerCreateList: async (dbInstance: string, encoding: ListControllerCreateListEncodingEnum, createListWithExpireDto: CreateListWithExpireDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('listControllerCreateList', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('listControllerCreateList', 'encoding', encoding) + // verify required parameter 'createListWithExpireDto' is not null or undefined + assertParamExists('listControllerCreateList', 'createListWithExpireDto', createListWithExpireDto) + const localVarPath = `/api/databases/{dbInstance}/list` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createListWithExpireDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Remove and return the elements from the tail/head of list stored at key. + * @summary + * @param {string} dbInstance + * @param {ListControllerDeleteElementEncodingEnum} encoding + * @param {DeleteListElementsDto} deleteListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerDeleteElement: async (dbInstance: string, encoding: ListControllerDeleteElementEncodingEnum, deleteListElementsDto: DeleteListElementsDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('listControllerDeleteElement', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('listControllerDeleteElement', 'encoding', encoding) + // verify required parameter 'deleteListElementsDto' is not null or undefined + assertParamExists('listControllerDeleteElement', 'deleteListElementsDto', deleteListElementsDto) + const localVarPath = `/api/databases/{dbInstance}/list/elements` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteListElementsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get specified List element by index + * @summary + * @param {number} index Zero-based index. 0 - first element, 1 - second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element + * @param {string} dbInstance + * @param {ListControllerGetElementEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerGetElement: async (index: number, dbInstance: string, encoding: ListControllerGetElementEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'index' is not null or undefined + assertParamExists('listControllerGetElement', 'index', index) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('listControllerGetElement', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('listControllerGetElement', 'encoding', encoding) + // verify required parameter 'keyDto' is not null or undefined + assertParamExists('listControllerGetElement', 'keyDto', keyDto) + const localVarPath = `/api/databases/{dbInstance}/list/get-elements/{index}` + .replace(`{${"index"}}`, encodeURIComponent(String(index))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(keyDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get specified elements of the list stored at key + * @summary + * @param {string} dbInstance + * @param {ListControllerGetElementsEncodingEnum} encoding + * @param {GetListElementsDto} getListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerGetElements: async (dbInstance: string, encoding: ListControllerGetElementsEncodingEnum, getListElementsDto: GetListElementsDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('listControllerGetElements', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('listControllerGetElements', 'encoding', encoding) + // verify required parameter 'getListElementsDto' is not null or undefined + assertParamExists('listControllerGetElements', 'getListElementsDto', getListElementsDto) + const localVarPath = `/api/databases/{dbInstance}/list/get-elements` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getListElementsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Insert element at the head/tail of the List data type + * @summary + * @param {string} dbInstance + * @param {ListControllerPushElementEncodingEnum} encoding + * @param {PushElementToListDto} pushElementToListDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerPushElement: async (dbInstance: string, encoding: ListControllerPushElementEncodingEnum, pushElementToListDto: PushElementToListDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('listControllerPushElement', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('listControllerPushElement', 'encoding', encoding) + // verify required parameter 'pushElementToListDto' is not null or undefined + assertParamExists('listControllerPushElement', 'pushElementToListDto', pushElementToListDto) + const localVarPath = `/api/databases/{dbInstance}/list` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(pushElementToListDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update list element by index. + * @summary + * @param {string} dbInstance + * @param {ListControllerUpdateElementEncodingEnum} encoding + * @param {SetListElementDto} setListElementDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerUpdateElement: async (dbInstance: string, encoding: ListControllerUpdateElementEncodingEnum, setListElementDto: SetListElementDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('listControllerUpdateElement', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('listControllerUpdateElement', 'encoding', encoding) + // verify required parameter 'setListElementDto' is not null or undefined + assertParamExists('listControllerUpdateElement', 'setListElementDto', setListElementDto) + const localVarPath = `/api/databases/{dbInstance}/list` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(setListElementDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserListApi - functional programming interface + * @export + */ +export const BrowserListApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserListApiAxiosParamCreator(configuration) + return { + /** + * Set key to hold list data type + * @summary + * @param {string} dbInstance + * @param {ListControllerCreateListEncodingEnum} encoding + * @param {CreateListWithExpireDto} createListWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listControllerCreateList(dbInstance: string, encoding: ListControllerCreateListEncodingEnum, createListWithExpireDto: CreateListWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listControllerCreateList(dbInstance, encoding, createListWithExpireDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserListApi.listControllerCreateList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove and return the elements from the tail/head of list stored at key. + * @summary + * @param {string} dbInstance + * @param {ListControllerDeleteElementEncodingEnum} encoding + * @param {DeleteListElementsDto} deleteListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listControllerDeleteElement(dbInstance: string, encoding: ListControllerDeleteElementEncodingEnum, deleteListElementsDto: DeleteListElementsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listControllerDeleteElement(dbInstance, encoding, deleteListElementsDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserListApi.listControllerDeleteElement']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get specified List element by index + * @summary + * @param {number} index Zero-based index. 0 - first element, 1 - second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element + * @param {string} dbInstance + * @param {ListControllerGetElementEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listControllerGetElement(index: number, dbInstance: string, encoding: ListControllerGetElementEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listControllerGetElement(index, dbInstance, encoding, keyDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserListApi.listControllerGetElement']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get specified elements of the list stored at key + * @summary + * @param {string} dbInstance + * @param {ListControllerGetElementsEncodingEnum} encoding + * @param {GetListElementsDto} getListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listControllerGetElements(dbInstance: string, encoding: ListControllerGetElementsEncodingEnum, getListElementsDto: GetListElementsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listControllerGetElements(dbInstance, encoding, getListElementsDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserListApi.listControllerGetElements']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Insert element at the head/tail of the List data type + * @summary + * @param {string} dbInstance + * @param {ListControllerPushElementEncodingEnum} encoding + * @param {PushElementToListDto} pushElementToListDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listControllerPushElement(dbInstance: string, encoding: ListControllerPushElementEncodingEnum, pushElementToListDto: PushElementToListDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listControllerPushElement(dbInstance, encoding, pushElementToListDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserListApi.listControllerPushElement']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update list element by index. + * @summary + * @param {string} dbInstance + * @param {ListControllerUpdateElementEncodingEnum} encoding + * @param {SetListElementDto} setListElementDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listControllerUpdateElement(dbInstance: string, encoding: ListControllerUpdateElementEncodingEnum, setListElementDto: SetListElementDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listControllerUpdateElement(dbInstance, encoding, setListElementDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserListApi.listControllerUpdateElement']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserListApi - factory interface + * @export + */ +export const BrowserListApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserListApiFp(configuration) + return { + /** + * Set key to hold list data type + * @summary + * @param {string} dbInstance + * @param {ListControllerCreateListEncodingEnum} encoding + * @param {CreateListWithExpireDto} createListWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerCreateList(dbInstance: string, encoding: ListControllerCreateListEncodingEnum, createListWithExpireDto: CreateListWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listControllerCreateList(dbInstance, encoding, createListWithExpireDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Remove and return the elements from the tail/head of list stored at key. + * @summary + * @param {string} dbInstance + * @param {ListControllerDeleteElementEncodingEnum} encoding + * @param {DeleteListElementsDto} deleteListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerDeleteElement(dbInstance: string, encoding: ListControllerDeleteElementEncodingEnum, deleteListElementsDto: DeleteListElementsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listControllerDeleteElement(dbInstance, encoding, deleteListElementsDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get specified List element by index + * @summary + * @param {number} index Zero-based index. 0 - first element, 1 - second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element + * @param {string} dbInstance + * @param {ListControllerGetElementEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerGetElement(index: number, dbInstance: string, encoding: ListControllerGetElementEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listControllerGetElement(index, dbInstance, encoding, keyDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get specified elements of the list stored at key + * @summary + * @param {string} dbInstance + * @param {ListControllerGetElementsEncodingEnum} encoding + * @param {GetListElementsDto} getListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerGetElements(dbInstance: string, encoding: ListControllerGetElementsEncodingEnum, getListElementsDto: GetListElementsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listControllerGetElements(dbInstance, encoding, getListElementsDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Insert element at the head/tail of the List data type + * @summary + * @param {string} dbInstance + * @param {ListControllerPushElementEncodingEnum} encoding + * @param {PushElementToListDto} pushElementToListDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerPushElement(dbInstance: string, encoding: ListControllerPushElementEncodingEnum, pushElementToListDto: PushElementToListDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listControllerPushElement(dbInstance, encoding, pushElementToListDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Update list element by index. + * @summary + * @param {string} dbInstance + * @param {ListControllerUpdateElementEncodingEnum} encoding + * @param {SetListElementDto} setListElementDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listControllerUpdateElement(dbInstance: string, encoding: ListControllerUpdateElementEncodingEnum, setListElementDto: SetListElementDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listControllerUpdateElement(dbInstance, encoding, setListElementDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserListApi - object-oriented interface + * @export + * @class BrowserListApi + * @extends {BaseAPI} + */ +export class BrowserListApi extends BaseAPI { + /** + * Set key to hold list data type + * @summary + * @param {string} dbInstance + * @param {ListControllerCreateListEncodingEnum} encoding + * @param {CreateListWithExpireDto} createListWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserListApi + */ + public listControllerCreateList(dbInstance: string, encoding: ListControllerCreateListEncodingEnum, createListWithExpireDto: CreateListWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserListApiFp(this.configuration).listControllerCreateList(dbInstance, encoding, createListWithExpireDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove and return the elements from the tail/head of list stored at key. + * @summary + * @param {string} dbInstance + * @param {ListControllerDeleteElementEncodingEnum} encoding + * @param {DeleteListElementsDto} deleteListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserListApi + */ + public listControllerDeleteElement(dbInstance: string, encoding: ListControllerDeleteElementEncodingEnum, deleteListElementsDto: DeleteListElementsDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserListApiFp(this.configuration).listControllerDeleteElement(dbInstance, encoding, deleteListElementsDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get specified List element by index + * @summary + * @param {number} index Zero-based index. 0 - first element, 1 - second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element + * @param {string} dbInstance + * @param {ListControllerGetElementEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserListApi + */ + public listControllerGetElement(index: number, dbInstance: string, encoding: ListControllerGetElementEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserListApiFp(this.configuration).listControllerGetElement(index, dbInstance, encoding, keyDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get specified elements of the list stored at key + * @summary + * @param {string} dbInstance + * @param {ListControllerGetElementsEncodingEnum} encoding + * @param {GetListElementsDto} getListElementsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserListApi + */ + public listControllerGetElements(dbInstance: string, encoding: ListControllerGetElementsEncodingEnum, getListElementsDto: GetListElementsDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserListApiFp(this.configuration).listControllerGetElements(dbInstance, encoding, getListElementsDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Insert element at the head/tail of the List data type + * @summary + * @param {string} dbInstance + * @param {ListControllerPushElementEncodingEnum} encoding + * @param {PushElementToListDto} pushElementToListDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserListApi + */ + public listControllerPushElement(dbInstance: string, encoding: ListControllerPushElementEncodingEnum, pushElementToListDto: PushElementToListDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserListApiFp(this.configuration).listControllerPushElement(dbInstance, encoding, pushElementToListDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update list element by index. + * @summary + * @param {string} dbInstance + * @param {ListControllerUpdateElementEncodingEnum} encoding + * @param {SetListElementDto} setListElementDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserListApi + */ + public listControllerUpdateElement(dbInstance: string, encoding: ListControllerUpdateElementEncodingEnum, setListElementDto: SetListElementDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserListApiFp(this.configuration).listControllerUpdateElement(dbInstance, encoding, setListElementDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ListControllerCreateListEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ListControllerCreateListEncodingEnum = typeof ListControllerCreateListEncodingEnum[keyof typeof ListControllerCreateListEncodingEnum]; +/** + * @export + */ +export const ListControllerDeleteElementEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ListControllerDeleteElementEncodingEnum = typeof ListControllerDeleteElementEncodingEnum[keyof typeof ListControllerDeleteElementEncodingEnum]; +/** + * @export + */ +export const ListControllerGetElementEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ListControllerGetElementEncodingEnum = typeof ListControllerGetElementEncodingEnum[keyof typeof ListControllerGetElementEncodingEnum]; +/** + * @export + */ +export const ListControllerGetElementsEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ListControllerGetElementsEncodingEnum = typeof ListControllerGetElementsEncodingEnum[keyof typeof ListControllerGetElementsEncodingEnum]; +/** + * @export + */ +export const ListControllerPushElementEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ListControllerPushElementEncodingEnum = typeof ListControllerPushElementEncodingEnum[keyof typeof ListControllerPushElementEncodingEnum]; +/** + * @export + */ +export const ListControllerUpdateElementEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ListControllerUpdateElementEncodingEnum = typeof ListControllerUpdateElementEncodingEnum[keyof typeof ListControllerUpdateElementEncodingEnum]; + + +/** + * BrowserREJSONRLApi - axios parameter creator + * @export + */ +export const BrowserREJSONRLApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Append item inside REJSON-RL array + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlArrAppendDto} modifyRejsonRlArrAppendDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerArrAppend: async (dbInstance: string, modifyRejsonRlArrAppendDto: ModifyRejsonRlArrAppendDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('rejsonRlControllerArrAppend', 'dbInstance', dbInstance) + // verify required parameter 'modifyRejsonRlArrAppendDto' is not null or undefined + assertParamExists('rejsonRlControllerArrAppend', 'modifyRejsonRlArrAppendDto', modifyRejsonRlArrAppendDto) + const localVarPath = `/api/databases/{dbInstance}/rejson-rl/arrappend` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(modifyRejsonRlArrAppendDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Create new REJSON-RL data type + * @summary + * @param {string} dbInstance + * @param {CreateRejsonRlWithExpireDto} createRejsonRlWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerCreateJson: async (dbInstance: string, createRejsonRlWithExpireDto: CreateRejsonRlWithExpireDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('rejsonRlControllerCreateJson', 'dbInstance', dbInstance) + // verify required parameter 'createRejsonRlWithExpireDto' is not null or undefined + assertParamExists('rejsonRlControllerCreateJson', 'createRejsonRlWithExpireDto', createRejsonRlWithExpireDto) + const localVarPath = `/api/databases/{dbInstance}/rejson-rl` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createRejsonRlWithExpireDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get json properties by path + * @summary + * @param {string} dbInstance + * @param {GetRejsonRlDto} getRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerGetJson: async (dbInstance: string, getRejsonRlDto: GetRejsonRlDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('rejsonRlControllerGetJson', 'dbInstance', dbInstance) + // verify required parameter 'getRejsonRlDto' is not null or undefined + assertParamExists('rejsonRlControllerGetJson', 'getRejsonRlDto', getRejsonRlDto) + const localVarPath = `/api/databases/{dbInstance}/rejson-rl/get` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getRejsonRlDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Modify REJSON-RL data type by path + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlSetDto} modifyRejsonRlSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerJsonSet: async (dbInstance: string, modifyRejsonRlSetDto: ModifyRejsonRlSetDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('rejsonRlControllerJsonSet', 'dbInstance', dbInstance) + // verify required parameter 'modifyRejsonRlSetDto' is not null or undefined + assertParamExists('rejsonRlControllerJsonSet', 'modifyRejsonRlSetDto', modifyRejsonRlSetDto) + const localVarPath = `/api/databases/{dbInstance}/rejson-rl/set` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(modifyRejsonRlSetDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes path in the REJSON-RL + * @summary + * @param {string} dbInstance + * @param {RemoveRejsonRlDto} removeRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerRemove: async (dbInstance: string, removeRejsonRlDto: RemoveRejsonRlDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('rejsonRlControllerRemove', 'dbInstance', dbInstance) + // verify required parameter 'removeRejsonRlDto' is not null or undefined + assertParamExists('rejsonRlControllerRemove', 'removeRejsonRlDto', removeRejsonRlDto) + const localVarPath = `/api/databases/{dbInstance}/rejson-rl` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(removeRejsonRlDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserREJSONRLApi - functional programming interface + * @export + */ +export const BrowserREJSONRLApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserREJSONRLApiAxiosParamCreator(configuration) + return { + /** + * Append item inside REJSON-RL array + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlArrAppendDto} modifyRejsonRlArrAppendDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rejsonRlControllerArrAppend(dbInstance: string, modifyRejsonRlArrAppendDto: ModifyRejsonRlArrAppendDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejsonRlControllerArrAppend(dbInstance, modifyRejsonRlArrAppendDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserREJSONRLApi.rejsonRlControllerArrAppend']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create new REJSON-RL data type + * @summary + * @param {string} dbInstance + * @param {CreateRejsonRlWithExpireDto} createRejsonRlWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rejsonRlControllerCreateJson(dbInstance: string, createRejsonRlWithExpireDto: CreateRejsonRlWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejsonRlControllerCreateJson(dbInstance, createRejsonRlWithExpireDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserREJSONRLApi.rejsonRlControllerCreateJson']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get json properties by path + * @summary + * @param {string} dbInstance + * @param {GetRejsonRlDto} getRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rejsonRlControllerGetJson(dbInstance: string, getRejsonRlDto: GetRejsonRlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejsonRlControllerGetJson(dbInstance, getRejsonRlDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserREJSONRLApi.rejsonRlControllerGetJson']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Modify REJSON-RL data type by path + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlSetDto} modifyRejsonRlSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rejsonRlControllerJsonSet(dbInstance: string, modifyRejsonRlSetDto: ModifyRejsonRlSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejsonRlControllerJsonSet(dbInstance, modifyRejsonRlSetDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserREJSONRLApi.rejsonRlControllerJsonSet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Removes path in the REJSON-RL + * @summary + * @param {string} dbInstance + * @param {RemoveRejsonRlDto} removeRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rejsonRlControllerRemove(dbInstance: string, removeRejsonRlDto: RemoveRejsonRlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rejsonRlControllerRemove(dbInstance, removeRejsonRlDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserREJSONRLApi.rejsonRlControllerRemove']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserREJSONRLApi - factory interface + * @export + */ +export const BrowserREJSONRLApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserREJSONRLApiFp(configuration) + return { + /** + * Append item inside REJSON-RL array + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlArrAppendDto} modifyRejsonRlArrAppendDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerArrAppend(dbInstance: string, modifyRejsonRlArrAppendDto: ModifyRejsonRlArrAppendDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejsonRlControllerArrAppend(dbInstance, modifyRejsonRlArrAppendDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Create new REJSON-RL data type + * @summary + * @param {string} dbInstance + * @param {CreateRejsonRlWithExpireDto} createRejsonRlWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerCreateJson(dbInstance: string, createRejsonRlWithExpireDto: CreateRejsonRlWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejsonRlControllerCreateJson(dbInstance, createRejsonRlWithExpireDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get json properties by path + * @summary + * @param {string} dbInstance + * @param {GetRejsonRlDto} getRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerGetJson(dbInstance: string, getRejsonRlDto: GetRejsonRlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejsonRlControllerGetJson(dbInstance, getRejsonRlDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Modify REJSON-RL data type by path + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlSetDto} modifyRejsonRlSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerJsonSet(dbInstance: string, modifyRejsonRlSetDto: ModifyRejsonRlSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejsonRlControllerJsonSet(dbInstance, modifyRejsonRlSetDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Removes path in the REJSON-RL + * @summary + * @param {string} dbInstance + * @param {RemoveRejsonRlDto} removeRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rejsonRlControllerRemove(dbInstance: string, removeRejsonRlDto: RemoveRejsonRlDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rejsonRlControllerRemove(dbInstance, removeRejsonRlDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserREJSONRLApi - object-oriented interface + * @export + * @class BrowserREJSONRLApi + * @extends {BaseAPI} + */ +export class BrowserREJSONRLApi extends BaseAPI { + /** + * Append item inside REJSON-RL array + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlArrAppendDto} modifyRejsonRlArrAppendDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserREJSONRLApi + */ + public rejsonRlControllerArrAppend(dbInstance: string, modifyRejsonRlArrAppendDto: ModifyRejsonRlArrAppendDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserREJSONRLApiFp(this.configuration).rejsonRlControllerArrAppend(dbInstance, modifyRejsonRlArrAppendDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create new REJSON-RL data type + * @summary + * @param {string} dbInstance + * @param {CreateRejsonRlWithExpireDto} createRejsonRlWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserREJSONRLApi + */ + public rejsonRlControllerCreateJson(dbInstance: string, createRejsonRlWithExpireDto: CreateRejsonRlWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserREJSONRLApiFp(this.configuration).rejsonRlControllerCreateJson(dbInstance, createRejsonRlWithExpireDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get json properties by path + * @summary + * @param {string} dbInstance + * @param {GetRejsonRlDto} getRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserREJSONRLApi + */ + public rejsonRlControllerGetJson(dbInstance: string, getRejsonRlDto: GetRejsonRlDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserREJSONRLApiFp(this.configuration).rejsonRlControllerGetJson(dbInstance, getRejsonRlDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Modify REJSON-RL data type by path + * @summary + * @param {string} dbInstance + * @param {ModifyRejsonRlSetDto} modifyRejsonRlSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserREJSONRLApi + */ + public rejsonRlControllerJsonSet(dbInstance: string, modifyRejsonRlSetDto: ModifyRejsonRlSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserREJSONRLApiFp(this.configuration).rejsonRlControllerJsonSet(dbInstance, modifyRejsonRlSetDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes path in the REJSON-RL + * @summary + * @param {string} dbInstance + * @param {RemoveRejsonRlDto} removeRejsonRlDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserREJSONRLApi + */ + public rejsonRlControllerRemove(dbInstance: string, removeRejsonRlDto: RemoveRejsonRlDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserREJSONRLApiFp(this.configuration).rejsonRlControllerRemove(dbInstance, removeRejsonRlDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * BrowserRediSearchApi - axios parameter creator + * @export + */ +export const BrowserRediSearchApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create redisearch index + * @summary + * @param {string} dbInstance + * @param {CreateRedisearchIndexDto} createRedisearchIndexDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerCreateIndex: async (dbInstance: string, createRedisearchIndexDto: CreateRedisearchIndexDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('redisearchControllerCreateIndex', 'dbInstance', dbInstance) + // verify required parameter 'createRedisearchIndexDto' is not null or undefined + assertParamExists('redisearchControllerCreateIndex', 'createRedisearchIndexDto', createRedisearchIndexDto) + const localVarPath = `/api/databases/{dbInstance}/redisearch` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createRedisearchIndexDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get index info + * @summary + * @param {string} dbInstance + * @param {IndexInfoRequestBodyDto} indexInfoRequestBodyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerInfo: async (dbInstance: string, indexInfoRequestBodyDto: IndexInfoRequestBodyDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('redisearchControllerInfo', 'dbInstance', dbInstance) + // verify required parameter 'indexInfoRequestBodyDto' is not null or undefined + assertParamExists('redisearchControllerInfo', 'indexInfoRequestBodyDto', indexInfoRequestBodyDto) + const localVarPath = `/api/databases/{dbInstance}/redisearch/info` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(indexInfoRequestBodyDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get list of available indexes + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerListEncodingEnum} encoding + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerList: async (dbInstance: string, encoding: RedisearchControllerListEncodingEnum, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('redisearchControllerList', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('redisearchControllerList', 'encoding', encoding) + const localVarPath = `/api/databases/{dbInstance}/redisearch` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Search for keys in index + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerSearchEncodingEnum} encoding + * @param {SearchRedisearchDto} searchRedisearchDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerSearch: async (dbInstance: string, encoding: RedisearchControllerSearchEncodingEnum, searchRedisearchDto: SearchRedisearchDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('redisearchControllerSearch', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('redisearchControllerSearch', 'encoding', encoding) + // verify required parameter 'searchRedisearchDto' is not null or undefined + assertParamExists('redisearchControllerSearch', 'searchRedisearchDto', searchRedisearchDto) + const localVarPath = `/api/databases/{dbInstance}/redisearch/search` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(searchRedisearchDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserRediSearchApi - functional programming interface + * @export + */ +export const BrowserRediSearchApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserRediSearchApiAxiosParamCreator(configuration) + return { + /** + * Create redisearch index + * @summary + * @param {string} dbInstance + * @param {CreateRedisearchIndexDto} createRedisearchIndexDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisearchControllerCreateIndex(dbInstance: string, createRedisearchIndexDto: CreateRedisearchIndexDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisearchControllerCreateIndex(dbInstance, createRedisearchIndexDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserRediSearchApi.redisearchControllerCreateIndex']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get index info + * @summary + * @param {string} dbInstance + * @param {IndexInfoRequestBodyDto} indexInfoRequestBodyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisearchControllerInfo(dbInstance: string, indexInfoRequestBodyDto: IndexInfoRequestBodyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisearchControllerInfo(dbInstance, indexInfoRequestBodyDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserRediSearchApi.redisearchControllerInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get list of available indexes + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerListEncodingEnum} encoding + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisearchControllerList(dbInstance: string, encoding: RedisearchControllerListEncodingEnum, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisearchControllerList(dbInstance, encoding, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserRediSearchApi.redisearchControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Search for keys in index + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerSearchEncodingEnum} encoding + * @param {SearchRedisearchDto} searchRedisearchDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisearchControllerSearch(dbInstance: string, encoding: RedisearchControllerSearchEncodingEnum, searchRedisearchDto: SearchRedisearchDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisearchControllerSearch(dbInstance, encoding, searchRedisearchDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserRediSearchApi.redisearchControllerSearch']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserRediSearchApi - factory interface + * @export + */ +export const BrowserRediSearchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserRediSearchApiFp(configuration) + return { + /** + * Create redisearch index + * @summary + * @param {string} dbInstance + * @param {CreateRedisearchIndexDto} createRedisearchIndexDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerCreateIndex(dbInstance: string, createRedisearchIndexDto: CreateRedisearchIndexDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.redisearchControllerCreateIndex(dbInstance, createRedisearchIndexDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get index info + * @summary + * @param {string} dbInstance + * @param {IndexInfoRequestBodyDto} indexInfoRequestBodyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerInfo(dbInstance: string, indexInfoRequestBodyDto: IndexInfoRequestBodyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.redisearchControllerInfo(dbInstance, indexInfoRequestBodyDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get list of available indexes + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerListEncodingEnum} encoding + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerList(dbInstance: string, encoding: RedisearchControllerListEncodingEnum, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.redisearchControllerList(dbInstance, encoding, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Search for keys in index + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerSearchEncodingEnum} encoding + * @param {SearchRedisearchDto} searchRedisearchDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisearchControllerSearch(dbInstance: string, encoding: RedisearchControllerSearchEncodingEnum, searchRedisearchDto: SearchRedisearchDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.redisearchControllerSearch(dbInstance, encoding, searchRedisearchDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserRediSearchApi - object-oriented interface + * @export + * @class BrowserRediSearchApi + * @extends {BaseAPI} + */ +export class BrowserRediSearchApi extends BaseAPI { + /** + * Create redisearch index + * @summary + * @param {string} dbInstance + * @param {CreateRedisearchIndexDto} createRedisearchIndexDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserRediSearchApi + */ + public redisearchControllerCreateIndex(dbInstance: string, createRedisearchIndexDto: CreateRedisearchIndexDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserRediSearchApiFp(this.configuration).redisearchControllerCreateIndex(dbInstance, createRedisearchIndexDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get index info + * @summary + * @param {string} dbInstance + * @param {IndexInfoRequestBodyDto} indexInfoRequestBodyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserRediSearchApi + */ + public redisearchControllerInfo(dbInstance: string, indexInfoRequestBodyDto: IndexInfoRequestBodyDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserRediSearchApiFp(this.configuration).redisearchControllerInfo(dbInstance, indexInfoRequestBodyDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get list of available indexes + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerListEncodingEnum} encoding + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserRediSearchApi + */ + public redisearchControllerList(dbInstance: string, encoding: RedisearchControllerListEncodingEnum, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserRediSearchApiFp(this.configuration).redisearchControllerList(dbInstance, encoding, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Search for keys in index + * @summary + * @param {string} dbInstance + * @param {RedisearchControllerSearchEncodingEnum} encoding + * @param {SearchRedisearchDto} searchRedisearchDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserRediSearchApi + */ + public redisearchControllerSearch(dbInstance: string, encoding: RedisearchControllerSearchEncodingEnum, searchRedisearchDto: SearchRedisearchDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserRediSearchApiFp(this.configuration).redisearchControllerSearch(dbInstance, encoding, searchRedisearchDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const RedisearchControllerListEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type RedisearchControllerListEncodingEnum = typeof RedisearchControllerListEncodingEnum[keyof typeof RedisearchControllerListEncodingEnum]; +/** + * @export + */ +export const RedisearchControllerSearchEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type RedisearchControllerSearchEncodingEnum = typeof RedisearchControllerSearchEncodingEnum[keyof typeof RedisearchControllerSearchEncodingEnum]; + + +/** + * BrowserSetApi - axios parameter creator + * @export + */ +export const BrowserSetApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add the specified members to the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToSetDto} addMembersToSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerAddMembers: async (dbInstance: string, encoding: SetControllerAddMembersEncodingEnum, addMembersToSetDto: AddMembersToSetDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('setControllerAddMembers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('setControllerAddMembers', 'encoding', encoding) + // verify required parameter 'addMembersToSetDto' is not null or undefined + assertParamExists('setControllerAddMembers', 'addMembersToSetDto', addMembersToSetDto) + const localVarPath = `/api/databases/{dbInstance}/set` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(addMembersToSetDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Set key to hold Set data type + * @summary + * @param {string} dbInstance + * @param {SetControllerCreateSetEncodingEnum} encoding + * @param {CreateSetWithExpireDto} createSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerCreateSet: async (dbInstance: string, encoding: SetControllerCreateSetEncodingEnum, createSetWithExpireDto: CreateSetWithExpireDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('setControllerCreateSet', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('setControllerCreateSet', 'encoding', encoding) + // verify required parameter 'createSetWithExpireDto' is not null or undefined + assertParamExists('setControllerCreateSet', 'createSetWithExpireDto', createSetWithExpireDto) + const localVarPath = `/api/databases/{dbInstance}/set` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createSetWithExpireDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromSetDto} deleteMembersFromSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerDeleteMembers: async (dbInstance: string, encoding: SetControllerDeleteMembersEncodingEnum, deleteMembersFromSetDto: DeleteMembersFromSetDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('setControllerDeleteMembers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('setControllerDeleteMembers', 'encoding', encoding) + // verify required parameter 'deleteMembersFromSetDto' is not null or undefined + assertParamExists('setControllerDeleteMembers', 'deleteMembersFromSetDto', deleteMembersFromSetDto) + const localVarPath = `/api/databases/{dbInstance}/set/members` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteMembersFromSetDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get specified members of the set stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {SetControllerGetMembersEncodingEnum} encoding + * @param {GetSetMembersDto} getSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerGetMembers: async (dbInstance: string, encoding: SetControllerGetMembersEncodingEnum, getSetMembersDto: GetSetMembersDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('setControllerGetMembers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('setControllerGetMembers', 'encoding', encoding) + // verify required parameter 'getSetMembersDto' is not null or undefined + assertParamExists('setControllerGetMembers', 'getSetMembersDto', getSetMembersDto) + const localVarPath = `/api/databases/{dbInstance}/set/get-members` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getSetMembersDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserSetApi - functional programming interface + * @export + */ +export const BrowserSetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserSetApiAxiosParamCreator(configuration) + return { + /** + * Add the specified members to the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToSetDto} addMembersToSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async setControllerAddMembers(dbInstance: string, encoding: SetControllerAddMembersEncodingEnum, addMembersToSetDto: AddMembersToSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setControllerAddMembers(dbInstance, encoding, addMembersToSetDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserSetApi.setControllerAddMembers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Set key to hold Set data type + * @summary + * @param {string} dbInstance + * @param {SetControllerCreateSetEncodingEnum} encoding + * @param {CreateSetWithExpireDto} createSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async setControllerCreateSet(dbInstance: string, encoding: SetControllerCreateSetEncodingEnum, createSetWithExpireDto: CreateSetWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setControllerCreateSet(dbInstance, encoding, createSetWithExpireDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserSetApi.setControllerCreateSet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromSetDto} deleteMembersFromSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async setControllerDeleteMembers(dbInstance: string, encoding: SetControllerDeleteMembersEncodingEnum, deleteMembersFromSetDto: DeleteMembersFromSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setControllerDeleteMembers(dbInstance, encoding, deleteMembersFromSetDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserSetApi.setControllerDeleteMembers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get specified members of the set stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {SetControllerGetMembersEncodingEnum} encoding + * @param {GetSetMembersDto} getSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async setControllerGetMembers(dbInstance: string, encoding: SetControllerGetMembersEncodingEnum, getSetMembersDto: GetSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.setControllerGetMembers(dbInstance, encoding, getSetMembersDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserSetApi.setControllerGetMembers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserSetApi - factory interface + * @export + */ +export const BrowserSetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserSetApiFp(configuration) + return { + /** + * Add the specified members to the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToSetDto} addMembersToSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerAddMembers(dbInstance: string, encoding: SetControllerAddMembersEncodingEnum, addMembersToSetDto: AddMembersToSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setControllerAddMembers(dbInstance, encoding, addMembersToSetDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Set key to hold Set data type + * @summary + * @param {string} dbInstance + * @param {SetControllerCreateSetEncodingEnum} encoding + * @param {CreateSetWithExpireDto} createSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerCreateSet(dbInstance: string, encoding: SetControllerCreateSetEncodingEnum, createSetWithExpireDto: CreateSetWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setControllerCreateSet(dbInstance, encoding, createSetWithExpireDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromSetDto} deleteMembersFromSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerDeleteMembers(dbInstance: string, encoding: SetControllerDeleteMembersEncodingEnum, deleteMembersFromSetDto: DeleteMembersFromSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setControllerDeleteMembers(dbInstance, encoding, deleteMembersFromSetDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get specified members of the set stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {SetControllerGetMembersEncodingEnum} encoding + * @param {GetSetMembersDto} getSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + setControllerGetMembers(dbInstance: string, encoding: SetControllerGetMembersEncodingEnum, getSetMembersDto: GetSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.setControllerGetMembers(dbInstance, encoding, getSetMembersDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserSetApi - object-oriented interface + * @export + * @class BrowserSetApi + * @extends {BaseAPI} + */ +export class BrowserSetApi extends BaseAPI { + /** + * Add the specified members to the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToSetDto} addMembersToSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserSetApi + */ + public setControllerAddMembers(dbInstance: string, encoding: SetControllerAddMembersEncodingEnum, addMembersToSetDto: AddMembersToSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserSetApiFp(this.configuration).setControllerAddMembers(dbInstance, encoding, addMembersToSetDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Set key to hold Set data type + * @summary + * @param {string} dbInstance + * @param {SetControllerCreateSetEncodingEnum} encoding + * @param {CreateSetWithExpireDto} createSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserSetApi + */ + public setControllerCreateSet(dbInstance: string, encoding: SetControllerCreateSetEncodingEnum, createSetWithExpireDto: CreateSetWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserSetApiFp(this.configuration).setControllerCreateSet(dbInstance, encoding, createSetWithExpireDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {SetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromSetDto} deleteMembersFromSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserSetApi + */ + public setControllerDeleteMembers(dbInstance: string, encoding: SetControllerDeleteMembersEncodingEnum, deleteMembersFromSetDto: DeleteMembersFromSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserSetApiFp(this.configuration).setControllerDeleteMembers(dbInstance, encoding, deleteMembersFromSetDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get specified members of the set stored at key by cursor position + * @summary + * @param {string} dbInstance + * @param {SetControllerGetMembersEncodingEnum} encoding + * @param {GetSetMembersDto} getSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserSetApi + */ + public setControllerGetMembers(dbInstance: string, encoding: SetControllerGetMembersEncodingEnum, getSetMembersDto: GetSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserSetApiFp(this.configuration).setControllerGetMembers(dbInstance, encoding, getSetMembersDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const SetControllerAddMembersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type SetControllerAddMembersEncodingEnum = typeof SetControllerAddMembersEncodingEnum[keyof typeof SetControllerAddMembersEncodingEnum]; +/** + * @export + */ +export const SetControllerCreateSetEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type SetControllerCreateSetEncodingEnum = typeof SetControllerCreateSetEncodingEnum[keyof typeof SetControllerCreateSetEncodingEnum]; +/** + * @export + */ +export const SetControllerDeleteMembersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type SetControllerDeleteMembersEncodingEnum = typeof SetControllerDeleteMembersEncodingEnum[keyof typeof SetControllerDeleteMembersEncodingEnum]; +/** + * @export + */ +export const SetControllerGetMembersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type SetControllerGetMembersEncodingEnum = typeof SetControllerGetMembersEncodingEnum[keyof typeof SetControllerGetMembersEncodingEnum]; + + +/** + * BrowserStreamsApi - axios parameter creator + * @export + */ +export const BrowserStreamsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Ack pending entries + * @summary + * @param {string} dbInstance + * @param {AckPendingEntriesDto} ackPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerAckPendingEntries: async (dbInstance: string, ackPendingEntriesDto: AckPendingEntriesDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerControllerAckPendingEntries', 'dbInstance', dbInstance) + // verify required parameter 'ackPendingEntriesDto' is not null or undefined + assertParamExists('consumerControllerAckPendingEntries', 'ackPendingEntriesDto', ackPendingEntriesDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups/consumers/pending-messages/ack` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(ackPendingEntriesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Claim pending entries + * @summary + * @param {string} dbInstance + * @param {ClaimPendingEntryDto} claimPendingEntryDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerClaimPendingEntries: async (dbInstance: string, claimPendingEntryDto: ClaimPendingEntryDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerControllerClaimPendingEntries', 'dbInstance', dbInstance) + // verify required parameter 'claimPendingEntryDto' is not null or undefined + assertParamExists('consumerControllerClaimPendingEntries', 'claimPendingEntryDto', claimPendingEntryDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups/consumers/pending-messages/claim` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(claimPendingEntryDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete Consumer(s) from the Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumersDto} deleteConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerDeleteConsumers: async (dbInstance: string, deleteConsumersDto: DeleteConsumersDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerControllerDeleteConsumers', 'dbInstance', dbInstance) + // verify required parameter 'deleteConsumersDto' is not null or undefined + assertParamExists('consumerControllerDeleteConsumers', 'deleteConsumersDto', deleteConsumersDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups/consumers` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteConsumersDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get consumers list in the group + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetConsumersEncodingEnum} encoding + * @param {GetConsumersDto} getConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerGetConsumers: async (dbInstance: string, encoding: ConsumerControllerGetConsumersEncodingEnum, getConsumersDto: GetConsumersDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerControllerGetConsumers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('consumerControllerGetConsumers', 'encoding', encoding) + // verify required parameter 'getConsumersDto' is not null or undefined + assertParamExists('consumerControllerGetConsumers', 'getConsumersDto', getConsumersDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups/consumers/get` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getConsumersDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get pending entries list + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetPendingEntriesEncodingEnum} encoding + * @param {GetPendingEntriesDto} getPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerGetPendingEntries: async (dbInstance: string, encoding: ConsumerControllerGetPendingEntriesEncodingEnum, getPendingEntriesDto: GetPendingEntriesDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerControllerGetPendingEntries', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('consumerControllerGetPendingEntries', 'encoding', encoding) + // verify required parameter 'getPendingEntriesDto' is not null or undefined + assertParamExists('consumerControllerGetPendingEntries', 'getPendingEntriesDto', getPendingEntriesDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups/consumers/pending-messages/get` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getPendingEntriesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Create stream consumer group + * @summary + * @param {string} dbInstance + * @param {CreateConsumerGroupsDto} createConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerCreateGroups: async (dbInstance: string, createConsumerGroupsDto: CreateConsumerGroupsDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerGroupControllerCreateGroups', 'dbInstance', dbInstance) + // verify required parameter 'createConsumerGroupsDto' is not null or undefined + assertParamExists('consumerGroupControllerCreateGroups', 'createConsumerGroupsDto', createConsumerGroupsDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createConsumerGroupsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumerGroupsDto} deleteConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerDeleteGroup: async (dbInstance: string, deleteConsumerGroupsDto: DeleteConsumerGroupsDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerGroupControllerDeleteGroup', 'dbInstance', dbInstance) + // verify required parameter 'deleteConsumerGroupsDto' is not null or undefined + assertParamExists('consumerGroupControllerDeleteGroup', 'deleteConsumerGroupsDto', deleteConsumerGroupsDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteConsumerGroupsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get consumer groups list + * @summary + * @param {string} dbInstance + * @param {ConsumerGroupControllerGetGroupsEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerGetGroups: async (dbInstance: string, encoding: ConsumerGroupControllerGetGroupsEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerGroupControllerGetGroups', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('consumerGroupControllerGetGroups', 'encoding', encoding) + // verify required parameter 'keyDto' is not null or undefined + assertParamExists('consumerGroupControllerGetGroups', 'keyDto', keyDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups/get` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(keyDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Modify last delivered ID of the Consumer Group + * @summary + * @param {string} dbInstance + * @param {UpdateConsumerGroupDto} updateConsumerGroupDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerUpdateGroup: async (dbInstance: string, updateConsumerGroupDto: UpdateConsumerGroupDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('consumerGroupControllerUpdateGroup', 'dbInstance', dbInstance) + // verify required parameter 'updateConsumerGroupDto' is not null or undefined + assertParamExists('consumerGroupControllerUpdateGroup', 'updateConsumerGroupDto', updateConsumerGroupDto) + const localVarPath = `/api/databases/{dbInstance}/streams/consumer-groups` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateConsumerGroupDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Add entries to the stream + * @summary + * @param {string} dbInstance + * @param {StreamControllerAddEntriesEncodingEnum} encoding + * @param {AddStreamEntriesDto} addStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerAddEntries: async (dbInstance: string, encoding: StreamControllerAddEntriesEncodingEnum, addStreamEntriesDto: AddStreamEntriesDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('streamControllerAddEntries', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('streamControllerAddEntries', 'encoding', encoding) + // verify required parameter 'addStreamEntriesDto' is not null or undefined + assertParamExists('streamControllerAddEntries', 'addStreamEntriesDto', addStreamEntriesDto) + const localVarPath = `/api/databases/{dbInstance}/streams/entries` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(addStreamEntriesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Create stream + * @summary + * @param {string} dbInstance + * @param {CreateStreamDto} createStreamDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerCreateStream: async (dbInstance: string, createStreamDto: CreateStreamDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('streamControllerCreateStream', 'dbInstance', dbInstance) + // verify required parameter 'createStreamDto' is not null or undefined + assertParamExists('streamControllerCreateStream', 'createStreamDto', createStreamDto) + const localVarPath = `/api/databases/{dbInstance}/streams` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createStreamDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Remove the specified entries from the Stream stored at key + * @summary + * @param {string} dbInstance + * @param {DeleteStreamEntriesDto} deleteStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerDeleteEntries: async (dbInstance: string, deleteStreamEntriesDto: DeleteStreamEntriesDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('streamControllerDeleteEntries', 'dbInstance', dbInstance) + // verify required parameter 'deleteStreamEntriesDto' is not null or undefined + assertParamExists('streamControllerDeleteEntries', 'deleteStreamEntriesDto', deleteStreamEntriesDto) + const localVarPath = `/api/databases/{dbInstance}/streams/entries` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteStreamEntriesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get stream entries + * @summary + * @param {string} dbInstance + * @param {StreamControllerGetEntriesEncodingEnum} encoding + * @param {GetStreamEntriesDto} getStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerGetEntries: async (dbInstance: string, encoding: StreamControllerGetEntriesEncodingEnum, getStreamEntriesDto: GetStreamEntriesDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('streamControllerGetEntries', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('streamControllerGetEntries', 'encoding', encoding) + // verify required parameter 'getStreamEntriesDto' is not null or undefined + assertParamExists('streamControllerGetEntries', 'getStreamEntriesDto', getStreamEntriesDto) + const localVarPath = `/api/databases/{dbInstance}/streams/entries/get` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getStreamEntriesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserStreamsApi - functional programming interface + * @export + */ +export const BrowserStreamsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserStreamsApiAxiosParamCreator(configuration) + return { + /** + * Ack pending entries + * @summary + * @param {string} dbInstance + * @param {AckPendingEntriesDto} ackPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerControllerAckPendingEntries(dbInstance: string, ackPendingEntriesDto: AckPendingEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerControllerAckPendingEntries(dbInstance, ackPendingEntriesDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerControllerAckPendingEntries']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Claim pending entries + * @summary + * @param {string} dbInstance + * @param {ClaimPendingEntryDto} claimPendingEntryDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerControllerClaimPendingEntries(dbInstance: string, claimPendingEntryDto: ClaimPendingEntryDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerControllerClaimPendingEntries(dbInstance, claimPendingEntryDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerControllerClaimPendingEntries']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete Consumer(s) from the Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumersDto} deleteConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerControllerDeleteConsumers(dbInstance: string, deleteConsumersDto: DeleteConsumersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerControllerDeleteConsumers(dbInstance, deleteConsumersDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerControllerDeleteConsumers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get consumers list in the group + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetConsumersEncodingEnum} encoding + * @param {GetConsumersDto} getConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerControllerGetConsumers(dbInstance: string, encoding: ConsumerControllerGetConsumersEncodingEnum, getConsumersDto: GetConsumersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerControllerGetConsumers(dbInstance, encoding, getConsumersDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerControllerGetConsumers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get pending entries list + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetPendingEntriesEncodingEnum} encoding + * @param {GetPendingEntriesDto} getPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerControllerGetPendingEntries(dbInstance: string, encoding: ConsumerControllerGetPendingEntriesEncodingEnum, getPendingEntriesDto: GetPendingEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerControllerGetPendingEntries(dbInstance, encoding, getPendingEntriesDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerControllerGetPendingEntries']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create stream consumer group + * @summary + * @param {string} dbInstance + * @param {CreateConsumerGroupsDto} createConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerGroupControllerCreateGroups(dbInstance: string, createConsumerGroupsDto: CreateConsumerGroupsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerGroupControllerCreateGroups(dbInstance, createConsumerGroupsDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerGroupControllerCreateGroups']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumerGroupsDto} deleteConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerGroupControllerDeleteGroup(dbInstance: string, deleteConsumerGroupsDto: DeleteConsumerGroupsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerGroupControllerDeleteGroup(dbInstance, deleteConsumerGroupsDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerGroupControllerDeleteGroup']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get consumer groups list + * @summary + * @param {string} dbInstance + * @param {ConsumerGroupControllerGetGroupsEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerGroupControllerGetGroups(dbInstance: string, encoding: ConsumerGroupControllerGetGroupsEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerGroupControllerGetGroups(dbInstance, encoding, keyDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerGroupControllerGetGroups']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Modify last delivered ID of the Consumer Group + * @summary + * @param {string} dbInstance + * @param {UpdateConsumerGroupDto} updateConsumerGroupDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async consumerGroupControllerUpdateGroup(dbInstance: string, updateConsumerGroupDto: UpdateConsumerGroupDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.consumerGroupControllerUpdateGroup(dbInstance, updateConsumerGroupDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.consumerGroupControllerUpdateGroup']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Add entries to the stream + * @summary + * @param {string} dbInstance + * @param {StreamControllerAddEntriesEncodingEnum} encoding + * @param {AddStreamEntriesDto} addStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async streamControllerAddEntries(dbInstance: string, encoding: StreamControllerAddEntriesEncodingEnum, addStreamEntriesDto: AddStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.streamControllerAddEntries(dbInstance, encoding, addStreamEntriesDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.streamControllerAddEntries']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create stream + * @summary + * @param {string} dbInstance + * @param {CreateStreamDto} createStreamDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async streamControllerCreateStream(dbInstance: string, createStreamDto: CreateStreamDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.streamControllerCreateStream(dbInstance, createStreamDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.streamControllerCreateStream']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove the specified entries from the Stream stored at key + * @summary + * @param {string} dbInstance + * @param {DeleteStreamEntriesDto} deleteStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async streamControllerDeleteEntries(dbInstance: string, deleteStreamEntriesDto: DeleteStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.streamControllerDeleteEntries(dbInstance, deleteStreamEntriesDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.streamControllerDeleteEntries']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get stream entries + * @summary + * @param {string} dbInstance + * @param {StreamControllerGetEntriesEncodingEnum} encoding + * @param {GetStreamEntriesDto} getStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async streamControllerGetEntries(dbInstance: string, encoding: StreamControllerGetEntriesEncodingEnum, getStreamEntriesDto: GetStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.streamControllerGetEntries(dbInstance, encoding, getStreamEntriesDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStreamsApi.streamControllerGetEntries']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserStreamsApi - factory interface + * @export + */ +export const BrowserStreamsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserStreamsApiFp(configuration) + return { + /** + * Ack pending entries + * @summary + * @param {string} dbInstance + * @param {AckPendingEntriesDto} ackPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerAckPendingEntries(dbInstance: string, ackPendingEntriesDto: AckPendingEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.consumerControllerAckPendingEntries(dbInstance, ackPendingEntriesDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Claim pending entries + * @summary + * @param {string} dbInstance + * @param {ClaimPendingEntryDto} claimPendingEntryDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerClaimPendingEntries(dbInstance: string, claimPendingEntryDto: ClaimPendingEntryDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.consumerControllerClaimPendingEntries(dbInstance, claimPendingEntryDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Delete Consumer(s) from the Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumersDto} deleteConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerDeleteConsumers(dbInstance: string, deleteConsumersDto: DeleteConsumersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.consumerControllerDeleteConsumers(dbInstance, deleteConsumersDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get consumers list in the group + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetConsumersEncodingEnum} encoding + * @param {GetConsumersDto} getConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerGetConsumers(dbInstance: string, encoding: ConsumerControllerGetConsumersEncodingEnum, getConsumersDto: GetConsumersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.consumerControllerGetConsumers(dbInstance, encoding, getConsumersDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get pending entries list + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetPendingEntriesEncodingEnum} encoding + * @param {GetPendingEntriesDto} getPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerControllerGetPendingEntries(dbInstance: string, encoding: ConsumerControllerGetPendingEntriesEncodingEnum, getPendingEntriesDto: GetPendingEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.consumerControllerGetPendingEntries(dbInstance, encoding, getPendingEntriesDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Create stream consumer group + * @summary + * @param {string} dbInstance + * @param {CreateConsumerGroupsDto} createConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerCreateGroups(dbInstance: string, createConsumerGroupsDto: CreateConsumerGroupsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.consumerGroupControllerCreateGroups(dbInstance, createConsumerGroupsDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Delete Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumerGroupsDto} deleteConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerDeleteGroup(dbInstance: string, deleteConsumerGroupsDto: DeleteConsumerGroupsDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.consumerGroupControllerDeleteGroup(dbInstance, deleteConsumerGroupsDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get consumer groups list + * @summary + * @param {string} dbInstance + * @param {ConsumerGroupControllerGetGroupsEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerGetGroups(dbInstance: string, encoding: ConsumerGroupControllerGetGroupsEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.consumerGroupControllerGetGroups(dbInstance, encoding, keyDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Modify last delivered ID of the Consumer Group + * @summary + * @param {string} dbInstance + * @param {UpdateConsumerGroupDto} updateConsumerGroupDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + consumerGroupControllerUpdateGroup(dbInstance: string, updateConsumerGroupDto: UpdateConsumerGroupDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.consumerGroupControllerUpdateGroup(dbInstance, updateConsumerGroupDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Add entries to the stream + * @summary + * @param {string} dbInstance + * @param {StreamControllerAddEntriesEncodingEnum} encoding + * @param {AddStreamEntriesDto} addStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerAddEntries(dbInstance: string, encoding: StreamControllerAddEntriesEncodingEnum, addStreamEntriesDto: AddStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.streamControllerAddEntries(dbInstance, encoding, addStreamEntriesDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Create stream + * @summary + * @param {string} dbInstance + * @param {CreateStreamDto} createStreamDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerCreateStream(dbInstance: string, createStreamDto: CreateStreamDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.streamControllerCreateStream(dbInstance, createStreamDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Remove the specified entries from the Stream stored at key + * @summary + * @param {string} dbInstance + * @param {DeleteStreamEntriesDto} deleteStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerDeleteEntries(dbInstance: string, deleteStreamEntriesDto: DeleteStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.streamControllerDeleteEntries(dbInstance, deleteStreamEntriesDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get stream entries + * @summary + * @param {string} dbInstance + * @param {StreamControllerGetEntriesEncodingEnum} encoding + * @param {GetStreamEntriesDto} getStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + streamControllerGetEntries(dbInstance: string, encoding: StreamControllerGetEntriesEncodingEnum, getStreamEntriesDto: GetStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.streamControllerGetEntries(dbInstance, encoding, getStreamEntriesDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserStreamsApi - object-oriented interface + * @export + * @class BrowserStreamsApi + * @extends {BaseAPI} + */ +export class BrowserStreamsApi extends BaseAPI { + /** + * Ack pending entries + * @summary + * @param {string} dbInstance + * @param {AckPendingEntriesDto} ackPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerControllerAckPendingEntries(dbInstance: string, ackPendingEntriesDto: AckPendingEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerControllerAckPendingEntries(dbInstance, ackPendingEntriesDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Claim pending entries + * @summary + * @param {string} dbInstance + * @param {ClaimPendingEntryDto} claimPendingEntryDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerControllerClaimPendingEntries(dbInstance: string, claimPendingEntryDto: ClaimPendingEntryDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerControllerClaimPendingEntries(dbInstance, claimPendingEntryDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete Consumer(s) from the Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumersDto} deleteConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerControllerDeleteConsumers(dbInstance: string, deleteConsumersDto: DeleteConsumersDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerControllerDeleteConsumers(dbInstance, deleteConsumersDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get consumers list in the group + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetConsumersEncodingEnum} encoding + * @param {GetConsumersDto} getConsumersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerControllerGetConsumers(dbInstance: string, encoding: ConsumerControllerGetConsumersEncodingEnum, getConsumersDto: GetConsumersDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerControllerGetConsumers(dbInstance, encoding, getConsumersDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get pending entries list + * @summary + * @param {string} dbInstance + * @param {ConsumerControllerGetPendingEntriesEncodingEnum} encoding + * @param {GetPendingEntriesDto} getPendingEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerControllerGetPendingEntries(dbInstance: string, encoding: ConsumerControllerGetPendingEntriesEncodingEnum, getPendingEntriesDto: GetPendingEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerControllerGetPendingEntries(dbInstance, encoding, getPendingEntriesDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create stream consumer group + * @summary + * @param {string} dbInstance + * @param {CreateConsumerGroupsDto} createConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerGroupControllerCreateGroups(dbInstance: string, createConsumerGroupsDto: CreateConsumerGroupsDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerGroupControllerCreateGroups(dbInstance, createConsumerGroupsDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete Consumer Group + * @summary + * @param {string} dbInstance + * @param {DeleteConsumerGroupsDto} deleteConsumerGroupsDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerGroupControllerDeleteGroup(dbInstance: string, deleteConsumerGroupsDto: DeleteConsumerGroupsDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerGroupControllerDeleteGroup(dbInstance, deleteConsumerGroupsDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get consumer groups list + * @summary + * @param {string} dbInstance + * @param {ConsumerGroupControllerGetGroupsEncodingEnum} encoding + * @param {KeyDto} keyDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerGroupControllerGetGroups(dbInstance: string, encoding: ConsumerGroupControllerGetGroupsEncodingEnum, keyDto: KeyDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerGroupControllerGetGroups(dbInstance, encoding, keyDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Modify last delivered ID of the Consumer Group + * @summary + * @param {string} dbInstance + * @param {UpdateConsumerGroupDto} updateConsumerGroupDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public consumerGroupControllerUpdateGroup(dbInstance: string, updateConsumerGroupDto: UpdateConsumerGroupDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).consumerGroupControllerUpdateGroup(dbInstance, updateConsumerGroupDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Add entries to the stream + * @summary + * @param {string} dbInstance + * @param {StreamControllerAddEntriesEncodingEnum} encoding + * @param {AddStreamEntriesDto} addStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public streamControllerAddEntries(dbInstance: string, encoding: StreamControllerAddEntriesEncodingEnum, addStreamEntriesDto: AddStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).streamControllerAddEntries(dbInstance, encoding, addStreamEntriesDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create stream + * @summary + * @param {string} dbInstance + * @param {CreateStreamDto} createStreamDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public streamControllerCreateStream(dbInstance: string, createStreamDto: CreateStreamDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).streamControllerCreateStream(dbInstance, createStreamDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove the specified entries from the Stream stored at key + * @summary + * @param {string} dbInstance + * @param {DeleteStreamEntriesDto} deleteStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public streamControllerDeleteEntries(dbInstance: string, deleteStreamEntriesDto: DeleteStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).streamControllerDeleteEntries(dbInstance, deleteStreamEntriesDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get stream entries + * @summary + * @param {string} dbInstance + * @param {StreamControllerGetEntriesEncodingEnum} encoding + * @param {GetStreamEntriesDto} getStreamEntriesDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStreamsApi + */ + public streamControllerGetEntries(dbInstance: string, encoding: StreamControllerGetEntriesEncodingEnum, getStreamEntriesDto: GetStreamEntriesDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStreamsApiFp(this.configuration).streamControllerGetEntries(dbInstance, encoding, getStreamEntriesDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ConsumerControllerGetConsumersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ConsumerControllerGetConsumersEncodingEnum = typeof ConsumerControllerGetConsumersEncodingEnum[keyof typeof ConsumerControllerGetConsumersEncodingEnum]; +/** + * @export + */ +export const ConsumerControllerGetPendingEntriesEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ConsumerControllerGetPendingEntriesEncodingEnum = typeof ConsumerControllerGetPendingEntriesEncodingEnum[keyof typeof ConsumerControllerGetPendingEntriesEncodingEnum]; +/** + * @export + */ +export const ConsumerGroupControllerGetGroupsEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ConsumerGroupControllerGetGroupsEncodingEnum = typeof ConsumerGroupControllerGetGroupsEncodingEnum[keyof typeof ConsumerGroupControllerGetGroupsEncodingEnum]; +/** + * @export + */ +export const StreamControllerAddEntriesEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type StreamControllerAddEntriesEncodingEnum = typeof StreamControllerAddEntriesEncodingEnum[keyof typeof StreamControllerAddEntriesEncodingEnum]; +/** + * @export + */ +export const StreamControllerGetEntriesEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type StreamControllerGetEntriesEncodingEnum = typeof StreamControllerGetEntriesEncodingEnum[keyof typeof StreamControllerGetEntriesEncodingEnum]; + + +/** + * BrowserStringApi - axios parameter creator + * @export + */ +export const BrowserStringApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Endpoint do download string value + * @summary + * @param {string} dbInstance + * @param {StringControllerDownloadStringFileEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerDownloadStringFile: async (dbInstance: string, encoding: StringControllerDownloadStringFileEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('stringControllerDownloadStringFile', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('stringControllerDownloadStringFile', 'encoding', encoding) + // verify required parameter 'getKeyInfoDto' is not null or undefined + assertParamExists('stringControllerDownloadStringFile', 'getKeyInfoDto', getKeyInfoDto) + const localVarPath = `/api/databases/{dbInstance}/string/download-value` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getKeyInfoDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get string value + * @summary + * @param {string} dbInstance + * @param {StringControllerGetStringValueEncodingEnum} encoding + * @param {GetStringInfoDto} getStringInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerGetStringValue: async (dbInstance: string, encoding: StringControllerGetStringValueEncodingEnum, getStringInfoDto: GetStringInfoDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('stringControllerGetStringValue', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('stringControllerGetStringValue', 'encoding', encoding) + // verify required parameter 'getStringInfoDto' is not null or undefined + assertParamExists('stringControllerGetStringValue', 'getStringInfoDto', getStringInfoDto) + const localVarPath = `/api/databases/{dbInstance}/string/get-value` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getStringInfoDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Set key to hold string value + * @summary + * @param {string} dbInstance + * @param {StringControllerSetStringEncodingEnum} encoding + * @param {SetStringWithExpireDto} setStringWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerSetString: async (dbInstance: string, encoding: StringControllerSetStringEncodingEnum, setStringWithExpireDto: SetStringWithExpireDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('stringControllerSetString', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('stringControllerSetString', 'encoding', encoding) + // verify required parameter 'setStringWithExpireDto' is not null or undefined + assertParamExists('stringControllerSetString', 'setStringWithExpireDto', setStringWithExpireDto) + const localVarPath = `/api/databases/{dbInstance}/string` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(setStringWithExpireDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update string value + * @summary + * @param {string} dbInstance + * @param {StringControllerUpdateStringValueEncodingEnum} encoding + * @param {SetStringDto} setStringDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerUpdateStringValue: async (dbInstance: string, encoding: StringControllerUpdateStringValueEncodingEnum, setStringDto: SetStringDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('stringControllerUpdateStringValue', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('stringControllerUpdateStringValue', 'encoding', encoding) + // verify required parameter 'setStringDto' is not null or undefined + assertParamExists('stringControllerUpdateStringValue', 'setStringDto', setStringDto) + const localVarPath = `/api/databases/{dbInstance}/string` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(setStringDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserStringApi - functional programming interface + * @export + */ +export const BrowserStringApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserStringApiAxiosParamCreator(configuration) + return { + /** + * Endpoint do download string value + * @summary + * @param {string} dbInstance + * @param {StringControllerDownloadStringFileEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async stringControllerDownloadStringFile(dbInstance: string, encoding: StringControllerDownloadStringFileEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.stringControllerDownloadStringFile(dbInstance, encoding, getKeyInfoDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStringApi.stringControllerDownloadStringFile']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get string value + * @summary + * @param {string} dbInstance + * @param {StringControllerGetStringValueEncodingEnum} encoding + * @param {GetStringInfoDto} getStringInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async stringControllerGetStringValue(dbInstance: string, encoding: StringControllerGetStringValueEncodingEnum, getStringInfoDto: GetStringInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.stringControllerGetStringValue(dbInstance, encoding, getStringInfoDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStringApi.stringControllerGetStringValue']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Set key to hold string value + * @summary + * @param {string} dbInstance + * @param {StringControllerSetStringEncodingEnum} encoding + * @param {SetStringWithExpireDto} setStringWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async stringControllerSetString(dbInstance: string, encoding: StringControllerSetStringEncodingEnum, setStringWithExpireDto: SetStringWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.stringControllerSetString(dbInstance, encoding, setStringWithExpireDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStringApi.stringControllerSetString']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update string value + * @summary + * @param {string} dbInstance + * @param {StringControllerUpdateStringValueEncodingEnum} encoding + * @param {SetStringDto} setStringDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async stringControllerUpdateStringValue(dbInstance: string, encoding: StringControllerUpdateStringValueEncodingEnum, setStringDto: SetStringDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.stringControllerUpdateStringValue(dbInstance, encoding, setStringDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserStringApi.stringControllerUpdateStringValue']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserStringApi - factory interface + * @export + */ +export const BrowserStringApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserStringApiFp(configuration) + return { + /** + * Endpoint do download string value + * @summary + * @param {string} dbInstance + * @param {StringControllerDownloadStringFileEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerDownloadStringFile(dbInstance: string, encoding: StringControllerDownloadStringFileEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.stringControllerDownloadStringFile(dbInstance, encoding, getKeyInfoDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get string value + * @summary + * @param {string} dbInstance + * @param {StringControllerGetStringValueEncodingEnum} encoding + * @param {GetStringInfoDto} getStringInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerGetStringValue(dbInstance: string, encoding: StringControllerGetStringValueEncodingEnum, getStringInfoDto: GetStringInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.stringControllerGetStringValue(dbInstance, encoding, getStringInfoDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Set key to hold string value + * @summary + * @param {string} dbInstance + * @param {StringControllerSetStringEncodingEnum} encoding + * @param {SetStringWithExpireDto} setStringWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerSetString(dbInstance: string, encoding: StringControllerSetStringEncodingEnum, setStringWithExpireDto: SetStringWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.stringControllerSetString(dbInstance, encoding, setStringWithExpireDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Update string value + * @summary + * @param {string} dbInstance + * @param {StringControllerUpdateStringValueEncodingEnum} encoding + * @param {SetStringDto} setStringDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stringControllerUpdateStringValue(dbInstance: string, encoding: StringControllerUpdateStringValueEncodingEnum, setStringDto: SetStringDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.stringControllerUpdateStringValue(dbInstance, encoding, setStringDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserStringApi - object-oriented interface + * @export + * @class BrowserStringApi + * @extends {BaseAPI} + */ +export class BrowserStringApi extends BaseAPI { + /** + * Endpoint do download string value + * @summary + * @param {string} dbInstance + * @param {StringControllerDownloadStringFileEncodingEnum} encoding + * @param {GetKeyInfoDto} getKeyInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStringApi + */ + public stringControllerDownloadStringFile(dbInstance: string, encoding: StringControllerDownloadStringFileEncodingEnum, getKeyInfoDto: GetKeyInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStringApiFp(this.configuration).stringControllerDownloadStringFile(dbInstance, encoding, getKeyInfoDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get string value + * @summary + * @param {string} dbInstance + * @param {StringControllerGetStringValueEncodingEnum} encoding + * @param {GetStringInfoDto} getStringInfoDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStringApi + */ + public stringControllerGetStringValue(dbInstance: string, encoding: StringControllerGetStringValueEncodingEnum, getStringInfoDto: GetStringInfoDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStringApiFp(this.configuration).stringControllerGetStringValue(dbInstance, encoding, getStringInfoDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Set key to hold string value + * @summary + * @param {string} dbInstance + * @param {StringControllerSetStringEncodingEnum} encoding + * @param {SetStringWithExpireDto} setStringWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStringApi + */ + public stringControllerSetString(dbInstance: string, encoding: StringControllerSetStringEncodingEnum, setStringWithExpireDto: SetStringWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStringApiFp(this.configuration).stringControllerSetString(dbInstance, encoding, setStringWithExpireDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update string value + * @summary + * @param {string} dbInstance + * @param {StringControllerUpdateStringValueEncodingEnum} encoding + * @param {SetStringDto} setStringDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserStringApi + */ + public stringControllerUpdateStringValue(dbInstance: string, encoding: StringControllerUpdateStringValueEncodingEnum, setStringDto: SetStringDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserStringApiFp(this.configuration).stringControllerUpdateStringValue(dbInstance, encoding, setStringDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const StringControllerDownloadStringFileEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type StringControllerDownloadStringFileEncodingEnum = typeof StringControllerDownloadStringFileEncodingEnum[keyof typeof StringControllerDownloadStringFileEncodingEnum]; +/** + * @export + */ +export const StringControllerGetStringValueEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type StringControllerGetStringValueEncodingEnum = typeof StringControllerGetStringValueEncodingEnum[keyof typeof StringControllerGetStringValueEncodingEnum]; +/** + * @export + */ +export const StringControllerSetStringEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type StringControllerSetStringEncodingEnum = typeof StringControllerSetStringEncodingEnum[keyof typeof StringControllerSetStringEncodingEnum]; +/** + * @export + */ +export const StringControllerUpdateStringValueEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type StringControllerUpdateStringValueEncodingEnum = typeof StringControllerUpdateStringValueEncodingEnum[keyof typeof StringControllerUpdateStringValueEncodingEnum]; + + +/** + * BrowserZSetApi - axios parameter creator + * @export + */ +export const BrowserZSetApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add the specified members to the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToZSetDto} addMembersToZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerAddMembers: async (dbInstance: string, encoding: ZSetControllerAddMembersEncodingEnum, addMembersToZSetDto: AddMembersToZSetDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('zSetControllerAddMembers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('zSetControllerAddMembers', 'encoding', encoding) + // verify required parameter 'addMembersToZSetDto' is not null or undefined + assertParamExists('zSetControllerAddMembers', 'addMembersToZSetDto', addMembersToZSetDto) + const localVarPath = `/api/databases/{dbInstance}/zSet` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(addMembersToZSetDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Set key to hold ZSet data type + * @summary + * @param {string} dbInstance + * @param {ZSetControllerCreateSetEncodingEnum} encoding + * @param {CreateZSetWithExpireDto} createZSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerCreateSet: async (dbInstance: string, encoding: ZSetControllerCreateSetEncodingEnum, createZSetWithExpireDto: CreateZSetWithExpireDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('zSetControllerCreateSet', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('zSetControllerCreateSet', 'encoding', encoding) + // verify required parameter 'createZSetWithExpireDto' is not null or undefined + assertParamExists('zSetControllerCreateSet', 'createZSetWithExpireDto', createZSetWithExpireDto) + const localVarPath = `/api/databases/{dbInstance}/zSet` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createZSetWithExpireDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromZSetDto} deleteMembersFromZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerDeleteMembers: async (dbInstance: string, encoding: ZSetControllerDeleteMembersEncodingEnum, deleteMembersFromZSetDto: DeleteMembersFromZSetDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('zSetControllerDeleteMembers', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('zSetControllerDeleteMembers', 'encoding', encoding) + // verify required parameter 'deleteMembersFromZSetDto' is not null or undefined + assertParamExists('zSetControllerDeleteMembers', 'deleteMembersFromZSetDto', deleteMembersFromZSetDto) + const localVarPath = `/api/databases/{dbInstance}/zSet/members` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteMembersFromZSetDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get specified members of the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerGetZSetEncodingEnum} encoding + * @param {GetZSetMembersDto} getZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerGetZSet: async (dbInstance: string, encoding: ZSetControllerGetZSetEncodingEnum, getZSetMembersDto: GetZSetMembersDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('zSetControllerGetZSet', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('zSetControllerGetZSet', 'encoding', encoding) + // verify required parameter 'getZSetMembersDto' is not null or undefined + assertParamExists('zSetControllerGetZSet', 'getZSetMembersDto', getZSetMembersDto) + const localVarPath = `/api/databases/{dbInstance}/zSet/get-members` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(getZSetMembersDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Search members in ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerSearchZSetEncodingEnum} encoding + * @param {SearchZSetMembersDto} searchZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerSearchZSet: async (dbInstance: string, encoding: ZSetControllerSearchZSetEncodingEnum, searchZSetMembersDto: SearchZSetMembersDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('zSetControllerSearchZSet', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('zSetControllerSearchZSet', 'encoding', encoding) + // verify required parameter 'searchZSetMembersDto' is not null or undefined + assertParamExists('zSetControllerSearchZSet', 'searchZSetMembersDto', searchZSetMembersDto) + const localVarPath = `/api/databases/{dbInstance}/zSet/search` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(searchZSetMembersDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update the specified member in the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerUpdateMemberEncodingEnum} encoding + * @param {UpdateMemberInZSetDto} updateMemberInZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerUpdateMember: async (dbInstance: string, encoding: ZSetControllerUpdateMemberEncodingEnum, updateMemberInZSetDto: UpdateMemberInZSetDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('zSetControllerUpdateMember', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('zSetControllerUpdateMember', 'encoding', encoding) + // verify required parameter 'updateMemberInZSetDto' is not null or undefined + assertParamExists('zSetControllerUpdateMember', 'updateMemberInZSetDto', updateMemberInZSetDto) + const localVarPath = `/api/databases/{dbInstance}/zSet` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateMemberInZSetDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BrowserZSetApi - functional programming interface + * @export + */ +export const BrowserZSetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BrowserZSetApiAxiosParamCreator(configuration) + return { + /** + * Add the specified members to the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToZSetDto} addMembersToZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async zSetControllerAddMembers(dbInstance: string, encoding: ZSetControllerAddMembersEncodingEnum, addMembersToZSetDto: AddMembersToZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.zSetControllerAddMembers(dbInstance, encoding, addMembersToZSetDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserZSetApi.zSetControllerAddMembers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Set key to hold ZSet data type + * @summary + * @param {string} dbInstance + * @param {ZSetControllerCreateSetEncodingEnum} encoding + * @param {CreateZSetWithExpireDto} createZSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async zSetControllerCreateSet(dbInstance: string, encoding: ZSetControllerCreateSetEncodingEnum, createZSetWithExpireDto: CreateZSetWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.zSetControllerCreateSet(dbInstance, encoding, createZSetWithExpireDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserZSetApi.zSetControllerCreateSet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromZSetDto} deleteMembersFromZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async zSetControllerDeleteMembers(dbInstance: string, encoding: ZSetControllerDeleteMembersEncodingEnum, deleteMembersFromZSetDto: DeleteMembersFromZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.zSetControllerDeleteMembers(dbInstance, encoding, deleteMembersFromZSetDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserZSetApi.zSetControllerDeleteMembers']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get specified members of the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerGetZSetEncodingEnum} encoding + * @param {GetZSetMembersDto} getZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async zSetControllerGetZSet(dbInstance: string, encoding: ZSetControllerGetZSetEncodingEnum, getZSetMembersDto: GetZSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.zSetControllerGetZSet(dbInstance, encoding, getZSetMembersDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserZSetApi.zSetControllerGetZSet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Search members in ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerSearchZSetEncodingEnum} encoding + * @param {SearchZSetMembersDto} searchZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async zSetControllerSearchZSet(dbInstance: string, encoding: ZSetControllerSearchZSetEncodingEnum, searchZSetMembersDto: SearchZSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.zSetControllerSearchZSet(dbInstance, encoding, searchZSetMembersDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserZSetApi.zSetControllerSearchZSet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update the specified member in the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerUpdateMemberEncodingEnum} encoding + * @param {UpdateMemberInZSetDto} updateMemberInZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async zSetControllerUpdateMember(dbInstance: string, encoding: ZSetControllerUpdateMemberEncodingEnum, updateMemberInZSetDto: UpdateMemberInZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.zSetControllerUpdateMember(dbInstance, encoding, updateMemberInZSetDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BrowserZSetApi.zSetControllerUpdateMember']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BrowserZSetApi - factory interface + * @export + */ +export const BrowserZSetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BrowserZSetApiFp(configuration) + return { + /** + * Add the specified members to the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToZSetDto} addMembersToZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerAddMembers(dbInstance: string, encoding: ZSetControllerAddMembersEncodingEnum, addMembersToZSetDto: AddMembersToZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.zSetControllerAddMembers(dbInstance, encoding, addMembersToZSetDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Set key to hold ZSet data type + * @summary + * @param {string} dbInstance + * @param {ZSetControllerCreateSetEncodingEnum} encoding + * @param {CreateZSetWithExpireDto} createZSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerCreateSet(dbInstance: string, encoding: ZSetControllerCreateSetEncodingEnum, createZSetWithExpireDto: CreateZSetWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.zSetControllerCreateSet(dbInstance, encoding, createZSetWithExpireDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromZSetDto} deleteMembersFromZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerDeleteMembers(dbInstance: string, encoding: ZSetControllerDeleteMembersEncodingEnum, deleteMembersFromZSetDto: DeleteMembersFromZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.zSetControllerDeleteMembers(dbInstance, encoding, deleteMembersFromZSetDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get specified members of the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerGetZSetEncodingEnum} encoding + * @param {GetZSetMembersDto} getZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerGetZSet(dbInstance: string, encoding: ZSetControllerGetZSetEncodingEnum, getZSetMembersDto: GetZSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.zSetControllerGetZSet(dbInstance, encoding, getZSetMembersDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Search members in ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerSearchZSetEncodingEnum} encoding + * @param {SearchZSetMembersDto} searchZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerSearchZSet(dbInstance: string, encoding: ZSetControllerSearchZSetEncodingEnum, searchZSetMembersDto: SearchZSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.zSetControllerSearchZSet(dbInstance, encoding, searchZSetMembersDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Update the specified member in the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerUpdateMemberEncodingEnum} encoding + * @param {UpdateMemberInZSetDto} updateMemberInZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + zSetControllerUpdateMember(dbInstance: string, encoding: ZSetControllerUpdateMemberEncodingEnum, updateMemberInZSetDto: UpdateMemberInZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.zSetControllerUpdateMember(dbInstance, encoding, updateMemberInZSetDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BrowserZSetApi - object-oriented interface + * @export + * @class BrowserZSetApi + * @extends {BaseAPI} + */ +export class BrowserZSetApi extends BaseAPI { + /** + * Add the specified members to the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerAddMembersEncodingEnum} encoding + * @param {AddMembersToZSetDto} addMembersToZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserZSetApi + */ + public zSetControllerAddMembers(dbInstance: string, encoding: ZSetControllerAddMembersEncodingEnum, addMembersToZSetDto: AddMembersToZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserZSetApiFp(this.configuration).zSetControllerAddMembers(dbInstance, encoding, addMembersToZSetDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Set key to hold ZSet data type + * @summary + * @param {string} dbInstance + * @param {ZSetControllerCreateSetEncodingEnum} encoding + * @param {CreateZSetWithExpireDto} createZSetWithExpireDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserZSetApi + */ + public zSetControllerCreateSet(dbInstance: string, encoding: ZSetControllerCreateSetEncodingEnum, createZSetWithExpireDto: CreateZSetWithExpireDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserZSetApiFp(this.configuration).zSetControllerCreateSet(dbInstance, encoding, createZSetWithExpireDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Remove the specified members from the Set stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerDeleteMembersEncodingEnum} encoding + * @param {DeleteMembersFromZSetDto} deleteMembersFromZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserZSetApi + */ + public zSetControllerDeleteMembers(dbInstance: string, encoding: ZSetControllerDeleteMembersEncodingEnum, deleteMembersFromZSetDto: DeleteMembersFromZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserZSetApiFp(this.configuration).zSetControllerDeleteMembers(dbInstance, encoding, deleteMembersFromZSetDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get specified members of the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerGetZSetEncodingEnum} encoding + * @param {GetZSetMembersDto} getZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserZSetApi + */ + public zSetControllerGetZSet(dbInstance: string, encoding: ZSetControllerGetZSetEncodingEnum, getZSetMembersDto: GetZSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserZSetApiFp(this.configuration).zSetControllerGetZSet(dbInstance, encoding, getZSetMembersDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Search members in ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerSearchZSetEncodingEnum} encoding + * @param {SearchZSetMembersDto} searchZSetMembersDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserZSetApi + */ + public zSetControllerSearchZSet(dbInstance: string, encoding: ZSetControllerSearchZSetEncodingEnum, searchZSetMembersDto: SearchZSetMembersDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserZSetApiFp(this.configuration).zSetControllerSearchZSet(dbInstance, encoding, searchZSetMembersDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update the specified member in the ZSet stored at key + * @summary + * @param {string} dbInstance + * @param {ZSetControllerUpdateMemberEncodingEnum} encoding + * @param {UpdateMemberInZSetDto} updateMemberInZSetDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BrowserZSetApi + */ + public zSetControllerUpdateMember(dbInstance: string, encoding: ZSetControllerUpdateMemberEncodingEnum, updateMemberInZSetDto: UpdateMemberInZSetDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BrowserZSetApiFp(this.configuration).zSetControllerUpdateMember(dbInstance, encoding, updateMemberInZSetDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const ZSetControllerAddMembersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ZSetControllerAddMembersEncodingEnum = typeof ZSetControllerAddMembersEncodingEnum[keyof typeof ZSetControllerAddMembersEncodingEnum]; +/** + * @export + */ +export const ZSetControllerCreateSetEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ZSetControllerCreateSetEncodingEnum = typeof ZSetControllerCreateSetEncodingEnum[keyof typeof ZSetControllerCreateSetEncodingEnum]; +/** + * @export + */ +export const ZSetControllerDeleteMembersEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ZSetControllerDeleteMembersEncodingEnum = typeof ZSetControllerDeleteMembersEncodingEnum[keyof typeof ZSetControllerDeleteMembersEncodingEnum]; +/** + * @export + */ +export const ZSetControllerGetZSetEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ZSetControllerGetZSetEncodingEnum = typeof ZSetControllerGetZSetEncodingEnum[keyof typeof ZSetControllerGetZSetEncodingEnum]; +/** + * @export + */ +export const ZSetControllerSearchZSetEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ZSetControllerSearchZSetEncodingEnum = typeof ZSetControllerSearchZSetEncodingEnum[keyof typeof ZSetControllerSearchZSetEncodingEnum]; +/** + * @export + */ +export const ZSetControllerUpdateMemberEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type ZSetControllerUpdateMemberEncodingEnum = typeof ZSetControllerUpdateMemberEncodingEnum[keyof typeof ZSetControllerUpdateMemberEncodingEnum]; + + +/** + * BulkActionsApi - axios parameter creator + * @export + */ +export const BulkActionsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Import data from file + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + bulkImportControllerImport: async (dbInstance: string, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('bulkImportControllerImport', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/bulk-actions/import` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Import default data + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + bulkImportControllerImportDefaultData: async (dbInstance: string, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('bulkImportControllerImportDefaultData', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/bulk-actions/import/default-data` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Import data from tutorial by path + * @summary + * @param {string} dbInstance + * @param {UploadImportFileByPathDto} uploadImportFileByPathDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + bulkImportControllerUploadFromTutorial: async (dbInstance: string, uploadImportFileByPathDto: UploadImportFileByPathDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('bulkImportControllerUploadFromTutorial', 'dbInstance', dbInstance) + // verify required parameter 'uploadImportFileByPathDto' is not null or undefined + assertParamExists('bulkImportControllerUploadFromTutorial', 'uploadImportFileByPathDto', uploadImportFileByPathDto) + const localVarPath = `/api/databases/{dbInstance}/bulk-actions/import/tutorial-data` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(uploadImportFileByPathDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * BulkActionsApi - functional programming interface + * @export + */ +export const BulkActionsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = BulkActionsApiAxiosParamCreator(configuration) + return { + /** + * Import data from file + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async bulkImportControllerImport(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.bulkImportControllerImport(dbInstance, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BulkActionsApi.bulkImportControllerImport']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Import default data + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async bulkImportControllerImportDefaultData(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.bulkImportControllerImportDefaultData(dbInstance, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BulkActionsApi.bulkImportControllerImportDefaultData']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Import data from tutorial by path + * @summary + * @param {string} dbInstance + * @param {UploadImportFileByPathDto} uploadImportFileByPathDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async bulkImportControllerUploadFromTutorial(dbInstance: string, uploadImportFileByPathDto: UploadImportFileByPathDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.bulkImportControllerUploadFromTutorial(dbInstance, uploadImportFileByPathDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['BulkActionsApi.bulkImportControllerUploadFromTutorial']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * BulkActionsApi - factory interface + * @export + */ +export const BulkActionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = BulkActionsApiFp(configuration) + return { + /** + * Import data from file + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + bulkImportControllerImport(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.bulkImportControllerImport(dbInstance, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Import default data + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + bulkImportControllerImportDefaultData(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.bulkImportControllerImportDefaultData(dbInstance, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Import data from tutorial by path + * @summary + * @param {string} dbInstance + * @param {UploadImportFileByPathDto} uploadImportFileByPathDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + bulkImportControllerUploadFromTutorial(dbInstance: string, uploadImportFileByPathDto: UploadImportFileByPathDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.bulkImportControllerUploadFromTutorial(dbInstance, uploadImportFileByPathDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * BulkActionsApi - object-oriented interface + * @export + * @class BulkActionsApi + * @extends {BaseAPI} + */ +export class BulkActionsApi extends BaseAPI { + /** + * Import data from file + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BulkActionsApi + */ + public bulkImportControllerImport(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BulkActionsApiFp(this.configuration).bulkImportControllerImport(dbInstance, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Import default data + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BulkActionsApi + */ + public bulkImportControllerImportDefaultData(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BulkActionsApiFp(this.configuration).bulkImportControllerImportDefaultData(dbInstance, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Import data from tutorial by path + * @summary + * @param {string} dbInstance + * @param {UploadImportFileByPathDto} uploadImportFileByPathDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof BulkActionsApi + */ + public bulkImportControllerUploadFromTutorial(dbInstance: string, uploadImportFileByPathDto: UploadImportFileByPathDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return BulkActionsApiFp(this.configuration).bulkImportControllerUploadFromTutorial(dbInstance, uploadImportFileByPathDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CLIApi - axios parameter creator + * @export + */ +export const CLIApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete Redis CLI client + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerDeleteClient: async (dbInstance: string, uuid: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('cliControllerDeleteClient', 'dbInstance', dbInstance) + // verify required parameter 'uuid' is not null or undefined + assertParamExists('cliControllerDeleteClient', 'uuid', uuid) + const localVarPath = `/api/databases/{dbInstance}/cli/{uuid}` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))) + .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerGetClient: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('cliControllerGetClient', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/cli` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Re-create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerReCreateClient: async (dbInstance: string, uuid: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('cliControllerReCreateClient', 'dbInstance', dbInstance) + // verify required parameter 'uuid' is not null or undefined + assertParamExists('cliControllerReCreateClient', 'uuid', uuid) + const localVarPath = `/api/databases/{dbInstance}/cli/{uuid}` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))) + .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerSendClusterCommand: async (dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('cliControllerSendClusterCommand', 'dbInstance', dbInstance) + // verify required parameter 'uuid' is not null or undefined + assertParamExists('cliControllerSendClusterCommand', 'uuid', uuid) + // verify required parameter 'sendCommandDto' is not null or undefined + assertParamExists('cliControllerSendClusterCommand', 'sendCommandDto', sendCommandDto) + const localVarPath = `/api/databases/{dbInstance}/cli/{uuid}/send-cluster-command` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))) + .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendCommandDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerSendCommand: async (dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('cliControllerSendCommand', 'dbInstance', dbInstance) + // verify required parameter 'uuid' is not null or undefined + assertParamExists('cliControllerSendCommand', 'uuid', uuid) + // verify required parameter 'sendCommandDto' is not null or undefined + assertParamExists('cliControllerSendCommand', 'sendCommandDto', sendCommandDto) + const localVarPath = `/api/databases/{dbInstance}/cli/{uuid}/send-command` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))) + .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(sendCommandDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CLIApi - functional programming interface + * @export + */ +export const CLIApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CLIApiAxiosParamCreator(configuration) + return { + /** + * Delete Redis CLI client + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cliControllerDeleteClient(dbInstance: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cliControllerDeleteClient(dbInstance, uuid, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CLIApi.cliControllerDeleteClient']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cliControllerGetClient(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cliControllerGetClient(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CLIApi.cliControllerGetClient']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Re-create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cliControllerReCreateClient(dbInstance: string, uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cliControllerReCreateClient(dbInstance, uuid, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CLIApi.cliControllerReCreateClient']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cliControllerSendClusterCommand(dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cliControllerSendClusterCommand(dbInstance, uuid, sendCommandDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CLIApi.cliControllerSendClusterCommand']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cliControllerSendCommand(dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cliControllerSendCommand(dbInstance, uuid, sendCommandDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CLIApi.cliControllerSendCommand']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CLIApi - factory interface + * @export + */ +export const CLIApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CLIApiFp(configuration) + return { + /** + * Delete Redis CLI client + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerDeleteClient(dbInstance: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cliControllerDeleteClient(dbInstance, uuid, options).then((request) => request(axios, basePath)); + }, + /** + * Create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerGetClient(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cliControllerGetClient(dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * Re-create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerReCreateClient(dbInstance: string, uuid: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cliControllerReCreateClient(dbInstance, uuid, options).then((request) => request(axios, basePath)); + }, + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerSendClusterCommand(dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cliControllerSendClusterCommand(dbInstance, uuid, sendCommandDto, options).then((request) => request(axios, basePath)); + }, + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cliControllerSendCommand(dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cliControllerSendCommand(dbInstance, uuid, sendCommandDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CLIApi - object-oriented interface + * @export + * @class CLIApi + * @extends {BaseAPI} + */ +export class CLIApi extends BaseAPI { + /** + * Delete Redis CLI client + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CLIApi + */ + public cliControllerDeleteClient(dbInstance: string, uuid: string, options?: RawAxiosRequestConfig) { + return CLIApiFp(this.configuration).cliControllerDeleteClient(dbInstance, uuid, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CLIApi + */ + public cliControllerGetClient(dbInstance: string, options?: RawAxiosRequestConfig) { + return CLIApiFp(this.configuration).cliControllerGetClient(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Re-create Redis client for CLI + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CLIApi + */ + public cliControllerReCreateClient(dbInstance: string, uuid: string, options?: RawAxiosRequestConfig) { + return CLIApiFp(this.configuration).cliControllerReCreateClient(dbInstance, uuid, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CLIApi + */ + public cliControllerSendClusterCommand(dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options?: RawAxiosRequestConfig) { + return CLIApiFp(this.configuration).cliControllerSendClusterCommand(dbInstance, uuid, sendCommandDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Send Redis CLI command + * @summary + * @param {string} dbInstance Database instance id. + * @param {string} uuid CLI client uuid + * @param {SendCommandDto} sendCommandDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CLIApi + */ + public cliControllerSendCommand(dbInstance: string, uuid: string, sendCommandDto: SendCommandDto, options?: RawAxiosRequestConfig) { + return CLIApiFp(this.configuration).cliControllerSendCommand(dbInstance, uuid, sendCommandDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CloudAuthApi - axios parameter creator + * @export + */ +export const CloudAuthApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * OAuth callback endpoint for handling OAuth authorization code flow + * @summary + * @param {string} [code] Authorization code from OAuth provider + * @param {string} [state] State parameter to prevent CSRF attacks + * @param {string} [error] Error code if OAuth flow failed + * @param {string} [errorDescription] Human-readable error description + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAuthControllerCallback: async (code?: string, state?: string, error?: string, errorDescription?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/auth/oauth/callback`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (code !== undefined) { + localVarQueryParameter['code'] = code; + } + + if (state !== undefined) { + localVarQueryParameter['state'] = state; + } + + if (error !== undefined) { + localVarQueryParameter['error'] = error; + } + + if (errorDescription !== undefined) { + localVarQueryParameter['error_description'] = errorDescription; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CloudAuthApi - functional programming interface + * @export + */ +export const CloudAuthApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CloudAuthApiAxiosParamCreator(configuration) + return { + /** + * OAuth callback endpoint for handling OAuth authorization code flow + * @summary + * @param {string} [code] Authorization code from OAuth provider + * @param {string} [state] State parameter to prevent CSRF attacks + * @param {string} [error] Error code if OAuth flow failed + * @param {string} [errorDescription] Human-readable error description + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudAuthControllerCallback(code?: string, state?: string, error?: string, errorDescription?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudAuthControllerCallback(code, state, error, errorDescription, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAuthApi.cloudAuthControllerCallback']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CloudAuthApi - factory interface + * @export + */ +export const CloudAuthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CloudAuthApiFp(configuration) + return { + /** + * OAuth callback endpoint for handling OAuth authorization code flow + * @summary + * @param {string} [code] Authorization code from OAuth provider + * @param {string} [state] State parameter to prevent CSRF attacks + * @param {string} [error] Error code if OAuth flow failed + * @param {string} [errorDescription] Human-readable error description + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAuthControllerCallback(code?: string, state?: string, error?: string, errorDescription?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudAuthControllerCallback(code, state, error, errorDescription, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CloudAuthApi - object-oriented interface + * @export + * @class CloudAuthApi + * @extends {BaseAPI} + */ +export class CloudAuthApi extends BaseAPI { + /** + * OAuth callback endpoint for handling OAuth authorization code flow + * @summary + * @param {string} [code] Authorization code from OAuth provider + * @param {string} [state] State parameter to prevent CSRF attacks + * @param {string} [error] Error code if OAuth flow failed + * @param {string} [errorDescription] Human-readable error description + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAuthApi + */ + public cloudAuthControllerCallback(code?: string, state?: string, error?: string, errorDescription?: string, options?: RawAxiosRequestConfig) { + return CloudAuthApiFp(this.configuration).cloudAuthControllerCallback(code, state, error, errorDescription, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CloudAutodiscoveryApi - axios parameter creator + * @export + */ +export const CloudAutodiscoveryApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerAddDiscoveredDatabases: async (importCloudDatabasesDto: ImportCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'importCloudDatabasesDto' is not null or undefined + assertParamExists('cloudAutodiscoveryControllerAddDiscoveredDatabases', 'importCloudDatabasesDto', importCloudDatabasesDto) + const localVarPath = `/api/cloud/autodiscovery/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xCloudApiKey != null) { + localVarHeaderParameter['x-cloud-api-key'] = String(xCloudApiKey); + } + if (xCloudApiSecret != null) { + localVarHeaderParameter['x-cloud-api-secret'] = String(xCloudApiSecret); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(importCloudDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerDiscoverDatabases: async (discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'discoverCloudDatabasesDto' is not null or undefined + assertParamExists('cloudAutodiscoveryControllerDiscoverDatabases', 'discoverCloudDatabasesDto', discoverCloudDatabasesDto) + const localVarPath = `/api/cloud/autodiscovery/get-databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (xCloudApiKey != null) { + localVarHeaderParameter['x-cloud-api-key'] = String(xCloudApiKey); + } + if (xCloudApiSecret != null) { + localVarHeaderParameter['x-cloud-api-secret'] = String(xCloudApiSecret); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(discoverCloudDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerDiscoverSubscriptions: async (xCloudApiKey?: string, xCloudApiSecret?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/autodiscovery/subscriptions`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (xCloudApiKey != null) { + localVarHeaderParameter['x-cloud-api-key'] = String(xCloudApiKey); + } + if (xCloudApiSecret != null) { + localVarHeaderParameter['x-cloud-api-secret'] = String(xCloudApiSecret); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get current account + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerGetAccount: async (xCloudApiKey?: string, xCloudApiSecret?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/autodiscovery/account`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (xCloudApiKey != null) { + localVarHeaderParameter['x-cloud-api-key'] = String(xCloudApiKey); + } + if (xCloudApiSecret != null) { + localVarHeaderParameter['x-cloud-api-secret'] = String(xCloudApiSecret); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerAddDiscoveredDatabases: async (importCloudDatabasesDto: ImportCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'importCloudDatabasesDto' is not null or undefined + assertParamExists('meCloudAutodiscoveryControllerAddDiscoveredDatabases', 'importCloudDatabasesDto', importCloudDatabasesDto) + const localVarPath = `/api/cloud/me/autodiscovery/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(importCloudDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerDiscoverDatabases: async (discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'discoverCloudDatabasesDto' is not null or undefined + assertParamExists('meCloudAutodiscoveryControllerDiscoverDatabases', 'discoverCloudDatabasesDto', discoverCloudDatabasesDto) + const localVarPath = `/api/cloud/me/autodiscovery/get-databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(discoverCloudDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerDiscoverSubscriptions: async (source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/autodiscovery/subscriptions`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get current account + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerGetAccount: async (source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/autodiscovery/account`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CloudAutodiscoveryApi - functional programming interface + * @export + */ +export const CloudAutodiscoveryApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CloudAutodiscoveryApiAxiosParamCreator(configuration) + return { + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto: ImportCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto, xCloudApiKey, xCloudApiSecret, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.cloudAutodiscoveryControllerAddDiscoveredDatabases']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto, xCloudApiKey, xCloudApiSecret, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.cloudAutodiscoveryControllerDiscoverDatabases']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudAutodiscoveryControllerDiscoverSubscriptions(xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudAutodiscoveryControllerDiscoverSubscriptions(xCloudApiKey, xCloudApiSecret, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.cloudAutodiscoveryControllerDiscoverSubscriptions']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get current account + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudAutodiscoveryControllerGetAccount(xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudAutodiscoveryControllerGetAccount(xCloudApiKey, xCloudApiSecret, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.cloudAutodiscoveryControllerGetAccount']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto: ImportCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto, source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.meCloudAutodiscoveryControllerAddDiscoveredDatabases']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto, source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.meCloudAutodiscoveryControllerDiscoverDatabases']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async meCloudAutodiscoveryControllerDiscoverSubscriptions(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.meCloudAutodiscoveryControllerDiscoverSubscriptions(source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.meCloudAutodiscoveryControllerDiscoverSubscriptions']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get current account + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async meCloudAutodiscoveryControllerGetAccount(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.meCloudAutodiscoveryControllerGetAccount(source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudAutodiscoveryApi.meCloudAutodiscoveryControllerGetAccount']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CloudAutodiscoveryApi - factory interface + * @export + */ +export const CloudAutodiscoveryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CloudAutodiscoveryApiFp(configuration) + return { + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto: ImportCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto, xCloudApiKey, xCloudApiSecret, options).then((request) => request(axios, basePath)); + }, + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto, xCloudApiKey, xCloudApiSecret, options).then((request) => request(axios, basePath)); + }, + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerDiscoverSubscriptions(xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cloudAutodiscoveryControllerDiscoverSubscriptions(xCloudApiKey, xCloudApiSecret, options).then((request) => request(axios, basePath)); + }, + /** + * Get current account + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudAutodiscoveryControllerGetAccount(xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudAutodiscoveryControllerGetAccount(xCloudApiKey, xCloudApiSecret, options).then((request) => request(axios, basePath)); + }, + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto: ImportCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto, source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto, source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerDiscoverSubscriptions(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.meCloudAutodiscoveryControllerDiscoverSubscriptions(source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + /** + * Get current account + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + meCloudAutodiscoveryControllerGetAccount(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.meCloudAutodiscoveryControllerGetAccount(source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CloudAutodiscoveryApi - object-oriented interface + * @export + * @class CloudAutodiscoveryApi + * @extends {BaseAPI} + */ +export class CloudAutodiscoveryApi extends BaseAPI { + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto: ImportCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto, xCloudApiKey, xCloudApiSecret, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto, xCloudApiKey, xCloudApiSecret, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public cloudAutodiscoveryControllerDiscoverSubscriptions(xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).cloudAutodiscoveryControllerDiscoverSubscriptions(xCloudApiKey, xCloudApiSecret, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get current account + * @summary + * @param {string} [xCloudApiKey] + * @param {string} [xCloudApiSecret] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public cloudAutodiscoveryControllerGetAccount(xCloudApiKey?: string, xCloudApiSecret?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).cloudAutodiscoveryControllerGetAccount(xCloudApiKey, xCloudApiSecret, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Add databases from Redis Enterprise Cloud Pro account. + * @summary + * @param {ImportCloudDatabasesDto} importCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto: ImportCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto, source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get databases belonging to subscriptions + * @summary + * @param {DiscoverCloudDatabasesDto} discoverCloudDatabasesDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto: DiscoverCloudDatabasesDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto, source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get information about current account’s subscriptions. + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public meCloudAutodiscoveryControllerDiscoverSubscriptions(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).meCloudAutodiscoveryControllerDiscoverSubscriptions(source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get current account + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudAutodiscoveryApi + */ + public meCloudAutodiscoveryControllerGetAccount(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudAutodiscoveryApiFp(this.configuration).meCloudAutodiscoveryControllerGetAccount(source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CloudCAPIKeysApi - axios parameter creator + * @export + */ +export const CloudCAPIKeysApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Removes user\'s capi keys by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudCapiKeyControllerDelete: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cloudCapiKeyControllerDelete', 'id', id) + const localVarPath = `/api/cloud/me/capi-keys/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes all user\'s capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudCapiKeyControllerDeleteAll: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/capi-keys`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Return list of user\'s existing capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudCapiKeyControllerList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/capi-keys`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CloudCAPIKeysApi - functional programming interface + * @export + */ +export const CloudCAPIKeysApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CloudCAPIKeysApiAxiosParamCreator(configuration) + return { + /** + * Removes user\'s capi keys by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudCapiKeyControllerDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudCapiKeyControllerDelete(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudCAPIKeysApi.cloudCapiKeyControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Removes all user\'s capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudCapiKeyControllerDeleteAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudCapiKeyControllerDeleteAll(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudCAPIKeysApi.cloudCapiKeyControllerDeleteAll']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Return list of user\'s existing capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudCapiKeyControllerList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudCapiKeyControllerList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudCAPIKeysApi.cloudCapiKeyControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CloudCAPIKeysApi - factory interface + * @export + */ +export const CloudCAPIKeysApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CloudCAPIKeysApiFp(configuration) + return { + /** + * Removes user\'s capi keys by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudCapiKeyControllerDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudCapiKeyControllerDelete(id, options).then((request) => request(axios, basePath)); + }, + /** + * Removes all user\'s capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudCapiKeyControllerDeleteAll(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudCapiKeyControllerDeleteAll(options).then((request) => request(axios, basePath)); + }, + /** + * Return list of user\'s existing capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudCapiKeyControllerList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cloudCapiKeyControllerList(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CloudCAPIKeysApi - object-oriented interface + * @export + * @class CloudCAPIKeysApi + * @extends {BaseAPI} + */ +export class CloudCAPIKeysApi extends BaseAPI { + /** + * Removes user\'s capi keys by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudCAPIKeysApi + */ + public cloudCapiKeyControllerDelete(id: string, options?: RawAxiosRequestConfig) { + return CloudCAPIKeysApiFp(this.configuration).cloudCapiKeyControllerDelete(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes all user\'s capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudCAPIKeysApi + */ + public cloudCapiKeyControllerDeleteAll(options?: RawAxiosRequestConfig) { + return CloudCAPIKeysApiFp(this.configuration).cloudCapiKeyControllerDeleteAll(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Return list of user\'s existing capi keys + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudCAPIKeysApi + */ + public cloudCapiKeyControllerList(options?: RawAxiosRequestConfig) { + return CloudCAPIKeysApiFp(this.configuration).cloudCapiKeyControllerList(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CloudJobsApi - axios parameter creator + * @export + */ +export const CloudJobsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create cloud job + * @summary + * @param {CreateCloudJobDto} createCloudJobDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudJobControllerCreateFreeDatabase: async (createCloudJobDto: CreateCloudJobDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createCloudJobDto' is not null or undefined + assertParamExists('cloudJobControllerCreateFreeDatabase', 'createCloudJobDto', createCloudJobDto) + const localVarPath = `/api/cloud/me/jobs`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createCloudJobDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get user jobs + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudJobControllerGetJobInfo: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cloudJobControllerGetJobInfo', 'id', id) + const localVarPath = `/api/cloud/me/jobs/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get list of user jobs + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudJobControllerGetUserJobsInfo: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/jobs`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CloudJobsApi - functional programming interface + * @export + */ +export const CloudJobsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CloudJobsApiAxiosParamCreator(configuration) + return { + /** + * Create cloud job + * @summary + * @param {CreateCloudJobDto} createCloudJobDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudJobControllerCreateFreeDatabase(createCloudJobDto: CreateCloudJobDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudJobControllerCreateFreeDatabase(createCloudJobDto, source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudJobsApi.cloudJobControllerCreateFreeDatabase']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get user jobs + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudJobControllerGetJobInfo(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudJobControllerGetJobInfo(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudJobsApi.cloudJobControllerGetJobInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get list of user jobs + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudJobControllerGetUserJobsInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudJobControllerGetUserJobsInfo(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudJobsApi.cloudJobControllerGetUserJobsInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CloudJobsApi - factory interface + * @export + */ +export const CloudJobsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CloudJobsApiFp(configuration) + return { + /** + * Create cloud job + * @summary + * @param {CreateCloudJobDto} createCloudJobDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudJobControllerCreateFreeDatabase(createCloudJobDto: CreateCloudJobDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudJobControllerCreateFreeDatabase(createCloudJobDto, source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + /** + * Get user jobs + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudJobControllerGetJobInfo(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudJobControllerGetJobInfo(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get list of user jobs + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudJobControllerGetUserJobsInfo(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cloudJobControllerGetUserJobsInfo(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CloudJobsApi - object-oriented interface + * @export + * @class CloudJobsApi + * @extends {BaseAPI} + */ +export class CloudJobsApi extends BaseAPI { + /** + * Create cloud job + * @summary + * @param {CreateCloudJobDto} createCloudJobDto + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudJobsApi + */ + public cloudJobControllerCreateFreeDatabase(createCloudJobDto: CreateCloudJobDto, source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudJobsApiFp(this.configuration).cloudJobControllerCreateFreeDatabase(createCloudJobDto, source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get user jobs + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudJobsApi + */ + public cloudJobControllerGetJobInfo(id: string, options?: RawAxiosRequestConfig) { + return CloudJobsApiFp(this.configuration).cloudJobControllerGetJobInfo(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get list of user jobs + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudJobsApi + */ + public cloudJobControllerGetUserJobsInfo(options?: RawAxiosRequestConfig) { + return CloudJobsApiFp(this.configuration).cloudJobControllerGetUserJobsInfo(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CloudSubscriptionApi - axios parameter creator + * @export + */ +export const CloudSubscriptionApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get list of plans with cloud regions + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudSubscriptionControllerGetPlans: async (source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/subscription/plans`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CloudSubscriptionApi - functional programming interface + * @export + */ +export const CloudSubscriptionApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CloudSubscriptionApiAxiosParamCreator(configuration) + return { + /** + * Get list of plans with cloud regions + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudSubscriptionControllerGetPlans(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudSubscriptionControllerGetPlans(source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudSubscriptionApi.cloudSubscriptionControllerGetPlans']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CloudSubscriptionApi - factory interface + * @export + */ +export const CloudSubscriptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CloudSubscriptionApiFp(configuration) + return { + /** + * Get list of plans with cloud regions + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudSubscriptionControllerGetPlans(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.cloudSubscriptionControllerGetPlans(source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CloudSubscriptionApi - object-oriented interface + * @export + * @class CloudSubscriptionApi + * @extends {BaseAPI} + */ +export class CloudSubscriptionApi extends BaseAPI { + /** + * Get list of plans with cloud regions + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudSubscriptionApi + */ + public cloudSubscriptionControllerGetPlans(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudSubscriptionApiFp(this.configuration).cloudSubscriptionControllerGetPlans(source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CloudUserApi - axios parameter creator + * @export + */ +export const CloudUserApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Logout user + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudUserControllerLogout: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me/logout`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Return user general info with accounts list + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudUserControllerMe: async (source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/cloud/me`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (source !== undefined) { + localVarQueryParameter['source'] = source; + } + + if (medium !== undefined) { + localVarQueryParameter['medium'] = medium; + } + + if (campaign !== undefined) { + localVarQueryParameter['campaign'] = campaign; + } + + if (amp !== undefined) { + localVarQueryParameter['amp'] = amp; + } + + if (_package !== undefined) { + localVarQueryParameter['package'] = _package; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Activate user account + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudUserControllerSetCurrentAccount: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cloudUserControllerSetCurrentAccount', 'id', id) + const localVarPath = `/api/cloud/me/accounts/{id}/current` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CloudUserApi - functional programming interface + * @export + */ +export const CloudUserApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CloudUserApiAxiosParamCreator(configuration) + return { + /** + * Logout user + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudUserControllerLogout(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudUserControllerLogout(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudUserApi.cloudUserControllerLogout']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Return user general info with accounts list + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudUserControllerMe(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudUserControllerMe(source, medium, campaign, amp, _package, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudUserApi.cloudUserControllerMe']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Activate user account + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async cloudUserControllerSetCurrentAccount(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cloudUserControllerSetCurrentAccount(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CloudUserApi.cloudUserControllerSetCurrentAccount']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CloudUserApi - factory interface + * @export + */ +export const CloudUserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CloudUserApiFp(configuration) + return { + /** + * Logout user + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudUserControllerLogout(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudUserControllerLogout(options).then((request) => request(axios, basePath)); + }, + /** + * Return user general info with accounts list + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudUserControllerMe(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudUserControllerMe(source, medium, campaign, amp, _package, options).then((request) => request(axios, basePath)); + }, + /** + * Activate user account + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cloudUserControllerSetCurrentAccount(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cloudUserControllerSetCurrentAccount(id, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CloudUserApi - object-oriented interface + * @export + * @class CloudUserApi + * @extends {BaseAPI} + */ +export class CloudUserApi extends BaseAPI { + /** + * Logout user + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudUserApi + */ + public cloudUserControllerLogout(options?: RawAxiosRequestConfig) { + return CloudUserApiFp(this.configuration).cloudUserControllerLogout(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Return user general info with accounts list + * @summary + * @param {string} [source] + * @param {string} [medium] + * @param {string} [campaign] + * @param {string} [amp] + * @param {string} [_package] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudUserApi + */ + public cloudUserControllerMe(source?: string, medium?: string, campaign?: string, amp?: string, _package?: string, options?: RawAxiosRequestConfig) { + return CloudUserApiFp(this.configuration).cloudUserControllerMe(source, medium, campaign, amp, _package, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Activate user account + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CloudUserApi + */ + public cloudUserControllerSetCurrentAccount(id: string, options?: RawAxiosRequestConfig) { + return CloudUserApiFp(this.configuration).cloudUserControllerSetCurrentAccount(id, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * ClusterMonitorApi - axios parameter creator + * @export + */ +export const ClusterMonitorApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get cluster details + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + clusterMonitorControllerGetClusterDetails: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('clusterMonitorControllerGetClusterDetails', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/cluster-details` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ClusterMonitorApi - functional programming interface + * @export + */ +export const ClusterMonitorApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ClusterMonitorApiAxiosParamCreator(configuration) + return { + /** + * Get cluster details + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async clusterMonitorControllerGetClusterDetails(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.clusterMonitorControllerGetClusterDetails(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ClusterMonitorApi.clusterMonitorControllerGetClusterDetails']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ClusterMonitorApi - factory interface + * @export + */ +export const ClusterMonitorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ClusterMonitorApiFp(configuration) + return { + /** + * Get cluster details + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + clusterMonitorControllerGetClusterDetails(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.clusterMonitorControllerGetClusterDetails(dbInstance, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * ClusterMonitorApi - object-oriented interface + * @export + * @class ClusterMonitorApi + * @extends {BaseAPI} + */ +export class ClusterMonitorApi extends BaseAPI { + /** + * Get cluster details + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ClusterMonitorApi + */ + public clusterMonitorControllerGetClusterDetails(dbInstance: string, options?: RawAxiosRequestConfig) { + return ClusterMonitorApiFp(this.configuration).clusterMonitorControllerGetClusterDetails(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * CommandsApi - axios parameter creator + * @export + */ +export const CommandsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + commandsControllerGetAll: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/commands`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * CommandsApi - functional programming interface + * @export + */ +export const CommandsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = CommandsApiAxiosParamCreator(configuration) + return { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async commandsControllerGetAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.commandsControllerGetAll(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['CommandsApi.commandsControllerGetAll']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * CommandsApi - factory interface + * @export + */ +export const CommandsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = CommandsApiFp(configuration) + return { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + commandsControllerGetAll(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.commandsControllerGetAll(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * CommandsApi - object-oriented interface + * @export + * @class CommandsApi + * @extends {BaseAPI} + */ +export class CommandsApi extends BaseAPI { + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof CommandsApi + */ + public commandsControllerGetAll(options?: RawAxiosRequestConfig) { + return CommandsApiFp(this.configuration).commandsControllerGetAll(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * DatabaseApi - axios parameter creator + * @export + */ +export const DatabaseApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete many databases by ids + * @summary + * @param {DeleteDatabasesDto} deleteDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerBulkDeleteDatabaseInstance: async (deleteDatabasesDto: DeleteDatabasesDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'deleteDatabasesDto' is not null or undefined + assertParamExists('databaseControllerBulkDeleteDatabaseInstance', 'deleteDatabasesDto', deleteDatabasesDto) + const localVarPath = `/api/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerClone: async (id: string, updateDatabaseDto: UpdateDatabaseDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseControllerClone', 'id', id) + // verify required parameter 'updateDatabaseDto' is not null or undefined + assertParamExists('databaseControllerClone', 'updateDatabaseDto', updateDatabaseDto) + const localVarPath = `/api/databases/clone/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateDatabaseDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Connect to database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerConnect: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseControllerConnect', 'id', id) + const localVarPath = `/api/databases/{id}/connect` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Add database instance + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerCreate: async (createDatabaseDto: CreateDatabaseDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createDatabaseDto' is not null or undefined + assertParamExists('databaseControllerCreate', 'createDatabaseDto', createDatabaseDto) + const localVarPath = `/api/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createDatabaseDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerDeleteDatabaseInstance: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseControllerDeleteDatabaseInstance', 'id', id) + const localVarPath = `/api/databases/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Export many databases by ids. With or without passwords and certificates bodies. + * @summary + * @param {ExportDatabasesDto} exportDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerExportConnections: async (exportDatabasesDto: ExportDatabasesDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'exportDatabasesDto' is not null or undefined + assertParamExists('databaseControllerExportConnections', 'exportDatabasesDto', exportDatabasesDto) + const localVarPath = `/api/databases/export`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(exportDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerGet: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseControllerGet', 'id', id) + const localVarPath = `/api/databases/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get databases list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Test connection + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerTestConnection: async (createDatabaseDto: CreateDatabaseDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createDatabaseDto' is not null or undefined + assertParamExists('databaseControllerTestConnection', 'createDatabaseDto', createDatabaseDto) + const localVarPath = `/api/databases/test`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createDatabaseDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Test connection + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerTestExistConnection: async (id: string, updateDatabaseDto: UpdateDatabaseDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseControllerTestExistConnection', 'id', id) + // verify required parameter 'updateDatabaseDto' is not null or undefined + assertParamExists('databaseControllerTestExistConnection', 'updateDatabaseDto', updateDatabaseDto) + const localVarPath = `/api/databases/test/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateDatabaseDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerUpdate: async (id: string, updateDatabaseDto: UpdateDatabaseDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseControllerUpdate', 'id', id) + // verify required parameter 'updateDatabaseDto' is not null or undefined + assertParamExists('databaseControllerUpdate', 'updateDatabaseDto', updateDatabaseDto) + const localVarPath = `/api/databases/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateDatabaseDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @param {File} [file] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseImportControllerImport: async (file?: File, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/databases/import`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * DatabaseApi - functional programming interface + * @export + */ +export const DatabaseApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DatabaseApiAxiosParamCreator(configuration) + return { + /** + * Delete many databases by ids + * @summary + * @param {DeleteDatabasesDto} deleteDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto: DeleteDatabasesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerBulkDeleteDatabaseInstance']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerClone(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerClone(id, updateDatabaseDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerClone']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Connect to database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerConnect(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerConnect(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerConnect']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Add database instance + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerCreate(createDatabaseDto: CreateDatabaseDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerCreate(createDatabaseDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerDeleteDatabaseInstance(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerDeleteDatabaseInstance(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerDeleteDatabaseInstance']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Export many databases by ids. With or without passwords and certificates bodies. + * @summary + * @param {ExportDatabasesDto} exportDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerExportConnections(exportDatabasesDto: ExportDatabasesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerExportConnections(exportDatabasesDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerExportConnections']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerGet(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get databases list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Test connection + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerTestConnection(createDatabaseDto: CreateDatabaseDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerTestConnection(createDatabaseDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerTestConnection']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Test connection + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerTestExistConnection(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerTestExistConnection(id, updateDatabaseDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerTestExistConnection']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseControllerUpdate(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseControllerUpdate(id, updateDatabaseDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseControllerUpdate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @param {File} [file] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseImportControllerImport(file?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseImportControllerImport(file, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseApi.databaseImportControllerImport']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DatabaseApi - factory interface + * @export + */ +export const DatabaseApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DatabaseApiFp(configuration) + return { + /** + * Delete many databases by ids + * @summary + * @param {DeleteDatabasesDto} deleteDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto: DeleteDatabasesDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto, options).then((request) => request(axios, basePath)); + }, + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerClone(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerClone(id, updateDatabaseDto, options).then((request) => request(axios, basePath)); + }, + /** + * Connect to database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerConnect(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerConnect(id, options).then((request) => request(axios, basePath)); + }, + /** + * Add database instance + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerCreate(createDatabaseDto: CreateDatabaseDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerCreate(createDatabaseDto, options).then((request) => request(axios, basePath)); + }, + /** + * Delete database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerDeleteDatabaseInstance(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerDeleteDatabaseInstance(id, options).then((request) => request(axios, basePath)); + }, + /** + * Export many databases by ids. With or without passwords and certificates bodies. + * @summary + * @param {ExportDatabasesDto} exportDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerExportConnections(exportDatabasesDto: ExportDatabasesDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerExportConnections(exportDatabasesDto, options).then((request) => request(axios, basePath)); + }, + /** + * Get database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerGet(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get databases list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.databaseControllerList(options).then((request) => request(axios, basePath)); + }, + /** + * Test connection + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerTestConnection(createDatabaseDto: CreateDatabaseDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerTestConnection(createDatabaseDto, options).then((request) => request(axios, basePath)); + }, + /** + * Test connection + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerTestExistConnection(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerTestExistConnection(id, updateDatabaseDto, options).then((request) => request(axios, basePath)); + }, + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseControllerUpdate(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseControllerUpdate(id, updateDatabaseDto, options).then((request) => request(axios, basePath)); + }, + /** + * + * @param {File} [file] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseImportControllerImport(file?: File, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseImportControllerImport(file, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DatabaseApi - object-oriented interface + * @export + * @class DatabaseApi + * @extends {BaseAPI} + */ +export class DatabaseApi extends BaseAPI { + /** + * Delete many databases by ids + * @summary + * @param {DeleteDatabasesDto} deleteDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto: DeleteDatabasesDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerClone(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerClone(id, updateDatabaseDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Connect to database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerConnect(id: string, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerConnect(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Add database instance + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerCreate(createDatabaseDto: CreateDatabaseDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerCreate(createDatabaseDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerDeleteDatabaseInstance(id: string, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerDeleteDatabaseInstance(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Export many databases by ids. With or without passwords and certificates bodies. + * @summary + * @param {ExportDatabasesDto} exportDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerExportConnections(exportDatabasesDto: ExportDatabasesDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerExportConnections(exportDatabasesDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get database instance by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerGet(id: string, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerGet(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get databases list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerList(options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerList(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Test connection + * @summary + * @param {CreateDatabaseDto} createDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerTestConnection(createDatabaseDto: CreateDatabaseDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerTestConnection(createDatabaseDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Test connection + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerTestExistConnection(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerTestExistConnection(id, updateDatabaseDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update database instance by id + * @summary + * @param {string} id + * @param {UpdateDatabaseDto} updateDatabaseDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseControllerUpdate(id: string, updateDatabaseDto: UpdateDatabaseDto, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseControllerUpdate(id, updateDatabaseDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @param {File} [file] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseApi + */ + public databaseImportControllerImport(file?: File, options?: RawAxiosRequestConfig) { + return DatabaseApiFp(this.configuration).databaseImportControllerImport(file, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * DatabaseAnalysisApi - axios parameter creator + * @export + */ +export const DatabaseAnalysisApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create new database analysis + * @summary + * @param {string} dbInstance + * @param {DatabaseAnalysisControllerCreateEncodingEnum} encoding + * @param {CreateDatabaseAnalysisDto} createDatabaseAnalysisDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerCreate: async (dbInstance: string, encoding: DatabaseAnalysisControllerCreateEncodingEnum, createDatabaseAnalysisDto: CreateDatabaseAnalysisDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseAnalysisControllerCreate', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('databaseAnalysisControllerCreate', 'encoding', encoding) + // verify required parameter 'createDatabaseAnalysisDto' is not null or undefined + assertParamExists('databaseAnalysisControllerCreate', 'createDatabaseAnalysisDto', createDatabaseAnalysisDto) + const localVarPath = `/api/databases/{dbInstance}/analysis` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createDatabaseAnalysisDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get database analysis + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerGetEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerGet: async (id: string, dbInstance: string, encoding: DatabaseAnalysisControllerGetEncodingEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseAnalysisControllerGet', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseAnalysisControllerGet', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('databaseAnalysisControllerGet', 'encoding', encoding) + const localVarPath = `/api/databases/{dbInstance}/analysis/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get database analysis list + * @summary + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerListEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerList: async (dbInstance: string, encoding: DatabaseAnalysisControllerListEncodingEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseAnalysisControllerList', 'dbInstance', dbInstance) + // verify required parameter 'encoding' is not null or undefined + assertParamExists('databaseAnalysisControllerList', 'encoding', encoding) + const localVarPath = `/api/databases/{dbInstance}/analysis` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (encoding !== undefined) { + localVarQueryParameter['encoding'] = encoding; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update database analysis by id + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {RecommendationVoteDto} recommendationVoteDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerModify: async (id: string, dbInstance: string, recommendationVoteDto: RecommendationVoteDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseAnalysisControllerModify', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseAnalysisControllerModify', 'dbInstance', dbInstance) + // verify required parameter 'recommendationVoteDto' is not null or undefined + assertParamExists('databaseAnalysisControllerModify', 'recommendationVoteDto', recommendationVoteDto) + const localVarPath = `/api/databases/{dbInstance}/analysis/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(recommendationVoteDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * DatabaseAnalysisApi - functional programming interface + * @export + */ +export const DatabaseAnalysisApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DatabaseAnalysisApiAxiosParamCreator(configuration) + return { + /** + * Create new database analysis + * @summary + * @param {string} dbInstance + * @param {DatabaseAnalysisControllerCreateEncodingEnum} encoding + * @param {CreateDatabaseAnalysisDto} createDatabaseAnalysisDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseAnalysisControllerCreate(dbInstance: string, encoding: DatabaseAnalysisControllerCreateEncodingEnum, createDatabaseAnalysisDto: CreateDatabaseAnalysisDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseAnalysisControllerCreate(dbInstance, encoding, createDatabaseAnalysisDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseAnalysisApi.databaseAnalysisControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get database analysis + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerGetEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseAnalysisControllerGet(id: string, dbInstance: string, encoding: DatabaseAnalysisControllerGetEncodingEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseAnalysisControllerGet(id, dbInstance, encoding, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseAnalysisApi.databaseAnalysisControllerGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get database analysis list + * @summary + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerListEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseAnalysisControllerList(dbInstance: string, encoding: DatabaseAnalysisControllerListEncodingEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseAnalysisControllerList(dbInstance, encoding, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseAnalysisApi.databaseAnalysisControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update database analysis by id + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {RecommendationVoteDto} recommendationVoteDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseAnalysisControllerModify(id: string, dbInstance: string, recommendationVoteDto: RecommendationVoteDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseAnalysisControllerModify(id, dbInstance, recommendationVoteDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseAnalysisApi.databaseAnalysisControllerModify']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DatabaseAnalysisApi - factory interface + * @export + */ +export const DatabaseAnalysisApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DatabaseAnalysisApiFp(configuration) + return { + /** + * Create new database analysis + * @summary + * @param {string} dbInstance + * @param {DatabaseAnalysisControllerCreateEncodingEnum} encoding + * @param {CreateDatabaseAnalysisDto} createDatabaseAnalysisDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerCreate(dbInstance: string, encoding: DatabaseAnalysisControllerCreateEncodingEnum, createDatabaseAnalysisDto: CreateDatabaseAnalysisDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseAnalysisControllerCreate(dbInstance, encoding, createDatabaseAnalysisDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get database analysis + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerGetEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerGet(id: string, dbInstance: string, encoding: DatabaseAnalysisControllerGetEncodingEnum, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseAnalysisControllerGet(id, dbInstance, encoding, options).then((request) => request(axios, basePath)); + }, + /** + * Get database analysis list + * @summary + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerListEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerList(dbInstance: string, encoding: DatabaseAnalysisControllerListEncodingEnum, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.databaseAnalysisControllerList(dbInstance, encoding, options).then((request) => request(axios, basePath)); + }, + /** + * Update database analysis by id + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {RecommendationVoteDto} recommendationVoteDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseAnalysisControllerModify(id: string, dbInstance: string, recommendationVoteDto: RecommendationVoteDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseAnalysisControllerModify(id, dbInstance, recommendationVoteDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DatabaseAnalysisApi - object-oriented interface + * @export + * @class DatabaseAnalysisApi + * @extends {BaseAPI} + */ +export class DatabaseAnalysisApi extends BaseAPI { + /** + * Create new database analysis + * @summary + * @param {string} dbInstance + * @param {DatabaseAnalysisControllerCreateEncodingEnum} encoding + * @param {CreateDatabaseAnalysisDto} createDatabaseAnalysisDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseAnalysisApi + */ + public databaseAnalysisControllerCreate(dbInstance: string, encoding: DatabaseAnalysisControllerCreateEncodingEnum, createDatabaseAnalysisDto: CreateDatabaseAnalysisDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return DatabaseAnalysisApiFp(this.configuration).databaseAnalysisControllerCreate(dbInstance, encoding, createDatabaseAnalysisDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get database analysis + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerGetEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseAnalysisApi + */ + public databaseAnalysisControllerGet(id: string, dbInstance: string, encoding: DatabaseAnalysisControllerGetEncodingEnum, options?: RawAxiosRequestConfig) { + return DatabaseAnalysisApiFp(this.configuration).databaseAnalysisControllerGet(id, dbInstance, encoding, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get database analysis list + * @summary + * @param {string} dbInstance Database instance id + * @param {DatabaseAnalysisControllerListEncodingEnum} encoding + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseAnalysisApi + */ + public databaseAnalysisControllerList(dbInstance: string, encoding: DatabaseAnalysisControllerListEncodingEnum, options?: RawAxiosRequestConfig) { + return DatabaseAnalysisApiFp(this.configuration).databaseAnalysisControllerList(dbInstance, encoding, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update database analysis by id + * @summary + * @param {string} id Analysis id + * @param {string} dbInstance Database instance id + * @param {RecommendationVoteDto} recommendationVoteDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseAnalysisApi + */ + public databaseAnalysisControllerModify(id: string, dbInstance: string, recommendationVoteDto: RecommendationVoteDto, options?: RawAxiosRequestConfig) { + return DatabaseAnalysisApiFp(this.configuration).databaseAnalysisControllerModify(id, dbInstance, recommendationVoteDto, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DatabaseAnalysisControllerCreateEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type DatabaseAnalysisControllerCreateEncodingEnum = typeof DatabaseAnalysisControllerCreateEncodingEnum[keyof typeof DatabaseAnalysisControllerCreateEncodingEnum]; +/** + * @export + */ +export const DatabaseAnalysisControllerGetEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type DatabaseAnalysisControllerGetEncodingEnum = typeof DatabaseAnalysisControllerGetEncodingEnum[keyof typeof DatabaseAnalysisControllerGetEncodingEnum]; +/** + * @export + */ +export const DatabaseAnalysisControllerListEncodingEnum = { + Utf8: 'utf8', + Ascii: 'ascii', + Buffer: 'buffer' +} as const; +export type DatabaseAnalysisControllerListEncodingEnum = typeof DatabaseAnalysisControllerListEncodingEnum[keyof typeof DatabaseAnalysisControllerListEncodingEnum]; + + +/** + * DatabaseDatabaseSettingsApi - axios parameter creator + * @export + */ +export const DatabaseDatabaseSettingsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Update database settings + * @summary + * @param {string} dbInstance + * @param {CreateOrUpdateDatabaseSettingDto} createOrUpdateDatabaseSettingDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseSettingsControllerCreate: async (dbInstance: string, createOrUpdateDatabaseSettingDto: CreateOrUpdateDatabaseSettingDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseSettingsControllerCreate', 'dbInstance', dbInstance) + // verify required parameter 'createOrUpdateDatabaseSettingDto' is not null or undefined + assertParamExists('databaseSettingsControllerCreate', 'createOrUpdateDatabaseSettingDto', createOrUpdateDatabaseSettingDto) + const localVarPath = `/api/databases/{dbInstance}/settings` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createOrUpdateDatabaseSettingDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete database settings + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseSettingsControllerDelete: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseSettingsControllerDelete', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/settings` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get database settings + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseSettingsControllerGet: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseSettingsControllerGet', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/settings` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * DatabaseDatabaseSettingsApi - functional programming interface + * @export + */ +export const DatabaseDatabaseSettingsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DatabaseDatabaseSettingsApiAxiosParamCreator(configuration) + return { + /** + * Update database settings + * @summary + * @param {string} dbInstance + * @param {CreateOrUpdateDatabaseSettingDto} createOrUpdateDatabaseSettingDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseSettingsControllerCreate(dbInstance: string, createOrUpdateDatabaseSettingDto: CreateOrUpdateDatabaseSettingDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseSettingsControllerCreate(dbInstance, createOrUpdateDatabaseSettingDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseDatabaseSettingsApi.databaseSettingsControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete database settings + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseSettingsControllerDelete(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseSettingsControllerDelete(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseDatabaseSettingsApi.databaseSettingsControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get database settings + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseSettingsControllerGet(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseSettingsControllerGet(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseDatabaseSettingsApi.databaseSettingsControllerGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DatabaseDatabaseSettingsApi - factory interface + * @export + */ +export const DatabaseDatabaseSettingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DatabaseDatabaseSettingsApiFp(configuration) + return { + /** + * Update database settings + * @summary + * @param {string} dbInstance + * @param {CreateOrUpdateDatabaseSettingDto} createOrUpdateDatabaseSettingDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseSettingsControllerCreate(dbInstance: string, createOrUpdateDatabaseSettingDto: CreateOrUpdateDatabaseSettingDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseSettingsControllerCreate(dbInstance, createOrUpdateDatabaseSettingDto, options).then((request) => request(axios, basePath)); + }, + /** + * Delete database settings + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseSettingsControllerDelete(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseSettingsControllerDelete(dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * Get database settings + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseSettingsControllerGet(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseSettingsControllerGet(dbInstance, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DatabaseDatabaseSettingsApi - object-oriented interface + * @export + * @class DatabaseDatabaseSettingsApi + * @extends {BaseAPI} + */ +export class DatabaseDatabaseSettingsApi extends BaseAPI { + /** + * Update database settings + * @summary + * @param {string} dbInstance + * @param {CreateOrUpdateDatabaseSettingDto} createOrUpdateDatabaseSettingDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseDatabaseSettingsApi + */ + public databaseSettingsControllerCreate(dbInstance: string, createOrUpdateDatabaseSettingDto: CreateOrUpdateDatabaseSettingDto, options?: RawAxiosRequestConfig) { + return DatabaseDatabaseSettingsApiFp(this.configuration).databaseSettingsControllerCreate(dbInstance, createOrUpdateDatabaseSettingDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete database settings + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseDatabaseSettingsApi + */ + public databaseSettingsControllerDelete(dbInstance: string, options?: RawAxiosRequestConfig) { + return DatabaseDatabaseSettingsApiFp(this.configuration).databaseSettingsControllerDelete(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get database settings + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseDatabaseSettingsApi + */ + public databaseSettingsControllerGet(dbInstance: string, options?: RawAxiosRequestConfig) { + return DatabaseDatabaseSettingsApiFp(this.configuration).databaseSettingsControllerGet(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * DatabaseInstancesApi - axios parameter creator + * @export + */ +export const DatabaseInstancesApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Try to create connection to specified database index + * @summary + * @param {object} index + * @param {string} id + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseInfoControllerGetDatabaseIndex: async (index: object, id: string, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'index' is not null or undefined + assertParamExists('databaseInfoControllerGetDatabaseIndex', 'index', index) + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseInfoControllerGetDatabaseIndex', 'id', id) + const localVarPath = `/api/databases/{id}/db/{index}` + .replace(`{${"index"}}`, encodeURIComponent(String(index))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get Redis database overview + * @summary + * @param {string} id + * @param {number} [riDbIndex] + * @param {DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum} [keyspace] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseInfoControllerGetDatabaseOverview: async (id: string, riDbIndex?: number, keyspace?: DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseInfoControllerGetDatabaseOverview', 'id', id) + const localVarPath = `/api/databases/{id}/overview` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (keyspace !== undefined) { + localVarQueryParameter['keyspace'] = keyspace; + } + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get Redis database config info + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseInfoControllerGetInfo: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseInfoControllerGetInfo', 'id', id) + const localVarPath = `/api/databases/{id}/info` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * DatabaseInstancesApi - functional programming interface + * @export + */ +export const DatabaseInstancesApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DatabaseInstancesApiAxiosParamCreator(configuration) + return { + /** + * Try to create connection to specified database index + * @summary + * @param {object} index + * @param {string} id + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseInfoControllerGetDatabaseIndex(index: object, id: string, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseInfoControllerGetDatabaseIndex(index, id, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseInstancesApi.databaseInfoControllerGetDatabaseIndex']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get Redis database overview + * @summary + * @param {string} id + * @param {number} [riDbIndex] + * @param {DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum} [keyspace] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseInfoControllerGetDatabaseOverview(id: string, riDbIndex?: number, keyspace?: DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseInfoControllerGetDatabaseOverview(id, riDbIndex, keyspace, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseInstancesApi.databaseInfoControllerGetDatabaseOverview']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get Redis database config info + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseInfoControllerGetInfo(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseInfoControllerGetInfo(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseInstancesApi.databaseInfoControllerGetInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DatabaseInstancesApi - factory interface + * @export + */ +export const DatabaseInstancesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DatabaseInstancesApiFp(configuration) + return { + /** + * Try to create connection to specified database index + * @summary + * @param {object} index + * @param {string} id + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseInfoControllerGetDatabaseIndex(index: object, id: string, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseInfoControllerGetDatabaseIndex(index, id, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get Redis database overview + * @summary + * @param {string} id + * @param {number} [riDbIndex] + * @param {DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum} [keyspace] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseInfoControllerGetDatabaseOverview(id: string, riDbIndex?: number, keyspace?: DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseInfoControllerGetDatabaseOverview(id, riDbIndex, keyspace, options).then((request) => request(axios, basePath)); + }, + /** + * Get Redis database config info + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseInfoControllerGetInfo(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseInfoControllerGetInfo(id, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DatabaseInstancesApi - object-oriented interface + * @export + * @class DatabaseInstancesApi + * @extends {BaseAPI} + */ +export class DatabaseInstancesApi extends BaseAPI { + /** + * Try to create connection to specified database index + * @summary + * @param {object} index + * @param {string} id + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseInstancesApi + */ + public databaseInfoControllerGetDatabaseIndex(index: object, id: string, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return DatabaseInstancesApiFp(this.configuration).databaseInfoControllerGetDatabaseIndex(index, id, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get Redis database overview + * @summary + * @param {string} id + * @param {number} [riDbIndex] + * @param {DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum} [keyspace] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseInstancesApi + */ + public databaseInfoControllerGetDatabaseOverview(id: string, riDbIndex?: number, keyspace?: DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum, options?: RawAxiosRequestConfig) { + return DatabaseInstancesApiFp(this.configuration).databaseInfoControllerGetDatabaseOverview(id, riDbIndex, keyspace, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get Redis database config info + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseInstancesApi + */ + public databaseInfoControllerGetInfo(id: string, options?: RawAxiosRequestConfig) { + return DatabaseInstancesApiFp(this.configuration).databaseInfoControllerGetInfo(id, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum = { + Full: 'full', + Current: 'current' +} as const; +export type DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum = typeof DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum[keyof typeof DatabaseInfoControllerGetDatabaseOverviewKeyspaceEnum]; + + +/** + * DatabaseRecommendationsApi - axios parameter creator + * @export + */ +export const DatabaseRecommendationsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete many recommendations by ids + * @summary + * @param {string} dbInstance + * @param {DeleteDatabaseRecommendationDto} deleteDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerBulkDeleteDatabaseRecommendation: async (dbInstance: string, deleteDatabaseRecommendationDto: DeleteDatabaseRecommendationDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseRecommendationControllerBulkDeleteDatabaseRecommendation', 'dbInstance', dbInstance) + // verify required parameter 'deleteDatabaseRecommendationDto' is not null or undefined + assertParamExists('databaseRecommendationControllerBulkDeleteDatabaseRecommendation', 'deleteDatabaseRecommendationDto', deleteDatabaseRecommendationDto) + const localVarPath = `/api/databases/{dbInstance}/recommendations` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(deleteDatabaseRecommendationDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get database recommendations + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerList: async (dbInstance: string, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseRecommendationControllerList', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/recommendations` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update database recommendation by id + * @summary + * @param {string} id + * @param {string} dbInstance + * @param {ModifyDatabaseRecommendationDto} modifyDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerModify: async (id: string, dbInstance: string, modifyDatabaseRecommendationDto: ModifyDatabaseRecommendationDto, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('databaseRecommendationControllerModify', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseRecommendationControllerModify', 'dbInstance', dbInstance) + // verify required parameter 'modifyDatabaseRecommendationDto' is not null or undefined + assertParamExists('databaseRecommendationControllerModify', 'modifyDatabaseRecommendationDto', modifyDatabaseRecommendationDto) + const localVarPath = `/api/databases/{dbInstance}/recommendations/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(modifyDatabaseRecommendationDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Mark all database recommendations as read + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerRead: async (dbInstance: string, riDbIndex?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('databaseRecommendationControllerRead', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/recommendations/read` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + if (riDbIndex != null) { + localVarHeaderParameter['ri-db-index'] = typeof riDbIndex === 'string' + ? riDbIndex + : JSON.stringify(riDbIndex); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * DatabaseRecommendationsApi - functional programming interface + * @export + */ +export const DatabaseRecommendationsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = DatabaseRecommendationsApiAxiosParamCreator(configuration) + return { + /** + * Delete many recommendations by ids + * @summary + * @param {string} dbInstance + * @param {DeleteDatabaseRecommendationDto} deleteDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseRecommendationControllerBulkDeleteDatabaseRecommendation(dbInstance: string, deleteDatabaseRecommendationDto: DeleteDatabaseRecommendationDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseRecommendationControllerBulkDeleteDatabaseRecommendation(dbInstance, deleteDatabaseRecommendationDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseRecommendationsApi.databaseRecommendationControllerBulkDeleteDatabaseRecommendation']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get database recommendations + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseRecommendationControllerList(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseRecommendationControllerList(dbInstance, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseRecommendationsApi.databaseRecommendationControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update database recommendation by id + * @summary + * @param {string} id + * @param {string} dbInstance + * @param {ModifyDatabaseRecommendationDto} modifyDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseRecommendationControllerModify(id: string, dbInstance: string, modifyDatabaseRecommendationDto: ModifyDatabaseRecommendationDto, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseRecommendationControllerModify(id, dbInstance, modifyDatabaseRecommendationDto, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseRecommendationsApi.databaseRecommendationControllerModify']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Mark all database recommendations as read + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async databaseRecommendationControllerRead(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.databaseRecommendationControllerRead(dbInstance, riDbIndex, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DatabaseRecommendationsApi.databaseRecommendationControllerRead']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * DatabaseRecommendationsApi - factory interface + * @export + */ +export const DatabaseRecommendationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = DatabaseRecommendationsApiFp(configuration) + return { + /** + * Delete many recommendations by ids + * @summary + * @param {string} dbInstance + * @param {DeleteDatabaseRecommendationDto} deleteDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerBulkDeleteDatabaseRecommendation(dbInstance: string, deleteDatabaseRecommendationDto: DeleteDatabaseRecommendationDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseRecommendationControllerBulkDeleteDatabaseRecommendation(dbInstance, deleteDatabaseRecommendationDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Get database recommendations + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerList(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseRecommendationControllerList(dbInstance, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Update database recommendation by id + * @summary + * @param {string} id + * @param {string} dbInstance + * @param {ModifyDatabaseRecommendationDto} modifyDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerModify(id: string, dbInstance: string, modifyDatabaseRecommendationDto: ModifyDatabaseRecommendationDto, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseRecommendationControllerModify(id, dbInstance, modifyDatabaseRecommendationDto, riDbIndex, options).then((request) => request(axios, basePath)); + }, + /** + * Mark all database recommendations as read + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + databaseRecommendationControllerRead(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.databaseRecommendationControllerRead(dbInstance, riDbIndex, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DatabaseRecommendationsApi - object-oriented interface + * @export + * @class DatabaseRecommendationsApi + * @extends {BaseAPI} + */ +export class DatabaseRecommendationsApi extends BaseAPI { + /** + * Delete many recommendations by ids + * @summary + * @param {string} dbInstance + * @param {DeleteDatabaseRecommendationDto} deleteDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseRecommendationsApi + */ + public databaseRecommendationControllerBulkDeleteDatabaseRecommendation(dbInstance: string, deleteDatabaseRecommendationDto: DeleteDatabaseRecommendationDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return DatabaseRecommendationsApiFp(this.configuration).databaseRecommendationControllerBulkDeleteDatabaseRecommendation(dbInstance, deleteDatabaseRecommendationDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get database recommendations + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseRecommendationsApi + */ + public databaseRecommendationControllerList(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return DatabaseRecommendationsApiFp(this.configuration).databaseRecommendationControllerList(dbInstance, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update database recommendation by id + * @summary + * @param {string} id + * @param {string} dbInstance + * @param {ModifyDatabaseRecommendationDto} modifyDatabaseRecommendationDto + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseRecommendationsApi + */ + public databaseRecommendationControllerModify(id: string, dbInstance: string, modifyDatabaseRecommendationDto: ModifyDatabaseRecommendationDto, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return DatabaseRecommendationsApiFp(this.configuration).databaseRecommendationControllerModify(id, dbInstance, modifyDatabaseRecommendationDto, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Mark all database recommendations as read + * @summary + * @param {string} dbInstance + * @param {number} [riDbIndex] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DatabaseRecommendationsApi + */ + public databaseRecommendationControllerRead(dbInstance: string, riDbIndex?: number, options?: RawAxiosRequestConfig) { + return DatabaseRecommendationsApiFp(this.configuration).databaseRecommendationControllerRead(dbInstance, riDbIndex, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * InfoApi - axios parameter creator + * @export + */ +export const InfoApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get list of features + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + featureControllerList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/features`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + featureControllerSync: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/features/sync`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + healthControllerHealth: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/health`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get list of blocking commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetCliBlockingCommands: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/info/cli-blocking-commands`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get list of unsupported commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetCliUnsupportedCommands: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/info/cli-unsupported-commands`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetInfo: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/info`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * InfoApi - functional programming interface + * @export + */ +export const InfoApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = InfoApiAxiosParamCreator(configuration) + return { + /** + * Get list of features + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async featureControllerList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.featureControllerList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['InfoApi.featureControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async featureControllerSync(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.featureControllerSync(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['InfoApi.featureControllerSync']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async healthControllerHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.healthControllerHealth(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['InfoApi.healthControllerHealth']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get list of blocking commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async serverControllerGetCliBlockingCommands(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.serverControllerGetCliBlockingCommands(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['InfoApi.serverControllerGetCliBlockingCommands']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get list of unsupported commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async serverControllerGetCliUnsupportedCommands(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.serverControllerGetCliUnsupportedCommands(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['InfoApi.serverControllerGetCliUnsupportedCommands']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async serverControllerGetInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.serverControllerGetInfo(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['InfoApi.serverControllerGetInfo']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * InfoApi - factory interface + * @export + */ +export const InfoApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = InfoApiFp(configuration) + return { + /** + * Get list of features + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + featureControllerList(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.featureControllerList(options).then((request) => request(axios, basePath)); + }, + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + featureControllerSync(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.featureControllerSync(options).then((request) => request(axios, basePath)); + }, + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + healthControllerHealth(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.healthControllerHealth(options).then((request) => request(axios, basePath)); + }, + /** + * Get list of blocking commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetCliBlockingCommands(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.serverControllerGetCliBlockingCommands(options).then((request) => request(axios, basePath)); + }, + /** + * Get list of unsupported commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetCliUnsupportedCommands(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.serverControllerGetCliUnsupportedCommands(options).then((request) => request(axios, basePath)); + }, + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + serverControllerGetInfo(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.serverControllerGetInfo(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * InfoApi - object-oriented interface + * @export + * @class InfoApi + * @extends {BaseAPI} + */ +export class InfoApi extends BaseAPI { + /** + * Get list of features + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InfoApi + */ + public featureControllerList(options?: RawAxiosRequestConfig) { + return InfoApiFp(this.configuration).featureControllerList(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InfoApi + */ + public featureControllerSync(options?: RawAxiosRequestConfig) { + return InfoApiFp(this.configuration).featureControllerSync(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InfoApi + */ + public healthControllerHealth(options?: RawAxiosRequestConfig) { + return InfoApiFp(this.configuration).healthControllerHealth(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get list of blocking commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InfoApi + */ + public serverControllerGetCliBlockingCommands(options?: RawAxiosRequestConfig) { + return InfoApiFp(this.configuration).serverControllerGetCliBlockingCommands(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get list of unsupported commands in CLI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InfoApi + */ + public serverControllerGetCliUnsupportedCommands(options?: RawAxiosRequestConfig) { + return InfoApiFp(this.configuration).serverControllerGetCliUnsupportedCommands(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get server info + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof InfoApi + */ + public serverControllerGetInfo(options?: RawAxiosRequestConfig) { + return InfoApiFp(this.configuration).serverControllerGetInfo(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * NotificationsApi - axios parameter creator + * @export + */ +export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Return ordered notifications history + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notificationControllerGetNotifications: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/notifications`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Mark all notifications as read + * @summary + * @param {ReadNotificationsDto} readNotificationsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notificationControllerReadNotifications: async (readNotificationsDto: ReadNotificationsDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'readNotificationsDto' is not null or undefined + assertParamExists('notificationControllerReadNotifications', 'readNotificationsDto', readNotificationsDto) + const localVarPath = `/api/notifications/read`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(readNotificationsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * NotificationsApi - functional programming interface + * @export + */ +export const NotificationsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration) + return { + /** + * Return ordered notifications history + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async notificationControllerGetNotifications(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.notificationControllerGetNotifications(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsApi.notificationControllerGetNotifications']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Mark all notifications as read + * @summary + * @param {ReadNotificationsDto} readNotificationsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async notificationControllerReadNotifications(readNotificationsDto: ReadNotificationsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.notificationControllerReadNotifications(readNotificationsDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['NotificationsApi.notificationControllerReadNotifications']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * NotificationsApi - factory interface + * @export + */ +export const NotificationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = NotificationsApiFp(configuration) + return { + /** + * Return ordered notifications history + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notificationControllerGetNotifications(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.notificationControllerGetNotifications(options).then((request) => request(axios, basePath)); + }, + /** + * Mark all notifications as read + * @summary + * @param {ReadNotificationsDto} readNotificationsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + notificationControllerReadNotifications(readNotificationsDto: ReadNotificationsDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.notificationControllerReadNotifications(readNotificationsDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * NotificationsApi - object-oriented interface + * @export + * @class NotificationsApi + * @extends {BaseAPI} + */ +export class NotificationsApi extends BaseAPI { + /** + * Return ordered notifications history + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsApi + */ + public notificationControllerGetNotifications(options?: RawAxiosRequestConfig) { + return NotificationsApiFp(this.configuration).notificationControllerGetNotifications(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Mark all notifications as read + * @summary + * @param {ReadNotificationsDto} readNotificationsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof NotificationsApi + */ + public notificationControllerReadNotifications(readNotificationsDto: ReadNotificationsDto, options?: RawAxiosRequestConfig) { + return NotificationsApiFp(this.configuration).notificationControllerReadNotifications(readNotificationsDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * PluginsApi - axios parameter creator + * @export + */ +export const PluginsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get list of available plugins + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginControllerGetAll: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/plugins`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get Redis whitelist commands available for plugins + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerGetPluginCommands: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('pluginsControllerGetPluginCommands', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/plugins/commands` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get previously saved state + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerGetState: async (visualizationId: string, id: string, dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'visualizationId' is not null or undefined + assertParamExists('pluginsControllerGetState', 'visualizationId', visualizationId) + // verify required parameter 'id' is not null or undefined + assertParamExists('pluginsControllerGetState', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('pluginsControllerGetState', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/plugins/{visualizationId}/command-executions/{id}/state` + .replace(`{${"visualizationId"}}`, encodeURIComponent(String(visualizationId))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Save plugin state for particular command execution + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {CreatePluginStateDto} createPluginStateDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerSaveState: async (visualizationId: string, id: string, dbInstance: string, createPluginStateDto: CreatePluginStateDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'visualizationId' is not null or undefined + assertParamExists('pluginsControllerSaveState', 'visualizationId', visualizationId) + // verify required parameter 'id' is not null or undefined + assertParamExists('pluginsControllerSaveState', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('pluginsControllerSaveState', 'dbInstance', dbInstance) + // verify required parameter 'createPluginStateDto' is not null or undefined + assertParamExists('pluginsControllerSaveState', 'createPluginStateDto', createPluginStateDto) + const localVarPath = `/api/databases/{dbInstance}/plugins/{visualizationId}/command-executions/{id}/state` + .replace(`{${"visualizationId"}}`, encodeURIComponent(String(visualizationId))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createPluginStateDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Send Redis Command from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionDto} createCommandExecutionDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerSendCommand: async (dbInstance: string, createCommandExecutionDto: CreateCommandExecutionDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('pluginsControllerSendCommand', 'dbInstance', dbInstance) + // verify required parameter 'createCommandExecutionDto' is not null or undefined + assertParamExists('pluginsControllerSendCommand', 'createCommandExecutionDto', createCommandExecutionDto) + const localVarPath = `/api/databases/{dbInstance}/plugins/command-executions` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createCommandExecutionDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * PluginsApi - functional programming interface + * @export + */ +export const PluginsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PluginsApiAxiosParamCreator(configuration) + return { + /** + * Get list of available plugins + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async pluginControllerGetAll(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pluginControllerGetAll(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.pluginControllerGetAll']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get Redis whitelist commands available for plugins + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async pluginsControllerGetPluginCommands(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pluginsControllerGetPluginCommands(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.pluginsControllerGetPluginCommands']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get previously saved state + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async pluginsControllerGetState(visualizationId: string, id: string, dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pluginsControllerGetState(visualizationId, id, dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.pluginsControllerGetState']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Save plugin state for particular command execution + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {CreatePluginStateDto} createPluginStateDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async pluginsControllerSaveState(visualizationId: string, id: string, dbInstance: string, createPluginStateDto: CreatePluginStateDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pluginsControllerSaveState(visualizationId, id, dbInstance, createPluginStateDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.pluginsControllerSaveState']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Send Redis Command from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionDto} createCommandExecutionDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async pluginsControllerSendCommand(dbInstance: string, createCommandExecutionDto: CreateCommandExecutionDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pluginsControllerSendCommand(dbInstance, createCommandExecutionDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PluginsApi.pluginsControllerSendCommand']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PluginsApi - factory interface + * @export + */ +export const PluginsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PluginsApiFp(configuration) + return { + /** + * Get list of available plugins + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginControllerGetAll(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pluginControllerGetAll(options).then((request) => request(axios, basePath)); + }, + /** + * Get Redis whitelist commands available for plugins + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerGetPluginCommands(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.pluginsControllerGetPluginCommands(dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * Get previously saved state + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerGetState(visualizationId: string, id: string, dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pluginsControllerGetState(visualizationId, id, dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * Save plugin state for particular command execution + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {CreatePluginStateDto} createPluginStateDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerSaveState(visualizationId: string, id: string, dbInstance: string, createPluginStateDto: CreatePluginStateDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pluginsControllerSaveState(visualizationId, id, dbInstance, createPluginStateDto, options).then((request) => request(axios, basePath)); + }, + /** + * Send Redis Command from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionDto} createCommandExecutionDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pluginsControllerSendCommand(dbInstance: string, createCommandExecutionDto: CreateCommandExecutionDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pluginsControllerSendCommand(dbInstance, createCommandExecutionDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * PluginsApi - object-oriented interface + * @export + * @class PluginsApi + * @extends {BaseAPI} + */ +export class PluginsApi extends BaseAPI { + /** + * Get list of available plugins + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public pluginControllerGetAll(options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).pluginControllerGetAll(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get Redis whitelist commands available for plugins + * @summary + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public pluginsControllerGetPluginCommands(dbInstance: string, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).pluginsControllerGetPluginCommands(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get previously saved state + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public pluginsControllerGetState(visualizationId: string, id: string, dbInstance: string, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).pluginsControllerGetState(visualizationId, id, dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Save plugin state for particular command execution + * @summary + * @param {string} visualizationId + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {CreatePluginStateDto} createPluginStateDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public pluginsControllerSaveState(visualizationId: string, id: string, dbInstance: string, createPluginStateDto: CreatePluginStateDto, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).pluginsControllerSaveState(visualizationId, id, dbInstance, createPluginStateDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Send Redis Command from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionDto} createCommandExecutionDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PluginsApi + */ + public pluginsControllerSendCommand(dbInstance: string, createCommandExecutionDto: CreateCommandExecutionDto, options?: RawAxiosRequestConfig) { + return PluginsApiFp(this.configuration).pluginsControllerSendCommand(dbInstance, createCommandExecutionDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * ProfilerApi - axios parameter creator + * @export + */ +export const ProfilerApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Endpoint do download profiler log file + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + profilerControllerDownloadLogsFile: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('profilerControllerDownloadLogsFile', 'id', id) + const localVarPath = `/api/profiler/logs/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * ProfilerApi - functional programming interface + * @export + */ +export const ProfilerApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ProfilerApiAxiosParamCreator(configuration) + return { + /** + * Endpoint do download profiler log file + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async profilerControllerDownloadLogsFile(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.profilerControllerDownloadLogsFile(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['ProfilerApi.profilerControllerDownloadLogsFile']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * ProfilerApi - factory interface + * @export + */ +export const ProfilerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ProfilerApiFp(configuration) + return { + /** + * Endpoint do download profiler log file + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + profilerControllerDownloadLogsFile(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.profilerControllerDownloadLogsFile(id, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * ProfilerApi - object-oriented interface + * @export + * @class ProfilerApi + * @extends {BaseAPI} + */ +export class ProfilerApi extends BaseAPI { + /** + * Endpoint do download profiler log file + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ProfilerApi + */ + public profilerControllerDownloadLogsFile(id: string, options?: RawAxiosRequestConfig) { + return ProfilerApiFp(this.configuration).profilerControllerDownloadLogsFile(id, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * PubSubApi - axios parameter creator + * @export + */ +export const PubSubApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Publish message to a channel + * @summary + * @param {string} dbInstance + * @param {PublishDto} publishDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pubSubControllerPublish: async (dbInstance: string, publishDto: PublishDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('pubSubControllerPublish', 'dbInstance', dbInstance) + // verify required parameter 'publishDto' is not null or undefined + assertParamExists('pubSubControllerPublish', 'publishDto', publishDto) + const localVarPath = `/api/databases/{dbInstance}/pub-sub/messages` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(publishDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * PubSubApi - functional programming interface + * @export + */ +export const PubSubApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = PubSubApiAxiosParamCreator(configuration) + return { + /** + * Publish message to a channel + * @summary + * @param {string} dbInstance + * @param {PublishDto} publishDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async pubSubControllerPublish(dbInstance: string, publishDto: PublishDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.pubSubControllerPublish(dbInstance, publishDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['PubSubApi.pubSubControllerPublish']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * PubSubApi - factory interface + * @export + */ +export const PubSubApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = PubSubApiFp(configuration) + return { + /** + * Publish message to a channel + * @summary + * @param {string} dbInstance + * @param {PublishDto} publishDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + pubSubControllerPublish(dbInstance: string, publishDto: PublishDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.pubSubControllerPublish(dbInstance, publishDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * PubSubApi - object-oriented interface + * @export + * @class PubSubApi + * @extends {BaseAPI} + */ +export class PubSubApi extends BaseAPI { + /** + * Publish message to a channel + * @summary + * @param {string} dbInstance + * @param {PublishDto} publishDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PubSubApi + */ + public pubSubControllerPublish(dbInstance: string, publishDto: PublishDto, options?: RawAxiosRequestConfig) { + return PubSubApiFp(this.configuration).pubSubControllerPublish(dbInstance, publishDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * RDIApi - axios parameter creator + * @export + */ +export const RDIApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Connect to RDI + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerConnect: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiControllerConnect', 'id', id) + const localVarPath = `/api/rdi/{id}/connect` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Create RDI + * @summary + * @param {CreateRdiDto} createRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerCreate: async (createRdiDto: CreateRdiDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createRdiDto' is not null or undefined + assertParamExists('rdiControllerCreate', 'createRdiDto', createRdiDto) + const localVarPath = `/api/rdi`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createRdiDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete RDI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerDelete: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/rdi`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get RDI by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerGet: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiControllerGet', 'id', id) + const localVarPath = `/api/rdi/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get RDI list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/rdi`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update RDI + * @summary + * @param {string} id + * @param {UpdateRdiDto} updateRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerUpdate: async (id: string, updateRdiDto: UpdateRdiDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiControllerUpdate', 'id', id) + // verify required parameter 'updateRdiDto' is not null or undefined + assertParamExists('rdiControllerUpdate', 'updateRdiDto', updateRdiDto) + const localVarPath = `/api/rdi/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateRdiDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Deploy the pipeline + * @summary + * @param {string} id + * @param {object} body + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerDeploy: async (id: string, body: object, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerDeploy', 'id', id) + // verify required parameter 'body' is not null or undefined + assertParamExists('rdiPipelineControllerDeploy', 'body', body) + const localVarPath = `/api/rdi/{id}/pipeline/deploy` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Dry run job + * @summary + * @param {string} id + * @param {RdiDryRunJobDto} rdiDryRunJobDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerDryRunJob: async (id: string, rdiDryRunJobDto: RdiDryRunJobDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerDryRunJob', 'id', id) + // verify required parameter 'rdiDryRunJobDto' is not null or undefined + assertParamExists('rdiPipelineControllerDryRunJob', 'rdiDryRunJobDto', rdiDryRunJobDto) + const localVarPath = `/api/rdi/{id}/pipeline/dry-run-job` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(rdiDryRunJobDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get config template for selected pipeline and db types + * @summary + * @param {string} pipelineType + * @param {string} dbType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetConfigTemplate: async (pipelineType: string, dbType: string, id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pipelineType' is not null or undefined + assertParamExists('rdiPipelineControllerGetConfigTemplate', 'pipelineType', pipelineType) + // verify required parameter 'dbType' is not null or undefined + assertParamExists('rdiPipelineControllerGetConfigTemplate', 'dbType', dbType) + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetConfigTemplate', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/config/template/{pipelineType}/{dbType}` + .replace(`{${"pipelineType"}}`, encodeURIComponent(String(pipelineType))) + .replace(`{${"dbType"}}`, encodeURIComponent(String(dbType))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get job functions + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetJobFunctions: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetJobFunctions', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/job-functions` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get job template for selected pipeline type + * @summary + * @param {string} pipelineType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetJobTemplate: async (pipelineType: string, id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'pipelineType' is not null or undefined + assertParamExists('rdiPipelineControllerGetJobTemplate', 'pipelineType', pipelineType) + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetJobTemplate', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/job/template/{pipelineType}` + .replace(`{${"pipelineType"}}`, encodeURIComponent(String(pipelineType))) + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetPipeline: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetPipeline', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get pipeline status + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetPipelineStatus: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetPipelineStatus', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/status` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get pipeline schema + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetSchema: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetSchema', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/schema` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get pipeline strategies and db types for template + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetStrategies: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerGetStrategies', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/strategies` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Resets default pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerResetPipeline: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerResetPipeline', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/reset` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Starts the stopped pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerStartPipeline: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerStartPipeline', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/start` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Stops running pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerStopPipeline: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerStopPipeline', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/stop` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Test target connections + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerTestConnections: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiPipelineControllerTestConnections', 'id', id) + const localVarPath = `/api/rdi/{id}/pipeline/test-connections` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get statistics + * @summary + * @param {string} id + * @param {string} [sections] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiStatisticsControllerGetStatistics: async (id: string, sections?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('rdiStatisticsControllerGetStatistics', 'id', id) + const localVarPath = `/api/rdi/{id}/statistics` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (sections !== undefined) { + localVarQueryParameter['sections'] = sections; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * RDIApi - functional programming interface + * @export + */ +export const RDIApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RDIApiAxiosParamCreator(configuration) + return { + /** + * Connect to RDI + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiControllerConnect(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiControllerConnect(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiControllerConnect']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Create RDI + * @summary + * @param {CreateRdiDto} createRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiControllerCreate(createRdiDto: CreateRdiDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiControllerCreate(createRdiDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete RDI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiControllerDelete(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiControllerDelete(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get RDI by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiControllerGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiControllerGet(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiControllerGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get RDI list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiControllerList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiControllerList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update RDI + * @summary + * @param {string} id + * @param {UpdateRdiDto} updateRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiControllerUpdate(id: string, updateRdiDto: UpdateRdiDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiControllerUpdate(id, updateRdiDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiControllerUpdate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Deploy the pipeline + * @summary + * @param {string} id + * @param {object} body + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerDeploy(id: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerDeploy(id, body, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerDeploy']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Dry run job + * @summary + * @param {string} id + * @param {RdiDryRunJobDto} rdiDryRunJobDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerDryRunJob(id: string, rdiDryRunJobDto: RdiDryRunJobDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerDryRunJob(id, rdiDryRunJobDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerDryRunJob']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get config template for selected pipeline and db types + * @summary + * @param {string} pipelineType + * @param {string} dbType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetConfigTemplate(pipelineType: string, dbType: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetConfigTemplate(pipelineType, dbType, id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetConfigTemplate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get job functions + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetJobFunctions(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetJobFunctions(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetJobFunctions']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get job template for selected pipeline type + * @summary + * @param {string} pipelineType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetJobTemplate(pipelineType: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetJobTemplate(pipelineType, id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetJobTemplate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetPipeline(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetPipeline(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetPipeline']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get pipeline status + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetPipelineStatus(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetPipelineStatus(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetPipelineStatus']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get pipeline schema + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetSchema(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetSchema(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetSchema']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get pipeline strategies and db types for template + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerGetStrategies(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerGetStrategies(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerGetStrategies']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Resets default pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerResetPipeline(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerResetPipeline(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerResetPipeline']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Starts the stopped pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerStartPipeline(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerStartPipeline(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerStartPipeline']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Stops running pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerStopPipeline(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerStopPipeline(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerStopPipeline']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Test target connections + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiPipelineControllerTestConnections(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiPipelineControllerTestConnections(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiPipelineControllerTestConnections']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get statistics + * @summary + * @param {string} id + * @param {string} [sections] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async rdiStatisticsControllerGetStatistics(id: string, sections?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.rdiStatisticsControllerGetStatistics(id, sections, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RDIApi.rdiStatisticsControllerGetStatistics']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RDIApi - factory interface + * @export + */ +export const RDIApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RDIApiFp(configuration) + return { + /** + * Connect to RDI + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerConnect(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiControllerConnect(id, options).then((request) => request(axios, basePath)); + }, + /** + * Create RDI + * @summary + * @param {CreateRdiDto} createRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerCreate(createRdiDto: CreateRdiDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiControllerCreate(createRdiDto, options).then((request) => request(axios, basePath)); + }, + /** + * Delete RDI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerDelete(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiControllerDelete(options).then((request) => request(axios, basePath)); + }, + /** + * Get RDI by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiControllerGet(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get RDI list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.rdiControllerList(options).then((request) => request(axios, basePath)); + }, + /** + * Update RDI + * @summary + * @param {string} id + * @param {UpdateRdiDto} updateRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiControllerUpdate(id: string, updateRdiDto: UpdateRdiDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiControllerUpdate(id, updateRdiDto, options).then((request) => request(axios, basePath)); + }, + /** + * Deploy the pipeline + * @summary + * @param {string} id + * @param {object} body + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerDeploy(id: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerDeploy(id, body, options).then((request) => request(axios, basePath)); + }, + /** + * Dry run job + * @summary + * @param {string} id + * @param {RdiDryRunJobDto} rdiDryRunJobDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerDryRunJob(id: string, rdiDryRunJobDto: RdiDryRunJobDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerDryRunJob(id, rdiDryRunJobDto, options).then((request) => request(axios, basePath)); + }, + /** + * Get config template for selected pipeline and db types + * @summary + * @param {string} pipelineType + * @param {string} dbType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetConfigTemplate(pipelineType: string, dbType: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetConfigTemplate(pipelineType, dbType, id, options).then((request) => request(axios, basePath)); + }, + /** + * Get job functions + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetJobFunctions(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetJobFunctions(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get job template for selected pipeline type + * @summary + * @param {string} pipelineType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetJobTemplate(pipelineType: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetJobTemplate(pipelineType, id, options).then((request) => request(axios, basePath)); + }, + /** + * Get pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetPipeline(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetPipeline(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get pipeline status + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetPipelineStatus(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetPipelineStatus(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get pipeline schema + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetSchema(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetSchema(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get pipeline strategies and db types for template + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerGetStrategies(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerGetStrategies(id, options).then((request) => request(axios, basePath)); + }, + /** + * Resets default pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerResetPipeline(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerResetPipeline(id, options).then((request) => request(axios, basePath)); + }, + /** + * Starts the stopped pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerStartPipeline(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerStartPipeline(id, options).then((request) => request(axios, basePath)); + }, + /** + * Stops running pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerStopPipeline(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerStopPipeline(id, options).then((request) => request(axios, basePath)); + }, + /** + * Test target connections + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiPipelineControllerTestConnections(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiPipelineControllerTestConnections(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get statistics + * @summary + * @param {string} id + * @param {string} [sections] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + rdiStatisticsControllerGetStatistics(id: string, sections?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.rdiStatisticsControllerGetStatistics(id, sections, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * RDIApi - object-oriented interface + * @export + * @class RDIApi + * @extends {BaseAPI} + */ +export class RDIApi extends BaseAPI { + /** + * Connect to RDI + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiControllerConnect(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiControllerConnect(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Create RDI + * @summary + * @param {CreateRdiDto} createRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiControllerCreate(createRdiDto: CreateRdiDto, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiControllerCreate(createRdiDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete RDI + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiControllerDelete(options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiControllerDelete(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get RDI by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiControllerGet(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiControllerGet(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get RDI list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiControllerList(options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiControllerList(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update RDI + * @summary + * @param {string} id + * @param {UpdateRdiDto} updateRdiDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiControllerUpdate(id: string, updateRdiDto: UpdateRdiDto, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiControllerUpdate(id, updateRdiDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Deploy the pipeline + * @summary + * @param {string} id + * @param {object} body + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerDeploy(id: string, body: object, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerDeploy(id, body, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Dry run job + * @summary + * @param {string} id + * @param {RdiDryRunJobDto} rdiDryRunJobDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerDryRunJob(id: string, rdiDryRunJobDto: RdiDryRunJobDto, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerDryRunJob(id, rdiDryRunJobDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get config template for selected pipeline and db types + * @summary + * @param {string} pipelineType + * @param {string} dbType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetConfigTemplate(pipelineType: string, dbType: string, id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetConfigTemplate(pipelineType, dbType, id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get job functions + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetJobFunctions(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetJobFunctions(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get job template for selected pipeline type + * @summary + * @param {string} pipelineType + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetJobTemplate(pipelineType: string, id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetJobTemplate(pipelineType, id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetPipeline(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetPipeline(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get pipeline status + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetPipelineStatus(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetPipelineStatus(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get pipeline schema + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetSchema(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetSchema(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get pipeline strategies and db types for template + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerGetStrategies(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerGetStrategies(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Resets default pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerResetPipeline(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerResetPipeline(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Starts the stopped pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerStartPipeline(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerStartPipeline(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Stops running pipeline + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerStopPipeline(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerStopPipeline(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Test target connections + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiPipelineControllerTestConnections(id: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiPipelineControllerTestConnections(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get statistics + * @summary + * @param {string} id + * @param {string} [sections] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RDIApi + */ + public rdiStatisticsControllerGetStatistics(id: string, sections?: string, options?: RawAxiosRequestConfig) { + return RDIApiFp(this.configuration).rdiStatisticsControllerGetStatistics(id, sections, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * RedisEnterpriseClusterApi - axios parameter creator + * @export + */ +export const RedisEnterpriseClusterApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add databases from Redis Enterprise cluster + * @summary + * @param {AddRedisEnterpriseDatabasesDto} addRedisEnterpriseDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisEnterpriseControllerAddRedisEnterpriseDatabases: async (addRedisEnterpriseDatabasesDto: AddRedisEnterpriseDatabasesDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'addRedisEnterpriseDatabasesDto' is not null or undefined + assertParamExists('redisEnterpriseControllerAddRedisEnterpriseDatabases', 'addRedisEnterpriseDatabasesDto', addRedisEnterpriseDatabasesDto) + const localVarPath = `/api/redis-enterprise/cluster/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(addRedisEnterpriseDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get all databases in the cluster. + * @summary + * @param {ClusterConnectionDetailsDto} clusterConnectionDetailsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisEnterpriseControllerGetDatabases: async (clusterConnectionDetailsDto: ClusterConnectionDetailsDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'clusterConnectionDetailsDto' is not null or undefined + assertParamExists('redisEnterpriseControllerGetDatabases', 'clusterConnectionDetailsDto', clusterConnectionDetailsDto) + const localVarPath = `/api/redis-enterprise/cluster/get-databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(clusterConnectionDetailsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * RedisEnterpriseClusterApi - functional programming interface + * @export + */ +export const RedisEnterpriseClusterApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RedisEnterpriseClusterApiAxiosParamCreator(configuration) + return { + /** + * Add databases from Redis Enterprise cluster + * @summary + * @param {AddRedisEnterpriseDatabasesDto} addRedisEnterpriseDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto: AddRedisEnterpriseDatabasesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RedisEnterpriseClusterApi.redisEnterpriseControllerAddRedisEnterpriseDatabases']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get all databases in the cluster. + * @summary + * @param {ClusterConnectionDetailsDto} clusterConnectionDetailsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto: ClusterConnectionDetailsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RedisEnterpriseClusterApi.redisEnterpriseControllerGetDatabases']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RedisEnterpriseClusterApi - factory interface + * @export + */ +export const RedisEnterpriseClusterApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RedisEnterpriseClusterApiFp(configuration) + return { + /** + * Add databases from Redis Enterprise cluster + * @summary + * @param {AddRedisEnterpriseDatabasesDto} addRedisEnterpriseDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto: AddRedisEnterpriseDatabasesDto, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto, options).then((request) => request(axios, basePath)); + }, + /** + * Get all databases in the cluster. + * @summary + * @param {ClusterConnectionDetailsDto} clusterConnectionDetailsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto: ClusterConnectionDetailsDto, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * RedisEnterpriseClusterApi - object-oriented interface + * @export + * @class RedisEnterpriseClusterApi + * @extends {BaseAPI} + */ +export class RedisEnterpriseClusterApi extends BaseAPI { + /** + * Add databases from Redis Enterprise cluster + * @summary + * @param {AddRedisEnterpriseDatabasesDto} addRedisEnterpriseDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RedisEnterpriseClusterApi + */ + public redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto: AddRedisEnterpriseDatabasesDto, options?: RawAxiosRequestConfig) { + return RedisEnterpriseClusterApiFp(this.configuration).redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get all databases in the cluster. + * @summary + * @param {ClusterConnectionDetailsDto} clusterConnectionDetailsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RedisEnterpriseClusterApi + */ + public redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto: ClusterConnectionDetailsDto, options?: RawAxiosRequestConfig) { + return RedisEnterpriseClusterApiFp(this.configuration).redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * RedisOSSSentinelApi - axios parameter creator + * @export + */ +export const RedisOSSSentinelApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Add masters from Redis Sentinel + * @summary + * @param {CreateSentinelDatabasesDto} createSentinelDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisSentinelControllerAddSentinelMasters: async (createSentinelDatabasesDto: CreateSentinelDatabasesDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createSentinelDatabasesDto' is not null or undefined + assertParamExists('redisSentinelControllerAddSentinelMasters', 'createSentinelDatabasesDto', createSentinelDatabasesDto) + const localVarPath = `/api/redis-sentinel/databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createSentinelDatabasesDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get master groups + * @summary + * @param {DiscoverSentinelMastersDto} discoverSentinelMastersDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisSentinelControllerGetMasters: async (discoverSentinelMastersDto: DiscoverSentinelMastersDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'discoverSentinelMastersDto' is not null or undefined + assertParamExists('redisSentinelControllerGetMasters', 'discoverSentinelMastersDto', discoverSentinelMastersDto) + const localVarPath = `/api/redis-sentinel/get-databases`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(discoverSentinelMastersDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * RedisOSSSentinelApi - functional programming interface + * @export + */ +export const RedisOSSSentinelApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = RedisOSSSentinelApiAxiosParamCreator(configuration) + return { + /** + * Add masters from Redis Sentinel + * @summary + * @param {CreateSentinelDatabasesDto} createSentinelDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto: CreateSentinelDatabasesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RedisOSSSentinelApi.redisSentinelControllerAddSentinelMasters']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get master groups + * @summary + * @param {DiscoverSentinelMastersDto} discoverSentinelMastersDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async redisSentinelControllerGetMasters(discoverSentinelMastersDto: DiscoverSentinelMastersDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.redisSentinelControllerGetMasters(discoverSentinelMastersDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['RedisOSSSentinelApi.redisSentinelControllerGetMasters']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * RedisOSSSentinelApi - factory interface + * @export + */ +export const RedisOSSSentinelApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = RedisOSSSentinelApiFp(configuration) + return { + /** + * Add masters from Redis Sentinel + * @summary + * @param {CreateSentinelDatabasesDto} createSentinelDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto: CreateSentinelDatabasesDto, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto, options).then((request) => request(axios, basePath)); + }, + /** + * Get master groups + * @summary + * @param {DiscoverSentinelMastersDto} discoverSentinelMastersDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + redisSentinelControllerGetMasters(discoverSentinelMastersDto: DiscoverSentinelMastersDto, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.redisSentinelControllerGetMasters(discoverSentinelMastersDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * RedisOSSSentinelApi - object-oriented interface + * @export + * @class RedisOSSSentinelApi + * @extends {BaseAPI} + */ +export class RedisOSSSentinelApi extends BaseAPI { + /** + * Add masters from Redis Sentinel + * @summary + * @param {CreateSentinelDatabasesDto} createSentinelDatabasesDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RedisOSSSentinelApi + */ + public redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto: CreateSentinelDatabasesDto, options?: RawAxiosRequestConfig) { + return RedisOSSSentinelApiFp(this.configuration).redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get master groups + * @summary + * @param {DiscoverSentinelMastersDto} discoverSentinelMastersDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof RedisOSSSentinelApi + */ + public redisSentinelControllerGetMasters(discoverSentinelMastersDto: DiscoverSentinelMastersDto, options?: RawAxiosRequestConfig) { + return RedisOSSSentinelApiFp(this.configuration).redisSentinelControllerGetMasters(discoverSentinelMastersDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * SettingsApi - axios parameter creator + * @export + */ +export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get json with agreements specification + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + settingsControllerGetAgreementsSpec: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/settings/agreements/spec`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get info about application settings + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + settingsControllerGetAppSettings: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/settings`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update user application settings and agreements + * @summary + * @param {UpdateSettingsDto} updateSettingsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + settingsControllerUpdate: async (updateSettingsDto: UpdateSettingsDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'updateSettingsDto' is not null or undefined + assertParamExists('settingsControllerUpdate', 'updateSettingsDto', updateSettingsDto) + const localVarPath = `/api/settings`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateSettingsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * SettingsApi - functional programming interface + * @export + */ +export const SettingsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration) + return { + /** + * Get json with agreements specification + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async settingsControllerGetAgreementsSpec(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.settingsControllerGetAgreementsSpec(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SettingsApi.settingsControllerGetAgreementsSpec']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get info about application settings + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async settingsControllerGetAppSettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.settingsControllerGetAppSettings(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SettingsApi.settingsControllerGetAppSettings']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update user application settings and agreements + * @summary + * @param {UpdateSettingsDto} updateSettingsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async settingsControllerUpdate(updateSettingsDto: UpdateSettingsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.settingsControllerUpdate(updateSettingsDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SettingsApi.settingsControllerUpdate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SettingsApi - factory interface + * @export + */ +export const SettingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SettingsApiFp(configuration) + return { + /** + * Get json with agreements specification + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + settingsControllerGetAgreementsSpec(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.settingsControllerGetAgreementsSpec(options).then((request) => request(axios, basePath)); + }, + /** + * Get info about application settings + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + settingsControllerGetAppSettings(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.settingsControllerGetAppSettings(options).then((request) => request(axios, basePath)); + }, + /** + * Update user application settings and agreements + * @summary + * @param {UpdateSettingsDto} updateSettingsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + settingsControllerUpdate(updateSettingsDto: UpdateSettingsDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.settingsControllerUpdate(updateSettingsDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * SettingsApi - object-oriented interface + * @export + * @class SettingsApi + * @extends {BaseAPI} + */ +export class SettingsApi extends BaseAPI { + /** + * Get json with agreements specification + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SettingsApi + */ + public settingsControllerGetAgreementsSpec(options?: RawAxiosRequestConfig) { + return SettingsApiFp(this.configuration).settingsControllerGetAgreementsSpec(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get info about application settings + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SettingsApi + */ + public settingsControllerGetAppSettings(options?: RawAxiosRequestConfig) { + return SettingsApiFp(this.configuration).settingsControllerGetAppSettings(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update user application settings and agreements + * @summary + * @param {UpdateSettingsDto} updateSettingsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SettingsApi + */ + public settingsControllerUpdate(updateSettingsDto: UpdateSettingsDto, options?: RawAxiosRequestConfig) { + return SettingsApiFp(this.configuration).settingsControllerUpdate(updateSettingsDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * SlowLogsApi - axios parameter creator + * @export + */ +export const SlowLogsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get slowlog config + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerGetConfig: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('slowLogControllerGetConfig', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/slow-logs/config` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * List of slow logs + * @summary + * @param {string} dbInstance + * @param {number} [count] Specifying the number of slow logs to fetch per node. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerGetSlowLogs: async (dbInstance: string, count?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('slowLogControllerGetSlowLogs', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/slow-logs` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (count !== undefined) { + localVarQueryParameter['count'] = count; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Clear slow logs + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerResetSlowLogs: async (dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('slowLogControllerResetSlowLogs', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/slow-logs` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update slowlog config + * @summary + * @param {string} dbInstance + * @param {UpdateSlowLogConfigDto} updateSlowLogConfigDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerUpdateConfig: async (dbInstance: string, updateSlowLogConfigDto: UpdateSlowLogConfigDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('slowLogControllerUpdateConfig', 'dbInstance', dbInstance) + // verify required parameter 'updateSlowLogConfigDto' is not null or undefined + assertParamExists('slowLogControllerUpdateConfig', 'updateSlowLogConfigDto', updateSlowLogConfigDto) + const localVarPath = `/api/databases/{dbInstance}/slow-logs/config` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateSlowLogConfigDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * SlowLogsApi - functional programming interface + * @export + */ +export const SlowLogsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = SlowLogsApiAxiosParamCreator(configuration) + return { + /** + * Get slowlog config + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async slowLogControllerGetConfig(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.slowLogControllerGetConfig(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SlowLogsApi.slowLogControllerGetConfig']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List of slow logs + * @summary + * @param {string} dbInstance + * @param {number} [count] Specifying the number of slow logs to fetch per node. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async slowLogControllerGetSlowLogs(dbInstance: string, count?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.slowLogControllerGetSlowLogs(dbInstance, count, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SlowLogsApi.slowLogControllerGetSlowLogs']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Clear slow logs + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async slowLogControllerResetSlowLogs(dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.slowLogControllerResetSlowLogs(dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SlowLogsApi.slowLogControllerResetSlowLogs']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update slowlog config + * @summary + * @param {string} dbInstance + * @param {UpdateSlowLogConfigDto} updateSlowLogConfigDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async slowLogControllerUpdateConfig(dbInstance: string, updateSlowLogConfigDto: UpdateSlowLogConfigDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.slowLogControllerUpdateConfig(dbInstance, updateSlowLogConfigDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['SlowLogsApi.slowLogControllerUpdateConfig']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * SlowLogsApi - factory interface + * @export + */ +export const SlowLogsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = SlowLogsApiFp(configuration) + return { + /** + * Get slowlog config + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerGetConfig(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.slowLogControllerGetConfig(dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * List of slow logs + * @summary + * @param {string} dbInstance + * @param {number} [count] Specifying the number of slow logs to fetch per node. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerGetSlowLogs(dbInstance: string, count?: number, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.slowLogControllerGetSlowLogs(dbInstance, count, options).then((request) => request(axios, basePath)); + }, + /** + * Clear slow logs + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerResetSlowLogs(dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.slowLogControllerResetSlowLogs(dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * Update slowlog config + * @summary + * @param {string} dbInstance + * @param {UpdateSlowLogConfigDto} updateSlowLogConfigDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + slowLogControllerUpdateConfig(dbInstance: string, updateSlowLogConfigDto: UpdateSlowLogConfigDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.slowLogControllerUpdateConfig(dbInstance, updateSlowLogConfigDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * SlowLogsApi - object-oriented interface + * @export + * @class SlowLogsApi + * @extends {BaseAPI} + */ +export class SlowLogsApi extends BaseAPI { + /** + * Get slowlog config + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SlowLogsApi + */ + public slowLogControllerGetConfig(dbInstance: string, options?: RawAxiosRequestConfig) { + return SlowLogsApiFp(this.configuration).slowLogControllerGetConfig(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * List of slow logs + * @summary + * @param {string} dbInstance + * @param {number} [count] Specifying the number of slow logs to fetch per node. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SlowLogsApi + */ + public slowLogControllerGetSlowLogs(dbInstance: string, count?: number, options?: RawAxiosRequestConfig) { + return SlowLogsApiFp(this.configuration).slowLogControllerGetSlowLogs(dbInstance, count, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Clear slow logs + * @summary + * @param {string} dbInstance + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SlowLogsApi + */ + public slowLogControllerResetSlowLogs(dbInstance: string, options?: RawAxiosRequestConfig) { + return SlowLogsApiFp(this.configuration).slowLogControllerResetSlowLogs(dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update slowlog config + * @summary + * @param {string} dbInstance + * @param {UpdateSlowLogConfigDto} updateSlowLogConfigDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SlowLogsApi + */ + public slowLogControllerUpdateConfig(dbInstance: string, updateSlowLogConfigDto: UpdateSlowLogConfigDto, options?: RawAxiosRequestConfig) { + return SlowLogsApiFp(this.configuration).slowLogControllerUpdateConfig(dbInstance, updateSlowLogConfigDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * TAGSApi - axios parameter creator + * @export + */ +export const TAGSApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create tag + * @summary + * @param {CreateTagDto} createTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerCreate: async (createTagDto: CreateTagDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'createTagDto' is not null or undefined + assertParamExists('tagControllerCreate', 'createTagDto', createTagDto) + const localVarPath = `/api/tags`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createTagDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete tag + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerDelete: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('tagControllerDelete', 'id', id) + const localVarPath = `/api/tags/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get tag by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerGet: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('tagControllerGet', 'id', id) + const localVarPath = `/api/tags/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get tags list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/tags`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Update tag + * @summary + * @param {string} id + * @param {UpdateTagDto} updateTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerUpdate: async (id: string, updateTagDto: UpdateTagDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('tagControllerUpdate', 'id', id) + // verify required parameter 'updateTagDto' is not null or undefined + assertParamExists('tagControllerUpdate', 'updateTagDto', updateTagDto) + const localVarPath = `/api/tags/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(updateTagDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * TAGSApi - functional programming interface + * @export + */ +export const TAGSApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TAGSApiAxiosParamCreator(configuration) + return { + /** + * Create tag + * @summary + * @param {CreateTagDto} createTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async tagControllerCreate(createTagDto: CreateTagDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.tagControllerCreate(createTagDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TAGSApi.tagControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete tag + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async tagControllerDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.tagControllerDelete(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TAGSApi.tagControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get tag by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async tagControllerGet(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.tagControllerGet(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TAGSApi.tagControllerGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get tags list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async tagControllerList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.tagControllerList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TAGSApi.tagControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Update tag + * @summary + * @param {string} id + * @param {UpdateTagDto} updateTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async tagControllerUpdate(id: string, updateTagDto: UpdateTagDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.tagControllerUpdate(id, updateTagDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TAGSApi.tagControllerUpdate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TAGSApi - factory interface + * @export + */ +export const TAGSApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TAGSApiFp(configuration) + return { + /** + * Create tag + * @summary + * @param {CreateTagDto} createTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerCreate(createTagDto: CreateTagDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.tagControllerCreate(createTagDto, options).then((request) => request(axios, basePath)); + }, + /** + * Delete tag + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.tagControllerDelete(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get tag by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerGet(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.tagControllerGet(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get tags list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.tagControllerList(options).then((request) => request(axios, basePath)); + }, + /** + * Update tag + * @summary + * @param {string} id + * @param {UpdateTagDto} updateTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + tagControllerUpdate(id: string, updateTagDto: UpdateTagDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.tagControllerUpdate(id, updateTagDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * TAGSApi - object-oriented interface + * @export + * @class TAGSApi + * @extends {BaseAPI} + */ +export class TAGSApi extends BaseAPI { + /** + * Create tag + * @summary + * @param {CreateTagDto} createTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TAGSApi + */ + public tagControllerCreate(createTagDto: CreateTagDto, options?: RawAxiosRequestConfig) { + return TAGSApiFp(this.configuration).tagControllerCreate(createTagDto, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete tag + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TAGSApi + */ + public tagControllerDelete(id: string, options?: RawAxiosRequestConfig) { + return TAGSApiFp(this.configuration).tagControllerDelete(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get tag by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TAGSApi + */ + public tagControllerGet(id: string, options?: RawAxiosRequestConfig) { + return TAGSApiFp(this.configuration).tagControllerGet(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get tags list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TAGSApi + */ + public tagControllerList(options?: RawAxiosRequestConfig) { + return TAGSApiFp(this.configuration).tagControllerList(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Update tag + * @summary + * @param {string} id + * @param {UpdateTagDto} updateTagDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TAGSApi + */ + public tagControllerUpdate(id: string, updateTagDto: UpdateTagDto, options?: RawAxiosRequestConfig) { + return TAGSApiFp(this.configuration).tagControllerUpdate(id, updateTagDto, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * TLSCertificatesApi - axios parameter creator + * @export + */ +export const TLSCertificatesApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete Ca Certificate by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + caCertificateControllerDelete: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('caCertificateControllerDelete', 'id', id) + const localVarPath = `/api/certificates/ca/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get Ca Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + caCertificateControllerList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/certificates/ca`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete Client Certificate pair by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + clientCertificateControllerDeleteClientCertificatePair: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('clientCertificateControllerDeleteClientCertificatePair', 'id', id) + const localVarPath = `/api/certificates/client/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get Client Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + clientCertificateControllerGetClientCertList: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/certificates/client`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * TLSCertificatesApi - functional programming interface + * @export + */ +export const TLSCertificatesApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TLSCertificatesApiAxiosParamCreator(configuration) + return { + /** + * Delete Ca Certificate by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async caCertificateControllerDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.caCertificateControllerDelete(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TLSCertificatesApi.caCertificateControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get Ca Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async caCertificateControllerList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.caCertificateControllerList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TLSCertificatesApi.caCertificateControllerList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete Client Certificate pair by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async clientCertificateControllerDeleteClientCertificatePair(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.clientCertificateControllerDeleteClientCertificatePair(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TLSCertificatesApi.clientCertificateControllerDeleteClientCertificatePair']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get Client Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async clientCertificateControllerGetClientCertList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.clientCertificateControllerGetClientCertList(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TLSCertificatesApi.clientCertificateControllerGetClientCertList']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TLSCertificatesApi - factory interface + * @export + */ +export const TLSCertificatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TLSCertificatesApiFp(configuration) + return { + /** + * Delete Ca Certificate by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + caCertificateControllerDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.caCertificateControllerDelete(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get Ca Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + caCertificateControllerList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.caCertificateControllerList(options).then((request) => request(axios, basePath)); + }, + /** + * Delete Client Certificate pair by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + clientCertificateControllerDeleteClientCertificatePair(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.clientCertificateControllerDeleteClientCertificatePair(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get Client Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + clientCertificateControllerGetClientCertList(options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.clientCertificateControllerGetClientCertList(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * TLSCertificatesApi - object-oriented interface + * @export + * @class TLSCertificatesApi + * @extends {BaseAPI} + */ +export class TLSCertificatesApi extends BaseAPI { + /** + * Delete Ca Certificate by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TLSCertificatesApi + */ + public caCertificateControllerDelete(id: string, options?: RawAxiosRequestConfig) { + return TLSCertificatesApiFp(this.configuration).caCertificateControllerDelete(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get Ca Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TLSCertificatesApi + */ + public caCertificateControllerList(options?: RawAxiosRequestConfig) { + return TLSCertificatesApiFp(this.configuration).caCertificateControllerList(options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete Client Certificate pair by id + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TLSCertificatesApi + */ + public clientCertificateControllerDeleteClientCertificatePair(id: string, options?: RawAxiosRequestConfig) { + return TLSCertificatesApiFp(this.configuration).clientCertificateControllerDeleteClientCertificatePair(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get Client Certificate list + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TLSCertificatesApi + */ + public clientCertificateControllerGetClientCertList(options?: RawAxiosRequestConfig) { + return TLSCertificatesApiFp(this.configuration).clientCertificateControllerGetClientCertList(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * TutorialsApi - axios parameter creator + * @export + */ +export const TutorialsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Create new tutorial + * @summary + * @param {File} [file] ZIP archive with tutorial static files + * @param {string} [link] External link to zip archive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + customTutorialControllerCreate: async (file?: File, link?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/custom-tutorials`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + + if (file !== undefined) { + localVarFormParams.append('file', file as any); + } + + if (link !== undefined) { + localVarFormParams.append('link', link as any); + } + + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete custom tutorial and its files + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + customTutorialControllerDelete: async (id: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('customTutorialControllerDelete', 'id', id) + const localVarPath = `/api/custom-tutorials/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get global manifest for custom tutorials + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + customTutorialControllerGetGlobalManifest: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/api/custom-tutorials/manifest`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * TutorialsApi - functional programming interface + * @export + */ +export const TutorialsApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = TutorialsApiAxiosParamCreator(configuration) + return { + /** + * Create new tutorial + * @summary + * @param {File} [file] ZIP archive with tutorial static files + * @param {string} [link] External link to zip archive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async customTutorialControllerCreate(file?: File, link?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.customTutorialControllerCreate(file, link, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TutorialsApi.customTutorialControllerCreate']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete custom tutorial and its files + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async customTutorialControllerDelete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.customTutorialControllerDelete(id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TutorialsApi.customTutorialControllerDelete']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get global manifest for custom tutorials + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async customTutorialControllerGetGlobalManifest(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.customTutorialControllerGetGlobalManifest(options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['TutorialsApi.customTutorialControllerGetGlobalManifest']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * TutorialsApi - factory interface + * @export + */ +export const TutorialsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = TutorialsApiFp(configuration) + return { + /** + * Create new tutorial + * @summary + * @param {File} [file] ZIP archive with tutorial static files + * @param {string} [link] External link to zip archive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + customTutorialControllerCreate(file?: File, link?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.customTutorialControllerCreate(file, link, options).then((request) => request(axios, basePath)); + }, + /** + * Delete custom tutorial and its files + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + customTutorialControllerDelete(id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.customTutorialControllerDelete(id, options).then((request) => request(axios, basePath)); + }, + /** + * Get global manifest for custom tutorials + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + customTutorialControllerGetGlobalManifest(options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.customTutorialControllerGetGlobalManifest(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * TutorialsApi - object-oriented interface + * @export + * @class TutorialsApi + * @extends {BaseAPI} + */ +export class TutorialsApi extends BaseAPI { + /** + * Create new tutorial + * @summary + * @param {File} [file] ZIP archive with tutorial static files + * @param {string} [link] External link to zip archive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TutorialsApi + */ + public customTutorialControllerCreate(file?: File, link?: string, options?: RawAxiosRequestConfig) { + return TutorialsApiFp(this.configuration).customTutorialControllerCreate(file, link, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete custom tutorial and its files + * @summary + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TutorialsApi + */ + public customTutorialControllerDelete(id: string, options?: RawAxiosRequestConfig) { + return TutorialsApiFp(this.configuration).customTutorialControllerDelete(id, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get global manifest for custom tutorials + * @summary + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TutorialsApi + */ + public customTutorialControllerGetGlobalManifest(options?: RawAxiosRequestConfig) { + return TutorialsApiFp(this.configuration).customTutorialControllerGetGlobalManifest(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * WorkbenchApi - axios parameter creator + * @export + */ +export const WorkbenchApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Delete command execution + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerDeleteCommandExecution: async (id: string, dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('workbenchControllerDeleteCommandExecution', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('workbenchControllerDeleteCommandExecution', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/workbench/command-executions/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {CommandExecutionFilter} commandExecutionFilter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerDeleteCommandExecutions: async (dbInstance: string, commandExecutionFilter: CommandExecutionFilter, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('workbenchControllerDeleteCommandExecutions', 'dbInstance', dbInstance) + // verify required parameter 'commandExecutionFilter' is not null or undefined + assertParamExists('workbenchControllerDeleteCommandExecutions', 'commandExecutionFilter', commandExecutionFilter) + const localVarPath = `/api/databases/{dbInstance}/workbench/command-executions` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(commandExecutionFilter, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get command execution details + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerGetCommandExecution: async (id: string, dbInstance: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('workbenchControllerGetCommandExecution', 'id', id) + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('workbenchControllerGetCommandExecution', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/workbench/command-executions/{id}` + .replace(`{${"id"}}`, encodeURIComponent(String(id))) + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * List of command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {WorkbenchControllerListCommandExecutionsTypeEnum} [type] Command execution type. Used to distinguish between search and workbench + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerListCommandExecutions: async (dbInstance: string, type?: WorkbenchControllerListCommandExecutionsTypeEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('workbenchControllerListCommandExecutions', 'dbInstance', dbInstance) + const localVarPath = `/api/databases/{dbInstance}/workbench/command-executions` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Send Redis Batch Commands from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionsDto} createCommandExecutionsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerSendCommands: async (dbInstance: string, createCommandExecutionsDto: CreateCommandExecutionsDto, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'dbInstance' is not null or undefined + assertParamExists('workbenchControllerSendCommands', 'dbInstance', dbInstance) + // verify required parameter 'createCommandExecutionsDto' is not null or undefined + assertParamExists('workbenchControllerSendCommands', 'createCommandExecutionsDto', createCommandExecutionsDto) + const localVarPath = `/api/databases/{dbInstance}/workbench/command-executions` + .replace(`{${"dbInstance"}}`, encodeURIComponent(String(dbInstance))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(createCommandExecutionsDto, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * WorkbenchApi - functional programming interface + * @export + */ +export const WorkbenchApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = WorkbenchApiAxiosParamCreator(configuration) + return { + /** + * Delete command execution + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async workbenchControllerDeleteCommandExecution(id: string, dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.workbenchControllerDeleteCommandExecution(id, dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkbenchApi.workbenchControllerDeleteCommandExecution']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Delete command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {CommandExecutionFilter} commandExecutionFilter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async workbenchControllerDeleteCommandExecutions(dbInstance: string, commandExecutionFilter: CommandExecutionFilter, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.workbenchControllerDeleteCommandExecutions(dbInstance, commandExecutionFilter, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkbenchApi.workbenchControllerDeleteCommandExecutions']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Get command execution details + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async workbenchControllerGetCommandExecution(id: string, dbInstance: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.workbenchControllerGetCommandExecution(id, dbInstance, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkbenchApi.workbenchControllerGetCommandExecution']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * List of command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {WorkbenchControllerListCommandExecutionsTypeEnum} [type] Command execution type. Used to distinguish between search and workbench + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async workbenchControllerListCommandExecutions(dbInstance: string, type?: WorkbenchControllerListCommandExecutionsTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.workbenchControllerListCommandExecutions(dbInstance, type, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkbenchApi.workbenchControllerListCommandExecutions']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Send Redis Batch Commands from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionsDto} createCommandExecutionsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async workbenchControllerSendCommands(dbInstance: string, createCommandExecutionsDto: CreateCommandExecutionsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.workbenchControllerSendCommands(dbInstance, createCommandExecutionsDto, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WorkbenchApi.workbenchControllerSendCommands']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * WorkbenchApi - factory interface + * @export + */ +export const WorkbenchApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = WorkbenchApiFp(configuration) + return { + /** + * Delete command execution + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerDeleteCommandExecution(id: string, dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.workbenchControllerDeleteCommandExecution(id, dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * Delete command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {CommandExecutionFilter} commandExecutionFilter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerDeleteCommandExecutions(dbInstance: string, commandExecutionFilter: CommandExecutionFilter, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.workbenchControllerDeleteCommandExecutions(dbInstance, commandExecutionFilter, options).then((request) => request(axios, basePath)); + }, + /** + * Get command execution details + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerGetCommandExecution(id: string, dbInstance: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.workbenchControllerGetCommandExecution(id, dbInstance, options).then((request) => request(axios, basePath)); + }, + /** + * List of command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {WorkbenchControllerListCommandExecutionsTypeEnum} [type] Command execution type. Used to distinguish between search and workbench + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerListCommandExecutions(dbInstance: string, type?: WorkbenchControllerListCommandExecutionsTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.workbenchControllerListCommandExecutions(dbInstance, type, options).then((request) => request(axios, basePath)); + }, + /** + * Send Redis Batch Commands from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionsDto} createCommandExecutionsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + workbenchControllerSendCommands(dbInstance: string, createCommandExecutionsDto: CreateCommandExecutionsDto, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.workbenchControllerSendCommands(dbInstance, createCommandExecutionsDto, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * WorkbenchApi - object-oriented interface + * @export + * @class WorkbenchApi + * @extends {BaseAPI} + */ +export class WorkbenchApi extends BaseAPI { + /** + * Delete command execution + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WorkbenchApi + */ + public workbenchControllerDeleteCommandExecution(id: string, dbInstance: string, options?: RawAxiosRequestConfig) { + return WorkbenchApiFp(this.configuration).workbenchControllerDeleteCommandExecution(id, dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Delete command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {CommandExecutionFilter} commandExecutionFilter + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WorkbenchApi + */ + public workbenchControllerDeleteCommandExecutions(dbInstance: string, commandExecutionFilter: CommandExecutionFilter, options?: RawAxiosRequestConfig) { + return WorkbenchApiFp(this.configuration).workbenchControllerDeleteCommandExecutions(dbInstance, commandExecutionFilter, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Get command execution details + * @summary + * @param {string} id + * @param {string} dbInstance Database instance id. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WorkbenchApi + */ + public workbenchControllerGetCommandExecution(id: string, dbInstance: string, options?: RawAxiosRequestConfig) { + return WorkbenchApiFp(this.configuration).workbenchControllerGetCommandExecution(id, dbInstance, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * List of command executions + * @summary + * @param {string} dbInstance Database instance id. + * @param {WorkbenchControllerListCommandExecutionsTypeEnum} [type] Command execution type. Used to distinguish between search and workbench + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WorkbenchApi + */ + public workbenchControllerListCommandExecutions(dbInstance: string, type?: WorkbenchControllerListCommandExecutionsTypeEnum, options?: RawAxiosRequestConfig) { + return WorkbenchApiFp(this.configuration).workbenchControllerListCommandExecutions(dbInstance, type, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Send Redis Batch Commands from the Workbench + * @summary + * @param {string} dbInstance Database instance id. + * @param {CreateCommandExecutionsDto} createCommandExecutionsDto + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WorkbenchApi + */ + public workbenchControllerSendCommands(dbInstance: string, createCommandExecutionsDto: CreateCommandExecutionsDto, options?: RawAxiosRequestConfig) { + return WorkbenchApiFp(this.configuration).workbenchControllerSendCommands(dbInstance, createCommandExecutionsDto, options).then((request) => request(this.axios, this.basePath)); + } +} + +/** + * @export + */ +export const WorkbenchControllerListCommandExecutionsTypeEnum = { + Workbench: 'WORKBENCH', + Search: 'SEARCH' +} as const; +export type WorkbenchControllerListCommandExecutionsTypeEnum = typeof WorkbenchControllerListCommandExecutionsTypeEnum[keyof typeof WorkbenchControllerListCommandExecutionsTypeEnum]; + + diff --git a/redisinsight/ui/src/api-client/base.ts b/redisinsight/ui/src/api-client/base.ts new file mode 100644 index 0000000000..bc61f39f79 --- /dev/null +++ b/redisinsight/ui/src/api-client/base.ts @@ -0,0 +1,86 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Redis Insight Backend API + * Redis Insight Backend API + * + * The version of the OpenAPI document: 2.70.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from './configuration'; +// Some imports not used depending on template conditions +// @ts-ignore +import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; + +export const BASE_PATH = "http://localhost".replace(/\/+$/, ""); + +/** + * + * @export + */ +export const COLLECTION_FORMATS = { + csv: ",", + ssv: " ", + tsv: "\t", + pipes: "|", +}; + +/** + * + * @export + * @interface RequestArgs + */ +export interface RequestArgs { + url: string; + options: RawAxiosRequestConfig; +} + +/** + * + * @export + * @class BaseAPI + */ +export class BaseAPI { + protected configuration: Configuration | undefined; + + constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) { + if (configuration) { + this.configuration = configuration; + this.basePath = configuration.basePath ?? basePath; + } + } +}; + +/** + * + * @export + * @class RequiredError + * @extends {Error} + */ +export class RequiredError extends Error { + constructor(public field: string, msg?: string) { + super(msg); + this.name = "RequiredError" + } +} + +interface ServerMap { + [key: string]: { + url: string, + description: string, + }[]; +} + +/** + * + * @export + */ +export const operationServerMap: ServerMap = { +} diff --git a/redisinsight/ui/src/api-client/common.ts b/redisinsight/ui/src/api-client/common.ts new file mode 100644 index 0000000000..2b2467c017 --- /dev/null +++ b/redisinsight/ui/src/api-client/common.ts @@ -0,0 +1,150 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Redis Insight Backend API + * Redis Insight Backend API + * + * The version of the OpenAPI document: 2.70.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import type { Configuration } from "./configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; + if (typeof parameter === "object") { + if (Array.isArray(parameter)) { + (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); + } + else { + Object.keys(parameter).forEach(currentKey => + setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) + ); + } + } + else { + if (urlSearchParams.has(key)) { + urlSearchParams.append(key, parameter); + } + else { + urlSearchParams.set(key, parameter); + } + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + setFlattenedQueryParams(searchParams, objects); + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; + return axios.request(axiosRequestArgs); + }; +} diff --git a/redisinsight/ui/src/api-client/configuration.ts b/redisinsight/ui/src/api-client/configuration.ts new file mode 100644 index 0000000000..2c364c7c02 --- /dev/null +++ b/redisinsight/ui/src/api-client/configuration.ts @@ -0,0 +1,115 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Redis Insight Backend API + * Redis Insight Backend API + * + * The version of the OpenAPI document: 2.70.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export interface ConfigurationParameters { + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + username?: string; + password?: string; + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + basePath?: string; + serverIndex?: number; + baseOptions?: any; + formDataCtor?: new () => any; +} + +export class Configuration { + /** + * parameter for apiKey security + * @param name security name + * @memberof Configuration + */ + apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + username?: string; + /** + * parameter for basic security + * + * @type {string} + * @memberof Configuration + */ + password?: string; + /** + * parameter for oauth2 security + * @param name security name + * @param scopes oauth2 scope + * @memberof Configuration + */ + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + /** + * override base path + * + * @type {string} + * @memberof Configuration + */ + basePath?: string; + /** + * override server index + * + * @type {number} + * @memberof Configuration + */ + serverIndex?: number; + /** + * base options for axios calls + * + * @type {any} + * @memberof Configuration + */ + baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; + + constructor(param: ConfigurationParameters = {}) { + this.apiKey = param.apiKey; + this.username = param.username; + this.password = param.password; + this.accessToken = param.accessToken; + this.basePath = param.basePath; + this.serverIndex = param.serverIndex; + this.baseOptions = { + ...param.baseOptions, + headers: { + ...param.baseOptions?.headers, + }, + }; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/redisinsight/ui/src/api-client/docs/AIApi.md b/redisinsight/ui/src/api-client/docs/AIApi.md new file mode 100644 index 0000000000..59cd33631b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AIApi.md @@ -0,0 +1,372 @@ +# AIApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**aiChatControllerCreate**](#aichatcontrollercreate) | **POST** /api/ai/assistant/chats | | +|[**aiChatControllerDelete**](#aichatcontrollerdelete) | **DELETE** /api/ai/assistant/chats/{id} | | +|[**aiChatControllerGetHistory**](#aichatcontrollergethistory) | **GET** /api/ai/assistant/chats/{id} | | +|[**aiChatControllerPostMessage**](#aichatcontrollerpostmessage) | **POST** /api/ai/assistant/chats/{id}/messages | | +|[**aiQueryControllerClearHistory**](#aiquerycontrollerclearhistory) | **DELETE** /api/ai/expert/{id}/messages | | +|[**aiQueryControllerGetHistory**](#aiquerycontrollergethistory) | **GET** /api/ai/expert/{id}/messages | | +|[**aiQueryControllerStreamQuestion**](#aiquerycontrollerstreamquestion) | **POST** /api/ai/expert/{id}/messages | | + +# **aiChatControllerCreate** +> PickTypeClass aiChatControllerCreate() + +Create a new chat + +### Example + +```typescript +import { + AIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +const { status, data } = await apiInstance.aiChatControllerCreate(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**PickTypeClass** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **aiChatControllerDelete** +> aiChatControllerDelete() + +Reset chat + +### Example + +```typescript +import { + AIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.aiChatControllerDelete( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **aiChatControllerGetHistory** +> AiChat aiChatControllerGetHistory() + +Get chat history + +### Example + +```typescript +import { + AIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.aiChatControllerGetHistory( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**AiChat** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **aiChatControllerPostMessage** +> string aiChatControllerPostMessage(sendAiChatMessageDto) + +Post a message + +### Example + +```typescript +import { + AIApi, + Configuration, + SendAiChatMessageDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +let id: string; // (default to undefined) +let sendAiChatMessageDto: SendAiChatMessageDto; // + +const { status, data } = await apiInstance.aiChatControllerPostMessage( + id, + sendAiChatMessageDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sendAiChatMessageDto** | **SendAiChatMessageDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **aiQueryControllerClearHistory** +> string aiQueryControllerClearHistory() + +Generate new query + +### Example + +```typescript +import { + AIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.aiQueryControllerClearHistory( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **aiQueryControllerGetHistory** +> string aiQueryControllerGetHistory() + +Generate new query + +### Example + +```typescript +import { + AIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.aiQueryControllerGetHistory( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **aiQueryControllerStreamQuestion** +> string aiQueryControllerStreamQuestion(sendAiQueryMessageDto) + +Generate new query + +### Example + +```typescript +import { + AIApi, + Configuration, + SendAiQueryMessageDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AIApi(configuration); + +let id: string; // (default to undefined) +let sendAiQueryMessageDto: SendAiQueryMessageDto; // + +const { status, data } = await apiInstance.aiQueryControllerStreamQuestion( + id, + sendAiQueryMessageDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sendAiQueryMessageDto** | **SendAiQueryMessageDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/AckPendingEntriesDto.md b/redisinsight/ui/src/api-client/docs/AckPendingEntriesDto.md new file mode 100644 index 0000000000..8d8bf5fe91 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AckPendingEntriesDto.md @@ -0,0 +1,24 @@ +# AckPendingEntriesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**groupName** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] +**entries** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Entries IDs | [default to undefined] + +## Example + +```typescript +import { AckPendingEntriesDto } from './api'; + +const instance: AckPendingEntriesDto = { + keyName, + groupName, + entries, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AckPendingEntriesResponse.md b/redisinsight/ui/src/api-client/docs/AckPendingEntriesResponse.md new file mode 100644 index 0000000000..85205d409c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AckPendingEntriesResponse.md @@ -0,0 +1,20 @@ +# AckPendingEntriesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected entries | [default to undefined] + +## Example + +```typescript +import { AckPendingEntriesResponse } from './api'; + +const instance: AckPendingEntriesResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddFieldsToHashDto.md b/redisinsight/ui/src/api-client/docs/AddFieldsToHashDto.md new file mode 100644 index 0000000000..77646603fc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddFieldsToHashDto.md @@ -0,0 +1,22 @@ +# AddFieldsToHashDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**fields** | [**Array<HashFieldDto>**](HashFieldDto.md) | Hash fields | [default to undefined] + +## Example + +```typescript +import { AddFieldsToHashDto } from './api'; + +const instance: AddFieldsToHashDto = { + keyName, + fields, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddMembersToSetDto.md b/redisinsight/ui/src/api-client/docs/AddMembersToSetDto.md new file mode 100644 index 0000000000..ab47211089 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddMembersToSetDto.md @@ -0,0 +1,22 @@ +# AddMembersToSetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**members** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Set members | [default to undefined] + +## Example + +```typescript +import { AddMembersToSetDto } from './api'; + +const instance: AddMembersToSetDto = { + keyName, + members, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddMembersToZSetDto.md b/redisinsight/ui/src/api-client/docs/AddMembersToZSetDto.md new file mode 100644 index 0000000000..dd180b1bf1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddMembersToZSetDto.md @@ -0,0 +1,22 @@ +# AddMembersToZSetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**members** | [**Array<ZSetMemberDto>**](ZSetMemberDto.md) | ZSet members | [default to undefined] + +## Example + +```typescript +import { AddMembersToZSetDto } from './api'; + +const instance: AddMembersToZSetDto = { + keyName, + members, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddRedisEnterpriseDatabaseResponse.md b/redisinsight/ui/src/api-client/docs/AddRedisEnterpriseDatabaseResponse.md new file mode 100644 index 0000000000..869a9e0157 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddRedisEnterpriseDatabaseResponse.md @@ -0,0 +1,28 @@ +# AddRedisEnterpriseDatabaseResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uid** | **number** | The unique ID of the database | [default to undefined] +**status** | **string** | Add Redis Enterprise database status | [default to StatusEnum_Success] +**message** | **string** | Message | [default to undefined] +**databaseDetails** | [**RedisEnterpriseDatabase**](RedisEnterpriseDatabase.md) | The database details. | [optional] [default to undefined] +**error** | **object** | Error | [optional] [default to undefined] + +## Example + +```typescript +import { AddRedisEnterpriseDatabaseResponse } from './api'; + +const instance: AddRedisEnterpriseDatabaseResponse = { + uid, + status, + message, + databaseDetails, + error, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddRedisEnterpriseDatabasesDto.md b/redisinsight/ui/src/api-client/docs/AddRedisEnterpriseDatabasesDto.md new file mode 100644 index 0000000000..7a34f37fb4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddRedisEnterpriseDatabasesDto.md @@ -0,0 +1,28 @@ +# AddRedisEnterpriseDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis Enterprise. | [default to 'localhost'] +**port** | **number** | The port your Redis Enterprise cluster is available on. | [default to 9443] +**username** | **string** | The admin e-mail/username | [default to undefined] +**password** | **string** | The admin password | [default to undefined] +**uids** | **Array<number>** | The unique IDs of the databases. | [default to undefined] + +## Example + +```typescript +import { AddRedisEnterpriseDatabasesDto } from './api'; + +const instance: AddRedisEnterpriseDatabasesDto = { + host, + port, + username, + password, + uids, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddStreamEntriesDto.md b/redisinsight/ui/src/api-client/docs/AddStreamEntriesDto.md new file mode 100644 index 0000000000..46a4aa5086 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddStreamEntriesDto.md @@ -0,0 +1,22 @@ +# AddStreamEntriesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**entries** | [**Array<StreamEntryDto>**](StreamEntryDto.md) | Entries to push | [default to undefined] + +## Example + +```typescript +import { AddStreamEntriesDto } from './api'; + +const instance: AddStreamEntriesDto = { + keyName, + entries, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AddStreamEntriesResponse.md b/redisinsight/ui/src/api-client/docs/AddStreamEntriesResponse.md new file mode 100644 index 0000000000..eb90bc983f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AddStreamEntriesResponse.md @@ -0,0 +1,22 @@ +# AddStreamEntriesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**entries** | **Array<string>** | Entries IDs | [default to undefined] + +## Example + +```typescript +import { AddStreamEntriesResponse } from './api'; + +const instance: AddStreamEntriesResponse = { + keyName, + entries, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AdditionalRedisModule.md b/redisinsight/ui/src/api-client/docs/AdditionalRedisModule.md new file mode 100644 index 0000000000..fc5493674f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AdditionalRedisModule.md @@ -0,0 +1,24 @@ +# AdditionalRedisModule + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of the module. | [default to undefined] +**version** | **number** | Integer representation of a module version. | [optional] [default to undefined] +**semanticVersion** | **string** | Semantic versioning representation of a module version. | [optional] [default to undefined] + +## Example + +```typescript +import { AdditionalRedisModule } from './api'; + +const instance: AdditionalRedisModule = { + name, + version, + semanticVersion, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AiChat.md b/redisinsight/ui/src/api-client/docs/AiChat.md new file mode 100644 index 0000000000..a319f1cd13 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AiChat.md @@ -0,0 +1,22 @@ +# AiChat + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**messages** | [**Array<AiChatMessage>**](AiChatMessage.md) | | [default to undefined] + +## Example + +```typescript +import { AiChat } from './api'; + +const instance: AiChat = { + id, + messages, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AiChatMessage.md b/redisinsight/ui/src/api-client/docs/AiChatMessage.md new file mode 100644 index 0000000000..38347a2b45 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AiChatMessage.md @@ -0,0 +1,24 @@ +# AiChatMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**content** | **string** | | [default to undefined] +**context** | **object** | | [default to undefined] + +## Example + +```typescript +import { AiChatMessage } from './api'; + +const instance: AiChatMessage = { + type, + content, + context, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AnalysisProgress.md b/redisinsight/ui/src/api-client/docs/AnalysisProgress.md new file mode 100644 index 0000000000..e5099c0f59 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AnalysisProgress.md @@ -0,0 +1,24 @@ +# AnalysisProgress + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **number** | Total keys in the database | [default to undefined] +**scanned** | **number** | Total keys scanned for entire database | [default to undefined] +**processed** | **number** | Total keys processed for entire database. (Filtered keys returned by scan command) | [default to undefined] + +## Example + +```typescript +import { AnalysisProgress } from './api'; + +const instance: AnalysisProgress = { + total, + scanned, + processed, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/AnalyticsApi.md b/redisinsight/ui/src/api-client/docs/AnalyticsApi.md new file mode 100644 index 0000000000..fb0cd5e5a3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/AnalyticsApi.md @@ -0,0 +1,113 @@ +# AnalyticsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**analyticsControllerSendEvent**](#analyticscontrollersendevent) | **POST** /api/analytics/send-event | | +|[**analyticsControllerSendPage**](#analyticscontrollersendpage) | **POST** /api/analytics/send-page | | + +# **analyticsControllerSendEvent** +> analyticsControllerSendEvent(sendEventDto) + +Send telemetry event + +### Example + +```typescript +import { + AnalyticsApi, + Configuration, + SendEventDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AnalyticsApi(configuration); + +let sendEventDto: SendEventDto; // + +const { status, data } = await apiInstance.analyticsControllerSendEvent( + sendEventDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sendEventDto** | **SendEventDto**| | | + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **analyticsControllerSendPage** +> analyticsControllerSendPage(sendEventDto) + +Send telemetry page + +### Example + +```typescript +import { + AnalyticsApi, + Configuration, + SendEventDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new AnalyticsApi(configuration); + +let sendEventDto: SendEventDto; // + +const { status, data } = await apiInstance.analyticsControllerSendPage( + sendEventDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sendEventDto** | **SendEventDto**| | | + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserBrowserHistoryApi.md b/redisinsight/ui/src/api-client/docs/BrowserBrowserHistoryApi.md new file mode 100644 index 0000000000..8ed5ebd673 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserBrowserHistoryApi.md @@ -0,0 +1,179 @@ +# BrowserBrowserHistoryApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**browserHistoryControllerBulkDelete**](#browserhistorycontrollerbulkdelete) | **DELETE** /api/databases/{dbInstance}/history | | +|[**browserHistoryControllerDelete**](#browserhistorycontrollerdelete) | **DELETE** /api/databases/{dbInstance}/history/{id} | | +|[**browserHistoryControllerList**](#browserhistorycontrollerlist) | **GET** /api/databases/{dbInstance}/history | | + +# **browserHistoryControllerBulkDelete** +> DeleteBrowserHistoryItemsResponse browserHistoryControllerBulkDelete(deleteBrowserHistoryItemsDto) + +Delete bulk browser history items + +### Example + +```typescript +import { + BrowserBrowserHistoryApi, + Configuration, + DeleteBrowserHistoryItemsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserBrowserHistoryApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let mode: string; //Search mode (default to undefined) +let deleteBrowserHistoryItemsDto: DeleteBrowserHistoryItemsDto; // + +const { status, data } = await apiInstance.browserHistoryControllerBulkDelete( + dbInstance, + mode, + deleteBrowserHistoryItemsDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteBrowserHistoryItemsDto** | **DeleteBrowserHistoryItemsDto**| | | +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **mode** | [**string**] | Search mode | defaults to undefined| + + +### Return type + +**DeleteBrowserHistoryItemsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **browserHistoryControllerDelete** +> browserHistoryControllerDelete() + +Delete browser history item by id + +### Example + +```typescript +import { + BrowserBrowserHistoryApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserBrowserHistoryApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let mode: string; //Search mode (default to undefined) +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.browserHistoryControllerDelete( + dbInstance, + mode, + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **mode** | [**string**] | Search mode | defaults to undefined| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **browserHistoryControllerList** +> BrowserHistory browserHistoryControllerList() + +Get browser history + +### Example + +```typescript +import { + BrowserBrowserHistoryApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserBrowserHistoryApi(configuration); + +let dbInstance: string; // (default to undefined) +let mode: 'pattern' | 'redisearch'; // (default to undefined) + +const { status, data } = await apiInstance.browserHistoryControllerList( + dbInstance, + mode +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **mode** | [**'pattern' | 'redisearch'**]**Array<'pattern' | 'redisearch'>** | | defaults to undefined| + + +### Return type + +**BrowserHistory** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserHashApi.md b/redisinsight/ui/src/api-client/docs/BrowserHashApi.md new file mode 100644 index 0000000000..d682c5d3dd --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserHashApi.md @@ -0,0 +1,317 @@ +# BrowserHashApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**hashControllerAddMember**](#hashcontrolleraddmember) | **PUT** /api/databases/{dbInstance}/hash | | +|[**hashControllerCreateHash**](#hashcontrollercreatehash) | **POST** /api/databases/{dbInstance}/hash | | +|[**hashControllerDeleteFields**](#hashcontrollerdeletefields) | **DELETE** /api/databases/{dbInstance}/hash/fields | | +|[**hashControllerGetMembers**](#hashcontrollergetmembers) | **POST** /api/databases/{dbInstance}/hash/get-fields | | +|[**hashControllerUpdateTtl**](#hashcontrollerupdatettl) | **PATCH** /api/databases/{dbInstance}/hash/ttl | | + +# **hashControllerAddMember** +> hashControllerAddMember(addFieldsToHashDto) + +Add the specified fields to the Hash stored at key + +### Example + +```typescript +import { + BrowserHashApi, + Configuration, + AddFieldsToHashDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserHashApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let addFieldsToHashDto: AddFieldsToHashDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.hashControllerAddMember( + dbInstance, + encoding, + addFieldsToHashDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **addFieldsToHashDto** | **AddFieldsToHashDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Fields added to hash successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **hashControllerCreateHash** +> hashControllerCreateHash(createHashWithExpireDto) + +Set key to hold Hash data type + +### Example + +```typescript +import { + BrowserHashApi, + Configuration, + CreateHashWithExpireDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserHashApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let createHashWithExpireDto: CreateHashWithExpireDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.hashControllerCreateHash( + dbInstance, + encoding, + createHashWithExpireDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createHashWithExpireDto** | **CreateHashWithExpireDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Hash key created successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **hashControllerDeleteFields** +> DeleteFieldsFromHashResponse hashControllerDeleteFields(deleteFieldsFromHashDto) + +Remove the specified fields from the Hash stored at key + +### Example + +```typescript +import { + BrowserHashApi, + Configuration, + DeleteFieldsFromHashDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserHashApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let deleteFieldsFromHashDto: DeleteFieldsFromHashDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.hashControllerDeleteFields( + dbInstance, + encoding, + deleteFieldsFromHashDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteFieldsFromHashDto** | **DeleteFieldsFromHashDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteFieldsFromHashResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Fields removed from hash | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **hashControllerGetMembers** +> GetHashFieldsResponse hashControllerGetMembers(getHashFieldsDto) + +Get specified fields of the hash stored at key by cursor position + +### Example + +```typescript +import { + BrowserHashApi, + Configuration, + GetHashFieldsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserHashApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getHashFieldsDto: GetHashFieldsDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.hashControllerGetMembers( + dbInstance, + encoding, + getHashFieldsDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getHashFieldsDto** | **GetHashFieldsDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetHashFieldsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Specified fields of the hash stored at key. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **hashControllerUpdateTtl** +> hashControllerUpdateTtl(updateHashFieldsTtlDto) + +Update hash fields ttl + +### Example + +```typescript +import { + BrowserHashApi, + Configuration, + UpdateHashFieldsTtlDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserHashApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let updateHashFieldsTtlDto: UpdateHashFieldsTtlDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.hashControllerUpdateTtl( + dbInstance, + encoding, + updateHashFieldsTtlDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateHashFieldsTtlDto** | **UpdateHashFieldsTtlDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Hash fields TTL updated successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserHistory.md b/redisinsight/ui/src/api-client/docs/BrowserHistory.md new file mode 100644 index 0000000000..92c13deda5 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserHistory.md @@ -0,0 +1,28 @@ +# BrowserHistory + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | History id | [default to '76dd5654-814b-4e49-9c72-b236f50891f4'] +**databaseId** | **string** | Database id | [default to '76dd5654-814b-4e49-9c72-b236f50891f4'] +**filter** | [**ScanFilter**](ScanFilter.md) | Filters for scan operation | [default to undefined] +**mode** | **string** | Mode of history | [default to ModeEnum_Pattern] +**createdAt** | **string** | History created date (ISO string) | [default to 2022-09-16T06:29:20Z] + +## Example + +```typescript +import { BrowserHistory } from './api'; + +const instance: BrowserHistory = { + id, + databaseId, + filter, + mode, + createdAt, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/BrowserKeysApi.md b/redisinsight/ui/src/api-client/docs/BrowserKeysApi.md new file mode 100644 index 0000000000..8f88765b41 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserKeysApi.md @@ -0,0 +1,379 @@ +# BrowserKeysApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**keysControllerDeleteKey**](#keyscontrollerdeletekey) | **DELETE** /api/databases/{dbInstance}/keys | | +|[**keysControllerGetKeyInfo**](#keyscontrollergetkeyinfo) | **POST** /api/databases/{dbInstance}/keys/get-info | | +|[**keysControllerGetKeys**](#keyscontrollergetkeys) | **POST** /api/databases/{dbInstance}/keys | | +|[**keysControllerGetKeysInfo**](#keyscontrollergetkeysinfo) | **POST** /api/databases/{dbInstance}/keys/get-metadata | | +|[**keysControllerRenameKey**](#keyscontrollerrenamekey) | **PATCH** /api/databases/{dbInstance}/keys/name | | +|[**keysControllerUpdateTtl**](#keyscontrollerupdatettl) | **PATCH** /api/databases/{dbInstance}/keys/ttl | | + +# **keysControllerDeleteKey** +> DeleteKeysResponse keysControllerDeleteKey(deleteKeysDto) + +Delete key + +### Example + +```typescript +import { + BrowserKeysApi, + Configuration, + DeleteKeysDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserKeysApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let deleteKeysDto: DeleteKeysDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.keysControllerDeleteKey( + dbInstance, + encoding, + deleteKeysDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteKeysDto** | **DeleteKeysDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteKeysResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Number of affected keys. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **keysControllerGetKeyInfo** +> GetKeyInfoResponse keysControllerGetKeyInfo(getKeyInfoDto) + +Get key info + +### Example + +```typescript +import { + BrowserKeysApi, + Configuration, + GetKeyInfoDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserKeysApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getKeyInfoDto: GetKeyInfoDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.keysControllerGetKeyInfo( + dbInstance, + encoding, + getKeyInfoDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getKeyInfoDto** | **GetKeyInfoDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetKeyInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Keys info | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **keysControllerGetKeys** +> Array keysControllerGetKeys(getKeysDto) + +Get keys by cursor position + +### Example + +```typescript +import { + BrowserKeysApi, + Configuration, + GetKeysDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserKeysApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getKeysDto: GetKeysDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.keysControllerGetKeys( + dbInstance, + encoding, + getKeysDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getKeysDto** | **GetKeysDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Keys list | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **keysControllerGetKeysInfo** +> Array keysControllerGetKeysInfo(getKeysInfoDto) + +Get info for multiple keys + +### Example + +```typescript +import { + BrowserKeysApi, + Configuration, + GetKeysInfoDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserKeysApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getKeysInfoDto: GetKeysInfoDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.keysControllerGetKeysInfo( + dbInstance, + encoding, + getKeysInfoDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getKeysInfoDto** | **GetKeysInfoDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Info for multiple keys | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **keysControllerRenameKey** +> RenameKeyResponse keysControllerRenameKey(renameKeyDto) + +Rename key + +### Example + +```typescript +import { + BrowserKeysApi, + Configuration, + RenameKeyDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserKeysApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let renameKeyDto: RenameKeyDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.keysControllerRenameKey( + dbInstance, + encoding, + renameKeyDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **renameKeyDto** | **RenameKeyDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**RenameKeyResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | New key name. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **keysControllerUpdateTtl** +> KeyTtlResponse keysControllerUpdateTtl(updateKeyTtlDto) + +Update the remaining time to live of a key + +### Example + +```typescript +import { + BrowserKeysApi, + Configuration, + UpdateKeyTtlDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserKeysApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let updateKeyTtlDto: UpdateKeyTtlDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.keysControllerUpdateTtl( + dbInstance, + encoding, + updateKeyTtlDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateKeyTtlDto** | **UpdateKeyTtlDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**KeyTtlResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | The remaining time to live of a key. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserListApi.md b/redisinsight/ui/src/api-client/docs/BrowserListApi.md new file mode 100644 index 0000000000..6808b894e7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserListApi.md @@ -0,0 +1,382 @@ +# BrowserListApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**listControllerCreateList**](#listcontrollercreatelist) | **POST** /api/databases/{dbInstance}/list | | +|[**listControllerDeleteElement**](#listcontrollerdeleteelement) | **DELETE** /api/databases/{dbInstance}/list/elements | | +|[**listControllerGetElement**](#listcontrollergetelement) | **POST** /api/databases/{dbInstance}/list/get-elements/{index} | | +|[**listControllerGetElements**](#listcontrollergetelements) | **POST** /api/databases/{dbInstance}/list/get-elements | | +|[**listControllerPushElement**](#listcontrollerpushelement) | **PUT** /api/databases/{dbInstance}/list | | +|[**listControllerUpdateElement**](#listcontrollerupdateelement) | **PATCH** /api/databases/{dbInstance}/list | | + +# **listControllerCreateList** +> listControllerCreateList(createListWithExpireDto) + +Set key to hold list data type + +### Example + +```typescript +import { + BrowserListApi, + Configuration, + CreateListWithExpireDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserListApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let createListWithExpireDto: CreateListWithExpireDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.listControllerCreateList( + dbInstance, + encoding, + createListWithExpireDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createListWithExpireDto** | **CreateListWithExpireDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listControllerDeleteElement** +> DeleteListElementsResponse listControllerDeleteElement(deleteListElementsDto) + +Remove and return the elements from the tail/head of list stored at key. + +### Example + +```typescript +import { + BrowserListApi, + Configuration, + DeleteListElementsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserListApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let deleteListElementsDto: DeleteListElementsDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.listControllerDeleteElement( + dbInstance, + encoding, + deleteListElementsDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteListElementsDto** | **DeleteListElementsDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteListElementsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Removed elements. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listControllerGetElement** +> GetListElementResponse listControllerGetElement(keyDto) + +Get specified List element by index + +### Example + +```typescript +import { + BrowserListApi, + Configuration, + KeyDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserListApi(configuration); + +let index: number; //Zero-based index. 0 - first element, 1 - second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element (default to undefined) +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let keyDto: KeyDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.listControllerGetElement( + index, + dbInstance, + encoding, + keyDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **keyDto** | **KeyDto**| | | +| **index** | [**number**] | Zero-based index. 0 - first element, 1 - second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element | defaults to undefined| +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetListElementResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Specified elements of the list stored at key. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listControllerGetElements** +> GetListElementsResponse listControllerGetElements(getListElementsDto) + +Get specified elements of the list stored at key + +### Example + +```typescript +import { + BrowserListApi, + Configuration, + GetListElementsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserListApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getListElementsDto: GetListElementsDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.listControllerGetElements( + dbInstance, + encoding, + getListElementsDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getListElementsDto** | **GetListElementsDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetListElementsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Specified elements of the list stored at key. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listControllerPushElement** +> PushListElementsResponse listControllerPushElement(pushElementToListDto) + +Insert element at the head/tail of the List data type + +### Example + +```typescript +import { + BrowserListApi, + Configuration, + PushElementToListDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserListApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let pushElementToListDto: PushElementToListDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.listControllerPushElement( + dbInstance, + encoding, + pushElementToListDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pushElementToListDto** | **PushElementToListDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**PushListElementsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Length of the list after the push operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listControllerUpdateElement** +> SetListElementResponse listControllerUpdateElement(setListElementDto) + +Update list element by index. + +### Example + +```typescript +import { + BrowserListApi, + Configuration, + SetListElementDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserListApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let setListElementDto: SetListElementDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.listControllerUpdateElement( + dbInstance, + encoding, + setListElementDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **setListElementDto** | **SetListElementDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**SetListElementResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated list element. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserREJSONRLApi.md b/redisinsight/ui/src/api-client/docs/BrowserREJSONRLApi.md new file mode 100644 index 0000000000..d7fafbd155 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserREJSONRLApi.md @@ -0,0 +1,302 @@ +# BrowserREJSONRLApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**rejsonRlControllerArrAppend**](#rejsonrlcontrollerarrappend) | **PATCH** /api/databases/{dbInstance}/rejson-rl/arrappend | | +|[**rejsonRlControllerCreateJson**](#rejsonrlcontrollercreatejson) | **POST** /api/databases/{dbInstance}/rejson-rl | | +|[**rejsonRlControllerGetJson**](#rejsonrlcontrollergetjson) | **POST** /api/databases/{dbInstance}/rejson-rl/get | | +|[**rejsonRlControllerJsonSet**](#rejsonrlcontrollerjsonset) | **PATCH** /api/databases/{dbInstance}/rejson-rl/set | | +|[**rejsonRlControllerRemove**](#rejsonrlcontrollerremove) | **DELETE** /api/databases/{dbInstance}/rejson-rl | | + +# **rejsonRlControllerArrAppend** +> rejsonRlControllerArrAppend(modifyRejsonRlArrAppendDto) + +Append item inside REJSON-RL array + +### Example + +```typescript +import { + BrowserREJSONRLApi, + Configuration, + ModifyRejsonRlArrAppendDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserREJSONRLApi(configuration); + +let dbInstance: string; // (default to undefined) +let modifyRejsonRlArrAppendDto: ModifyRejsonRlArrAppendDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.rejsonRlControllerArrAppend( + dbInstance, + modifyRejsonRlArrAppendDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **modifyRejsonRlArrAppendDto** | **ModifyRejsonRlArrAppendDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rejsonRlControllerCreateJson** +> rejsonRlControllerCreateJson(createRejsonRlWithExpireDto) + +Create new REJSON-RL data type + +### Example + +```typescript +import { + BrowserREJSONRLApi, + Configuration, + CreateRejsonRlWithExpireDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserREJSONRLApi(configuration); + +let dbInstance: string; // (default to undefined) +let createRejsonRlWithExpireDto: CreateRejsonRlWithExpireDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.rejsonRlControllerCreateJson( + dbInstance, + createRejsonRlWithExpireDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createRejsonRlWithExpireDto** | **CreateRejsonRlWithExpireDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rejsonRlControllerGetJson** +> GetRejsonRlResponseDto rejsonRlControllerGetJson(getRejsonRlDto) + +Get json properties by path + +### Example + +```typescript +import { + BrowserREJSONRLApi, + Configuration, + GetRejsonRlDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserREJSONRLApi(configuration); + +let dbInstance: string; // (default to undefined) +let getRejsonRlDto: GetRejsonRlDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.rejsonRlControllerGetJson( + dbInstance, + getRejsonRlDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getRejsonRlDto** | **GetRejsonRlDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetRejsonRlResponseDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Download full data by path or returns description of data inside | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rejsonRlControllerJsonSet** +> rejsonRlControllerJsonSet(modifyRejsonRlSetDto) + +Modify REJSON-RL data type by path + +### Example + +```typescript +import { + BrowserREJSONRLApi, + Configuration, + ModifyRejsonRlSetDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserREJSONRLApi(configuration); + +let dbInstance: string; // (default to undefined) +let modifyRejsonRlSetDto: ModifyRejsonRlSetDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.rejsonRlControllerJsonSet( + dbInstance, + modifyRejsonRlSetDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **modifyRejsonRlSetDto** | **ModifyRejsonRlSetDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rejsonRlControllerRemove** +> RemoveRejsonRlResponse rejsonRlControllerRemove(removeRejsonRlDto) + +Removes path in the REJSON-RL + +### Example + +```typescript +import { + BrowserREJSONRLApi, + Configuration, + RemoveRejsonRlDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserREJSONRLApi(configuration); + +let dbInstance: string; // (default to undefined) +let removeRejsonRlDto: RemoveRejsonRlDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.rejsonRlControllerRemove( + dbInstance, + removeRejsonRlDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **removeRejsonRlDto** | **RemoveRejsonRlDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**RemoveRejsonRlResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserRediSearchApi.md b/redisinsight/ui/src/api-client/docs/BrowserRediSearchApi.md new file mode 100644 index 0000000000..e9a577f38b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserRediSearchApi.md @@ -0,0 +1,245 @@ +# BrowserRediSearchApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**redisearchControllerCreateIndex**](#redisearchcontrollercreateindex) | **POST** /api/databases/{dbInstance}/redisearch | | +|[**redisearchControllerInfo**](#redisearchcontrollerinfo) | **POST** /api/databases/{dbInstance}/redisearch/info | | +|[**redisearchControllerList**](#redisearchcontrollerlist) | **GET** /api/databases/{dbInstance}/redisearch | | +|[**redisearchControllerSearch**](#redisearchcontrollersearch) | **POST** /api/databases/{dbInstance}/redisearch/search | | + +# **redisearchControllerCreateIndex** +> redisearchControllerCreateIndex(createRedisearchIndexDto) + +Create redisearch index + +### Example + +```typescript +import { + BrowserRediSearchApi, + Configuration, + CreateRedisearchIndexDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserRediSearchApi(configuration); + +let dbInstance: string; // (default to undefined) +let createRedisearchIndexDto: CreateRedisearchIndexDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.redisearchControllerCreateIndex( + dbInstance, + createRedisearchIndexDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createRedisearchIndexDto** | **CreateRedisearchIndexDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **redisearchControllerInfo** +> IndexInfoDto redisearchControllerInfo(indexInfoRequestBodyDto) + +Get index info + +### Example + +```typescript +import { + BrowserRediSearchApi, + Configuration, + IndexInfoRequestBodyDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserRediSearchApi(configuration); + +let dbInstance: string; // (default to undefined) +let indexInfoRequestBodyDto: IndexInfoRequestBodyDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.redisearchControllerInfo( + dbInstance, + indexInfoRequestBodyDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **indexInfoRequestBodyDto** | **IndexInfoRequestBodyDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**IndexInfoDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **redisearchControllerList** +> ListRedisearchIndexesResponse redisearchControllerList() + +Get list of available indexes + +### Example + +```typescript +import { + BrowserRediSearchApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserRediSearchApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.redisearchControllerList( + dbInstance, + encoding, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**ListRedisearchIndexesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **redisearchControllerSearch** +> GetKeysWithDetailsResponse redisearchControllerSearch(searchRedisearchDto) + +Search for keys in index + +### Example + +```typescript +import { + BrowserRediSearchApi, + Configuration, + SearchRedisearchDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserRediSearchApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let searchRedisearchDto: SearchRedisearchDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.redisearchControllerSearch( + dbInstance, + encoding, + searchRedisearchDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **searchRedisearchDto** | **SearchRedisearchDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetKeysWithDetailsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserSetApi.md b/redisinsight/ui/src/api-client/docs/BrowserSetApi.md new file mode 100644 index 0000000000..fab488844f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserSetApi.md @@ -0,0 +1,255 @@ +# BrowserSetApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**setControllerAddMembers**](#setcontrolleraddmembers) | **PUT** /api/databases/{dbInstance}/set | | +|[**setControllerCreateSet**](#setcontrollercreateset) | **POST** /api/databases/{dbInstance}/set | | +|[**setControllerDeleteMembers**](#setcontrollerdeletemembers) | **DELETE** /api/databases/{dbInstance}/set/members | | +|[**setControllerGetMembers**](#setcontrollergetmembers) | **POST** /api/databases/{dbInstance}/set/get-members | | + +# **setControllerAddMembers** +> setControllerAddMembers(addMembersToSetDto) + +Add the specified members to the Set stored at key + +### Example + +```typescript +import { + BrowserSetApi, + Configuration, + AddMembersToSetDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let addMembersToSetDto: AddMembersToSetDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.setControllerAddMembers( + dbInstance, + encoding, + addMembersToSetDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **addMembersToSetDto** | **AddMembersToSetDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Members added to set successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setControllerCreateSet** +> setControllerCreateSet(createSetWithExpireDto) + +Set key to hold Set data type + +### Example + +```typescript +import { + BrowserSetApi, + Configuration, + CreateSetWithExpireDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let createSetWithExpireDto: CreateSetWithExpireDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.setControllerCreateSet( + dbInstance, + encoding, + createSetWithExpireDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createSetWithExpireDto** | **CreateSetWithExpireDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Set key created successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setControllerDeleteMembers** +> DeleteMembersFromSetResponse setControllerDeleteMembers(deleteMembersFromSetDto) + +Remove the specified members from the Set stored at key + +### Example + +```typescript +import { + BrowserSetApi, + Configuration, + DeleteMembersFromSetDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let deleteMembersFromSetDto: DeleteMembersFromSetDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.setControllerDeleteMembers( + dbInstance, + encoding, + deleteMembersFromSetDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteMembersFromSetDto** | **DeleteMembersFromSetDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteMembersFromSetResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Members removed from set | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setControllerGetMembers** +> GetSetMembersResponse setControllerGetMembers(getSetMembersDto) + +Get specified members of the set stored at key by cursor position + +### Example + +```typescript +import { + BrowserSetApi, + Configuration, + GetSetMembersDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getSetMembersDto: GetSetMembersDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.setControllerGetMembers( + dbInstance, + encoding, + getSetMembersDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getSetMembersDto** | **GetSetMembersDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetSetMembersResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Specified members of the set stored at key. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserStreamsApi.md b/redisinsight/ui/src/api-client/docs/BrowserStreamsApi.md new file mode 100644 index 0000000000..a62f44ff84 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserStreamsApi.md @@ -0,0 +1,789 @@ +# BrowserStreamsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**consumerControllerAckPendingEntries**](#consumercontrollerackpendingentries) | **POST** /api/databases/{dbInstance}/streams/consumer-groups/consumers/pending-messages/ack | | +|[**consumerControllerClaimPendingEntries**](#consumercontrollerclaimpendingentries) | **POST** /api/databases/{dbInstance}/streams/consumer-groups/consumers/pending-messages/claim | | +|[**consumerControllerDeleteConsumers**](#consumercontrollerdeleteconsumers) | **DELETE** /api/databases/{dbInstance}/streams/consumer-groups/consumers | | +|[**consumerControllerGetConsumers**](#consumercontrollergetconsumers) | **POST** /api/databases/{dbInstance}/streams/consumer-groups/consumers/get | | +|[**consumerControllerGetPendingEntries**](#consumercontrollergetpendingentries) | **POST** /api/databases/{dbInstance}/streams/consumer-groups/consumers/pending-messages/get | | +|[**consumerGroupControllerCreateGroups**](#consumergroupcontrollercreategroups) | **POST** /api/databases/{dbInstance}/streams/consumer-groups | | +|[**consumerGroupControllerDeleteGroup**](#consumergroupcontrollerdeletegroup) | **DELETE** /api/databases/{dbInstance}/streams/consumer-groups | | +|[**consumerGroupControllerGetGroups**](#consumergroupcontrollergetgroups) | **POST** /api/databases/{dbInstance}/streams/consumer-groups/get | | +|[**consumerGroupControllerUpdateGroup**](#consumergroupcontrollerupdategroup) | **PATCH** /api/databases/{dbInstance}/streams/consumer-groups | | +|[**streamControllerAddEntries**](#streamcontrolleraddentries) | **POST** /api/databases/{dbInstance}/streams/entries | | +|[**streamControllerCreateStream**](#streamcontrollercreatestream) | **POST** /api/databases/{dbInstance}/streams | | +|[**streamControllerDeleteEntries**](#streamcontrollerdeleteentries) | **DELETE** /api/databases/{dbInstance}/streams/entries | | +|[**streamControllerGetEntries**](#streamcontrollergetentries) | **POST** /api/databases/{dbInstance}/streams/entries/get | | + +# **consumerControllerAckPendingEntries** +> AckPendingEntriesResponse consumerControllerAckPendingEntries(ackPendingEntriesDto) + +Ack pending entries + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + AckPendingEntriesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let ackPendingEntriesDto: AckPendingEntriesDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerControllerAckPendingEntries( + dbInstance, + ackPendingEntriesDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **ackPendingEntriesDto** | **AckPendingEntriesDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**AckPendingEntriesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerControllerClaimPendingEntries** +> ClaimPendingEntriesResponse consumerControllerClaimPendingEntries(claimPendingEntryDto) + +Claim pending entries + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + ClaimPendingEntryDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let claimPendingEntryDto: ClaimPendingEntryDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerControllerClaimPendingEntries( + dbInstance, + claimPendingEntryDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **claimPendingEntryDto** | **ClaimPendingEntryDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**ClaimPendingEntriesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerControllerDeleteConsumers** +> consumerControllerDeleteConsumers(deleteConsumersDto) + +Delete Consumer(s) from the Consumer Group + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + DeleteConsumersDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let deleteConsumersDto: DeleteConsumersDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerControllerDeleteConsumers( + dbInstance, + deleteConsumersDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteConsumersDto** | **DeleteConsumersDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerControllerGetConsumers** +> Array consumerControllerGetConsumers(getConsumersDto) + +Get consumers list in the group + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + GetConsumersDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getConsumersDto: GetConsumersDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerControllerGetConsumers( + dbInstance, + encoding, + getConsumersDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getConsumersDto** | **GetConsumersDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerControllerGetPendingEntries** +> Array consumerControllerGetPendingEntries(getPendingEntriesDto) + +Get pending entries list + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + GetPendingEntriesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getPendingEntriesDto: GetPendingEntriesDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerControllerGetPendingEntries( + dbInstance, + encoding, + getPendingEntriesDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getPendingEntriesDto** | **GetPendingEntriesDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerGroupControllerCreateGroups** +> consumerGroupControllerCreateGroups(createConsumerGroupsDto) + +Create stream consumer group + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + CreateConsumerGroupsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let createConsumerGroupsDto: CreateConsumerGroupsDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerGroupControllerCreateGroups( + dbInstance, + createConsumerGroupsDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createConsumerGroupsDto** | **CreateConsumerGroupsDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerGroupControllerDeleteGroup** +> DeleteConsumerGroupsResponse consumerGroupControllerDeleteGroup(deleteConsumerGroupsDto) + +Delete Consumer Group + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + DeleteConsumerGroupsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let deleteConsumerGroupsDto: DeleteConsumerGroupsDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerGroupControllerDeleteGroup( + dbInstance, + deleteConsumerGroupsDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteConsumerGroupsDto** | **DeleteConsumerGroupsDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteConsumerGroupsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Returns number of affected consumer groups. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerGroupControllerGetGroups** +> Array consumerGroupControllerGetGroups(keyDto) + +Get consumer groups list + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + KeyDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let keyDto: KeyDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerGroupControllerGetGroups( + dbInstance, + encoding, + keyDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **keyDto** | **KeyDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Returns stream consumer groups. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **consumerGroupControllerUpdateGroup** +> consumerGroupControllerUpdateGroup(updateConsumerGroupDto) + +Modify last delivered ID of the Consumer Group + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + UpdateConsumerGroupDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let updateConsumerGroupDto: UpdateConsumerGroupDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.consumerGroupControllerUpdateGroup( + dbInstance, + updateConsumerGroupDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateConsumerGroupDto** | **UpdateConsumerGroupDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **streamControllerAddEntries** +> AddStreamEntriesResponse streamControllerAddEntries(addStreamEntriesDto) + +Add entries to the stream + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + AddStreamEntriesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let addStreamEntriesDto: AddStreamEntriesDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.streamControllerAddEntries( + dbInstance, + encoding, + addStreamEntriesDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **addStreamEntriesDto** | **AddStreamEntriesDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**AddStreamEntriesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Returns entries IDs added | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **streamControllerCreateStream** +> streamControllerCreateStream(createStreamDto) + +Create stream + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + CreateStreamDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let createStreamDto: CreateStreamDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.streamControllerCreateStream( + dbInstance, + createStreamDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createStreamDto** | **CreateStreamDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **streamControllerDeleteEntries** +> DeleteStreamEntriesResponse streamControllerDeleteEntries(deleteStreamEntriesDto) + +Remove the specified entries from the Stream stored at key + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + DeleteStreamEntriesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let deleteStreamEntriesDto: DeleteStreamEntriesDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.streamControllerDeleteEntries( + dbInstance, + deleteStreamEntriesDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteStreamEntriesDto** | **DeleteStreamEntriesDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteStreamEntriesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **streamControllerGetEntries** +> GetStreamEntriesResponse streamControllerGetEntries(getStreamEntriesDto) + +Get stream entries + +### Example + +```typescript +import { + BrowserStreamsApi, + Configuration, + GetStreamEntriesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStreamsApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getStreamEntriesDto: GetStreamEntriesDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.streamControllerGetEntries( + dbInstance, + encoding, + getStreamEntriesDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getStreamEntriesDto** | **GetStreamEntriesDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetStreamEntriesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Returns ordered stream entries in defined range. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserStringApi.md b/redisinsight/ui/src/api-client/docs/BrowserStringApi.md new file mode 100644 index 0000000000..138693762c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserStringApi.md @@ -0,0 +1,255 @@ +# BrowserStringApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**stringControllerDownloadStringFile**](#stringcontrollerdownloadstringfile) | **POST** /api/databases/{dbInstance}/string/download-value | | +|[**stringControllerGetStringValue**](#stringcontrollergetstringvalue) | **POST** /api/databases/{dbInstance}/string/get-value | | +|[**stringControllerSetString**](#stringcontrollersetstring) | **POST** /api/databases/{dbInstance}/string | | +|[**stringControllerUpdateStringValue**](#stringcontrollerupdatestringvalue) | **PUT** /api/databases/{dbInstance}/string | | + +# **stringControllerDownloadStringFile** +> stringControllerDownloadStringFile(getKeyInfoDto) + +Endpoint do download string value + +### Example + +```typescript +import { + BrowserStringApi, + Configuration, + GetKeyInfoDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStringApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getKeyInfoDto: GetKeyInfoDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.stringControllerDownloadStringFile( + dbInstance, + encoding, + getKeyInfoDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getKeyInfoDto** | **GetKeyInfoDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stringControllerGetStringValue** +> GetStringValueResponse stringControllerGetStringValue(getStringInfoDto) + +Get string value + +### Example + +```typescript +import { + BrowserStringApi, + Configuration, + GetStringInfoDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStringApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getStringInfoDto: GetStringInfoDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.stringControllerGetStringValue( + dbInstance, + encoding, + getStringInfoDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getStringInfoDto** | **GetStringInfoDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetStringValueResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | String value | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stringControllerSetString** +> stringControllerSetString(setStringWithExpireDto) + +Set key to hold string value + +### Example + +```typescript +import { + BrowserStringApi, + Configuration, + SetStringWithExpireDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStringApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let setStringWithExpireDto: SetStringWithExpireDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.stringControllerSetString( + dbInstance, + encoding, + setStringWithExpireDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **setStringWithExpireDto** | **SetStringWithExpireDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stringControllerUpdateStringValue** +> stringControllerUpdateStringValue(setStringDto) + +Update string value + +### Example + +```typescript +import { + BrowserStringApi, + Configuration, + SetStringDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserStringApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let setStringDto: SetStringDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.stringControllerUpdateStringValue( + dbInstance, + encoding, + setStringDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **setStringDto** | **SetStringDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BrowserZSetApi.md b/redisinsight/ui/src/api-client/docs/BrowserZSetApi.md new file mode 100644 index 0000000000..b00779f6ff --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BrowserZSetApi.md @@ -0,0 +1,379 @@ +# BrowserZSetApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**zSetControllerAddMembers**](#zsetcontrolleraddmembers) | **PUT** /api/databases/{dbInstance}/zSet | | +|[**zSetControllerCreateSet**](#zsetcontrollercreateset) | **POST** /api/databases/{dbInstance}/zSet | | +|[**zSetControllerDeleteMembers**](#zsetcontrollerdeletemembers) | **DELETE** /api/databases/{dbInstance}/zSet/members | | +|[**zSetControllerGetZSet**](#zsetcontrollergetzset) | **POST** /api/databases/{dbInstance}/zSet/get-members | | +|[**zSetControllerSearchZSet**](#zsetcontrollersearchzset) | **POST** /api/databases/{dbInstance}/zSet/search | | +|[**zSetControllerUpdateMember**](#zsetcontrollerupdatemember) | **PATCH** /api/databases/{dbInstance}/zSet | | + +# **zSetControllerAddMembers** +> zSetControllerAddMembers(addMembersToZSetDto) + +Add the specified members to the ZSet stored at key + +### Example + +```typescript +import { + BrowserZSetApi, + Configuration, + AddMembersToZSetDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserZSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let addMembersToZSetDto: AddMembersToZSetDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.zSetControllerAddMembers( + dbInstance, + encoding, + addMembersToZSetDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **addMembersToZSetDto** | **AddMembersToZSetDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zSetControllerCreateSet** +> zSetControllerCreateSet(createZSetWithExpireDto) + +Set key to hold ZSet data type + +### Example + +```typescript +import { + BrowserZSetApi, + Configuration, + CreateZSetWithExpireDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserZSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let createZSetWithExpireDto: CreateZSetWithExpireDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.zSetControllerCreateSet( + dbInstance, + encoding, + createZSetWithExpireDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createZSetWithExpireDto** | **CreateZSetWithExpireDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zSetControllerDeleteMembers** +> DeleteMembersFromZSetResponse zSetControllerDeleteMembers(deleteMembersFromZSetDto) + +Remove the specified members from the Set stored at key + +### Example + +```typescript +import { + BrowserZSetApi, + Configuration, + DeleteMembersFromZSetDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserZSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let deleteMembersFromZSetDto: DeleteMembersFromZSetDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.zSetControllerDeleteMembers( + dbInstance, + encoding, + deleteMembersFromZSetDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteMembersFromZSetDto** | **DeleteMembersFromZSetDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteMembersFromZSetResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zSetControllerGetZSet** +> GetZSetResponse zSetControllerGetZSet(getZSetMembersDto) + +Get specified members of the ZSet stored at key + +### Example + +```typescript +import { + BrowserZSetApi, + Configuration, + GetZSetMembersDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserZSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let getZSetMembersDto: GetZSetMembersDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.zSetControllerGetZSet( + dbInstance, + encoding, + getZSetMembersDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **getZSetMembersDto** | **GetZSetMembersDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**GetZSetResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zSetControllerSearchZSet** +> SearchZSetMembersResponse zSetControllerSearchZSet(searchZSetMembersDto) + +Search members in ZSet stored at key + +### Example + +```typescript +import { + BrowserZSetApi, + Configuration, + SearchZSetMembersDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserZSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let searchZSetMembersDto: SearchZSetMembersDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.zSetControllerSearchZSet( + dbInstance, + encoding, + searchZSetMembersDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **searchZSetMembersDto** | **SearchZSetMembersDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**SearchZSetMembersResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zSetControllerUpdateMember** +> zSetControllerUpdateMember(updateMemberInZSetDto) + +Update the specified member in the ZSet stored at key + +### Example + +```typescript +import { + BrowserZSetApi, + Configuration, + UpdateMemberInZSetDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BrowserZSetApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let updateMemberInZSetDto: UpdateMemberInZSetDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.zSetControllerUpdateMember( + dbInstance, + encoding, + updateMemberInZSetDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateMemberInZSetDto** | **UpdateMemberInZSetDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/BulkActionsApi.md b/redisinsight/ui/src/api-client/docs/BulkActionsApi.md new file mode 100644 index 0000000000..3911b101ed --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/BulkActionsApi.md @@ -0,0 +1,176 @@ +# BulkActionsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**bulkImportControllerImport**](#bulkimportcontrollerimport) | **POST** /api/databases/{dbInstance}/bulk-actions/import | | +|[**bulkImportControllerImportDefaultData**](#bulkimportcontrollerimportdefaultdata) | **POST** /api/databases/{dbInstance}/bulk-actions/import/default-data | | +|[**bulkImportControllerUploadFromTutorial**](#bulkimportcontrolleruploadfromtutorial) | **POST** /api/databases/{dbInstance}/bulk-actions/import/tutorial-data | | + +# **bulkImportControllerImport** +> object bulkImportControllerImport() + +Import data from file + +### Example + +```typescript +import { + BulkActionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BulkActionsApi(configuration); + +let dbInstance: string; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.bulkImportControllerImport( + dbInstance, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **bulkImportControllerImportDefaultData** +> object bulkImportControllerImportDefaultData() + +Import default data + +### Example + +```typescript +import { + BulkActionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BulkActionsApi(configuration); + +let dbInstance: string; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.bulkImportControllerImportDefaultData( + dbInstance, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **bulkImportControllerUploadFromTutorial** +> object bulkImportControllerUploadFromTutorial(uploadImportFileByPathDto) + +Import data from tutorial by path + +### Example + +```typescript +import { + BulkActionsApi, + Configuration, + UploadImportFileByPathDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new BulkActionsApi(configuration); + +let dbInstance: string; // (default to undefined) +let uploadImportFileByPathDto: UploadImportFileByPathDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.bulkImportControllerUploadFromTutorial( + dbInstance, + uploadImportFileByPathDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **uploadImportFileByPathDto** | **UploadImportFileByPathDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CLIApi.md b/redisinsight/ui/src/api-client/docs/CLIApi.md new file mode 100644 index 0000000000..7609d08523 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CLIApi.md @@ -0,0 +1,287 @@ +# CLIApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cliControllerDeleteClient**](#clicontrollerdeleteclient) | **DELETE** /api/databases/{dbInstance}/cli/{uuid} | | +|[**cliControllerGetClient**](#clicontrollergetclient) | **POST** /api/databases/{dbInstance}/cli | | +|[**cliControllerReCreateClient**](#clicontrollerrecreateclient) | **PATCH** /api/databases/{dbInstance}/cli/{uuid} | | +|[**cliControllerSendClusterCommand**](#clicontrollersendclustercommand) | **POST** /api/databases/{dbInstance}/cli/{uuid}/send-cluster-command | | +|[**cliControllerSendCommand**](#clicontrollersendcommand) | **POST** /api/databases/{dbInstance}/cli/{uuid}/send-command | | + +# **cliControllerDeleteClient** +> DeleteClientResponse cliControllerDeleteClient() + +Delete Redis CLI client + +### Example + +```typescript +import { + CLIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CLIApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let uuid: string; //CLI client uuid (default to undefined) + +const { status, data } = await apiInstance.cliControllerDeleteClient( + dbInstance, + uuid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **uuid** | [**string**] | CLI client uuid | defaults to undefined| + + +### Return type + +**DeleteClientResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Delete Redis CLI client response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cliControllerGetClient** +> CreateCliClientResponse cliControllerGetClient() + +Create Redis client for CLI + +### Example + +```typescript +import { + CLIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CLIApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) + +const { status, data } = await apiInstance.cliControllerGetClient( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +**CreateCliClientResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Create Redis client for CLI | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cliControllerReCreateClient** +> cliControllerReCreateClient() + +Re-create Redis client for CLI + +### Example + +```typescript +import { + CLIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CLIApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let uuid: string; //CLI client uuid (default to undefined) + +const { status, data } = await apiInstance.cliControllerReCreateClient( + dbInstance, + uuid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **uuid** | [**string**] | CLI client uuid | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cliControllerSendClusterCommand** +> Array cliControllerSendClusterCommand(sendCommandDto) + +Send Redis CLI command + +### Example + +```typescript +import { + CLIApi, + Configuration, + SendCommandDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CLIApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let uuid: string; //CLI client uuid (default to undefined) +let sendCommandDto: SendCommandDto; // + +const { status, data } = await apiInstance.cliControllerSendClusterCommand( + dbInstance, + uuid, + sendCommandDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sendCommandDto** | **SendCommandDto**| | | +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **uuid** | [**string**] | CLI client uuid | defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Redis CLI command response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cliControllerSendCommand** +> SendCommandResponse cliControllerSendCommand(sendCommandDto) + +Send Redis CLI command + +### Example + +```typescript +import { + CLIApi, + Configuration, + SendCommandDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CLIApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let uuid: string; //CLI client uuid (default to undefined) +let sendCommandDto: SendCommandDto; // + +const { status, data } = await apiInstance.cliControllerSendCommand( + dbInstance, + uuid, + sendCommandDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sendCommandDto** | **SendCommandDto**| | | +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **uuid** | [**string**] | CLI client uuid | defaults to undefined| + + +### Return type + +**SendCommandResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Redis CLI command response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CaCertificate.md b/redisinsight/ui/src/api-client/docs/CaCertificate.md new file mode 100644 index 0000000000..071d832d6b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CaCertificate.md @@ -0,0 +1,26 @@ +# CaCertificate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Certificate id | [default to undefined] +**name** | **string** | Certificate name | [default to undefined] +**certificate** | **string** | Certificate body | [default to undefined] +**isPreSetup** | **boolean** | Whether the certificate was created from a file or environment variables at startup | [optional] [default to undefined] + +## Example + +```typescript +import { CaCertificate } from './api'; + +const instance: CaCertificate = { + id, + name, + certificate, + isPreSetup, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ClaimPendingEntriesResponse.md b/redisinsight/ui/src/api-client/docs/ClaimPendingEntriesResponse.md new file mode 100644 index 0000000000..a9a9cfbb88 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClaimPendingEntriesResponse.md @@ -0,0 +1,20 @@ +# ClaimPendingEntriesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **Array<string>** | Entries IDs were affected by claim command | [default to undefined] + +## Example + +```typescript +import { ClaimPendingEntriesResponse } from './api'; + +const instance: ClaimPendingEntriesResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ClaimPendingEntryDto.md b/redisinsight/ui/src/api-client/docs/ClaimPendingEntryDto.md new file mode 100644 index 0000000000..469be1efc6 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClaimPendingEntryDto.md @@ -0,0 +1,36 @@ +# ClaimPendingEntryDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**groupName** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] +**consumerName** | [**GetPendingEntriesDtoConsumerName**](GetPendingEntriesDtoConsumerName.md) | | [default to undefined] +**minIdleTime** | **number** | Claim only if its idle time is greater the minimum idle time | [default to 0] +**entries** | **Array<string>** | Entries IDs | [default to undefined] +**idle** | **number** | Set the idle time (last time it was delivered) of the message | [optional] [default to undefined] +**time** | **number** | This is the same as IDLE but instead of a relative amount of milliseconds, it sets the idle time to a specific Unix time (in milliseconds) | [optional] [default to undefined] +**retryCount** | **number** | Set the retry counter to the specified value. This counter is incremented every time a message is delivered again. Normally XCLAIM does not alter this counter, which is just served to clients when the XPENDING command is called: this way clients can detect anomalies, like messages that are never processed for some reason after a big number of delivery attempts | [optional] [default to undefined] +**force** | **boolean** | Creates the pending message entry in the PEL even if certain specified IDs are not already in the PEL assigned to a different client | [optional] [default to undefined] + +## Example + +```typescript +import { ClaimPendingEntryDto } from './api'; + +const instance: ClaimPendingEntryDto = { + keyName, + groupName, + consumerName, + minIdleTime, + entries, + idle, + time, + retryCount, + force, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ClientCertificate.md b/redisinsight/ui/src/api-client/docs/ClientCertificate.md new file mode 100644 index 0000000000..1dc64c443a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClientCertificate.md @@ -0,0 +1,28 @@ +# ClientCertificate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Certificate id | [default to undefined] +**name** | **string** | Certificate name | [default to undefined] +**certificate** | **string** | Certificate body | [default to undefined] +**key** | **string** | Key body | [default to undefined] +**isPreSetup** | **boolean** | Whether the certificate was created from a file or environment variables at startup | [optional] [default to undefined] + +## Example + +```typescript +import { ClientCertificate } from './api'; + +const instance: ClientCertificate = { + id, + name, + certificate, + key, + isPreSetup, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudAccountInfo.md b/redisinsight/ui/src/api-client/docs/CloudAccountInfo.md new file mode 100644 index 0000000000..bbc16c77fe --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudAccountInfo.md @@ -0,0 +1,26 @@ +# CloudAccountInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **number** | Account id | [default to undefined] +**accountName** | **string** | Account name | [default to undefined] +**ownerName** | **string** | Account owner name | [default to undefined] +**ownerEmail** | **string** | Account owner email | [default to undefined] + +## Example + +```typescript +import { CloudAccountInfo } from './api'; + +const instance: CloudAccountInfo = { + accountId, + accountName, + ownerName, + ownerEmail, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudAuthApi.md b/redisinsight/ui/src/api-client/docs/CloudAuthApi.md new file mode 100644 index 0000000000..c0eaeadacf --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudAuthApi.md @@ -0,0 +1,68 @@ +# CloudAuthApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cloudAuthControllerCallback**](#cloudauthcontrollercallback) | **GET** /api/cloud/auth/oauth/callback | | + +# **cloudAuthControllerCallback** +> CloudAuthResponse cloudAuthControllerCallback() + +OAuth callback endpoint for handling OAuth authorization code flow + +### Example + +```typescript +import { + CloudAuthApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAuthApi(configuration); + +let code: string; //Authorization code from OAuth provider (optional) (default to undefined) +let state: string; //State parameter to prevent CSRF attacks (optional) (default to undefined) +let error: string; //Error code if OAuth flow failed (optional) (default to undefined) +let errorDescription: string; //Human-readable error description (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudAuthControllerCallback( + code, + state, + error, + errorDescription +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **code** | [**string**] | Authorization code from OAuth provider | (optional) defaults to undefined| +| **state** | [**string**] | State parameter to prevent CSRF attacks | (optional) defaults to undefined| +| **error** | [**string**] | Error code if OAuth flow failed | (optional) defaults to undefined| +| **errorDescription** | [**string**] | Human-readable error description | (optional) defaults to undefined| + + +### Return type + +**CloudAuthResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OAuth callback processed successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CloudAuthRequestOptions.md b/redisinsight/ui/src/api-client/docs/CloudAuthRequestOptions.md new file mode 100644 index 0000000000..46d530451d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudAuthRequestOptions.md @@ -0,0 +1,26 @@ +# CloudAuthRequestOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**strategy** | **string** | OAuth identity provider strategy | [default to undefined] +**action** | **string** | Action to perform after authentication | [optional] [default to undefined] +**data** | **object** | Additional data for the authentication request | [optional] [default to undefined] +**callback** | **object** | Callback function to execute after authentication | [optional] [default to undefined] + +## Example + +```typescript +import { CloudAuthRequestOptions } from './api'; + +const instance: CloudAuthRequestOptions = { + strategy, + action, + data, + callback, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudAuthResponse.md b/redisinsight/ui/src/api-client/docs/CloudAuthResponse.md new file mode 100644 index 0000000000..9fc652f7c2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudAuthResponse.md @@ -0,0 +1,24 @@ +# CloudAuthResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | Authentication status | [default to undefined] +**message** | **string** | Success or informational message | [optional] [default to undefined] +**error** | [**CloudAuthResponseError**](CloudAuthResponseError.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CloudAuthResponse } from './api'; + +const instance: CloudAuthResponse = { + status, + message, + error, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudAuthResponseError.md b/redisinsight/ui/src/api-client/docs/CloudAuthResponseError.md new file mode 100644 index 0000000000..8af23a2c50 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudAuthResponseError.md @@ -0,0 +1,19 @@ +# CloudAuthResponseError + +Error details if authentication failed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { CloudAuthResponseError } from './api'; + +const instance: CloudAuthResponseError = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudAutodiscoveryApi.md b/redisinsight/ui/src/api-client/docs/CloudAutodiscoveryApi.md new file mode 100644 index 0000000000..635fca043d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudAutodiscoveryApi.md @@ -0,0 +1,499 @@ +# CloudAutodiscoveryApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cloudAutodiscoveryControllerAddDiscoveredDatabases**](#cloudautodiscoverycontrolleradddiscovereddatabases) | **POST** /api/cloud/autodiscovery/databases | | +|[**cloudAutodiscoveryControllerDiscoverDatabases**](#cloudautodiscoverycontrollerdiscoverdatabases) | **POST** /api/cloud/autodiscovery/get-databases | | +|[**cloudAutodiscoveryControllerDiscoverSubscriptions**](#cloudautodiscoverycontrollerdiscoversubscriptions) | **GET** /api/cloud/autodiscovery/subscriptions | | +|[**cloudAutodiscoveryControllerGetAccount**](#cloudautodiscoverycontrollergetaccount) | **GET** /api/cloud/autodiscovery/account | | +|[**meCloudAutodiscoveryControllerAddDiscoveredDatabases**](#mecloudautodiscoverycontrolleradddiscovereddatabases) | **POST** /api/cloud/me/autodiscovery/databases | | +|[**meCloudAutodiscoveryControllerDiscoverDatabases**](#mecloudautodiscoverycontrollerdiscoverdatabases) | **POST** /api/cloud/me/autodiscovery/get-databases | | +|[**meCloudAutodiscoveryControllerDiscoverSubscriptions**](#mecloudautodiscoverycontrollerdiscoversubscriptions) | **GET** /api/cloud/me/autodiscovery/subscriptions | | +|[**meCloudAutodiscoveryControllerGetAccount**](#mecloudautodiscoverycontrollergetaccount) | **GET** /api/cloud/me/autodiscovery/account | | + +# **cloudAutodiscoveryControllerAddDiscoveredDatabases** +> Array cloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto) + +Add databases from Redis Enterprise Cloud Pro account. + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration, + ImportCloudDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let importCloudDatabasesDto: ImportCloudDatabasesDto; // +let xCloudApiKey: string; // (optional) (default to undefined) +let xCloudApiSecret: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudAutodiscoveryControllerAddDiscoveredDatabases( + importCloudDatabasesDto, + xCloudApiKey, + xCloudApiSecret +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **importCloudDatabasesDto** | **ImportCloudDatabasesDto**| | | +| **xCloudApiKey** | [**string**] | | (optional) defaults to undefined| +| **xCloudApiSecret** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Added databases list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudAutodiscoveryControllerDiscoverDatabases** +> Array cloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto) + +Get databases belonging to subscriptions + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration, + DiscoverCloudDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let discoverCloudDatabasesDto: DiscoverCloudDatabasesDto; // +let xCloudApiKey: string; // (optional) (default to undefined) +let xCloudApiSecret: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudAutodiscoveryControllerDiscoverDatabases( + discoverCloudDatabasesDto, + xCloudApiKey, + xCloudApiSecret +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **discoverCloudDatabasesDto** | **DiscoverCloudDatabasesDto**| | | +| **xCloudApiKey** | [**string**] | | (optional) defaults to undefined| +| **xCloudApiSecret** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Databases list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudAutodiscoveryControllerDiscoverSubscriptions** +> Array cloudAutodiscoveryControllerDiscoverSubscriptions() + +Get information about current account’s subscriptions. + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let xCloudApiKey: string; // (optional) (default to undefined) +let xCloudApiSecret: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudAutodiscoveryControllerDiscoverSubscriptions( + xCloudApiKey, + xCloudApiSecret +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **xCloudApiKey** | [**string**] | | (optional) defaults to undefined| +| **xCloudApiSecret** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Redis cloud subscription list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudAutodiscoveryControllerGetAccount** +> CloudAccountInfo cloudAutodiscoveryControllerGetAccount() + +Get current account + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let xCloudApiKey: string; // (optional) (default to undefined) +let xCloudApiSecret: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudAutodiscoveryControllerGetAccount( + xCloudApiKey, + xCloudApiSecret +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **xCloudApiKey** | [**string**] | | (optional) defaults to undefined| +| **xCloudApiSecret** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**CloudAccountInfo** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Account Details. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **meCloudAutodiscoveryControllerAddDiscoveredDatabases** +> Array meCloudAutodiscoveryControllerAddDiscoveredDatabases(importCloudDatabasesDto) + +Add databases from Redis Enterprise Cloud Pro account. + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration, + ImportCloudDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let importCloudDatabasesDto: ImportCloudDatabasesDto; // +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.meCloudAutodiscoveryControllerAddDiscoveredDatabases( + importCloudDatabasesDto, + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **importCloudDatabasesDto** | **ImportCloudDatabasesDto**| | | +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Added databases list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **meCloudAutodiscoveryControllerDiscoverDatabases** +> Array meCloudAutodiscoveryControllerDiscoverDatabases(discoverCloudDatabasesDto) + +Get databases belonging to subscriptions + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration, + DiscoverCloudDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let discoverCloudDatabasesDto: DiscoverCloudDatabasesDto; // +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.meCloudAutodiscoveryControllerDiscoverDatabases( + discoverCloudDatabasesDto, + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **discoverCloudDatabasesDto** | **DiscoverCloudDatabasesDto**| | | +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Databases list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **meCloudAutodiscoveryControllerDiscoverSubscriptions** +> Array meCloudAutodiscoveryControllerDiscoverSubscriptions() + +Get information about current account’s subscriptions. + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.meCloudAutodiscoveryControllerDiscoverSubscriptions( + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Redis cloud subscription list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **meCloudAutodiscoveryControllerGetAccount** +> CloudAccountInfo meCloudAutodiscoveryControllerGetAccount() + +Get current account + +### Example + +```typescript +import { + CloudAutodiscoveryApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudAutodiscoveryApi(configuration); + +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.meCloudAutodiscoveryControllerGetAccount( + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**CloudAccountInfo** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Account Details. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CloudCAPIKeysApi.md b/redisinsight/ui/src/api-client/docs/CloudCAPIKeysApi.md new file mode 100644 index 0000000000..413ee8b4ad --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudCAPIKeysApi.md @@ -0,0 +1,149 @@ +# CloudCAPIKeysApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cloudCapiKeyControllerDelete**](#cloudcapikeycontrollerdelete) | **DELETE** /api/cloud/me/capi-keys/{id} | | +|[**cloudCapiKeyControllerDeleteAll**](#cloudcapikeycontrollerdeleteall) | **DELETE** /api/cloud/me/capi-keys | | +|[**cloudCapiKeyControllerList**](#cloudcapikeycontrollerlist) | **GET** /api/cloud/me/capi-keys | | + +# **cloudCapiKeyControllerDelete** +> cloudCapiKeyControllerDelete() + +Removes user\'s capi keys by id + +### Example + +```typescript +import { + CloudCAPIKeysApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudCAPIKeysApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.cloudCapiKeyControllerDelete( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudCapiKeyControllerDeleteAll** +> cloudCapiKeyControllerDeleteAll() + +Removes all user\'s capi keys + +### Example + +```typescript +import { + CloudCAPIKeysApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudCAPIKeysApi(configuration); + +const { status, data } = await apiInstance.cloudCapiKeyControllerDeleteAll(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudCapiKeyControllerList** +> Array cloudCapiKeyControllerList() + +Return list of user\'s existing capi keys + +### Example + +```typescript +import { + CloudCAPIKeysApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudCAPIKeysApi(configuration); + +const { status, data } = await apiInstance.cloudCapiKeyControllerList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CloudCapiKey.md b/redisinsight/ui/src/api-client/docs/CloudCapiKey.md new file mode 100644 index 0000000000..24ee5744bc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudCapiKey.md @@ -0,0 +1,38 @@ +# CloudCapiKey + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**userId** | **string** | | [default to undefined] +**name** | **string** | Autogenerated name of capi key (Redisinsight-<RI id>-<ISO date of creation> | [default to undefined] +**cloudAccountId** | **number** | | [default to undefined] +**cloudUserId** | **number** | | [default to undefined] +**capiKey** | **string** | | [default to undefined] +**capiSecret** | **string** | | [default to undefined] +**valid** | **boolean** | | [default to undefined] +**createdAt** | **string** | | [default to undefined] +**lastUsed** | **string** | | [default to undefined] + +## Example + +```typescript +import { CloudCapiKey } from './api'; + +const instance: CloudCapiKey = { + id, + userId, + name, + cloudAccountId, + cloudUserId, + capiKey, + capiSecret, + valid, + createdAt, + lastUsed, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudDatabase.md b/redisinsight/ui/src/api-client/docs/CloudDatabase.md new file mode 100644 index 0000000000..0010f8bf29 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudDatabase.md @@ -0,0 +1,38 @@ +# CloudDatabase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription id | [default to undefined] +**subscriptionType** | **string** | Subscription type | [default to undefined] +**databaseId** | **number** | Database id | [default to undefined] +**name** | **string** | Database name | [default to undefined] +**publicEndpoint** | **string** | Address your Redis Cloud database is available on | [default to undefined] +**status** | **string** | Database status | [default to StatusEnum_Active] +**sslClientAuthentication** | **boolean** | Is ssl authentication enabled or not | [default to undefined] +**modules** | **Array<string>** | Information about the modules loaded to the database | [default to undefined] +**_options** | **object** | Additional database options | [default to undefined] +**tags** | [**Array<Tag>**](Tag.md) | Tags associated with the database. | [default to undefined] + +## Example + +```typescript +import { CloudDatabase } from './api'; + +const instance: CloudDatabase = { + subscriptionId, + subscriptionType, + databaseId, + name, + publicEndpoint, + status, + sslClientAuthentication, + modules, + _options, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudDatabaseDetails.md b/redisinsight/ui/src/api-client/docs/CloudDatabaseDetails.md new file mode 100644 index 0000000000..47963707aa --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudDatabaseDetails.md @@ -0,0 +1,32 @@ +# CloudDatabaseDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cloudId** | **number** | Database id from the cloud | [default to undefined] +**subscriptionId** | **number** | Subscription id from the cloud | [default to undefined] +**subscriptionType** | **string** | Subscription type | [default to undefined] +**planMemoryLimit** | **number** | Plan memory limit | [optional] [default to undefined] +**memoryLimitMeasurementUnit** | **string** | Memory limit units | [optional] [default to undefined] +**free** | **boolean** | Is free database | [optional] [default to undefined] +**isBdbPackage** | **boolean** | Is subscription using bdb packages | [optional] [default to undefined] + +## Example + +```typescript +import { CloudDatabaseDetails } from './api'; + +const instance: CloudDatabaseDetails = { + cloudId, + subscriptionId, + subscriptionType, + planMemoryLimit, + memoryLimitMeasurementUnit, + free, + isBdbPackage, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudJobInfo.md b/redisinsight/ui/src/api-client/docs/CloudJobInfo.md new file mode 100644 index 0000000000..fbffd98847 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudJobInfo.md @@ -0,0 +1,32 @@ +# CloudJobInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**name** | **string** | | [default to undefined] +**status** | **string** | | [default to undefined] +**child** | [**CloudJobInfo**](CloudJobInfo.md) | Children job if any | [optional] [default to undefined] +**error** | **object** | Error if any | [optional] [default to undefined] +**result** | **object** | Job result | [optional] [default to undefined] +**step** | **string** | Job step | [optional] [default to undefined] + +## Example + +```typescript +import { CloudJobInfo } from './api'; + +const instance: CloudJobInfo = { + id, + name, + status, + child, + error, + result, + step, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudJobsApi.md b/redisinsight/ui/src/api-client/docs/CloudJobsApi.md new file mode 100644 index 0000000000..f1e71c9313 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudJobsApi.md @@ -0,0 +1,172 @@ +# CloudJobsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cloudJobControllerCreateFreeDatabase**](#cloudjobcontrollercreatefreedatabase) | **POST** /api/cloud/me/jobs | | +|[**cloudJobControllerGetJobInfo**](#cloudjobcontrollergetjobinfo) | **GET** /api/cloud/me/jobs/{id} | | +|[**cloudJobControllerGetUserJobsInfo**](#cloudjobcontrollergetuserjobsinfo) | **GET** /api/cloud/me/jobs | | + +# **cloudJobControllerCreateFreeDatabase** +> CloudJobInfo cloudJobControllerCreateFreeDatabase(createCloudJobDto) + +Create cloud job + +### Example + +```typescript +import { + CloudJobsApi, + Configuration, + CreateCloudJobDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudJobsApi(configuration); + +let createCloudJobDto: CreateCloudJobDto; // +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudJobControllerCreateFreeDatabase( + createCloudJobDto, + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createCloudJobDto** | **CreateCloudJobDto**| | | +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**CloudJobInfo** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudJobControllerGetJobInfo** +> CloudJobInfo cloudJobControllerGetJobInfo() + +Get user jobs + +### Example + +```typescript +import { + CloudJobsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudJobsApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.cloudJobControllerGetJobInfo( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**CloudJobInfo** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudJobControllerGetUserJobsInfo** +> Array cloudJobControllerGetUserJobsInfo() + +Get list of user jobs + +### Example + +```typescript +import { + CloudJobsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudJobsApi(configuration); + +const { status, data } = await apiInstance.cloudJobControllerGetUserJobsInfo(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CloudSubscription.md b/redisinsight/ui/src/api-client/docs/CloudSubscription.md new file mode 100644 index 0000000000..f3e0bf26a1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudSubscription.md @@ -0,0 +1,36 @@ +# CloudSubscription + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | Subscription id | [default to undefined] +**name** | **string** | Subscription name | [default to undefined] +**type** | **string** | Subscription type | [default to undefined] +**numberOfDatabases** | **number** | Number of databases in subscription | [default to undefined] +**status** | **string** | Subscription status | [default to StatusEnum_Active] +**provider** | **string** | Subscription provider | [optional] [default to undefined] +**region** | **string** | Subscription region | [optional] [default to undefined] +**price** | **number** | Subscription price | [optional] [default to undefined] +**free** | **boolean** | Determines if subscription is 0 price | [optional] [default to undefined] + +## Example + +```typescript +import { CloudSubscription } from './api'; + +const instance: CloudSubscription = { + id, + name, + type, + numberOfDatabases, + status, + provider, + region, + price, + free, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudSubscriptionApi.md b/redisinsight/ui/src/api-client/docs/CloudSubscriptionApi.md new file mode 100644 index 0000000000..930013ea41 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudSubscriptionApi.md @@ -0,0 +1,71 @@ +# CloudSubscriptionApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cloudSubscriptionControllerGetPlans**](#cloudsubscriptioncontrollergetplans) | **GET** /api/cloud/me/subscription/plans | | + +# **cloudSubscriptionControllerGetPlans** +> Array cloudSubscriptionControllerGetPlans() + +Get list of plans with cloud regions + +### Example + +```typescript +import { + CloudSubscriptionApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudSubscriptionApi(configuration); + +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudSubscriptionControllerGetPlans( + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | List of plans with cloud regions | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/CloudSubscriptionPlanResponse.md b/redisinsight/ui/src/api-client/docs/CloudSubscriptionPlanResponse.md new file mode 100644 index 0000000000..d95e3ba1af --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudSubscriptionPlanResponse.md @@ -0,0 +1,34 @@ +# CloudSubscriptionPlanResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | | [default to undefined] +**regionId** | **number** | | [default to undefined] +**type** | **string** | Subscription type | [default to undefined] +**name** | **string** | | [default to undefined] +**provider** | **string** | | [default to undefined] +**region** | **string** | | [optional] [default to undefined] +**price** | **number** | | [optional] [default to undefined] +**details** | [**CloudSubscriptionRegion**](CloudSubscriptionRegion.md) | | [default to undefined] + +## Example + +```typescript +import { CloudSubscriptionPlanResponse } from './api'; + +const instance: CloudSubscriptionPlanResponse = { + id, + regionId, + type, + name, + provider, + region, + price, + details, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudSubscriptionRegion.md b/redisinsight/ui/src/api-client/docs/CloudSubscriptionRegion.md new file mode 100644 index 0000000000..fd0323e0d0 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudSubscriptionRegion.md @@ -0,0 +1,38 @@ +# CloudSubscriptionRegion + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**regionId** | **number** | | [default to undefined] +**name** | **string** | | [default to undefined] +**displayOrder** | **number** | | [default to undefined] +**region** | **string** | | [optional] [default to undefined] +**provider** | **string** | | [optional] [default to undefined] +**cloud** | **string** | | [optional] [default to undefined] +**countryName** | **string** | | [optional] [default to undefined] +**cityName** | **string** | | [optional] [default to undefined] +**flag** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CloudSubscriptionRegion } from './api'; + +const instance: CloudSubscriptionRegion = { + id, + regionId, + name, + displayOrder, + region, + provider, + cloud, + countryName, + cityName, + flag, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudUser.md b/redisinsight/ui/src/api-client/docs/CloudUser.md new file mode 100644 index 0000000000..0e4130d347 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudUser.md @@ -0,0 +1,30 @@ +# CloudUser + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | User id | [optional] [default to undefined] +**name** | **string** | User name | [optional] [default to undefined] +**currentAccountId** | **number** | Current account id | [optional] [default to undefined] +**capiKey** | [**CloudCapiKey**](CloudCapiKey.md) | Cloud API key | [optional] [default to undefined] +**accounts** | [**Array<CloudUserAccount>**](CloudUserAccount.md) | User accounts | [optional] [default to undefined] +**data** | **object** | Additional user data | [optional] [default to undefined] + +## Example + +```typescript +import { CloudUser } from './api'; + +const instance: CloudUser = { + id, + name, + currentAccountId, + capiKey, + accounts, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudUserAccount.md b/redisinsight/ui/src/api-client/docs/CloudUserAccount.md new file mode 100644 index 0000000000..7e95ba2d3b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudUserAccount.md @@ -0,0 +1,26 @@ +# CloudUserAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | Account id | [default to undefined] +**name** | **string** | Account name | [default to undefined] +**capiKey** | **string** | Cloud API key | [default to undefined] +**capiSecret** | **string** | Cloud API secret | [default to undefined] + +## Example + +```typescript +import { CloudUserAccount } from './api'; + +const instance: CloudUserAccount = { + id, + name, + capiKey, + capiSecret, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CloudUserApi.md b/redisinsight/ui/src/api-client/docs/CloudUserApi.md new file mode 100644 index 0000000000..9544b6951f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CloudUserApi.md @@ -0,0 +1,168 @@ +# CloudUserApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**cloudUserControllerLogout**](#cloudusercontrollerlogout) | **GET** /api/cloud/me/logout | | +|[**cloudUserControllerMe**](#cloudusercontrollerme) | **GET** /api/cloud/me | | +|[**cloudUserControllerSetCurrentAccount**](#cloudusercontrollersetcurrentaccount) | **PUT** /api/cloud/me/accounts/{id}/current | | + +# **cloudUserControllerLogout** +> cloudUserControllerLogout() + +Logout user + +### Example + +```typescript +import { + CloudUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudUserApi(configuration); + +const { status, data } = await apiInstance.cloudUserControllerLogout(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudUserControllerMe** +> CloudUser cloudUserControllerMe() + +Return user general info with accounts list + +### Example + +```typescript +import { + CloudUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudUserApi(configuration); + +let source: string; // (optional) (default to 'redisinsight') +let medium: string; // (optional) (default to undefined) +let campaign: string; // (optional) (default to undefined) +let amp: string; // (optional) (default to undefined) +let _package: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.cloudUserControllerMe( + source, + medium, + campaign, + amp, + _package +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **source** | [**string**] | | (optional) defaults to 'redisinsight'| +| **medium** | [**string**] | | (optional) defaults to undefined| +| **campaign** | [**string**] | | (optional) defaults to undefined| +| **amp** | [**string**] | | (optional) defaults to undefined| +| **_package** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**CloudUser** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **cloudUserControllerSetCurrentAccount** +> CloudUser cloudUserControllerSetCurrentAccount() + +Activate user account + +### Example + +```typescript +import { + CloudUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CloudUserApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.cloudUserControllerSetCurrentAccount( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**CloudUser** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/ClusterConnectionDetailsDto.md b/redisinsight/ui/src/api-client/docs/ClusterConnectionDetailsDto.md new file mode 100644 index 0000000000..3d9a0ce409 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClusterConnectionDetailsDto.md @@ -0,0 +1,26 @@ +# ClusterConnectionDetailsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis Enterprise. | [default to 'localhost'] +**port** | **number** | The port your Redis Enterprise cluster is available on. | [default to 9443] +**username** | **string** | The admin e-mail/username | [default to undefined] +**password** | **string** | The admin password | [default to undefined] + +## Example + +```typescript +import { ClusterConnectionDetailsDto } from './api'; + +const instance: ClusterConnectionDetailsDto = { + host, + port, + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ClusterDetails.md b/redisinsight/ui/src/api-client/docs/ClusterDetails.md new file mode 100644 index 0000000000..97f289ba83 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClusterDetails.md @@ -0,0 +1,52 @@ +# ClusterDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Redis version | [default to undefined] +**mode** | **string** | Redis mode. Currently one of: standalone, cluster or sentinel | [default to undefined] +**user** | **string** | Username from the connection or undefined in case when connected with default user | [optional] [default to undefined] +**uptimeSec** | **number** | Maximum value uptime_in_seconds from all nodes | [default to undefined] +**state** | **string** | cluster_state from CLUSTER INFO command | [default to undefined] +**slotsAssigned** | **number** | cluster_slots_assigned from CLUSTER INFO command | [default to undefined] +**slotsOk** | **number** | cluster_slots_ok from CLUSTER INFO command | [default to undefined] +**slotsPFail** | **number** | cluster_slots_pfail from CLUSTER INFO command | [default to undefined] +**slotsFail** | **number** | cluster_slots_fail from CLUSTER INFO command | [default to undefined] +**slotsUnassigned** | **number** | Calculated from (16384 - cluster_slots_assigned from CLUSTER INFO command) | [default to undefined] +**statsMessagesSent** | **number** | cluster_stats_messages_sent from CLUSTER INFO command | [default to undefined] +**statsMessagesReceived** | **number** | cluster_stats_messages_received from CLUSTER INFO command | [default to undefined] +**currentEpoch** | **number** | cluster_current_epoch from CLUSTER INFO command | [default to undefined] +**myEpoch** | **number** | cluster_my_epoch from CLUSTER INFO command | [default to undefined] +**size** | **number** | Number of shards. cluster_size from CLUSTER INFO command | [default to undefined] +**knownNodes** | **number** | All nodes number in the Cluster. cluster_known_nodes from CLUSTER INFO command | [default to undefined] +**nodes** | [**Array<ClusterNodeDetails>**](ClusterNodeDetails.md) | Details per each node | [default to undefined] + +## Example + +```typescript +import { ClusterDetails } from './api'; + +const instance: ClusterDetails = { + version, + mode, + user, + uptimeSec, + state, + slotsAssigned, + slotsOk, + slotsPFail, + slotsFail, + slotsUnassigned, + statsMessagesSent, + statsMessagesReceived, + currentEpoch, + myEpoch, + size, + knownNodes, + nodes, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ClusterMonitorApi.md b/redisinsight/ui/src/api-client/docs/ClusterMonitorApi.md new file mode 100644 index 0000000000..1c29fb968c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClusterMonitorApi.md @@ -0,0 +1,59 @@ +# ClusterMonitorApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**clusterMonitorControllerGetClusterDetails**](#clustermonitorcontrollergetclusterdetails) | **GET** /api/databases/{dbInstance}/cluster-details | | + +# **clusterMonitorControllerGetClusterDetails** +> ClusterDetails clusterMonitorControllerGetClusterDetails() + +Get cluster details + +### Example + +```typescript +import { + ClusterMonitorApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ClusterMonitorApi(configuration); + +let dbInstance: string; // (default to undefined) + +const { status, data } = await apiInstance.clusterMonitorControllerGetClusterDetails( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +**ClusterDetails** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/ClusterNodeDetails.md b/redisinsight/ui/src/api-client/docs/ClusterNodeDetails.md new file mode 100644 index 0000000000..1402732522 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ClusterNodeDetails.md @@ -0,0 +1,62 @@ +# ClusterNodeDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Node id | [default to undefined] +**version** | **string** | Redis version | [default to undefined] +**mode** | **string** | Redis mode | [default to undefined] +**host** | **string** | Node IP address | [default to undefined] +**port** | **number** | Node IP address | [default to undefined] +**role** | **string** | Node role in cluster | [default to undefined] +**primary** | **string** | ID of primary node (for replica only) | [optional] [default to undefined] +**health** | **string** | Node\'s current health status | [default to undefined] +**slots** | **Array<string>** | Array of assigned slots or slots ranges. Shown for primary nodes only | [optional] [default to undefined] +**totalKeys** | **number** | Total keys stored inside this node | [default to undefined] +**usedMemory** | **number** | Memory used by node. \"memory.used_memory\" from INFO command | [default to undefined] +**opsPerSecond** | **number** | Current operations per second. \"stats.instantaneous_ops_per_sec\" from INFO command | [default to undefined] +**connectionsReceived** | **number** | Total connections received by node. \"stats.total_connections_received\" from INFO command | [default to undefined] +**connectedClients** | **number** | Currently connected clients. \"clients.connected_clients\" from INFO command | [default to undefined] +**commandsProcessed** | **number** | Total commands processed by node. \"stats.total_commands_processed\" from INFO command | [default to undefined] +**networkInKbps** | **number** | Current input network usage in KB/s. \"stats.instantaneous_input_kbps\" from INFO command | [default to undefined] +**networkOutKbps** | **number** | Current output network usage in KB/s. \"stats.instantaneous_output_kbps\" from INFO command | [default to undefined] +**cacheHitRatio** | **number** | Ratio for cache hits and misses [0 - 1]. Ideally should be close to 1 | [optional] [default to undefined] +**replicationOffset** | **number** | The replication offset of this node. This information can be used to send commands to the most up to date replicas. | [default to undefined] +**replicationLag** | **number** | For replicas only. Determines on how much replica is behind of primary. | [optional] [default to undefined] +**uptimeSec** | **number** | Current node uptime_in_seconds | [default to undefined] +**replicas** | [**Array<ClusterNodeDetails>**](ClusterNodeDetails.md) | For primary nodes only. Replica node(s) details | [optional] [default to undefined] + +## Example + +```typescript +import { ClusterNodeDetails } from './api'; + +const instance: ClusterNodeDetails = { + id, + version, + mode, + host, + port, + role, + primary, + health, + slots, + totalKeys, + usedMemory, + opsPerSecond, + connectionsReceived, + connectedClients, + commandsProcessed, + networkInKbps, + networkOutKbps, + cacheHitRatio, + replicationOffset, + replicationLag, + uptimeSec, + replicas, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CommandExecution.md b/redisinsight/ui/src/api-client/docs/CommandExecution.md new file mode 100644 index 0000000000..2aeae1f9c9 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CommandExecution.md @@ -0,0 +1,42 @@ +# CommandExecution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Command execution id | [default to undefined] +**databaseId** | **string** | Database id | [default to undefined] +**command** | **string** | Redis command | [default to undefined] +**mode** | **string** | Workbench mode | [optional] [default to ModeEnum_Ascii] +**resultsMode** | **string** | Workbench result mode | [optional] [default to ResultsModeEnum_Default] +**summary** | [**ResultsSummary**](ResultsSummary.md) | Workbench executions summary | [optional] [default to undefined] +**result** | [**Array<CommandExecutionResult>**](CommandExecutionResult.md) | Command execution result | [default to undefined] +**isNotStored** | **boolean** | Result did not stored in db | [optional] [default to undefined] +**createdAt** | **string** | Date of command execution | [default to undefined] +**executionTime** | **number** | Workbench command execution time | [optional] [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**type** | **string** | Command execution type. Used to distinguish between search and workbench | [optional] [default to TypeEnum_Workbench] + +## Example + +```typescript +import { CommandExecution } from './api'; + +const instance: CommandExecution = { + id, + databaseId, + command, + mode, + resultsMode, + summary, + result, + isNotStored, + createdAt, + executionTime, + db, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CommandExecutionFilter.md b/redisinsight/ui/src/api-client/docs/CommandExecutionFilter.md new file mode 100644 index 0000000000..87977b1180 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CommandExecutionFilter.md @@ -0,0 +1,20 @@ +# CommandExecutionFilter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Command execution type. Used to distinguish between search and workbench | [optional] [default to TypeEnum_Workbench] + +## Example + +```typescript +import { CommandExecutionFilter } from './api'; + +const instance: CommandExecutionFilter = { + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CommandExecutionResult.md b/redisinsight/ui/src/api-client/docs/CommandExecutionResult.md new file mode 100644 index 0000000000..0703046eb8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CommandExecutionResult.md @@ -0,0 +1,24 @@ +# CommandExecutionResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | Redis CLI command execution status | [default to StatusEnum_Success] +**response** | **string** | Redis response | [default to undefined] +**sizeLimitExceeded** | **boolean** | Flag showing if response was replaced with message notification about response size limit threshold | [default to undefined] + +## Example + +```typescript +import { CommandExecutionResult } from './api'; + +const instance: CommandExecutionResult = { + status, + response, + sizeLimitExceeded, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CommandsApi.md b/redisinsight/ui/src/api-client/docs/CommandsApi.md new file mode 100644 index 0000000000..74ad4a8dd6 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CommandsApi.md @@ -0,0 +1,51 @@ +# CommandsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**commandsControllerGetAll**](#commandscontrollergetall) | **GET** /api/commands | | + +# **commandsControllerGetAll** +> commandsControllerGetAll() + + +### Example + +```typescript +import { + CommandsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new CommandsApi(configuration); + +const { status, data } = await apiInstance.commandsControllerGetAll(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/ConsumerDto.md b/redisinsight/ui/src/api-client/docs/ConsumerDto.md new file mode 100644 index 0000000000..6b9ef5ac41 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ConsumerDto.md @@ -0,0 +1,24 @@ +# ConsumerDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**ConsumerDtoName**](ConsumerDtoName.md) | | [default to undefined] +**pending** | **number** | The number of pending messages for the client, which are messages that were delivered but are yet to be acknowledged | [default to undefined] +**idle** | **number** | The number of milliseconds that have passed since the consumer last interacted with the server | [default to undefined] + +## Example + +```typescript +import { ConsumerDto } from './api'; + +const instance: ConsumerDto = { + name, + pending, + idle, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ConsumerDtoName.md b/redisinsight/ui/src/api-client/docs/ConsumerDtoName.md new file mode 100644 index 0000000000..81ce665618 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ConsumerDtoName.md @@ -0,0 +1,23 @@ +# ConsumerDtoName + +The consumer\'s name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { ConsumerDtoName } from './api'; + +const instance: ConsumerDtoName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ConsumerGroupDto.md b/redisinsight/ui/src/api-client/docs/ConsumerGroupDto.md new file mode 100644 index 0000000000..28cedefdac --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ConsumerGroupDto.md @@ -0,0 +1,30 @@ +# ConsumerGroupDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**ConsumerGroupDtoName**](ConsumerGroupDtoName.md) | | [default to undefined] +**consumers** | **number** | Number of consumers | [default to undefined] +**pending** | **number** | Number of pending messages | [default to undefined] +**smallestPendingId** | **string** | Smallest Id of the message that is pending in the group | [default to undefined] +**greatestPendingId** | **string** | Greatest Id of the message that is pending in the group | [default to undefined] +**lastDeliveredId** | **string** | Id of last delivered message | [default to undefined] + +## Example + +```typescript +import { ConsumerGroupDto } from './api'; + +const instance: ConsumerGroupDto = { + name, + consumers, + pending, + smallestPendingId, + greatestPendingId, + lastDeliveredId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ConsumerGroupDtoName.md b/redisinsight/ui/src/api-client/docs/ConsumerGroupDtoName.md new file mode 100644 index 0000000000..411f9df0a3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ConsumerGroupDtoName.md @@ -0,0 +1,23 @@ +# ConsumerGroupDtoName + +Consumer Group name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { ConsumerGroupDtoName } from './api'; + +const instance: ConsumerGroupDtoName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateBasicSshOptionsDto.md b/redisinsight/ui/src/api-client/docs/CreateBasicSshOptionsDto.md new file mode 100644 index 0000000000..0b85754e77 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateBasicSshOptionsDto.md @@ -0,0 +1,26 @@ +# CreateBasicSshOptionsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of SSH server | [default to 'localhost'] +**port** | **number** | The port of SSH server | [default to 22] +**username** | **string** | SSH username | [optional] [default to undefined] +**password** | **string** | The SSH password | [optional] [default to undefined] + +## Example + +```typescript +import { CreateBasicSshOptionsDto } from './api'; + +const instance: CreateBasicSshOptionsDto = { + host, + port, + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCaCertificateDto.md b/redisinsight/ui/src/api-client/docs/CreateCaCertificateDto.md new file mode 100644 index 0000000000..5f590dfdcc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCaCertificateDto.md @@ -0,0 +1,24 @@ +# CreateCaCertificateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Certificate name | [default to undefined] +**certificate** | **string** | Certificate body | [default to undefined] +**isPreSetup** | **boolean** | Whether the certificate was created from a file or environment variables at startup | [optional] [default to undefined] + +## Example + +```typescript +import { CreateCaCertificateDto } from './api'; + +const instance: CreateCaCertificateDto = { + name, + certificate, + isPreSetup, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCertSshOptionsDto.md b/redisinsight/ui/src/api-client/docs/CreateCertSshOptionsDto.md new file mode 100644 index 0000000000..da76447403 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCertSshOptionsDto.md @@ -0,0 +1,28 @@ +# CreateCertSshOptionsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of SSH server | [default to 'localhost'] +**port** | **number** | The port of SSH server | [default to 22] +**username** | **string** | SSH username | [optional] [default to undefined] +**privateKey** | **string** | The SSH private key | [optional] [default to undefined] +**passphrase** | **string** | The SSH passphrase | [optional] [default to undefined] + +## Example + +```typescript +import { CreateCertSshOptionsDto } from './api'; + +const instance: CreateCertSshOptionsDto = { + host, + port, + username, + privateKey, + passphrase, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCliClientResponse.md b/redisinsight/ui/src/api-client/docs/CreateCliClientResponse.md new file mode 100644 index 0000000000..e1d84efcde --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCliClientResponse.md @@ -0,0 +1,20 @@ +# CreateCliClientResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | Client uuid | [default to undefined] + +## Example + +```typescript +import { CreateCliClientResponse } from './api'; + +const instance: CreateCliClientResponse = { + uuid, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateClientCertificateDto.md b/redisinsight/ui/src/api-client/docs/CreateClientCertificateDto.md new file mode 100644 index 0000000000..10d757373b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateClientCertificateDto.md @@ -0,0 +1,26 @@ +# CreateClientCertificateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Certificate name | [default to undefined] +**certificate** | **string** | Certificate body | [default to undefined] +**key** | **string** | Key body | [default to undefined] +**isPreSetup** | **boolean** | Whether the certificate was created from a file or environment variables at startup | [optional] [default to undefined] + +## Example + +```typescript +import { CreateClientCertificateDto } from './api'; + +const instance: CreateClientCertificateDto = { + name, + certificate, + key, + isPreSetup, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCloudJobDto.md b/redisinsight/ui/src/api-client/docs/CreateCloudJobDto.md new file mode 100644 index 0000000000..7f25ecedae --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCloudJobDto.md @@ -0,0 +1,24 @@ +# CreateCloudJobDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Job name to create | [default to undefined] +**runMode** | **string** | Mod in which to run the job. | [default to undefined] +**data** | [**CreateCloudJobDtoData**](CreateCloudJobDtoData.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CreateCloudJobDto } from './api'; + +const instance: CreateCloudJobDto = { + name, + runMode, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCloudJobDtoData.md b/redisinsight/ui/src/api-client/docs/CreateCloudJobDtoData.md new file mode 100644 index 0000000000..7b71c26952 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCloudJobDtoData.md @@ -0,0 +1,31 @@ +# CreateCloudJobDtoData + +Any data for create a job. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription id of database | [default to undefined] +**planId** | **number** | Plan id for create a subscription. | [default to undefined] +**isRecommendedSettings** | **boolean** | Use recommended settings | [optional] [default to undefined] +**databaseId** | **number** | Database id to import | [default to undefined] +**region** | **string** | Subscription region | [default to undefined] +**provider** | **string** | Subscription provider | [default to undefined] + +## Example + +```typescript +import { CreateCloudJobDtoData } from './api'; + +const instance: CreateCloudJobDtoData = { + subscriptionId, + planId, + isRecommendedSettings, + databaseId, + region, + provider, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCommandExecutionDto.md b/redisinsight/ui/src/api-client/docs/CreateCommandExecutionDto.md new file mode 100644 index 0000000000..c1e5ab493c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCommandExecutionDto.md @@ -0,0 +1,26 @@ +# CreateCommandExecutionDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**command** | **string** | Redis command | [default to undefined] +**mode** | **string** | Workbench mode | [optional] [default to ModeEnum_Ascii] +**resultsMode** | **string** | Workbench result mode | [optional] [default to ResultsModeEnum_Default] +**type** | **string** | Command execution type. Used to distinguish between search and workbench | [optional] [default to TypeEnum_Workbench] + +## Example + +```typescript +import { CreateCommandExecutionDto } from './api'; + +const instance: CreateCommandExecutionDto = { + command, + mode, + resultsMode, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateCommandExecutionsDto.md b/redisinsight/ui/src/api-client/docs/CreateCommandExecutionsDto.md new file mode 100644 index 0000000000..c4098799b6 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateCommandExecutionsDto.md @@ -0,0 +1,26 @@ +# CreateCommandExecutionsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | **string** | Workbench mode | [optional] [default to ModeEnum_Ascii] +**resultsMode** | **string** | Workbench result mode | [optional] [default to ResultsModeEnum_Default] +**type** | **string** | Command execution type. Used to distinguish between search and workbench | [optional] [default to TypeEnum_Workbench] +**commands** | **Array<string>** | Redis commands | [default to undefined] + +## Example + +```typescript +import { CreateCommandExecutionsDto } from './api'; + +const instance: CreateCommandExecutionsDto = { + mode, + resultsMode, + type, + commands, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateConsumerGroupDto.md b/redisinsight/ui/src/api-client/docs/CreateConsumerGroupDto.md new file mode 100644 index 0000000000..b319dba748 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateConsumerGroupDto.md @@ -0,0 +1,22 @@ +# CreateConsumerGroupDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] +**lastDeliveredId** | **string** | Id of last delivered message | [default to undefined] + +## Example + +```typescript +import { CreateConsumerGroupDto } from './api'; + +const instance: CreateConsumerGroupDto = { + name, + lastDeliveredId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateConsumerGroupsDto.md b/redisinsight/ui/src/api-client/docs/CreateConsumerGroupsDto.md new file mode 100644 index 0000000000..9cc0b3f9ca --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateConsumerGroupsDto.md @@ -0,0 +1,22 @@ +# CreateConsumerGroupsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**consumerGroups** | [**Array<CreateConsumerGroupDto>**](CreateConsumerGroupDto.md) | List of consumer groups to create | [default to undefined] + +## Example + +```typescript +import { CreateConsumerGroupsDto } from './api'; + +const instance: CreateConsumerGroupsDto = { + keyName, + consumerGroups, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateDatabaseAnalysisDto.md b/redisinsight/ui/src/api-client/docs/CreateDatabaseAnalysisDto.md new file mode 100644 index 0000000000..d190f64347 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateDatabaseAnalysisDto.md @@ -0,0 +1,22 @@ +# CreateDatabaseAnalysisDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**delimiter** | **string** | Namespace delimiter | [default to ':'] +**filter** | [**ScanFilter**](ScanFilter.md) | Filters for scan operation | [default to undefined] + +## Example + +```typescript +import { CreateDatabaseAnalysisDto } from './api'; + +const instance: CreateDatabaseAnalysisDto = { + delimiter, + filter, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateDatabaseCloudJobDataDto.md b/redisinsight/ui/src/api-client/docs/CreateDatabaseCloudJobDataDto.md new file mode 100644 index 0000000000..62bffd5132 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateDatabaseCloudJobDataDto.md @@ -0,0 +1,20 @@ +# CreateDatabaseCloudJobDataDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription id for create a database. | [default to undefined] + +## Example + +```typescript +import { CreateDatabaseCloudJobDataDto } from './api'; + +const instance: CreateDatabaseCloudJobDataDto = { + subscriptionId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateDatabaseDto.md b/redisinsight/ui/src/api-client/docs/CreateDatabaseDto.md new file mode 100644 index 0000000000..6e2d61f5e9 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateDatabaseDto.md @@ -0,0 +1,62 @@ +# CreateDatabaseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] +**name** | **string** | A name for your Redis database. | [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**timeout** | **number** | Connection timeout | [optional] [default to 30000] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**sentinelMaster** | [**SentinelMaster**](SentinelMaster.md) | Redis OSS Sentinel master group. | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**keyNameFormat** | **string** | Key name format | [optional] [default to KeyNameFormatEnum_Unicode] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**caCert** | [**CreateDatabaseDtoCaCert**](CreateDatabaseDtoCaCert.md) | | [optional] [default to undefined] +**clientCert** | [**CreateDatabaseDtoClientCert**](CreateDatabaseDtoClientCert.md) | | [optional] [default to undefined] +**sshOptions** | [**CreateDatabaseDtoSshOptions**](CreateDatabaseDtoSshOptions.md) | | [optional] [default to undefined] +**tags** | [**Array<CreateTagDto>**](CreateTagDto.md) | Tags associated with the database. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateDatabaseDto } from './api'; + +const instance: CreateDatabaseDto = { + host, + port, + name, + db, + username, + password, + timeout, + nameFromProvider, + provider, + sentinelMaster, + tls, + tlsServername, + verifyServerCert, + ssh, + cloudDetails, + compressor, + keyNameFormat, + forceStandalone, + caCert, + clientCert, + sshOptions, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoCaCert.md b/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoCaCert.md new file mode 100644 index 0000000000..0ab2a3702b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoCaCert.md @@ -0,0 +1,27 @@ +# CreateDatabaseDtoCaCert + +CA Certificate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Certificate name | [default to undefined] +**certificate** | **string** | Certificate body | [default to undefined] +**isPreSetup** | **boolean** | Whether the certificate was created from a file or environment variables at startup | [optional] [default to undefined] +**id** | **string** | Certificate id | [default to undefined] + +## Example + +```typescript +import { CreateDatabaseDtoCaCert } from './api'; + +const instance: CreateDatabaseDtoCaCert = { + name, + certificate, + isPreSetup, + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoClientCert.md b/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoClientCert.md new file mode 100644 index 0000000000..c8e6ffe094 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoClientCert.md @@ -0,0 +1,29 @@ +# CreateDatabaseDtoClientCert + +Client Certificate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Certificate name | [default to undefined] +**certificate** | **string** | Certificate body | [default to undefined] +**key** | **string** | Key body | [default to undefined] +**isPreSetup** | **boolean** | Whether the certificate was created from a file or environment variables at startup | [optional] [default to undefined] +**id** | **string** | Certificate id | [default to undefined] + +## Example + +```typescript +import { CreateDatabaseDtoClientCert } from './api'; + +const instance: CreateDatabaseDtoClientCert = { + name, + certificate, + key, + isPreSetup, + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoSshOptions.md b/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoSshOptions.md new file mode 100644 index 0000000000..bc6120d0ab --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateDatabaseDtoSshOptions.md @@ -0,0 +1,31 @@ +# CreateDatabaseDtoSshOptions + +SSH Options + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of SSH server | [default to 'localhost'] +**port** | **number** | The port of SSH server | [default to 22] +**username** | **string** | SSH username | [optional] [default to undefined] +**password** | **string** | The SSH password | [optional] [default to undefined] +**privateKey** | **string** | The SSH private key | [optional] [default to undefined] +**passphrase** | **string** | The SSH passphrase | [optional] [default to undefined] + +## Example + +```typescript +import { CreateDatabaseDtoSshOptions } from './api'; + +const instance: CreateDatabaseDtoSshOptions = { + host, + port, + username, + password, + privateKey, + passphrase, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateHashWithExpireDto.md b/redisinsight/ui/src/api-client/docs/CreateHashWithExpireDto.md new file mode 100644 index 0000000000..7a2861fcaa --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateHashWithExpireDto.md @@ -0,0 +1,24 @@ +# CreateHashWithExpireDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**fields** | [**Array<HashFieldDto>**](HashFieldDto.md) | Hash fields | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateHashWithExpireDto } from './api'; + +const instance: CreateHashWithExpireDto = { + keyName, + fields, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateListWithExpireDto.md b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDto.md new file mode 100644 index 0000000000..2f99ab90ed --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDto.md @@ -0,0 +1,26 @@ +# CreateListWithExpireDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**elements** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | List element(s) | [default to undefined] +**destination** | **string** | In order to append elements to the end of the list, use the TAIL value, to prepend use HEAD value. Default: TAIL (when not specified) | [optional] [default to DestinationEnum_Tail] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateListWithExpireDto } from './api'; + +const instance: CreateListWithExpireDto = { + keyName, + elements, + destination, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoElementsInner.md b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoElementsInner.md new file mode 100644 index 0000000000..8efdb49dcd --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoElementsInner.md @@ -0,0 +1,22 @@ +# CreateListWithExpireDtoElementsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { CreateListWithExpireDtoElementsInner } from './api'; + +const instance: CreateListWithExpireDtoElementsInner = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoKeyName.md b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoKeyName.md new file mode 100644 index 0000000000..d2270961be --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoKeyName.md @@ -0,0 +1,23 @@ +# CreateListWithExpireDtoKeyName + +Key Name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { CreateListWithExpireDtoKeyName } from './api'; + +const instance: CreateListWithExpireDtoKeyName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoKeyNameOneOf.md b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoKeyNameOneOf.md new file mode 100644 index 0000000000..4fad7502c8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateListWithExpireDtoKeyNameOneOf.md @@ -0,0 +1,22 @@ +# CreateListWithExpireDtoKeyNameOneOf + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { CreateListWithExpireDtoKeyNameOneOf } from './api'; + +const instance: CreateListWithExpireDtoKeyNameOneOf = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateOrUpdateDatabaseSettingDto.md b/redisinsight/ui/src/api-client/docs/CreateOrUpdateDatabaseSettingDto.md new file mode 100644 index 0000000000..57f544c254 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateOrUpdateDatabaseSettingDto.md @@ -0,0 +1,20 @@ +# CreateOrUpdateDatabaseSettingDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **object** | Applied settings by user, by database | [default to undefined] + +## Example + +```typescript +import { CreateOrUpdateDatabaseSettingDto } from './api'; + +const instance: CreateOrUpdateDatabaseSettingDto = { + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreatePluginStateDto.md b/redisinsight/ui/src/api-client/docs/CreatePluginStateDto.md new file mode 100644 index 0000000000..125e0358c7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreatePluginStateDto.md @@ -0,0 +1,20 @@ +# CreatePluginStateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **string** | State can be anything except \"undefined\" | [default to undefined] + +## Example + +```typescript +import { CreatePluginStateDto } from './api'; + +const instance: CreatePluginStateDto = { + state, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateRdiDto.md b/redisinsight/ui/src/api-client/docs/CreateRdiDto.md new file mode 100644 index 0000000000..881c5d2abe --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateRdiDto.md @@ -0,0 +1,26 @@ +# CreateRdiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **string** | Base url of API to connect to (for API type only) | [optional] [default to undefined] +**name** | **string** | A name to associate with RDI | [default to undefined] +**username** | **string** | RDI or API username | [optional] [default to undefined] +**password** | **string** | RDI or API password | [optional] [default to undefined] + +## Example + +```typescript +import { CreateRdiDto } from './api'; + +const instance: CreateRdiDto = { + url, + name, + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexDto.md b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexDto.md new file mode 100644 index 0000000000..9b16b93797 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexDto.md @@ -0,0 +1,26 @@ +# CreateRedisearchIndexDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | [**CreateRedisearchIndexDtoIndex**](CreateRedisearchIndexDtoIndex.md) | | [default to undefined] +**type** | **string** | Type of keys to index | [default to undefined] +**prefixes** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Keys prefixes to find keys for index | [optional] [default to undefined] +**fields** | [**Array<CreateRedisearchIndexFieldDto>**](CreateRedisearchIndexFieldDto.md) | Fields to index | [default to undefined] + +## Example + +```typescript +import { CreateRedisearchIndexDto } from './api'; + +const instance: CreateRedisearchIndexDto = { + index, + type, + prefixes, + fields, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexDtoIndex.md b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexDtoIndex.md new file mode 100644 index 0000000000..93ee01fad8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexDtoIndex.md @@ -0,0 +1,23 @@ +# CreateRedisearchIndexDtoIndex + +Index Name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { CreateRedisearchIndexDtoIndex } from './api'; + +const instance: CreateRedisearchIndexDtoIndex = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexFieldDto.md b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexFieldDto.md new file mode 100644 index 0000000000..54c64f5aad --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexFieldDto.md @@ -0,0 +1,22 @@ +# CreateRedisearchIndexFieldDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**CreateRedisearchIndexFieldDtoName**](CreateRedisearchIndexFieldDtoName.md) | | [default to undefined] +**type** | **string** | Type of how data must be indexed | [default to undefined] + +## Example + +```typescript +import { CreateRedisearchIndexFieldDto } from './api'; + +const instance: CreateRedisearchIndexFieldDto = { + name, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexFieldDtoName.md b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexFieldDtoName.md new file mode 100644 index 0000000000..929e69ae07 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateRedisearchIndexFieldDtoName.md @@ -0,0 +1,23 @@ +# CreateRedisearchIndexFieldDtoName + +Name of field to be indexed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { CreateRedisearchIndexFieldDtoName } from './api'; + +const instance: CreateRedisearchIndexFieldDtoName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateRejsonRlWithExpireDto.md b/redisinsight/ui/src/api-client/docs/CreateRejsonRlWithExpireDto.md new file mode 100644 index 0000000000..e5fec4d942 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateRejsonRlWithExpireDto.md @@ -0,0 +1,24 @@ +# CreateRejsonRlWithExpireDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**data** | **string** | Valid json string | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateRejsonRlWithExpireDto } from './api'; + +const instance: CreateRejsonRlWithExpireDto = { + keyName, + data, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateSentinelDatabaseDto.md b/redisinsight/ui/src/api-client/docs/CreateSentinelDatabaseDto.md new file mode 100644 index 0000000000..fd9725c8a0 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateSentinelDatabaseDto.md @@ -0,0 +1,28 @@ +# CreateSentinelDatabaseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alias** | **string** | The name under which the base will be saved in the application. | [default to undefined] +**name** | **string** | Sentinel master group name. | [default to undefined] +**username** | **string** | The username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateSentinelDatabaseDto } from './api'; + +const instance: CreateSentinelDatabaseDto = { + alias, + name, + username, + password, + db, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateSentinelDatabaseResponse.md b/redisinsight/ui/src/api-client/docs/CreateSentinelDatabaseResponse.md new file mode 100644 index 0000000000..05134a87e9 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateSentinelDatabaseResponse.md @@ -0,0 +1,28 @@ +# CreateSentinelDatabaseResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Database instance id. | [optional] [default to undefined] +**name** | **string** | Sentinel master group name. | [default to undefined] +**status** | **string** | Add Sentinel Master status | [default to StatusEnum_Success] +**message** | **string** | Message | [default to undefined] +**error** | **object** | Error | [optional] [default to undefined] + +## Example + +```typescript +import { CreateSentinelDatabaseResponse } from './api'; + +const instance: CreateSentinelDatabaseResponse = { + id, + name, + status, + message, + error, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateSentinelDatabasesDto.md b/redisinsight/ui/src/api-client/docs/CreateSentinelDatabasesDto.md new file mode 100644 index 0000000000..16994ed925 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateSentinelDatabasesDto.md @@ -0,0 +1,62 @@ +# CreateSentinelDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**timeout** | **number** | Connection timeout | [optional] [default to 30000] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**sentinelMaster** | [**SentinelMaster**](SentinelMaster.md) | Redis OSS Sentinel master group. | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**keyNameFormat** | **string** | Key name format | [optional] [default to KeyNameFormatEnum_Unicode] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**caCert** | [**CreateDatabaseDtoCaCert**](CreateDatabaseDtoCaCert.md) | | [optional] [default to undefined] +**clientCert** | [**CreateDatabaseDtoClientCert**](CreateDatabaseDtoClientCert.md) | | [optional] [default to undefined] +**sshOptions** | [**CreateDatabaseDtoSshOptions**](CreateDatabaseDtoSshOptions.md) | | [optional] [default to undefined] +**tags** | [**Array<CreateTagDto>**](CreateTagDto.md) | Tags associated with the database. | [optional] [default to undefined] +**masters** | [**Array<CreateSentinelDatabaseDto>**](CreateSentinelDatabaseDto.md) | The Sentinel master group list. | [default to undefined] + +## Example + +```typescript +import { CreateSentinelDatabasesDto } from './api'; + +const instance: CreateSentinelDatabasesDto = { + host, + port, + db, + username, + password, + timeout, + nameFromProvider, + provider, + sentinelMaster, + tls, + tlsServername, + verifyServerCert, + ssh, + cloudDetails, + compressor, + keyNameFormat, + forceStandalone, + caCert, + clientCert, + sshOptions, + tags, + masters, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateSetWithExpireDto.md b/redisinsight/ui/src/api-client/docs/CreateSetWithExpireDto.md new file mode 100644 index 0000000000..83251fb369 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateSetWithExpireDto.md @@ -0,0 +1,24 @@ +# CreateSetWithExpireDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**members** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Set members | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateSetWithExpireDto } from './api'; + +const instance: CreateSetWithExpireDto = { + keyName, + members, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateStreamDto.md b/redisinsight/ui/src/api-client/docs/CreateStreamDto.md new file mode 100644 index 0000000000..3ceef86c6b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateStreamDto.md @@ -0,0 +1,24 @@ +# CreateStreamDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**entries** | [**Array<StreamEntryDto>**](StreamEntryDto.md) | Entries to push | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateStreamDto } from './api'; + +const instance: CreateStreamDto = { + keyName, + entries, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateSubscriptionAndDatabaseCloudJobDataDto.md b/redisinsight/ui/src/api-client/docs/CreateSubscriptionAndDatabaseCloudJobDataDto.md new file mode 100644 index 0000000000..4d503a6a8c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateSubscriptionAndDatabaseCloudJobDataDto.md @@ -0,0 +1,22 @@ +# CreateSubscriptionAndDatabaseCloudJobDataDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**planId** | **number** | Plan id for create a subscription. | [default to undefined] +**isRecommendedSettings** | **boolean** | Use recommended settings | [optional] [default to undefined] + +## Example + +```typescript +import { CreateSubscriptionAndDatabaseCloudJobDataDto } from './api'; + +const instance: CreateSubscriptionAndDatabaseCloudJobDataDto = { + planId, + isRecommendedSettings, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateTagDto.md b/redisinsight/ui/src/api-client/docs/CreateTagDto.md new file mode 100644 index 0000000000..72a29c1fcb --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateTagDto.md @@ -0,0 +1,22 @@ +# CreateTagDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | Key of the tag. | [default to undefined] +**value** | **string** | Value of the tag. | [default to undefined] + +## Example + +```typescript +import { CreateTagDto } from './api'; + +const instance: CreateTagDto = { + key, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CreateZSetWithExpireDto.md b/redisinsight/ui/src/api-client/docs/CreateZSetWithExpireDto.md new file mode 100644 index 0000000000..e9e24fb13b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CreateZSetWithExpireDto.md @@ -0,0 +1,24 @@ +# CreateZSetWithExpireDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**members** | [**Array<ZSetMemberDto>**](ZSetMemberDto.md) | ZSet members | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { CreateZSetWithExpireDto } from './api'; + +const instance: CreateZSetWithExpireDto = { + keyName, + members, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CustomTutorialManifest.md b/redisinsight/ui/src/api-client/docs/CustomTutorialManifest.md new file mode 100644 index 0000000000..aece16a407 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CustomTutorialManifest.md @@ -0,0 +1,30 @@ +# CustomTutorialManifest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**type** | **string** | | [default to undefined] +**label** | **string** | | [default to undefined] +**summary** | **string** | | [default to undefined] +**args** | [**CustomTutorialManifestArgs**](CustomTutorialManifestArgs.md) | | [optional] [default to undefined] +**children** | [**CustomTutorialManifest**](CustomTutorialManifest.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CustomTutorialManifest } from './api'; + +const instance: CustomTutorialManifest = { + id, + type, + label, + summary, + args, + children, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/CustomTutorialManifestArgs.md b/redisinsight/ui/src/api-client/docs/CustomTutorialManifestArgs.md new file mode 100644 index 0000000000..359c3f28c1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/CustomTutorialManifestArgs.md @@ -0,0 +1,24 @@ +# CustomTutorialManifestArgs + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **boolean** | | [optional] [default to undefined] +**initialIsOpen** | **boolean** | | [optional] [default to undefined] +**withBorder** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { CustomTutorialManifestArgs } from './api'; + +const instance: CustomTutorialManifestArgs = { + path, + initialIsOpen, + withBorder, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/Database.md b/redisinsight/ui/src/api-client/docs/Database.md new file mode 100644 index 0000000000..5510694da4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Database.md @@ -0,0 +1,80 @@ +# Database + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Database id. | [default to undefined] +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] +**name** | **string** | A name for your Redis database. | [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**timeout** | **number** | Connection timeout | [optional] [default to 30000] +**connectionType** | **string** | Connection Type | [default to ConnectionTypeEnum_Standalone] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**lastConnection** | **string** | Time of the last connection to the database. | [default to undefined] +**createdAt** | **string** | Date of creation | [default to undefined] +**sentinelMaster** | [**SentinelMaster**](SentinelMaster.md) | Redis OSS Sentinel master group. | [optional] [default to undefined] +**nodes** | [**Array<Endpoint>**](Endpoint.md) | OSS Cluster Nodes | [optional] [default to undefined] +**modules** | [**Array<AdditionalRedisModule>**](AdditionalRedisModule.md) | Loaded Redis modules. | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**caCert** | [**CaCertificate**](CaCertificate.md) | CA Certificate | [optional] [default to undefined] +**clientCert** | [**ClientCertificate**](ClientCertificate.md) | Client Certificate | [optional] [default to undefined] +**_new** | **boolean** | A new created connection | [optional] [default to false] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**sshOptions** | [**SshOptions**](SshOptions.md) | SSH options | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**keyNameFormat** | **string** | Key name format | [optional] [default to KeyNameFormatEnum_Unicode] +**version** | **string** | The version your Redis server | [optional] [default to undefined] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**tags** | [**Array<Tag>**](Tag.md) | Tags associated with the database. | [optional] [default to undefined] +**isPreSetup** | **boolean** | Whether the database was created from a file or environment variables at startup | [optional] [default to undefined] + +## Example + +```typescript +import { Database } from './api'; + +const instance: Database = { + id, + host, + port, + name, + db, + username, + password, + timeout, + connectionType, + nameFromProvider, + provider, + lastConnection, + createdAt, + sentinelMaster, + nodes, + modules, + tls, + tlsServername, + verifyServerCert, + caCert, + clientCert, + _new, + ssh, + sshOptions, + cloudDetails, + compressor, + keyNameFormat, + version, + forceStandalone, + tags, + isPreSetup, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseAnalysis.md b/redisinsight/ui/src/api-client/docs/DatabaseAnalysis.md new file mode 100644 index 0000000000..d204d4275c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseAnalysis.md @@ -0,0 +1,48 @@ +# DatabaseAnalysis + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Analysis id | [default to '76dd5654-814b-4e49-9c72-b236f50891f4'] +**databaseId** | **string** | Database id | [default to '76dd5654-814b-4e49-9c72-b236f50891f4'] +**filter** | [**ScanFilter**](ScanFilter.md) | Filters for scan operation | [default to undefined] +**delimiter** | **string** | Namespace delimiter | [default to ':'] +**progress** | [**AnalysisProgress**](AnalysisProgress.md) | Analysis progress | [default to undefined] +**createdAt** | **string** | Analysis created date (ISO string) | [default to 2022-09-16T06:29:20Z] +**totalKeys** | [**SimpleSummary**](SimpleSummary.md) | Total keys with details by types | [default to undefined] +**totalMemory** | [**SimpleSummary**](SimpleSummary.md) | Total memory with details by types | [default to undefined] +**topKeysNsp** | [**Array<NspSummary>**](NspSummary.md) | Top namespaces by keys number | [default to undefined] +**topMemoryNsp** | [**Array<NspSummary>**](NspSummary.md) | Top namespaces by memory | [default to undefined] +**topKeysLength** | [**Array<Key>**](Key.md) | Top keys by key length (string length, list elements count, etc.) | [default to undefined] +**topKeysMemory** | [**Array<Key>**](Key.md) | Top keys by memory used | [default to undefined] +**expirationGroups** | [**Array<SumGroup>**](SumGroup.md) | Expiration groups | [default to undefined] +**recommendations** | [**Array<Recommendation>**](Recommendation.md) | Recommendations | [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] + +## Example + +```typescript +import { DatabaseAnalysis } from './api'; + +const instance: DatabaseAnalysis = { + id, + databaseId, + filter, + delimiter, + progress, + createdAt, + totalKeys, + totalMemory, + topKeysNsp, + topMemoryNsp, + topKeysLength, + topKeysMemory, + expirationGroups, + recommendations, + db, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseAnalysisApi.md b/redisinsight/ui/src/api-client/docs/DatabaseAnalysisApi.md new file mode 100644 index 0000000000..facfcfc32c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseAnalysisApi.md @@ -0,0 +1,241 @@ +# DatabaseAnalysisApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**databaseAnalysisControllerCreate**](#databaseanalysiscontrollercreate) | **POST** /api/databases/{dbInstance}/analysis | | +|[**databaseAnalysisControllerGet**](#databaseanalysiscontrollerget) | **GET** /api/databases/{dbInstance}/analysis/{id} | | +|[**databaseAnalysisControllerList**](#databaseanalysiscontrollerlist) | **GET** /api/databases/{dbInstance}/analysis | | +|[**databaseAnalysisControllerModify**](#databaseanalysiscontrollermodify) | **PATCH** /api/databases/{dbInstance}/analysis/{id} | | + +# **databaseAnalysisControllerCreate** +> DatabaseAnalysis databaseAnalysisControllerCreate(createDatabaseAnalysisDto) + +Create new database analysis + +### Example + +```typescript +import { + DatabaseAnalysisApi, + Configuration, + CreateDatabaseAnalysisDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseAnalysisApi(configuration); + +let dbInstance: string; // (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) +let createDatabaseAnalysisDto: CreateDatabaseAnalysisDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseAnalysisControllerCreate( + dbInstance, + encoding, + createDatabaseAnalysisDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createDatabaseAnalysisDto** | **CreateDatabaseAnalysisDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DatabaseAnalysis** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseAnalysisControllerGet** +> DatabaseAnalysis databaseAnalysisControllerGet() + +Get database analysis + +### Example + +```typescript +import { + DatabaseAnalysisApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseAnalysisApi(configuration); + +let id: string; //Analysis id (default to undefined) +let dbInstance: string; //Database instance id (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) + +const { status, data } = await apiInstance.databaseAnalysisControllerGet( + id, + dbInstance, + encoding +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | Analysis id | defaults to undefined| +| **dbInstance** | [**string**] | Database instance id | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| + + +### Return type + +**DatabaseAnalysis** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseAnalysisControllerList** +> Array databaseAnalysisControllerList() + +Get database analysis list + +### Example + +```typescript +import { + DatabaseAnalysisApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseAnalysisApi(configuration); + +let dbInstance: string; //Database instance id (default to undefined) +let encoding: 'utf8' | 'ascii' | 'buffer'; // (default to undefined) + +const { status, data } = await apiInstance.databaseAnalysisControllerList( + dbInstance, + encoding +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id | defaults to undefined| +| **encoding** | [**'utf8' | 'ascii' | 'buffer'**]**Array<'utf8' | 'ascii' | 'buffer'>** | | defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseAnalysisControllerModify** +> DatabaseAnalysis databaseAnalysisControllerModify(recommendationVoteDto) + +Update database analysis by id + +### Example + +```typescript +import { + DatabaseAnalysisApi, + Configuration, + RecommendationVoteDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseAnalysisApi(configuration); + +let id: string; //Analysis id (default to undefined) +let dbInstance: string; //Database instance id (default to undefined) +let recommendationVoteDto: RecommendationVoteDto; // + +const { status, data } = await apiInstance.databaseAnalysisControllerModify( + id, + dbInstance, + recommendationVoteDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **recommendationVoteDto** | **RecommendationVoteDto**| | | +| **id** | [**string**] | Analysis id | defaults to undefined| +| **dbInstance** | [**string**] | Database instance id | defaults to undefined| + + +### Return type + +**DatabaseAnalysis** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated database analysis response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/DatabaseApi.md b/redisinsight/ui/src/api-client/docs/DatabaseApi.md new file mode 100644 index 0000000000..265b53b06c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseApi.md @@ -0,0 +1,639 @@ +# DatabaseApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**databaseControllerBulkDeleteDatabaseInstance**](#databasecontrollerbulkdeletedatabaseinstance) | **DELETE** /api/databases | | +|[**databaseControllerClone**](#databasecontrollerclone) | **POST** /api/databases/clone/{id} | | +|[**databaseControllerConnect**](#databasecontrollerconnect) | **GET** /api/databases/{id}/connect | | +|[**databaseControllerCreate**](#databasecontrollercreate) | **POST** /api/databases | | +|[**databaseControllerDeleteDatabaseInstance**](#databasecontrollerdeletedatabaseinstance) | **DELETE** /api/databases/{id} | | +|[**databaseControllerExportConnections**](#databasecontrollerexportconnections) | **POST** /api/databases/export | | +|[**databaseControllerGet**](#databasecontrollerget) | **GET** /api/databases/{id} | | +|[**databaseControllerList**](#databasecontrollerlist) | **GET** /api/databases | | +|[**databaseControllerTestConnection**](#databasecontrollertestconnection) | **POST** /api/databases/test | | +|[**databaseControllerTestExistConnection**](#databasecontrollertestexistconnection) | **POST** /api/databases/test/{id} | | +|[**databaseControllerUpdate**](#databasecontrollerupdate) | **PATCH** /api/databases/{id} | | +|[**databaseImportControllerImport**](#databaseimportcontrollerimport) | **POST** /api/databases/import | | + +# **databaseControllerBulkDeleteDatabaseInstance** +> DeleteDatabasesDto databaseControllerBulkDeleteDatabaseInstance(deleteDatabasesDto) + +Delete many databases by ids + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + DeleteDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let deleteDatabasesDto: DeleteDatabasesDto; // + +const { status, data } = await apiInstance.databaseControllerBulkDeleteDatabaseInstance( + deleteDatabasesDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteDatabasesDto** | **DeleteDatabasesDto**| | | + + +### Return type + +**DeleteDatabasesDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Delete many databases by ids response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerClone** +> DatabaseResponse databaseControllerClone(updateDatabaseDto) + +Update database instance by id + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + UpdateDatabaseDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let id: string; // (default to undefined) +let updateDatabaseDto: UpdateDatabaseDto; // + +const { status, data } = await apiInstance.databaseControllerClone( + id, + updateDatabaseDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateDatabaseDto** | **UpdateDatabaseDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**DatabaseResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated database instance\' response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerConnect** +> databaseControllerConnect() + +Connect to database instance by id + +### Example + +```typescript +import { + DatabaseApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.databaseControllerConnect( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successfully connected to database instance | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerCreate** +> DatabaseResponse databaseControllerCreate(createDatabaseDto) + +Add database instance + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + CreateDatabaseDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let createDatabaseDto: CreateDatabaseDto; // + +const { status, data } = await apiInstance.databaseControllerCreate( + createDatabaseDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createDatabaseDto** | **CreateDatabaseDto**| | | + + +### Return type + +**DatabaseResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created database instance | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerDeleteDatabaseInstance** +> databaseControllerDeleteDatabaseInstance() + +Delete database instance by id + +### Example + +```typescript +import { + DatabaseApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.databaseControllerDeleteDatabaseInstance( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerExportConnections** +> ExportDatabase databaseControllerExportConnections(exportDatabasesDto) + +Export many databases by ids. With or without passwords and certificates bodies. + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + ExportDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let exportDatabasesDto: ExportDatabasesDto; // + +const { status, data } = await apiInstance.databaseControllerExportConnections( + exportDatabasesDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **exportDatabasesDto** | **ExportDatabasesDto**| | | + + +### Return type + +**ExportDatabase** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Export many databases by ids response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerGet** +> DatabaseResponse databaseControllerGet() + +Get database instance by id + +### Example + +```typescript +import { + DatabaseApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.databaseControllerGet( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**DatabaseResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Database instance | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerList** +> Array databaseControllerList() + +Get databases list + +### Example + +```typescript +import { + DatabaseApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +const { status, data } = await apiInstance.databaseControllerList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerTestConnection** +> databaseControllerTestConnection(createDatabaseDto) + +Test connection + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + CreateDatabaseDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let createDatabaseDto: CreateDatabaseDto; // + +const { status, data } = await apiInstance.databaseControllerTestConnection( + createDatabaseDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createDatabaseDto** | **CreateDatabaseDto**| | | + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerTestExistConnection** +> databaseControllerTestExistConnection(updateDatabaseDto) + +Test connection + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + UpdateDatabaseDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let id: string; // (default to undefined) +let updateDatabaseDto: UpdateDatabaseDto; // + +const { status, data } = await apiInstance.databaseControllerTestExistConnection( + id, + updateDatabaseDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateDatabaseDto** | **UpdateDatabaseDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseControllerUpdate** +> DatabaseResponse databaseControllerUpdate(updateDatabaseDto) + +Update database instance by id + +### Example + +```typescript +import { + DatabaseApi, + Configuration, + UpdateDatabaseDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let id: string; // (default to undefined) +let updateDatabaseDto: UpdateDatabaseDto; // + +const { status, data } = await apiInstance.databaseControllerUpdate( + id, + updateDatabaseDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateDatabaseDto** | **UpdateDatabaseDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**DatabaseResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated database instance\' response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseImportControllerImport** +> DatabaseImportResponse databaseImportControllerImport() + + +### Example + +```typescript +import { + DatabaseApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseApi(configuration); + +let file: File; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseImportControllerImport( + file +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **file** | [**File**] | | (optional) defaults to undefined| + + +### Return type + +**DatabaseImportResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**0** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/DatabaseDatabaseSettingsApi.md b/redisinsight/ui/src/api-client/docs/DatabaseDatabaseSettingsApi.md new file mode 100644 index 0000000000..086effd648 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseDatabaseSettingsApi.md @@ -0,0 +1,167 @@ +# DatabaseDatabaseSettingsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**databaseSettingsControllerCreate**](#databasesettingscontrollercreate) | **POST** /api/databases/{dbInstance}/settings | | +|[**databaseSettingsControllerDelete**](#databasesettingscontrollerdelete) | **DELETE** /api/databases/{dbInstance}/settings | | +|[**databaseSettingsControllerGet**](#databasesettingscontrollerget) | **GET** /api/databases/{dbInstance}/settings | | + +# **databaseSettingsControllerCreate** +> DatabaseSettings databaseSettingsControllerCreate(createOrUpdateDatabaseSettingDto) + +Update database settings + +### Example + +```typescript +import { + DatabaseDatabaseSettingsApi, + Configuration, + CreateOrUpdateDatabaseSettingDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseDatabaseSettingsApi(configuration); + +let dbInstance: string; // (default to undefined) +let createOrUpdateDatabaseSettingDto: CreateOrUpdateDatabaseSettingDto; // + +const { status, data } = await apiInstance.databaseSettingsControllerCreate( + dbInstance, + createOrUpdateDatabaseSettingDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createOrUpdateDatabaseSettingDto** | **CreateOrUpdateDatabaseSettingDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +**DatabaseSettings** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseSettingsControllerDelete** +> databaseSettingsControllerDelete() + +Delete database settings + +### Example + +```typescript +import { + DatabaseDatabaseSettingsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseDatabaseSettingsApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) + +const { status, data } = await apiInstance.databaseSettingsControllerDelete( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseSettingsControllerGet** +> DatabaseSettings databaseSettingsControllerGet() + +Get database settings + +### Example + +```typescript +import { + DatabaseDatabaseSettingsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseDatabaseSettingsApi(configuration); + +let dbInstance: string; // (default to undefined) + +const { status, data } = await apiInstance.databaseSettingsControllerGet( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +**DatabaseSettings** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/DatabaseImportResponse.md b/redisinsight/ui/src/api-client/docs/DatabaseImportResponse.md new file mode 100644 index 0000000000..fa6752ddef --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseImportResponse.md @@ -0,0 +1,26 @@ +# DatabaseImportResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **number** | Total elements processed from the import file | [default to undefined] +**success** | [**DatabaseImportResult**](DatabaseImportResult.md) | List of successfully imported database | [default to undefined] +**partial** | [**DatabaseImportResult**](DatabaseImportResult.md) | List of partially imported database | [default to undefined] +**fail** | [**DatabaseImportResult**](DatabaseImportResult.md) | List of databases failed to import | [default to undefined] + +## Example + +```typescript +import { DatabaseImportResponse } from './api'; + +const instance: DatabaseImportResponse = { + total, + success, + partial, + fail, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseImportResult.md b/redisinsight/ui/src/api-client/docs/DatabaseImportResult.md new file mode 100644 index 0000000000..9cced6bb9b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseImportResult.md @@ -0,0 +1,28 @@ +# DatabaseImportResult + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **number** | Entry index from original json | [default to undefined] +**status** | **string** | Import status | [default to undefined] +**host** | **string** | Database host | [optional] [default to undefined] +**port** | **number** | Database port | [optional] [default to undefined] +**errors** | **string** | Error message if any | [optional] [default to undefined] + +## Example + +```typescript +import { DatabaseImportResult } from './api'; + +const instance: DatabaseImportResult = { + index, + status, + host, + port, + errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseInstancesApi.md b/redisinsight/ui/src/api-client/docs/DatabaseInstancesApi.md new file mode 100644 index 0000000000..0cc290ed0f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseInstancesApi.md @@ -0,0 +1,175 @@ +# DatabaseInstancesApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**databaseInfoControllerGetDatabaseIndex**](#databaseinfocontrollergetdatabaseindex) | **GET** /api/databases/{id}/db/{index} | | +|[**databaseInfoControllerGetDatabaseOverview**](#databaseinfocontrollergetdatabaseoverview) | **GET** /api/databases/{id}/overview | | +|[**databaseInfoControllerGetInfo**](#databaseinfocontrollergetinfo) | **GET** /api/databases/{id}/info | | + +# **databaseInfoControllerGetDatabaseIndex** +> databaseInfoControllerGetDatabaseIndex() + +Try to create connection to specified database index + +### Example + +```typescript +import { + DatabaseInstancesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseInstancesApi(configuration); + +let index: object; // (default to undefined) +let id: string; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseInfoControllerGetDatabaseIndex( + index, + id, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **index** | **object** | | defaults to undefined| +| **id** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseInfoControllerGetDatabaseOverview** +> DatabaseOverview databaseInfoControllerGetDatabaseOverview() + +Get Redis database overview + +### Example + +```typescript +import { + DatabaseInstancesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseInstancesApi(configuration); + +let id: string; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) +let keyspace: 'full' | 'current'; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseInfoControllerGetDatabaseOverview( + id, + riDbIndex, + keyspace +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| +| **keyspace** | [**'full' | 'current'**]**Array<'full' | 'current'>** | | (optional) defaults to undefined| + + +### Return type + +**DatabaseOverview** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Redis database overview | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseInfoControllerGetInfo** +> RedisDatabaseInfoResponse databaseInfoControllerGetInfo() + +Get Redis database config info + +### Example + +```typescript +import { + DatabaseInstancesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseInstancesApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.databaseInfoControllerGetInfo( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**RedisDatabaseInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Redis database info | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/DatabaseOverview.md b/redisinsight/ui/src/api-client/docs/DatabaseOverview.md new file mode 100644 index 0000000000..6ee183fab2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseOverview.md @@ -0,0 +1,40 @@ +# DatabaseOverview + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Redis database version | [default to undefined] +**usedMemory** | **number** | Total number of bytes allocated by Redis primary shards | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**totalKeys** | **number** | Total number of keys inside Redis primary shards | [optional] [default to undefined] +**totalKeysPerDb** | **number** | Nested object with total number of keys per logical database | [optional] [default to undefined] +**connectedClients** | **number** | Median for connected clients in the all shards | [optional] [default to undefined] +**opsPerSecond** | **number** | Sum of current commands per second in the all shards | [optional] [default to undefined] +**networkInKbps** | **number** | Sum of current network input in the all shards (kbps) | [optional] [default to undefined] +**networkOutKbps** | **number** | Sum of current network out in the all shards (kbps) | [optional] [default to undefined] +**cpuUsagePercentage** | **number** | Sum of current cpu usage in the all shards (%) | [optional] [default to undefined] +**serverName** | **string** | Database server name | [default to undefined] + +## Example + +```typescript +import { DatabaseOverview } from './api'; + +const instance: DatabaseOverview = { + version, + usedMemory, + cloudDetails, + totalKeys, + totalKeysPerDb, + connectedClients, + opsPerSecond, + networkInKbps, + networkOutKbps, + cpuUsagePercentage, + serverName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseRecommendation.md b/redisinsight/ui/src/api-client/docs/DatabaseRecommendation.md new file mode 100644 index 0000000000..cf1c442896 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseRecommendation.md @@ -0,0 +1,34 @@ +# DatabaseRecommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Recommendation id | [default to undefined] +**name** | **string** | Recommendation name | [default to undefined] +**databaseId** | **string** | Database ID to which recommendation belongs | [default to undefined] +**read** | **boolean** | Determines if recommendation was shown to user | [optional] [default to undefined] +**disabled** | **boolean** | Should this recommendation shown to user | [optional] [default to undefined] +**vote** | **string** | Recommendation vote | [optional] [default to VoteEnum_Useful] +**hide** | **boolean** | Should this recommendation hidden | [optional] [default to undefined] +**params** | **object** | Additional recommendation params | [optional] [default to undefined] + +## Example + +```typescript +import { DatabaseRecommendation } from './api'; + +const instance: DatabaseRecommendation = { + id, + name, + databaseId, + read, + disabled, + vote, + hide, + params, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseRecommendationsApi.md b/redisinsight/ui/src/api-client/docs/DatabaseRecommendationsApi.md new file mode 100644 index 0000000000..a41f080af4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseRecommendationsApi.md @@ -0,0 +1,238 @@ +# DatabaseRecommendationsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**databaseRecommendationControllerBulkDeleteDatabaseRecommendation**](#databaserecommendationcontrollerbulkdeletedatabaserecommendation) | **DELETE** /api/databases/{dbInstance}/recommendations | | +|[**databaseRecommendationControllerList**](#databaserecommendationcontrollerlist) | **GET** /api/databases/{dbInstance}/recommendations | | +|[**databaseRecommendationControllerModify**](#databaserecommendationcontrollermodify) | **PATCH** /api/databases/{dbInstance}/recommendations/{id} | | +|[**databaseRecommendationControllerRead**](#databaserecommendationcontrollerread) | **PATCH** /api/databases/{dbInstance}/recommendations/read | | + +# **databaseRecommendationControllerBulkDeleteDatabaseRecommendation** +> DeleteDatabaseRecommendationResponse databaseRecommendationControllerBulkDeleteDatabaseRecommendation(deleteDatabaseRecommendationDto) + +Delete many recommendations by ids + +### Example + +```typescript +import { + DatabaseRecommendationsApi, + Configuration, + DeleteDatabaseRecommendationDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseRecommendationsApi(configuration); + +let dbInstance: string; // (default to undefined) +let deleteDatabaseRecommendationDto: DeleteDatabaseRecommendationDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseRecommendationControllerBulkDeleteDatabaseRecommendation( + dbInstance, + deleteDatabaseRecommendationDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **deleteDatabaseRecommendationDto** | **DeleteDatabaseRecommendationDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DeleteDatabaseRecommendationResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Delete many recommendations by ids response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseRecommendationControllerList** +> DatabaseRecommendationsResponse databaseRecommendationControllerList() + +Get database recommendations + +### Example + +```typescript +import { + DatabaseRecommendationsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseRecommendationsApi(configuration); + +let dbInstance: string; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseRecommendationControllerList( + dbInstance, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DatabaseRecommendationsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseRecommendationControllerModify** +> DatabaseRecommendation databaseRecommendationControllerModify(modifyDatabaseRecommendationDto) + +Update database recommendation by id + +### Example + +```typescript +import { + DatabaseRecommendationsApi, + Configuration, + ModifyDatabaseRecommendationDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseRecommendationsApi(configuration); + +let id: string; // (default to undefined) +let dbInstance: string; // (default to undefined) +let modifyDatabaseRecommendationDto: ModifyDatabaseRecommendationDto; // +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseRecommendationControllerModify( + id, + dbInstance, + modifyDatabaseRecommendationDto, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **modifyDatabaseRecommendationDto** | **ModifyDatabaseRecommendationDto**| | | +| **id** | [**string**] | | defaults to undefined| +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +**DatabaseRecommendation** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated database recommendation\' response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **databaseRecommendationControllerRead** +> databaseRecommendationControllerRead() + +Mark all database recommendations as read + +### Example + +```typescript +import { + DatabaseRecommendationsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DatabaseRecommendationsApi(configuration); + +let dbInstance: string; // (default to undefined) +let riDbIndex: number; // (optional) (default to undefined) + +const { status, data } = await apiInstance.databaseRecommendationControllerRead( + dbInstance, + riDbIndex +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **riDbIndex** | [**number**] | | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/DatabaseRecommendationsResponse.md b/redisinsight/ui/src/api-client/docs/DatabaseRecommendationsResponse.md new file mode 100644 index 0000000000..adbabf4f26 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseRecommendationsResponse.md @@ -0,0 +1,22 @@ +# DatabaseRecommendationsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommendations** | [**Array<DatabaseRecommendation>**](DatabaseRecommendation.md) | Ordered recommendations list | [default to undefined] +**totalUnread** | **number** | Number of unread recommendations | [default to undefined] + +## Example + +```typescript +import { DatabaseRecommendationsResponse } from './api'; + +const instance: DatabaseRecommendationsResponse = { + recommendations, + totalUnread, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseResponse.md b/redisinsight/ui/src/api-client/docs/DatabaseResponse.md new file mode 100644 index 0000000000..8af1cff8b9 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseResponse.md @@ -0,0 +1,80 @@ +# DatabaseResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Database id. | [default to undefined] +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] +**name** | **string** | A name for your Redis database. | [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**timeout** | **number** | Connection timeout | [optional] [default to 30000] +**connectionType** | **string** | Connection Type | [default to ConnectionTypeEnum_Standalone] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**lastConnection** | **string** | Time of the last connection to the database. | [default to undefined] +**createdAt** | **string** | Date of creation | [default to undefined] +**nodes** | [**Array<Endpoint>**](Endpoint.md) | OSS Cluster Nodes | [optional] [default to undefined] +**modules** | [**Array<AdditionalRedisModule>**](AdditionalRedisModule.md) | Loaded Redis modules. | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**caCert** | [**CaCertificate**](CaCertificate.md) | CA Certificate | [optional] [default to undefined] +**clientCert** | [**ClientCertificate**](ClientCertificate.md) | Client Certificate | [optional] [default to undefined] +**_new** | **boolean** | A new created connection | [optional] [default to false] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**keyNameFormat** | **string** | Key name format | [optional] [default to KeyNameFormatEnum_Unicode] +**version** | **string** | The version your Redis server | [optional] [default to undefined] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**tags** | [**Array<Tag>**](Tag.md) | Tags associated with the database. | [optional] [default to undefined] +**isPreSetup** | **boolean** | Whether the database was created from a file or environment variables at startup | [optional] [default to undefined] +**password** | **boolean** | The database password flag (true if password was set) | [optional] [default to undefined] +**sshOptions** | [**SshOptionsResponse**](SshOptionsResponse.md) | Ssh options | [optional] [default to undefined] +**sentinelMaster** | [**SentinelMasterResponse**](SentinelMasterResponse.md) | Sentinel master | [optional] [default to undefined] + +## Example + +```typescript +import { DatabaseResponse } from './api'; + +const instance: DatabaseResponse = { + id, + host, + port, + name, + db, + username, + timeout, + connectionType, + nameFromProvider, + provider, + lastConnection, + createdAt, + nodes, + modules, + tls, + tlsServername, + verifyServerCert, + caCert, + clientCert, + _new, + ssh, + cloudDetails, + compressor, + keyNameFormat, + version, + forceStandalone, + tags, + isPreSetup, + password, + sshOptions, + sentinelMaster, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DatabaseSettings.md b/redisinsight/ui/src/api-client/docs/DatabaseSettings.md new file mode 100644 index 0000000000..da451e558b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DatabaseSettings.md @@ -0,0 +1,22 @@ +# DatabaseSettings + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**databaseId** | **string** | Database id | [default to '123'] +**data** | **object** | Applied settings by user, by database | [default to undefined] + +## Example + +```typescript +import { DatabaseSettings } from './api'; + +const instance: DatabaseSettings = { + databaseId, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteBrowserHistoryItemsDto.md b/redisinsight/ui/src/api-client/docs/DeleteBrowserHistoryItemsDto.md new file mode 100644 index 0000000000..38fdb4be38 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteBrowserHistoryItemsDto.md @@ -0,0 +1,20 @@ +# DeleteBrowserHistoryItemsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **Array<string>** | The unique ID of the browser history requested | [default to undefined] + +## Example + +```typescript +import { DeleteBrowserHistoryItemsDto } from './api'; + +const instance: DeleteBrowserHistoryItemsDto = { + ids, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteBrowserHistoryItemsResponse.md b/redisinsight/ui/src/api-client/docs/DeleteBrowserHistoryItemsResponse.md new file mode 100644 index 0000000000..6bc9b7242b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteBrowserHistoryItemsResponse.md @@ -0,0 +1,20 @@ +# DeleteBrowserHistoryItemsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected browser history items | [default to undefined] + +## Example + +```typescript +import { DeleteBrowserHistoryItemsResponse } from './api'; + +const instance: DeleteBrowserHistoryItemsResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteClientResponse.md b/redisinsight/ui/src/api-client/docs/DeleteClientResponse.md new file mode 100644 index 0000000000..83e745a5c7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteClientResponse.md @@ -0,0 +1,20 @@ +# DeleteClientResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected clients | [default to undefined] + +## Example + +```typescript +import { DeleteClientResponse } from './api'; + +const instance: DeleteClientResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteConsumerGroupsDto.md b/redisinsight/ui/src/api-client/docs/DeleteConsumerGroupsDto.md new file mode 100644 index 0000000000..97b407455a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteConsumerGroupsDto.md @@ -0,0 +1,22 @@ +# DeleteConsumerGroupsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**consumerGroups** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Consumer group names | [default to undefined] + +## Example + +```typescript +import { DeleteConsumerGroupsDto } from './api'; + +const instance: DeleteConsumerGroupsDto = { + keyName, + consumerGroups, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteConsumerGroupsResponse.md b/redisinsight/ui/src/api-client/docs/DeleteConsumerGroupsResponse.md new file mode 100644 index 0000000000..c5750799cd --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteConsumerGroupsResponse.md @@ -0,0 +1,20 @@ +# DeleteConsumerGroupsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of deleted consumer groups | [default to undefined] + +## Example + +```typescript +import { DeleteConsumerGroupsResponse } from './api'; + +const instance: DeleteConsumerGroupsResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteConsumersDto.md b/redisinsight/ui/src/api-client/docs/DeleteConsumersDto.md new file mode 100644 index 0000000000..49fa0ed007 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteConsumersDto.md @@ -0,0 +1,24 @@ +# DeleteConsumersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**groupName** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] +**consumerNames** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Names of consumers to delete | [default to undefined] + +## Example + +```typescript +import { DeleteConsumersDto } from './api'; + +const instance: DeleteConsumersDto = { + keyName, + groupName, + consumerNames, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteDatabaseRecommendationDto.md b/redisinsight/ui/src/api-client/docs/DeleteDatabaseRecommendationDto.md new file mode 100644 index 0000000000..6681e7da28 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteDatabaseRecommendationDto.md @@ -0,0 +1,20 @@ +# DeleteDatabaseRecommendationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **Array<string>** | The unique IDs of the database recommendation requested | [default to undefined] + +## Example + +```typescript +import { DeleteDatabaseRecommendationDto } from './api'; + +const instance: DeleteDatabaseRecommendationDto = { + ids, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteDatabaseRecommendationResponse.md b/redisinsight/ui/src/api-client/docs/DeleteDatabaseRecommendationResponse.md new file mode 100644 index 0000000000..3fa2cbc4b3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteDatabaseRecommendationResponse.md @@ -0,0 +1,20 @@ +# DeleteDatabaseRecommendationResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected recommendations | [default to undefined] + +## Example + +```typescript +import { DeleteDatabaseRecommendationResponse } from './api'; + +const instance: DeleteDatabaseRecommendationResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteDatabasesDto.md b/redisinsight/ui/src/api-client/docs/DeleteDatabasesDto.md new file mode 100644 index 0000000000..608f2578b2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteDatabasesDto.md @@ -0,0 +1,20 @@ +# DeleteDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **Array<string>** | The unique ID of the database requested | [default to undefined] + +## Example + +```typescript +import { DeleteDatabasesDto } from './api'; + +const instance: DeleteDatabasesDto = { + ids, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteFieldsFromHashDto.md b/redisinsight/ui/src/api-client/docs/DeleteFieldsFromHashDto.md new file mode 100644 index 0000000000..f02f4f918c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteFieldsFromHashDto.md @@ -0,0 +1,22 @@ +# DeleteFieldsFromHashDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**fields** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Hash fields | [default to undefined] + +## Example + +```typescript +import { DeleteFieldsFromHashDto } from './api'; + +const instance: DeleteFieldsFromHashDto = { + keyName, + fields, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteFieldsFromHashResponse.md b/redisinsight/ui/src/api-client/docs/DeleteFieldsFromHashResponse.md new file mode 100644 index 0000000000..9dd5248a5e --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteFieldsFromHashResponse.md @@ -0,0 +1,20 @@ +# DeleteFieldsFromHashResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected fields | [default to undefined] + +## Example + +```typescript +import { DeleteFieldsFromHashResponse } from './api'; + +const instance: DeleteFieldsFromHashResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteKeysDto.md b/redisinsight/ui/src/api-client/docs/DeleteKeysDto.md new file mode 100644 index 0000000000..25c3bfe18b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteKeysDto.md @@ -0,0 +1,20 @@ +# DeleteKeysDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyNames** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Key name | [default to undefined] + +## Example + +```typescript +import { DeleteKeysDto } from './api'; + +const instance: DeleteKeysDto = { + keyNames, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteKeysResponse.md b/redisinsight/ui/src/api-client/docs/DeleteKeysResponse.md new file mode 100644 index 0000000000..403953a3e7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteKeysResponse.md @@ -0,0 +1,20 @@ +# DeleteKeysResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected keys | [default to undefined] + +## Example + +```typescript +import { DeleteKeysResponse } from './api'; + +const instance: DeleteKeysResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteListElementsDto.md b/redisinsight/ui/src/api-client/docs/DeleteListElementsDto.md new file mode 100644 index 0000000000..de6c1f159e --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteListElementsDto.md @@ -0,0 +1,24 @@ +# DeleteListElementsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**destination** | **string** | In order to remove last elements of the list, use the TAIL value, else HEAD value | [default to DestinationEnum_Tail] +**count** | **number** | Specifying the number of elements to remove from list. | [default to 1] + +## Example + +```typescript +import { DeleteListElementsDto } from './api'; + +const instance: DeleteListElementsDto = { + keyName, + destination, + count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteListElementsResponse.md b/redisinsight/ui/src/api-client/docs/DeleteListElementsResponse.md new file mode 100644 index 0000000000..bb10e6bec1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteListElementsResponse.md @@ -0,0 +1,20 @@ +# DeleteListElementsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**elements** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Removed elements from list | [default to undefined] + +## Example + +```typescript +import { DeleteListElementsResponse } from './api'; + +const instance: DeleteListElementsResponse = { + elements, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteMembersFromSetDto.md b/redisinsight/ui/src/api-client/docs/DeleteMembersFromSetDto.md new file mode 100644 index 0000000000..1df7325774 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteMembersFromSetDto.md @@ -0,0 +1,22 @@ +# DeleteMembersFromSetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**members** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Key members | [default to undefined] + +## Example + +```typescript +import { DeleteMembersFromSetDto } from './api'; + +const instance: DeleteMembersFromSetDto = { + keyName, + members, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteMembersFromSetResponse.md b/redisinsight/ui/src/api-client/docs/DeleteMembersFromSetResponse.md new file mode 100644 index 0000000000..301c9482dd --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteMembersFromSetResponse.md @@ -0,0 +1,20 @@ +# DeleteMembersFromSetResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected members | [default to undefined] + +## Example + +```typescript +import { DeleteMembersFromSetResponse } from './api'; + +const instance: DeleteMembersFromSetResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteMembersFromZSetDto.md b/redisinsight/ui/src/api-client/docs/DeleteMembersFromZSetDto.md new file mode 100644 index 0000000000..0ed128fed4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteMembersFromZSetDto.md @@ -0,0 +1,22 @@ +# DeleteMembersFromZSetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**members** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Key members | [default to undefined] + +## Example + +```typescript +import { DeleteMembersFromZSetDto } from './api'; + +const instance: DeleteMembersFromZSetDto = { + keyName, + members, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteMembersFromZSetResponse.md b/redisinsight/ui/src/api-client/docs/DeleteMembersFromZSetResponse.md new file mode 100644 index 0000000000..f55a7befaa --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteMembersFromZSetResponse.md @@ -0,0 +1,20 @@ +# DeleteMembersFromZSetResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of affected members | [default to undefined] + +## Example + +```typescript +import { DeleteMembersFromZSetResponse } from './api'; + +const instance: DeleteMembersFromZSetResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteStreamEntriesDto.md b/redisinsight/ui/src/api-client/docs/DeleteStreamEntriesDto.md new file mode 100644 index 0000000000..71b96e2ee7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteStreamEntriesDto.md @@ -0,0 +1,22 @@ +# DeleteStreamEntriesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**entries** | **Array<string>** | Entries IDs | [default to undefined] + +## Example + +```typescript +import { DeleteStreamEntriesDto } from './api'; + +const instance: DeleteStreamEntriesDto = { + keyName, + entries, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DeleteStreamEntriesResponse.md b/redisinsight/ui/src/api-client/docs/DeleteStreamEntriesResponse.md new file mode 100644 index 0000000000..b1744db582 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DeleteStreamEntriesResponse.md @@ -0,0 +1,20 @@ +# DeleteStreamEntriesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of deleted entries | [default to undefined] + +## Example + +```typescript +import { DeleteStreamEntriesResponse } from './api'; + +const instance: DeleteStreamEntriesResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DiscoverCloudDatabasesDto.md b/redisinsight/ui/src/api-client/docs/DiscoverCloudDatabasesDto.md new file mode 100644 index 0000000000..be4e736921 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DiscoverCloudDatabasesDto.md @@ -0,0 +1,20 @@ +# DiscoverCloudDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptions** | [**Array<GetCloudSubscriptionDatabasesDto>**](GetCloudSubscriptionDatabasesDto.md) | Subscriptions where to discover databases | [default to undefined] + +## Example + +```typescript +import { DiscoverCloudDatabasesDto } from './api'; + +const instance: DiscoverCloudDatabasesDto = { + subscriptions, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/DiscoverSentinelMastersDto.md b/redisinsight/ui/src/api-client/docs/DiscoverSentinelMastersDto.md new file mode 100644 index 0000000000..c19ea14528 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/DiscoverSentinelMastersDto.md @@ -0,0 +1,58 @@ +# DiscoverSentinelMastersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**timeout** | **number** | Connection timeout | [optional] [default to 30000] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**sentinelMaster** | [**SentinelMaster**](SentinelMaster.md) | Redis OSS Sentinel master group. | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**keyNameFormat** | **string** | Key name format | [optional] [default to KeyNameFormatEnum_Unicode] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**caCert** | [**CreateDatabaseDtoCaCert**](CreateDatabaseDtoCaCert.md) | | [optional] [default to undefined] +**clientCert** | [**CreateDatabaseDtoClientCert**](CreateDatabaseDtoClientCert.md) | | [optional] [default to undefined] +**sshOptions** | [**CreateDatabaseDtoSshOptions**](CreateDatabaseDtoSshOptions.md) | | [optional] [default to undefined] +**tags** | [**Array<CreateTagDto>**](CreateTagDto.md) | Tags associated with the database. | [optional] [default to undefined] + +## Example + +```typescript +import { DiscoverSentinelMastersDto } from './api'; + +const instance: DiscoverSentinelMastersDto = { + host, + port, + username, + password, + timeout, + nameFromProvider, + provider, + sentinelMaster, + tls, + tlsServername, + verifyServerCert, + ssh, + cloudDetails, + compressor, + keyNameFormat, + forceStandalone, + caCert, + clientCert, + sshOptions, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/Endpoint.md b/redisinsight/ui/src/api-client/docs/Endpoint.md new file mode 100644 index 0000000000..ac95f74b90 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Endpoint.md @@ -0,0 +1,22 @@ +# Endpoint + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] + +## Example + +```typescript +import { Endpoint } from './api'; + +const instance: Endpoint = { + host, + port, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ExportDatabase.md b/redisinsight/ui/src/api-client/docs/ExportDatabase.md new file mode 100644 index 0000000000..19bd820117 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ExportDatabase.md @@ -0,0 +1,64 @@ +# ExportDatabase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Database id. | [default to undefined] +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [default to 6379] +**name** | **string** | A name for your Redis database. | [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**connectionType** | **string** | Connection Type | [default to ConnectionTypeEnum_Standalone] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**lastConnection** | **string** | Time of the last connection to the database. | [default to undefined] +**sentinelMaster** | [**SentinelMaster**](SentinelMaster.md) | Redis OSS Sentinel master group. | [optional] [default to undefined] +**modules** | [**Array<AdditionalRedisModule>**](AdditionalRedisModule.md) | Loaded Redis modules. | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**caCert** | [**CaCertificate**](CaCertificate.md) | CA Certificate | [optional] [default to undefined] +**clientCert** | [**ClientCertificate**](ClientCertificate.md) | Client Certificate | [optional] [default to undefined] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**sshOptions** | [**SshOptions**](SshOptions.md) | SSH options | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**tags** | [**Array<Tag>**](Tag.md) | Tags associated with the database. | [optional] [default to undefined] + +## Example + +```typescript +import { ExportDatabase } from './api'; + +const instance: ExportDatabase = { + id, + host, + port, + name, + db, + username, + password, + connectionType, + nameFromProvider, + provider, + lastConnection, + sentinelMaster, + modules, + tls, + tlsServername, + verifyServerCert, + caCert, + clientCert, + ssh, + sshOptions, + compressor, + forceStandalone, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ExportDatabasesDto.md b/redisinsight/ui/src/api-client/docs/ExportDatabasesDto.md new file mode 100644 index 0000000000..dc2f5f30eb --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ExportDatabasesDto.md @@ -0,0 +1,22 @@ +# ExportDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **Array<string>** | The unique IDs of the databases requested | [default to undefined] +**withSecrets** | **boolean** | Export passwords and certificate bodies | [optional] [default to undefined] + +## Example + +```typescript +import { ExportDatabasesDto } from './api'; + +const instance: ExportDatabasesDto = { + ids, + withSecrets, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/FieldStatisticsDto.md b/redisinsight/ui/src/api-client/docs/FieldStatisticsDto.md new file mode 100644 index 0000000000..c4a77645c7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/FieldStatisticsDto.md @@ -0,0 +1,24 @@ +# FieldStatisticsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifier** | **string** | Field identifier | [default to undefined] +**attribute** | **string** | Field attribute | [default to undefined] +**Index_Errors** | **object** | Field errors | [default to undefined] + +## Example + +```typescript +import { FieldStatisticsDto } from './api'; + +const instance: FieldStatisticsDto = { + identifier, + attribute, + Index_Errors, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetAgreementsSpecResponse.md b/redisinsight/ui/src/api-client/docs/GetAgreementsSpecResponse.md new file mode 100644 index 0000000000..7426f008c8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetAgreementsSpecResponse.md @@ -0,0 +1,22 @@ +# GetAgreementsSpecResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Version of agreements specification. | [default to undefined] +**agreements** | **object** | Agreements specification. | [default to undefined] + +## Example + +```typescript +import { GetAgreementsSpecResponse } from './api'; + +const instance: GetAgreementsSpecResponse = { + version, + agreements, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetAppSettingsResponse.md b/redisinsight/ui/src/api-client/docs/GetAppSettingsResponse.md new file mode 100644 index 0000000000..5a860ccfcc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetAppSettingsResponse.md @@ -0,0 +1,32 @@ +# GetAppSettingsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**theme** | **string** | Applied application theme. | [default to undefined] +**dateFormat** | **string** | Applied application date format | [default to undefined] +**timezone** | **string** | Applied application timezone | [default to undefined] +**scanThreshold** | **number** | Applied the threshold for scan operation. | [default to undefined] +**batchSize** | **number** | Applied the batch of the commands for workbench. | [default to undefined] +**acceptTermsAndConditionsOverwritten** | **boolean** | Flag indicating that terms and conditions are accepted via environment variable | [default to undefined] +**agreements** | [**GetUserAgreementsResponse**](GetUserAgreementsResponse.md) | Agreements set by the user. | [default to undefined] + +## Example + +```typescript +import { GetAppSettingsResponse } from './api'; + +const instance: GetAppSettingsResponse = { + theme, + dateFormat, + timezone, + scanThreshold, + batchSize, + acceptTermsAndConditionsOverwritten, + agreements, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetCloudSubscriptionDatabasesDto.md b/redisinsight/ui/src/api-client/docs/GetCloudSubscriptionDatabasesDto.md new file mode 100644 index 0000000000..c6c6aeab12 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetCloudSubscriptionDatabasesDto.md @@ -0,0 +1,24 @@ +# GetCloudSubscriptionDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription Id | [default to undefined] +**subscriptionType** | **string** | Subscription Id | [default to undefined] +**free** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { GetCloudSubscriptionDatabasesDto } from './api'; + +const instance: GetCloudSubscriptionDatabasesDto = { + subscriptionId, + subscriptionType, + free, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetConsumersDto.md b/redisinsight/ui/src/api-client/docs/GetConsumersDto.md new file mode 100644 index 0000000000..a0b21a591e --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetConsumersDto.md @@ -0,0 +1,22 @@ +# GetConsumersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**groupName** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] + +## Example + +```typescript +import { GetConsumersDto } from './api'; + +const instance: GetConsumersDto = { + keyName, + groupName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetConsumersDtoGroupName.md b/redisinsight/ui/src/api-client/docs/GetConsumersDtoGroupName.md new file mode 100644 index 0000000000..375d2076ca --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetConsumersDtoGroupName.md @@ -0,0 +1,23 @@ +# GetConsumersDtoGroupName + +Consumer group name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { GetConsumersDtoGroupName } from './api'; + +const instance: GetConsumersDtoGroupName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetHashFieldsDto.md b/redisinsight/ui/src/api-client/docs/GetHashFieldsDto.md new file mode 100644 index 0000000000..abae4e6cec --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetHashFieldsDto.md @@ -0,0 +1,26 @@ +# GetHashFieldsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**cursor** | **number** | Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. | [default to 0] +**count** | **number** | Specifying the number of elements to return. | [optional] [default to 15] +**match** | **string** | Iterate only elements matching a given pattern. | [optional] [default to '*'] + +## Example + +```typescript +import { GetHashFieldsDto } from './api'; + +const instance: GetHashFieldsDto = { + keyName, + cursor, + count, + match, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetHashFieldsResponse.md b/redisinsight/ui/src/api-client/docs/GetHashFieldsResponse.md new file mode 100644 index 0000000000..43ae5ff99a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetHashFieldsResponse.md @@ -0,0 +1,26 @@ +# GetHashFieldsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**nextCursor** | **number** | The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. | [default to undefined] +**fields** | [**Array<HashFieldDto>**](HashFieldDto.md) | Array of members. | [default to undefined] +**total** | **number** | The number of fields in the currently-selected hash. | [default to undefined] + +## Example + +```typescript +import { GetHashFieldsResponse } from './api'; + +const instance: GetHashFieldsResponse = { + keyName, + nextCursor, + fields, + total, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetKeyInfoDto.md b/redisinsight/ui/src/api-client/docs/GetKeyInfoDto.md new file mode 100644 index 0000000000..db6da48fdb --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetKeyInfoDto.md @@ -0,0 +1,22 @@ +# GetKeyInfoDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**includeSize** | **boolean** | Flag to determine if size should be requested and shown in the response | [optional] [default to false] + +## Example + +```typescript +import { GetKeyInfoDto } from './api'; + +const instance: GetKeyInfoDto = { + keyName, + includeSize, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetKeyInfoResponse.md b/redisinsight/ui/src/api-client/docs/GetKeyInfoResponse.md new file mode 100644 index 0000000000..efa22861b7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetKeyInfoResponse.md @@ -0,0 +1,28 @@ +# GetKeyInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**CreateListWithExpireDtoElementsInner**](CreateListWithExpireDtoElementsInner.md) | | [default to undefined] +**type** | **string** | | [default to undefined] +**ttl** | **number** | The remaining time to live of a key. If the property has value of -1, then the key has no expiration time (no limit). | [default to undefined] +**size** | **number** | The number of bytes that a key and its value require to be stored in RAM. | [default to undefined] +**length** | **number** | The length of the value stored in a key. | [optional] [default to undefined] + +## Example + +```typescript +import { GetKeyInfoResponse } from './api'; + +const instance: GetKeyInfoResponse = { + name, + type, + ttl, + size, + length, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetKeysDto.md b/redisinsight/ui/src/api-client/docs/GetKeysDto.md new file mode 100644 index 0000000000..15be27978f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetKeysDto.md @@ -0,0 +1,30 @@ +# GetKeysDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cursor** | **string** | Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. | [default to '0'] +**count** | **number** | Specifying the number of elements to return. | [optional] [default to 15] +**match** | **string** | Iterate only elements matching a given pattern. | [optional] [default to '*'] +**type** | **string** | Iterate through the database looking for keys of a specific type. | [optional] [default to undefined] +**keysInfo** | **boolean** | Fetch keys info (type, size, ttl, length) | [optional] [default to true] +**scanThreshold** | **number** | The maximum number of keys to scan | [optional] [default to undefined] + +## Example + +```typescript +import { GetKeysDto } from './api'; + +const instance: GetKeysDto = { + cursor, + count, + match, + type, + keysInfo, + scanThreshold, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetKeysInfoDto.md b/redisinsight/ui/src/api-client/docs/GetKeysInfoDto.md new file mode 100644 index 0000000000..7ec3809210 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetKeysInfoDto.md @@ -0,0 +1,26 @@ +# GetKeysInfoDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keys** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | List of keys | [default to undefined] +**type** | **string** | Iterate through the database looking for keys of a specific type. | [optional] [default to undefined] +**includeSize** | **boolean** | Flag to determine if keys should be requested and shown in the response | [optional] [default to true] +**includeTTL** | **boolean** | Flag to determine if TTL should be requested and shown in the response | [optional] [default to true] + +## Example + +```typescript +import { GetKeysInfoDto } from './api'; + +const instance: GetKeysInfoDto = { + keys, + type, + includeSize, + includeTTL, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetKeysWithDetailsResponse.md b/redisinsight/ui/src/api-client/docs/GetKeysWithDetailsResponse.md new file mode 100644 index 0000000000..b992e4baf6 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetKeysWithDetailsResponse.md @@ -0,0 +1,32 @@ +# GetKeysWithDetailsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cursor** | **number** | The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. | [default to 0] +**total** | **number** | The number of keys in the currently-selected database. | [default to undefined] +**scanned** | **number** | The number of keys we tried to scan. Be aware that scanned is sum of COUNT parameters from redis commands | [default to undefined] +**keys** | [**Array<GetKeyInfoResponse>**](GetKeyInfoResponse.md) | Array of Keys. | [default to undefined] +**host** | **string** | Node host. In case when we are working with cluster | [optional] [default to undefined] +**port** | **number** | Node port. In case when we are working with cluster | [optional] [default to undefined] +**maxResults** | **number** | The maximum number of results. For RediSearch this number is a value from \"FT.CONFIG GET maxsearchresults\" command. | [optional] [default to undefined] + +## Example + +```typescript +import { GetKeysWithDetailsResponse } from './api'; + +const instance: GetKeysWithDetailsResponse = { + cursor, + total, + scanned, + keys, + host, + port, + maxResults, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetListElementResponse.md b/redisinsight/ui/src/api-client/docs/GetListElementResponse.md new file mode 100644 index 0000000000..ece3606749 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetListElementResponse.md @@ -0,0 +1,22 @@ +# GetListElementResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**value** | [**GetListElementResponseValue**](GetListElementResponseValue.md) | | [default to undefined] + +## Example + +```typescript +import { GetListElementResponse } from './api'; + +const instance: GetListElementResponse = { + keyName, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetListElementResponseValue.md b/redisinsight/ui/src/api-client/docs/GetListElementResponseValue.md new file mode 100644 index 0000000000..c2c1c810de --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetListElementResponseValue.md @@ -0,0 +1,23 @@ +# GetListElementResponseValue + +Element value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { GetListElementResponseValue } from './api'; + +const instance: GetListElementResponseValue = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetListElementsDto.md b/redisinsight/ui/src/api-client/docs/GetListElementsDto.md new file mode 100644 index 0000000000..748efea22a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetListElementsDto.md @@ -0,0 +1,24 @@ +# GetListElementsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**offset** | **number** | Specifying the number of elements to skip. | [default to undefined] +**count** | **number** | Specifying the number of elements to return from starting at offset. | [default to 15] + +## Example + +```typescript +import { GetListElementsDto } from './api'; + +const instance: GetListElementsDto = { + keyName, + offset, + count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetListElementsResponse.md b/redisinsight/ui/src/api-client/docs/GetListElementsResponse.md new file mode 100644 index 0000000000..ec3ae47073 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetListElementsResponse.md @@ -0,0 +1,24 @@ +# GetListElementsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**total** | **number** | The number of elements in the currently-selected list. | [default to undefined] +**elements** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Elements | [default to undefined] + +## Example + +```typescript +import { GetListElementsResponse } from './api'; + +const instance: GetListElementsResponse = { + keyName, + total, + elements, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetPendingEntriesDto.md b/redisinsight/ui/src/api-client/docs/GetPendingEntriesDto.md new file mode 100644 index 0000000000..8c20da59c8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetPendingEntriesDto.md @@ -0,0 +1,30 @@ +# GetPendingEntriesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**groupName** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] +**consumerName** | [**GetPendingEntriesDtoConsumerName**](GetPendingEntriesDtoConsumerName.md) | | [default to undefined] +**start** | **string** | Specifying the start id | [optional] [default to '-'] +**end** | **string** | Specifying the end id | [optional] [default to '+'] +**count** | **number** | Specifying the number of pending messages to return. | [optional] [default to 500] + +## Example + +```typescript +import { GetPendingEntriesDto } from './api'; + +const instance: GetPendingEntriesDto = { + keyName, + groupName, + consumerName, + start, + end, + count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetPendingEntriesDtoConsumerName.md b/redisinsight/ui/src/api-client/docs/GetPendingEntriesDtoConsumerName.md new file mode 100644 index 0000000000..7d2417be1d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetPendingEntriesDtoConsumerName.md @@ -0,0 +1,23 @@ +# GetPendingEntriesDtoConsumerName + +Consumer name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { GetPendingEntriesDtoConsumerName } from './api'; + +const instance: GetPendingEntriesDtoConsumerName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetRejsonRlDto.md b/redisinsight/ui/src/api-client/docs/GetRejsonRlDto.md new file mode 100644 index 0000000000..b4596a573d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetRejsonRlDto.md @@ -0,0 +1,24 @@ +# GetRejsonRlDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**path** | **string** | Path to look for data | [optional] [default to undefined] +**forceRetrieve** | **boolean** | Don\'t check for json size and return whole json in path when enabled | [optional] [default to undefined] + +## Example + +```typescript +import { GetRejsonRlDto } from './api'; + +const instance: GetRejsonRlDto = { + keyName, + path, + forceRetrieve, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetRejsonRlResponseDto.md b/redisinsight/ui/src/api-client/docs/GetRejsonRlResponseDto.md new file mode 100644 index 0000000000..6271c94de7 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetRejsonRlResponseDto.md @@ -0,0 +1,26 @@ +# GetRejsonRlResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**downloaded** | **boolean** | Determines if json value was downloaded | [default to undefined] +**type** | **string** | Type of data in the requested path | [optional] [default to undefined] +**path** | **string** | Requested path | [optional] [default to undefined] +**data** | [**GetRejsonRlResponseDtoData**](GetRejsonRlResponseDtoData.md) | | [default to undefined] + +## Example + +```typescript +import { GetRejsonRlResponseDto } from './api'; + +const instance: GetRejsonRlResponseDto = { + downloaded, + type, + path, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetRejsonRlResponseDtoData.md b/redisinsight/ui/src/api-client/docs/GetRejsonRlResponseDtoData.md new file mode 100644 index 0000000000..9b93f815c3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetRejsonRlResponseDtoData.md @@ -0,0 +1,19 @@ +# GetRejsonRlResponseDtoData + +JSON data that can be of various types + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { GetRejsonRlResponseDtoData } from './api'; + +const instance: GetRejsonRlResponseDtoData = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetServerInfoResponse.md b/redisinsight/ui/src/api-client/docs/GetServerInfoResponse.md new file mode 100644 index 0000000000..8d8fcb3986 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetServerInfoResponse.md @@ -0,0 +1,38 @@ +# GetServerInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Server identifier. | [default to undefined] +**createDateTime** | **string** | Time of the first server launch. | [default to undefined] +**appVersion** | **string** | Version of the application. | [default to undefined] +**osPlatform** | **string** | The operating system platform. | [default to undefined] +**buildType** | **string** | Application build type. | [default to undefined] +**packageType** | **string** | Application package type. | [default to undefined] +**appType** | **string** | Application type. | [default to undefined] +**fixedDatabaseId** | **string** | Fixed Redis database id. | [optional] [default to undefined] +**encryptionStrategies** | **Array<string>** | List of available encryption strategies | [default to undefined] +**sessionId** | **number** | Server session id. | [default to undefined] + +## Example + +```typescript +import { GetServerInfoResponse } from './api'; + +const instance: GetServerInfoResponse = { + id, + createDateTime, + appVersion, + osPlatform, + buildType, + packageType, + appType, + fixedDatabaseId, + encryptionStrategies, + sessionId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetSetMembersDto.md b/redisinsight/ui/src/api-client/docs/GetSetMembersDto.md new file mode 100644 index 0000000000..4aab42b3e3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetSetMembersDto.md @@ -0,0 +1,26 @@ +# GetSetMembersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**cursor** | **number** | Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. | [default to 0] +**count** | **number** | Specifying the number of elements to return. | [optional] [default to 15] +**match** | **string** | Iterate only elements matching a given pattern. | [optional] [default to '*'] + +## Example + +```typescript +import { GetSetMembersDto } from './api'; + +const instance: GetSetMembersDto = { + keyName, + cursor, + count, + match, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetSetMembersResponse.md b/redisinsight/ui/src/api-client/docs/GetSetMembersResponse.md new file mode 100644 index 0000000000..6164b06f79 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetSetMembersResponse.md @@ -0,0 +1,26 @@ +# GetSetMembersResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**nextCursor** | **number** | The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. | [default to undefined] +**members** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Array of members | [default to undefined] +**total** | **number** | The number of members in the currently-selected set. | [default to undefined] + +## Example + +```typescript +import { GetSetMembersResponse } from './api'; + +const instance: GetSetMembersResponse = { + keyName, + nextCursor, + members, + total, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetStreamEntriesDto.md b/redisinsight/ui/src/api-client/docs/GetStreamEntriesDto.md new file mode 100644 index 0000000000..bd9c70adb2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetStreamEntriesDto.md @@ -0,0 +1,28 @@ +# GetStreamEntriesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**start** | **string** | Specifying the start id | [optional] [default to '-'] +**end** | **string** | Specifying the end id | [optional] [default to '+'] +**count** | **number** | Specifying the number of entries to return. | [optional] [default to 500] +**sortOrder** | **string** | Get entries sort by IDs order. | [default to SortOrderEnum_Desc] + +## Example + +```typescript +import { GetStreamEntriesDto } from './api'; + +const instance: GetStreamEntriesDto = { + keyName, + start, + end, + count, + sortOrder, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetStreamEntriesResponse.md b/redisinsight/ui/src/api-client/docs/GetStreamEntriesResponse.md new file mode 100644 index 0000000000..3c8eb19249 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetStreamEntriesResponse.md @@ -0,0 +1,30 @@ +# GetStreamEntriesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**total** | **number** | Total number of entries | [default to undefined] +**lastGeneratedId** | **string** | Last generated id in the stream | [default to undefined] +**firstEntry** | [**StreamEntryDto**](StreamEntryDto.md) | First stream entry | [default to undefined] +**lastEntry** | [**StreamEntryDto**](StreamEntryDto.md) | Last stream entry | [default to undefined] +**entries** | [**Array<StreamEntryDto>**](StreamEntryDto.md) | Stream entries | [default to undefined] + +## Example + +```typescript +import { GetStreamEntriesResponse } from './api'; + +const instance: GetStreamEntriesResponse = { + keyName, + total, + lastGeneratedId, + firstEntry, + lastEntry, + entries, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetStringInfoDto.md b/redisinsight/ui/src/api-client/docs/GetStringInfoDto.md new file mode 100644 index 0000000000..b1f1527135 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetStringInfoDto.md @@ -0,0 +1,24 @@ +# GetStringInfoDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**start** | **number** | Start of string | [default to 0] +**end** | **number** | End of string | [default to undefined] + +## Example + +```typescript +import { GetStringInfoDto } from './api'; + +const instance: GetStringInfoDto = { + keyName, + start, + end, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetStringValueResponse.md b/redisinsight/ui/src/api-client/docs/GetStringValueResponse.md new file mode 100644 index 0000000000..108be41360 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetStringValueResponse.md @@ -0,0 +1,22 @@ +# GetStringValueResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**value** | [**SetStringWithExpireDtoValue**](SetStringWithExpireDtoValue.md) | | [default to undefined] + +## Example + +```typescript +import { GetStringValueResponse } from './api'; + +const instance: GetStringValueResponse = { + keyName, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetUserAgreementsResponse.md b/redisinsight/ui/src/api-client/docs/GetUserAgreementsResponse.md new file mode 100644 index 0000000000..68c75f07da --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetUserAgreementsResponse.md @@ -0,0 +1,20 @@ +# GetUserAgreementsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Last version on agreements set by the user. | [default to undefined] + +## Example + +```typescript +import { GetUserAgreementsResponse } from './api'; + +const instance: GetUserAgreementsResponse = { + version, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetZSetMembersDto.md b/redisinsight/ui/src/api-client/docs/GetZSetMembersDto.md new file mode 100644 index 0000000000..7e620b6242 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetZSetMembersDto.md @@ -0,0 +1,26 @@ +# GetZSetMembersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**offset** | **number** | Specifying the number of elements to skip. | [default to undefined] +**count** | **number** | Specifying the number of elements to return from starting at offset. | [default to 15] +**sortOrder** | **string** | Get elements sorted by score. In order to sort the members from the highest to the lowest score, use the DESC value, else ASC value | [default to SortOrderEnum_Desc] + +## Example + +```typescript +import { GetZSetMembersDto } from './api'; + +const instance: GetZSetMembersDto = { + keyName, + offset, + count, + sortOrder, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/GetZSetResponse.md b/redisinsight/ui/src/api-client/docs/GetZSetResponse.md new file mode 100644 index 0000000000..192650a4a2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/GetZSetResponse.md @@ -0,0 +1,24 @@ +# GetZSetResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**total** | **number** | The number of members in the currently-selected z-set. | [default to undefined] +**members** | [**Array<ZSetMemberDto>**](ZSetMemberDto.md) | Array of Members. | [default to undefined] + +## Example + +```typescript +import { GetZSetResponse } from './api'; + +const instance: GetZSetResponse = { + keyName, + total, + members, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/HashFieldDto.md b/redisinsight/ui/src/api-client/docs/HashFieldDto.md new file mode 100644 index 0000000000..3fea9f609b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/HashFieldDto.md @@ -0,0 +1,24 @@ +# HashFieldDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**field** | [**HashFieldDtoField**](HashFieldDtoField.md) | | [default to undefined] +**value** | [**HashFieldDtoField**](HashFieldDtoField.md) | | [default to undefined] +**expire** | **number** | Set timeout on field in seconds | [optional] [default to undefined] + +## Example + +```typescript +import { HashFieldDto } from './api'; + +const instance: HashFieldDto = { + field, + value, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/HashFieldDtoField.md b/redisinsight/ui/src/api-client/docs/HashFieldDtoField.md new file mode 100644 index 0000000000..9186031bac --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/HashFieldDtoField.md @@ -0,0 +1,23 @@ +# HashFieldDtoField + +Field + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { HashFieldDtoField } from './api'; + +const instance: HashFieldDtoField = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/HashFieldTtlDto.md b/redisinsight/ui/src/api-client/docs/HashFieldTtlDto.md new file mode 100644 index 0000000000..6a6409dbe2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/HashFieldTtlDto.md @@ -0,0 +1,22 @@ +# HashFieldTtlDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**field** | [**HashFieldDtoField**](HashFieldDtoField.md) | | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the field will automatically be deleted. If the property has value of -1, then the field timeout will be removed. | [default to undefined] + +## Example + +```typescript +import { HashFieldTtlDto } from './api'; + +const instance: HashFieldTtlDto = { + field, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ImportCloudDatabaseDto.md b/redisinsight/ui/src/api-client/docs/ImportCloudDatabaseDto.md new file mode 100644 index 0000000000..009aed40b1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ImportCloudDatabaseDto.md @@ -0,0 +1,24 @@ +# ImportCloudDatabaseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription id | [default to undefined] +**databaseId** | **number** | Database id | [default to undefined] +**free** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { ImportCloudDatabaseDto } from './api'; + +const instance: ImportCloudDatabaseDto = { + subscriptionId, + databaseId, + free, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ImportCloudDatabaseResponse.md b/redisinsight/ui/src/api-client/docs/ImportCloudDatabaseResponse.md new file mode 100644 index 0000000000..45fcde38a4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ImportCloudDatabaseResponse.md @@ -0,0 +1,30 @@ +# ImportCloudDatabaseResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription id | [default to undefined] +**databaseId** | **number** | Database id | [default to undefined] +**status** | **string** | Add Redis Cloud database status | [default to StatusEnum_Success] +**message** | **string** | Message | [default to undefined] +**databaseDetails** | [**CloudDatabase**](CloudDatabase.md) | The database details. | [optional] [default to undefined] +**error** | **object** | Error | [optional] [default to undefined] + +## Example + +```typescript +import { ImportCloudDatabaseResponse } from './api'; + +const instance: ImportCloudDatabaseResponse = { + subscriptionId, + databaseId, + status, + message, + databaseDetails, + error, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ImportCloudDatabasesDto.md b/redisinsight/ui/src/api-client/docs/ImportCloudDatabasesDto.md new file mode 100644 index 0000000000..add05ba618 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ImportCloudDatabasesDto.md @@ -0,0 +1,20 @@ +# ImportCloudDatabasesDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**databases** | [**Array<ImportCloudDatabaseDto>**](ImportCloudDatabaseDto.md) | Cloud databases list. | [default to undefined] + +## Example + +```typescript +import { ImportCloudDatabasesDto } from './api'; + +const instance: ImportCloudDatabasesDto = { + databases, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ImportDatabaseCloudJobDataDto.md b/redisinsight/ui/src/api-client/docs/ImportDatabaseCloudJobDataDto.md new file mode 100644 index 0000000000..0290279367 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ImportDatabaseCloudJobDataDto.md @@ -0,0 +1,26 @@ +# ImportDatabaseCloudJobDataDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subscriptionId** | **number** | Subscription id of database | [default to undefined] +**databaseId** | **number** | Database id to import | [default to undefined] +**region** | **string** | Subscription region | [default to undefined] +**provider** | **string** | Subscription provider | [default to undefined] + +## Example + +```typescript +import { ImportDatabaseCloudJobDataDto } from './api'; + +const instance: ImportDatabaseCloudJobDataDto = { + subscriptionId, + databaseId, + region, + provider, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/IndexAttibuteDto.md b/redisinsight/ui/src/api-client/docs/IndexAttibuteDto.md new file mode 100644 index 0000000000..506b63b733 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/IndexAttibuteDto.md @@ -0,0 +1,38 @@ +# IndexAttibuteDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifier** | **string** | Field identifier | [default to undefined] +**attribute** | **string** | Field attribute | [default to undefined] +**type** | **string** | Field type | [default to undefined] +**WEIGHT** | **string** | Field weight | [default to undefined] +**SORTABLE** | **boolean** | Field can be sorted | [default to undefined] +**NOINDEX** | **boolean** | Attributes can have the NOINDEX option, which means they will not be indexed. | [default to undefined] +**CASESENSITIVE** | **boolean** | Attribute is case sensitive | [default to undefined] +**UNF** | **boolean** | By default, for hashes (not with JSON) SORTABLE applies a normalization to the indexed value (characters set to lowercase, removal of diacritics). | [default to undefined] +**NOSTEM** | **boolean** | Text attributes can have the NOSTEM argument that disables stemming when indexing its values. This may be ideal for things like proper names. | [default to undefined] +**SEPARATOR** | **string** | Indicates how the text contained in the attribute is to be split into individual tags. The default is ,. The value must be a single character. | [default to undefined] + +## Example + +```typescript +import { IndexAttibuteDto } from './api'; + +const instance: IndexAttibuteDto = { + identifier, + attribute, + type, + WEIGHT, + SORTABLE, + NOINDEX, + CASESENSITIVE, + UNF, + NOSTEM, + SEPARATOR, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/IndexDefinitionDto.md b/redisinsight/ui/src/api-client/docs/IndexDefinitionDto.md new file mode 100644 index 0000000000..ecebc69a43 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/IndexDefinitionDto.md @@ -0,0 +1,24 @@ +# IndexDefinitionDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key_type** | **string** | key_type, hash or JSON | [default to undefined] +**prefixes** | **Array<string>** | Index prefixes given during create | [default to undefined] +**default_score** | **string** | Index default_score | [default to undefined] + +## Example + +```typescript +import { IndexDefinitionDto } from './api'; + +const instance: IndexDefinitionDto = { + key_type, + prefixes, + default_score, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/IndexInfoDto.md b/redisinsight/ui/src/api-client/docs/IndexInfoDto.md new file mode 100644 index 0000000000..10f2ad2319 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/IndexInfoDto.md @@ -0,0 +1,86 @@ +# IndexInfoDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index_name** | **string** | The index name that was defined when index was created | [default to undefined] +**index_options** | [**IndexOptionsDto**](IndexOptionsDto.md) | The index options selected during FT.CREATE such as FILTER {filter}, LANGUAGE {default_lang}, etc. | [default to undefined] +**index_definition** | [**IndexDefinitionDto**](IndexDefinitionDto.md) | Includes key_type, hash or JSON; prefixes, if any; and default_score. | [default to undefined] +**attributes** | [**Array<IndexAttibuteDto>**](IndexAttibuteDto.md) | The index schema field names, types, and attributes. | [default to undefined] +**num_docs** | **string** | The number of documents. | [default to undefined] +**max_doc_id** | **string** | The maximum document ID. | [default to undefined] +**num_terms** | **string** | The number of distinct terms. | [default to undefined] +**num_records** | **string** | The total number of records. | [default to undefined] +**inverted_sz_mb** | **string** | The memory used by the inverted index, which is the core data structure used for searching in RediSearch. The size is given in megabytes. | [default to undefined] +**vector_index_sz_mb** | **string** | The memory used by the vector index, which stores any vectors associated with each document. | [default to undefined] +**total_inverted_index_blocks** | **string** | The total number of blocks in the inverted index. | [default to undefined] +**offset_vectors_sz_mb** | **string** | The memory used by the offset vectors, which store positional information for terms in documents. | [default to undefined] +**doc_table_size_mb** | **string** | The memory used by the document table, which contains metadata about each document in the index. | [default to undefined] +**sortable_values_size_mb** | **string** | The memory used by sortable values, which are values associated with documents and used for sorting purposes. | [default to undefined] +**tag_overhead_sz_mb** | **string** | Tag overhead memory usage in mb | [default to undefined] +**text_overhead_sz_mb** | **string** | Text overhead memory usage in mb | [default to undefined] +**total_index_memory_sz_mb** | **string** | Total index memory size in mb | [default to undefined] +**key_table_size_mb** | **string** | The memory used by the key table, which stores the mapping between document IDs and Redis keys | [default to undefined] +**geoshapes_sz_mb** | **string** | The memory used by GEO-related fields. | [default to undefined] +**records_per_doc_avg** | **string** | The average number of records (including deletions) per document. | [default to undefined] +**bytes_per_record_avg** | **string** | The average size of each record in bytes. | [default to undefined] +**offsets_per_term_avg** | **string** | The average number of offsets (position information) per term. | [default to undefined] +**offset_bits_per_record_avg** | **string** | The average number of bits used for offsets per record. | [default to undefined] +**hash_indexing_failures** | **string** | The number of failures encountered during indexing. | [default to undefined] +**total_indexing_time** | **string** | The total time taken for indexing in seconds. | [default to undefined] +**indexing** | **string** | Indicates whether the index is currently being generated. | [default to undefined] +**percent_indexed** | **string** | The percentage of the index that has been successfully generated. | [default to undefined] +**number_of_uses** | **number** | The number of times the index has been used. | [default to undefined] +**cleaning** | **number** | The index deletion flag. A value of 1 indicates index deletion is in progress. | [default to undefined] +**gc_stats** | **object** | Garbage collection statistics | [default to undefined] +**cursor_stats** | **object** | Cursor statistics | [default to undefined] +**dialect_stats** | **object** | Dialect statistics: the number of times the index was searched using each DIALECT, 1 - 4. | [default to undefined] +**Index_Errors** | **object** | Index error statistics, including indexing failures, last indexing error, and last indexing error key. | [default to undefined] +**field_statistics** | [**Array<FieldStatisticsDto>**](FieldStatisticsDto.md) | Dialect statistics: the number of times the index was searched using each DIALECT, 1 - 4. | [default to undefined] + +## Example + +```typescript +import { IndexInfoDto } from './api'; + +const instance: IndexInfoDto = { + index_name, + index_options, + index_definition, + attributes, + num_docs, + max_doc_id, + num_terms, + num_records, + inverted_sz_mb, + vector_index_sz_mb, + total_inverted_index_blocks, + offset_vectors_sz_mb, + doc_table_size_mb, + sortable_values_size_mb, + tag_overhead_sz_mb, + text_overhead_sz_mb, + total_index_memory_sz_mb, + key_table_size_mb, + geoshapes_sz_mb, + records_per_doc_avg, + bytes_per_record_avg, + offsets_per_term_avg, + offset_bits_per_record_avg, + hash_indexing_failures, + total_indexing_time, + indexing, + percent_indexed, + number_of_uses, + cleaning, + gc_stats, + cursor_stats, + dialect_stats, + Index_Errors, + field_statistics, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/IndexInfoRequestBodyDto.md b/redisinsight/ui/src/api-client/docs/IndexInfoRequestBodyDto.md new file mode 100644 index 0000000000..fb178e1603 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/IndexInfoRequestBodyDto.md @@ -0,0 +1,20 @@ +# IndexInfoRequestBodyDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] + +## Example + +```typescript +import { IndexInfoRequestBodyDto } from './api'; + +const instance: IndexInfoRequestBodyDto = { + index, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/IndexOptionsDto.md b/redisinsight/ui/src/api-client/docs/IndexOptionsDto.md new file mode 100644 index 0000000000..896a928b2f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/IndexOptionsDto.md @@ -0,0 +1,22 @@ +# IndexOptionsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter** | **string** | is a filter expression with the full RediSearch aggregation expression language. | [default to undefined] +**default_lang** | **string** | if set, indicates the default language for documents in the index. Default is English. | [default to undefined] + +## Example + +```typescript +import { IndexOptionsDto } from './api'; + +const instance: IndexOptionsDto = { + filter, + default_lang, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/InfoApi.md b/redisinsight/ui/src/api-client/docs/InfoApi.md new file mode 100644 index 0000000000..5890350fdc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/InfoApi.md @@ -0,0 +1,276 @@ +# InfoApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**featureControllerList**](#featurecontrollerlist) | **GET** /api/features | | +|[**featureControllerSync**](#featurecontrollersync) | **POST** /api/features/sync | | +|[**healthControllerHealth**](#healthcontrollerhealth) | **GET** /api/health | | +|[**serverControllerGetCliBlockingCommands**](#servercontrollergetcliblockingcommands) | **GET** /api/info/cli-blocking-commands | | +|[**serverControllerGetCliUnsupportedCommands**](#servercontrollergetcliunsupportedcommands) | **GET** /api/info/cli-unsupported-commands | | +|[**serverControllerGetInfo**](#servercontrollergetinfo) | **GET** /api/info | | + +# **featureControllerList** +> featureControllerList() + +Get list of features + +### Example + +```typescript +import { + InfoApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new InfoApi(configuration); + +const { status, data } = await apiInstance.featureControllerList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Get list of features | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **featureControllerSync** +> featureControllerSync() + + +### Example + +```typescript +import { + InfoApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new InfoApi(configuration); + +const { status, data } = await apiInstance.featureControllerSync(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **healthControllerHealth** +> healthControllerHealth() + +Get server info + +### Example + +```typescript +import { + InfoApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new InfoApi(configuration); + +const { status, data } = await apiInstance.healthControllerHealth(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **serverControllerGetCliBlockingCommands** +> Array serverControllerGetCliBlockingCommands() + +Get list of blocking commands in CLI + +### Example + +```typescript +import { + InfoApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new InfoApi(configuration); + +const { status, data } = await apiInstance.serverControllerGetCliBlockingCommands(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Blocking commands | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **serverControllerGetCliUnsupportedCommands** +> Array serverControllerGetCliUnsupportedCommands() + +Get list of unsupported commands in CLI + +### Example + +```typescript +import { + InfoApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new InfoApi(configuration); + +const { status, data } = await apiInstance.serverControllerGetCliUnsupportedCommands(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Unsupported commands | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **serverControllerGetInfo** +> GetServerInfoResponse serverControllerGetInfo() + +Get server info + +### Example + +```typescript +import { + InfoApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new InfoApi(configuration); + +const { status, data } = await apiInstance.serverControllerGetInfo(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**GetServerInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Server Info | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/Key.md b/redisinsight/ui/src/api-client/docs/Key.md new file mode 100644 index 0000000000..288a5bdc00 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Key.md @@ -0,0 +1,28 @@ +# Key + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**type** | **string** | Key type | [default to undefined] +**memory** | **number** | Memory used by key in bytes | [default to undefined] +**length** | **number** | Number of characters, elements, etc. based on type | [default to undefined] +**ttl** | **number** | Key ttl | [default to undefined] + +## Example + +```typescript +import { Key } from './api'; + +const instance: Key = { + name, + type, + memory, + length, + ttl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/KeyDto.md b/redisinsight/ui/src/api-client/docs/KeyDto.md new file mode 100644 index 0000000000..7ae415eb82 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/KeyDto.md @@ -0,0 +1,20 @@ +# KeyDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] + +## Example + +```typescript +import { KeyDto } from './api'; + +const instance: KeyDto = { + keyName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/KeyTtlResponse.md b/redisinsight/ui/src/api-client/docs/KeyTtlResponse.md new file mode 100644 index 0000000000..5a6711c2a4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/KeyTtlResponse.md @@ -0,0 +1,20 @@ +# KeyTtlResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ttl** | **number** | The remaining time to live of a key that has a timeout. If value equals -2 then the key does not exist or has deleted. If value equals -1 then the key has no associated expire (No limit). | [default to undefined] + +## Example + +```typescript +import { KeyTtlResponse } from './api'; + +const instance: KeyTtlResponse = { + ttl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ListRedisearchIndexesResponse.md b/redisinsight/ui/src/api-client/docs/ListRedisearchIndexesResponse.md new file mode 100644 index 0000000000..15a82f35cc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ListRedisearchIndexesResponse.md @@ -0,0 +1,20 @@ +# ListRedisearchIndexesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indexes** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | Indexes names | [default to undefined] + +## Example + +```typescript +import { ListRedisearchIndexesResponse } from './api'; + +const instance: ListRedisearchIndexesResponse = { + indexes, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ModifyDatabaseRecommendationDto.md b/redisinsight/ui/src/api-client/docs/ModifyDatabaseRecommendationDto.md new file mode 100644 index 0000000000..e383b05f1f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ModifyDatabaseRecommendationDto.md @@ -0,0 +1,22 @@ +# ModifyDatabaseRecommendationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vote** | **string** | Recommendation vote | [optional] [default to undefined] +**hide** | **boolean** | Hide recommendation | [optional] [default to undefined] + +## Example + +```typescript +import { ModifyDatabaseRecommendationDto } from './api'; + +const instance: ModifyDatabaseRecommendationDto = { + vote, + hide, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ModifyRejsonRlArrAppendDto.md b/redisinsight/ui/src/api-client/docs/ModifyRejsonRlArrAppendDto.md new file mode 100644 index 0000000000..17074fcea3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ModifyRejsonRlArrAppendDto.md @@ -0,0 +1,24 @@ +# ModifyRejsonRlArrAppendDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**path** | **string** | Path of the json field | [default to undefined] +**data** | **Array<string>** | Array of valid serialized jsons | [default to undefined] + +## Example + +```typescript +import { ModifyRejsonRlArrAppendDto } from './api'; + +const instance: ModifyRejsonRlArrAppendDto = { + keyName, + path, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ModifyRejsonRlSetDto.md b/redisinsight/ui/src/api-client/docs/ModifyRejsonRlSetDto.md new file mode 100644 index 0000000000..1b2ce8b8a2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ModifyRejsonRlSetDto.md @@ -0,0 +1,24 @@ +# ModifyRejsonRlSetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**path** | **string** | Path of the json field | [default to undefined] +**data** | **string** | Array of valid serialized jsons | [default to undefined] + +## Example + +```typescript +import { ModifyRejsonRlSetDto } from './api'; + +const instance: ModifyRejsonRlSetDto = { + keyName, + path, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/NotificationsApi.md b/redisinsight/ui/src/api-client/docs/NotificationsApi.md new file mode 100644 index 0000000000..cb447f38bf --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/NotificationsApi.md @@ -0,0 +1,105 @@ +# NotificationsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**notificationControllerGetNotifications**](#notificationcontrollergetnotifications) | **GET** /api/notifications | | +|[**notificationControllerReadNotifications**](#notificationcontrollerreadnotifications) | **PATCH** /api/notifications/read | | + +# **notificationControllerGetNotifications** +> NotificationsDto notificationControllerGetNotifications() + +Return ordered notifications history + +### Example + +```typescript +import { + NotificationsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new NotificationsApi(configuration); + +const { status, data } = await apiInstance.notificationControllerGetNotifications(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**NotificationsDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **notificationControllerReadNotifications** +> NotificationsDto notificationControllerReadNotifications(readNotificationsDto) + +Mark all notifications as read + +### Example + +```typescript +import { + NotificationsApi, + Configuration, + ReadNotificationsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new NotificationsApi(configuration); + +let readNotificationsDto: ReadNotificationsDto; // + +const { status, data } = await apiInstance.notificationControllerReadNotifications( + readNotificationsDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **readNotificationsDto** | **ReadNotificationsDto**| | | + + +### Return type + +**NotificationsDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/NotificationsDto.md b/redisinsight/ui/src/api-client/docs/NotificationsDto.md new file mode 100644 index 0000000000..435aba5213 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/NotificationsDto.md @@ -0,0 +1,22 @@ +# NotificationsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notifications** | **Array<object>** | Ordered notifications list | [default to undefined] +**totalUnread** | **number** | Number of unread notifications | [default to undefined] + +## Example + +```typescript +import { NotificationsDto } from './api'; + +const instance: NotificationsDto = { + notifications, + totalUnread, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/NspSummary.md b/redisinsight/ui/src/api-client/docs/NspSummary.md new file mode 100644 index 0000000000..502d8f2e21 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/NspSummary.md @@ -0,0 +1,26 @@ +# NspSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nsp** | [**NspSummaryNsp**](NspSummaryNsp.md) | | [default to undefined] +**memory** | **number** | Total memory used by namespace in bytes | [default to undefined] +**keys** | **number** | Total keys inside namespace | [default to undefined] +**types** | [**Array<NspTypeSummary>**](NspTypeSummary.md) | Top namespaces by keys number | [default to undefined] + +## Example + +```typescript +import { NspSummary } from './api'; + +const instance: NspSummary = { + nsp, + memory, + keys, + types, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/NspSummaryNsp.md b/redisinsight/ui/src/api-client/docs/NspSummaryNsp.md new file mode 100644 index 0000000000..f6bc8cd0a4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/NspSummaryNsp.md @@ -0,0 +1,23 @@ +# NspSummaryNsp + +Namespace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { NspSummaryNsp } from './api'; + +const instance: NspSummaryNsp = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/NspTypeSummary.md b/redisinsight/ui/src/api-client/docs/NspTypeSummary.md new file mode 100644 index 0000000000..489e42b481 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/NspTypeSummary.md @@ -0,0 +1,24 @@ +# NspTypeSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type name | [default to undefined] +**memory** | **number** | Total memory in bytes inside particular data type | [default to undefined] +**keys** | **number** | Total keys inside particular data type | [default to undefined] + +## Example + +```typescript +import { NspTypeSummary } from './api'; + +const instance: NspTypeSummary = { + type, + memory, + keys, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PendingEntryDto.md b/redisinsight/ui/src/api-client/docs/PendingEntryDto.md new file mode 100644 index 0000000000..460f9f719d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PendingEntryDto.md @@ -0,0 +1,26 @@ +# PendingEntryDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Entry ID | [default to undefined] +**consumerName** | [**GetPendingEntriesDtoConsumerName**](GetPendingEntriesDtoConsumerName.md) | | [default to undefined] +**idle** | **number** | The number of milliseconds that elapsed since the last time this message was delivered to this consumer | [default to undefined] +**delivered** | **number** | The number of times this message was delivered | [default to undefined] + +## Example + +```typescript +import { PendingEntryDto } from './api'; + +const instance: PendingEntryDto = { + id, + consumerName, + idle, + delivered, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PickTypeClass.md b/redisinsight/ui/src/api-client/docs/PickTypeClass.md new file mode 100644 index 0000000000..82ad9270ac --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PickTypeClass.md @@ -0,0 +1,20 @@ +# PickTypeClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] + +## Example + +```typescript +import { PickTypeClass } from './api'; + +const instance: PickTypeClass = { + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/Plugin.md b/redisinsight/ui/src/api-client/docs/Plugin.md new file mode 100644 index 0000000000..59c9c9fdef --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Plugin.md @@ -0,0 +1,30 @@ +# Plugin + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**internal** | **boolean** | Determine if plugin is built into Redisinsight | [optional] [default to undefined] +**name** | **string** | Module name from manifest | [default to undefined] +**baseUrl** | **string** | Plugins base url | [default to undefined] +**main** | **string** | Uri to main js file on the local server | [default to undefined] +**styles** | **string** | Uri to css file on the local server | [default to undefined] +**visualizations** | [**Array<PluginVisualization>**](PluginVisualization.md) | Visualization field from manifest | [default to undefined] + +## Example + +```typescript +import { Plugin } from './api'; + +const instance: Plugin = { + internal, + name, + baseUrl, + main, + styles, + visualizations, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PluginCommandExecution.md b/redisinsight/ui/src/api-client/docs/PluginCommandExecution.md new file mode 100644 index 0000000000..272e69652c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PluginCommandExecution.md @@ -0,0 +1,38 @@ +# PluginCommandExecution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**databaseId** | **string** | Database id | [optional] [default to undefined] +**command** | **string** | Redis command | [optional] [default to undefined] +**mode** | **string** | Workbench mode | [optional] [default to ModeEnum_Ascii] +**resultsMode** | **string** | Workbench result mode | [optional] [default to ResultsModeEnum_Default] +**summary** | [**ResultsSummary**](ResultsSummary.md) | Workbench executions summary | [optional] [default to undefined] +**result** | [**Array<CommandExecutionResult>**](CommandExecutionResult.md) | Command execution result | [optional] [default to undefined] +**isNotStored** | **boolean** | Result did not stored in db | [optional] [default to undefined] +**executionTime** | **number** | Workbench command execution time | [optional] [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**type** | **string** | Command execution type. Used to distinguish between search and workbench | [optional] [default to TypeEnum_Workbench] + +## Example + +```typescript +import { PluginCommandExecution } from './api'; + +const instance: PluginCommandExecution = { + databaseId, + command, + mode, + resultsMode, + summary, + result, + isNotStored, + executionTime, + db, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PluginState.md b/redisinsight/ui/src/api-client/docs/PluginState.md new file mode 100644 index 0000000000..c3e5cc7840 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PluginState.md @@ -0,0 +1,28 @@ +# PluginState + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**visualizationId** | **string** | Plugin visualization id. Should be unique per all plugins | [default to undefined] +**commandExecutionId** | **string** | Command Execution id | [default to undefined] +**state** | **string** | Stored state | [default to undefined] +**createdAt** | **string** | Date of creation | [default to undefined] +**updatedAt** | **string** | Date of updating | [default to undefined] + +## Example + +```typescript +import { PluginState } from './api'; + +const instance: PluginState = { + visualizationId, + commandExecutionId, + state, + createdAt, + updatedAt, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PluginVisualization.md b/redisinsight/ui/src/api-client/docs/PluginVisualization.md new file mode 100644 index 0000000000..4ddaa9d5b9 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PluginVisualization.md @@ -0,0 +1,32 @@ +# PluginVisualization + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**name** | **string** | | [default to undefined] +**activationMethod** | **string** | | [default to undefined] +**matchCommands** | **Array<string>** | | [default to undefined] +**_default** | **boolean** | | [default to undefined] +**iconDark** | **string** | | [default to undefined] +**iconLight** | **string** | | [default to undefined] + +## Example + +```typescript +import { PluginVisualization } from './api'; + +const instance: PluginVisualization = { + id, + name, + activationMethod, + matchCommands, + _default, + iconDark, + iconLight, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PluginsApi.md b/redisinsight/ui/src/api-client/docs/PluginsApi.md new file mode 100644 index 0000000000..44bae7ab76 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PluginsApi.md @@ -0,0 +1,280 @@ +# PluginsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**pluginControllerGetAll**](#plugincontrollergetall) | **GET** /api/plugins | | +|[**pluginsControllerGetPluginCommands**](#pluginscontrollergetplugincommands) | **GET** /api/databases/{dbInstance}/plugins/commands | | +|[**pluginsControllerGetState**](#pluginscontrollergetstate) | **GET** /api/databases/{dbInstance}/plugins/{visualizationId}/command-executions/{id}/state | | +|[**pluginsControllerSaveState**](#pluginscontrollersavestate) | **POST** /api/databases/{dbInstance}/plugins/{visualizationId}/command-executions/{id}/state | | +|[**pluginsControllerSendCommand**](#pluginscontrollersendcommand) | **POST** /api/databases/{dbInstance}/plugins/command-executions | | + +# **pluginControllerGetAll** +> PluginsResponse pluginControllerGetAll() + +Get list of available plugins + +### Example + +```typescript +import { + PluginsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PluginsApi(configuration); + +const { status, data } = await apiInstance.pluginControllerGetAll(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**PluginsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pluginsControllerGetPluginCommands** +> Array pluginsControllerGetPluginCommands() + +Get Redis whitelist commands available for plugins + +### Example + +```typescript +import { + PluginsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PluginsApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) + +const { status, data } = await apiInstance.pluginsControllerGetPluginCommands( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | List of available commands | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pluginsControllerGetState** +> PluginState pluginsControllerGetState() + +Get previously saved state + +### Example + +```typescript +import { + PluginsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PluginsApi(configuration); + +let visualizationId: string; // (default to undefined) +let id: string; // (default to undefined) +let dbInstance: string; //Database instance id. (default to undefined) + +const { status, data } = await apiInstance.pluginsControllerGetState( + visualizationId, + id, + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **visualizationId** | [**string**] | | defaults to undefined| +| **id** | [**string**] | | defaults to undefined| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +**PluginState** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Plugin state | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pluginsControllerSaveState** +> pluginsControllerSaveState(createPluginStateDto) + +Save plugin state for particular command execution + +### Example + +```typescript +import { + PluginsApi, + Configuration, + CreatePluginStateDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PluginsApi(configuration); + +let visualizationId: string; // (default to undefined) +let id: string; // (default to undefined) +let dbInstance: string; //Database instance id. (default to undefined) +let createPluginStateDto: CreatePluginStateDto; // + +const { status, data } = await apiInstance.pluginsControllerSaveState( + visualizationId, + id, + dbInstance, + createPluginStateDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createPluginStateDto** | **CreatePluginStateDto**| | | +| **visualizationId** | [**string**] | | defaults to undefined| +| **id** | [**string**] | | defaults to undefined| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pluginsControllerSendCommand** +> PluginCommandExecution pluginsControllerSendCommand(createCommandExecutionDto) + +Send Redis Command from the Workbench + +### Example + +```typescript +import { + PluginsApi, + Configuration, + CreateCommandExecutionDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PluginsApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let createCommandExecutionDto: CreateCommandExecutionDto; // + +const { status, data } = await apiInstance.pluginsControllerSendCommand( + dbInstance, + createCommandExecutionDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createCommandExecutionDto** | **CreateCommandExecutionDto**| | | +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +**PluginCommandExecution** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/PluginsResponse.md b/redisinsight/ui/src/api-client/docs/PluginsResponse.md new file mode 100644 index 0000000000..93d02d5013 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PluginsResponse.md @@ -0,0 +1,22 @@ +# PluginsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_static** | **string** | Uri to static resources required for plugins | [default to undefined] +**plugins** | [**Array<Plugin>**](Plugin.md) | List of available plugins | [default to undefined] + +## Example + +```typescript +import { PluginsResponse } from './api'; + +const instance: PluginsResponse = { + _static, + plugins, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ProfilerApi.md b/redisinsight/ui/src/api-client/docs/ProfilerApi.md new file mode 100644 index 0000000000..975fbcddf0 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ProfilerApi.md @@ -0,0 +1,59 @@ +# ProfilerApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**profilerControllerDownloadLogsFile**](#profilercontrollerdownloadlogsfile) | **GET** /api/profiler/logs/{id} | | + +# **profilerControllerDownloadLogsFile** +> profilerControllerDownloadLogsFile() + +Endpoint do download profiler log file + +### Example + +```typescript +import { + ProfilerApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilerApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.profilerControllerDownloadLogsFile( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/PubSubApi.md b/redisinsight/ui/src/api-client/docs/PubSubApi.md new file mode 100644 index 0000000000..bbd63c06fa --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PubSubApi.md @@ -0,0 +1,63 @@ +# PubSubApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**pubSubControllerPublish**](#pubsubcontrollerpublish) | **POST** /api/databases/{dbInstance}/pub-sub/messages | | + +# **pubSubControllerPublish** +> PublishResponse pubSubControllerPublish(publishDto) + +Publish message to a channel + +### Example + +```typescript +import { + PubSubApi, + Configuration, + PublishDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PubSubApi(configuration); + +let dbInstance: string; // (default to undefined) +let publishDto: PublishDto; // + +const { status, data } = await apiInstance.pubSubControllerPublish( + dbInstance, + publishDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **publishDto** | **PublishDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +**PublishResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Returns number of clients message ws delivered | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/PublishDto.md b/redisinsight/ui/src/api-client/docs/PublishDto.md new file mode 100644 index 0000000000..a523b522f8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PublishDto.md @@ -0,0 +1,22 @@ +# PublishDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | Message to send | [default to undefined] +**channel** | **string** | Chanel name | [default to undefined] + +## Example + +```typescript +import { PublishDto } from './api'; + +const instance: PublishDto = { + message, + channel, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PublishResponse.md b/redisinsight/ui/src/api-client/docs/PublishResponse.md new file mode 100644 index 0000000000..03b3a57c92 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PublishResponse.md @@ -0,0 +1,20 @@ +# PublishResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Number of clients message ws delivered | [default to undefined] + +## Example + +```typescript +import { PublishResponse } from './api'; + +const instance: PublishResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PushElementToListDto.md b/redisinsight/ui/src/api-client/docs/PushElementToListDto.md new file mode 100644 index 0000000000..ac570bc1f1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PushElementToListDto.md @@ -0,0 +1,24 @@ +# PushElementToListDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**elements** | [**Array<CreateListWithExpireDtoElementsInner>**](CreateListWithExpireDtoElementsInner.md) | List element(s) | [default to undefined] +**destination** | **string** | In order to append elements to the end of the list, use the TAIL value, to prepend use HEAD value. Default: TAIL (when not specified) | [optional] [default to DestinationEnum_Tail] + +## Example + +```typescript +import { PushElementToListDto } from './api'; + +const instance: PushElementToListDto = { + keyName, + elements, + destination, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PushListElementsResponse.md b/redisinsight/ui/src/api-client/docs/PushListElementsResponse.md new file mode 100644 index 0000000000..f34f34ab41 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PushListElementsResponse.md @@ -0,0 +1,22 @@ +# PushListElementsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**total** | **number** | The number of elements in the list after current operation. | [default to undefined] + +## Example + +```typescript +import { PushListElementsResponse } from './api'; + +const instance: PushListElementsResponse = { + keyName, + total, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/PushListElementsResponseKeyName.md b/redisinsight/ui/src/api-client/docs/PushListElementsResponseKeyName.md new file mode 100644 index 0000000000..e24d3e5b6d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/PushListElementsResponseKeyName.md @@ -0,0 +1,23 @@ +# PushListElementsResponseKeyName + +keyName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { PushListElementsResponseKeyName } from './api'; + +const instance: PushListElementsResponseKeyName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RDIApi.md b/redisinsight/ui/src/api-client/docs/RDIApi.md new file mode 100644 index 0000000000..5dbbf37edf --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RDIApi.md @@ -0,0 +1,1057 @@ +# RDIApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**rdiControllerConnect**](#rdicontrollerconnect) | **GET** /api/rdi/{id}/connect | | +|[**rdiControllerCreate**](#rdicontrollercreate) | **POST** /api/rdi | | +|[**rdiControllerDelete**](#rdicontrollerdelete) | **DELETE** /api/rdi | | +|[**rdiControllerGet**](#rdicontrollerget) | **GET** /api/rdi/{id} | | +|[**rdiControllerList**](#rdicontrollerlist) | **GET** /api/rdi | | +|[**rdiControllerUpdate**](#rdicontrollerupdate) | **PATCH** /api/rdi/{id} | | +|[**rdiPipelineControllerDeploy**](#rdipipelinecontrollerdeploy) | **POST** /api/rdi/{id}/pipeline/deploy | | +|[**rdiPipelineControllerDryRunJob**](#rdipipelinecontrollerdryrunjob) | **POST** /api/rdi/{id}/pipeline/dry-run-job | | +|[**rdiPipelineControllerGetConfigTemplate**](#rdipipelinecontrollergetconfigtemplate) | **GET** /api/rdi/{id}/pipeline/config/template/{pipelineType}/{dbType} | | +|[**rdiPipelineControllerGetJobFunctions**](#rdipipelinecontrollergetjobfunctions) | **GET** /api/rdi/{id}/pipeline/job-functions | | +|[**rdiPipelineControllerGetJobTemplate**](#rdipipelinecontrollergetjobtemplate) | **GET** /api/rdi/{id}/pipeline/job/template/{pipelineType} | | +|[**rdiPipelineControllerGetPipeline**](#rdipipelinecontrollergetpipeline) | **GET** /api/rdi/{id}/pipeline | | +|[**rdiPipelineControllerGetPipelineStatus**](#rdipipelinecontrollergetpipelinestatus) | **GET** /api/rdi/{id}/pipeline/status | | +|[**rdiPipelineControllerGetSchema**](#rdipipelinecontrollergetschema) | **GET** /api/rdi/{id}/pipeline/schema | | +|[**rdiPipelineControllerGetStrategies**](#rdipipelinecontrollergetstrategies) | **GET** /api/rdi/{id}/pipeline/strategies | | +|[**rdiPipelineControllerResetPipeline**](#rdipipelinecontrollerresetpipeline) | **POST** /api/rdi/{id}/pipeline/reset | | +|[**rdiPipelineControllerStartPipeline**](#rdipipelinecontrollerstartpipeline) | **POST** /api/rdi/{id}/pipeline/start | | +|[**rdiPipelineControllerStopPipeline**](#rdipipelinecontrollerstoppipeline) | **POST** /api/rdi/{id}/pipeline/stop | | +|[**rdiPipelineControllerTestConnections**](#rdipipelinecontrollertestconnections) | **POST** /api/rdi/{id}/pipeline/test-connections | | +|[**rdiStatisticsControllerGetStatistics**](#rdistatisticscontrollergetstatistics) | **GET** /api/rdi/{id}/statistics | | + +# **rdiControllerConnect** +> rdiControllerConnect() + +Connect to RDI + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiControllerConnect( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successfully connected to rdi instance | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiControllerCreate** +> Rdi rdiControllerCreate(createRdiDto) + +Create RDI + +### Example + +```typescript +import { + RDIApi, + Configuration, + CreateRdiDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let createRdiDto: CreateRdiDto; // + +const { status, data } = await apiInstance.rdiControllerCreate( + createRdiDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createRdiDto** | **CreateRdiDto**| | | + + +### Return type + +**Rdi** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiControllerDelete** +> rdiControllerDelete() + +Delete RDI + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +const { status, data } = await apiInstance.rdiControllerDelete(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiControllerGet** +> Rdi rdiControllerGet() + +Get RDI by id + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiControllerGet( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**Rdi** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiControllerList** +> Array rdiControllerList() + +Get RDI list + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +const { status, data } = await apiInstance.rdiControllerList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiControllerUpdate** +> Rdi rdiControllerUpdate(updateRdiDto) + +Update RDI + +### Example + +```typescript +import { + RDIApi, + Configuration, + UpdateRdiDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) +let updateRdiDto: UpdateRdiDto; // + +const { status, data } = await apiInstance.rdiControllerUpdate( + id, + updateRdiDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateRdiDto** | **UpdateRdiDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**Rdi** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerDeploy** +> rdiPipelineControllerDeploy(body) + +Deploy the pipeline + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) +let body: object; // + +const { status, data } = await apiInstance.rdiPipelineControllerDeploy( + id, + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **object**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerDryRunJob** +> RdiDryRunJobResponseDto rdiPipelineControllerDryRunJob(rdiDryRunJobDto) + +Dry run job + +### Example + +```typescript +import { + RDIApi, + Configuration, + RdiDryRunJobDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) +let rdiDryRunJobDto: RdiDryRunJobDto; // + +const { status, data } = await apiInstance.rdiPipelineControllerDryRunJob( + id, + rdiDryRunJobDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **rdiDryRunJobDto** | **RdiDryRunJobDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**RdiDryRunJobResponseDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetConfigTemplate** +> RdiTemplateResponseDto rdiPipelineControllerGetConfigTemplate() + +Get config template for selected pipeline and db types + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let pipelineType: string; // (default to undefined) +let dbType: string; // (default to undefined) +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetConfigTemplate( + pipelineType, + dbType, + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pipelineType** | [**string**] | | defaults to undefined| +| **dbType** | [**string**] | | defaults to undefined| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**RdiTemplateResponseDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetJobFunctions** +> rdiPipelineControllerGetJobFunctions() + +Get job functions + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetJobFunctions( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetJobTemplate** +> RdiTemplateResponseDto rdiPipelineControllerGetJobTemplate() + +Get job template for selected pipeline type + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let pipelineType: string; // (default to undefined) +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetJobTemplate( + pipelineType, + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pipelineType** | [**string**] | | defaults to undefined| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**RdiTemplateResponseDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetPipeline** +> object rdiPipelineControllerGetPipeline() + +Get pipeline + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetPipeline( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetPipelineStatus** +> rdiPipelineControllerGetPipelineStatus() + +Get pipeline status + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetPipelineStatus( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetSchema** +> object rdiPipelineControllerGetSchema() + +Get pipeline schema + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetSchema( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerGetStrategies** +> object rdiPipelineControllerGetStrategies() + +Get pipeline strategies and db types for template + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerGetStrategies( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerResetPipeline** +> rdiPipelineControllerResetPipeline() + +Resets default pipeline + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerResetPipeline( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerStartPipeline** +> rdiPipelineControllerStartPipeline() + +Starts the stopped pipeline + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerStartPipeline( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerStopPipeline** +> rdiPipelineControllerStopPipeline() + +Stops running pipeline + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerStopPipeline( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiPipelineControllerTestConnections** +> RdiTestConnectionsResponseDto rdiPipelineControllerTestConnections() + +Test target connections + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.rdiPipelineControllerTestConnections( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**RdiTestConnectionsResponseDto** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **rdiStatisticsControllerGetStatistics** +> object rdiStatisticsControllerGetStatistics() + +Get statistics + +### Example + +```typescript +import { + RDIApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RDIApi(configuration); + +let id: string; // (default to undefined) +let sections: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.rdiStatisticsControllerGetStatistics( + id, + sections +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| +| **sections** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**object** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/Rdi.md b/redisinsight/ui/src/api-client/docs/Rdi.md new file mode 100644 index 0000000000..5d614cd51d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Rdi.md @@ -0,0 +1,32 @@ +# Rdi + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | RDI id. | [default to undefined] +**url** | **string** | Base url of API to connect to (for API type only) | [optional] [default to undefined] +**name** | **string** | A name to associate with RDI | [default to undefined] +**username** | **string** | RDI or API username | [optional] [default to undefined] +**password** | **string** | RDI or API password | [optional] [default to undefined] +**lastConnection** | **string** | Time of the last connection to RDI. | [default to undefined] +**version** | **string** | The version of RDI being used | [optional] [default to undefined] + +## Example + +```typescript +import { Rdi } from './api'; + +const instance: Rdi = { + id, + url, + name, + username, + password, + lastConnection, + version, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RdiDryRunJobDto.md b/redisinsight/ui/src/api-client/docs/RdiDryRunJobDto.md new file mode 100644 index 0000000000..56232e0ffa --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RdiDryRunJobDto.md @@ -0,0 +1,22 @@ +# RdiDryRunJobDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input_data** | **object** | Input data | [default to undefined] +**job** | **object** | Job file | [default to undefined] + +## Example + +```typescript +import { RdiDryRunJobDto } from './api'; + +const instance: RdiDryRunJobDto = { + input_data, + job, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RdiDryRunJobResponseDto.md b/redisinsight/ui/src/api-client/docs/RdiDryRunJobResponseDto.md new file mode 100644 index 0000000000..1e08ba8298 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RdiDryRunJobResponseDto.md @@ -0,0 +1,22 @@ +# RdiDryRunJobResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transformations** | **object** | Dry run job transformations result | [default to undefined] +**commands** | **object** | Dry run job commands result | [default to undefined] + +## Example + +```typescript +import { RdiDryRunJobResponseDto } from './api'; + +const instance: RdiDryRunJobResponseDto = { + transformations, + commands, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RdiTemplateResponseDto.md b/redisinsight/ui/src/api-client/docs/RdiTemplateResponseDto.md new file mode 100644 index 0000000000..23604f7d72 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RdiTemplateResponseDto.md @@ -0,0 +1,20 @@ +# RdiTemplateResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**template** | **string** | Template for rdi file | [default to undefined] + +## Example + +```typescript +import { RdiTemplateResponseDto } from './api'; + +const instance: RdiTemplateResponseDto = { + template, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RdiTestConnectionsResponseDto.md b/redisinsight/ui/src/api-client/docs/RdiTestConnectionsResponseDto.md new file mode 100644 index 0000000000..424ae6b1d9 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RdiTestConnectionsResponseDto.md @@ -0,0 +1,22 @@ +# RdiTestConnectionsResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sources** | **object** | Sources connection results | [default to undefined] +**targets** | **object** | Targets connection results | [default to undefined] + +## Example + +```typescript +import { RdiTestConnectionsResponseDto } from './api'; + +const instance: RdiTestConnectionsResponseDto = { + sources, + targets, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ReadNotificationsDto.md b/redisinsight/ui/src/api-client/docs/ReadNotificationsDto.md new file mode 100644 index 0000000000..ffd297f9fe --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ReadNotificationsDto.md @@ -0,0 +1,22 @@ +# ReadNotificationsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timestamp** | **number** | Timestamp of notification | [optional] [default to undefined] +**type** | **string** | Type of notification | [optional] [default to undefined] + +## Example + +```typescript +import { ReadNotificationsDto } from './api'; + +const instance: ReadNotificationsDto = { + timestamp, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/Recommendation.md b/redisinsight/ui/src/api-client/docs/Recommendation.md new file mode 100644 index 0000000000..f31e5e7440 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Recommendation.md @@ -0,0 +1,24 @@ +# Recommendation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Recommendation name | [default to undefined] +**params** | **object** | Additional recommendation params | [optional] [default to undefined] +**vote** | **string** | User vote | [optional] [default to undefined] + +## Example + +```typescript +import { Recommendation } from './api'; + +const instance: Recommendation = { + name, + params, + vote, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RecommendationVoteDto.md b/redisinsight/ui/src/api-client/docs/RecommendationVoteDto.md new file mode 100644 index 0000000000..084f5c2aed --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RecommendationVoteDto.md @@ -0,0 +1,22 @@ +# RecommendationVoteDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Recommendation name | [default to undefined] +**vote** | **string** | User vote | [default to undefined] + +## Example + +```typescript +import { RecommendationVoteDto } from './api'; + +const instance: RecommendationVoteDto = { + name, + vote, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RedisDatabaseInfoResponse.md b/redisinsight/ui/src/api-client/docs/RedisDatabaseInfoResponse.md new file mode 100644 index 0000000000..f218638c0f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RedisDatabaseInfoResponse.md @@ -0,0 +1,42 @@ +# RedisDatabaseInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Redis database version | [default to undefined] +**role** | **string** | Value is \"master\" if the instance is replica of no one, or \"slave\" if the instance is a replica of some master instance | [optional] [default to RoleEnum_Master] +**server** | **object** | Redis database info from server section | [optional] [default to undefined] +**stats** | [**RedisDatabaseStatsDto**](RedisDatabaseStatsDto.md) | Various Redis stats | [optional] [default to undefined] +**databases** | **number** | The number of Redis databases | [optional] [default to 16] +**usedMemory** | **number** | Total number of bytes allocated by Redis using | [optional] [default to undefined] +**totalKeys** | **number** | Total number of keys inside Redis database | [optional] [default to undefined] +**connectedClients** | **number** | Number of client connections (excluding connections from replicas) | [optional] [default to undefined] +**uptimeInSeconds** | **number** | Number of seconds since Redis server start | [optional] [default to undefined] +**hitRatio** | **number** | The cache hit ratio represents the efficiency of cache usage | [optional] [default to undefined] +**cashedScripts** | **number** | The number of the cached lua scripts | [optional] [default to undefined] +**nodes** | [**Array<RedisNodeInfoResponse>**](RedisNodeInfoResponse.md) | Nodes info | [optional] [default to undefined] + +## Example + +```typescript +import { RedisDatabaseInfoResponse } from './api'; + +const instance: RedisDatabaseInfoResponse = { + version, + role, + server, + stats, + databases, + usedMemory, + totalKeys, + connectedClients, + uptimeInSeconds, + hitRatio, + cashedScripts, + nodes, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RedisDatabaseStatsDto.md b/redisinsight/ui/src/api-client/docs/RedisDatabaseStatsDto.md new file mode 100644 index 0000000000..d37971bbb6 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RedisDatabaseStatsDto.md @@ -0,0 +1,30 @@ +# RedisDatabaseStatsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instantaneous_input_kbps** | **string** | | [default to undefined] +**instantaneous_ops_per_sec** | **string** | | [default to undefined] +**instantaneous_output_kbps** | **string** | | [default to undefined] +**maxmemory_policy** | **number** | | [default to undefined] +**numberOfKeysRange** | **string** | Redis database mode | [default to undefined] +**uptime_in_days** | **string** | Redis database role | [default to undefined] + +## Example + +```typescript +import { RedisDatabaseStatsDto } from './api'; + +const instance: RedisDatabaseStatsDto = { + instantaneous_input_kbps, + instantaneous_ops_per_sec, + instantaneous_output_kbps, + maxmemory_policy, + numberOfKeysRange, + uptime_in_days, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RedisEnterpriseClusterApi.md b/redisinsight/ui/src/api-client/docs/RedisEnterpriseClusterApi.md new file mode 100644 index 0000000000..15ae717d3f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RedisEnterpriseClusterApi.md @@ -0,0 +1,113 @@ +# RedisEnterpriseClusterApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**redisEnterpriseControllerAddRedisEnterpriseDatabases**](#redisenterprisecontrolleraddredisenterprisedatabases) | **POST** /api/redis-enterprise/cluster/databases | | +|[**redisEnterpriseControllerGetDatabases**](#redisenterprisecontrollergetdatabases) | **POST** /api/redis-enterprise/cluster/get-databases | | + +# **redisEnterpriseControllerAddRedisEnterpriseDatabases** +> Array redisEnterpriseControllerAddRedisEnterpriseDatabases(addRedisEnterpriseDatabasesDto) + +Add databases from Redis Enterprise cluster + +### Example + +```typescript +import { + RedisEnterpriseClusterApi, + Configuration, + AddRedisEnterpriseDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RedisEnterpriseClusterApi(configuration); + +let addRedisEnterpriseDatabasesDto: AddRedisEnterpriseDatabasesDto; // + +const { status, data } = await apiInstance.redisEnterpriseControllerAddRedisEnterpriseDatabases( + addRedisEnterpriseDatabasesDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **addRedisEnterpriseDatabasesDto** | **AddRedisEnterpriseDatabasesDto**| | | + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Added databases list. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **redisEnterpriseControllerGetDatabases** +> Array redisEnterpriseControllerGetDatabases(clusterConnectionDetailsDto) + +Get all databases in the cluster. + +### Example + +```typescript +import { + RedisEnterpriseClusterApi, + Configuration, + ClusterConnectionDetailsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RedisEnterpriseClusterApi(configuration); + +let clusterConnectionDetailsDto: ClusterConnectionDetailsDto; // + +const { status, data } = await apiInstance.redisEnterpriseControllerGetDatabases( + clusterConnectionDetailsDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **clusterConnectionDetailsDto** | **ClusterConnectionDetailsDto**| | | + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | All databases in the cluster. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/RedisEnterpriseDatabase.md b/redisinsight/ui/src/api-client/docs/RedisEnterpriseDatabase.md new file mode 100644 index 0000000000..2300039c27 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RedisEnterpriseDatabase.md @@ -0,0 +1,38 @@ +# RedisEnterpriseDatabase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uid** | **number** | The unique ID of the database. | [default to undefined] +**name** | **string** | Name of database in cluster. | [default to undefined] +**dnsName** | **string** | DNS name your Redis Enterprise cluster database is available on. | [default to undefined] +**address** | **string** | Address your Redis Enterprise cluster database is available on. | [default to undefined] +**port** | **number** | The port your Redis Enterprise cluster database is available on. | [default to undefined] +**status** | **string** | Database status | [default to StatusEnum_Active] +**modules** | **Array<string>** | Information about the modules loaded to the database | [default to undefined] +**tls** | **boolean** | Is TLS mode enabled? | [default to undefined] +**_options** | **object** | Additional database options | [default to undefined] +**tags** | [**Array<CreateTagDto>**](CreateTagDto.md) | Tags associated with the database. | [default to undefined] + +## Example + +```typescript +import { RedisEnterpriseDatabase } from './api'; + +const instance: RedisEnterpriseDatabase = { + uid, + name, + dnsName, + address, + port, + status, + modules, + tls, + _options, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RedisNodeInfoResponse.md b/redisinsight/ui/src/api-client/docs/RedisNodeInfoResponse.md new file mode 100644 index 0000000000..7a3f279a6e --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RedisNodeInfoResponse.md @@ -0,0 +1,40 @@ +# RedisNodeInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Redis database version | [default to undefined] +**role** | **string** | Value is \"master\" if the instance is replica of no one, or \"slave\" if the instance is a replica of some master instance | [optional] [default to RoleEnum_Master] +**server** | **object** | Redis database info from server section | [optional] [default to undefined] +**stats** | [**RedisDatabaseStatsDto**](RedisDatabaseStatsDto.md) | Various Redis stats | [optional] [default to undefined] +**databases** | **number** | The number of Redis databases | [optional] [default to 16] +**usedMemory** | **number** | Total number of bytes allocated by Redis using | [optional] [default to undefined] +**totalKeys** | **number** | Total number of keys inside Redis database | [optional] [default to undefined] +**connectedClients** | **number** | Number of client connections (excluding connections from replicas) | [optional] [default to undefined] +**uptimeInSeconds** | **number** | Number of seconds since Redis server start | [optional] [default to undefined] +**hitRatio** | **number** | The cache hit ratio represents the efficiency of cache usage | [optional] [default to undefined] +**cashedScripts** | **number** | The number of the cached lua scripts | [optional] [default to undefined] + +## Example + +```typescript +import { RedisNodeInfoResponse } from './api'; + +const instance: RedisNodeInfoResponse = { + version, + role, + server, + stats, + databases, + usedMemory, + totalKeys, + connectedClients, + uptimeInSeconds, + hitRatio, + cashedScripts, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RedisOSSSentinelApi.md b/redisinsight/ui/src/api-client/docs/RedisOSSSentinelApi.md new file mode 100644 index 0000000000..35195ce457 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RedisOSSSentinelApi.md @@ -0,0 +1,113 @@ +# RedisOSSSentinelApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**redisSentinelControllerAddSentinelMasters**](#redissentinelcontrolleraddsentinelmasters) | **POST** /api/redis-sentinel/databases | | +|[**redisSentinelControllerGetMasters**](#redissentinelcontrollergetmasters) | **POST** /api/redis-sentinel/get-databases | | + +# **redisSentinelControllerAddSentinelMasters** +> Array redisSentinelControllerAddSentinelMasters(createSentinelDatabasesDto) + +Add masters from Redis Sentinel + +### Example + +```typescript +import { + RedisOSSSentinelApi, + Configuration, + CreateSentinelDatabasesDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RedisOSSSentinelApi(configuration); + +let createSentinelDatabasesDto: CreateSentinelDatabasesDto; // + +const { status, data } = await apiInstance.redisSentinelControllerAddSentinelMasters( + createSentinelDatabasesDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createSentinelDatabasesDto** | **CreateSentinelDatabasesDto**| | | + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **redisSentinelControllerGetMasters** +> Array redisSentinelControllerGetMasters(discoverSentinelMastersDto) + +Get master groups + +### Example + +```typescript +import { + RedisOSSSentinelApi, + Configuration, + DiscoverSentinelMastersDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RedisOSSSentinelApi(configuration); + +let discoverSentinelMastersDto: DiscoverSentinelMastersDto; // + +const { status, data } = await apiInstance.redisSentinelControllerGetMasters( + discoverSentinelMastersDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **discoverSentinelMastersDto** | **DiscoverSentinelMastersDto**| | | + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/RemoveRejsonRlDto.md b/redisinsight/ui/src/api-client/docs/RemoveRejsonRlDto.md new file mode 100644 index 0000000000..c30c0f1916 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RemoveRejsonRlDto.md @@ -0,0 +1,22 @@ +# RemoveRejsonRlDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**path** | **string** | Path of the json field | [default to undefined] + +## Example + +```typescript +import { RemoveRejsonRlDto } from './api'; + +const instance: RemoveRejsonRlDto = { + keyName, + path, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RemoveRejsonRlResponse.md b/redisinsight/ui/src/api-client/docs/RemoveRejsonRlResponse.md new file mode 100644 index 0000000000..aca54f8349 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RemoveRejsonRlResponse.md @@ -0,0 +1,20 @@ +# RemoveRejsonRlResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affected** | **number** | Integer , specifically the number of paths deleted (0 or 1). | [default to undefined] + +## Example + +```typescript +import { RemoveRejsonRlResponse } from './api'; + +const instance: RemoveRejsonRlResponse = { + affected, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RenameKeyDto.md b/redisinsight/ui/src/api-client/docs/RenameKeyDto.md new file mode 100644 index 0000000000..22678f68c0 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RenameKeyDto.md @@ -0,0 +1,22 @@ +# RenameKeyDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**newKeyName** | [**RenameKeyDtoNewKeyName**](RenameKeyDtoNewKeyName.md) | | [default to undefined] + +## Example + +```typescript +import { RenameKeyDto } from './api'; + +const instance: RenameKeyDto = { + keyName, + newKeyName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RenameKeyDtoNewKeyName.md b/redisinsight/ui/src/api-client/docs/RenameKeyDtoNewKeyName.md new file mode 100644 index 0000000000..c7a69e66e3 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RenameKeyDtoNewKeyName.md @@ -0,0 +1,23 @@ +# RenameKeyDtoNewKeyName + +New key name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { RenameKeyDtoNewKeyName } from './api'; + +const instance: RenameKeyDtoNewKeyName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RenameKeyResponse.md b/redisinsight/ui/src/api-client/docs/RenameKeyResponse.md new file mode 100644 index 0000000000..6ef84b6733 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RenameKeyResponse.md @@ -0,0 +1,20 @@ +# RenameKeyResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] + +## Example + +```typescript +import { RenameKeyResponse } from './api'; + +const instance: RenameKeyResponse = { + keyName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ResultsSummary.md b/redisinsight/ui/src/api-client/docs/ResultsSummary.md new file mode 100644 index 0000000000..ccdd843063 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ResultsSummary.md @@ -0,0 +1,24 @@ +# ResultsSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **number** | Total number of commands executed | [default to undefined] +**success** | **number** | Total number of successful commands executed | [default to undefined] +**fail** | **number** | Total number of failed commands executed | [default to undefined] + +## Example + +```typescript +import { ResultsSummary } from './api'; + +const instance: ResultsSummary = { + total, + success, + fail, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/RootCustomTutorialManifest.md b/redisinsight/ui/src/api-client/docs/RootCustomTutorialManifest.md new file mode 100644 index 0000000000..2ed4a334b1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/RootCustomTutorialManifest.md @@ -0,0 +1,44 @@ +# RootCustomTutorialManifest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**type** | **string** | | [default to undefined] +**label** | **string** | | [default to undefined] +**summary** | **string** | | [default to undefined] +**args** | [**CustomTutorialManifestArgs**](CustomTutorialManifestArgs.md) | | [optional] [default to undefined] +**children** | [**CustomTutorialManifest**](CustomTutorialManifest.md) | | [optional] [default to undefined] +**_actions** | **string** | | [optional] [default to undefined] +**_path** | **string** | | [optional] [default to undefined] +**keywords** | **Array<string>** | | [optional] [default to undefined] +**author** | **string** | | [optional] [default to undefined] +**url** | **string** | | [optional] [default to undefined] +**industry** | **Array<string>** | | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { RootCustomTutorialManifest } from './api'; + +const instance: RootCustomTutorialManifest = { + id, + type, + label, + summary, + args, + children, + _actions, + _path, + keywords, + author, + url, + industry, + description, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SafeRejsonRlDataDto.md b/redisinsight/ui/src/api-client/docs/SafeRejsonRlDataDto.md new file mode 100644 index 0000000000..a848393d78 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SafeRejsonRlDataDto.md @@ -0,0 +1,28 @@ +# SafeRejsonRlDataDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | Key inside json data | [default to undefined] +**path** | **string** | Path of the json field | [default to undefined] +**cardinality** | **number** | Number of properties/elements inside field (for object and arrays only) | [optional] [default to undefined] +**type** | **string** | Type of the field | [default to undefined] +**value** | **string** | Any value | [optional] [default to undefined] + +## Example + +```typescript +import { SafeRejsonRlDataDto } from './api'; + +const instance: SafeRejsonRlDataDto = { + key, + path, + cardinality, + type, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ScanFilter.md b/redisinsight/ui/src/api-client/docs/ScanFilter.md new file mode 100644 index 0000000000..579950a8f6 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ScanFilter.md @@ -0,0 +1,22 @@ +# ScanFilter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Key type | [default to undefined] +**match** | **string** | Match glob patterns | [default to '*'] + +## Example + +```typescript +import { ScanFilter } from './api'; + +const instance: ScanFilter = { + type, + match, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SearchRedisearchDto.md b/redisinsight/ui/src/api-client/docs/SearchRedisearchDto.md new file mode 100644 index 0000000000..2e57797c25 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SearchRedisearchDto.md @@ -0,0 +1,26 @@ +# SearchRedisearchDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | [**CreateRedisearchIndexDtoIndex**](CreateRedisearchIndexDtoIndex.md) | | [default to undefined] +**query** | **string** | Query to search inside data fields | [default to undefined] +**limit** | **number** | Limit number of results to be returned | [default to undefined] +**offset** | **number** | Offset position to start searching | [default to undefined] + +## Example + +```typescript +import { SearchRedisearchDto } from './api'; + +const instance: SearchRedisearchDto = { + index, + query, + limit, + offset, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SearchZSetMembersDto.md b/redisinsight/ui/src/api-client/docs/SearchZSetMembersDto.md new file mode 100644 index 0000000000..236012be4a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SearchZSetMembersDto.md @@ -0,0 +1,26 @@ +# SearchZSetMembersDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**cursor** | **number** | Iteration cursor. An iteration starts when the cursor is set to 0, and terminates when the cursor returned by the server is 0. | [default to 0] +**count** | **number** | Specifying the number of elements to return. | [optional] [default to 15] +**match** | **string** | Iterate only elements matching a given pattern. | [default to '*'] + +## Example + +```typescript +import { SearchZSetMembersDto } from './api'; + +const instance: SearchZSetMembersDto = { + keyName, + cursor, + count, + match, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SearchZSetMembersResponse.md b/redisinsight/ui/src/api-client/docs/SearchZSetMembersResponse.md new file mode 100644 index 0000000000..ae7ca6e4f8 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SearchZSetMembersResponse.md @@ -0,0 +1,26 @@ +# SearchZSetMembersResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**PushListElementsResponseKeyName**](PushListElementsResponseKeyName.md) | | [default to undefined] +**nextCursor** | **number** | The new cursor to use in the next call. If the property has value of 0, then the iteration is completed. | [default to undefined] +**members** | [**Array<ZSetMemberDto>**](ZSetMemberDto.md) | Array of Members. | [default to undefined] +**total** | **number** | The number of members in the currently-selected z-set. | [default to undefined] + +## Example + +```typescript +import { SearchZSetMembersResponse } from './api'; + +const instance: SearchZSetMembersResponse = { + keyName, + nextCursor, + members, + total, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SendAiChatMessageDto.md b/redisinsight/ui/src/api-client/docs/SendAiChatMessageDto.md new file mode 100644 index 0000000000..6f6d492671 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SendAiChatMessageDto.md @@ -0,0 +1,20 @@ +# SendAiChatMessageDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **string** | Message content | [default to undefined] + +## Example + +```typescript +import { SendAiChatMessageDto } from './api'; + +const instance: SendAiChatMessageDto = { + content, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SendAiQueryMessageDto.md b/redisinsight/ui/src/api-client/docs/SendAiQueryMessageDto.md new file mode 100644 index 0000000000..140dc88f6d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SendAiQueryMessageDto.md @@ -0,0 +1,20 @@ +# SendAiQueryMessageDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **string** | Message content | [default to undefined] + +## Example + +```typescript +import { SendAiQueryMessageDto } from './api'; + +const instance: SendAiQueryMessageDto = { + content, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SendCommandDto.md b/redisinsight/ui/src/api-client/docs/SendCommandDto.md new file mode 100644 index 0000000000..26589b8687 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SendCommandDto.md @@ -0,0 +1,22 @@ +# SendCommandDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**command** | **string** | Redis CLI command | [default to undefined] +**outputFormat** | **string** | Define output format | [optional] [default to OutputFormatEnum_Raw] + +## Example + +```typescript +import { SendCommandDto } from './api'; + +const instance: SendCommandDto = { + command, + outputFormat, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SendCommandResponse.md b/redisinsight/ui/src/api-client/docs/SendCommandResponse.md new file mode 100644 index 0000000000..3d06ca4014 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SendCommandResponse.md @@ -0,0 +1,22 @@ +# SendCommandResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**response** | **string** | Redis CLI response | [default to undefined] +**status** | **string** | Redis CLI command execution status | [default to StatusEnum_Success] + +## Example + +```typescript +import { SendCommandResponse } from './api'; + +const instance: SendCommandResponse = { + response, + status, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SendEventDto.md b/redisinsight/ui/src/api-client/docs/SendEventDto.md new file mode 100644 index 0000000000..61f7d2d80a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SendEventDto.md @@ -0,0 +1,26 @@ +# SendEventDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event** | **string** | Telemetry event name. | [default to undefined] +**eventData** | **object** | Telemetry event data. | [optional] [default to undefined] +**nonTracking** | **boolean** | Does not track the specific user in any way? | [optional] [default to undefined] +**traits** | **object** | User data. | [optional] [default to undefined] + +## Example + +```typescript +import { SendEventDto } from './api'; + +const instance: SendEventDto = { + event, + eventData, + nonTracking, + traits, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SentinelMaster.md b/redisinsight/ui/src/api-client/docs/SentinelMaster.md new file mode 100644 index 0000000000..07b53c59cf --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SentinelMaster.md @@ -0,0 +1,34 @@ +# SentinelMaster + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Sentinel master group name. Identifies a group of Redis instances composed of a master and one or more slaves. | [default to undefined] +**username** | **string** | Sentinel username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password for your Redis Sentinel master. If your master doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**host** | **string** | The hostname of Sentinel master. | [optional] [default to 'localhost'] +**port** | **number** | The port Sentinel master. | [optional] [default to 6379] +**status** | **string** | Sentinel master status | [optional] [default to StatusEnum_Active] +**numberOfSlaves** | **number** | The number of slaves. | [optional] [default to 0] +**nodes** | [**Array<Endpoint>**](Endpoint.md) | Sentinel master endpoints. | [optional] [default to undefined] + +## Example + +```typescript +import { SentinelMaster } from './api'; + +const instance: SentinelMaster = { + name, + username, + password, + host, + port, + status, + numberOfSlaves, + nodes, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SentinelMasterResponse.md b/redisinsight/ui/src/api-client/docs/SentinelMasterResponse.md new file mode 100644 index 0000000000..26e54872ed --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SentinelMasterResponse.md @@ -0,0 +1,34 @@ +# SentinelMasterResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Sentinel master group name. Identifies a group of Redis instances composed of a master and one or more slaves. | [default to undefined] +**username** | **string** | Sentinel username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**host** | **string** | The hostname of Sentinel master. | [optional] [default to 'localhost'] +**port** | **number** | The port Sentinel master. | [optional] [default to 6379] +**status** | **string** | Sentinel master status | [optional] [default to StatusEnum_Active] +**numberOfSlaves** | **number** | The number of slaves. | [optional] [default to 0] +**nodes** | [**Array<Endpoint>**](Endpoint.md) | Sentinel master endpoints. | [optional] [default to undefined] +**password** | **boolean** | The password for your Redis Sentinel master. If your master doesn’t require a password, leave this field empty. | [optional] [default to undefined] + +## Example + +```typescript +import { SentinelMasterResponse } from './api'; + +const instance: SentinelMasterResponse = { + name, + username, + host, + port, + status, + numberOfSlaves, + nodes, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SetListElementDto.md b/redisinsight/ui/src/api-client/docs/SetListElementDto.md new file mode 100644 index 0000000000..006804e476 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SetListElementDto.md @@ -0,0 +1,24 @@ +# SetListElementDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**element** | [**SetListElementDtoElement**](SetListElementDtoElement.md) | | [default to undefined] +**index** | **number** | Element index | [default to undefined] + +## Example + +```typescript +import { SetListElementDto } from './api'; + +const instance: SetListElementDto = { + keyName, + element, + index, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SetListElementDtoElement.md b/redisinsight/ui/src/api-client/docs/SetListElementDtoElement.md new file mode 100644 index 0000000000..09b64b97e0 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SetListElementDtoElement.md @@ -0,0 +1,23 @@ +# SetListElementDtoElement + +List element + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { SetListElementDtoElement } from './api'; + +const instance: SetListElementDtoElement = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SetListElementResponse.md b/redisinsight/ui/src/api-client/docs/SetListElementResponse.md new file mode 100644 index 0000000000..c282e59302 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SetListElementResponse.md @@ -0,0 +1,22 @@ +# SetListElementResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**index** | **number** | Element index | [default to undefined] +**element** | [**SetListElementDtoElement**](SetListElementDtoElement.md) | | [default to undefined] + +## Example + +```typescript +import { SetListElementResponse } from './api'; + +const instance: SetListElementResponse = { + index, + element, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SetStringDto.md b/redisinsight/ui/src/api-client/docs/SetStringDto.md new file mode 100644 index 0000000000..9fbd4eeec2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SetStringDto.md @@ -0,0 +1,22 @@ +# SetStringDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**value** | [**SetStringWithExpireDtoValue**](SetStringWithExpireDtoValue.md) | | [default to undefined] + +## Example + +```typescript +import { SetStringDto } from './api'; + +const instance: SetStringDto = { + keyName, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SetStringWithExpireDto.md b/redisinsight/ui/src/api-client/docs/SetStringWithExpireDto.md new file mode 100644 index 0000000000..de838c1f11 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SetStringWithExpireDto.md @@ -0,0 +1,24 @@ +# SetStringWithExpireDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**value** | [**SetStringWithExpireDtoValue**](SetStringWithExpireDtoValue.md) | | [default to undefined] +**expire** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. | [optional] [default to undefined] + +## Example + +```typescript +import { SetStringWithExpireDto } from './api'; + +const instance: SetStringWithExpireDto = { + keyName, + value, + expire, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SetStringWithExpireDtoValue.md b/redisinsight/ui/src/api-client/docs/SetStringWithExpireDtoValue.md new file mode 100644 index 0000000000..927c1d809f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SetStringWithExpireDtoValue.md @@ -0,0 +1,23 @@ +# SetStringWithExpireDtoValue + +Key value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { SetStringWithExpireDtoValue } from './api'; + +const instance: SetStringWithExpireDtoValue = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SettingsApi.md b/redisinsight/ui/src/api-client/docs/SettingsApi.md new file mode 100644 index 0000000000..522b3a7100 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SettingsApi.md @@ -0,0 +1,150 @@ +# SettingsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**settingsControllerGetAgreementsSpec**](#settingscontrollergetagreementsspec) | **GET** /api/settings/agreements/spec | | +|[**settingsControllerGetAppSettings**](#settingscontrollergetappsettings) | **GET** /api/settings | | +|[**settingsControllerUpdate**](#settingscontrollerupdate) | **PATCH** /api/settings | | + +# **settingsControllerGetAgreementsSpec** +> GetAgreementsSpecResponse settingsControllerGetAgreementsSpec() + +Get json with agreements specification + +### Example + +```typescript +import { + SettingsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SettingsApi(configuration); + +const { status, data } = await apiInstance.settingsControllerGetAgreementsSpec(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**GetAgreementsSpecResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Agreements specification | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **settingsControllerGetAppSettings** +> GetAppSettingsResponse settingsControllerGetAppSettings() + +Get info about application settings + +### Example + +```typescript +import { + SettingsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SettingsApi(configuration); + +const { status, data } = await apiInstance.settingsControllerGetAppSettings(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**GetAppSettingsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Application settings | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **settingsControllerUpdate** +> GetAppSettingsResponse settingsControllerUpdate(updateSettingsDto) + +Update user application settings and agreements + +### Example + +```typescript +import { + SettingsApi, + Configuration, + UpdateSettingsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SettingsApi(configuration); + +let updateSettingsDto: UpdateSettingsDto; // + +const { status, data } = await apiInstance.settingsControllerUpdate( + updateSettingsDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateSettingsDto** | **UpdateSettingsDto**| | | + + +### Return type + +**GetAppSettingsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Application settings | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/ShortCommandExecution.md b/redisinsight/ui/src/api-client/docs/ShortCommandExecution.md new file mode 100644 index 0000000000..a8cfcade98 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ShortCommandExecution.md @@ -0,0 +1,40 @@ +# ShortCommandExecution + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Command execution id | [optional] [default to undefined] +**databaseId** | **string** | Database id | [optional] [default to undefined] +**command** | **string** | Redis command | [optional] [default to undefined] +**mode** | **string** | Workbench mode | [optional] [default to ModeEnum_Ascii] +**resultsMode** | **string** | Workbench result mode | [optional] [default to ResultsModeEnum_Default] +**summary** | [**ResultsSummary**](ResultsSummary.md) | Workbench executions summary | [optional] [default to undefined] +**isNotStored** | **boolean** | Result did not stored in db | [optional] [default to undefined] +**createdAt** | **string** | Date of command execution | [optional] [default to undefined] +**executionTime** | **number** | Workbench command execution time | [optional] [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**type** | **string** | Command execution type. Used to distinguish between search and workbench | [optional] [default to TypeEnum_Workbench] + +## Example + +```typescript +import { ShortCommandExecution } from './api'; + +const instance: ShortCommandExecution = { + id, + databaseId, + command, + mode, + resultsMode, + summary, + isNotStored, + createdAt, + executionTime, + db, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ShortDatabaseAnalysis.md b/redisinsight/ui/src/api-client/docs/ShortDatabaseAnalysis.md new file mode 100644 index 0000000000..15f1a1d77a --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ShortDatabaseAnalysis.md @@ -0,0 +1,24 @@ +# ShortDatabaseAnalysis + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Analysis id | [optional] [default to '76dd5654-814b-4e49-9c72-b236f50891f4'] +**createdAt** | **string** | Analysis created date (ISO string) | [optional] [default to 2022-09-16T06:29:20Z] +**db** | **number** | Logical database number. | [optional] [default to undefined] + +## Example + +```typescript +import { ShortDatabaseAnalysis } from './api'; + +const instance: ShortDatabaseAnalysis = { + id, + createdAt, + db, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SimpleSummary.md b/redisinsight/ui/src/api-client/docs/SimpleSummary.md new file mode 100644 index 0000000000..4405c3fa80 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SimpleSummary.md @@ -0,0 +1,22 @@ +# SimpleSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **number** | Total number | [default to undefined] +**types** | [**Array<SimpleTypeSummary>**](SimpleTypeSummary.md) | Array with totals by type | [default to undefined] + +## Example + +```typescript +import { SimpleSummary } from './api'; + +const instance: SimpleSummary = { + total, + types, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SimpleTypeSummary.md b/redisinsight/ui/src/api-client/docs/SimpleTypeSummary.md new file mode 100644 index 0000000000..bfd218ae48 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SimpleTypeSummary.md @@ -0,0 +1,22 @@ +# SimpleTypeSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type name | [default to undefined] +**total** | **number** | Total inside this type of data | [default to undefined] + +## Example + +```typescript +import { SimpleTypeSummary } from './api'; + +const instance: SimpleTypeSummary = { + type, + total, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SlowLog.md b/redisinsight/ui/src/api-client/docs/SlowLog.md new file mode 100644 index 0000000000..1acc215f33 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SlowLog.md @@ -0,0 +1,30 @@ +# SlowLog + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | Unique slowlog Id calculated by Redis | [default to undefined] +**time** | **number** | Time when command was executed | [default to undefined] +**durationUs** | **number** | Time needed to execute this command in microseconds | [default to undefined] +**args** | **string** | Command with args | [default to undefined] +**source** | **string** | Client that executed this command | [default to undefined] +**client** | **string** | Client name if defined | [optional] [default to undefined] + +## Example + +```typescript +import { SlowLog } from './api'; + +const instance: SlowLog = { + id, + time, + durationUs, + args, + source, + client, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SlowLogConfig.md b/redisinsight/ui/src/api-client/docs/SlowLogConfig.md new file mode 100644 index 0000000000..431a2dadda --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SlowLogConfig.md @@ -0,0 +1,22 @@ +# SlowLogConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**slowlogMaxLen** | **number** | Max logs to store inside Redis slowlog | [optional] [default to undefined] +**slowlogLogSlowerThan** | **number** | Store logs with execution time greater than this value (in microseconds) | [optional] [default to undefined] + +## Example + +```typescript +import { SlowLogConfig } from './api'; + +const instance: SlowLogConfig = { + slowlogMaxLen, + slowlogLogSlowerThan, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SlowLogsApi.md b/redisinsight/ui/src/api-client/docs/SlowLogsApi.md new file mode 100644 index 0000000000..b4534e4ece --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SlowLogsApi.md @@ -0,0 +1,222 @@ +# SlowLogsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**slowLogControllerGetConfig**](#slowlogcontrollergetconfig) | **GET** /api/databases/{dbInstance}/slow-logs/config | | +|[**slowLogControllerGetSlowLogs**](#slowlogcontrollergetslowlogs) | **GET** /api/databases/{dbInstance}/slow-logs | | +|[**slowLogControllerResetSlowLogs**](#slowlogcontrollerresetslowlogs) | **DELETE** /api/databases/{dbInstance}/slow-logs | | +|[**slowLogControllerUpdateConfig**](#slowlogcontrollerupdateconfig) | **PATCH** /api/databases/{dbInstance}/slow-logs/config | | + +# **slowLogControllerGetConfig** +> SlowLogConfig slowLogControllerGetConfig() + +Get slowlog config + +### Example + +```typescript +import { + SlowLogsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SlowLogsApi(configuration); + +let dbInstance: string; // (default to undefined) + +const { status, data } = await apiInstance.slowLogControllerGetConfig( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +**SlowLogConfig** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **slowLogControllerGetSlowLogs** +> Array slowLogControllerGetSlowLogs() + +List of slow logs + +### Example + +```typescript +import { + SlowLogsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SlowLogsApi(configuration); + +let dbInstance: string; // (default to undefined) +let count: number; //Specifying the number of slow logs to fetch per node. (optional) (default to 50) + +const { status, data } = await apiInstance.slowLogControllerGetSlowLogs( + dbInstance, + count +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| +| **count** | [**number**] | Specifying the number of slow logs to fetch per node. | (optional) defaults to 50| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **slowLogControllerResetSlowLogs** +> slowLogControllerResetSlowLogs() + +Clear slow logs + +### Example + +```typescript +import { + SlowLogsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SlowLogsApi(configuration); + +let dbInstance: string; // (default to undefined) + +const { status, data } = await apiInstance.slowLogControllerResetSlowLogs( + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **slowLogControllerUpdateConfig** +> SlowLogConfig slowLogControllerUpdateConfig(updateSlowLogConfigDto) + +Update slowlog config + +### Example + +```typescript +import { + SlowLogsApi, + Configuration, + UpdateSlowLogConfigDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new SlowLogsApi(configuration); + +let dbInstance: string; // (default to undefined) +let updateSlowLogConfigDto: UpdateSlowLogConfigDto; // + +const { status, data } = await apiInstance.slowLogControllerUpdateConfig( + dbInstance, + updateSlowLogConfigDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateSlowLogConfigDto** | **UpdateSlowLogConfigDto**| | | +| **dbInstance** | [**string**] | | defaults to undefined| + + +### Return type + +**SlowLogConfig** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/SshOptions.md b/redisinsight/ui/src/api-client/docs/SshOptions.md new file mode 100644 index 0000000000..0d12556686 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SshOptions.md @@ -0,0 +1,30 @@ +# SshOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of SSH server | [default to 'localhost'] +**port** | **number** | The port of SSH server | [default to 22] +**username** | **string** | SSH username | [optional] [default to undefined] +**password** | **string** | The SSH password | [optional] [default to undefined] +**privateKey** | **string** | The SSH private key | [optional] [default to undefined] +**passphrase** | **string** | The SSH passphrase | [optional] [default to undefined] + +## Example + +```typescript +import { SshOptions } from './api'; + +const instance: SshOptions = { + host, + port, + username, + password, + privateKey, + passphrase, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SshOptionsResponse.md b/redisinsight/ui/src/api-client/docs/SshOptionsResponse.md new file mode 100644 index 0000000000..44fce27edb --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SshOptionsResponse.md @@ -0,0 +1,30 @@ +# SshOptionsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of SSH server | [default to 'localhost'] +**port** | **number** | The port of SSH server | [default to 22] +**username** | **string** | SSH username | [optional] [default to undefined] +**password** | **boolean** | The SSH password flag (true if password was set) | [optional] [default to undefined] +**passphrase** | **boolean** | The SSH passphrase flag (true if password was set) | [optional] [default to undefined] +**privateKey** | **boolean** | The SSH private key | [optional] [default to undefined] + +## Example + +```typescript +import { SshOptionsResponse } from './api'; + +const instance: SshOptionsResponse = { + host, + port, + username, + password, + passphrase, + privateKey, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/StreamEntryDto.md b/redisinsight/ui/src/api-client/docs/StreamEntryDto.md new file mode 100644 index 0000000000..ef9e21ffd2 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/StreamEntryDto.md @@ -0,0 +1,22 @@ +# StreamEntryDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Entry ID | [default to undefined] +**fields** | [**Array<StreamEntryFieldDto>**](StreamEntryFieldDto.md) | Entry fields | [default to undefined] + +## Example + +```typescript +import { StreamEntryDto } from './api'; + +const instance: StreamEntryDto = { + id, + fields, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/StreamEntryFieldDto.md b/redisinsight/ui/src/api-client/docs/StreamEntryFieldDto.md new file mode 100644 index 0000000000..aa45105667 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/StreamEntryFieldDto.md @@ -0,0 +1,22 @@ +# StreamEntryFieldDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**StreamEntryFieldDtoName**](StreamEntryFieldDtoName.md) | | [default to undefined] +**value** | [**StreamEntryFieldDtoValue**](StreamEntryFieldDtoValue.md) | | [default to undefined] + +## Example + +```typescript +import { StreamEntryFieldDto } from './api'; + +const instance: StreamEntryFieldDto = { + name, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/StreamEntryFieldDtoName.md b/redisinsight/ui/src/api-client/docs/StreamEntryFieldDtoName.md new file mode 100644 index 0000000000..af5ca2547f --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/StreamEntryFieldDtoName.md @@ -0,0 +1,23 @@ +# StreamEntryFieldDtoName + +Entry field name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { StreamEntryFieldDtoName } from './api'; + +const instance: StreamEntryFieldDtoName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/StreamEntryFieldDtoValue.md b/redisinsight/ui/src/api-client/docs/StreamEntryFieldDtoValue.md new file mode 100644 index 0000000000..54fc6bcc0b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/StreamEntryFieldDtoValue.md @@ -0,0 +1,23 @@ +# StreamEntryFieldDtoValue + +Entry value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { StreamEntryFieldDtoValue } from './api'; + +const instance: StreamEntryFieldDtoValue = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/SumGroup.md b/redisinsight/ui/src/api-client/docs/SumGroup.md new file mode 100644 index 0000000000..e15f876bee --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/SumGroup.md @@ -0,0 +1,24 @@ +# SumGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**label** | **string** | Group Label | [default to undefined] +**total** | **number** | Sum of data (e.g. memory, or number of keys) | [default to undefined] +**threshold** | **number** | Group threshold during analyzing (all values less then (<) threshold) | [default to undefined] + +## Example + +```typescript +import { SumGroup } from './api'; + +const instance: SumGroup = { + label, + total, + threshold, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/TAGSApi.md b/redisinsight/ui/src/api-client/docs/TAGSApi.md new file mode 100644 index 0000000000..5f37fa8805 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/TAGSApi.md @@ -0,0 +1,265 @@ +# TAGSApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**tagControllerCreate**](#tagcontrollercreate) | **POST** /api/tags | | +|[**tagControllerDelete**](#tagcontrollerdelete) | **DELETE** /api/tags/{id} | | +|[**tagControllerGet**](#tagcontrollerget) | **GET** /api/tags/{id} | | +|[**tagControllerList**](#tagcontrollerlist) | **GET** /api/tags | | +|[**tagControllerUpdate**](#tagcontrollerupdate) | **PATCH** /api/tags/{id} | | + +# **tagControllerCreate** +> Tag tagControllerCreate(createTagDto) + +Create tag + +### Example + +```typescript +import { + TAGSApi, + Configuration, + CreateTagDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TAGSApi(configuration); + +let createTagDto: CreateTagDto; // + +const { status, data } = await apiInstance.tagControllerCreate( + createTagDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createTagDto** | **CreateTagDto**| | | + + +### Return type + +**Tag** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tagControllerDelete** +> tagControllerDelete() + +Delete tag + +### Example + +```typescript +import { + TAGSApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TAGSApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.tagControllerDelete( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tagControllerGet** +> Tag tagControllerGet() + +Get tag by id + +### Example + +```typescript +import { + TAGSApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TAGSApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.tagControllerGet( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**Tag** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tagControllerList** +> Array tagControllerList() + +Get tags list + +### Example + +```typescript +import { + TAGSApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TAGSApi(configuration); + +const { status, data } = await apiInstance.tagControllerList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tagControllerUpdate** +> Tag tagControllerUpdate(updateTagDto) + +Update tag + +### Example + +```typescript +import { + TAGSApi, + Configuration, + UpdateTagDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TAGSApi(configuration); + +let id: string; // (default to undefined) +let updateTagDto: UpdateTagDto; // + +const { status, data } = await apiInstance.tagControllerUpdate( + id, + updateTagDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **updateTagDto** | **UpdateTagDto**| | | +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +**Tag** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/TLSCertificatesApi.md b/redisinsight/ui/src/api-client/docs/TLSCertificatesApi.md new file mode 100644 index 0000000000..093a3355c4 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/TLSCertificatesApi.md @@ -0,0 +1,201 @@ +# TLSCertificatesApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**caCertificateControllerDelete**](#cacertificatecontrollerdelete) | **DELETE** /api/certificates/ca/{id} | | +|[**caCertificateControllerList**](#cacertificatecontrollerlist) | **GET** /api/certificates/ca | | +|[**clientCertificateControllerDeleteClientCertificatePair**](#clientcertificatecontrollerdeleteclientcertificatepair) | **DELETE** /api/certificates/client/{id} | | +|[**clientCertificateControllerGetClientCertList**](#clientcertificatecontrollergetclientcertlist) | **GET** /api/certificates/client | | + +# **caCertificateControllerDelete** +> caCertificateControllerDelete() + +Delete Ca Certificate by id + +### Example + +```typescript +import { + TLSCertificatesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TLSCertificatesApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.caCertificateControllerDelete( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **caCertificateControllerList** +> Array caCertificateControllerList() + +Get Ca Certificate list + +### Example + +```typescript +import { + TLSCertificatesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TLSCertificatesApi(configuration); + +const { status, data } = await apiInstance.caCertificateControllerList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Ca Certificate list | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **clientCertificateControllerDeleteClientCertificatePair** +> clientCertificateControllerDeleteClientCertificatePair() + +Delete Client Certificate pair by id + +### Example + +```typescript +import { + TLSCertificatesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TLSCertificatesApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.clientCertificateControllerDeleteClientCertificatePair( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **clientCertificateControllerGetClientCertList** +> Array clientCertificateControllerGetClientCertList() + +Get Client Certificate list + +### Example + +```typescript +import { + TLSCertificatesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TLSCertificatesApi(configuration); + +const { status, data } = await apiInstance.clientCertificateControllerGetClientCertList(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Client Certificate list | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/Tag.md b/redisinsight/ui/src/api-client/docs/Tag.md new file mode 100644 index 0000000000..047c9956db --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/Tag.md @@ -0,0 +1,28 @@ +# Tag + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Tag id. | [default to undefined] +**key** | **string** | Key of the tag. | [default to undefined] +**value** | **string** | Value of the tag. | [default to undefined] +**createdAt** | **string** | Creation date of the tag. | [default to undefined] +**updatedAt** | **string** | Last update date of the tag. | [default to undefined] + +## Example + +```typescript +import { Tag } from './api'; + +const instance: Tag = { + id, + key, + value, + createdAt, + updatedAt, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/TutorialsApi.md b/redisinsight/ui/src/api-client/docs/TutorialsApi.md new file mode 100644 index 0000000000..58f62f3007 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/TutorialsApi.md @@ -0,0 +1,159 @@ +# TutorialsApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**customTutorialControllerCreate**](#customtutorialcontrollercreate) | **POST** /api/custom-tutorials | | +|[**customTutorialControllerDelete**](#customtutorialcontrollerdelete) | **DELETE** /api/custom-tutorials/{id} | | +|[**customTutorialControllerGetGlobalManifest**](#customtutorialcontrollergetglobalmanifest) | **GET** /api/custom-tutorials/manifest | | + +# **customTutorialControllerCreate** +> RootCustomTutorialManifest customTutorialControllerCreate() + +Create new tutorial + +### Example + +```typescript +import { + TutorialsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TutorialsApi(configuration); + +let file: File; //ZIP archive with tutorial static files (optional) (default to undefined) +let link: string; //External link to zip archive (optional) (default to undefined) + +const { status, data } = await apiInstance.customTutorialControllerCreate( + file, + link +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **file** | [**File**] | ZIP archive with tutorial static files | (optional) defaults to undefined| +| **link** | [**string**] | External link to zip archive | (optional) defaults to undefined| + + +### Return type + +**RootCustomTutorialManifest** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **customTutorialControllerDelete** +> customTutorialControllerDelete() + +Delete custom tutorial and its files + +### Example + +```typescript +import { + TutorialsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TutorialsApi(configuration); + +let id: string; // (default to undefined) + +const { status, data } = await apiInstance.customTutorialControllerDelete( + id +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **customTutorialControllerGetGlobalManifest** +> RootCustomTutorialManifest customTutorialControllerGetGlobalManifest() + +Get global manifest for custom tutorials + +### Example + +```typescript +import { + TutorialsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TutorialsApi(configuration); + +const { status, data } = await apiInstance.customTutorialControllerGetGlobalManifest(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**RootCustomTutorialManifest** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/UpdateConsumerGroupDto.md b/redisinsight/ui/src/api-client/docs/UpdateConsumerGroupDto.md new file mode 100644 index 0000000000..e57370b0ab --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateConsumerGroupDto.md @@ -0,0 +1,24 @@ +# UpdateConsumerGroupDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**name** | [**GetConsumersDtoGroupName**](GetConsumersDtoGroupName.md) | | [default to undefined] +**lastDeliveredId** | **string** | Id of last delivered message | [default to undefined] + +## Example + +```typescript +import { UpdateConsumerGroupDto } from './api'; + +const instance: UpdateConsumerGroupDto = { + keyName, + name, + lastDeliveredId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateDatabaseDto.md b/redisinsight/ui/src/api-client/docs/UpdateDatabaseDto.md new file mode 100644 index 0000000000..9bfbc8ade1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateDatabaseDto.md @@ -0,0 +1,62 @@ +# UpdateDatabaseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of your Redis database, for example redis.acme.com. If your Redis server is running on your local machine, you can enter either 127.0.0.1 or localhost. | [optional] [default to 'localhost'] +**port** | **number** | The port your Redis database is available on. | [optional] [default to 6379] +**name** | **string** | A name for your Redis database. | [optional] [default to undefined] +**db** | **number** | Logical database number. | [optional] [default to undefined] +**username** | **string** | Database username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password, if any, for your Redis database. If your database doesn’t require a password, leave this field empty. | [optional] [default to undefined] +**nameFromProvider** | **string** | The database name from provider | [optional] [default to undefined] +**provider** | **string** | The redis database hosting provider | [optional] [default to undefined] +**tls** | **boolean** | Use TLS to connect. | [optional] [default to undefined] +**tlsServername** | **string** | SNI servername | [optional] [default to undefined] +**verifyServerCert** | **boolean** | The certificate returned by the server needs to be verified. | [optional] [default to false] +**ssh** | **boolean** | Use SSH tunnel to connect. | [optional] [default to undefined] +**cloudDetails** | [**CloudDatabaseDetails**](CloudDatabaseDetails.md) | Cloud details | [optional] [default to undefined] +**compressor** | **string** | Database compressor | [optional] [default to CompressorEnum_None] +**keyNameFormat** | **string** | Key name format | [optional] [default to KeyNameFormatEnum_Unicode] +**forceStandalone** | **boolean** | Force client connection as standalone | [optional] [default to undefined] +**caCert** | [**CreateDatabaseDtoCaCert**](CreateDatabaseDtoCaCert.md) | | [optional] [default to undefined] +**clientCert** | [**CreateDatabaseDtoClientCert**](CreateDatabaseDtoClientCert.md) | | [optional] [default to undefined] +**tags** | [**Array<CreateTagDto>**](CreateTagDto.md) | Tags associated with the database. | [optional] [default to undefined] +**sshOptions** | [**UpdateSshOptionsDto**](UpdateSshOptionsDto.md) | Updated ssh options fields | [optional] [default to undefined] +**timeout** | **number** | Connection timeout | [optional] [default to undefined] +**sentinelMaster** | [**UpdateSentinelMasterDto**](UpdateSentinelMasterDto.md) | Updated sentinel master fields | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateDatabaseDto } from './api'; + +const instance: UpdateDatabaseDto = { + host, + port, + name, + db, + username, + password, + nameFromProvider, + provider, + tls, + tlsServername, + verifyServerCert, + ssh, + cloudDetails, + compressor, + keyNameFormat, + forceStandalone, + caCert, + clientCert, + tags, + sshOptions, + timeout, + sentinelMaster, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateHashFieldsTtlDto.md b/redisinsight/ui/src/api-client/docs/UpdateHashFieldsTtlDto.md new file mode 100644 index 0000000000..fed5966e63 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateHashFieldsTtlDto.md @@ -0,0 +1,22 @@ +# UpdateHashFieldsTtlDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**fields** | [**Array<HashFieldTtlDto>**](HashFieldTtlDto.md) | Hash fields | [default to undefined] + +## Example + +```typescript +import { UpdateHashFieldsTtlDto } from './api'; + +const instance: UpdateHashFieldsTtlDto = { + keyName, + fields, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateKeyTtlDto.md b/redisinsight/ui/src/api-client/docs/UpdateKeyTtlDto.md new file mode 100644 index 0000000000..1a7dbe676b --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateKeyTtlDto.md @@ -0,0 +1,22 @@ +# UpdateKeyTtlDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**ttl** | **number** | Set a timeout on key in seconds. After the timeout has expired, the key will automatically be deleted. If the property has value of -1, then the key timeout will be removed. | [default to undefined] + +## Example + +```typescript +import { UpdateKeyTtlDto } from './api'; + +const instance: UpdateKeyTtlDto = { + keyName, + ttl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateMemberInZSetDto.md b/redisinsight/ui/src/api-client/docs/UpdateMemberInZSetDto.md new file mode 100644 index 0000000000..090827443e --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateMemberInZSetDto.md @@ -0,0 +1,22 @@ +# UpdateMemberInZSetDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyName** | [**CreateListWithExpireDtoKeyName**](CreateListWithExpireDtoKeyName.md) | | [default to undefined] +**member** | [**ZSetMemberDto**](ZSetMemberDto.md) | ZSet member | [default to undefined] + +## Example + +```typescript +import { UpdateMemberInZSetDto } from './api'; + +const instance: UpdateMemberInZSetDto = { + keyName, + member, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateRdiDto.md b/redisinsight/ui/src/api-client/docs/UpdateRdiDto.md new file mode 100644 index 0000000000..3e494748a5 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateRdiDto.md @@ -0,0 +1,24 @@ +# UpdateRdiDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | A name to associate with RDI | [optional] [default to undefined] +**username** | **string** | RDI or API username | [optional] [default to undefined] +**password** | **string** | RDI or API password | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateRdiDto } from './api'; + +const instance: UpdateRdiDto = { + name, + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateSentinelMasterDto.md b/redisinsight/ui/src/api-client/docs/UpdateSentinelMasterDto.md new file mode 100644 index 0000000000..523a5701dc --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateSentinelMasterDto.md @@ -0,0 +1,22 @@ +# UpdateSentinelMasterDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **string** | Sentinel username, if your database is ACL enabled, otherwise leave this field empty. | [optional] [default to undefined] +**password** | **string** | The password for your Redis Sentinel master. If your master doesn’t require a password, leave this field empty. | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateSentinelMasterDto } from './api'; + +const instance: UpdateSentinelMasterDto = { + username, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateSettingsDto.md b/redisinsight/ui/src/api-client/docs/UpdateSettingsDto.md new file mode 100644 index 0000000000..238997ae1d --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateSettingsDto.md @@ -0,0 +1,32 @@ +# UpdateSettingsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**theme** | **string** | Application theme. | [optional] [default to undefined] +**dateFormat** | **string** | Application date format. | [optional] [default to undefined] +**timezone** | **string** | Application timezone. | [optional] [default to undefined] +**scanThreshold** | **number** | Threshold for scan operation. | [optional] [default to undefined] +**batchSize** | **number** | Batch for workbench pipeline. | [optional] [default to undefined] +**agreements** | **object** | Agreements | [optional] [default to undefined] +**analyticsReason** | **string** | Reason describing why analytics are enabled | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateSettingsDto } from './api'; + +const instance: UpdateSettingsDto = { + theme, + dateFormat, + timezone, + scanThreshold, + batchSize, + agreements, + analyticsReason, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateSlowLogConfigDto.md b/redisinsight/ui/src/api-client/docs/UpdateSlowLogConfigDto.md new file mode 100644 index 0000000000..3296470607 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateSlowLogConfigDto.md @@ -0,0 +1,22 @@ +# UpdateSlowLogConfigDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**slowlogMaxLen** | **number** | Max logs to store inside Redis slowlog | [optional] [default to undefined] +**slowlogLogSlowerThan** | **number** | Store logs with execution time greater than this value (in microseconds) | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateSlowLogConfigDto } from './api'; + +const instance: UpdateSlowLogConfigDto = { + slowlogMaxLen, + slowlogLogSlowerThan, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateSshOptionsDto.md b/redisinsight/ui/src/api-client/docs/UpdateSshOptionsDto.md new file mode 100644 index 0000000000..7f8d824ec0 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateSshOptionsDto.md @@ -0,0 +1,30 @@ +# UpdateSshOptionsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **string** | The hostname of SSH server | [optional] [default to 'localhost'] +**port** | **number** | The port of SSH server | [optional] [default to 22] +**username** | **string** | SSH username | [optional] [default to undefined] +**password** | **string** | The SSH password | [optional] [default to undefined] +**privateKey** | **string** | The SSH private key | [optional] [default to undefined] +**passphrase** | **string** | The SSH passphrase | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateSshOptionsDto } from './api'; + +const instance: UpdateSshOptionsDto = { + host, + port, + username, + password, + privateKey, + passphrase, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UpdateTagDto.md b/redisinsight/ui/src/api-client/docs/UpdateTagDto.md new file mode 100644 index 0000000000..470334b587 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UpdateTagDto.md @@ -0,0 +1,22 @@ +# UpdateTagDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | Key of the tag. | [optional] [default to undefined] +**value** | **string** | Value of the tag. | [optional] [default to undefined] + +## Example + +```typescript +import { UpdateTagDto } from './api'; + +const instance: UpdateTagDto = { + key, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UploadImportFileByPathDto.md b/redisinsight/ui/src/api-client/docs/UploadImportFileByPathDto.md new file mode 100644 index 0000000000..9b6644fb8c --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UploadImportFileByPathDto.md @@ -0,0 +1,20 @@ +# UploadImportFileByPathDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **string** | Internal path to data file | [default to undefined] + +## Example + +```typescript +import { UploadImportFileByPathDto } from './api'; + +const instance: UploadImportFileByPathDto = { + path, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UseCaCertificateDto.md b/redisinsight/ui/src/api-client/docs/UseCaCertificateDto.md new file mode 100644 index 0000000000..73f3fff347 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UseCaCertificateDto.md @@ -0,0 +1,20 @@ +# UseCaCertificateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Certificate id | [default to undefined] + +## Example + +```typescript +import { UseCaCertificateDto } from './api'; + +const instance: UseCaCertificateDto = { + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/UseClientCertificateDto.md b/redisinsight/ui/src/api-client/docs/UseClientCertificateDto.md new file mode 100644 index 0000000000..82555148a1 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/UseClientCertificateDto.md @@ -0,0 +1,20 @@ +# UseClientCertificateDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Certificate id | [default to undefined] + +## Example + +```typescript +import { UseClientCertificateDto } from './api'; + +const instance: UseClientCertificateDto = { + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/WorkbenchApi.md b/redisinsight/ui/src/api-client/docs/WorkbenchApi.md new file mode 100644 index 0000000000..3de9825530 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/WorkbenchApi.md @@ -0,0 +1,284 @@ +# WorkbenchApi + +All URIs are relative to *http://localhost* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**workbenchControllerDeleteCommandExecution**](#workbenchcontrollerdeletecommandexecution) | **DELETE** /api/databases/{dbInstance}/workbench/command-executions/{id} | | +|[**workbenchControllerDeleteCommandExecutions**](#workbenchcontrollerdeletecommandexecutions) | **DELETE** /api/databases/{dbInstance}/workbench/command-executions | | +|[**workbenchControllerGetCommandExecution**](#workbenchcontrollergetcommandexecution) | **GET** /api/databases/{dbInstance}/workbench/command-executions/{id} | | +|[**workbenchControllerListCommandExecutions**](#workbenchcontrollerlistcommandexecutions) | **GET** /api/databases/{dbInstance}/workbench/command-executions | | +|[**workbenchControllerSendCommands**](#workbenchcontrollersendcommands) | **POST** /api/databases/{dbInstance}/workbench/command-executions | | + +# **workbenchControllerDeleteCommandExecution** +> workbenchControllerDeleteCommandExecution() + +Delete command execution + +### Example + +```typescript +import { + WorkbenchApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WorkbenchApi(configuration); + +let id: string; // (default to undefined) +let dbInstance: string; //Database instance id. (default to undefined) + +const { status, data } = await apiInstance.workbenchControllerDeleteCommandExecution( + id, + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **workbenchControllerDeleteCommandExecutions** +> workbenchControllerDeleteCommandExecutions(commandExecutionFilter) + +Delete command executions + +### Example + +```typescript +import { + WorkbenchApi, + Configuration, + CommandExecutionFilter +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WorkbenchApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let commandExecutionFilter: CommandExecutionFilter; // + +const { status, data } = await apiInstance.workbenchControllerDeleteCommandExecutions( + dbInstance, + commandExecutionFilter +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **commandExecutionFilter** | **CommandExecutionFilter**| | | +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **workbenchControllerGetCommandExecution** +> CommandExecution workbenchControllerGetCommandExecution() + +Get command execution details + +### Example + +```typescript +import { + WorkbenchApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WorkbenchApi(configuration); + +let id: string; // (default to undefined) +let dbInstance: string; //Database instance id. (default to undefined) + +const { status, data } = await apiInstance.workbenchControllerGetCommandExecution( + id, + dbInstance +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **id** | [**string**] | | defaults to undefined| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +**CommandExecution** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **workbenchControllerListCommandExecutions** +> Array workbenchControllerListCommandExecutions() + +List of command executions + +### Example + +```typescript +import { + WorkbenchApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WorkbenchApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let type: 'WORKBENCH' | 'SEARCH'; //Command execution type. Used to distinguish between search and workbench (optional) (default to 'WORKBENCH') + +const { status, data } = await apiInstance.workbenchControllerListCommandExecutions( + dbInstance, + type +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| +| **type** | [**'WORKBENCH' | 'SEARCH'**]**Array<'WORKBENCH' | 'SEARCH'>** | Command execution type. Used to distinguish between search and workbench | (optional) defaults to 'WORKBENCH'| + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **workbenchControllerSendCommands** +> CommandExecution workbenchControllerSendCommands(createCommandExecutionsDto) + +Send Redis Batch Commands from the Workbench + +### Example + +```typescript +import { + WorkbenchApi, + Configuration, + CreateCommandExecutionsDto +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WorkbenchApi(configuration); + +let dbInstance: string; //Database instance id. (default to undefined) +let createCommandExecutionsDto: CreateCommandExecutionsDto; // + +const { status, data } = await apiInstance.workbenchControllerSendCommands( + dbInstance, + createCommandExecutionsDto +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createCommandExecutionsDto** | **CreateCommandExecutionsDto**| | | +| **dbInstance** | [**string**] | Database instance id. | defaults to undefined| + + +### Return type + +**CommandExecution** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/redisinsight/ui/src/api-client/docs/ZSetMemberDto.md b/redisinsight/ui/src/api-client/docs/ZSetMemberDto.md new file mode 100644 index 0000000000..dcf39af611 --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ZSetMemberDto.md @@ -0,0 +1,22 @@ +# ZSetMemberDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**ZSetMemberDtoName**](ZSetMemberDtoName.md) | | [default to undefined] +**score** | **number** | Member score value. | [default to 1] + +## Example + +```typescript +import { ZSetMemberDto } from './api'; + +const instance: ZSetMemberDto = { + name, + score, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/docs/ZSetMemberDtoName.md b/redisinsight/ui/src/api-client/docs/ZSetMemberDtoName.md new file mode 100644 index 0000000000..4f40bba1bb --- /dev/null +++ b/redisinsight/ui/src/api-client/docs/ZSetMemberDtoName.md @@ -0,0 +1,23 @@ +# ZSetMemberDtoName + +Member name value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [default to undefined] +**data** | **Array<number>** | | [default to undefined] + +## Example + +```typescript +import { ZSetMemberDtoName } from './api'; + +const instance: ZSetMemberDtoName = { + type, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/redisinsight/ui/src/api-client/git_push.sh b/redisinsight/ui/src/api-client/git_push.sh new file mode 100644 index 0000000000..f53a75d4fa --- /dev/null +++ b/redisinsight/ui/src/api-client/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/redisinsight/ui/src/api-client/index.ts b/redisinsight/ui/src/api-client/index.ts new file mode 100644 index 0000000000..22ac98cee4 --- /dev/null +++ b/redisinsight/ui/src/api-client/index.ts @@ -0,0 +1,18 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * Redis Insight Backend API + * Redis Insight Backend API + * + * The version of the OpenAPI document: 2.70.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +export * from "./api"; +export * from "./configuration"; + diff --git a/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.spec.tsx b/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.spec.tsx index c151439e04..91479bb90f 100644 --- a/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.spec.tsx +++ b/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.spec.tsx @@ -5,7 +5,7 @@ import { DATABASE_LIST_MODULES_TEXT, } from 'uiSrc/slices/interfaces' import { fireEvent, render, act } from 'uiSrc/utils/test-utils' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import DatabaseListModules, { Props } from './DatabaseListModules' const mockedProps = mock() diff --git a/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.tsx b/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.tsx index 139a98cc37..b74ea96f75 100644 --- a/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.tsx +++ b/redisinsight/ui/src/components/database-list-modules/DatabaseListModules.tsx @@ -12,7 +12,7 @@ import { IconButton } from 'uiSrc/components/base/forms/buttons' import { ColorText } from 'uiSrc/components/base/text' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { RiTooltip } from 'uiSrc/components' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import styles from './styles.module.scss' @@ -46,7 +46,8 @@ const DatabaseListModules = React.memo((props: Props) => { const newModules: IDatabaseModule[] = sortModules( modules?.map(({ name: propName, semanticVersion = '', version = '' }) => { - const module: ModuleInfo = DEFAULT_MODULES_INFO[propName] + const module: ModuleInfo = + DEFAULT_MODULES_INFO[propName as keyof typeof DEFAULT_MODULES_INFO] const moduleName = module?.text || propName const { abbreviation = '', name = moduleName } = getModule(moduleName) diff --git a/redisinsight/ui/src/components/formated-date/FormatedDate.tsx b/redisinsight/ui/src/components/formated-date/FormatedDate.tsx index e3ea44496e..b9c3900e44 100644 --- a/redisinsight/ui/src/components/formated-date/FormatedDate.tsx +++ b/redisinsight/ui/src/components/formated-date/FormatedDate.tsx @@ -7,7 +7,7 @@ import { RiTooltip } from 'uiSrc/components' import styles from './styles.module.scss' export interface Props { - date: Date | string | number + date?: Date | string | number } const FormatedDate = ({ date }: Props) => { @@ -17,6 +17,7 @@ const FormatedDate = ({ date }: Props) => { if (!date) return null + // @ts-ignore const formatedDate = formatTimestamp(date, dateFormat, timezone) return ( diff --git a/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.spec.tsx b/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.spec.tsx index 7c3c53bc7c..242b2d0495 100644 --- a/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.spec.tsx +++ b/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.spec.tsx @@ -2,7 +2,7 @@ import { cloneDeep, set } from 'lodash' import React from 'react' import MockedSocket from 'socket.io-mock' -import socketIO from 'socket.io-client' +import socketIOClient from 'socket.io-client' import { NotificationEvent } from 'uiSrc/constants/notifications' import { setLastReceivedNotification, @@ -23,15 +23,16 @@ import { RecommendationsSocketEvents } from 'uiSrc/constants/recommendations' import { addUnreadRecommendations } from 'uiSrc/slices/recommendations/recommendations' import { GlobalSubscriptions } from 'uiSrc/components' -import { NotificationsDto } from 'apiSrc/modules/notification/dto' +import { NotificationsDto } from 'uiSrc/api-client' import CommonAppSubscription from './CommonAppSubscription' +const socketIO = jest.mocked(socketIOClient) let store: typeof mockedStore -let socket: typeof MockedSocket +let socket: MockedSocket beforeEach(() => { cleanup() socket = new MockedSocket() - socketIO.mockReturnValue(socket) + socketIO.mockReturnValue(socket as any) store = cloneDeep(mockedStore) store.clearActions() }) diff --git a/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.tsx b/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.tsx index a27fcfab18..08491f9d52 100644 --- a/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.tsx +++ b/redisinsight/ui/src/components/global-subscriptions/CommonAppSubscription/CommonAppSubscription.tsx @@ -19,7 +19,7 @@ import { oauthCloudJobSelector, setJob } from 'uiSrc/slices/oauth/cloud' import { CloudJobName } from 'uiSrc/electron/constants' import { appCsrfSelector } from 'uiSrc/slices/app/csrf' import { useIoConnection } from 'uiSrc/services/hooks/useIoConnection' -import { CloudJobInfo } from 'apiSrc/modules/cloud/job/models' +import { CloudJobInfo } from 'uiSrc/api-client' const CommonAppSubscription = () => { const { id: jobId = '' } = useSelector(oauthCloudJobSelector) ?? {} diff --git a/redisinsight/ui/src/components/instance-header/components/ShortInstanceInfo.tsx b/redisinsight/ui/src/components/instance-header/components/ShortInstanceInfo.tsx index f60c7d28f7..85908f4a4e 100644 --- a/redisinsight/ui/src/components/instance-header/components/ShortInstanceInfo.tsx +++ b/redisinsight/ui/src/components/instance-header/components/ShortInstanceInfo.tsx @@ -14,8 +14,8 @@ import { Theme } from 'uiSrc/constants' import { ThemeContext } from 'uiSrc/contexts/themeContext' import { FlexItem, Row } from 'uiSrc/components/base/layout/flex' import { Text } from 'uiSrc/components/base/text' +import { AdditionalRedisModule } from 'uiSrc/api-client' import { AllIconsType, RiIcon } from 'uiSrc/components/base/icons/RiIcon' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' import styles from './styles.module.scss' export interface Props { @@ -37,7 +37,7 @@ const ShortInstanceInfo = ({ info, databases, modules }: Props) => { const getIcon = (name: string) => { const icon: AllIconsType = - DEFAULT_MODULES_INFO[name]?.[ + DEFAULT_MODULES_INFO[name as keyof typeof DEFAULT_MODULES_INFO]?.[ theme === Theme.Dark ? 'iconDark' : 'iconLight' ] if (icon) { @@ -106,7 +106,9 @@ const ShortInstanceInfo = ({ info, databases, modules }: Props) => { {truncateText( getModule(name)?.name || - DATABASE_LIST_MODULES_TEXT[name] || + DATABASE_LIST_MODULES_TEXT[ + name as keyof typeof DATABASE_LIST_MODULES_TEXT + ] || name, 50, )} diff --git a/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfile.spec.tsx b/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfile.spec.tsx index fdadef4db5..1e23e27108 100644 --- a/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfile.spec.tsx +++ b/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfile.spec.tsx @@ -1,6 +1,6 @@ import { cloneDeep, set } from 'lodash' import React from 'react' -import { CloudUser } from 'src/modules/cloud/user/models' +import { CloudUser } from 'uiSrc/api-client' import { FeatureFlags } from 'uiSrc/constants' import { cleanup, diff --git a/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.spec.tsx b/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.spec.tsx index 8756f17708..8236bcd17c 100644 --- a/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.spec.tsx +++ b/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.spec.tsx @@ -1,5 +1,5 @@ import React from 'react' -import { CloudUser } from 'src/modules/cloud/user/models' +import { CloudUser } from 'uiSrc/api-client' import { act, fireEvent, @@ -19,10 +19,14 @@ const mockUser: CloudUser = { { id: 45, name: 'Account 1', + capiKey: 'key', + capiSecret: 'secret', }, { id: 46, name: 'Account 2', + capiKey: 'key', + capiSecret: 'secret', }, ], data: {}, diff --git a/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.tsx b/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.tsx index 535f32c380..1abc76cbf5 100644 --- a/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.tsx +++ b/redisinsight/ui/src/components/instance-header/components/user-profile/UserProfileBadge.tsx @@ -23,7 +23,7 @@ import { Text } from 'uiSrc/components/base/text' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { UserProfileLink } from 'uiSrc/components/base/link/UserProfileLink' import { Loader } from 'uiSrc/components/base/display' -import { CloudUser } from 'apiSrc/modules/cloud/user/models' +import { CloudUser } from 'uiSrc/api-client' import styles from './styles.module.scss' export interface UserProfileBadgeProps { diff --git a/redisinsight/ui/src/components/markdown/CodeButtonBlock/CodeButtonBlock.tsx b/redisinsight/ui/src/components/markdown/CodeButtonBlock/CodeButtonBlock.tsx index e07bffa040..dccae91f63 100644 --- a/redisinsight/ui/src/components/markdown/CodeButtonBlock/CodeButtonBlock.tsx +++ b/redisinsight/ui/src/components/markdown/CodeButtonBlock/CodeButtonBlock.tsx @@ -30,7 +30,7 @@ import { Spacer } from 'uiSrc/components/base/layout/spacer' import { EmptyButton } from 'uiSrc/components/base/forms/buttons' import { PlayIcon, CheckBoldIcon, CopyIcon } from 'uiSrc/components/base/icons' import { Title } from 'uiSrc/components/base/text/Title' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import { RunConfirmationPopover } from './components' import styles from './styles.module.scss' diff --git a/redisinsight/ui/src/components/monitor-config/MonitorConfig.tsx b/redisinsight/ui/src/components/monitor-config/MonitorConfig.tsx index e4cbd54b92..dce783a711 100644 --- a/redisinsight/ui/src/components/monitor-config/MonitorConfig.tsx +++ b/redisinsight/ui/src/components/monitor-config/MonitorConfig.tsx @@ -24,11 +24,10 @@ import { SocketErrors, SocketEvent, } from 'uiSrc/constants' -import { IMonitorDataPayload } from 'uiSrc/slices/interfaces' +import { IMonitorDataPayload, IMonitorData } from 'uiSrc/slices/interfaces' import { connectedInstanceSelector } from 'uiSrc/slices/instances/instances' import { appCsrfSelector } from 'uiSrc/slices/app/csrf' import { useIoConnection } from 'uiSrc/services/hooks/useIoConnection' -import { IMonitorData } from 'apiSrc/modules/profiler/interfaces/monitor-data.interface' import ApiStatusCode from '../../constants/apiStatusCode' @@ -71,7 +70,7 @@ const MonitorConfig = ({ retryDelay = 15000 }: IProps) => { ) const getErrorMessage = (error: { - type: string + type?: string name: any message: any }): string => { diff --git a/redisinsight/ui/src/components/oauth/oauth-select-plan/OAuthSelectPlan.tsx b/redisinsight/ui/src/components/oauth/oauth-select-plan/OAuthSelectPlan.tsx index 75375c8ed8..6d8217ff3b 100644 --- a/redisinsight/ui/src/components/oauth/oauth-select-plan/OAuthSelectPlan.tsx +++ b/redisinsight/ui/src/components/oauth/oauth-select-plan/OAuthSelectPlan.tsx @@ -27,7 +27,7 @@ import { Title } from 'uiSrc/components/base/text/Title' import { ColorText, Text } from 'uiSrc/components/base/text' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { RiSelect } from 'uiSrc/components/base/forms/select/RiSelect' -import { CloudSubscriptionPlanResponse } from 'apiSrc/modules/cloud/subscription/dto' +import { CloudSubscriptionPlanResponse } from 'uiSrc/api-client' import { OAuthProvider, OAuthProviders } from './constants' import styles from './styles.module.scss' diff --git a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/chat-history/ChatHistory.tsx b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/chat-history/ChatHistory.tsx index bb6bd2a852..2896712a9b 100644 --- a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/chat-history/ChatHistory.tsx +++ b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/chat-history/ChatHistory.tsx @@ -15,7 +15,7 @@ import { import { Nullable, scrollIntoView } from 'uiSrc/utils' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { Loader } from 'uiSrc/components/base/display' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import LoadingMessage from '../loading-message' import MarkdownMessage from '../markdown-message' diff --git a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/MarkdownMessage.tsx b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/MarkdownMessage.tsx index 5da6017d6e..e423b10145 100644 --- a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/MarkdownMessage.tsx +++ b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/MarkdownMessage.tsx @@ -2,7 +2,7 @@ import React, { useCallback, useEffect, useState } from 'react' import JsxParser from 'react-jsx-parser' import MarkdownToJsxString from 'uiSrc/services/formatter/MarkdownToJsxString' import { CloudLink } from 'uiSrc/components/markdown' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import { ChatExternalLink, CodeBlock } from './components' export interface CodeProps { diff --git a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/components/code-block/CodeBlock.tsx b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/components/code-block/CodeBlock.tsx index 2d308bfc40..dfcfc5ab40 100644 --- a/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/components/code-block/CodeBlock.tsx +++ b/redisinsight/ui/src/components/side-panels/panels/ai-assistant/components/shared/markdown-message/components/code-block/CodeBlock.tsx @@ -4,7 +4,7 @@ import { CodeButtonParams } from 'uiSrc/constants' import { sendWbQueryAction } from 'uiSrc/slices/workbench/wb-results' import { CodeButtonBlock } from 'uiSrc/components/markdown' import { ButtonLang } from 'uiSrc/utils/formatters/markdown/remarkCode' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' export interface Props { modules?: AdditionalRedisModule[] diff --git a/redisinsight/ui/src/components/virtual-table/interfaces.ts b/redisinsight/ui/src/components/virtual-table/interfaces.ts index 5d853bc4e2..aa13502352 100644 --- a/redisinsight/ui/src/components/virtual-table/interfaces.ts +++ b/redisinsight/ui/src/components/virtual-table/interfaces.ts @@ -27,7 +27,7 @@ export interface IResizeEvent { height: number } -export interface ITableColumn { +export interface ITableColumn { id: string label: string | ReactNode minWidth?: number @@ -45,8 +45,8 @@ export interface ITableColumn { alignment?: TableCellAlignment textAlignment?: TableCellTextAlignment render?: ( - cellData?: any, - columnItem?: any, + cellData: any, + columnItem: T, expanded?: boolean, rowIndex?: number, ) => any diff --git a/redisinsight/ui/src/constants/keys.ts b/redisinsight/ui/src/constants/keys.ts index 552c7cd78d..2d74a3a530 100644 --- a/redisinsight/ui/src/constants/keys.ts +++ b/redisinsight/ui/src/constants/keys.ts @@ -1,5 +1,6 @@ import { StreamViewType } from 'uiSrc/slices/interfaces/stream' import { ApiEndpoints } from 'uiSrc/constants' +import { DatabaseCompressorEnum } from 'uiSrc/api-client' import { CommandGroup } from './commands' export enum KeyTypes { @@ -154,26 +155,20 @@ export enum KeyValueFormat { export const DATETIME_FORMATTER_DEFAULT = 'HH:mm:ss d MMM yyyy' -export enum KeyValueCompressor { - GZIP = 'GZIP', - ZSTD = 'ZSTD', - LZ4 = 'LZ4', - SNAPPY = 'SNAPPY', - Brotli = 'Brotli', - PHPGZCompress = 'PHPGZCompress', -} +export const KeyValueCompressor = DatabaseCompressorEnum export const COMPRESSOR_MAGIC_SYMBOLS: ICompressorMagicSymbols = Object.freeze({ - [KeyValueCompressor.GZIP]: '31,139', // 1f 8b hex - [KeyValueCompressor.ZSTD]: '40,181,47,253', // 28 b5 2f fd hex - [KeyValueCompressor.LZ4]: '4,34,77,24', // 04 22 4d 18 hex - [KeyValueCompressor.SNAPPY]: '', // no magic symbols + [KeyValueCompressor.None]: '', + [KeyValueCompressor.Gzip]: '31,139', // 1f 8b hex + [KeyValueCompressor.Zstd]: '40,181,47,253', // 28 b5 2f fd hex + [KeyValueCompressor.Lz4]: '4,34,77,24', // 04 22 4d 18 hex + [KeyValueCompressor.Snappy]: '', // no magic symbols [KeyValueCompressor.Brotli]: '', // no magic symbols - [KeyValueCompressor.PHPGZCompress]: '', // no magic symbols + [KeyValueCompressor.PhpgzCompress]: '', // no magic symbols }) export type ICompressorMagicSymbols = { - [key in KeyValueCompressor]: string + [key in (typeof DatabaseCompressorEnum)[keyof typeof DatabaseCompressorEnum]]: string } export const ENDPOINT_BASED_ON_KEY_TYPE = Object.freeze({ @@ -194,18 +189,18 @@ export enum SearchHistoryMode { } export enum KeyboardKeys { - ENTER = "Enter", - SPACE = " ", - ESCAPE = "Escape", - TAB = "Tab", - BACKSPACE = "Backspace", - F2 = "F2", - ARROW_DOWN = "ArrowDown", - ARROW_UP = "ArrowUp", - ARROW_LEFT = "ArrowLeft", - ARROW_RIGHT = "ArrowRight", - PAGE_UP = "PageUp", - PAGE_DOWN = "PageDown", - END = "End", - HOME = "Home" + ENTER = 'Enter', + SPACE = ' ', + ESCAPE = 'Escape', + TAB = 'Tab', + BACKSPACE = 'Backspace', + F2 = 'F2', + ARROW_DOWN = 'ArrowDown', + ARROW_UP = 'ArrowUp', + ARROW_LEFT = 'ArrowLeft', + ARROW_RIGHT = 'ArrowRight', + PAGE_UP = 'PageUp', + PAGE_DOWN = 'PageDown', + END = 'End', + HOME = 'Home', } diff --git a/redisinsight/ui/src/constants/prop-types/keys.ts b/redisinsight/ui/src/constants/prop-types/keys.ts index 6d14b2015b..f434706121 100644 --- a/redisinsight/ui/src/constants/prop-types/keys.ts +++ b/redisinsight/ui/src/constants/prop-types/keys.ts @@ -1,7 +1,8 @@ import { RedisResponseBuffer } from 'uiSrc/slices/interfaces' +import { GetKeyInfoResponse } from 'uiSrc/api-client' import { KeyTypes, ModulesKeyTypes } from '../keys' -export interface IKeyPropTypes { +export interface IKeyPropTypes extends GetKeyInfoResponse { nameString: string name: RedisResponseBuffer type: KeyTypes | ModulesKeyTypes diff --git a/redisinsight/ui/src/electron/utils/ipcCheckUpdates.ts b/redisinsight/ui/src/electron/utils/ipcCheckUpdates.ts index a6e795854f..710b7941ea 100644 --- a/redisinsight/ui/src/electron/utils/ipcCheckUpdates.ts +++ b/redisinsight/ui/src/electron/utils/ipcCheckUpdates.ts @@ -5,7 +5,7 @@ import { ReleaseNotesSource } from 'uiSrc/constants/telemetry' import { setElectronInfo, setReleaseNotesViewed } from 'uiSrc/slices/app/info' import { addMessageNotification } from 'uiSrc/slices/app/notifications' import successMessages from 'uiSrc/components/notifications/success-messages' -import { GetServerInfoResponse } from 'apiSrc/modules/server/dto/server.dto' +import { GetServerInfoResponse } from 'uiSrc/api-client' import { ElectronStorageItem, IpcInvokeEvent } from '../constants' export const ipcCheckUpdates = async ( diff --git a/redisinsight/ui/src/mocks/handlers/analytics/clusterDetailsHandlers.ts b/redisinsight/ui/src/mocks/handlers/analytics/clusterDetailsHandlers.ts index b4c71937cb..8d9414dfe5 100644 --- a/redisinsight/ui/src/mocks/handlers/analytics/clusterDetailsHandlers.ts +++ b/redisinsight/ui/src/mocks/handlers/analytics/clusterDetailsHandlers.ts @@ -4,10 +4,10 @@ import { getUrl } from 'uiSrc/utils' import { getMswURL } from 'uiSrc/utils/test-utils' import { ClusterDetails, - HealthStatus, - NodeRole, -} from 'apiSrc/modules/cluster-monitor/models' -import { Database as DatabaseInstanceResponse } from 'apiSrc/modules/database/models/database' + Database as DatabaseInstanceResponse, + ClusterNodeDetailsHealthEnum, + ClusterNodeDetailsRoleEnum, +} from 'uiSrc/api-client' export const INSTANCE_ID_MOCK = 'instanceId' @@ -39,9 +39,9 @@ export const CLUSTER_DETAILS_DATA_MOCK: ClusterDetails = { id: '3', host: '3.93.234.244', port: 12511, - role: 'primary' as NodeRole, + role: ClusterNodeDetailsRoleEnum.Primary, slots: ['10923-16383'], - health: 'online' as HealthStatus, + health: ClusterNodeDetailsHealthEnum.Online, totalKeys: 0, usedMemory: 38448896, opsPerSecond: 0, @@ -61,9 +61,9 @@ export const CLUSTER_DETAILS_DATA_MOCK: ClusterDetails = { id: '4', host: '44.202.117.57', port: 12511, - role: 'primary' as NodeRole, + role: ClusterNodeDetailsRoleEnum.Primary, slots: ['0-5460'], - health: 'online' as HealthStatus, + health:ClusterNodeDetailsHealthEnum.Online, totalKeys: 0, usedMemory: 38448896, opsPerSecond: 0, @@ -83,9 +83,9 @@ export const CLUSTER_DETAILS_DATA_MOCK: ClusterDetails = { id: '5', host: '44.210.115.34', port: 12511, - role: 'primary' as NodeRole, + role: ClusterNodeDetailsRoleEnum.Primary, slots: ['5461-10922'], - health: 'online' as HealthStatus, + health: ClusterNodeDetailsHealthEnum.Online, totalKeys: 0, usedMemory: 38448896, opsPerSecond: 0, diff --git a/redisinsight/ui/src/mocks/handlers/app/infoHandlers.ts b/redisinsight/ui/src/mocks/handlers/app/infoHandlers.ts index cdea01f50f..7226ef634c 100644 --- a/redisinsight/ui/src/mocks/handlers/app/infoHandlers.ts +++ b/redisinsight/ui/src/mocks/handlers/app/infoHandlers.ts @@ -1,7 +1,7 @@ import { rest, RestHandler } from 'msw' import { ApiEndpoints } from 'uiSrc/constants' import { getMswURL } from 'uiSrc/utils/test-utils' -import { Database as DatabaseInstanceResponse } from 'apiSrc/modules/database/models/database' +import { Database as DatabaseInstanceResponse } from 'uiSrc/api-client' export const APP_INFO_DATA_MOCK = { id: 'id1', diff --git a/redisinsight/ui/src/mocks/handlers/browser/redisearchHandlers.ts b/redisinsight/ui/src/mocks/handlers/browser/redisearchHandlers.ts index 775410ea48..2fb794166d 100644 --- a/redisinsight/ui/src/mocks/handlers/browser/redisearchHandlers.ts +++ b/redisinsight/ui/src/mocks/handlers/browser/redisearchHandlers.ts @@ -2,7 +2,7 @@ import { rest, RestHandler } from 'msw' import { ApiEndpoints } from 'uiSrc/constants' import { getMswURL } from 'uiSrc/utils/test-utils' import { getUrl, stringToBuffer } from 'uiSrc/utils' -import { ListRedisearchIndexesResponse } from 'apiSrc/modules/browser/redisearch/dto' +import { ListRedisearchIndexesResponse } from 'uiSrc/api-client' import { INSTANCE_ID_MOCK } from '../instances/instancesHandlers' export const REDISEARCH_LIST_DATA_MOCK_UTF8 = ['idx: 1', 'idx:2'] diff --git a/redisinsight/ui/src/mocks/handlers/instances/instancesHandlers.ts b/redisinsight/ui/src/mocks/handlers/instances/instancesHandlers.ts index 4c2bb18dc4..dc3e4c247a 100644 --- a/redisinsight/ui/src/mocks/handlers/instances/instancesHandlers.ts +++ b/redisinsight/ui/src/mocks/handlers/instances/instancesHandlers.ts @@ -1,40 +1,43 @@ import { rest, RestHandler } from 'msw' -import { RedisNodeInfoResponse } from 'src/modules/database/dto/redis-info.dto' import { ApiEndpoints } from 'uiSrc/constants' import { ConnectionType, Instance } from 'uiSrc/slices/interfaces' import { getMswURL } from 'uiSrc/utils/test-utils' import { getUrl } from 'uiSrc/utils' import { MOCK_INFO_API_RESPONSE } from 'uiSrc/mocks/data/instances' -import { Database as DatabaseInstanceResponse } from 'apiSrc/modules/database/models/database' -import { ExportDatabase } from 'apiSrc/modules/database/models/export-database' +import { + RedisNodeInfoResponse, + Database as DatabaseInstanceResponse, + ExportDatabase, +} from 'uiSrc/api-client' export const INSTANCE_ID_MOCK = 'instanceId' export const INSTANCES_MOCK: Instance[] = [ { id: INSTANCE_ID_MOCK, - version: '6.2.6', + // version: '6.2.6', host: 'localhost', port: 6379, name: 'localhost', - username: null, - password: null, + username: undefined, + password: undefined, connectionType: ConnectionType.Standalone, - nameFromProvider: null, + nameFromProvider: undefined, modules: [], db: 123, - lastConnection: new Date('2021-04-22T09:03:56.917Z'), - version: null, + lastConnection: new Date('2021-04-22T09:03:56.917Z').toString(), + version: undefined, }, { id: 'a0db1bc8-a353-4c43-a856-b72f4811d2d4', host: 'localhost', port: 12000, name: 'oea123123', - username: null, - password: null, + username: undefined, + password: undefined, connectionType: ConnectionType.Standalone, - nameFromProvider: null, + nameFromProvider: undefined, modules: [], + // @ts-expect-error TODO: check this type inconsistency tls: { verifyServerCert: true, caCertId: '70b95d32-c19d-4311-bb24-e684af12cf15', @@ -43,17 +46,17 @@ export const INSTANCES_MOCK: Instance[] = [ }, { id: 'b83a3932-e95f-4f09-9d8a-55079f400186', - version: '6.2.6', + // version: '6.2.6', host: 'localhost', port: 5005, name: 'sentinel', - username: null, - password: null, + username: undefined, + password: undefined, connectionType: ConnectionType.Sentinel, - nameFromProvider: null, - lastConnection: new Date('2021-04-22T18:40:44.031Z'), + nameFromProvider: undefined, + lastConnection: new Date('2021-04-22T18:40:44.031Z').toString(), modules: [], - version: null, + version: undefined, endpoints: [ { host: 'localhost', diff --git a/redisinsight/ui/src/mocks/handlers/rdi/rdiHandler.ts b/redisinsight/ui/src/mocks/handlers/rdi/rdiHandler.ts index 7be4f7c50e..be2b8ba61b 100644 --- a/redisinsight/ui/src/mocks/handlers/rdi/rdiHandler.ts +++ b/redisinsight/ui/src/mocks/handlers/rdi/rdiHandler.ts @@ -2,7 +2,7 @@ import { rest, RestHandler } from 'msw' import { getMswURL } from 'uiSrc/utils/test-utils' import { getUrl } from 'uiSrc/utils' import { ApiEndpoints } from 'uiSrc/constants' -import { Rdi as RdiInstanceResponse } from 'apiSrc/modules/rdi/models/rdi' +import { Rdi as RdiInstanceResponse } from 'uiSrc/api-client' const handlers: RestHandler[] = [ // fetch rdi instances diff --git a/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsHandler.ts b/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsHandler.ts index 52840f5d28..78561b379a 100644 --- a/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsHandler.ts +++ b/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsHandler.ts @@ -2,7 +2,7 @@ import { rest, RestHandler } from 'msw' import { ApiEndpoints } from 'uiSrc/constants' import { getMswURL } from 'uiSrc/utils/test-utils' import { getUrl } from 'uiSrc/utils' -import { DatabaseRecommendationsResponse as RecommendationResponse } from 'apiSrc/modules/database-recommendation/dto/database-recommendations.response' +import { DatabaseRecommendationsResponse as RecommendationResponse } from 'uiSrc/api-client' import { INSTANCE_ID_MOCK } from '../instances/instancesHandlers' export const RECOMMENDATIONS_DATA_MOCK = { diff --git a/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsReadHandler.ts b/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsReadHandler.ts index 199f2b8af4..92005339b5 100644 --- a/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsReadHandler.ts +++ b/redisinsight/ui/src/mocks/handlers/recommendations/recommendationsReadHandler.ts @@ -2,7 +2,7 @@ import { rest, RestHandler } from 'msw' import { ApiEndpoints } from 'uiSrc/constants' import { getMswURL } from 'uiSrc/utils/test-utils' import { getUrl } from 'uiSrc/utils' -import { Recommendation as RecommendationResponse } from 'apiSrc/modules/database-recommendations/models/recommendation' +import { Recommendation as RecommendationResponse } from 'uiSrc/api-client' import { INSTANCE_ID_MOCK } from '../instances/instancesHandlers' const EMPTY_RECOMMENDATIONS_MOCK = { diff --git a/redisinsight/ui/src/packages/vite.config.mjs b/redisinsight/ui/src/packages/vite.config.mjs index 4463176f5e..1cecf956ae 100644 --- a/redisinsight/ui/src/packages/vite.config.mjs +++ b/redisinsight/ui/src/packages/vite.config.mjs @@ -42,7 +42,6 @@ export default defineConfig({ '@redislabsdev/redis-ui-icons': '@redis-ui/icons', '@redislabsdev/redis-ui-table': '@redis-ui/table', uiSrc: fileURLToPath(new URL('../../src', import.meta.url)), - apiSrc: fileURLToPath(new URL('../../../api/src', import.meta.url)), }, }, server: { diff --git a/redisinsight/ui/src/pages/autodiscover-sentinel/sentinel-databases/SentinelDatabasesPage.tsx b/redisinsight/ui/src/pages/autodiscover-sentinel/sentinel-databases/SentinelDatabasesPage.tsx index 91934772c6..59ddfd910b 100644 --- a/redisinsight/ui/src/pages/autodiscover-sentinel/sentinel-databases/SentinelDatabasesPage.tsx +++ b/redisinsight/ui/src/pages/autodiscover-sentinel/sentinel-databases/SentinelDatabasesPage.tsx @@ -21,7 +21,7 @@ import { CopyIcon } from 'uiSrc/components/base/icons' import { Text } from 'uiSrc/components/base/text' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { ColumnDefinition } from 'uiSrc/components/base/layout/table' -import { CreateSentinelDatabaseDto } from 'apiSrc/modules/redis-sentinel/dto/create.sentinel.database.dto' +import { CreateSentinelDatabaseDto } from 'uiSrc/api-client' import SentinelDatabases from './components' @@ -82,6 +82,7 @@ const SentinelDatabasesPage = () => { dispatch(updateMastersSentinel(databases)) dispatch( + // @ts-expect-error TODO: check this - expected type is CreateSentinelDatabasesDto createMastersSentinelAction(pikedDatabases, () => history.push(Pages.sentinelDatabasesResult), ), diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyHash/AddKeyHash.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyHash/AddKeyHash.tsx index 9f10079127..b8030dc08b 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyHash/AddKeyHash.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyHash/AddKeyHash.tsx @@ -30,7 +30,7 @@ import { FormField } from 'uiSrc/components/base/forms/FormField' import { CreateHashWithExpireDto, HashFieldDto, -} from 'apiSrc/modules/browser/hash/dto' +} from 'uiSrc/api-client' import { IHashFieldState, INITIAL_HASH_FIELD_STATE } from './interfaces' import { AddHashFormConfig as config } from '../constants/fields-config' diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyList/AddKeyList.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyList/AddKeyList.tsx index 41675cd751..3a52ad0293 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyList/AddKeyList.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyList/AddKeyList.tsx @@ -16,8 +16,8 @@ import { import { RiSelect } from 'uiSrc/components/base/forms/select/RiSelect' import { CreateListWithExpireDto, - ListElementDestination, -} from 'apiSrc/modules/browser/list/dto' + CreateListWithExpireDtoDestinationEnum as ListElementDestination, +} from 'uiSrc/api-client' import { AddListFormConfig as config } from '../constants/fields-config' import AddKeyFooter from '../AddKeyFooter/AddKeyFooter' diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyReJSON/AddKeyReJSON.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyReJSON/AddKeyReJSON.tsx index 5b7030ecfc..3c5620d6eb 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyReJSON/AddKeyReJSON.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyReJSON/AddKeyReJSON.tsx @@ -16,7 +16,7 @@ import { SecondaryButton, } from 'uiSrc/components/base/forms/buttons' import { FormField } from 'uiSrc/components/base/forms/FormField' -import { CreateRejsonRlWithExpireDto } from 'apiSrc/modules/browser/rejson-rl/dto' +import { CreateRejsonRlWithExpireDto } from 'uiSrc/api-client' import { AddJSONFormConfig as config } from '../constants/fields-config' diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeySet/AddKeySet.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeySet/AddKeySet.tsx index cf980a62ff..d567ffda15 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeySet/AddKeySet.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeySet/AddKeySet.tsx @@ -17,7 +17,7 @@ import { } from 'uiSrc/components/base/forms/buttons' import { FlexItem, Row } from 'uiSrc/components/base/layout/flex' import { FormField } from 'uiSrc/components/base/forms/FormField' -import { CreateSetWithExpireDto } from 'apiSrc/modules/browser/set/dto' +import { CreateSetWithExpireDto } from 'uiSrc/api-client' import { INITIAL_SET_MEMBER_STATE, ISetMemberState } from './interfaces' import { AddSetFormConfig as config } from '../constants/fields-config' diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyStream/AddKeyStream.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyStream/AddKeyStream.tsx index adc2a2a799..649e31bc98 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyStream/AddKeyStream.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyStream/AddKeyStream.tsx @@ -15,7 +15,7 @@ import { SecondaryButton, } from 'uiSrc/components/base/forms/buttons' import { FlexItem, Row } from 'uiSrc/components/base/layout/flex' -import { CreateStreamDto } from 'apiSrc/modules/browser/stream/dto' +import { CreateStreamDto } from 'uiSrc/api-client' import AddKeyFooter from '../AddKeyFooter/AddKeyFooter' import styles from './styles.module.scss' @@ -70,7 +70,7 @@ const AddKeyStream = (props: Props) => { const submitData = (): void => { const data: CreateStreamDto = { - keyName: stringToBuffer(keyName), + keyName: stringToBuffer(keyName) as any, entries: [ { id: entryID, diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyString/AddKeyString.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyString/AddKeyString.tsx index 05e05e8b5e..5da066a2f7 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyString/AddKeyString.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyString/AddKeyString.tsx @@ -13,7 +13,7 @@ import { import { FlexItem, Row } from 'uiSrc/components/base/layout/flex' import { FormField } from 'uiSrc/components/base/forms/FormField' import { TextArea } from 'uiSrc/components/base/inputs' -import { SetStringWithExpireDto } from 'apiSrc/modules/browser/string/dto' +import { SetStringWithExpireDto } from 'uiSrc/api-client' import AddKeyFooter from '../AddKeyFooter/AddKeyFooter' import { AddStringFormConfig as config } from '../constants/fields-config' diff --git a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyZset/AddKeyZset.tsx b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyZset/AddKeyZset.tsx index 882dedacdb..03acddec60 100644 --- a/redisinsight/ui/src/pages/browser/components/add-key/AddKeyZset/AddKeyZset.tsx +++ b/redisinsight/ui/src/pages/browser/components/add-key/AddKeyZset/AddKeyZset.tsx @@ -24,7 +24,7 @@ import { } from 'uiSrc/components/base/forms/buttons' import { FlexItem, Row } from 'uiSrc/components/base/layout/flex' import { FormField } from 'uiSrc/components/base/forms/FormField' -import { CreateZSetWithExpireDto } from 'apiSrc/modules/browser/z-set/dto' +import { CreateZSetWithExpireDto } from 'uiSrc/api-client' import AddKeyFooter from '../AddKeyFooter/AddKeyFooter' import { AddZsetFormConfig as config } from '../constants/fields-config' diff --git a/redisinsight/ui/src/pages/browser/components/bulk-actions/BulkDelete/BulkDeleteSummaryButton/BulkDeleteSummaryButton.tsx b/redisinsight/ui/src/pages/browser/components/bulk-actions/BulkDelete/BulkDeleteSummaryButton/BulkDeleteSummaryButton.tsx index 12f2385e1c..6934afcebd 100644 --- a/redisinsight/ui/src/pages/browser/components/bulk-actions/BulkDelete/BulkDeleteSummaryButton/BulkDeleteSummaryButton.tsx +++ b/redisinsight/ui/src/pages/browser/components/bulk-actions/BulkDelete/BulkDeleteSummaryButton/BulkDeleteSummaryButton.tsx @@ -3,7 +3,8 @@ import { Maybe } from 'uiSrc/utils' import { SecondaryButton } from 'uiSrc/components/base/forms/buttons' import { DownloadIcon } from 'uiSrc/components/base/icons' import { Link } from 'uiSrc/components/base/link/Link' -import { RedisString } from 'apiSrc/common/constants' + +type RedisString = string | Buffer export interface BulkDeleteSummaryButtonProps { pattern: string diff --git a/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndex.tsx b/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndex.tsx index 25684c4e2b..4041ab24d9 100644 --- a/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndex.tsx +++ b/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndex.tsx @@ -29,7 +29,7 @@ import { HealthText, Text } from 'uiSrc/components/base/text' import { Link } from 'uiSrc/components/base/link/Link' import { RiSelect } from 'uiSrc/components/base/forms/select/RiSelect' import { RiPopover } from 'uiSrc/components/base' -import { CreateRedisearchIndexDto } from 'apiSrc/modules/browser/redisearch/dto' +import { CreateRedisearchIndexDto } from 'uiSrc/api-client' import { KEY_TYPE_OPTIONS, RedisearchIndexKeyType } from './constants' diff --git a/redisinsight/ui/src/pages/browser/components/key-list/KeyList.tsx b/redisinsight/ui/src/pages/browser/components/key-list/KeyList.tsx index 750d9949d7..0496d794b7 100644 --- a/redisinsight/ui/src/pages/browser/components/key-list/KeyList.tsx +++ b/redisinsight/ui/src/pages/browser/components/key-list/KeyList.tsx @@ -51,8 +51,7 @@ import KeyRowTTL from 'uiSrc/pages/browser/components/key-row-ttl' import KeyRowSize from 'uiSrc/pages/browser/components/key-row-size' import KeyRowName from 'uiSrc/pages/browser/components/key-row-name' import KeyRowType from 'uiSrc/pages/browser/components/key-row-type' - -import { GetKeyInfoResponse } from 'apiSrc/modules/browser/keys/dto' +import { GetKeyInfoResponse } from 'uiSrc/api-client' import NoKeysMessage from '../no-keys-message' import { DeleteKeyPopover } from '../delete-key-popover/DeleteKeyPopover' @@ -363,27 +362,22 @@ const KeyList = forwardRef((props: Props, ref) => { const isTtlTheLastColumn = !shownColumns.includes(BrowserColumns.Size) const ttlColumnSize = isTtlTheLastColumn ? 146 : 86 - const columns: ITableColumn[] = [ + const columns: ITableColumn[] = [ { id: 'type', label: 'Type', absoluteWidth: 'auto', minWidth: 126, - render: (cellData: any, { nameString }: any) => ( + render: (cellData, { nameString }) => ( ), - }, + } as ITableColumn, { id: 'nameString', label: 'Key', minWidth: 94, truncateText: true, - render: ( - _cellData: string, - { name, type }: IKeyPropTypes, - _expanded, - rowIndex, - ) => { + render: (_cellData, { name, type }, _expanded, rowIndex) => { const nameString = keyFormatConvertor(name) return ( <> @@ -402,9 +396,9 @@ const KeyList = forwardRef((props: Props, ref) => { ) }, - }, + } as ITableColumn, shownColumns.includes(BrowserColumns.TTL) - ? { + ? ({ id: 'ttl', label: 'TTL', absoluteWidth: ttlColumnSize, @@ -413,7 +407,7 @@ const KeyList = forwardRef((props: Props, ref) => { alignment: TableCellAlignment.Right, render: ( cellData: number, - { nameString, name, type }: IKeyPropTypes, + { nameString, name, type }, _expanded, rowIndex, ) => ( @@ -437,10 +431,10 @@ const KeyList = forwardRef((props: Props, ref) => { )} ), - } + } as ITableColumn) : null, shownColumns.includes(BrowserColumns.Size) - ? { + ? ({ id: 'size', label: 'Size', absoluteWidth: 90, @@ -449,7 +443,7 @@ const KeyList = forwardRef((props: Props, ref) => { textAlignment: TableCellTextAlignment.Right, render: ( cellData: number, - { nameString, name, type }: IKeyPropTypes, + { nameString, name, type }, _expanded, rowIndex, ) => ( @@ -473,7 +467,7 @@ const KeyList = forwardRef((props: Props, ref) => { )} ), - } + } as ITableColumn) : null, ].filter((el) => !!el) diff --git a/redisinsight/ui/src/pages/browser/components/key-tree/KeyTree.tsx b/redisinsight/ui/src/pages/browser/components/key-tree/KeyTree.tsx index 632756ab77..744eaadfc0 100644 --- a/redisinsight/ui/src/pages/browser/components/key-tree/KeyTree.tsx +++ b/redisinsight/ui/src/pages/browser/components/key-tree/KeyTree.tsx @@ -28,7 +28,7 @@ import { selectedKeyDataSelector, } from 'uiSrc/slices/browser/keys' import { TelemetryEvent, sendEventTelemetry } from 'uiSrc/telemetry' -import { GetKeyInfoResponse } from 'apiSrc/modules/browser/keys/dto' +import { GetKeyInfoResponse } from 'uiSrc/api-client' import NoKeysMessage from '../no-keys-message' import styles from './styles.module.scss' @@ -53,6 +53,7 @@ export const secondPanelId = 'keys' const parseKeyNames = (keys: GetKeyInfoResponse[]) => keys.map((item) => ({ ...item, + // @ts-expect-error TODO: check this type mismatch (use item.name ?? check instead?) nameString: item.nameString ?? bufferToString(item.name), })) @@ -80,8 +81,8 @@ const KeyTree = forwardRef((props: Props, ref) => { const [firstDataLoaded, setFirstDataLoaded] = useState( !!keysState.keys.length, ) - const [items, setItems] = useState( - parseKeyNames(keysState.keys ?? []), + const [items, setItems] = useState( + parseKeyNames((keysState.keys ?? []) as IKeyPropTypes[]), ) // escape regexp symbols and join and transform to regexp @@ -144,7 +145,7 @@ const KeyTree = forwardRef((props: Props, ref) => { startIndex: number stopIndex: number }) => { - const formattedAllKeys = parseKeyNames(keysState.keys) + const formattedAllKeys = parseKeyNames(keysState.keys) as IKeyPropTypes[] loadMoreItems?.(formattedAllKeys, props) } @@ -215,7 +216,7 @@ const KeyTree = forwardRef((props: Props, ref) => {
{ hashDataSelectorMock, ) ;(connectedInstanceSelector as jest.Mock).mockImplementationOnce(() => ({ - compressor: KeyValueCompressor.GZIP, + compressor: KeyValueCompressor.Gzip, })) const { queryByTestId } = render( diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/hash-details/hash-details-table/HashDetailsTable.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/hash-details/hash-details-table/HashDetailsTable.tsx index dc16ed50e6..1d66c1a69b 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/hash-details/hash-details-table/HashDetailsTable.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/hash-details/hash-details-table/HashDetailsTable.tsx @@ -86,7 +86,7 @@ import { GetHashFieldsResponse, HashFieldDto, UpdateHashFieldsTtlDto, -} from 'apiSrc/modules/browser/hash/dto' +} from 'uiSrc/api-client' import styles from './styles.module.scss' @@ -187,7 +187,7 @@ const HashDetailsTable = (props: Props) => { setDeleting(`${field + suffix}`) }, []) - const onSuccessRemoved = (newTotalValue: number) => { + const onSuccessRemoved = (newTotalValue?: number) => { newTotalValue === 0 && onRemoveKey() sendEventTelemetry({ event: getBasedOnViewTypeEvent( @@ -469,7 +469,7 @@ const HashDetailsTable = (props: Props) => { disabledTooltipText={TEXT_UNPRINTABLE_CHARACTERS} onDecline={() => handleEditField(rowIndex, false, 'value')} onApply={(value) => - handleApplyEditValue(fieldItem, value, rowIndex) + handleApplyEditValue(fieldItem as string, value, rowIndex) } approveText={TEXT_INVALID_VALUE} approveByValidation={(value) => @@ -509,11 +509,7 @@ const HashDetailsTable = (props: Props) => { absoluteWidth: 40, minWidth: 40, maxWidth: 40, - render: function Actions( - _act: any, - { field: fieldItem, value: valueItem }: HashFieldDto, - _, - ) { + render: function Actions(_act: any, { field: fieldItem }: HashFieldDto) { const field = bufferToString(fieldItem, viewFormat) return ( @@ -570,7 +566,7 @@ const HashDetailsTable = (props: Props) => { isEditing={isEditing} onEdit={(value: boolean) => handleEditField(rowIndex, value, 'ttl')} onDecline={() => handleEditField(rowIndex, false, 'ttl')} - onApply={(value) => handleApplyEditExpire(fieldItem, value, 'ttl')} + onApply={(value) => handleApplyEditExpire(fieldItem as string, value, rowIndex)} testIdPrefix="hash-ttl" validation={validateTTLNumber} isEditDisabled={isTruncatedFieldName} diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/add-list-elements/AddListElements.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/add-list-elements/AddListElements.tsx index 5c70de61f7..c406458b9d 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/add-list-elements/AddListElements.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/add-list-elements/AddListElements.tsx @@ -1,7 +1,6 @@ import React, { ChangeEvent, useEffect, useRef, useState } from 'react' import { useDispatch, useSelector } from 'react-redux' -import cx from 'classnames' import { EuiFieldText } from '@elastic/eui' import { @@ -25,7 +24,7 @@ import { SecondaryButton, } from 'uiSrc/components/base/forms/buttons' import { RiSelect } from 'uiSrc/components/base/forms/select/RiSelect' -import { PushElementToListDto } from 'apiSrc/modules/browser/list/dto' +import { PushElementToListDto } from 'uiSrc/api-client' import styles from '../styles.module.scss' diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.spec.tsx index 5ae1634128..c511b00b58 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.spec.tsx @@ -24,9 +24,9 @@ import { } from 'uiSrc/utils/tests/decompressors' import { setSelectedKeyRefreshDisabled } from 'uiSrc/slices/browser/keys' import { MOCK_TRUNCATED_BUFFER_VALUE } from 'uiSrc/mocks/data/bigString' -import { ListDetailsTable, Props } from './ListDetailsTable' +import { ListDetailsTable } from './ListDetailsTable' -const mockedProps = mock() +const mockedProps = mock() const elements = [ { element: { type: 'Buffer', data: [49] }, index: 0 }, @@ -159,7 +159,7 @@ describe('ListDetailsTable', () => { listDataSelectorMock, ) ;(connectedInstanceSelector as jest.Mock).mockImplementationOnce(() => ({ - compressor: KeyValueCompressor.GZIP, + compressor: KeyValueCompressor.Gzip, })) const { queryByTestId } = render() diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.tsx index be4fdfb974..1fd78e3959 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/list-details-table/ListDetailsTable.tsx @@ -66,16 +66,14 @@ import { NoResultsFoundText } from 'uiSrc/constants/texts' import VirtualTable from 'uiSrc/components/virtual-table/VirtualTable' import { getColumnWidth } from 'uiSrc/components/virtual-grid' import { decompressingBuffer } from 'uiSrc/utils/decompressors' +import { RedisResponseBuffer } from 'uiSrc/slices/interfaces' +import { SetListElementResponse, SetListElementDto } from 'uiSrc/api-client' import { EditableTextArea, FormattedValue, } from 'uiSrc/pages/browser/modules/key-details/shared' import { Text } from 'uiSrc/components/base/text' -import { - SetListElementDto, - SetListElementResponse, -} from 'apiSrc/modules/browser/list/dto' import styles from './styles.module.scss' @@ -99,7 +97,9 @@ const ListDetailsTable = () => { total, searchedIndex, } = useSelector(listDataSelector) - const { name: key } = useSelector(selectedKeyDataSelector) ?? { name: '' } + const key = + useSelector(selectedKeyDataSelector)?.name || + ('' as unknown as RedisResponseBuffer) const { id: instanceId, compressor = null } = useSelector( connectedInstanceSelector, ) diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/remove-list-elements/RemoveListElements.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/remove-list-elements/RemoveListElements.tsx index ba46f27388..bd824a3617 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/remove-list-elements/RemoveListElements.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/list-details/remove-list-elements/RemoveListElements.tsx @@ -43,7 +43,7 @@ import { FormField } from 'uiSrc/components/base/forms/FormField' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { RiSelect } from 'uiSrc/components/base/forms/select/RiSelect' import { RiPopover } from 'uiSrc/components/base' -import { DeleteListElementsDto } from 'apiSrc/modules/browser/list/dto' +import { DeleteListElementsDto } from 'uiSrc/api-client' import { HEAD_DESTINATION, diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/rejson-details/rejson-dynamic-types/RejsonDynamicTypes.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/rejson-details/rejson-dynamic-types/RejsonDynamicTypes.tsx index 27e0ce81bf..aa09773502 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/rejson-details/rejson-dynamic-types/RejsonDynamicTypes.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/rejson-details/rejson-dynamic-types/RejsonDynamicTypes.tsx @@ -69,7 +69,7 @@ const RejsonDynamicTypes = (props: DynamicTypesProps) => { const renderRejsonDataBeDownloaded = (item: any, i: number) => { if (isScalar(item)) - return renderScalar({ key: i || null, value: item, parentPath }) + return renderScalar({ key: i || '', value: item, parentPath }) const data = { ...item, parentPath } if (['array', 'object'].includes(item.type)) @@ -97,7 +97,7 @@ const RejsonDynamicTypes = (props: DynamicTypesProps) => { const renderResult = (data: any) => { if (isScalar(data)) { - return renderScalar({ key: null, value: data, parentPath }) + return renderScalar({ key: '', value: data, parentPath }) } if (!isDownloaded) { diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/set-details/set-details-table/SetDetailsTable.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/set-details/set-details-table/SetDetailsTable.tsx index d49de6c409..7e7809e04f 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/set-details/set-details-table/SetDetailsTable.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/set-details/set-details-table/SetDetailsTable.tsx @@ -49,7 +49,7 @@ import { } from 'uiSrc/components/virtual-table/interfaces' import { decompressingBuffer } from 'uiSrc/utils/decompressors' import { FormattedValue } from 'uiSrc/pages/browser/modules/key-details/shared' -import { GetSetMembersResponse } from 'apiSrc/modules/browser/set/dto' +import { GetSetMembersResponse } from 'uiSrc/api-client' import styles from './styles.module.scss' const suffix = '_set' @@ -76,7 +76,7 @@ const SetDetailsTable = (props: Props) => { total, nextCursor, } = useSelector(setDataSelector) - const { length = 0, name: key } = useSelector(selectedKeyDataSelector) ?? {} + const { length = 0, name: key } = useSelector(selectedKeyDataSelector)! ?? {} const { id: instanceId, compressor = null } = useSelector( connectedInstanceSelector, ) @@ -136,8 +136,10 @@ const SetDetailsTable = (props: Props) => { }) } - const handleDeleteMember = (member: string | RedisString = '') => { - dispatch(deleteSetMembers(key, [member], onSuccessRemoved)) + const handleDeleteMember = (member: RedisString = '') => { + dispatch( + deleteSetMembers(key, [member as RedisResponseBuffer], onSuccessRemoved), + ) closePopover() } @@ -229,15 +231,16 @@ const SetDetailsTable = (props: Props) => { compressor, ) const { value, isValid } = formattingBuffer( - decompressedMemberItem, + decompressedMemberItem as RedisResponseBuffer, viewFormatProp, { expanded }, ) const tooltipContent = createTooltipContent( value, - decompressedMemberItem, + decompressedMemberItem as RedisResponseBuffer, viewFormatProp, ) + // @ts-expect-error const cellContent = value?.substring?.(0, 200) ?? value return ( diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-entity/AddStreamEntries.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-entity/AddStreamEntries.tsx index 35eee734fc..7aaf50d548 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-entity/AddStreamEntries.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-entity/AddStreamEntries.tsx @@ -24,7 +24,7 @@ import { PrimaryButton, SecondaryButton, } from 'uiSrc/components/base/forms/buttons' -import { AddStreamEntriesDto } from 'apiSrc/modules/browser/stream/dto' +import { AddStreamEntriesDto } from 'uiSrc/api-client' import StreamEntryFields from './StreamEntryFields/StreamEntryFields' import styles from './styles.module.scss' diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-group/AddStreamGroup.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-group/AddStreamGroup.tsx index fc7b124598..7238b1da59 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-group/AddStreamGroup.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/add-stream-group/AddStreamGroup.tsx @@ -21,7 +21,7 @@ import { import { FormField } from 'uiSrc/components/base/forms/FormField' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' import { RiTooltip } from 'uiSrc/components' -import { CreateConsumerGroupsDto } from 'apiSrc/modules/browser/stream/dto' +import { CreateConsumerGroupsDto } from 'uiSrc/api-client' import styles from './styles.module.scss' diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.spec.tsx index c7f3c36a2a..153c0f426e 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.spec.tsx @@ -1,7 +1,7 @@ import React from 'react' import { instance, mock } from 'ts-mockito' import { render, screen } from 'uiSrc/utils/test-utils' -import { ConsumerDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerDto } from 'uiSrc/api-client' import ConsumersView, { Props } from './ConsumersView' const mockedProps = mock() diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.tsx index 26b06b2aac..8aaeba3383 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersView/ConsumersView.tsx @@ -8,7 +8,8 @@ import VirtualTable from 'uiSrc/components/virtual-table/VirtualTable' import { ITableColumn } from 'uiSrc/components/virtual-table/interfaces' import { selectedKeyDataSelector } from 'uiSrc/slices/browser/keys' import { SortOrder } from 'uiSrc/constants' -import { ConsumerDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerDto } from 'uiSrc/api-client' +import { getLodashOrder } from 'uiSrc/utils' import styles from './styles.module.scss' @@ -33,7 +34,7 @@ const ConsumersView = (props: Props) => { } = props const { loading } = useSelector(streamGroupsSelector) - const { name: key = '' } = useSelector(selectedKeyDataSelector) ?? {} + const key = useSelector(selectedKeyDataSelector)?.name const [consumers, setConsumers] = useState(data) const [sortedColumnName, setSortedColumnName] = useState('name') @@ -43,7 +44,7 @@ const ConsumersView = (props: Props) => { useEffect(() => { setConsumers( - orderBy(data, sortedColumnName, sortedColumnOrder?.toLowerCase()), + orderBy(data, sortedColumnName, getLodashOrder(sortedColumnOrder)), ) }, [data]) @@ -51,7 +52,7 @@ const ConsumersView = (props: Props) => { setSortedColumnName(column) setSortedColumnOrder(order) - setConsumers(orderBy(consumers, column, order?.toLowerCase())) + setConsumers(orderBy(consumers, column, getLodashOrder(order))) } return ( diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.spec.tsx index a2951d082f..2cbb1df50a 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.spec.tsx @@ -21,7 +21,7 @@ import { MOCK_TRUNCATED_BUFFER_VALUE, MOCK_TRUNCATED_STRING_VALUE, } from 'uiSrc/mocks/data/bigString' -import { ConsumerDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerDto } from 'uiSrc/api-client' import ConsumersViewWrapper, { Props } from './ConsumersViewWrapper' import ConsumersView, { Props as ConsumersViewProps } from './ConsumersView' @@ -48,10 +48,10 @@ jest.mock('./ConsumersView', () => ({ default: jest.fn(), })) -const mockConsumerName = 'group' const mockConsumers: ConsumerDto[] = [ { name: { + // @ts-ignore ...bufferToString('test'), viewValue: 'test', }, @@ -60,6 +60,7 @@ const mockConsumers: ConsumerDto[] = [ }, { name: { + // @ts-ignore ...bufferToString('test2'), viewValue: 'test2', }, @@ -73,7 +74,7 @@ const mockConsumersView = jest.fn((props: ConsumersViewProps) => ( @@ -89,7 +90,7 @@ const mockConsumersView = jest.fn((props: ConsumersViewProps) => ( describe('ConsumersViewWrapper', () => { beforeAll(() => { - ConsumersView.mockImplementation(mockConsumersView) + jest.mocked(ConsumersView).mockImplementation(mockConsumersView) }) it('should render', () => { @@ -113,7 +114,7 @@ describe('ConsumersViewWrapper', () => { expect(store.getActions()).toEqual([ ...afterRenderActions, - setSelectedConsumer(), + setSelectedConsumer(undefined), loadConsumerGroups(false), ]) }) diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.tsx index 109f03b8d8..3ca65f2113 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/consumers-view/ConsumersViewWrapper.tsx @@ -27,7 +27,7 @@ import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry' import { Text } from 'uiSrc/components/base/text' import { RiTooltip } from 'uiSrc/components' -import { ConsumerDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerDto } from 'uiSrc/api-client' import ConsumersView from './ConsumersView' import styles from './ConsumersView/styles.module.scss' @@ -123,6 +123,7 @@ const ConsumersViewWrapper = (props: Props) => { headerCellClassName: 'truncateText', render: function Name(_name: string, { name }: ConsumerDto) { // Better to cut the long string, because it could affect virtual scroll performance + // @ts-ignore const viewName = name?.viewValue ?? '' const cellContent = viewName.substring(0, 200) const tooltipContent = formatLongName(viewName) @@ -179,6 +180,7 @@ const ConsumersViewWrapper = (props: Props) => { maxWidth: actionsWidth, minWidth: actionsWidth, render: function Actions(_act: any, { name }: ConsumerDto) { + // @ts-ignore const viewName = name?.viewValue ?? '' return (
@@ -197,7 +199,7 @@ const ConsumersViewWrapper = (props: Props) => { updateLoading={false} showPopover={showPopover} testid={`remove-consumer-button-${viewName}`} - handleDeleteItem={() => handleDeleteConsumer(name)} + handleDeleteItem={() => handleDeleteConsumer(name as string)} handleButtonClick={handleRemoveIconClick} />
diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsView/GroupsView.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsView/GroupsView.tsx index 71382346a8..f9305221c9 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsView/GroupsView.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsView/GroupsView.tsx @@ -8,7 +8,8 @@ import VirtualTable from 'uiSrc/components/virtual-table/VirtualTable' import { ITableColumn } from 'uiSrc/components/virtual-table/interfaces' import { selectedKeyDataSelector } from 'uiSrc/slices/browser/keys' import { SortOrder } from 'uiSrc/constants' -import { ConsumerGroupDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerGroupDto } from 'uiSrc/api-client' +import { getLodashOrder } from 'uiSrc/utils' import styles from './styles.module.scss' @@ -31,7 +32,7 @@ const ConsumerGroups = (props: Props) => { const { data = [], columns = [], onClosePopover, onSelectGroup } = props const { loading } = useSelector(streamGroupsSelector) - const { name: key = '' } = useSelector(selectedKeyDataSelector) ?? {} + const key = useSelector(selectedKeyDataSelector)?.name const [groups, setGroups] = useState([]) const [sortedColumnName, setSortedColumnName] = useState('name') @@ -40,7 +41,9 @@ const ConsumerGroups = (props: Props) => { ) useEffect(() => { - setGroups(orderBy(data, sortedColumnName, sortedColumnOrder?.toLowerCase())) + setGroups( + orderBy(data, sortedColumnName, getLodashOrder(sortedColumnOrder)), + ) }, [data]) const onChangeSorting = useCallback( @@ -51,8 +54,8 @@ const ConsumerGroups = (props: Props) => { setGroups( orderBy( data, - [column === 'name' ? `${column}.viewValue` : column], - order?.toLowerCase(), + column === 'name' ? `${column}.viewValue` : column, + getLodashOrder(order), ), ) }, diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.spec.tsx index 7126b7b983..12ab227040 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.spec.tsx @@ -19,7 +19,7 @@ import VirtualTable from 'uiSrc/components/virtual-table/VirtualTable' import { stringToBuffer } from 'uiSrc/utils' import { setSelectedKeyRefreshDisabled } from 'uiSrc/slices/browser/keys' import { MOCK_TRUNCATED_BUFFER_VALUE } from 'uiSrc/mocks/data/bigString' -import { ConsumerGroupDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerGroupDto } from 'uiSrc/api-client' import GroupsView, { Props as GroupsViewProps } from './GroupsView' import GroupsViewWrapper, { Props } from './GroupsViewWrapper' @@ -57,6 +57,7 @@ jest.mock('./GroupsView', () => ({ const mockGroups: ConsumerGroupDto[] = [ { name: { + // @ts-ignore ...stringToBuffer('test'), viewValue: 'test', }, @@ -68,6 +69,7 @@ const mockGroups: ConsumerGroupDto[] = [ }, { name: { + // @ts-ignore ...stringToBuffer('test2'), viewValue: 'test2', }, diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.tsx index 53fd243050..11963787f1 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/groups-view/GroupsViewWrapper.tsx @@ -41,7 +41,7 @@ import { ConsumerDto, ConsumerGroupDto, UpdateConsumerGroupDto, -} from 'apiSrc/modules/browser/stream/dto' +} from 'uiSrc/api-client' import GroupsView from './GroupsView' @@ -49,6 +49,15 @@ import styles from './GroupsView/styles.module.scss' export interface IConsumerGroup extends ConsumerGroupDto { editing: boolean + name: ConsumerGroupDto['name'] & { + viewValue?: string + } + greatestPendingId: ConsumerGroupDto['greatestPendingId'] & { + viewValue?: string + } + smallestPendingId: ConsumerGroupDto['smallestPendingId'] & { + viewValue?: string + } } const suffix = '_stream_group' @@ -101,14 +110,17 @@ const GroupsViewWrapper = (props: Props) => { ...item, editing: false, name: { + // @ts-ignore ...item.name, viewValue: bufferToString(item.name), }, greatestPendingId: { + // @ts-ignore ...item.greatestPendingId, viewValue: bufferToString(item.greatestPendingId), }, smallestPendingId: { + // @ts-ignore ...item.smallestPendingId, viewValue: bufferToString(item.smallestPendingId), }, @@ -184,7 +196,7 @@ const GroupsViewWrapper = (props: Props) => { } } - const handleApplyEditId = (groupName: RedisResponseBuffer) => { + const handleApplyEditId = (groupName: any) => { if (!!groupName?.data?.length && !idError && selectedKey) { const data: UpdateConsumerGroupDto = { keyName: selectedKey, diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessageClaimPopover/MessageClaimPopover.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessageClaimPopover/MessageClaimPopover.tsx index aaf486d2f7..d6da5764f9 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessageClaimPopover/MessageClaimPopover.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessageClaimPopover/MessageClaimPopover.tsx @@ -32,7 +32,7 @@ import { ClaimPendingEntryDto, ClaimPendingEntriesResponse, ConsumerDto, -} from 'apiSrc/modules/browser/stream/dto' +} from 'uiSrc/api-client' import styles from './styles.module.scss' diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.spec.tsx index 0d2e66f6c9..854e1d83f6 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.spec.tsx @@ -1,7 +1,7 @@ import React from 'react' import { instance, mock } from 'ts-mockito' import { render, screen } from 'uiSrc/utils/test-utils' -import { PendingEntryDto } from 'apiSrc/modules/browser/stream/dto' +import { PendingEntryDto } from 'uiSrc/api-client' import MessagesView, { Props } from './MessagesView' const mockedProps = mock() diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.tsx index 3d08a8721f..cbd556d84e 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesView/MessagesView.tsx @@ -6,7 +6,7 @@ import { streamGroupsSelector } from 'uiSrc/slices/browser/stream' import VirtualTable from 'uiSrc/components/virtual-table/VirtualTable' import { ITableColumn } from 'uiSrc/components/virtual-table/interfaces' import { selectedKeyDataSelector } from 'uiSrc/slices/browser/keys' -import { PendingEntryDto } from 'apiSrc/modules/browser/stream/dto' +import { PendingEntryDto } from 'uiSrc/api-client' import styles from './styles.module.scss' @@ -33,7 +33,7 @@ const MessagesView = (props: Props) => { } = props const { loading } = useSelector(streamGroupsSelector) - const { name: key = '' } = useSelector(selectedKeyDataSelector) ?? {} + const key = useSelector(selectedKeyDataSelector)?.name return ( <> diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.spec.tsx index 6e9a04b832..6e0f0f508e 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.spec.tsx @@ -19,7 +19,7 @@ import { MOCK_TRUNCATED_STRING_VALUE, } from 'uiSrc/mocks/data/bigString' import { TEXT_CONSUMER_NAME_TOO_LONG } from 'uiSrc/constants' -import { PendingEntryDto } from 'apiSrc/modules/browser/stream/dto' +import { PendingEntryDto } from 'uiSrc/api-client' import MessagesView, { Props as MessagesViewProps } from './MessagesView' import MessagesViewWrapper, { Props } from './MessagesViewWrapper' @@ -74,7 +74,7 @@ const mockMessagesView = jest.fn((props: MessagesViewProps) => ( describe('MessagesViewWrapper', () => { beforeAll(() => { - MessagesView.mockImplementation(mockMessagesView) + jest.mocked(MessagesView).mockImplementation(mockMessagesView) }) it('should render', () => { @@ -98,6 +98,7 @@ describe('MessagesViewWrapper', () => { expect(store.getActions()).toEqual([ ...afterRenderActions, + // @ts-expect-error setSelectedGroup(), loadConsumerGroups(false), ]) diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.tsx index 33d69daf8b..4b7afe1d5b 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/messages-view/MessagesViewWrapper.tsx @@ -28,7 +28,7 @@ import { PendingEntryDto, ClaimPendingEntryDto, ClaimPendingEntriesResponse, -} from 'apiSrc/modules/browser/stream/dto' +} from 'uiSrc/api-client' import MessagesView from './MessagesView' import MessageClaimPopover from './MessageClaimPopover' @@ -50,7 +50,7 @@ const MessagesViewWrapper = (props: Props) => { name: consumerName, pending = 0, } = useSelector(selectedConsumerSelector) ?? {} - const isTruncatedConsumerName = isTruncatedString(consumerName) + const isTruncatedConsumerName = isTruncatedString(consumerName!) const { name: group } = useSelector(selectedGroupSelector) ?? { name: '' } const { name: key } = useSelector(selectedKeyDataSelector) ?? { name: '' } const { instanceId } = useParams<{ instanceId: string }>() @@ -97,6 +97,7 @@ const MessagesViewWrapper = (props: Props) => { } const handleAchPendingMessage = (entry: string) => { + // @ts-expect-error TODO: check type mismatch dispatch(ackPendingEntriesAction(key, group, [entry], onSuccessAck)) } diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataView/StreamDataView.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataView/StreamDataView.tsx index 42df84de44..c007ddf520 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataView/StreamDataView.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataView/StreamDataView.tsx @@ -22,7 +22,7 @@ import { sendEventTelemetry, TelemetryEvent, } from 'uiSrc/telemetry' -import { StreamEntryDto } from 'apiSrc/modules/browser/stream/dto' +import { StreamEntryDto } from 'uiSrc/api-client' import styles from './styles.module.scss' @@ -52,7 +52,7 @@ const StreamDataView = (props: Props) => { const { viewType } = useSelector(keysSelector) const { loading } = useSelector(streamSelector) const { total, firstEntry, lastEntry } = useSelector(streamDataSelector) - const { name: key } = useSelector(selectedKeyDataSelector) ?? { name: '' } + const key = useSelector(selectedKeyDataSelector)?.name! const [sortedColumnName, setSortedColumnName] = useState('id') const [sortedColumnOrder, setSortedColumnOrder] = useState( diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataViewWrapper.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataViewWrapper.tsx index 35ab26d55a..9752d61d4f 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataViewWrapper.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-data-view/StreamDataViewWrapper.tsx @@ -1,7 +1,7 @@ import React, { useCallback, useEffect, useState } from 'react' import { useDispatch, useSelector } from 'react-redux' import { last, mergeWith, toNumber } from 'lodash' -import { RedisResponseBuffer } from 'uiSrc/slices/interfaces' +import { RedisResponseBuffer, RedisString } from 'uiSrc/slices/interfaces' import { bufferToString, @@ -38,7 +38,7 @@ import { decompressingBuffer } from 'uiSrc/utils/decompressors' import { FormattedValue } from 'uiSrc/pages/browser/modules/key-details/shared' import { FormatedDate } from 'uiSrc/components' import { Text } from 'uiSrc/components/base/text' -import { StreamEntryDto } from 'apiSrc/modules/browser/stream/dto' +import { StreamEntryDto, StreamEntryFieldDto } from 'uiSrc/api-client' import StreamDataView from './StreamDataView' import styles from './StreamDataView/styles.module.scss' import { @@ -185,11 +185,12 @@ const StreamDataViewWrapper = (props: Props) => { }, ...columnsNames, actions: '', - } + } as unknown as StreamEntryDto setEntries([headerRow, ...streamEntries]) setColumns([ idColumn, ...Object.keys(columnsNames).map((field) => + // @ts-ignore getTemplateColumn(field, columnsNames[field]?.id), ), actionsColumn, @@ -209,7 +210,7 @@ const StreamDataViewWrapper = (props: Props) => { }, []) const formatItem = useCallback( - (field) => ({ + (field: StreamEntryFieldDto) => ({ name: field.name, value: field.value, }), @@ -231,8 +232,8 @@ const StreamDataViewWrapper = (props: Props) => { }) } - const handleDeleteEntry = (entryId = '') => { - dispatch(deleteStreamEntry(key, [entryId], onSuccessRemoved)) + const handleDeleteEntry = (entryId: RedisString = '') => { + dispatch(deleteStreamEntry(key, [entryId as string], onSuccessRemoved)) closePopover() } diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-details-body/StreamDetailsBody.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-details-body/StreamDetailsBody.tsx index 3a8ec4c7d6..68e1e5dfb0 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-details-body/StreamDetailsBody.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-details-body/StreamDetailsBody.tsx @@ -23,7 +23,7 @@ import { selectedKeyDataSelector } from 'uiSrc/slices/browser/keys' import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry' import RangeFilter from 'uiSrc/components/range-filter' import { ProgressBarLoader } from 'uiSrc/components/base/display' -import { GetStreamEntriesResponse } from 'apiSrc/modules/browser/stream/dto' +import { GetStreamEntriesResponse } from 'uiSrc/api-client' import ConsumersViewWrapper from '../consumers-view' import GroupsViewWrapper from '../groups-view' @@ -122,6 +122,7 @@ const StreamDetailsBody = (props: Props) => { if (shouldLoadMore()) { dispatch( fetchMoreStreamEntries( + // @ts-expect-error TODO: check type mismatch key, entryColumnSortOrder === SortOrder.DESC ? start : nextId, entryColumnSortOrder === SortOrder.DESC ? nextId : end, @@ -157,6 +158,7 @@ const StreamDetailsBody = (props: Props) => { ) => { dispatch( fetchStreamEntries( + // @ts-expect-error TODO: check type mismatch key, SCAN_COUNT_DEFAULT, entryColumnSortOrder, diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-tabs/StreamTabs.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-tabs/StreamTabs.tsx index 617aa15158..806deb9740 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-tabs/StreamTabs.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/stream-details/stream-tabs/StreamTabs.tsx @@ -16,7 +16,7 @@ import { SCAN_COUNT_DEFAULT } from 'uiSrc/constants/api' import { SortOrder } from 'uiSrc/constants' import { selectedKeyDataSelector } from 'uiSrc/slices/browser/keys' import Tabs, { TabInfo } from 'uiSrc/components/base/layout/tabs' -import { ConsumerGroupDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerGroupDto } from 'uiSrc/api-client' const StreamTabs = () => { const { viewType } = useSelector(streamSelector) @@ -43,6 +43,7 @@ const StreamTabs = () => { const onSelectedTabChanged = (id: StreamViewType) => { if (id === StreamViewType.Data) { dispatch( + // @ts-expect-error TODO: check type mismatch fetchStreamEntries(key, SCAN_COUNT_DEFAULT, SortOrder.DESC, true), ) } diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/string-details/string-details-value/StringDetailsValue.spec.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/string-details/string-details-value/StringDetailsValue.spec.tsx index ab7650c7d2..9cc8a23a5a 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/string-details/string-details-value/StringDetailsValue.spec.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/string-details/string-details-value/StringDetailsValue.spec.tsx @@ -2,8 +2,8 @@ import React from 'react' import { instance, mock } from 'ts-mockito' import { KeyValueCompressor, KeyValueFormat } from 'uiSrc/constants' import { - fetchDownloadStringValue, - stringDataSelector, + fetchDownloadStringValue as fetchDownloadStringValueOriginal, + stringDataSelector as stringDataSelectorOriginal, } from 'uiSrc/slices/browser/string' import { connectedInstanceSelector } from 'uiSrc/slices/instances/instances' import { anyToBuffer, bufferToString } from 'uiSrc/utils' @@ -17,6 +17,7 @@ import { import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry' import { downloadFile } from 'uiSrc/utils/dom/downloadFile' import { selectedKeySelector } from 'uiSrc/slices/browser/keys' +import { RedisString } from 'uiSrc/slices/interfaces' import { MOCK_TRUNCATED_BUFFER_VALUE } from 'uiSrc/mocks/data/bigString' import { StringDetailsValue, Props } from './StringDetailsValue' @@ -28,10 +29,12 @@ const DOWNLOAD_BTN = 'download-all-value-btn' const STRING_MAX_LENGTH = 2 const STRING_LENGTH = 4 -const fullValue = { type: 'Buffer', data: [49, 50, 51, 52] } -const partValue = { type: 'Buffer', data: [49, 50] } +const fullValue = { type: 'Buffer', data: [49, 50, 51, 52] } as RedisString +const partValue = { type: 'Buffer', data: [49, 50] } as RedisString const mockedProps = mock() +const fetchDownloadStringValue = jest.mocked(fetchDownloadStringValueOriginal) +const stringDataSelector = jest.mocked(stringDataSelectorOriginal) jest.mock('uiSrc/slices/browser/string', () => ({ ...jest.requireActual('uiSrc/slices/browser/string'), @@ -256,8 +259,9 @@ describe('StringDetailsValue', () => { }) stringDataSelector.mockImplementation(stringDataSelectorMock) + // @ts-expect-error connectedInstanceSelector.mockImplementation(() => ({ - compressor: KeyValueCompressor.GZIP, + compressor: KeyValueCompressor.Gzip, })) render( @@ -278,8 +282,9 @@ describe('StringDetailsValue', () => { }) stringDataSelector.mockImplementation(stringDataSelectorMock) + // @ts-expect-error connectedInstanceSelector.mockImplementation(() => ({ - compressor: KeyValueCompressor.GZIP, + compressor: KeyValueCompressor.Gzip, })) render( diff --git a/redisinsight/ui/src/pages/browser/modules/key-details/components/zset-details/zset-details-table/ZSetDetailsTable.tsx b/redisinsight/ui/src/pages/browser/modules/key-details/components/zset-details/zset-details-table/ZSetDetailsTable.tsx index 207fecb6d8..0869333680 100644 --- a/redisinsight/ui/src/pages/browser/modules/key-details/components/zset-details/zset-details-table/ZSetDetailsTable.tsx +++ b/redisinsight/ui/src/pages/browser/modules/key-details/components/zset-details/zset-details-table/ZSetDetailsTable.tsx @@ -75,7 +75,7 @@ import { RiTooltip } from 'uiSrc/components' import { AddMembersToZSetDto, SearchZSetMembersResponse, -} from 'apiSrc/modules/browser/z-set/dto' +} from 'uiSrc/api-client' import styles from './styles.module.scss' @@ -284,6 +284,7 @@ const ZSetDetailsTable = (props: Props) => { eventData: { keyType: KeyTypes.ZSet, databaseId: instanceId, + // @ts-expect-error TODO: check this type mismatch largestCellLength: members[rowIndex]?.name?.length || 0, }, }) diff --git a/redisinsight/ui/src/pages/cluster-details/ClusterDetailsPage.tsx b/redisinsight/ui/src/pages/cluster-details/ClusterDetailsPage.tsx index f29466515a..43562e22f9 100644 --- a/redisinsight/ui/src/pages/cluster-details/ClusterDetailsPage.tsx +++ b/redisinsight/ui/src/pages/cluster-details/ClusterDetailsPage.tsx @@ -2,7 +2,7 @@ import { orderBy } from 'lodash' import React, { useContext, useEffect, useState } from 'react' import { useSelector, useDispatch } from 'react-redux' import { useParams } from 'react-router-dom' -import { ClusterNodeDetails } from 'src/modules/cluster-monitor/models' +import { ClusterNodeDetails } from 'uiSrc/api-client' import { Theme } from 'uiSrc/constants' import { ThemeContext } from 'uiSrc/contexts/themeContext' diff --git a/redisinsight/ui/src/pages/database-analysis/components/analysis-ttl-view/ExpirationGroupsView.tsx b/redisinsight/ui/src/pages/database-analysis/components/analysis-ttl-view/ExpirationGroupsView.tsx index 81337887b1..0d83a42134 100644 --- a/redisinsight/ui/src/pages/database-analysis/components/analysis-ttl-view/ExpirationGroupsView.tsx +++ b/redisinsight/ui/src/pages/database-analysis/components/analysis-ttl-view/ExpirationGroupsView.tsx @@ -27,7 +27,7 @@ import { } from 'uiSrc/slices/analytics/dbAnalysis' import { SwitchInput } from 'uiSrc/components/base/inputs' import { Title } from 'uiSrc/components/base/text/Title' -import { DatabaseAnalysis } from 'apiSrc/modules/database-analysis/models' +import { DatabaseAnalysis } from 'uiSrc/api-client' import styles from './styles.module.scss' @@ -142,7 +142,7 @@ const ExpirationGroupsView = (props: Props) => {
- {({ width, height }) => ( + {({ width = DEFAULT_BAR_WIDTH, height }) => ( { label: 'No decompression', }, { - value: KeyValueCompressor.GZIP, + value: KeyValueCompressor.Gzip, label: 'GZIP', }, { - value: KeyValueCompressor.LZ4, + value: KeyValueCompressor.Lz4, label: 'LZ4', }, { - value: KeyValueCompressor.SNAPPY, + value: KeyValueCompressor.Snappy, label: 'SNAPPY', }, { - value: KeyValueCompressor.ZSTD, + value: KeyValueCompressor.Zstd, label: 'ZSTD', }, { @@ -44,7 +44,7 @@ const DbCompressor = (props: Props) => { label: 'Brotli', }, { - value: KeyValueCompressor.PHPGZCompress, + value: KeyValueCompressor.PhpgzCompress, label: 'PHP GZCompress', }, ] diff --git a/redisinsight/ui/src/pages/home/components/form/DbInfo.tsx b/redisinsight/ui/src/pages/home/components/form/DbInfo.tsx index 295962a666..c57be6fad0 100644 --- a/redisinsight/ui/src/pages/home/components/form/DbInfo.tsx +++ b/redisinsight/ui/src/pages/home/components/form/DbInfo.tsx @@ -13,9 +13,8 @@ import { Group as ListGroup, Item as ListGroupItem, } from 'uiSrc/components/base/layout/list' +import { Endpoint, AdditionalRedisModule } from 'uiSrc/api-client' import { RiIcon } from 'uiSrc/components/base/icons/RiIcon' -import { Endpoint } from 'apiSrc/common/models' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' import styles from '../styles.module.scss' diff --git a/redisinsight/ui/src/pages/home/components/form/sentinel/DbInfoSentinel.tsx b/redisinsight/ui/src/pages/home/components/form/sentinel/DbInfoSentinel.tsx index 1d24ae8c2b..55c05d3009 100644 --- a/redisinsight/ui/src/pages/home/components/form/sentinel/DbInfoSentinel.tsx +++ b/redisinsight/ui/src/pages/home/components/form/sentinel/DbInfoSentinel.tsx @@ -8,7 +8,7 @@ import { Group as ListGroup, Item as ListGroupItem, } from 'uiSrc/components/base/layout/list' -import { SentinelMaster } from 'apiSrc/modules/redis-sentinel/models/sentinel-master' +import { SentinelMaster } from 'uiSrc/api-client' import SentinelHostPort from './SentinelHostPort' import styles from '../../styles.module.scss' diff --git a/redisinsight/ui/src/pages/pub-sub/components/messages-list/MessagesList/MessagesList.tsx b/redisinsight/ui/src/pages/pub-sub/components/messages-list/MessagesList/MessagesList.tsx index f6564992d7..d83e0f48b8 100644 --- a/redisinsight/ui/src/pages/pub-sub/components/messages-list/MessagesList/MessagesList.tsx +++ b/redisinsight/ui/src/pages/pub-sub/components/messages-list/MessagesList/MessagesList.tsx @@ -10,12 +10,11 @@ import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry' import { FormatedDate, RiTooltip } from 'uiSrc/components' import { ChevronDownIcon } from 'uiSrc/components/base/icons' import { IconButton } from 'uiSrc/components/base/forms/buttons' -import { IMessage } from 'apiSrc/modules/pub-sub/interfaces/message.interface' - +import { IPubsubMessage } from 'uiSrc/slices/interfaces/pubsub' import styles from './styles.module.scss' export interface Props { - items: IMessage[] + items: IPubsubMessage[] width?: number height?: number } diff --git a/redisinsight/ui/src/pages/rdi/home/RdiPage.tsx b/redisinsight/ui/src/pages/rdi/home/RdiPage.tsx index 7daa64ba73..bf0a15b269 100644 --- a/redisinsight/ui/src/pages/rdi/home/RdiPage.tsx +++ b/redisinsight/ui/src/pages/rdi/home/RdiPage.tsx @@ -19,7 +19,7 @@ import HomePageTemplate from 'uiSrc/templates/home-page-template' import { setTitle } from 'uiSrc/utils' import { Page, PageBody } from 'uiSrc/components/base/layout/page' import { RIResizeObserver } from 'uiSrc/components/base/utils' -import { Rdi as RdiInstanceResponse } from 'apiSrc/modules/rdi/models/rdi' +import { Rdi as RdiInstanceResponse } from 'uiSrc/api-client' import EmptyMessage from './empty-message/EmptyMessage' import ConnectionForm from './connection-form/ConnectionFormWrapper' import RdiHeader from './header/RdiHeader' diff --git a/redisinsight/ui/src/pages/slow-log/SlowLogPage.tsx b/redisinsight/ui/src/pages/slow-log/SlowLogPage.tsx index b39621eb3a..fe5777ef57 100644 --- a/redisinsight/ui/src/pages/slow-log/SlowLogPage.tsx +++ b/redisinsight/ui/src/pages/slow-log/SlowLogPage.tsx @@ -38,7 +38,7 @@ import { defaultValueRender, RiSelect, } from 'uiSrc/components/base/forms/select/RiSelect' -import { SlowLog } from 'apiSrc/modules/slow-log/models' +import { SlowLog } from 'uiSrc/api-client' import { Actions, EmptySlowLog, SlowLogTable } from './components' diff --git a/redisinsight/ui/src/services/database/instancesService.ts b/redisinsight/ui/src/services/database/instancesService.ts index 81b3b1d422..90136b149c 100644 --- a/redisinsight/ui/src/services/database/instancesService.ts +++ b/redisinsight/ui/src/services/database/instancesService.ts @@ -1,7 +1,10 @@ -import { RedisNodeInfoResponse } from 'src/modules/database/dto/redis-info.dto' -import { Database as DatabaseInstanceResponse } from 'src/modules/database/models/database' -import { ExportDatabase } from 'src/modules/database/models/export-database' import axios, { CancelTokenSource } from 'axios' + +import { + ExportDatabase, + Database as DatabaseInstanceResponse, + RedisNodeInfoResponse, +} from 'uiSrc/api-client' import { ApiEndpoints } from 'uiSrc/constants' import { apiService } from 'uiSrc/services' import { isStatusSuccessful, Nullable } from 'uiSrc/utils' diff --git a/redisinsight/ui/src/slices/analytics/clusterDetails.ts b/redisinsight/ui/src/slices/analytics/clusterDetails.ts index f43264e64a..4796b2c076 100644 --- a/redisinsight/ui/src/slices/analytics/clusterDetails.ts +++ b/redisinsight/ui/src/slices/analytics/clusterDetails.ts @@ -2,11 +2,11 @@ import { createSlice, PayloadAction } from '@reduxjs/toolkit' import { AxiosError } from 'axios' import { ApiEndpoints } from 'uiSrc/constants' import { apiService } from 'uiSrc/services' -import { addErrorNotification } from 'uiSrc/slices/app/notifications' +import { addErrorNotification, IAddInstanceErrorPayload } from 'uiSrc/slices/app/notifications' import { StateClusterDetails } from 'uiSrc/slices/interfaces/analytics' import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils' -import { ClusterDetails } from 'apiSrc/modules/cluster-monitor/models/cluster-details' +import { ClusterDetails } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' export const initialState: StateClusterDetails = { @@ -72,7 +72,7 @@ export function fetchClusterDetailsAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getClusterDetailsError(errorMessage)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/analytics/dbAnalysis.ts b/redisinsight/ui/src/slices/analytics/dbAnalysis.ts index d029c86609..0e595cac7d 100644 --- a/redisinsight/ui/src/slices/analytics/dbAnalysis.ts +++ b/redisinsight/ui/src/slices/analytics/dbAnalysis.ts @@ -3,7 +3,7 @@ import { AxiosError } from 'axios' import { ApiEndpoints } from 'uiSrc/constants' import { Vote } from 'uiSrc/constants/recommendations' import { apiService } from 'uiSrc/services' -import { addErrorNotification } from 'uiSrc/slices/app/notifications' +import { addErrorNotification, IAddInstanceErrorPayload } from 'uiSrc/slices/app/notifications' import { StateDatabaseAnalysis, DatabaseAnalysisViewTab, @@ -12,7 +12,7 @@ import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils' import { DatabaseAnalysis, ShortDatabaseAnalysis, -} from 'apiSrc/modules/database-analysis/models' +} from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' @@ -139,7 +139,7 @@ export function fetchDBAnalysisAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getDBAnalysisError(errorMessage)) onFailAction?.() } @@ -176,7 +176,7 @@ export function putRecommendationVote( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(setRecommendationVoteError(errorMessage)) onFailAction?.() } @@ -204,7 +204,7 @@ export function fetchDBAnalysisReportsHistory( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadDBAnalysisReportsError(errorMessage)) onFailAction?.() } @@ -237,7 +237,7 @@ export function createNewAnalysis( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getDBAnalysisError(errorMessage)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/analytics/slowlog.ts b/redisinsight/ui/src/slices/analytics/slowlog.ts index 818bdbc4d0..ca69fc91f4 100644 --- a/redisinsight/ui/src/slices/analytics/slowlog.ts +++ b/redisinsight/ui/src/slices/analytics/slowlog.ts @@ -3,10 +3,10 @@ import { AxiosError } from 'axios' import { ApiEndpoints, DurationUnits } from 'uiSrc/constants' import { apiService } from 'uiSrc/services' import { setSlowLogUnits } from 'uiSrc/slices/app/context' -import { addErrorNotification } from 'uiSrc/slices/app/notifications' +import { addErrorNotification, IAddInstanceErrorPayload } from 'uiSrc/slices/app/notifications' import { StateSlowLog } from 'uiSrc/slices/interfaces/analytics' import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils' -import { SlowLog, SlowLogConfig } from 'apiSrc/modules/slow-log/models' +import { SlowLog, SlowLogConfig } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' @@ -112,7 +112,7 @@ export function fetchSlowLogsAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getSlowLogsError(errorMessage)) onFailAction?.() } @@ -141,7 +141,7 @@ export function clearSlowLogAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(deleteSlowLogsError(errorMessage)) onFailAction?.() } @@ -170,7 +170,7 @@ export function getSlowLogConfigAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getSlowLogConfigError(errorMessage)) onFailAction?.() } @@ -203,7 +203,7 @@ export function patchSlowLogConfigAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getSlowLogConfigError(errorMessage)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/app/info.ts b/redisinsight/ui/src/slices/app/info.ts index 8416686f7c..0fe657eb24 100644 --- a/redisinsight/ui/src/slices/app/info.ts +++ b/redisinsight/ui/src/slices/app/info.ts @@ -2,7 +2,7 @@ import { createSlice, PayloadAction } from '@reduxjs/toolkit' import { apiService } from 'uiSrc/services' import { ApiEndpoints } from 'uiSrc/constants' import { getApiErrorMessage, isStatusSuccessful } from 'uiSrc/utils' -import { GetServerInfoResponse } from 'apiSrc/modules/server/dto/server.dto' +import { GetServerInfoResponse } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { RedisResponseEncoding, StateAppInfo } from '../interfaces' diff --git a/redisinsight/ui/src/slices/app/notifications.ts b/redisinsight/ui/src/slices/app/notifications.ts index 5e70d6c9a0..1aeb420a79 100644 --- a/redisinsight/ui/src/slices/app/notifications.ts +++ b/redisinsight/ui/src/slices/app/notifications.ts @@ -10,7 +10,7 @@ import { Maybe, Nullable, } from 'uiSrc/utils' -import { NotificationsDto } from 'apiSrc/modules/notification/dto' +import { NotificationsDto } from 'uiSrc/api-client' import { IError, IGlobalNotification, diff --git a/redisinsight/ui/src/slices/app/plugins.ts b/redisinsight/ui/src/slices/app/plugins.ts index 40c69c4018..4c5fe2a4d2 100644 --- a/redisinsight/ui/src/slices/app/plugins.ts +++ b/redisinsight/ui/src/slices/app/plugins.ts @@ -15,8 +15,7 @@ import { PluginsResponse, StateAppPlugins, } from 'uiSrc/slices/interfaces' -import { SendCommandResponse } from 'apiSrc/modules/cli/dto/cli.dto' -import { PluginState } from 'apiSrc/modules/workbench/models/plugin-state' +import { SendCommandResponse, PluginState } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' diff --git a/redisinsight/ui/src/slices/app/redis-commands.ts b/redisinsight/ui/src/slices/app/redis-commands.ts index 5c691cec9d..98f1d43b26 100644 --- a/redisinsight/ui/src/slices/app/redis-commands.ts +++ b/redisinsight/ui/src/slices/app/redis-commands.ts @@ -8,7 +8,7 @@ import { checkDeprecatedCommandGroup, } from 'uiSrc/utils' import { getConfig } from 'uiSrc/config' -import { GetServerInfoResponse } from 'apiSrc/modules/server/dto/server.dto' +import { GetServerInfoResponse } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { StateAppRedisCommands } from '../interfaces' diff --git a/redisinsight/ui/src/slices/browser/hash.ts b/redisinsight/ui/src/slices/browser/hash.ts index 8d283eba33..f11c4b19fb 100644 --- a/redisinsight/ui/src/slices/browser/hash.ts +++ b/redisinsight/ui/src/slices/browser/hash.ts @@ -21,7 +21,7 @@ import { GetHashFieldsResponse, AddFieldsToHashDto, UpdateHashFieldsTtlDto, -} from 'apiSrc/modules/browser/hash/dto' +} from 'uiSrc/api-client' import { deleteKeyFromList, deleteSelectedKeySuccess, @@ -34,6 +34,7 @@ import { HashField, RedisResponseBuffer, StateHash } from '../interfaces' import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../app/notifications' export const initialState: StateHash = { @@ -258,8 +259,8 @@ export function fetchHashFields( onSuccess?.(data) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadHashFieldsFailure(errorMessage)) } } @@ -295,7 +296,7 @@ export function refreshHashFieldsAction( dispatch(loadHashFieldsSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) dispatch(loadHashFieldsFailure(errorMessage)) } } @@ -332,8 +333,8 @@ export function fetchMoreHashFields( dispatch(loadMoreHashFieldsSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadMoreHashFieldsFailure(errorMessage)) } } @@ -386,8 +387,8 @@ export function deleteHashFields( } } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(removeHashFieldsFailure(errorMessage)) } } @@ -423,8 +424,8 @@ export function addHashFieldsAction( if (onFailAction) { onFailAction() } - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateValueFailure(errorMessage)) } } @@ -467,8 +468,8 @@ export function updateHashFieldsAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateValueFailure(errorMessage)) onFailAction?.() } @@ -531,8 +532,8 @@ export function updateHashTTLAction( dispatch(updateFieldsInList(data.fields as any)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateValueFailure(errorMessage)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/browser/keys.ts b/redisinsight/ui/src/slices/browser/keys.ts index bb09aec495..616b171a48 100644 --- a/redisinsight/ui/src/slices/browser/keys.ts +++ b/redisinsight/ui/src/slices/browser/keys.ts @@ -43,17 +43,17 @@ import { setBrowserSelectedKey, } from 'uiSrc/slices/app/context' -import { CreateListWithExpireDto } from 'apiSrc/modules/browser/list/dto' -import { SetStringWithExpireDto } from 'apiSrc/modules/browser/string/dto' -import { CreateZSetWithExpireDto } from 'apiSrc/modules/browser/z-set/dto' -import { CreateHashWithExpireDto } from 'apiSrc/modules/browser/hash/dto' -import { CreateRejsonRlWithExpireDto } from 'apiSrc/modules/browser/rejson-rl/dto' -import { CreateSetWithExpireDto } from 'apiSrc/modules/browser/set/dto' import { + CreateListWithExpireDto, + SetStringWithExpireDto, + CreateZSetWithExpireDto, + CreateHashWithExpireDto, + CreateRejsonRlWithExpireDto, + CreateSetWithExpireDto, GetKeyInfoResponse, GetKeysWithDetailsResponse, -} from 'apiSrc/modules/browser/keys/dto' -import { CreateStreamDto } from 'apiSrc/modules/browser/stream/dto' + CreateStreamDto, +} from 'uiSrc/api-client' import { fetchString } from './string' import { @@ -117,6 +117,7 @@ export const initialState: KeysStore = { isSearched: false, isFiltered: false, isBrowserFullScreen: false, + shownColumns: [], searchMode: localStorageService?.get(BrowserStorageItem.browserSearchMode) ?? SearchMode.Pattern, diff --git a/redisinsight/ui/src/slices/browser/list.ts b/redisinsight/ui/src/slices/browser/list.ts index b917215a2d..d5d413c243 100644 --- a/redisinsight/ui/src/slices/browser/list.ts +++ b/redisinsight/ui/src/slices/browser/list.ts @@ -21,12 +21,12 @@ import { SCAN_COUNT_DEFAULT } from 'uiSrc/constants/api' import { SetListElementDto, GetListElementsResponse, - GetListElementResponse, SetListElementResponse, PushElementToListDto, DeleteListElementsDto, + GetListElementResponse, DeleteListElementsResponse, -} from 'apiSrc/modules/browser/list/dto' +} from 'uiSrc/api-client' import { refreshKeyInfoAction, fetchKeyInfo, @@ -39,6 +39,7 @@ import { AppDispatch, RootState } from '../store' import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../app/notifications' import { RedisResponseBuffer } from '../interfaces' @@ -86,6 +87,7 @@ const listSlice = createSlice({ state.data = { ...state.data, ...payload, + // @ts-expect-error type mismatch elements: payload.elements.map((element, i) => ({ index: i, element })), key: payload.keyName, } @@ -110,6 +112,7 @@ const listSlice = createSlice({ const listIndex = state.data?.elements?.length state.data.elements = state.data?.elements?.concat( + // @ts-expect-error type mismatch elements.map((element, i) => ({ index: listIndex + i, element })), ) }, @@ -138,7 +141,7 @@ const listSlice = createSlice({ }: PayloadAction<[number, GetListElementResponse]>, ) => { state.loading = false - + // @ts-expect-error type mismatch state.data.elements = [{ index, element: data?.value }] }, loadSearchingListElementFailure: (state, { payload }) => { @@ -174,6 +177,7 @@ const listSlice = createSlice({ state, { payload }: { payload: SetListElementDto }, ) => { + // @ts-expect-error type mismatch state.data.elements[ state.data.elements.length === 1 ? 0 : payload.index ] = payload @@ -272,8 +276,8 @@ export function fetchListElements( dispatch(updateSelectedKeyRefreshTime(Date.now())) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadListElementsFailure(errorMessage)) } } @@ -308,8 +312,8 @@ export function fetchMoreListElements( dispatch(loadMoreListElementsSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadMoreListElementsFailure(errorMessage)) } } @@ -341,13 +345,13 @@ export function fetchSearchingListElementAction( ) if (isStatusSuccessful(status)) { - dispatch(loadSearchingListElementSuccess([index, data])) + dispatch(loadSearchingListElementSuccess([index as number, data])) dispatch(updateSelectedKeyRefreshTime(Date.now())) onSuccess?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadSearchingListElementFailure(errorMessage)) } } @@ -407,8 +411,8 @@ export function updateListElementAction( dispatch(refreshKeyInfoAction(data.keyName)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateValueFailure(errorMessage)) onFailAction?.() @@ -441,8 +445,8 @@ export function insertListElementsAction( dispatch(fetchKeyInfo(data.keyName)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(insertListElementsFailure(errorMessage)) onFailAction?.() @@ -494,8 +498,8 @@ export function deleteListElementsAction( } } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(deleteListElementsFailure(errorMessage)) onFailAction?.() diff --git a/redisinsight/ui/src/slices/browser/redisearch.ts b/redisinsight/ui/src/slices/browser/redisearch.ts index 4e5a5a034c..db31ce743f 100644 --- a/redisinsight/ui/src/slices/browser/redisearch.ts +++ b/redisinsight/ui/src/slices/browser/redisearch.ts @@ -20,11 +20,11 @@ import ApiErrors from 'uiSrc/constants/apiErrors' import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry' import { SearchHistoryItem } from 'uiSrc/slices/interfaces/keys' -import { GetKeysWithDetailsResponse } from 'apiSrc/modules/browser/keys/dto' import { + GetKeysWithDetailsResponse, CreateRedisearchIndexDto, ListRedisearchIndexesResponse, -} from 'apiSrc/modules/browser/redisearch/dto' +} from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { RedisResponseBuffer, StateRedisearch } from '../interfaces' diff --git a/redisinsight/ui/src/slices/browser/rejson.ts b/redisinsight/ui/src/slices/browser/rejson.ts index ef7e49ddb3..125784d39e 100644 --- a/redisinsight/ui/src/slices/browser/rejson.ts +++ b/redisinsight/ui/src/slices/browser/rejson.ts @@ -22,7 +22,7 @@ import { parseJsonData } from 'uiSrc/pages/browser/modules/key-details/component import { GetRejsonRlResponseDto, RemoveRejsonRlResponse, -} from 'apiSrc/modules/browser/rejson-rl/dto' +} from 'uiSrc/api-client' import { refreshKeyInfoAction } from './keys' import { @@ -33,6 +33,7 @@ import { import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../app/notifications' import { AppDispatch, RootState } from '../store' @@ -44,7 +45,7 @@ export const initialState: InitialStateRejson = { error: null, data: { downloaded: false, - data: undefined, + data: null, type: '', }, editorType: EditorType.Default, @@ -200,7 +201,7 @@ export function fetchReJSON( if (!axios.isCancel(error)) { const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(loadRejsonBranchFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -211,7 +212,7 @@ export function setReJSONDataAction( key: RedisResponseBuffer, path: string, data: string, - isEditMode: boolean, + isEditMode?: boolean, length?: number, onSuccessAction?: () => void, onFailAction?: () => void, @@ -266,9 +267,9 @@ export function setReJSONDataAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) dispatch(setReJSONDataFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) onFailAction?.() } } @@ -316,9 +317,9 @@ export function appendReJSONArrayItemAction( dispatch(refreshKeyInfoAction(key)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) dispatch(appendReJSONArrayItemFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -372,7 +373,7 @@ export function removeReJSONKeyAction( } catch (error) { const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(removeRejsonKeyFailure(errorMessage)) - dispatch(addErrorNotification(error as AxiosError)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } diff --git a/redisinsight/ui/src/slices/browser/set.ts b/redisinsight/ui/src/slices/browser/set.ts index 6e44602528..a0289bc07c 100644 --- a/redisinsight/ui/src/slices/browser/set.ts +++ b/redisinsight/ui/src/slices/browser/set.ts @@ -14,10 +14,7 @@ import { import successMessages from 'uiSrc/components/notifications/success-messages' import { SCAN_COUNT_DEFAULT } from 'uiSrc/constants/api' -import { - AddMembersToSetDto, - GetSetMembersResponse, -} from 'apiSrc/modules/browser/set/dto' +import { AddMembersToSetDto, GetSetMembersResponse } from 'uiSrc/api-client' import { deleteKeyFromList, deleteSelectedKeySuccess, @@ -30,6 +27,7 @@ import { InitialStateSet, RedisResponseBuffer } from '../interfaces' import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../app/notifications' export const initialState: InitialStateSet = { @@ -139,9 +137,12 @@ const setSlice = createSlice({ { payload }: { payload: RedisResponseBuffer[] }, ) => { remove( + // @ts-ignore state.data?.members, (member: { data: any[] }) => - payload.findIndex((item) => isEqualBuffers(item, member)) > -1, + payload.findIndex((item) => + isEqualBuffers(item, member as RedisResponseBuffer), + ) > -1, ) state.data = { @@ -212,8 +213,8 @@ export function fetchSetMembers( onSuccess?.(data) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadSetMembersFailure(errorMessage)) } } @@ -250,8 +251,8 @@ export function fetchMoreSetMembers( dispatch(loadMoreSetMembersSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadMoreSetMembersFailure(errorMessage)) } } @@ -288,8 +289,8 @@ export function refreshSetMembersAction( dispatch(loadSetMembersSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadSetMembersFailure(errorMessage)) } } @@ -322,8 +323,8 @@ export function addSetMembersAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(addSetMembersFailure(errorMessage)) onFailAction?.() } @@ -380,8 +381,8 @@ export function deleteSetMembers( } } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(removeSetMembersFailure(errorMessage)) } } diff --git a/redisinsight/ui/src/slices/browser/stream.ts b/redisinsight/ui/src/slices/browser/stream.ts index 8b6176d6dc..73a55b8790 100644 --- a/redisinsight/ui/src/slices/browser/stream.ts +++ b/redisinsight/ui/src/slices/browser/stream.ts @@ -33,7 +33,7 @@ import { ClaimPendingEntryDto, ClaimPendingEntriesResponse, AckPendingEntriesResponse, -} from 'apiSrc/modules/browser/stream/dto' +} from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { StateStream, StreamViewType } from '../interfaces/stream' import { diff --git a/redisinsight/ui/src/slices/browser/zset.ts b/redisinsight/ui/src/slices/browser/zset.ts index c63414bf46..6b7a510212 100644 --- a/redisinsight/ui/src/slices/browser/zset.ts +++ b/redisinsight/ui/src/slices/browser/zset.ts @@ -24,7 +24,7 @@ import { SearchZSetMembersResponse, ZSetMemberDto, GetZSetResponse, -} from 'apiSrc/modules/browser/z-set/dto' +} from 'uiSrc/api-client' import { deleteKeyFromList, deleteSelectedKeySuccess, @@ -36,6 +36,7 @@ import { AppDispatch, RootState } from '../store' import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../app/notifications' import { RedisResponseBuffer } from '../interfaces' @@ -284,8 +285,8 @@ export function fetchZSetMembers( dispatch(updateSelectedKeyRefreshTime(Date.now())) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadZSetMembersFailure(errorMessage)) } } @@ -322,8 +323,8 @@ export function fetchMoreZSetMembers( dispatch(loadMoreZSetMembersSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadMoreZSetMembersFailure(errorMessage)) } } @@ -366,8 +367,8 @@ export function fetchAddZSetMembers( } } catch (error) { onFailAction?.() - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateScoreFailure(errorMessage)) } } @@ -420,8 +421,8 @@ export function deleteZSetMembers( } } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(removeZsetMembersFailure(errorMessage)) } } @@ -464,8 +465,8 @@ export function updateZSetMembers( } } catch (error) { onFailAction?.() - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateScoreFailure(errorMessage)) } } @@ -503,8 +504,8 @@ export function fetchSearchZSetMembers( onSuccess?.(data) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(searchZSetMembersFailure(errorMessage)) } } @@ -539,8 +540,8 @@ export function fetchSearchMoreZSetMembers( dispatch(searchMoreZSetMembersSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(searchMoreZSetMembersFailure(errorMessage)) } } @@ -578,14 +579,16 @@ export function refreshZsetMembersAction( dispatch(searchZSetMembersSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage( + error as IAddInstanceErrorPayload, + ) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(searchZSetMembersFailure(errorMessage)) } return } const { sortOrder } = state.browser.zset.data - dispatch(loadZSetMembers([sortOrder, resetData])) + dispatch(loadZSetMembers([sortOrder as any, resetData])) try { const state = stateInit() @@ -608,8 +611,8 @@ export function refreshZsetMembersAction( dispatch(loadZSetMembersSuccess(data)) } } catch (error) { - const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + const errorMessage = getApiErrorMessage(error as IAddInstanceErrorPayload) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(loadZSetMembersFailure(errorMessage)) } } diff --git a/redisinsight/ui/src/slices/cli/cli-output.ts b/redisinsight/ui/src/slices/cli/cli-output.ts index 660905bb41..f390cae78d 100644 --- a/redisinsight/ui/src/slices/cli/cli-output.ts +++ b/redisinsight/ui/src/slices/cli/cli-output.ts @@ -12,7 +12,7 @@ import { SelectCommand, CliOutputFormatterType, } from 'uiSrc/constants/cliOutput' -import { SendCommandResponse } from 'apiSrc/modules/cli/dto/cli.dto' +import { SendCommandResponse } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { CommandExecutionStatus, StateCliOutput } from '../interfaces/cli' diff --git a/redisinsight/ui/src/slices/cli/cli-settings.ts b/redisinsight/ui/src/slices/cli/cli-settings.ts index 68fd7df9a2..6635604f51 100644 --- a/redisinsight/ui/src/slices/cli/cli-settings.ts +++ b/redisinsight/ui/src/slices/cli/cli-settings.ts @@ -1,13 +1,11 @@ import { createSlice } from '@reduxjs/toolkit' +import { AxiosError } from 'axios' import { apiService, sessionStorageService } from 'uiSrc/services' import { ApiEndpoints, BrowserStorageItem } from 'uiSrc/constants' import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils' import { setCliDbIndex } from 'uiSrc/slices/cli/cli-output' -import { - CreateCliClientResponse, - DeleteClientResponse, -} from 'apiSrc/modules/cli/dto/cli.dto' +import { CreateCliClientResponse, DeleteClientResponse } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { StateCliSettings } from '../interfaces/cli' @@ -222,7 +220,7 @@ export function createCliClientAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(processCliClientFailure(errorMessage)) onFailAction?.(errorMessage) } @@ -258,7 +256,7 @@ export function updateCliClientAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(processCliClientFailure(errorMessage)) onFailAction?.(errorMessage) } @@ -285,7 +283,7 @@ export function deleteCliClientAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(processCliClientFailure(errorMessage)) onFailAction?.() } @@ -330,7 +328,7 @@ export function fetchBlockingCliCommandsAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(processCliClientFailure(errorMessage)) onFailAction?.() } @@ -355,7 +353,7 @@ export function fetchUnsupportedCliCommandsAction( onSuccessAction?.() } } catch (error) { - const errorMessage = getApiErrorMessage(error) + const errorMessage = getApiErrorMessage(error as AxiosError) dispatch(processCliClientFailure(errorMessage)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/instances/cloud.ts b/redisinsight/ui/src/slices/instances/cloud.ts index d021d37f42..c534a55ae6 100644 --- a/redisinsight/ui/src/slices/instances/cloud.ts +++ b/redisinsight/ui/src/slices/instances/cloud.ts @@ -20,7 +20,10 @@ import { LoadedCloud, OAuthSocialAction, } from '../interfaces' -import { addErrorNotification } from '../app/notifications' +import { + addErrorNotification, + IAddInstanceErrorPayload, +} from '../app/notifications' import { AppDispatch, RootState } from '../store' export const initialState: InitialStateCloud = { @@ -236,7 +239,7 @@ export function fetchSubscriptionsRedisCloud( const err = getAxiosError(error as EnhancedAxiosError) dispatch(loadSubscriptionsRedisCloudFailure(errorMessage)) - dispatch(addErrorNotification(err)) + dispatch(addErrorNotification(err as IAddInstanceErrorPayload)) onFailAction?.() } } @@ -270,7 +273,7 @@ export function fetchAccountRedisCloud( const err = getAxiosError(error as EnhancedAxiosError) dispatch(loadAccountRedisCloudFailure(errorMessage)) - dispatch(addErrorNotification(err)) + dispatch(addErrorNotification(err as IAddInstanceErrorPayload)) } } } @@ -311,7 +314,7 @@ export function fetchInstancesRedisCloud( const err = getAxiosError(error as EnhancedAxiosError) dispatch(loadInstancesRedisCloudFailure(errorMessage)) - dispatch(addErrorNotification(err)) + dispatch(addErrorNotification(err as IAddInstanceErrorPayload)) } } } @@ -351,7 +354,11 @@ export function addInstancesRedisCloud( ...ApiEncryptionErrors, ) if (encryptionErrors.length) { - dispatch(addErrorNotification(encryptionErrors[0])) + dispatch( + addErrorNotification( + encryptionErrors[0] as IAddInstanceErrorPayload, + ), + ) } dispatch(createInstancesRedisCloudSuccess(data)) } @@ -360,7 +367,7 @@ export function addInstancesRedisCloud( const err = getAxiosError(error as EnhancedAxiosError) dispatch(createInstancesRedisCloudFailure(errorMessage)) - dispatch(addErrorNotification(err)) + dispatch(addErrorNotification(err as IAddInstanceErrorPayload)) } } } diff --git a/redisinsight/ui/src/slices/instances/instances.ts b/redisinsight/ui/src/slices/instances/instances.ts index b2369bcaa8..bb17c58b52 100644 --- a/redisinsight/ui/src/slices/instances/instances.ts +++ b/redisinsight/ui/src/slices/instances/instances.ts @@ -22,9 +22,11 @@ import { INFINITE_MESSAGES, InfiniteMessagesIds, } from 'uiSrc/components/notifications/components' -import { Database as DatabaseInstanceResponse } from 'apiSrc/modules/database/models/database' -import { RedisNodeInfoResponse } from 'apiSrc/modules/database/dto/redis-info.dto' -import { ExportDatabase } from 'apiSrc/modules/database/models/export-database' +import { + Database as DatabaseInstanceResponse, + RedisNodeInfoResponse, + ExportDatabase, +} from 'uiSrc/api-client' import { fetchMastersSentinelAction } from './sentinel' import { fetchTags } from './tags' @@ -33,6 +35,7 @@ import { addErrorNotification, addInfiniteNotification, addMessageNotification, + IAddInstanceErrorPayload, removeInfiniteNotification, } from '../app/notifications' import { ConnectionType, InitialStateInstances, Instance } from '../interfaces' @@ -55,7 +58,7 @@ export const initialState: InitialStateInstances = { port: 0, version: '', nameFromProvider: '', - lastConnection: new Date(), + lastConnection: new Date().toString(), connectionType: ConnectionType.Standalone, isRediStack: false, modules: [], @@ -397,7 +400,7 @@ export function fetchInstancesAction(onSuccess?: (data: Instance[]) => void) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(loadInstancesFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) localStorageService.set(BrowserStorageItem.instancesCount, '0') } @@ -461,12 +464,13 @@ export function createInstanceStandaloneAction( dispatch(defaultInstanceChangingFailure(errorMessage)) + // @ts-ignore if (error?.response?.data?.error === ApiErrors.SentinelParamsRequired) { checkoutToSentinelFlow(payload, dispatch, onRedirectToSentinel) return } - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -512,7 +516,7 @@ export function autoCreateAndConnectToInstanceAction( ) return } - dispatch(addErrorNotification(error as AxiosError)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(removeInfiniteNotification(InfiniteMessagesIds.autoCreateDb)) } } @@ -590,7 +594,7 @@ export function updateInstanceAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(defaultInstanceChangingFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -621,7 +625,7 @@ export function cloneInstanceAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(defaultInstanceChangingFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -669,7 +673,7 @@ export function deleteInstancesAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -696,7 +700,7 @@ export function exportInstancesAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) onFail?.() } } @@ -724,7 +728,7 @@ export function fetchConnectedInstanceAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) onFail?.() } } @@ -777,7 +781,7 @@ export function fetchEditedInstanceAction( dispatch(setEditedInstance(null)) dispatch(setConnectedInstanceFailure()) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -803,7 +807,12 @@ export function checkConnectToInstanceAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification({ ...error, instanceId: id })) + dispatch( + addErrorNotification({ + ...error, + instanceId: id, + } as IAddInstanceErrorPayload), + ) onFailAction?.() } } @@ -894,7 +903,7 @@ export function checkDatabaseIndexAction( } catch (_err) { const error = _err as AxiosError dispatch(checkDatabaseIndexFailure()) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) onFailAction?.() } } @@ -953,8 +962,10 @@ export function testInstanceStandaloneAction( dispatch(testConnectionFailure(errorMessage)) + // @ts-ignore if (error?.response?.data?.error === ApiErrors.SentinelParamsRequired) { checkoutToSentinelFlow( + // @ts-expect-error { id, ...payload }, dispatch, onRedirectToSentinel, @@ -962,7 +973,7 @@ export function testInstanceStandaloneAction( return } - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } diff --git a/redisinsight/ui/src/slices/instances/sentinel.ts b/redisinsight/ui/src/slices/instances/sentinel.ts index 19edbd9ede..483939072f 100644 --- a/redisinsight/ui/src/slices/instances/sentinel.ts +++ b/redisinsight/ui/src/slices/instances/sentinel.ts @@ -13,9 +13,11 @@ import { apiService } from 'uiSrc/services' import { ApiEndpoints } from 'uiSrc/constants' import { ApiEncryptionErrors } from 'uiSrc/constants/apiErrors' -import { SentinelMaster } from 'apiSrc/modules/redis-sentinel/models/sentinel-master' -import { CreateSentinelDatabasesDto } from 'apiSrc/modules/redis-sentinel/dto/create.sentinel.databases.dto' -import { CreateSentinelDatabaseResponse } from 'apiSrc/modules/redis-sentinel/dto/create.sentinel.database.response' +import { + SentinelMaster, + CreateSentinelDatabaseResponse, + CreateSentinelDatabaseDto, +} from 'uiSrc/api-client' import { AddRedisDatabaseStatus, InitialStateSentinel, @@ -24,7 +26,10 @@ import { ModifiedSentinelMaster, } from '../interfaces' import { AppDispatch, RootState } from '../store' -import { addErrorNotification } from '../app/notifications' +import { + addErrorNotification, + IAddInstanceErrorPayload, +} from '../app/notifications' export const initialState: InitialStateSentinel = { loading: false, @@ -83,7 +88,7 @@ const sentinelSlice = createSlice({ }, createMastersSentinelSuccess: ( state, - { payload }: { payload: CreateSentinelDatabasesDto[] }, + { payload }: { payload: CreateSentinelDatabaseResponse[] }, ) => { state.loading = false @@ -155,7 +160,7 @@ export function fetchMastersSentinelAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(loadMastersSentinelFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) onFailAction?.() } @@ -164,7 +169,7 @@ export function fetchMastersSentinelAction( // Asynchronous thunk action export function createMastersSentinelAction( - payload: CreateSentinelDatabasesDto, + payload: CreateSentinelDatabaseDto[], onSuccessAction?: () => void, onFailAction?: () => void, ) { @@ -183,11 +188,16 @@ export function createMastersSentinelAction( if (isStatusSuccessful(status)) { const encryptionErrors = getApiErrorsFromBulkOperation( + // @ts-ignore data, ...ApiEncryptionErrors, ) if (encryptionErrors.length) { - dispatch(addErrorNotification(encryptionErrors[0])) + dispatch( + addErrorNotification( + encryptionErrors[0] as IAddInstanceErrorPayload, + ), + ) } dispatch(createMastersSentinelSuccess(data)) @@ -197,7 +207,7 @@ export function createMastersSentinelAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(createMastersSentinelFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/interfaces/analytics.ts b/redisinsight/ui/src/slices/interfaces/analytics.ts index 44bf42a897..fe7ad79b59 100644 --- a/redisinsight/ui/src/slices/interfaces/analytics.ts +++ b/redisinsight/ui/src/slices/interfaces/analytics.ts @@ -1,10 +1,11 @@ import { Nullable } from 'uiSrc/utils' -import { SlowLog, SlowLogConfig } from 'apiSrc/modules/slow-log/models' -import { ClusterDetails } from 'apiSrc/modules/cluster-monitor/models/cluster-details' import { + SlowLog, + SlowLogConfig, + ClusterDetails, DatabaseAnalysis, ShortDatabaseAnalysis, -} from 'apiSrc/modules/database-analysis/models' +} from 'uiSrc/api-client' export interface StateSlowLog { loading: boolean diff --git a/redisinsight/ui/src/slices/interfaces/api.ts b/redisinsight/ui/src/slices/interfaces/api.ts index 4f59053d86..cf3ec8ad50 100644 --- a/redisinsight/ui/src/slices/interfaces/api.ts +++ b/redisinsight/ui/src/slices/interfaces/api.ts @@ -1,6 +1,8 @@ -import { CreateCommandExecutionDto as CreateCommandExecutionDtoAPI } from 'apiSrc/modules/workbench/dto/create-command-execution.dto' -import { CommandExecution as CommandExecutionAPI } from 'apiSrc/modules/workbench/models/command-execution' -import { CommandExecutionResult as CommandExecutionResultAPI } from 'apiSrc/modules/workbench/models/command-execution-result' +import { + CreateCommandExecutionDto as CreateCommandExecutionDtoAPI, + CommandExecution as CommandExecutionAPI, + CommandExecutionResult as CommandExecutionResultAPI, +} from 'uiSrc/api-client' interface CreateCommandExecutionDto extends CreateCommandExecutionDtoAPI {} interface CommandExecution extends CommandExecutionAPI {} diff --git a/redisinsight/ui/src/slices/interfaces/app.ts b/redisinsight/ui/src/slices/interfaces/app.ts index 76bbe0a683..cd0e32ff16 100644 --- a/redisinsight/ui/src/slices/interfaces/app.ts +++ b/redisinsight/ui/src/slices/interfaces/app.ts @@ -11,8 +11,11 @@ import { SortOrder, } from 'uiSrc/constants' import { ConfigDBStorageItem } from 'uiSrc/constants/storage' -import { GetServerInfoResponse } from 'apiSrc/modules/server/dto/server.dto' -import { RedisString as RedisStringAPI } from 'apiSrc/common/constants/redis-string' +import { + GetServerInfoResponse, + CreateListWithExpireDtoKeyName, + CreateListWithExpireDtoKeyNameOneOfTypeEnum, +} from 'uiSrc/api-client' export interface CustomError { details?: any[] @@ -275,15 +278,13 @@ export enum RedisResponseEncoding { Buffer = 'buffer', } -export enum RedisResponseBufferType { - Buffer = 'Buffer', -} +export const RedisResponseBufferType = + CreateListWithExpireDtoKeyNameOneOfTypeEnum + +type RedisStringAPI = CreateListWithExpireDtoKeyName -export type RedisResponseBuffer = { - type: RedisResponseBufferType - data: UintArray -} & Exclude +export type RedisResponseBuffer = RedisStringAPI // Exclude -export type RedisString = string | RedisResponseBuffer +export type RedisString = RedisStringAPI export type UintArray = number[] | Uint8Array diff --git a/redisinsight/ui/src/slices/interfaces/bulkActions.ts b/redisinsight/ui/src/slices/interfaces/bulkActions.ts index 8b3fbd5570..7cb8fdd1cd 100644 --- a/redisinsight/ui/src/slices/interfaces/bulkActions.ts +++ b/redisinsight/ui/src/slices/interfaces/bulkActions.ts @@ -1,6 +1,34 @@ import { BulkActionsStatus, BulkActionsType } from 'uiSrc/constants' import { Nullable } from 'uiSrc/utils' -import { IBulkActionOverview as IBulkActionOverviewBE } from 'apiSrc/modules/bulk-actions/interfaces/bulk-action-overview.interface' + +interface IBulkActionProgressOverview { + total: number + scanned: number +} + +interface IBulkActionSummaryOverview { + processed: number + succeed: number + failed: number + errors: Array> + keys: Array +} + +interface IBulkActionFilterOverview { + type: string + match: string +} + +interface IBulkActionOverviewBE { + id: string + databaseId: string + duration: number + type: string + status: string + filter: IBulkActionFilterOverview + progress: IBulkActionProgressOverview + summary: IBulkActionSummaryOverview +} export interface IBulkActionOverview extends Omit { diff --git a/redisinsight/ui/src/slices/interfaces/cli.ts b/redisinsight/ui/src/slices/interfaces/cli.ts index 3575c80b39..9956801579 100644 --- a/redisinsight/ui/src/slices/interfaces/cli.ts +++ b/redisinsight/ui/src/slices/interfaces/cli.ts @@ -1,7 +1,4 @@ -export enum CommandExecutionStatus { - Success = 'success', - Fail = 'fail', -} +export { SendCommandResponseStatusEnum as CommandExecutionStatus } from 'uiSrc/api-client' export enum ClusterNodeRole { All = 'ALL', diff --git a/redisinsight/ui/src/slices/interfaces/cloud.ts b/redisinsight/ui/src/slices/interfaces/cloud.ts index fa525ed346..dc4b194290 100644 --- a/redisinsight/ui/src/slices/interfaces/cloud.ts +++ b/redisinsight/ui/src/slices/interfaces/cloud.ts @@ -2,9 +2,12 @@ import { Nullable } from 'uiSrc/utils' import { Instance } from 'uiSrc/slices/interfaces/instances' import { OAuthProvider } from 'uiSrc/components/oauth/oauth-select-plan/constants' -import { CloudJobInfo, CloudJobStatus } from 'apiSrc/modules/cloud/job/models' -import { CloudUser } from 'apiSrc/modules/cloud/user/models' -import { CloudSubscriptionPlanResponse } from 'apiSrc/modules/cloud/subscription/dto' +import { + CloudJobInfo, + CloudSubscriptionPlanResponse, + CloudUser, + CloudJobInfoStatusEnum as CloudJobStatus, +} from 'uiSrc/api-client' export interface CloudJobInfoState extends Omit { status: '' | CloudJobStatus diff --git a/redisinsight/ui/src/slices/interfaces/instances.ts b/redisinsight/ui/src/slices/interfaces/instances.ts index fab13a7bb4..ab00e9f798 100644 --- a/redisinsight/ui/src/slices/interfaces/instances.ts +++ b/redisinsight/ui/src/slices/interfaces/instances.ts @@ -2,81 +2,32 @@ import { RedisResponseBuffer, RedisString } from 'uiSrc/slices/interfaces/app' import { Maybe, Nullable } from 'uiSrc/utils' import { OAuthSocialAction } from 'uiSrc/slices/interfaces/cloud' import { DatabaseListColumn } from 'uiSrc/constants' -import { GetHashFieldsResponse } from 'apiSrc/modules/browser/hash/dto' -import { GetSetMembersResponse } from 'apiSrc/modules/browser/set/dto' import { + CreateSentinelDatabaseDto, + CreateSentinelDatabaseResponse, + GetHashFieldsResponse, + GetSetMembersResponse, + RedisNodeInfoResponse, GetRejsonRlResponseDto, - SafeRejsonRlDataDto, -} from 'apiSrc/modules/browser/rejson-rl/dto' -import { GetListElementsDto, GetListElementsResponse, -} from 'apiSrc/modules/browser/list/dto' -import { Database as DatabaseInstanceResponse } from 'apiSrc/modules/database/models/database' -import { SearchZSetMembersResponse } from 'apiSrc/modules/browser/z-set/dto' -import { SentinelMaster } from 'apiSrc/modules/redis-sentinel/models/sentinel-master' -import { CreateSentinelDatabaseDto } from 'apiSrc/modules/redis-sentinel/dto/create.sentinel.database.dto' -import { CreateSentinelDatabaseResponse } from 'apiSrc/modules/redis-sentinel/dto/create.sentinel.database.response' -import { RedisNodeInfoResponse } from 'apiSrc/modules/database/dto/redis-info.dto' -import { Tag } from './tag' + Database as DatabaseInstanceResponse, + SearchZSetMembersResponse, +} from 'uiSrc/api-client' export interface Instance extends Partial { host: string port: number - nameFromProvider?: Nullable - provider?: string id: string endpoints?: Nullable - connectionType?: ConnectionType - lastConnection?: Date - password?: Nullable - username?: Nullable - name?: string - db?: number - tls?: boolean - ssh?: boolean - sshOptions?: { - host: string - port: number - username?: string - password?: string | true - privateKey?: string - passphrase?: string | true - } tlsClientAuthRequired?: boolean - verifyServerCert?: boolean - caCert?: CaCertificate - clientCert?: ClientCertificate authUsername?: Nullable authPass?: Nullable isDeleting?: boolean - sentinelMaster?: SentinelMaster - modules: AdditionalRedisModule[] - version: Nullable isRediStack?: boolean visible?: boolean loading?: boolean isFreeDb?: boolean - tags?: Tag[] -} - -export interface AdditionalRedisModule { - name: string - version: number - semanticVersion: string -} - -interface CaCertificate { - id?: string - name?: string - certificate?: string -} - -interface ClientCertificate { - id?: string - name?: string - key?: string - certificate?: string } export enum ConnectionType { @@ -471,7 +422,7 @@ export interface ModifiedSentinelMaster extends CreateSentinelDatabaseDto { export interface ModifiedGetListElementsResponse extends GetListElementsDto, GetListElementsResponse { - elements: { index: number; element: RedisResponseBuffer }[] + // elements: { index: number; element: RedisResponseBuffer }[] key?: RedisString searchedIndex: Nullable } @@ -482,9 +433,7 @@ export interface InitialStateSet { data: ModifiedGetSetMembersResponse } -export interface GetRejsonRlResponse extends GetRejsonRlResponseDto { - data: Maybe -} +export interface GetRejsonRlResponse extends GetRejsonRlResponseDto {} export enum EditorType { Default = 'default', diff --git a/redisinsight/ui/src/slices/interfaces/keys.ts b/redisinsight/ui/src/slices/interfaces/keys.ts index 573a2389e1..636fa4730a 100644 --- a/redisinsight/ui/src/slices/interfaces/keys.ts +++ b/redisinsight/ui/src/slices/interfaces/keys.ts @@ -6,7 +6,7 @@ import { } from 'uiSrc/constants' import { IKeyPropTypes } from 'uiSrc/constants/prop-types/keys' import { Maybe, Nullable } from 'uiSrc/utils' -import { GetKeyInfoResponse } from 'apiSrc/modules/browser/keys/dto' +import { GetKeyInfoResponse } from 'uiSrc/api-client' export interface Key { name: string diff --git a/redisinsight/ui/src/slices/interfaces/monitor.ts b/redisinsight/ui/src/slices/interfaces/monitor.ts index 8d7d4a587e..29ef1f6d5c 100644 --- a/redisinsight/ui/src/slices/interfaces/monitor.ts +++ b/redisinsight/ui/src/slices/interfaces/monitor.ts @@ -1,6 +1,13 @@ import { Socket } from 'socket.io-client' import { Nullable } from 'uiSrc/utils' -import { IMonitorData } from 'apiSrc/modules/profiler/interfaces/monitor-data.interface' + +export interface IMonitorData { + time: string + args: string[] + source: string + database: number + shardOptions: any +} export interface IMonitorDataPayload extends Partial { isError?: boolean diff --git a/redisinsight/ui/src/slices/interfaces/pubsub.ts b/redisinsight/ui/src/slices/interfaces/pubsub.ts index 5596e6c491..968dc157c7 100644 --- a/redisinsight/ui/src/slices/interfaces/pubsub.ts +++ b/redisinsight/ui/src/slices/interfaces/pubsub.ts @@ -1,5 +1,13 @@ -import { IMessage } from 'apiSrc/modules/pub-sub/interfaces/message.interface' -import { SubscriptionDto } from 'apiSrc/modules/pub-sub/dto/subscription.dto' +export interface IPubsubMessage { + message: string + channel: string + time: number +} + +export interface SubscriptionDto { + channel: string + type: string +} export interface PubSubSubscription { channel: string @@ -20,6 +28,6 @@ export interface StatePubSub { isSubscribeTriggered: boolean isConnected: boolean isSubscribed: boolean - messages: IMessage[] + messages: IPubsubMessage[] count: number } diff --git a/redisinsight/ui/src/slices/interfaces/rdi.ts b/redisinsight/ui/src/slices/interfaces/rdi.ts index 0bbd7620c0..be0a9a293a 100644 --- a/redisinsight/ui/src/slices/interfaces/rdi.ts +++ b/redisinsight/ui/src/slices/interfaces/rdi.ts @@ -1,7 +1,7 @@ import { monaco as monacoEditor } from 'react-monaco-editor' import { Nullable } from 'uiSrc/utils' import { ICommand } from 'uiSrc/constants' -import { Rdi as RdiInstanceResponse } from 'apiSrc/modules/rdi/models/rdi' +import { Rdi as RdiInstanceResponse } from 'uiSrc/api-client' // tabs for dry run job panel export enum PipelineJobsTabs { @@ -214,8 +214,8 @@ export interface IStateRdiStatistics { export interface RdiInstance extends RdiInstanceResponse { visible?: boolean - loading: boolean - error: string + loading?: boolean + error?: string // not really present, but used in InstancesList.tsx:142 db?: number } diff --git a/redisinsight/ui/src/slices/interfaces/stream.ts b/redisinsight/ui/src/slices/interfaces/stream.ts index 16a8ff9636..6f915f9cf2 100644 --- a/redisinsight/ui/src/slices/interfaces/stream.ts +++ b/redisinsight/ui/src/slices/interfaces/stream.ts @@ -5,7 +5,7 @@ import { ConsumerGroupDto, GetStreamEntriesResponse, PendingEntryDto, -} from 'apiSrc/modules/browser/stream/dto' +} from 'uiSrc/api-client' import { RedisResponseBuffer } from './app' type Range = { diff --git a/redisinsight/ui/src/slices/interfaces/user.ts b/redisinsight/ui/src/slices/interfaces/user.ts index 8008280885..f856a736d7 100644 --- a/redisinsight/ui/src/slices/interfaces/user.ts +++ b/redisinsight/ui/src/slices/interfaces/user.ts @@ -1,9 +1,9 @@ import { Nullable } from 'uiSrc/utils' -import { CloudUser } from 'apiSrc/modules/cloud/user/models' import { + CloudUser, GetAgreementsSpecResponse, GetAppSettingsResponse, -} from 'apiSrc/modules/settings/dto/settings.dto' +} from 'uiSrc/api-client' export interface StateUserSettings { loading: boolean diff --git a/redisinsight/ui/src/slices/oauth/cloud.ts b/redisinsight/ui/src/slices/oauth/cloud.ts index 35da55a4da..f996674b76 100644 --- a/redisinsight/ui/src/slices/oauth/cloud.ts +++ b/redisinsight/ui/src/slices/oauth/cloud.ts @@ -20,9 +20,11 @@ import { import successMessages from 'uiSrc/components/notifications/success-messages' import { getCloudSsoUtmParams } from 'uiSrc/utils/oauth/cloudSsoUtm' import { setSSOFlow } from 'uiSrc/slices/instances/cloud' -import { CloudUser } from 'apiSrc/modules/cloud/user/models' -import { CloudJobInfo } from 'apiSrc/modules/cloud/job/models' -import { CloudSubscriptionPlanResponse } from 'apiSrc/modules/cloud/subscription/dto' +import { + CloudJobInfo, + CloudSubscriptionPlanResponse, + CloudUser, +} from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { diff --git a/redisinsight/ui/src/slices/pubsub/pubsub.ts b/redisinsight/ui/src/slices/pubsub/pubsub.ts index bf19d6bcb8..0912219fdb 100644 --- a/redisinsight/ui/src/slices/pubsub/pubsub.ts +++ b/redisinsight/ui/src/slices/pubsub/pubsub.ts @@ -8,8 +8,7 @@ import { AppDispatch, RootState } from 'uiSrc/slices/store' import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils' import { DEFAULT_SEARCH_MATCH } from 'uiSrc/constants/api' import { SubscriptionType } from 'uiSrc/constants/pubSub' -import { MessagesResponse } from 'apiSrc/modules/pub-sub/dto/messages.response' -import { PublishResponse } from 'apiSrc/modules/pub-sub/dto/publish.response' +import { PublishResponse } from 'uiSrc/api-client' export const initialState: StatePubSub = { loading: false, @@ -54,7 +53,7 @@ const pubSubSlice = createSlice({ }, concatPubSubMessages: ( state, - { payload }: PayloadAction, + { payload }: PayloadAction, ) => { state.count += payload.count if (payload.messages.length >= PUB_SUB_ITEMS_MAX_COUNT) { diff --git a/redisinsight/ui/src/slices/rdi/instances.ts b/redisinsight/ui/src/slices/rdi/instances.ts index 2161df1bf8..fe7c218f29 100644 --- a/redisinsight/ui/src/slices/rdi/instances.ts +++ b/redisinsight/ui/src/slices/rdi/instances.ts @@ -11,12 +11,13 @@ import { Maybe, Nullable, } from 'uiSrc/utils' -import { Rdi as RdiInstanceResponse } from 'apiSrc/modules/rdi/models/rdi' +import { Rdi as RdiInstanceResponse } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../app/notifications' import { IErrorData, @@ -33,13 +34,14 @@ export const initialState: InitialStateRdiInstances = { name: '', url: '', version: '', - lastConnection: new Date(), + lastConnection: new Date().toString(), loading: false, error: '', }, loadingChanging: false, errorChanging: '', changedSuccessfully: false, + isPipelineLoaded: false, } // A slice for recipes @@ -120,6 +122,7 @@ const instancesSlice = createSlice({ state, { payload }: { payload: Nullable }, ) => { + // @ts-expect-error TODO: check if this is needed state.editedInstance.data = payload }, @@ -208,7 +211,7 @@ export function fetchInstancesAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(loadInstancesFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -245,7 +248,7 @@ export function createInstanceAction( dispatch(defaultInstanceChangingFailure(errorMessage)) const errorData = error?.response?.data as IErrorData onFail?.(errorData?.errorCode || errorData?.error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -280,7 +283,7 @@ export function editInstanceAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(defaultInstanceChangingFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -328,7 +331,7 @@ export function deleteInstancesAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -354,7 +357,7 @@ export function fetchConnectedInstanceAction( const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) dispatch(setConnectedInstanceFailure(errorMessage)) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) } } } @@ -381,7 +384,12 @@ export function checkConnectToRdiInstanceAction( const errorMessage = getApiErrorMessage(error) dispatch(setDefaultInstanceFailure(errorMessage)) - dispatch(addErrorNotification({ ...error, instanceId: id })) + dispatch( + addErrorNotification({ + ...error, + instanceId: id, + } as IAddInstanceErrorPayload), + ) onFailAction?.() } } diff --git a/redisinsight/ui/src/slices/recommendations/recommendations.ts b/redisinsight/ui/src/slices/recommendations/recommendations.ts index b093508b03..13480b3f9d 100644 --- a/redisinsight/ui/src/slices/recommendations/recommendations.ts +++ b/redisinsight/ui/src/slices/recommendations/recommendations.ts @@ -4,12 +4,12 @@ import { AxiosError } from 'axios' import { remove, some } from 'lodash' import { apiService, resourcesService } from 'uiSrc/services' import { ApiEndpoints } from 'uiSrc/constants' -import { addErrorNotification } from 'uiSrc/slices/app/notifications' +import { addErrorNotification, IAddInstanceErrorPayload } from 'uiSrc/slices/app/notifications' import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils' import { DeleteDatabaseRecommendationResponse, ModifyDatabaseRecommendationDto, -} from 'apiSrc/modules/database-recommendation/dto' +} from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { @@ -178,7 +178,7 @@ export function fetchRecommendationsAction( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(getRecommendationsFailure(errorMessage)) onFailAction?.() } @@ -227,7 +227,7 @@ export function updateLiveRecommendation( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateRecommendationError(errorMessage)) onFailAction?.() } @@ -259,7 +259,7 @@ export function deleteLiveRecommendations( } catch (_err) { const error = _err as AxiosError const errorMessage = getApiErrorMessage(error) - dispatch(addErrorNotification(error)) + dispatch(addErrorNotification(error as IAddInstanceErrorPayload)) dispatch(updateRecommendationError(errorMessage)) onFailAction?.() } diff --git a/redisinsight/ui/src/slices/tests/analytics/slowlog.spec.ts b/redisinsight/ui/src/slices/tests/analytics/slowlog.spec.ts index d36146d91c..83846526b4 100644 --- a/redisinsight/ui/src/slices/tests/analytics/slowlog.spec.ts +++ b/redisinsight/ui/src/slices/tests/analytics/slowlog.spec.ts @@ -1,5 +1,4 @@ import { cloneDeep } from 'lodash' -import { AxiosError } from 'axios' import { DEFAULT_SLOWLOG_DURATION_UNIT } from 'uiSrc/constants' import { apiService } from 'uiSrc/services' import { setSlowLogUnits } from 'uiSrc/slices/app/context' @@ -8,10 +7,13 @@ import { mockedStore, initialStateDefault, } from 'uiSrc/utils/test-utils' -import { addErrorNotification } from 'uiSrc/slices/app/notifications' +import { + addErrorNotification, + IAddInstanceErrorPayload, +} from 'uiSrc/slices/app/notifications' import { MOCK_TIMESTAMP } from 'uiSrc/mocks/data/dateNow' -import { SlowLog, SlowLogConfig } from 'apiSrc/modules/slow-log/models' +import { SlowLog, SlowLogConfig } from 'uiSrc/api-client' import reducer, { initialState, @@ -56,7 +58,7 @@ describe('slowLog slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -320,7 +322,7 @@ describe('slowLog slice', () => { // Assert const expectedActions = [ getSlowLogs(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), getSlowLogsError(errorMessage), ] @@ -360,7 +362,7 @@ describe('slowLog slice', () => { // Assert const expectedActions = [ deleteSlowLogs(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), deleteSlowLogsError(errorMessage), ] @@ -407,7 +409,7 @@ describe('slowLog slice', () => { // Assert const expectedActions = [ getSlowLogConfig(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), getSlowLogConfigError(errorMessage), ] @@ -473,7 +475,7 @@ describe('slowLog slice', () => { // Assert const expectedActions = [ getSlowLogConfig(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), getSlowLogConfigError(errorMessage), ] diff --git a/redisinsight/ui/src/slices/tests/browser/keys.spec.ts b/redisinsight/ui/src/slices/tests/browser/keys.spec.ts index 075b67cb7a..1a66bfc611 100644 --- a/redisinsight/ui/src/slices/tests/browser/keys.spec.ts +++ b/redisinsight/ui/src/slices/tests/browser/keys.spec.ts @@ -1,5 +1,4 @@ import { cloneDeep } from 'lodash' -import { AxiosError } from 'axios' import { configureStore } from '@reduxjs/toolkit' import { getConfig } from 'uiSrc/config' import { @@ -23,9 +22,14 @@ import { import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from 'uiSrc/slices/app/notifications' import successMessages from 'uiSrc/components/notifications/success-messages' -import { SearchHistoryItem, SearchMode } from 'uiSrc/slices/interfaces/keys' +import { + KeysStore, + SearchHistoryItem, + SearchMode, +} from 'uiSrc/slices/interfaces/keys' import { resetBrowserTree, setBrowserSelectedKey, @@ -36,16 +40,16 @@ import { setEditorType, setIsWithinThreshold, } from 'uiSrc/slices/browser/rejson' -import { EditorType } from 'uiSrc/slices/interfaces' -import { CreateHashWithExpireDto } from 'apiSrc/modules/browser/hash/dto' +import { EditorType, RedisString } from 'uiSrc/slices/interfaces' import { + CreateHashWithExpireDto, CreateListWithExpireDto, - ListElementDestination, -} from 'apiSrc/modules/browser/list/dto' -import { CreateRejsonRlWithExpireDto } from 'apiSrc/modules/browser/rejson-rl/dto' -import { CreateSetWithExpireDto } from 'apiSrc/modules/browser/set/dto' -import { CreateZSetWithExpireDto } from 'apiSrc/modules/browser/z-set/dto' -import { SetStringWithExpireDto } from 'apiSrc/modules/browser/string/dto' + CreateListWithExpireDtoDestinationEnum as ListElementDestination, + CreateRejsonRlWithExpireDto, + CreateSetWithExpireDto, + CreateZSetWithExpireDto, + SetStringWithExpireDto, +} from 'uiSrc/api-client' import { getString, getStringSuccess } from '../../browser/string' import reducer, { addHashKey, @@ -141,7 +145,7 @@ describe('keys slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -863,7 +867,7 @@ describe('keys slice', () => { data: { keys: [{ name: data.key }], }, - } + } as KeysStore const state = { ...initialState, data: { @@ -894,7 +898,7 @@ describe('keys slice', () => { data: { keys: [{ name: key }], }, - } + } as KeysStore const state = { ...initialState, data: { @@ -1220,7 +1224,7 @@ describe('keys slice', () => { // Assert const expectedActions = [ loadKeys(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadKeysFailure(errorMessage), ] expect(store.getActions()).toEqual(expectedActions) @@ -1298,7 +1302,7 @@ describe('keys slice', () => { // Assert const expectedActions = [ loadMoreKeys(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadMoreKeysFailure(errorMessage), ] expect(store.getActions()).toEqual(expectedActions) @@ -1351,7 +1355,7 @@ describe('keys slice', () => { // Assert const expectedActions = [ defaultSelectedKeyAction(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), defaultSelectedKeyActionFailure(errorMessage), ] expect(store.getActions()).toEqual(expectedActions) @@ -1375,7 +1379,7 @@ describe('keys slice', () => { // Assert const expectedActions = [ defaultSelectedKeyAction(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), defaultSelectedKeyActionFailure(errorMessage), resetKeyInfo(), setBrowserSelectedKey(null), @@ -1501,7 +1505,7 @@ describe('keys slice', () => { const expectedActions = [ refreshKeyInfo(), refreshKeyInfoFail(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) @@ -1820,6 +1824,7 @@ describe('keys slice', () => { const testStore = configureStore({ reducer: rootReducer, + // @ts-ignore preloadedState: initialStateWithColumns, }) @@ -1856,7 +1861,7 @@ describe('keys slice', () => { // Act await testStore.dispatch( fetchKeysMetadata( - data.map(({ name }) => ({ name })), + data.map(({ name }) => ({ name })) as unknown as RedisString[], null, controller.signal, onSuccessMock, @@ -1866,11 +1871,10 @@ describe('keys slice', () => { const expectedData = { keys: data.map(({ name }) => ({ name })), type: undefined, + includeTTL: shownColumns.includes(BrowserColumns.TTL), + includeSize: shownColumns.includes(BrowserColumns.Size), } - expectedData.includeTTL = shownColumns.includes(BrowserColumns.TTL) - expectedData.includeSize = shownColumns.includes(BrowserColumns.Size) - expect(apiServiceMock).toBeCalledWith( '/databases//keys/get-metadata', expectedData, @@ -1898,6 +1902,7 @@ describe('keys slice', () => { const testStore = configureStore({ reducer: rootReducer, + // @ts-ignore preloadedState: initialStateWithColumns, }) @@ -1937,7 +1942,7 @@ describe('keys slice', () => { // Act await testStore.dispatch( fetchKeysMetadataTree( - data.map(({ name }, i) => [i, name]), + data.map(({ name }, i) => [i, name]) as unknown as RedisString[], null, controller.signal, onSuccessMock, @@ -1947,11 +1952,10 @@ describe('keys slice', () => { const expectedData = { keys: data.map(({ name }) => name), type: undefined, + includeTTL: shownColumns.includes(BrowserColumns.TTL), + includeSize: shownColumns.includes(BrowserColumns.Size), } - expectedData.includeTTL = shownColumns.includes(BrowserColumns.TTL) - expectedData.includeSize = shownColumns.includes(BrowserColumns.Size) - // Assert expect(apiServiceMock).toBeCalledWith( '/databases//keys/get-metadata', @@ -1968,13 +1972,13 @@ describe('keys slice', () => { it('updateKeyList should be called', async () => { // Act await store.dispatch( - addKeyIntoList({ key: 'key', keyType: 'hash' }), + addKeyIntoList({ key: 'key', keyType: KeyTypes.Hash }), ) // Assert const expectedActions = [ resetBrowserTree(), - updateKeyList({ keyName: 'key', keyType: 'hash' }), + updateKeyList({ keyName: 'key', keyType: KeyTypes.Hash }), ] expect(store.getActions()).toEqual(expectedActions) }) diff --git a/redisinsight/ui/src/slices/tests/browser/list.spec.ts b/redisinsight/ui/src/slices/tests/browser/list.spec.ts index 2b3487e8af..9d25462675 100644 --- a/redisinsight/ui/src/slices/tests/browser/list.spec.ts +++ b/redisinsight/ui/src/slices/tests/browser/list.spec.ts @@ -14,7 +14,7 @@ import { MOCK_TIMESTAMP } from 'uiSrc/mocks/data/dateNow' import { DeleteListElementsDto, PushElementToListDto, -} from 'apiSrc/modules/browser/list/dto' +} from 'uiSrc/api-client' import { defaultSelectedKeyAction, deleteSelectedKeySuccess, diff --git a/redisinsight/ui/src/slices/tests/browser/rejson.spec.ts b/redisinsight/ui/src/slices/tests/browser/rejson.spec.ts index 574c057129..22b7df4dc4 100644 --- a/redisinsight/ui/src/slices/tests/browser/rejson.spec.ts +++ b/redisinsight/ui/src/slices/tests/browser/rejson.spec.ts @@ -1,4 +1,3 @@ -import { AxiosError } from 'axios' import { cloneDeep } from 'lodash' import { apiService } from 'uiSrc/services' import { @@ -8,7 +7,10 @@ import { mockStore, } from 'uiSrc/utils/test-utils' import successMessages from 'uiSrc/components/notifications/success-messages' -import { GetRejsonRlResponseDto } from 'apiSrc/modules/browser/rejson-rl/dto' +import { GetRejsonRlResponseDto } from 'uiSrc/api-client' +import { stringToBuffer } from 'uiSrc/utils' +import { EditorType } from 'uiSrc/slices/interfaces' +import { RootState } from 'uiSrc/slices/store' import reducer, { initialState, loadRejsonBranch, @@ -34,10 +36,9 @@ import reducer, { import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../../app/notifications' import { refreshKeyInfo } from '../../browser/keys' -import { EditorType } from 'uiSrc/slices/interfaces' -import { stringToBuffer } from 'uiSrc/utils' jest.mock('uiSrc/services', () => ({ ...jest.requireActual('uiSrc/services'), @@ -70,7 +71,7 @@ beforeEach(() => { }, }, }, - }, + } as RootState['browser'], } storeWithSelectedKey = mockStore(rootStateWithSelectedKey) @@ -83,7 +84,7 @@ describe('rejson slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -107,7 +108,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -134,7 +135,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) @@ -157,7 +158,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -181,7 +182,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -203,7 +204,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -224,7 +225,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -251,7 +252,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -273,7 +274,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -294,7 +295,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -318,7 +319,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -340,7 +341,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -361,7 +362,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -385,7 +386,7 @@ describe('rejson slice', () => { browser: { rejson: nextState, }, - } + } as RootState expect(rejsonSelector(rootState)).toEqual(state) }) }) @@ -434,7 +435,7 @@ describe('rejson slice', () => { const expectedActions = [ loadRejsonBranch(), loadRejsonBranchFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) @@ -611,7 +612,7 @@ describe('rejson slice', () => { const expectedActions = [ setReJSONData(), setReJSONDataFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) @@ -668,7 +669,7 @@ describe('rejson slice', () => { const expectedActions = [ appendReJSONArrayItem(), appendReJSONArrayItemFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) @@ -728,7 +729,7 @@ describe('rejson slice', () => { const expectedActions = [ removeRejsonKey(), removeRejsonKeyFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) diff --git a/redisinsight/ui/src/slices/tests/browser/stream.spec.ts b/redisinsight/ui/src/slices/tests/browser/stream.spec.ts index 63b5585016..88ad8e0d4a 100644 --- a/redisinsight/ui/src/slices/tests/browser/stream.spec.ts +++ b/redisinsight/ui/src/slices/tests/browser/stream.spec.ts @@ -1,4 +1,3 @@ -import { AxiosError } from 'axios' import { cloneDeep, omit } from 'lodash' import { cleanup, @@ -76,11 +75,14 @@ import { ClaimPendingEntryDto, PendingEntryDto, UpdateConsumerGroupDto, -} from 'apiSrc/modules/browser/stream/dto' + GetStreamEntriesResponse, +} from 'uiSrc/api-client' import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from '../../app/notifications' +import { RootState } from 'uiSrc/slices/store' jest.mock('uiSrc/services', () => ({ ...jest.requireActual('uiSrc/services'), @@ -107,11 +109,12 @@ const mockedEntryData = { fields: { field: stringToBuffer('1'), name: stringToBuffer('2') }, }, ], -} +} as unknown as GetStreamEntriesResponse const mockGroups: ConsumerGroupDto[] = [ { name: { + // @ts-ignore ...stringToBuffer('test'), viewValue: 'test', }, @@ -123,6 +126,7 @@ const mockGroups: ConsumerGroupDto[] = [ }, { name: { + // @ts-ignore ...stringToBuffer('test2'), viewValue: 'test2', }, @@ -137,12 +141,14 @@ const mockGroups: ConsumerGroupDto[] = [ const mockConsumers: ConsumerDto[] = [ { name: stringToBuffer('test'), + // @ts-ignore nameString: 'test', idle: 123, pending: 321, }, { name: stringToBuffer('test2'), + // @ts-ignore nameString: 'test2', idle: 13, pending: 31, @@ -179,7 +185,7 @@ describe('stream slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -192,7 +198,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(initialState) }) }) @@ -212,7 +218,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -242,7 +248,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -264,7 +270,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -284,7 +290,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -313,7 +319,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -335,7 +341,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -355,7 +361,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -376,7 +382,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -398,7 +404,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -418,7 +424,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -439,7 +445,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -461,7 +467,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -484,7 +490,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -507,7 +513,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -534,7 +540,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamRangeSelector(rootState)).toEqual(stateRange) }) }) @@ -557,7 +563,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -581,7 +587,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -617,7 +623,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -628,6 +634,7 @@ describe('stream slice', () => { const data: ConsumerDto[] = [ { name: { + // @ts-ignore ...stringToBuffer('123'), viewValue: '123', }, @@ -653,7 +660,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -689,7 +696,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -718,7 +725,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -744,7 +751,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -769,7 +776,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -780,7 +787,7 @@ describe('stream slice', () => { const group = { name: stringToBuffer('group name'), nameString: 'group name', - } + } as unknown as ConsumerGroupDto const state = { ...initialState, @@ -797,7 +804,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -826,7 +833,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -869,7 +876,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -892,7 +899,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -916,7 +923,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -941,7 +948,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -964,7 +971,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -988,7 +995,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -1017,7 +1024,7 @@ describe('stream slice', () => { const rootState = { ...initialStateDefault, browser: { stream: nextState }, - } + } as RootState expect(streamSelector(rootState)).toEqual(state) }) }) @@ -1073,7 +1080,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ loadEntries(true), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadEntriesFailure(errorMessage), ] @@ -1121,7 +1128,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ loadEntries(true), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadEntriesFailure(errorMessage), ] @@ -1165,7 +1172,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ loadConsumerGroups(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadConsumerGroupsFailure(errorMessage), ] @@ -1209,7 +1216,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ loadConsumerGroups(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadConsumersFailure(errorMessage), ] @@ -1253,7 +1260,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ loadConsumerGroups(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadConsumerMessagesFailure(errorMessage), ] @@ -1315,7 +1322,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ modifyLastDeliveredId(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), modifyLastDeliveredIdFailure(errorMessage), ] @@ -1378,7 +1385,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ deleteConsumerGroups(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), deleteConsumerGroupsFailure(errorMessage), ] @@ -1447,7 +1454,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ deleteConsumers(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), deleteConsumersFailure(errorMessage), ] @@ -1503,7 +1510,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ loadConsumerGroups(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadConsumerMessagesFailure(errorMessage), ] @@ -1566,7 +1573,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ ackPendingEntries(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ackPendingEntriesFailure(errorMessage), ] @@ -1672,7 +1679,7 @@ describe('stream slice', () => { // Assert const expectedActions = [ claimConsumerMessages(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), claimConsumerMessagesFailure(errorMessage), ] diff --git a/redisinsight/ui/src/slices/tests/browser/zset.spec.ts b/redisinsight/ui/src/slices/tests/browser/zset.spec.ts index 87628199e1..2c13e04c7c 100644 --- a/redisinsight/ui/src/slices/tests/browser/zset.spec.ts +++ b/redisinsight/ui/src/slices/tests/browser/zset.spec.ts @@ -1,5 +1,4 @@ import { cloneDeep } from 'lodash' -import { AxiosError } from 'axios' import { SortOrder } from 'uiSrc/constants' import { apiService } from 'uiSrc/services' import { @@ -11,15 +10,14 @@ import { import { addErrorNotification, addMessageNotification, + IAddInstanceErrorPayload, } from 'uiSrc/slices/app/notifications' import successMessages from 'uiSrc/components/notifications/success-messages' import { stringToBuffer } from 'uiSrc/utils' import { deleteRedisearchKeyFromList } from 'uiSrc/slices/browser/redisearch' import { MOCK_TIMESTAMP } from 'uiSrc/mocks/data/dateNow' -import { - AddMembersToZSetDto, - ZSetMemberDto, -} from 'apiSrc/modules/browser/z-set/dto' +import { AddMembersToZSetDto, ZSetMemberDto } from 'uiSrc/api-client' +import { RootState } from 'uiSrc/slices/store' import { defaultSelectedKeyAction, deleteSelectedKeySuccess, @@ -90,7 +88,7 @@ describe('zset slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -103,7 +101,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(initialState) }) }) @@ -119,14 +117,14 @@ describe('zset slice', () => { // Act const nextState = reducer( initialState, - loadZSetMembers([initialState.data.sortOrder, undefined]), + loadZSetMembers([initialState.data.sortOrder as SortOrder, undefined]), ) // Assert const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -161,7 +159,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) @@ -189,7 +187,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -218,7 +216,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -241,7 +239,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -274,7 +272,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) @@ -305,7 +303,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -328,7 +326,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -353,7 +351,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -384,7 +382,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) @@ -406,7 +404,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(initialState) }) }) @@ -429,7 +427,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -449,7 +447,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -487,7 +485,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) @@ -508,7 +506,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(initialState) }) }) @@ -532,7 +530,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -552,7 +550,7 @@ describe('zset slice', () => { const rootSate = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootSate)).toEqual(state) }) }) @@ -574,7 +572,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(initialStateRemove) }) }) @@ -597,7 +595,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -638,7 +636,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -662,7 +660,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -685,7 +683,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -709,7 +707,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -733,7 +731,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -789,7 +787,7 @@ describe('zset slice', () => { const rootState = { ...initialStateDefault, browser: { zset: nextState }, - } + } as RootState expect(zsetSelector(rootState)).toEqual(state) }) }) @@ -841,7 +839,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ loadZSetMembers([SortOrder.ASC, undefined]), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadZSetMembersFailure(errorMessage), ] @@ -896,7 +894,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ loadMoreZSetMembers(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadMoreZSetMembersFailure(errorMessage), ] @@ -952,7 +950,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ updateScore(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), updateScoreFailure(errorMessage), ] @@ -1021,7 +1019,7 @@ describe('zset slice', () => { }, }, }, - } + } as RootState const mockedStore = mockStore(nextState) @@ -1057,7 +1055,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ removeZsetMembers(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), removeZsetMembersFailure(errorMessage), ] @@ -1110,7 +1108,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ updateScore(), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), updateScoreFailure(errorMessage), ] @@ -1155,7 +1153,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ searchZSetMembers('zz'), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), searchZSetMembersFailure(errorMessage), ] @@ -1203,7 +1201,7 @@ describe('zset slice', () => { // Assert const expectedActions = [ searchMoreZSetMembers('zz'), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), searchMoreZSetMembersFailure(errorMessage), ] @@ -1249,12 +1247,13 @@ describe('zset slice', () => { apiService.post = jest.fn().mockRejectedValue(responsePayload) // Act + // @ts-ignore await store.dispatch(refreshZsetMembersAction()) // Assert const expectedActions = [ loadZSetMembers([SortOrder.ASC, undefined]), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), loadZSetMembersFailure(errorMessage), ] @@ -1274,11 +1273,12 @@ describe('zset slice', () => { searching: true, }, }, - } + } as RootState const mockedStore = mockStore(nextState) apiService.post = jest.fn().mockResolvedValue(responsePayload) + // @ts-ignore await mockedStore.dispatch(refreshZsetMembersAction()) // Assert diff --git a/redisinsight/ui/src/slices/tests/cli/cli-output.spec.ts b/redisinsight/ui/src/slices/tests/cli/cli-output.spec.ts index 137ba6b012..b55fc2172c 100644 --- a/redisinsight/ui/src/slices/tests/cli/cli-output.spec.ts +++ b/redisinsight/ui/src/slices/tests/cli/cli-output.spec.ts @@ -1,7 +1,7 @@ -import { cloneDeep, first } from 'lodash' +import { cloneDeep } from 'lodash' import { AxiosError } from 'axios' -import { SendCommandResponse } from 'src/modules/cli/dto/cli.dto' +import { SendCommandResponse } from 'uiSrc/api-client' import { AppDispatch, RootState } from 'uiSrc/slices/store' import { cleanup, diff --git a/redisinsight/ui/src/slices/tests/instances/cloud.spec.ts b/redisinsight/ui/src/slices/tests/instances/cloud.spec.ts index 4b9aa1393d..5a4ac2e3a3 100644 --- a/redisinsight/ui/src/slices/tests/instances/cloud.spec.ts +++ b/redisinsight/ui/src/slices/tests/instances/cloud.spec.ts @@ -1,4 +1,3 @@ -import { AxiosError } from 'axios' import { cloneDeep } from 'lodash' import { apiService } from 'uiSrc/services' import { @@ -7,9 +6,11 @@ import { mockedStore, } from 'uiSrc/utils/test-utils' import { + // @ts-expect-error GetCloudAccountShortInfoResponse, + // @ts-expect-error RedisCloudDatabase, -} from 'apiSrc/modules/redis-enterprise/dto/cloud.dto' +} from 'uiSrc/api-client' import reducer, { loadSubscriptionsRedisCloud, initialState, @@ -32,8 +33,15 @@ import reducer, { createInstancesRedisCloud, createInstancesRedisCloudSuccess, } from '../../instances/cloud' -import { LoadedCloud, RedisCloudSubscriptionType } from '../../interfaces' -import { addErrorNotification } from '../../app/notifications' +import { + LoadedCloud, + OAuthSocialAction, + RedisCloudSubscriptionType, +} from '../../interfaces' +import { + addErrorNotification, + IAddInstanceErrorPayload, +} from '../../app/notifications' jest.mock('uiSrc/services', () => ({ ...jest.requireActual('uiSrc/services'), @@ -85,7 +93,7 @@ describe('cloud slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -563,7 +571,7 @@ describe('cloud slice', () => { describe('setSSOFlow', () => { it('should properly set setSSOFlow', () => { // Arrange - const data = 'import' + const data = OAuthSocialAction.Import const state = { ...initialState, ssoFlow: 'import', @@ -669,7 +677,7 @@ describe('cloud slice', () => { loadSubscriptionsRedisCloudFailure( responsePayload.response.data.message, ), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) @@ -726,7 +734,7 @@ describe('cloud slice', () => { const expectedActions = [ loadAccountRedisCloud(), loadAccountRedisCloudFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) @@ -799,6 +807,7 @@ describe('cloud slice', () => { // Act await store.dispatch( + // @ts-expect-error type mismatch fetchInstancesRedisCloud({ ids, credentials }), ) @@ -806,7 +815,7 @@ describe('cloud slice', () => { const expectedActions = [ loadInstancesRedisCloud(), loadInstancesRedisCloudFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) @@ -817,7 +826,7 @@ describe('cloud slice', () => { it('call addInstancesRedisCloud and createInstancesRedisCloudSuccess when fetch is successed', async () => { // Arrange const databasesPicked = [ - { subscriptionId: '1231', databaseId: '123', free: false }, + { subscriptionId: 1231, databaseId: 123, free: false }, ] const credentials = { accessKey: '123', @@ -844,7 +853,7 @@ describe('cloud slice', () => { it('call addInstancesRedisCloud and createInstancesRedisCloudFailure when fetch is failure', async () => { // Arrange const databasesPicked = [ - { subscriptionId: '1231', databaseId: '123', free: false }, + { subscriptionId: 1231, databaseId: 123, free: false }, ] const credentials = { accessKey: '123', @@ -873,7 +882,7 @@ describe('cloud slice', () => { createInstancesRedisCloudFailure( responsePayload.response.data.message, ), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) diff --git a/redisinsight/ui/src/slices/tests/instances/cluster.spec.ts b/redisinsight/ui/src/slices/tests/instances/cluster.spec.ts index cdb820d967..567b0f4031 100644 --- a/redisinsight/ui/src/slices/tests/instances/cluster.spec.ts +++ b/redisinsight/ui/src/slices/tests/instances/cluster.spec.ts @@ -1,4 +1,3 @@ -import { AxiosError } from 'axios' import { cloneDeep } from 'lodash' import { apiService } from 'uiSrc/services' import { @@ -9,8 +8,8 @@ import { import { ClusterConnectionDetailsDto, RedisEnterpriseDatabase, -} from 'apiSrc/modules/redis-enterprise/dto/cluster.dto' -import { AddRedisEnterpriseDatabaseResponse } from 'apiSrc/modules/redis-enterprise/dto/redis-enterprise-cluster.dto' + AddRedisEnterpriseDatabaseResponse, +} from 'uiSrc/api-client' import reducer, { initialState, loadInstancesRedisCluster, @@ -24,7 +23,7 @@ import reducer, { addInstancesRedisCluster, } from '../../instances/cluster' -import { addErrorNotification } from '../../app/notifications' +import { addErrorNotification, IAddInstanceErrorPayload } from '../../app/notifications' jest.mock('uiSrc/services', () => ({ ...jest.requireActual('uiSrc/services'), @@ -159,7 +158,7 @@ describe('cluster slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -430,7 +429,7 @@ describe('cluster slice', () => { loadInstancesRedisClusterFailure( responsePayload.response.data.message, ), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) @@ -484,7 +483,7 @@ describe('cluster slice', () => { createInstancesRedisClusterFailure( responsePayload.response.data.message, ), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) diff --git a/redisinsight/ui/src/slices/tests/instances/sentinel.spec.ts b/redisinsight/ui/src/slices/tests/instances/sentinel.spec.ts index cd249dbcb0..6accffa1fa 100644 --- a/redisinsight/ui/src/slices/tests/instances/sentinel.spec.ts +++ b/redisinsight/ui/src/slices/tests/instances/sentinel.spec.ts @@ -1,4 +1,3 @@ -import { AxiosError } from 'axios' import { cloneDeep } from 'lodash' import { cleanup, @@ -8,8 +7,10 @@ import { import { apiService } from 'uiSrc/services' import { parseAddedMastersSentinel, parseMastersSentinel } from 'uiSrc/utils' -import { SentinelMaster } from 'apiSrc/modules/redis-sentinel/models/sentinel-master' -import { CreateSentinelDatabaseResponse } from 'apiSrc/modules/redis-sentinel/dto/create.sentinel.database.response' +import { + SentinelMaster, + CreateSentinelDatabaseResponse, +} from 'uiSrc/api-client' import reducer, { initialState, @@ -25,8 +26,15 @@ import reducer, { createMastersSentinelFailure, updateMastersSentinel, } from '../../instances/sentinel' -import { addErrorNotification } from '../../app/notifications' -import { LoadedSentinel, ModifiedSentinelMaster } from '../../interfaces' +import { + addErrorNotification, + IAddInstanceErrorPayload, +} from '../../app/notifications' +import { + Instance, + LoadedSentinel, + ModifiedSentinelMaster, +} from '../../interfaces' jest.mock('uiSrc/services', () => ({ ...jest.requireActual('uiSrc/services'), @@ -97,7 +105,7 @@ describe('sentinel slice', () => { const nextState = initialState // Act - const result = reducer(undefined, {}) + const result = reducer(undefined, {} as any) // Assert expect(result).toEqual(nextState) @@ -130,7 +138,7 @@ describe('sentinel slice', () => { // Arrange const data: ModifiedSentinelMaster[] = [ - { name: 'mymaster', host: 'localhost', port: 0, numberOfSlaves: 10 }, + { name: 'mymaster', host: 'localhost', port: '0', alias: 'alias' }, ] const state = { @@ -345,7 +353,7 @@ describe('sentinel slice', () => { const requestData = { host: 'localhost', port: 5005, - } + } as Instance const responsePayload = { data: masters, status: 200 } @@ -368,7 +376,7 @@ describe('sentinel slice', () => { const requestData = { host: 'localhost', port: 5005, - } + } as Instance const errorMessage = 'Could not connect to aoeu:123, please check the connection details.' @@ -388,7 +396,7 @@ describe('sentinel slice', () => { const expectedActions = [ loadMastersSentinel(), loadMastersSentinelFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) @@ -457,7 +465,7 @@ describe('sentinel slice', () => { const expectedActions = [ createMastersSentinel(), createMastersSentinelFailure(responsePayload.response.data.message), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) }) diff --git a/redisinsight/ui/src/slices/tests/rdi/instances.spec.ts b/redisinsight/ui/src/slices/tests/rdi/instances.spec.ts index f53743e1f5..d0e51bf5fa 100644 --- a/redisinsight/ui/src/slices/tests/rdi/instances.spec.ts +++ b/redisinsight/ui/src/slices/tests/rdi/instances.spec.ts @@ -1,5 +1,4 @@ import { cloneDeep } from 'lodash' -import { AxiosError } from 'axios' import { cleanup, initialStateDefault, @@ -10,7 +9,6 @@ import reducer, { setConnectedInstance, setConnectedInstanceSuccess, setConnectedInstanceFailure, - resetConnectedInstance, setDefaultInstance, setDefaultInstanceSuccess, setDefaultInstanceFailure, @@ -32,7 +30,6 @@ import { } from 'uiSrc/slices/app/notifications' import { RdiInstance } from 'uiSrc/slices/interfaces' import successMessages from 'uiSrc/components/notifications/success-messages' -import { Rdi } from 'apiSrc/modules/rdi/models' let store: typeof mockedStore @@ -200,7 +197,7 @@ describe('rdi instances slice', () => { // Act const nextState = reducer( initialState, - updateConnectedInstance(mockRdiInstance as Rdi), + updateConnectedInstance(mockRdiInstance as RdiInstance), ) // Assert @@ -253,7 +250,7 @@ describe('rdi instances slice', () => { const expectedActions = [ setConnectedInstance(), setConnectedInstanceFailure(errorMessage), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) @@ -310,7 +307,7 @@ describe('rdi instances slice', () => { const expectedActions = [ defaultInstanceChanging(), defaultInstanceChangingFailure(errorMessage), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) @@ -360,7 +357,7 @@ describe('rdi instances slice', () => { const expectedActions = [ defaultInstanceChanging(), defaultInstanceChangingFailure(errorMessage), - addErrorNotification(responsePayload as AxiosError), + addErrorNotification(responsePayload as IAddInstanceErrorPayload), ] expect(store.getActions()).toEqual(expectedActions) diff --git a/redisinsight/ui/src/slices/tests/workbench/wb-results.spec.ts b/redisinsight/ui/src/slices/tests/workbench/wb-results.spec.ts index 19c30cb72d..db0a58f923 100644 --- a/redisinsight/ui/src/slices/tests/workbench/wb-results.spec.ts +++ b/redisinsight/ui/src/slices/tests/workbench/wb-results.spec.ts @@ -17,7 +17,7 @@ import { import { EMPTY_COMMAND } from 'uiSrc/constants' import { CommandExecutionType, ResultsMode } from 'uiSrc/slices/interfaces' import { setDbIndexState } from 'uiSrc/slices/app/context' -import { SendClusterCommandDto } from 'apiSrc/modules/cli/dto/cli.dto' +import { SendCommandDto as SendClusterCommandDto } from 'uiSrc/api-client' import reducer, { initialState, sendWBCommand, @@ -614,6 +614,7 @@ describe('workbench results slice', () => { const commandId = `${Date.now()}` const options: SendClusterCommandDto = { command: 'keys *', + // @ts-expect-error TODO: check type mismatch nodeOptions: { host: 'localhost', port: 7000, diff --git a/redisinsight/ui/src/slices/user/cloud-user-profile.ts b/redisinsight/ui/src/slices/user/cloud-user-profile.ts index c87691e916..580a88e39b 100644 --- a/redisinsight/ui/src/slices/user/cloud-user-profile.ts +++ b/redisinsight/ui/src/slices/user/cloud-user-profile.ts @@ -3,7 +3,7 @@ import { createSlice } from '@reduxjs/toolkit' import { apiService } from 'uiSrc/services' import { ApiEndpoints } from 'uiSrc/constants' import { getApiErrorMessage, isStatusSuccessful } from 'uiSrc/utils' -import { CloudUser } from 'apiSrc/modules/cloud/user/models' +import { CloudUser } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { StateUserProfile } from '../interfaces/user' diff --git a/redisinsight/ui/src/slices/user/user-settings.ts b/redisinsight/ui/src/slices/user/user-settings.ts index 8f4f9247c9..969f4eef65 100644 --- a/redisinsight/ui/src/slices/user/user-settings.ts +++ b/redisinsight/ui/src/slices/user/user-settings.ts @@ -8,7 +8,7 @@ import { GetAgreementsSpecResponse, GetAppSettingsResponse, UpdateSettingsDto, -} from 'apiSrc/modules/settings/dto/settings.dto' +} from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { StateUserSettings } from '../interfaces/user' diff --git a/redisinsight/ui/src/slices/workbench/wb-results.ts b/redisinsight/ui/src/slices/workbench/wb-results.ts index ae811d7e72..2cc73dae2a 100644 --- a/redisinsight/ui/src/slices/workbench/wb-results.ts +++ b/redisinsight/ui/src/slices/workbench/wb-results.ts @@ -40,7 +40,7 @@ import { getLocalWbHistory, removeCommand, } from 'uiSrc/services/workbenchStorage' -import { CreateCommandExecutionsDto } from 'apiSrc/modules/workbench/dto/create-command-executions.dto' +import { CreateCommandExecutionsDto } from 'uiSrc/api-client' import { AppDispatch, RootState } from '../store' import { diff --git a/redisinsight/ui/src/telemetry/interfaces.ts b/redisinsight/ui/src/telemetry/interfaces.ts index 312b8db7b8..2f652635ce 100644 --- a/redisinsight/ui/src/telemetry/interfaces.ts +++ b/redisinsight/ui/src/telemetry/interfaces.ts @@ -1,4 +1,4 @@ -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import { TelemetryEvent } from './events' export interface ITelemetryIdentify { diff --git a/redisinsight/ui/src/telemetry/telemetryUtils.ts b/redisinsight/ui/src/telemetry/telemetryUtils.ts index c65ed855a7..ede0ce2785 100644 --- a/redisinsight/ui/src/telemetry/telemetryUtils.ts +++ b/redisinsight/ui/src/telemetry/telemetryUtils.ts @@ -16,7 +16,7 @@ import { import { apiService } from 'uiSrc/services' import { store } from 'uiSrc/slices/store' import { getInstanceInfo } from 'uiSrc/services/database/instancesService' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import { IRedisModulesSummary, MatchType, RedisModules } from './interfaces' import { TelemetryEvent } from './events' import { checkIsAnalyticsGranted } from './checkAnalytics' diff --git a/redisinsight/ui/src/types/global.d.ts b/redisinsight/ui/src/types/global.d.ts new file mode 100644 index 0000000000..d3ff21c526 --- /dev/null +++ b/redisinsight/ui/src/types/global.d.ts @@ -0,0 +1,13 @@ +declare module 'socket.io-mock' { + export default class MockedSocket { + socketClient: { + emit: (event: string, data?: any) => void + on: (event: string, callback: (data: any) => void) => void + connected: boolean + } + + on: (event: string, callback: (data: any) => void) => void + + emit: (event: string, data?: any) => void + } +} diff --git a/redisinsight/ui/src/utils/cliHelper.tsx b/redisinsight/ui/src/utils/cliHelper.tsx index a28a253151..bd26771647 100644 --- a/redisinsight/ui/src/utils/cliHelper.tsx +++ b/redisinsight/ui/src/utils/cliHelper.tsx @@ -15,7 +15,7 @@ import { SelectCommand } from 'uiSrc/constants/cliOutput' import { RedisDefaultModules, COMMAND_MODULES } from 'uiSrc/slices/interfaces' import { getCommandsForExecution } from 'uiSrc/utils/monaco/monacoUtils' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' import formatToText from './transformers/cliTextFormatter' import { getDbIndex } from './longNames' diff --git a/redisinsight/ui/src/utils/common.ts b/redisinsight/ui/src/utils/common.ts index e26d6b5de9..f52a958979 100644 --- a/redisinsight/ui/src/utils/common.ts +++ b/redisinsight/ui/src/utils/common.ts @@ -1,6 +1,7 @@ import { trim } from 'lodash' import { IpcInvokeEvent } from 'uiSrc/electron/constants' import { getConfig } from 'uiSrc/config' +import { SortOrder } from 'uiSrc/constants' const riConfig = getConfig() const isDevelopment = riConfig.app.env === 'development' @@ -65,3 +66,6 @@ export const openNewWindowDatabase = (location: string) => { window.app?.ipc?.invoke(IpcInvokeEvent.windowOpen, { location }) } + +export const getLodashOrder = (order: SortOrder) => + order?.toLowerCase() as 'asc' | 'desc' diff --git a/redisinsight/ui/src/utils/decompressors/decompressors.ts b/redisinsight/ui/src/utils/decompressors/decompressors.ts index 1189489ccb..a2252cb87d 100644 --- a/redisinsight/ui/src/utils/decompressors/decompressors.ts +++ b/redisinsight/ui/src/utils/decompressors/decompressors.ts @@ -26,13 +26,14 @@ init(brotliWasmUrl).then(() => brotli) const decompressingBuffer = ( reply: RedisResponseBuffer, - compressorInit: Nullable = null, + compressorInit: Nullable = null, ): { value: RedisString - compressor: Nullable + compressor: Nullable isCompressed: boolean } => { - const compressorByValue: Nullable = getCompressor(reply) + const compressorByValue: Nullable = + getCompressor(reply) const compressor = compressorInit === compressorByValue || (!compressorByValue && compressorInit) @@ -41,7 +42,8 @@ const decompressingBuffer = ( try { switch (compressor) { - case KeyValueCompressor.GZIP: { + case KeyValueCompressor.Gzip: { + // @ts-expect-error const value = ungzip(Buffer.from(reply)) return { @@ -50,7 +52,8 @@ const decompressingBuffer = ( value: anyToBuffer(value), } } - case KeyValueCompressor.ZSTD: { + case KeyValueCompressor.Zstd: { + // @ts-expect-error const value = decompressFzstd(Buffer.from(reply)) return { @@ -59,7 +62,7 @@ const decompressingBuffer = ( value: anyToBuffer(value), } } - case KeyValueCompressor.LZ4: { + case KeyValueCompressor.Lz4: { const value = decompressLz4(Buffer.from(reply)) return { compressor, @@ -67,7 +70,8 @@ const decompressingBuffer = ( value: anyToBuffer(value), } } - case KeyValueCompressor.SNAPPY: { + case KeyValueCompressor.Snappy: { + // @ts-expect-error const value = anyToBuffer(decompressSnappy(Buffer.from(reply))) return { @@ -86,7 +90,7 @@ const decompressingBuffer = ( isCompressed: !isEqualBuffers(value, reply), } } - case KeyValueCompressor.PHPGZCompress: { + case KeyValueCompressor.PhpgzCompress: { const decompressedValue = inflate(bufferToUint8Array(reply)) if (!decompressedValue) return { value: reply, compressor: null, isCompressed: false } @@ -109,9 +113,9 @@ const decompressingBuffer = ( const getCompressor = ( reply: RedisResponseBuffer, -): Nullable => { +): Nullable => { const replyStart = reply?.data?.slice?.(0, 10)?.join?.(',') ?? '' - let compressor: Nullable = null + let compressor: Nullable = null forIn( COMPRESSOR_MAGIC_SYMBOLS, @@ -121,7 +125,7 @@ const getCompressor = ( replyStart.startsWith(magicSymbols) && replyStart.length > magicSymbols.length ) { - compressor = compressorName as KeyValueCompressor + compressor = compressorName as unknown as keyof ICompressorMagicSymbols return false // break loop } diff --git a/redisinsight/ui/src/utils/modules.ts b/redisinsight/ui/src/utils/modules.ts index 80b4c6d2f4..df8c545705 100644 --- a/redisinsight/ui/src/utils/modules.ts +++ b/redisinsight/ui/src/utils/modules.ts @@ -5,7 +5,7 @@ import { RedisDefaultModules, REDISEARCH_MODULES, } from 'uiSrc/slices/interfaces' -import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module' +import { AdditionalRedisModule } from 'uiSrc/api-client' export interface IDatabaseModule { abbreviation: string diff --git a/redisinsight/ui/src/utils/parseResponse.ts b/redisinsight/ui/src/utils/parseResponse.ts index 2cb217735e..86aff890da 100644 --- a/redisinsight/ui/src/utils/parseResponse.ts +++ b/redisinsight/ui/src/utils/parseResponse.ts @@ -2,14 +2,17 @@ import { find, map, sortBy, omit, forEach, isNull } from 'lodash' import { ModifiedSentinelMaster } from 'uiSrc/slices/interfaces' import { initialStateSentinelStatus } from 'uiSrc/slices/instances/sentinel' -import { AddSentinelMasterResponse } from 'apiSrc/modules/instances/dto/redis-sentinel.dto' -import { SentinelMaster } from 'apiSrc/modules/redis-sentinel/models/sentinel' +import { + CreateSentinelDatabaseResponse as AddSentinelMasterResponse, + SentinelMaster, +} from 'uiSrc/api-client' const DEFAULT_NODE_ID = 'standalone' export const parseMastersSentinel = ( masters: SentinelMaster[], ): ModifiedSentinelMaster[] => + // @ts-expect-error TODO: check this type mismatch map(sortBy(masters, 'name'), (master, i) => ({ ...initialStateSentinelStatus, ...master, @@ -23,13 +26,14 @@ export const parseAddedMastersSentinel = ( masters: ModifiedSentinelMaster[], statuses: AddSentinelMasterResponse[], ): ModifiedSentinelMaster[] => + // @ts-expect-error TODO: check this type mismatch sortBy(masters, 'message').map((master) => ({ ...master, ...find(statuses, (status) => master.name === status.name), loading: false, })) -export const parseKeysListResponse = (prevShards = {}, data = []) => { +export const parseKeysListResponse = (prevShards: any = {}, data: any = []) => { const shards = { ...prevShards } const result = { @@ -40,7 +44,7 @@ export const parseKeysListResponse = (prevShards = {}, data = []) => { shardsMeta: {}, } - data.forEach((node) => { + data.forEach((node: any) => { const id = node.host ? `${node.host}:${node.port}` : DEFAULT_NODE_ID const shard = (() => { if (!shards[id]) { @@ -67,7 +71,7 @@ export const parseKeysListResponse = (prevShards = {}, data = []) => { }) // summarize result numbers - const nextCursor = [] + const nextCursor: any[] = [] forEach(shards, (shard, id) => { if (shard.total === null) { result.total = shard.total diff --git a/redisinsight/ui/src/utils/streamUtils.ts b/redisinsight/ui/src/utils/streamUtils.ts index d80818502b..4bade5be61 100644 --- a/redisinsight/ui/src/utils/streamUtils.ts +++ b/redisinsight/ui/src/utils/streamUtils.ts @@ -11,7 +11,7 @@ import { ConsumerDto, ConsumerGroupDto, PendingEntryDto, -} from 'apiSrc/modules/browser/stream/dto' +} from 'uiSrc/api-client' import { isEqualBuffers } from './formatters' export enum ClaimTimeOptions { diff --git a/redisinsight/ui/src/utils/tests/decompressors/decompressors.spec.ts b/redisinsight/ui/src/utils/tests/decompressors/decompressors.spec.ts index f766713cd2..4b534c783c 100644 --- a/redisinsight/ui/src/utils/tests/decompressors/decompressors.spec.ts +++ b/redisinsight/ui/src/utils/tests/decompressors/decompressors.spec.ts @@ -16,8 +16,6 @@ import { LZ4_COMPRESSED_VALUE_2, SNAPPY_COMPRESSED_VALUE_2, SNAPPY_COMPRESSED_VALUE_1, - BROTLI_COMPRESSED_VALUE_1, - BROTLI_COMPRESSED_VALUE_2, PHPGZCOMPRESS_COMPRESSED_VALUE_1, PHPGZCOMPRESS_COMPRESSED_VALUE_2, } from './constants' @@ -38,7 +36,7 @@ const defaultValues = [ isCompressed: false, }, { - input: COMPRESSOR_MAGIC_SYMBOLS[KeyValueCompressor.GZIP] + input: COMPRESSOR_MAGIC_SYMBOLS[KeyValueCompressor.Gzip] .split(',') .map((symbol) => toNumber(symbol)), compressor: null, @@ -47,7 +45,7 @@ const defaultValues = [ isCompressed: false, }, { - input: COMPRESSOR_MAGIC_SYMBOLS[KeyValueCompressor.ZSTD] + input: COMPRESSOR_MAGIC_SYMBOLS[KeyValueCompressor.Zstd] .split(',') .map((symbol) => toNumber(symbol)), compressor: null, @@ -57,58 +55,58 @@ const defaultValues = [ }, { input: GZIP_COMPRESSED_VALUE_1, - compressor: KeyValueCompressor.GZIP, + compressor: KeyValueCompressor.Gzip, output: DECOMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, isCompressed: true, }, { input: GZIP_COMPRESSED_VALUE_2, - compressor: KeyValueCompressor.GZIP, + compressor: KeyValueCompressor.Gzip, output: DECOMPRESSED_VALUE_2, outputStr: DECOMPRESSED_VALUE_STR_2, isCompressed: true, }, { input: ZSTD_COMPRESSED_VALUE_1, - compressor: KeyValueCompressor.ZSTD, + compressor: KeyValueCompressor.Zstd, output: DECOMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, isCompressed: true, }, { input: ZSTD_COMPRESSED_VALUE_2, - compressor: KeyValueCompressor.ZSTD, + compressor: KeyValueCompressor.Zstd, output: DECOMPRESSED_VALUE_2, outputStr: DECOMPRESSED_VALUE_STR_2, isCompressed: true, }, { input: LZ4_COMPRESSED_VALUE_1, - compressor: KeyValueCompressor.LZ4, + compressor: KeyValueCompressor.Lz4, output: DECOMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, isCompressed: true, }, { input: LZ4_COMPRESSED_VALUE_2, - compressor: KeyValueCompressor.LZ4, + compressor: KeyValueCompressor.Lz4, output: DECOMPRESSED_VALUE_2, outputStr: DECOMPRESSED_VALUE_STR_2, isCompressed: true, }, { input: SNAPPY_COMPRESSED_VALUE_1, - compressor: KeyValueCompressor.SNAPPY, - compressorInit: KeyValueCompressor.SNAPPY, + compressor: KeyValueCompressor.Snappy, + compressorInit: KeyValueCompressor.Snappy, output: DECOMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, isCompressed: true, }, { input: SNAPPY_COMPRESSED_VALUE_2, - compressor: KeyValueCompressor.SNAPPY, - compressorInit: KeyValueCompressor.SNAPPY, + compressor: KeyValueCompressor.Snappy, + compressorInit: KeyValueCompressor.Snappy, output: DECOMPRESSED_VALUE_2, outputStr: DECOMPRESSED_VALUE_STR_2, isCompressed: true, @@ -118,15 +116,15 @@ const defaultValues = [ compressor: null, output: GZIP_COMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, - compressorInit: KeyValueCompressor.LZ4, - compressorByValue: KeyValueCompressor.GZIP, + compressorInit: KeyValueCompressor.Lz4, + compressorByValue: KeyValueCompressor.Gzip, isCompressed: false, }, { input: ZSTD_COMPRESSED_VALUE_1, compressor: null, - compressorInit: KeyValueCompressor.LZ4, - compressorByValue: KeyValueCompressor.ZSTD, + compressorInit: KeyValueCompressor.Lz4, + compressorByValue: KeyValueCompressor.Zstd, output: ZSTD_COMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, isCompressed: false, @@ -150,16 +148,16 @@ const defaultValues = [ // }, { input: PHPGZCOMPRESS_COMPRESSED_VALUE_1, - compressor: KeyValueCompressor.PHPGZCompress, - compressorInit: KeyValueCompressor.PHPGZCompress, + compressor: KeyValueCompressor.PhpgzCompress, + compressorInit: KeyValueCompressor.PhpgzCompress, output: DECOMPRESSED_VALUE_1, outputStr: DECOMPRESSED_VALUE_STR_1, isCompressed: true, }, { input: PHPGZCOMPRESS_COMPRESSED_VALUE_2, - compressor: KeyValueCompressor.PHPGZCompress, - compressorInit: KeyValueCompressor.PHPGZCompress, + compressor: KeyValueCompressor.PhpgzCompress, + compressorInit: KeyValueCompressor.PhpgzCompress, output: DECOMPRESSED_VALUE_2, outputStr: DECOMPRESSED_VALUE_STR_2, isCompressed: true, @@ -177,9 +175,9 @@ describe('getCompressor', () => { // SNAPPY doesn't have magic symbols if ( - compressor === KeyValueCompressor.SNAPPY || - compressor === KeyValueCompressor.Brotli || - compressor === KeyValueCompressor.PHPGZCompress + compressor === KeyValueCompressor.Snappy || + // compressor === KeyValueCompressor.Brotli || + compressor === KeyValueCompressor.PhpgzCompress ) { expected = null } diff --git a/redisinsight/ui/src/utils/tests/streamUtils.spec.ts b/redisinsight/ui/src/utils/tests/streamUtils.spec.ts index b6635016ad..88fa6c8fee 100644 --- a/redisinsight/ui/src/utils/tests/streamUtils.spec.ts +++ b/redisinsight/ui/src/utils/tests/streamUtils.spec.ts @@ -1,4 +1,4 @@ -import { ConsumerDto } from 'apiSrc/modules/browser/stream/dto' +import { ConsumerDto } from 'uiSrc/api-client' import { getDefaultConsumer } from '../streamUtils' const consumers1: ConsumerDto[] = [ diff --git a/redisinsight/ui/vite.config.mjs b/redisinsight/ui/vite.config.mjs index 62a6261ab0..a81fc5bbab 100644 --- a/redisinsight/ui/vite.config.mjs +++ b/redisinsight/ui/vite.config.mjs @@ -63,7 +63,6 @@ export default defineConfig({ '@redislabsdev/redis-ui-icons': '@redis-ui/icons', '@redislabsdev/redis-ui-table': '@redis-ui/table', uiSrc: fileURLToPath(new URL('./src', import.meta.url)), - apiSrc: fileURLToPath(new URL('../api/src', import.meta.url)), }, }, server: { diff --git a/tsconfig.json b/tsconfig.json index 8d7f161dfb..140366b566 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -28,8 +28,6 @@ "types": ["node", "vite/client"], "paths": { "uiSrc/*": ["redisinsight/ui/src/*"], - "apiSrc/*": ["redisinsight/api/src/*"], - "src/*": ["redisinsight/api/src/*"], "desktopSrc/*": ["redisinsight/desktop/src/*"], "tests/*": ["redisinsight/ui/__tests__/*"] }