diff --git a/package-lock.json b/package-lock.json index 62ecad279..1577fa41e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -33624,7 +33624,7 @@ }, "packages/compliance": { "name": "@redhat-cloud-services/compliance-client", - "version": "0.2.0", + "version": "0.2.2", "license": "Apache-2.0", "dependencies": { "@redhat-cloud-services/javascript-clients-shared": "^1.2.2", @@ -33667,7 +33667,7 @@ }, "packages/host-inventory": { "name": "@redhat-cloud-services/host-inventory-client", - "version": "1.5.0", + "version": "1.5.1", "license": "Apache-2.0", "dependencies": { "axios": "^0.27.2", @@ -33676,7 +33676,7 @@ }, "packages/insights": { "name": "@redhat-cloud-services/insights-client", - "version": "1.5.0", + "version": "1.5.1", "license": "Apache-2.0", "dependencies": { "axios": "^0.27.2", @@ -33685,7 +33685,7 @@ }, "packages/integrations": { "name": "@redhat-cloud-services/integrations-client", - "version": "2.5.0", + "version": "2.5.1", "license": "Apache-2.0", "dependencies": { "@redhat-cloud-services/javascript-clients-shared": "^1.2.2", @@ -33710,7 +33710,7 @@ }, "packages/notifications": { "name": "@redhat-cloud-services/notifications-client", - "version": "2.5.0", + "version": "2.5.1", "license": "Apache-2.0", "dependencies": { "@redhat-cloud-services/javascript-clients-shared": "^1.2.2", @@ -33735,7 +33735,7 @@ }, "packages/patch": { "name": "@redhat-cloud-services/patch-client", - "version": "1.5.0", + "version": "1.5.1", "license": "Apache-2.0", "dependencies": { "axios": "^0.27.2", @@ -33756,13 +33756,29 @@ "version": "1.5.0", "license": "Apache-2.0", "dependencies": { - "axios": "^0.27.2", + "@redhat-cloud-services/javascript-clients-shared": "^1.2.2", + "axios": "^1.7.2", "tslib": "^2.6.2" } }, + "packages/quickstarts/node_modules/axios": { + "version": "1.7.7", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz", + "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==", + "dependencies": { + "follow-redirects": "^1.15.6", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, + "packages/quickstarts/node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==" + }, "packages/rbac": { "name": "@redhat-cloud-services/rbac-client", - "version": "2.2.0", + "version": "2.2.2", "license": "Apache-2.0", "dependencies": { "@redhat-cloud-services/javascript-clients-shared": "^1.2.2", @@ -33838,7 +33854,7 @@ }, "packages/vulnerabilities": { "name": "@redhat-cloud-services/vulnerabilities-client", - "version": "1.5.0", + "version": "1.5.2", "license": "Apache-2.0", "dependencies": { "axios": "^0.27.2", @@ -40671,8 +40687,26 @@ "@redhat-cloud-services/quickstarts-client": { "version": "file:packages/quickstarts", "requires": { - "axios": "^0.27.2", + "@redhat-cloud-services/javascript-clients-shared": "^1.2.2", + "axios": "^1.7.2", "tslib": "^2.6.2" + }, + "dependencies": { + "axios": { + "version": "1.7.7", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz", + "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==", + "requires": { + "follow-redirects": "^1.15.6", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, + "proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==" + } } }, "@redhat-cloud-services/rbac-client": { diff --git a/packages/quickstarts/.npmignore b/packages/quickstarts/.npmignore index 999d88df6..6b112e4e7 100644 --- a/packages/quickstarts/.npmignore +++ b/packages/quickstarts/.npmignore @@ -1 +1,6 @@ -# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm \ No newline at end of file +.openapi-generator +node_modules +.openapi-generator-ignore +package-lock.json +*.ts +!*.d.ts diff --git a/packages/quickstarts/.openapi-generator/FILES b/packages/quickstarts/.openapi-generator/FILES index a80cd4f07..c942559fe 100644 --- a/packages/quickstarts/.openapi-generator/FILES +++ b/packages/quickstarts/.openapi-generator/FILES @@ -1,8 +1,16 @@ .gitignore .npmignore +FavoritesGet/index.ts +FavoritesPost/index.ts +HelptopicsGet/index.ts +HelptopicsNameGet/index.ts +QuickstartsGet/index.ts +QuickstartsIdGet/index.ts api.ts base.ts common.ts configuration.ts git_push.sh index.ts +index.ts +types/index.ts diff --git a/packages/quickstarts/.openapi-generator/VERSION b/packages/quickstarts/.openapi-generator/VERSION index 4ac4fded4..412252180 100644 --- a/packages/quickstarts/.openapi-generator/VERSION +++ b/packages/quickstarts/.openapi-generator/VERSION @@ -1 +1 @@ -6.2.0 \ No newline at end of file +7.0.0 \ No newline at end of file diff --git a/packages/quickstarts/FavoritesGet/index.ts b/packages/quickstarts/FavoritesGet/index.ts new file mode 100644 index 000000000..1bf7beaa5 --- /dev/null +++ b/packages/quickstarts/FavoritesGet/index.ts @@ -0,0 +1,49 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { BadRequest, FavoritesGet200Response } from '../types'; + + +export type FavoritesGetParams = { + options?: AxiosRequestConfig +} + +const isFavoritesGetObjectParams = (params: [FavoritesGetParams] | unknown[]): params is [FavoritesGetParams] => { + return params.length === 1 +} +/** +* +* @summary Returns list of all favorites +* @param {FavoritesGetParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const favoritesGetParamCreator = async (...config: ([FavoritesGetParams] | [AxiosRequestConfig])): Promise => { + const params = isFavoritesGetObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as FavoritesGetParams; + const { options = {} } = params; + const localVarPath = `/favorites`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + }; +} + +export default favoritesGetParamCreator; diff --git a/packages/quickstarts/FavoritesPost/index.ts b/packages/quickstarts/FavoritesPost/index.ts new file mode 100644 index 000000000..c16347c9a --- /dev/null +++ b/packages/quickstarts/FavoritesPost/index.ts @@ -0,0 +1,58 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { BadRequest, V1FavoriteQuickstart } from '../types'; + + +export type FavoritesPostParams = { + /** + * + * @type { V1FavoriteQuickstart } + * @memberof FavoritesPostApi + */ + v1FavoriteQuickstart?: V1FavoriteQuickstart, + options?: AxiosRequestConfig +} + +const isFavoritesPostObjectParams = (params: [FavoritesPostParams] | unknown[]): params is [FavoritesPostParams] => { + return params.length === 1 && true +} +/** +* +* @summary Add a favorite +* @param {FavoritesPostParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const favoritesPostParamCreator = async (...config: ([FavoritesPostParams] | [V1FavoriteQuickstart, AxiosRequestConfig])): Promise => { + const params = isFavoritesPostObjectParams(config) ? config[0] : ['v1FavoriteQuickstart', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as FavoritesPostParams; + const { v1FavoriteQuickstart, options = {} } = params; + const localVarPath = `/favorites`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'POST' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + serializeData: v1FavoriteQuickstart, + }; +} + +export default favoritesPostParamCreator; diff --git a/packages/quickstarts/HelptopicsGet/index.ts b/packages/quickstarts/HelptopicsGet/index.ts new file mode 100644 index 000000000..06ca68344 --- /dev/null +++ b/packages/quickstarts/HelptopicsGet/index.ts @@ -0,0 +1,49 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { HelptopicsGet200Response } from '../types'; + + +export type HelptopicsGetParams = { + options?: AxiosRequestConfig +} + +const isHelptopicsGetObjectParams = (params: [HelptopicsGetParams] | unknown[]): params is [HelptopicsGetParams] => { + return params.length === 1 +} +/** +* +* @summary Returns list of all help topics +* @param {HelptopicsGetParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const helptopicsGetParamCreator = async (...config: ([HelptopicsGetParams] | [AxiosRequestConfig])): Promise => { + const params = isHelptopicsGetObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as HelptopicsGetParams; + const { options = {} } = params; + const localVarPath = `/helptopics`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + }; +} + +export default helptopicsGetParamCreator; diff --git a/packages/quickstarts/HelptopicsNameGet/index.ts b/packages/quickstarts/HelptopicsNameGet/index.ts new file mode 100644 index 000000000..23fb80fc2 --- /dev/null +++ b/packages/quickstarts/HelptopicsNameGet/index.ts @@ -0,0 +1,49 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { BadRequest, HelptopicsNameGet200Response, NotFound } from '../types'; + + +export type HelptopicsNameGetParams = { + options?: AxiosRequestConfig +} + +const isHelptopicsNameGetObjectParams = (params: [HelptopicsNameGetParams] | unknown[]): params is [HelptopicsNameGetParams] => { + return params.length === 1 +} +/** +* +* @summary Return a help topics set by topic name +* @param {HelptopicsNameGetParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const helptopicsNameGetParamCreator = async (...config: ([HelptopicsNameGetParams] | [AxiosRequestConfig])): Promise => { + const params = isHelptopicsNameGetObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as HelptopicsNameGetParams; + const { options = {} } = params; + const localVarPath = `/helptopics/{name}`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + }; +} + +export default helptopicsNameGetParamCreator; diff --git a/packages/quickstarts/QuickstartsGet/index.ts b/packages/quickstarts/QuickstartsGet/index.ts new file mode 100644 index 000000000..e7d49b158 --- /dev/null +++ b/packages/quickstarts/QuickstartsGet/index.ts @@ -0,0 +1,49 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { QuickstartsGet200Response } from '../types'; + + +export type QuickstartsGetParams = { + options?: AxiosRequestConfig +} + +const isQuickstartsGetObjectParams = (params: [QuickstartsGetParams] | unknown[]): params is [QuickstartsGetParams] => { + return params.length === 1 +} +/** +* +* @summary Returns list of all quickstarts +* @param {QuickstartsGetParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const quickstartsGetParamCreator = async (...config: ([QuickstartsGetParams] | [AxiosRequestConfig])): Promise => { + const params = isQuickstartsGetObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as QuickstartsGetParams; + const { options = {} } = params; + const localVarPath = `/quickstarts`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + }; +} + +export default quickstartsGetParamCreator; diff --git a/packages/quickstarts/QuickstartsIdGet/index.ts b/packages/quickstarts/QuickstartsIdGet/index.ts new file mode 100644 index 000000000..f63b5b838 --- /dev/null +++ b/packages/quickstarts/QuickstartsIdGet/index.ts @@ -0,0 +1,49 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { BadRequest, NotFound, V1Quickstart } from '../types'; + + +export type QuickstartsIdGetParams = { + options?: AxiosRequestConfig +} + +const isQuickstartsIdGetObjectParams = (params: [QuickstartsIdGetParams] | unknown[]): params is [QuickstartsIdGetParams] => { + return params.length === 1 +} +/** +* +* @summary Return a quickstarts by ID +* @param {QuickstartsIdGetParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const quickstartsIdGetParamCreator = async (...config: ([QuickstartsIdGetParams] | [AxiosRequestConfig])): Promise => { + const params = isQuickstartsIdGetObjectParams(config) ? config[0] : ['options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as QuickstartsIdGetParams; + const { options = {} } = params; + const localVarPath = `/quickstarts/{id}`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + return { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + }; +} + +export default quickstartsIdGetParamCreator; diff --git a/packages/quickstarts/README.md b/packages/quickstarts/README.md index 72cfa1c54..7bf2a49ab 100644 --- a/packages/quickstarts/README.md +++ b/packages/quickstarts/README.md @@ -1,3 +1,59 @@ +# Javascript client for quickstarts API +If you want to use [RedHatInsights/quickstarts-backend](https://github.com/RedHatInsights/notifications-backend) you shouldn't use get requests directly, but rather use this client to integrate with the service. + +## Install +NPM +```bash +npm install --save @redhat-cloud-services/quickstarts-client +``` + +Or Yarn +```bash +yarn add @redhat-cloud-services/quickstarts-client +``` + +### Usage +This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately. + +To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it). +```JS +// api.js +import APIFactory from '@redhat-cloud-services/javascript-client-shared/dist/utils'; +import createEndpoint from '@redhat-cloud-services/quickstarts-client/dist/endpointResourceV1CreateEndpoint'; +import enableEndpoint from '@redhat-cloud-services/quickstarts-client/dist/endpointResourceV1EnableEndpoint'; + +// BASE_PATH should be set in your constants file +const quickstartsApi = APIFactory(BASE_PATH, undefined, { createEndpoint, enableEndpoint }); +export configMnagerApi; +``` + +If you want to add some interceptors you can use axios build in interceptors +```JS +// api.js +import axios from 'axios'; +import { quickstartsApi } from '@redhat-cloud-services/quickstarts-client'; +const instance = axios.create(); + +// Request interceptor +instance.interceptors.request.use((request) => { + // some logic to do with request +}); + +// Response interceptor +instance.interceptors.response.use((response) => { + // some logic to do with request +}); + +// Error interceptor +instance.interceptors.response.use(null, (error) => { + // some logic to do with error +}); + +// BASE_PATH should be set in your constants file +const quickstartsApi = APIFactory(BASE_PATH, instance, { createEndpoint, enableEndpoint }); +export quickstartsApi; +``` + ## Building Run `nx build @redhat-cloud-services/quickstarts-client` to build the library. diff --git a/packages/quickstarts/api.ts b/packages/quickstarts/api.ts index 1d2c39e73..4fb2116a3 100644 --- a/packages/quickstarts/api.ts +++ b/packages/quickstarts/api.ts @@ -13,13 +13,15 @@ */ -import { Configuration } from './configuration'; -import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import type { Configuration } from './configuration'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +import type { RequestArgs } from './base'; // @ts-ignore -import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; +import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base'; /** * @@ -168,10 +170,10 @@ export interface V1HelpTopic { 'createdAt'?: string; /** * - * @type {V1HelpTopicDeletedAt} + * @type {string} * @memberof V1HelpTopic */ - 'deletedAt'?: V1HelpTopicDeletedAt; + 'deletedAt'?: string | null; /** * * @type {string} @@ -203,12 +205,6 @@ export interface V1HelpTopic { */ 'updatedAt'?: string; } -/** - * @type V1HelpTopicDeletedAt - * @export - */ -export type V1HelpTopicDeletedAt = null | string; - /** * * @export @@ -223,10 +219,10 @@ export interface V1HelpTopicTagsInner { 'createdAt'?: string; /** * - * @type {V1HelpTopicDeletedAt} + * @type {string} * @memberof V1HelpTopicTagsInner */ - 'deletedAt'?: V1HelpTopicDeletedAt; + 'deletedAt'?: string | null; /** * * @type {number} @@ -272,10 +268,10 @@ export interface V1Quickstart { 'createdAt'?: string; /** * - * @type {V1HelpTopicDeletedAt} + * @type {string} * @memberof V1Quickstart */ - 'deletedAt'?: V1HelpTopicDeletedAt; + 'deletedAt'?: string | null; /** * * @type {Array} @@ -327,10 +323,10 @@ export interface V1QuickstartFavoriteQuickstartInner { 'createdAt'?: string; /** * - * @type {V1HelpTopicDeletedAt} + * @type {string} * @memberof V1QuickstartFavoriteQuickstartInner */ - 'deletedAt'?: V1HelpTopicDeletedAt; + 'deletedAt'?: string | null; /** * * @type {boolean} @@ -383,10 +379,10 @@ export interface V1QuickstartProgress { } /** - * DefaultApi - axios parameter creator + * FavoritesGetApi - axios parameter creator * @export */ -export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { +export const FavoritesGetApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * @@ -418,6 +414,75 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + } +}; + +/** + * FavoritesGetApi - functional programming interface + * @export + */ +export const FavoritesGetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = FavoritesGetApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Returns list of all favorites + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async favoritesGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.favoritesGet(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * FavoritesGetApi - factory interface + * @export + */ +export const FavoritesGetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = FavoritesGetApiFp(configuration) + return { + /** + * + * @summary Returns list of all favorites + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + favoritesGet(options?: any): AxiosPromise { + return localVarFp.favoritesGet(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * FavoritesGetApi - object-oriented interface + * @export + * @class FavoritesGetApi + * @extends {BaseAPI} + */ +export class FavoritesGetApi extends BaseAPI { + /** + * + * @summary Returns list of all favorites + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FavoritesGetApi + */ + public favoritesGet(options?: AxiosRequestConfig) { + return FavoritesGetApiFp(this.configuration).favoritesGet(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * FavoritesPostApi - axios parameter creator + * @export + */ +export const FavoritesPostApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** * * @summary Add a favorite @@ -452,6 +517,78 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + } +}; + +/** + * FavoritesPostApi - functional programming interface + * @export + */ +export const FavoritesPostApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = FavoritesPostApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Add a favorite + * @param {V1FavoriteQuickstart} [v1FavoriteQuickstart] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async favoritesPost(v1FavoriteQuickstart?: V1FavoriteQuickstart, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.favoritesPost(v1FavoriteQuickstart, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * FavoritesPostApi - factory interface + * @export + */ +export const FavoritesPostApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = FavoritesPostApiFp(configuration) + return { + /** + * + * @summary Add a favorite + * @param {V1FavoriteQuickstart} [v1FavoriteQuickstart] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + favoritesPost(v1FavoriteQuickstart?: V1FavoriteQuickstart, options?: any): AxiosPromise { + return localVarFp.favoritesPost(v1FavoriteQuickstart, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * FavoritesPostApi - object-oriented interface + * @export + * @class FavoritesPostApi + * @extends {BaseAPI} + */ +export class FavoritesPostApi extends BaseAPI { + /** + * + * @summary Add a favorite + * @param {V1FavoriteQuickstart} [v1FavoriteQuickstart] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof FavoritesPostApi + */ + public favoritesPost(v1FavoriteQuickstart?: V1FavoriteQuickstart, options?: AxiosRequestConfig) { + return FavoritesPostApiFp(this.configuration).favoritesPost(v1FavoriteQuickstart, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * HelptopicsGetApi - axios parameter creator + * @export + */ +export const HelptopicsGetApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** * * @summary Returns list of all help topics @@ -482,6 +619,75 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + } +}; + +/** + * HelptopicsGetApi - functional programming interface + * @export + */ +export const HelptopicsGetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = HelptopicsGetApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Returns list of all help topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async helptopicsGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.helptopicsGet(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * HelptopicsGetApi - factory interface + * @export + */ +export const HelptopicsGetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = HelptopicsGetApiFp(configuration) + return { + /** + * + * @summary Returns list of all help topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + helptopicsGet(options?: any): AxiosPromise { + return localVarFp.helptopicsGet(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * HelptopicsGetApi - object-oriented interface + * @export + * @class HelptopicsGetApi + * @extends {BaseAPI} + */ +export class HelptopicsGetApi extends BaseAPI { + /** + * + * @summary Returns list of all help topics + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HelptopicsGetApi + */ + public helptopicsGet(options?: AxiosRequestConfig) { + return HelptopicsGetApiFp(this.configuration).helptopicsGet(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * HelptopicsNameGetApi - axios parameter creator + * @export + */ +export const HelptopicsNameGetApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** * * @summary Return a help topics set by topic name @@ -512,6 +718,75 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + } +}; + +/** + * HelptopicsNameGetApi - functional programming interface + * @export + */ +export const HelptopicsNameGetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = HelptopicsNameGetApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Return a help topics set by topic name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async helptopicsNameGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.helptopicsNameGet(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * HelptopicsNameGetApi - factory interface + * @export + */ +export const HelptopicsNameGetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = HelptopicsNameGetApiFp(configuration) + return { + /** + * + * @summary Return a help topics set by topic name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + helptopicsNameGet(options?: any): AxiosPromise { + return localVarFp.helptopicsNameGet(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * HelptopicsNameGetApi - object-oriented interface + * @export + * @class HelptopicsNameGetApi + * @extends {BaseAPI} + */ +export class HelptopicsNameGetApi extends BaseAPI { + /** + * + * @summary Return a help topics set by topic name + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HelptopicsNameGetApi + */ + public helptopicsNameGet(options?: AxiosRequestConfig) { + return HelptopicsNameGetApiFp(this.configuration).helptopicsNameGet(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * QuickstartsGetApi - axios parameter creator + * @export + */ +export const QuickstartsGetApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** * * @summary Returns list of all quickstarts @@ -542,6 +817,75 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + } +}; + +/** + * QuickstartsGetApi - functional programming interface + * @export + */ +export const QuickstartsGetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = QuickstartsGetApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Returns list of all quickstarts + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async quickstartsGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.quickstartsGet(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + } +}; + +/** + * QuickstartsGetApi - factory interface + * @export + */ +export const QuickstartsGetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = QuickstartsGetApiFp(configuration) + return { + /** + * + * @summary Returns list of all quickstarts + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + quickstartsGet(options?: any): AxiosPromise { + return localVarFp.quickstartsGet(options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * QuickstartsGetApi - object-oriented interface + * @export + * @class QuickstartsGetApi + * @extends {BaseAPI} + */ +export class QuickstartsGetApi extends BaseAPI { + /** + * + * @summary Returns list of all quickstarts + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof QuickstartsGetApi + */ + public quickstartsGet(options?: AxiosRequestConfig) { + return QuickstartsGetApiFp(this.configuration).quickstartsGet(options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** + * QuickstartsIdGetApi - axios parameter creator + * @export + */ +export const QuickstartsIdGetApiAxiosParamCreator = function (configuration?: Configuration) { + return { /** * * @summary Return a quickstarts by ID @@ -576,63 +920,12 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; /** - * DefaultApi - functional programming interface + * QuickstartsIdGetApi - functional programming interface * @export */ -export const DefaultApiFp = function(configuration?: Configuration) { - const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) +export const QuickstartsIdGetApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = QuickstartsIdGetApiAxiosParamCreator(configuration) return { - /** - * - * @summary Returns list of all favorites - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async favoritesGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.favoritesGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Add a favorite - * @param {V1FavoriteQuickstart} [v1FavoriteQuickstart] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async favoritesPost(v1FavoriteQuickstart?: V1FavoriteQuickstart, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.favoritesPost(v1FavoriteQuickstart, options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Returns list of all help topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async helptopicsGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.helptopicsGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Return a help topics set by topic name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async helptopicsNameGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.helptopicsNameGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, - /** - * - * @summary Returns list of all quickstarts - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async quickstartsGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.quickstartsGet(options); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * * @summary Return a quickstarts by ID @@ -647,58 +940,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { }; /** - * DefaultApi - factory interface + * QuickstartsIdGetApi - factory interface * @export */ -export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - const localVarFp = DefaultApiFp(configuration) +export const QuickstartsIdGetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = QuickstartsIdGetApiFp(configuration) return { - /** - * - * @summary Returns list of all favorites - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - favoritesGet(options?: any): AxiosPromise { - return localVarFp.favoritesGet(options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Add a favorite - * @param {V1FavoriteQuickstart} [v1FavoriteQuickstart] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - favoritesPost(v1FavoriteQuickstart?: V1FavoriteQuickstart, options?: any): AxiosPromise { - return localVarFp.favoritesPost(v1FavoriteQuickstart, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Returns list of all help topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - helptopicsGet(options?: any): AxiosPromise { - return localVarFp.helptopicsGet(options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Return a help topics set by topic name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - helptopicsNameGet(options?: any): AxiosPromise { - return localVarFp.helptopicsNameGet(options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Returns list of all quickstarts - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - quickstartsGet(options?: any): AxiosPromise { - return localVarFp.quickstartsGet(options).then((request) => request(axios, basePath)); - }, /** * * @summary Return a quickstarts by ID @@ -712,78 +959,23 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa }; /** - * DefaultApi - object-oriented interface + * QuickstartsIdGetApi - object-oriented interface * @export - * @class DefaultApi + * @class QuickstartsIdGetApi * @extends {BaseAPI} */ -export class DefaultApi extends BaseAPI { - /** - * - * @summary Returns list of all favorites - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public favoritesGet(options?: AxiosRequestConfig) { - return DefaultApiFp(this.configuration).favoritesGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Add a favorite - * @param {V1FavoriteQuickstart} [v1FavoriteQuickstart] - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public favoritesPost(v1FavoriteQuickstart?: V1FavoriteQuickstart, options?: AxiosRequestConfig) { - return DefaultApiFp(this.configuration).favoritesPost(v1FavoriteQuickstart, options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Returns list of all help topics - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public helptopicsGet(options?: AxiosRequestConfig) { - return DefaultApiFp(this.configuration).helptopicsGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Return a help topics set by topic name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public helptopicsNameGet(options?: AxiosRequestConfig) { - return DefaultApiFp(this.configuration).helptopicsNameGet(options).then((request) => request(this.axios, this.basePath)); - } - - /** - * - * @summary Returns list of all quickstarts - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DefaultApi - */ - public quickstartsGet(options?: AxiosRequestConfig) { - return DefaultApiFp(this.configuration).quickstartsGet(options).then((request) => request(this.axios, this.basePath)); - } - +export class QuickstartsIdGetApi extends BaseAPI { /** * * @summary Return a quickstarts by ID * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DefaultApi + * @memberof QuickstartsIdGetApi */ public quickstartsIdGet(options?: AxiosRequestConfig) { - return DefaultApiFp(this.configuration).quickstartsIdGet(options).then((request) => request(this.axios, this.basePath)); + return QuickstartsIdGetApiFp(this.configuration).quickstartsIdGet(options).then((request) => request(this.axios, this.basePath)); } } + diff --git a/packages/quickstarts/base.ts b/packages/quickstarts/base.ts index 2a11ac818..6f6560f82 100644 --- a/packages/quickstarts/base.ts +++ b/packages/quickstarts/base.ts @@ -13,10 +13,11 @@ */ -import { Configuration } from "./configuration"; +import type { Configuration } from './configuration'; // Some imports not used depending on template conditions // @ts-ignore -import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; +import globalAxios from 'axios'; export const BASE_PATH = "http://localhost".replace(/\/+$/, ""); @@ -64,8 +65,8 @@ export class BaseAPI { * @extends {Error} */ export class RequiredError extends Error { - name: "RequiredError" = "RequiredError"; constructor(public field: string, msg?: string) { super(msg); + this.name = "RequiredError" } } diff --git a/packages/quickstarts/common.ts b/packages/quickstarts/common.ts index 8a18241ce..d9c4e35b5 100644 --- a/packages/quickstarts/common.ts +++ b/packages/quickstarts/common.ts @@ -13,9 +13,10 @@ */ -import { Configuration } from "./configuration"; -import { RequiredError, RequestArgs } from "./base"; -import { AxiosInstance, AxiosResponse } from 'axios'; +import type { Configuration } from "./configuration"; +import type { RequestArgs } from "./base"; +import type { AxiosInstance, AxiosResponse } from 'axios'; +import { RequiredError } from "./base"; /** * @@ -84,6 +85,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope } 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)); @@ -142,7 +144,7 @@ export const toPathString = function (url: URL) { */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url}; + const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || axios.defaults.baseURL || basePath) + axiosArgs.url}; return axios.request(axiosRequestArgs); }; } diff --git a/packages/quickstarts/doc/classes/Configuration.md b/packages/quickstarts/doc/classes/Configuration.md deleted file mode 100644 index 02e8fcb90..000000000 --- a/packages/quickstarts/doc/classes/Configuration.md +++ /dev/null @@ -1,202 +0,0 @@ -[@redhat-cloud-services/quickstarts-client](../README.md) / [Exports](../modules.md) / Configuration - -# Class: Configuration - -## Table of contents - -### Constructors - -- [constructor](Configuration.md#constructor) - -### Properties - -- [accessToken](Configuration.md#accesstoken) -- [apiKey](Configuration.md#apikey) -- [baseOptions](Configuration.md#baseoptions) -- [basePath](Configuration.md#basepath) -- [formDataCtor](Configuration.md#formdatactor) -- [password](Configuration.md#password) -- [username](Configuration.md#username) - -### Methods - -- [isJsonMime](Configuration.md#isjsonmime) - -## Constructors - -### constructor - -• **new Configuration**(`param?`): [`Configuration`](Configuration.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) | - -#### Returns - -[`Configuration`](Configuration.md) - -#### Defined in - -[configuration.ts:77](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L77) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| `Promise`\<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`\<`string`\> - -parameter for oauth2 security - -**`Param`** - -security name - -**`Param`** - -oauth2 scope - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:53](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L53) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -parameter for apiKey security - -**`Param`** - -security name - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:32](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L32) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -base options for axios calls - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L67) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -override base path - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:60](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L60) - -___ - -### formDataCtor - -• `Optional` **formDataCtor**: () => `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 declaration - -• **new formDataCtor**(): `any` - -##### Returns - -`any` - -#### Defined in - -[configuration.ts:75](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L75) - -___ - -### password - -• `Optional` **password**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:46](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L46) - -___ - -### username - -• `Optional` **username**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L39) - -## Methods - -### isJsonMime - -▸ **isJsonMime**(`mime`): `boolean` - -Check if the given MIME is a JSON MIME. -JSON MIME examples: - application/json - application/json; charset=UTF8 - APPLICATION/JSON - application/vnd.company+json - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `mime` | `string` | MIME (Multipurpose Internet Mail Extensions) | - -#### Returns - -`boolean` - -True if the given MIME is JSON, false otherwise. - -#### Defined in - -[configuration.ts:97](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L97) diff --git a/packages/quickstarts/doc/classes/DefaultApi.md b/packages/quickstarts/doc/classes/DefaultApi.md deleted file mode 100644 index e1dfac355..000000000 --- a/packages/quickstarts/doc/classes/DefaultApi.md +++ /dev/null @@ -1,285 +0,0 @@ -[@redhat-cloud-services/quickstarts-client](../README.md) / [Exports](../modules.md) / DefaultApi - -# Class: DefaultApi - -DefaultApi - object-oriented interface - -**`Export`** - -DefaultApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`DefaultApi`** - -## Table of contents - -### Constructors - -- [constructor](DefaultApi.md#constructor) - -### Properties - -- [axios](DefaultApi.md#axios) -- [basePath](DefaultApi.md#basepath) -- [configuration](DefaultApi.md#configuration) - -### Methods - -- [favoritesGet](DefaultApi.md#favoritesget) -- [favoritesPost](DefaultApi.md#favoritespost) -- [helptopicsGet](DefaultApi.md#helptopicsget) -- [helptopicsNameGet](DefaultApi.md#helptopicsnameget) -- [quickstartsGet](DefaultApi.md#quickstartsget) -- [quickstartsIdGet](DefaultApi.md#quickstartsidget) - -## Constructors - -### constructor - -• **new DefaultApi**(`configuration?`, `basePath?`, `axios?`): [`DefaultApi`](DefaultApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`DefaultApi`](DefaultApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/base.ts#L52) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/base.ts#L52) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/base.ts#L52) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:50](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/base.ts#L50) - -## Methods - -### favoritesGet - -▸ **favoritesGet**(`options?`): `Promise`\<`AxiosResponse`\<[`FavoritesGet200Response`](../interfaces/FavoritesGet200Response.md), `any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`\<`any`\> | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`FavoritesGet200Response`](../interfaces/FavoritesGet200Response.md), `any`\>\> - -**`Summary`** - -Returns list of all favorites - -**`Throws`** - -**`Memberof`** - -DefaultApi - -#### Defined in - -[api.ts:728](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L728) - -___ - -### favoritesPost - -▸ **favoritesPost**(`v1FavoriteQuickstart?`, `options?`): `Promise`\<`AxiosResponse`\<[`V1FavoriteQuickstart`](../interfaces/V1FavoriteQuickstart.md), `any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `v1FavoriteQuickstart?` | [`V1FavoriteQuickstart`](../interfaces/V1FavoriteQuickstart.md) | | -| `options?` | `AxiosRequestConfig`\<`any`\> | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`V1FavoriteQuickstart`](../interfaces/V1FavoriteQuickstart.md), `any`\>\> - -**`Summary`** - -Add a favorite - -**`Throws`** - -**`Memberof`** - -DefaultApi - -#### Defined in - -[api.ts:740](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L740) - -___ - -### helptopicsGet - -▸ **helptopicsGet**(`options?`): `Promise`\<`AxiosResponse`\<[`HelptopicsGet200Response`](../interfaces/HelptopicsGet200Response.md), `any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`\<`any`\> | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HelptopicsGet200Response`](../interfaces/HelptopicsGet200Response.md), `any`\>\> - -**`Summary`** - -Returns list of all help topics - -**`Throws`** - -**`Memberof`** - -DefaultApi - -#### Defined in - -[api.ts:751](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L751) - -___ - -### helptopicsNameGet - -▸ **helptopicsNameGet**(`options?`): `Promise`\<`AxiosResponse`\<[`HelptopicsNameGet200Response`](../interfaces/HelptopicsNameGet200Response.md), `any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`\<`any`\> | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HelptopicsNameGet200Response`](../interfaces/HelptopicsNameGet200Response.md), `any`\>\> - -**`Summary`** - -Return a help topics set by topic name - -**`Throws`** - -**`Memberof`** - -DefaultApi - -#### Defined in - -[api.ts:762](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L762) - -___ - -### quickstartsGet - -▸ **quickstartsGet**(`options?`): `Promise`\<`AxiosResponse`\<[`QuickstartsGet200Response`](../interfaces/QuickstartsGet200Response.md), `any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`\<`any`\> | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`QuickstartsGet200Response`](../interfaces/QuickstartsGet200Response.md), `any`\>\> - -**`Summary`** - -Returns list of all quickstarts - -**`Throws`** - -**`Memberof`** - -DefaultApi - -#### Defined in - -[api.ts:773](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L773) - -___ - -### quickstartsIdGet - -▸ **quickstartsIdGet**(`options?`): `Promise`\<`AxiosResponse`\<[`V1Quickstart`](../interfaces/V1Quickstart.md), `any`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`\<`any`\> | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`V1Quickstart`](../interfaces/V1Quickstart.md), `any`\>\> - -**`Summary`** - -Return a quickstarts by ID - -**`Throws`** - -**`Memberof`** - -DefaultApi - -#### Defined in - -[api.ts:784](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L784) diff --git a/packages/quickstarts/doc/interfaces/BadRequest.md b/packages/quickstarts/doc/interfaces/BadRequest.md index 1cab3b477..a18c75828 100644 --- a/packages/quickstarts/doc/interfaces/BadRequest.md +++ b/packages/quickstarts/doc/interfaces/BadRequest.md @@ -24,4 +24,4 @@ BadRequest #### Defined in -[api.ts:35](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L35) +types/index.ts:12 diff --git a/packages/quickstarts/doc/interfaces/ConfigurationParameters.md b/packages/quickstarts/doc/interfaces/ConfigurationParameters.md deleted file mode 100644 index 4f61d3546..000000000 --- a/packages/quickstarts/doc/interfaces/ConfigurationParameters.md +++ /dev/null @@ -1,102 +0,0 @@ -[@redhat-cloud-services/quickstarts-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters - -# Interface: ConfigurationParameters - -quickstarts -No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - -The version of the OpenAPI document: 1.0.0 - -NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -https://openapi-generator.tech -Do not edit the class manually. - -## Table of contents - -### Properties - -- [accessToken](ConfigurationParameters.md#accesstoken) -- [apiKey](ConfigurationParameters.md#apikey) -- [baseOptions](ConfigurationParameters.md#baseoptions) -- [basePath](ConfigurationParameters.md#basepath) -- [formDataCtor](ConfigurationParameters.md#formdatactor) -- [password](ConfigurationParameters.md#password) -- [username](ConfigurationParameters.md#username) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| `Promise`\<`string`\> \| (`name?`: `string`, `scopes?`: `string`[]) => `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `Promise`\<`string`\> - -#### Defined in - -[configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L20) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -#### Defined in - -[configuration.ts:17](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L17) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -#### Defined in - -[configuration.ts:22](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L22) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -#### Defined in - -[configuration.ts:21](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L21) - -___ - -### formDataCtor - -• `Optional` **formDataCtor**: () => `any` - -#### Type declaration - -• **new formDataCtor**(): `any` - -##### Returns - -`any` - -#### Defined in - -[configuration.ts:23](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L23) - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -[configuration.ts:19](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L19) - -___ - -### username - -• `Optional` **username**: `string` - -#### Defined in - -[configuration.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/configuration.ts#L18) diff --git a/packages/quickstarts/doc/interfaces/FavoritesGet200Response.md b/packages/quickstarts/doc/interfaces/FavoritesGet200Response.md index ce5f67bb5..bb230a30b 100644 --- a/packages/quickstarts/doc/interfaces/FavoritesGet200Response.md +++ b/packages/quickstarts/doc/interfaces/FavoritesGet200Response.md @@ -24,4 +24,4 @@ FavoritesGet200Response #### Defined in -[api.ts:48](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L48) +types/index.ts:25 diff --git a/packages/quickstarts/doc/interfaces/HelptopicsGet200Response.md b/packages/quickstarts/doc/interfaces/HelptopicsGet200Response.md index dfbad19a6..fd49441bf 100644 --- a/packages/quickstarts/doc/interfaces/HelptopicsGet200Response.md +++ b/packages/quickstarts/doc/interfaces/HelptopicsGet200Response.md @@ -24,4 +24,4 @@ HelptopicsGet200Response #### Defined in -[api.ts:61](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L61) +types/index.ts:38 diff --git a/packages/quickstarts/doc/interfaces/HelptopicsNameGet200Response.md b/packages/quickstarts/doc/interfaces/HelptopicsNameGet200Response.md index 883bb0ca0..0a405226c 100644 --- a/packages/quickstarts/doc/interfaces/HelptopicsNameGet200Response.md +++ b/packages/quickstarts/doc/interfaces/HelptopicsNameGet200Response.md @@ -24,4 +24,4 @@ HelptopicsNameGet200Response #### Defined in -[api.ts:74](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L74) +types/index.ts:51 diff --git a/packages/quickstarts/doc/interfaces/NotFound.md b/packages/quickstarts/doc/interfaces/NotFound.md index af7ef7534..8d9b47348 100644 --- a/packages/quickstarts/doc/interfaces/NotFound.md +++ b/packages/quickstarts/doc/interfaces/NotFound.md @@ -24,4 +24,4 @@ NotFound #### Defined in -[api.ts:87](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L87) +types/index.ts:64 diff --git a/packages/quickstarts/doc/interfaces/QuickstartsGet200Response.md b/packages/quickstarts/doc/interfaces/QuickstartsGet200Response.md index d8c337659..d6a9d00da 100644 --- a/packages/quickstarts/doc/interfaces/QuickstartsGet200Response.md +++ b/packages/quickstarts/doc/interfaces/QuickstartsGet200Response.md @@ -24,4 +24,4 @@ QuickstartsGet200Response #### Defined in -[api.ts:100](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L100) +types/index.ts:77 diff --git a/packages/quickstarts/doc/interfaces/V1FavoriteQuickstart.md b/packages/quickstarts/doc/interfaces/V1FavoriteQuickstart.md index 27ae15e30..d702a3f87 100644 --- a/packages/quickstarts/doc/interfaces/V1FavoriteQuickstart.md +++ b/packages/quickstarts/doc/interfaces/V1FavoriteQuickstart.md @@ -30,7 +30,7 @@ V1FavoriteQuickstart #### Defined in -[api.ts:113](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L113) +types/index.ts:90 ___ @@ -44,7 +44,7 @@ V1FavoriteQuickstart #### Defined in -[api.ts:119](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L119) +types/index.ts:96 ___ @@ -58,7 +58,7 @@ V1FavoriteQuickstart #### Defined in -[api.ts:125](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L125) +types/index.ts:102 ___ @@ -72,7 +72,7 @@ V1FavoriteQuickstart #### Defined in -[api.ts:131](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L131) +types/index.ts:108 ___ @@ -86,7 +86,7 @@ V1FavoriteQuickstart #### Defined in -[api.ts:137](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L137) +types/index.ts:114 ___ @@ -100,7 +100,7 @@ V1FavoriteQuickstart #### Defined in -[api.ts:143](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L143) +types/index.ts:120 ___ @@ -114,4 +114,4 @@ V1FavoriteQuickstart #### Defined in -[api.ts:149](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L149) +types/index.ts:126 diff --git a/packages/quickstarts/doc/interfaces/V1HelpTopic.md b/packages/quickstarts/doc/interfaces/V1HelpTopic.md index a980ecded..974381f43 100644 --- a/packages/quickstarts/doc/interfaces/V1HelpTopic.md +++ b/packages/quickstarts/doc/interfaces/V1HelpTopic.md @@ -31,7 +31,7 @@ V1HelpTopic #### Defined in -[api.ts:162](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L162) +types/index.ts:139 ___ @@ -45,13 +45,13 @@ V1HelpTopic #### Defined in -[api.ts:168](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L168) +types/index.ts:145 ___ ### deletedAt -• `Optional` **deletedAt**: [`V1HelpTopicDeletedAt`](../modules.md#v1helptopicdeletedat) +• `Optional` **deletedAt**: ``null`` \| `string` **`Memberof`** @@ -59,7 +59,7 @@ V1HelpTopic #### Defined in -[api.ts:174](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L174) +types/index.ts:151 ___ @@ -73,7 +73,7 @@ V1HelpTopic #### Defined in -[api.ts:180](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L180) +types/index.ts:157 ___ @@ -87,7 +87,7 @@ V1HelpTopic #### Defined in -[api.ts:186](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L186) +types/index.ts:163 ___ @@ -101,7 +101,7 @@ V1HelpTopic #### Defined in -[api.ts:192](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L192) +types/index.ts:169 ___ @@ -115,7 +115,7 @@ V1HelpTopic #### Defined in -[api.ts:198](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L198) +types/index.ts:175 ___ @@ -129,4 +129,4 @@ V1HelpTopic #### Defined in -[api.ts:204](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L204) +types/index.ts:181 diff --git a/packages/quickstarts/doc/interfaces/V1HelpTopicTagsInner.md b/packages/quickstarts/doc/interfaces/V1HelpTopicTagsInner.md index 2f34b499a..790418eb1 100644 --- a/packages/quickstarts/doc/interfaces/V1HelpTopicTagsInner.md +++ b/packages/quickstarts/doc/interfaces/V1HelpTopicTagsInner.md @@ -29,13 +29,13 @@ V1HelpTopicTagsInner #### Defined in -[api.ts:223](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L223) +types/index.ts:194 ___ ### deletedAt -• `Optional` **deletedAt**: [`V1HelpTopicDeletedAt`](../modules.md#v1helptopicdeletedat) +• `Optional` **deletedAt**: ``null`` \| `string` **`Memberof`** @@ -43,7 +43,7 @@ V1HelpTopicTagsInner #### Defined in -[api.ts:229](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L229) +types/index.ts:200 ___ @@ -57,7 +57,7 @@ V1HelpTopicTagsInner #### Defined in -[api.ts:235](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L235) +types/index.ts:206 ___ @@ -71,7 +71,7 @@ V1HelpTopicTagsInner #### Defined in -[api.ts:241](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L241) +types/index.ts:212 ___ @@ -85,7 +85,7 @@ V1HelpTopicTagsInner #### Defined in -[api.ts:247](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L247) +types/index.ts:218 ___ @@ -99,4 +99,4 @@ V1HelpTopicTagsInner #### Defined in -[api.ts:253](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L253) +types/index.ts:224 diff --git a/packages/quickstarts/doc/interfaces/V1Quickstart.md b/packages/quickstarts/doc/interfaces/V1Quickstart.md index bd9284b02..d70acf773 100644 --- a/packages/quickstarts/doc/interfaces/V1Quickstart.md +++ b/packages/quickstarts/doc/interfaces/V1Quickstart.md @@ -31,7 +31,7 @@ V1Quickstart #### Defined in -[api.ts:266](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L266) +types/index.ts:237 ___ @@ -45,13 +45,13 @@ V1Quickstart #### Defined in -[api.ts:272](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L272) +types/index.ts:243 ___ ### deletedAt -• `Optional` **deletedAt**: [`V1HelpTopicDeletedAt`](../modules.md#v1helptopicdeletedat) +• `Optional` **deletedAt**: ``null`` \| `string` **`Memberof`** @@ -59,7 +59,7 @@ V1Quickstart #### Defined in -[api.ts:278](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L278) +types/index.ts:249 ___ @@ -73,7 +73,7 @@ V1Quickstart #### Defined in -[api.ts:284](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L284) +types/index.ts:255 ___ @@ -87,7 +87,7 @@ V1Quickstart #### Defined in -[api.ts:290](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L290) +types/index.ts:261 ___ @@ -101,7 +101,7 @@ V1Quickstart #### Defined in -[api.ts:296](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L296) +types/index.ts:267 ___ @@ -115,7 +115,7 @@ V1Quickstart #### Defined in -[api.ts:302](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L302) +types/index.ts:273 ___ @@ -129,4 +129,4 @@ V1Quickstart #### Defined in -[api.ts:308](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L308) +types/index.ts:279 diff --git a/packages/quickstarts/doc/interfaces/V1QuickstartFavoriteQuickstartInner.md b/packages/quickstarts/doc/interfaces/V1QuickstartFavoriteQuickstartInner.md index 717a55450..220ac5e75 100644 --- a/packages/quickstarts/doc/interfaces/V1QuickstartFavoriteQuickstartInner.md +++ b/packages/quickstarts/doc/interfaces/V1QuickstartFavoriteQuickstartInner.md @@ -30,7 +30,7 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:321](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L321) +types/index.ts:292 ___ @@ -44,13 +44,13 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:327](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L327) +types/index.ts:298 ___ ### deletedAt -• `Optional` **deletedAt**: [`V1HelpTopicDeletedAt`](../modules.md#v1helptopicdeletedat) +• `Optional` **deletedAt**: ``null`` \| `string` **`Memberof`** @@ -58,7 +58,7 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:333](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L333) +types/index.ts:304 ___ @@ -72,7 +72,7 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:339](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L339) +types/index.ts:310 ___ @@ -86,7 +86,7 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:345](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L345) +types/index.ts:316 ___ @@ -100,7 +100,7 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:351](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L351) +types/index.ts:322 ___ @@ -114,4 +114,4 @@ V1QuickstartFavoriteQuickstartInner #### Defined in -[api.ts:357](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L357) +types/index.ts:328 diff --git a/packages/quickstarts/doc/interfaces/V1QuickstartProgress.md b/packages/quickstarts/doc/interfaces/V1QuickstartProgress.md index f00705f5e..a26579df0 100644 --- a/packages/quickstarts/doc/interfaces/V1QuickstartProgress.md +++ b/packages/quickstarts/doc/interfaces/V1QuickstartProgress.md @@ -26,7 +26,7 @@ V1QuickstartProgress #### Defined in -[api.ts:370](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L370) +types/index.ts:341 ___ @@ -40,7 +40,7 @@ V1QuickstartProgress #### Defined in -[api.ts:376](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L376) +types/index.ts:347 ___ @@ -54,4 +54,4 @@ V1QuickstartProgress #### Defined in -[api.ts:382](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L382) +types/index.ts:353 diff --git a/packages/quickstarts/doc/modules.md b/packages/quickstarts/doc/modules.md index 3ca066ed6..c610001df 100644 --- a/packages/quickstarts/doc/modules.md +++ b/packages/quickstarts/doc/modules.md @@ -4,15 +4,9 @@ ## Table of contents -### Classes - -- [Configuration](classes/Configuration.md) -- [DefaultApi](classes/DefaultApi.md) - ### Interfaces - [BadRequest](interfaces/BadRequest.md) -- [ConfigurationParameters](interfaces/ConfigurationParameters.md) - [FavoritesGet200Response](interfaces/FavoritesGet200Response.md) - [HelptopicsGet200Response](interfaces/HelptopicsGet200Response.md) - [HelptopicsNameGet200Response](interfaces/HelptopicsNameGet200Response.md) @@ -25,125 +19,167 @@ - [V1QuickstartFavoriteQuickstartInner](interfaces/V1QuickstartFavoriteQuickstartInner.md) - [V1QuickstartProgress](interfaces/V1QuickstartProgress.md) -### Type Aliases +### Functions -- [V1HelpTopicDeletedAt](modules.md#v1helptopicdeletedat) +- [favoritesGet](modules.md#favoritesget) +- [favoritesPost](modules.md#favoritespost) +- [helptopicsGet](modules.md#helptopicsget) +- [helptopicsNameGet](modules.md#helptopicsnameget) +- [quickstartsGet](modules.md#quickstartsget) +- [quickstartsIdGet](modules.md#quickstartsidget) -### Functions +## Functions -- [DefaultApiAxiosParamCreator](modules.md#defaultapiaxiosparamcreator) -- [DefaultApiFactory](modules.md#defaultapifactory) -- [DefaultApiFp](modules.md#defaultapifp) +### favoritesGet -## Type Aliases +▸ **favoritesGet**(`...config`): `Promise`\<`RequestArgs`\> -### V1HelpTopicDeletedAt +#### Parameters -Ƭ **V1HelpTopicDeletedAt**: ``null`` \| `string` +| Name | Type | Description | +| :------ | :------ | :------ | +| `...config` | [`FavoritesGetParams`] \| [`AxiosRequestConfig`\<`any`\>] | with all available params. | -**`Export`** +#### Returns -#### Defined in +`Promise`\<`RequestArgs`\> -[api.ts:210](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L210) +**`Summary`** -## Functions +Returns list of all favorites + +**`Throws`** + +#### Defined in + +FavoritesGet/index.ts:28 -### DefaultApiAxiosParamCreator +___ -▸ **DefaultApiAxiosParamCreator**(`configuration?`): `Object` +### favoritesPost -DefaultApi - axios parameter creator +▸ **favoritesPost**(`...config`): `Promise`\<`RequestArgs`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | +| Name | Type | Description | +| :------ | :------ | :------ | +| `...config` | [`FavoritesPostParams`] \| [[`V1FavoriteQuickstart`](interfaces/V1FavoriteQuickstart.md), `AxiosRequestConfig`\<`any`\>] | with all available params. | #### Returns -`Object` +`Promise`\<`RequestArgs`\> + +**`Summary`** + +Add a favorite + +**`Throws`** + +#### Defined in + +FavoritesPost/index.ts:34 + +___ + +### helptopicsGet + +▸ **helptopicsGet**(`...config`): `Promise`\<`RequestArgs`\> + +#### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `favoritesGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<`RequestArgs`\> | - | -| `favoritesPost` | (`v1FavoriteQuickstart?`: [`V1FavoriteQuickstart`](interfaces/V1FavoriteQuickstart.md), `options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<`RequestArgs`\> | - | -| `helptopicsGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<`RequestArgs`\> | - | -| `helptopicsNameGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<`RequestArgs`\> | - | -| `quickstartsGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<`RequestArgs`\> | - | -| `quickstartsIdGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<`RequestArgs`\> | - | +| `...config` | [`AxiosRequestConfig`\<`any`\>] \| [`HelptopicsGetParams`] | with all available params. | -**`Export`** +#### Returns + +`Promise`\<`RequestArgs`\> + +**`Summary`** + +Returns list of all help topics + +**`Throws`** #### Defined in -[api.ts:389](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L389) +HelptopicsGet/index.ts:28 ___ -### DefaultApiFactory - -▸ **DefaultApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` +### helptopicsNameGet -DefaultApi - factory interface +▸ **helptopicsNameGet**(`...config`): `Promise`\<`RequestArgs`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | +| Name | Type | Description | +| :------ | :------ | :------ | +| `...config` | [`AxiosRequestConfig`\<`any`\>] \| [`HelptopicsNameGetParams`] | with all available params. | #### Returns -`Object` +`Promise`\<`RequestArgs`\> -| Name | Type | -| :------ | :------ | -| `favoritesGet` | (`options?`: `any`) => `AxiosPromise`\<[`FavoritesGet200Response`](interfaces/FavoritesGet200Response.md)\> | -| `favoritesPost` | (`v1FavoriteQuickstart?`: [`V1FavoriteQuickstart`](interfaces/V1FavoriteQuickstart.md), `options?`: `any`) => `AxiosPromise`\<[`V1FavoriteQuickstart`](interfaces/V1FavoriteQuickstart.md)\> | -| `helptopicsGet` | (`options?`: `any`) => `AxiosPromise`\<[`HelptopicsGet200Response`](interfaces/HelptopicsGet200Response.md)\> | -| `helptopicsNameGet` | (`options?`: `any`) => `AxiosPromise`\<[`HelptopicsNameGet200Response`](interfaces/HelptopicsNameGet200Response.md)\> | -| `quickstartsGet` | (`options?`: `any`) => `AxiosPromise`\<[`QuickstartsGet200Response`](interfaces/QuickstartsGet200Response.md)\> | -| `quickstartsIdGet` | (`options?`: `any`) => `AxiosPromise`\<[`V1Quickstart`](interfaces/V1Quickstart.md)\> | +**`Summary`** -**`Export`** +Return a help topics set by topic name + +**`Throws`** #### Defined in -[api.ts:653](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L653) +HelptopicsNameGet/index.ts:28 ___ -### DefaultApiFp +### quickstartsGet + +▸ **quickstartsGet**(`...config`): `Promise`\<`RequestArgs`\> -▸ **DefaultApiFp**(`configuration?`): `Object` +#### Parameters -DefaultApi - functional programming interface +| Name | Type | Description | +| :------ | :------ | :------ | +| `...config` | [`AxiosRequestConfig`\<`any`\>] \| [`QuickstartsGetParams`] | with all available params. | + +#### Returns + +`Promise`\<`RequestArgs`\> + +**`Summary`** + +Returns list of all quickstarts + +**`Throws`** + +#### Defined in + +QuickstartsGet/index.ts:28 + +___ + +### quickstartsIdGet + +▸ **quickstartsIdGet**(`...config`): `Promise`\<`RequestArgs`\> #### Parameters -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | +| Name | Type | Description | +| :------ | :------ | :------ | +| `...config` | [`AxiosRequestConfig`\<`any`\>] \| [`QuickstartsIdGetParams`] | with all available params. | #### Returns -`Object` +`Promise`\<`RequestArgs`\> + +**`Summary`** -| Name | Type | -| :------ | :------ | -| `favoritesGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`FavoritesGet200Response`](interfaces/FavoritesGet200Response.md)\>\> | -| `favoritesPost` | (`v1FavoriteQuickstart?`: [`V1FavoriteQuickstart`](interfaces/V1FavoriteQuickstart.md), `options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`V1FavoriteQuickstart`](interfaces/V1FavoriteQuickstart.md)\>\> | -| `helptopicsGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`HelptopicsGet200Response`](interfaces/HelptopicsGet200Response.md)\>\> | -| `helptopicsNameGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`HelptopicsNameGet200Response`](interfaces/HelptopicsNameGet200Response.md)\>\> | -| `quickstartsGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`QuickstartsGet200Response`](interfaces/QuickstartsGet200Response.md)\>\> | -| `quickstartsIdGet` | (`options?`: `AxiosRequestConfig`\<`any`\>) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`V1Quickstart`](interfaces/V1Quickstart.md)\>\> | +Return a quickstarts by ID -**`Export`** +**`Throws`** #### Defined in -[api.ts:582](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/quickstarts/api.ts#L582) +QuickstartsIdGet/index.ts:28 diff --git a/packages/quickstarts/index.ts b/packages/quickstarts/index.ts index e62f70a3d..ffae283ac 100644 --- a/packages/quickstarts/index.ts +++ b/packages/quickstarts/index.ts @@ -1,18 +1,28 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * quickstarts - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.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"; +// This is a sample supporting file mustache template. +export * from './types' + +export { default as favoritesGet } from './FavoritesGet' + + +// end of operations block +export { default as favoritesPost } from './FavoritesPost' + + +// end of operations block +export { default as helptopicsGet } from './HelptopicsGet' + + +// end of operations block +export { default as helptopicsNameGet } from './HelptopicsNameGet' + + +// end of operations block +export { default as quickstartsGet } from './QuickstartsGet' + + +// end of operations block +export { default as quickstartsIdGet } from './QuickstartsIdGet' + + +// end of operations block diff --git a/packages/quickstarts/openapitools.json b/packages/quickstarts/openapitools.json index 7f8d0939e..06ac15078 100644 --- a/packages/quickstarts/openapitools.json +++ b/packages/quickstarts/openapitools.json @@ -2,6 +2,6 @@ "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "6.2.0" + "version": "7.0.0" } } diff --git a/packages/quickstarts/package.json b/packages/quickstarts/package.json index ac97b8371..fa9ecfc90 100644 --- a/packages/quickstarts/package.json +++ b/packages/quickstarts/package.json @@ -21,7 +21,8 @@ "access": "public" }, "dependencies": { - "axios": "^0.27.2", - "tslib": "^2.6.2" + "axios": "^1.7.2", + "tslib": "^2.6.2", + "@redhat-cloud-services/javascript-clients-shared": "^1.2.2" } } diff --git a/packages/quickstarts/project.json b/packages/quickstarts/project.json index 1b8337169..9766472a5 100644 --- a/packages/quickstarts/project.json +++ b/packages/quickstarts/project.json @@ -7,7 +7,6 @@ "generate": { "executor": "@redhat-cloud-services/build-utils:client-generator", "options": { - "legacyGenerator": true, "specs": { "default": "https://raw.githubusercontent.com/RedHatInsights/quickstarts/main/spec/openapi.yaml" } diff --git a/packages/quickstarts/types/index.ts b/packages/quickstarts/types/index.ts new file mode 100644 index 000000000..f018843c5 --- /dev/null +++ b/packages/quickstarts/types/index.ts @@ -0,0 +1,354 @@ +/** + * + * @export + * @interface BadRequest + */ +export interface BadRequest { + /** + * + * @type {string} + * @memberof BadRequest + */ + 'msg'?: string; +} +/** + * + * @export + * @interface FavoritesGet200Response + */ +export interface FavoritesGet200Response { + /** + * + * @type {Array} + * @memberof FavoritesGet200Response + */ + 'data'?: Array; +} +/** + * + * @export + * @interface HelptopicsGet200Response + */ +export interface HelptopicsGet200Response { + /** + * + * @type {Array} + * @memberof HelptopicsGet200Response + */ + 'data'?: Array; +} +/** + * + * @export + * @interface HelptopicsNameGet200Response + */ +export interface HelptopicsNameGet200Response { + /** + * + * @type {V1HelpTopic} + * @memberof HelptopicsNameGet200Response + */ + 'data'?: V1HelpTopic; +} +/** + * + * @export + * @interface NotFound + */ +export interface NotFound { + /** + * + * @type {string} + * @memberof NotFound + */ + 'msg'?: string; +} +/** + * + * @export + * @interface QuickstartsGet200Response + */ +export interface QuickstartsGet200Response { + /** + * + * @type {Array} + * @memberof QuickstartsGet200Response + */ + 'data'?: Array; +} +/** + * + * @export + * @interface V1FavoriteQuickstart + */ +export interface V1FavoriteQuickstart { + /** + * + * @type {string} + * @memberof V1FavoriteQuickstart + */ + 'accountId'?: string; + /** + * + * @type {string} + * @memberof V1FavoriteQuickstart + */ + 'createdAt'?: string; + /** + * + * @type {any} + * @memberof V1FavoriteQuickstart + */ + 'deletedAt'?: any; + /** + * + * @type {boolean} + * @memberof V1FavoriteQuickstart + */ + 'favorite'?: boolean; + /** + * + * @type {number} + * @memberof V1FavoriteQuickstart + */ + 'id'?: number; + /** + * + * @type {string} + * @memberof V1FavoriteQuickstart + */ + 'quickstartName'?: string; + /** + * + * @type {string} + * @memberof V1FavoriteQuickstart + */ + 'updatedAt'?: string; +} +/** + * + * @export + * @interface V1HelpTopic + */ +export interface V1HelpTopic { + /** + * + * @type {object} + * @memberof V1HelpTopic + */ + 'content'?: object; + /** + * + * @type {string} + * @memberof V1HelpTopic + */ + 'createdAt'?: string; + /** + * + * @type {string} + * @memberof V1HelpTopic + */ + 'deletedAt'?: string | null; + /** + * + * @type {string} + * @memberof V1HelpTopic + */ + 'groupName'?: string; + /** + * + * @type {number} + * @memberof V1HelpTopic + */ + 'id'?: number; + /** + * + * @type {string} + * @memberof V1HelpTopic + */ + 'name'?: string; + /** + * + * @type {Array} + * @memberof V1HelpTopic + */ + 'tags'?: Array; + /** + * + * @type {string} + * @memberof V1HelpTopic + */ + 'updatedAt'?: string; +} +/** + * + * @export + * @interface V1HelpTopicTagsInner + */ +export interface V1HelpTopicTagsInner { + /** + * + * @type {string} + * @memberof V1HelpTopicTagsInner + */ + 'createdAt'?: string; + /** + * + * @type {string} + * @memberof V1HelpTopicTagsInner + */ + 'deletedAt'?: string | null; + /** + * + * @type {number} + * @memberof V1HelpTopicTagsInner + */ + 'id'?: number; + /** + * + * @type {string} + * @memberof V1HelpTopicTagsInner + */ + 'type'?: string; + /** + * + * @type {string} + * @memberof V1HelpTopicTagsInner + */ + 'updatedAt'?: string; + /** + * + * @type {string} + * @memberof V1HelpTopicTagsInner + */ + 'value'?: string; +} +/** + * + * @export + * @interface V1Quickstart + */ +export interface V1Quickstart { + /** + * + * @type {object} + * @memberof V1Quickstart + */ + 'content'?: object; + /** + * + * @type {string} + * @memberof V1Quickstart + */ + 'createdAt'?: string; + /** + * + * @type {string} + * @memberof V1Quickstart + */ + 'deletedAt'?: string | null; + /** + * + * @type {Array} + * @memberof V1Quickstart + */ + 'favoriteQuickstart'?: Array; + /** + * + * @type {number} + * @memberof V1Quickstart + */ + 'id'?: number; + /** + * + * @type {string} + * @memberof V1Quickstart + */ + 'name'?: string; + /** + * + * @type {Array} + * @memberof V1Quickstart + */ + 'tags'?: Array; + /** + * + * @type {string} + * @memberof V1Quickstart + */ + 'updatedAt'?: string; +} +/** + * + * @export + * @interface V1QuickstartFavoriteQuickstartInner + */ +export interface V1QuickstartFavoriteQuickstartInner { + /** + * + * @type {string} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'accountId'?: string; + /** + * + * @type {string} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'createdAt'?: string; + /** + * + * @type {string} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'deletedAt'?: string | null; + /** + * + * @type {boolean} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'favorite'?: boolean; + /** + * + * @type {number} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'id'?: number; + /** + * + * @type {string} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'quickstartName'?: string; + /** + * + * @type {string} + * @memberof V1QuickstartFavoriteQuickstartInner + */ + 'updatedAt'?: string; +} +/** + * + * @export + * @interface V1QuickstartProgress + */ +export interface V1QuickstartProgress { + /** + * + * @type {number} + * @memberof V1QuickstartProgress + */ + 'accountId'?: number; + /** + * + * @type {string} + * @memberof V1QuickstartProgress + */ + 'progress'?: string; + /** + * + * @type {string} + * @memberof V1QuickstartProgress + */ + 'quickstartName'?: string; +}