diff --git a/api.ts b/api.ts index 9fa4c6a..d2fcd6d 100644 --- a/api.ts +++ b/api.ts @@ -1547,7 +1547,7 @@ export interface CrawlersRun200Response { */ export interface CrawlersRunRequest { /** - * URLs to crawl + * Optional URLs to crawl (overrides crawler\'s default URL configuration). If not provided, the crawler will use its configured URLs or perform a full crawl. * @type {Array} * @memberof CrawlersRunRequest */ @@ -16293,7 +16293,7 @@ export const CrawlersApiAxiosParamCreator = function (configuration?: Configurat * @summary Delete a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16477,7 +16477,7 @@ export const CrawlersApiAxiosParamCreator = function (configuration?: Configurat * @summary Get details of a single crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16524,19 +16524,17 @@ export const CrawlersApiAxiosParamCreator = function (configuration?: Configurat * @param {string} organization Organization identifier * @param {string} project Project identifier * @param {string} crawler Crawler identifier - * @param {CrawlersRunRequest} crawlersRunRequest + * @param {CrawlersRunRequest} [crawlersRunRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - crawlersRun: async (organization: string, project: string, crawler: string, crawlersRunRequest: CrawlersRunRequest, options: RawAxiosRequestConfig = {}): Promise => { + crawlersRun: async (organization: string, project: string, crawler: string, crawlersRunRequest?: CrawlersRunRequest, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'organization' is not null or undefined assertParamExists('crawlersRun', 'organization', organization) // verify required parameter 'project' is not null or undefined assertParamExists('crawlersRun', 'project', project) // verify required parameter 'crawler' is not null or undefined assertParamExists('crawlersRun', 'crawler', crawler) - // verify required parameter 'crawlersRunRequest' is not null or undefined - assertParamExists('crawlersRun', 'crawlersRunRequest', crawlersRunRequest) const localVarPath = `/api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run` .replace(`{${"organization"}}`, encodeURIComponent(String(organization))) .replace(`{${"project"}}`, encodeURIComponent(String(project))) @@ -16575,7 +16573,7 @@ export const CrawlersApiAxiosParamCreator = function (configuration?: Configurat * @summary Update a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {V2CrawlerRequest} v2CrawlerRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -16652,7 +16650,7 @@ export const CrawlersApiFp = function(configuration?: Configuration) { * @summary Delete a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16701,7 +16699,7 @@ export const CrawlersApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async crawlersList(organization: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + async crawlersList(organization: string, project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.crawlersList(organization, project, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CrawlersApi.crawlersList']?.[localVarOperationServerIndex]?.url; @@ -16712,7 +16710,7 @@ export const CrawlersApiFp = function(configuration?: Configuration) { * @summary Get details of a single crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16728,11 +16726,11 @@ export const CrawlersApiFp = function(configuration?: Configuration) { * @param {string} organization Organization identifier * @param {string} project Project identifier * @param {string} crawler Crawler identifier - * @param {CrawlersRunRequest} crawlersRunRequest + * @param {CrawlersRunRequest} [crawlersRunRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async crawlersRun(organization: string, project: string, crawler: string, crawlersRunRequest: CrawlersRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async crawlersRun(organization: string, project: string, crawler: string, crawlersRunRequest?: CrawlersRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.crawlersRun(organization, project, crawler, crawlersRunRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CrawlersApi.crawlersRun']?.[localVarOperationServerIndex]?.url; @@ -16743,7 +16741,7 @@ export const CrawlersApiFp = function(configuration?: Configuration) { * @summary Update a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {V2CrawlerRequest} v2CrawlerRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -16781,7 +16779,7 @@ export const CrawlersApiFactory = function (configuration?: Configuration, baseP * @summary Delete a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16821,7 +16819,7 @@ export const CrawlersApiFactory = function (configuration?: Configuration, baseP * @param {*} [options] Override http request option. * @throws {RequiredError} */ - crawlersList(organization: string, project: string, options?: RawAxiosRequestConfig): AxiosPromise> { + crawlersList(organization: string, project: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.crawlersList(organization, project, options).then((request) => request(axios, basePath)); }, /** @@ -16829,7 +16827,7 @@ export const CrawlersApiFactory = function (configuration?: Configuration, baseP * @summary Get details of a single crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -16842,11 +16840,11 @@ export const CrawlersApiFactory = function (configuration?: Configuration, baseP * @param {string} organization Organization identifier * @param {string} project Project identifier * @param {string} crawler Crawler identifier - * @param {CrawlersRunRequest} crawlersRunRequest + * @param {CrawlersRunRequest} [crawlersRunRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - crawlersRun(organization: string, project: string, crawler: string, crawlersRunRequest: CrawlersRunRequest, options?: RawAxiosRequestConfig): AxiosPromise { + crawlersRun(organization: string, project: string, crawler: string, crawlersRunRequest?: CrawlersRunRequest, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.crawlersRun(organization, project, crawler, crawlersRunRequest, options).then((request) => request(axios, basePath)); }, /** @@ -16854,7 +16852,7 @@ export const CrawlersApiFactory = function (configuration?: Configuration, baseP * @summary Update a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {V2CrawlerRequest} v2CrawlerRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -16891,7 +16889,7 @@ export class CrawlersApi extends BaseAPI { * @summary Delete a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CrawlersApi @@ -16947,7 +16945,7 @@ export class CrawlersApi extends BaseAPI { * @summary Get details of a single crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CrawlersApi @@ -16962,12 +16960,12 @@ export class CrawlersApi extends BaseAPI { * @param {string} organization Organization identifier * @param {string} project Project identifier * @param {string} crawler Crawler identifier - * @param {CrawlersRunRequest} crawlersRunRequest + * @param {CrawlersRunRequest} [crawlersRunRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CrawlersApi */ - public crawlersRun(organization: string, project: string, crawler: string, crawlersRunRequest: CrawlersRunRequest, options?: RawAxiosRequestConfig) { + public crawlersRun(organization: string, project: string, crawler: string, crawlersRunRequest?: CrawlersRunRequest, options?: RawAxiosRequestConfig) { return CrawlersApiFp(this.configuration).crawlersRun(organization, project, crawler, crawlersRunRequest, options).then((request) => request(this.axios, this.basePath)); } @@ -16976,7 +16974,7 @@ export class CrawlersApi extends BaseAPI { * @summary Update a crawler * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} crawler + * @param {string} crawler The UUID of the crawler * @param {V2CrawlerRequest} v2CrawlerRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -17756,7 +17754,7 @@ export const DomainsApiAxiosParamCreator = function (configuration?: Configurati * @summary Delete a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -17844,7 +17842,7 @@ export const DomainsApiAxiosParamCreator = function (configuration?: Configurati * @summary Get details of a single domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -17890,7 +17888,7 @@ export const DomainsApiAxiosParamCreator = function (configuration?: Configurati * @summary Renew the SSL certificate for a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -17961,7 +17959,7 @@ export const DomainsApiFp = function(configuration?: Configuration) { * @summary Delete a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -17990,7 +17988,7 @@ export const DomainsApiFp = function(configuration?: Configuration) { * @summary Get details of a single domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -18005,7 +18003,7 @@ export const DomainsApiFp = function(configuration?: Configuration) { * @summary Renew the SSL certificate for a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -18042,7 +18040,7 @@ export const DomainsApiFactory = function (configuration?: Configuration, basePa * @summary Delete a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -18065,7 +18063,7 @@ export const DomainsApiFactory = function (configuration?: Configuration, basePa * @summary Get details of a single domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -18077,7 +18075,7 @@ export const DomainsApiFactory = function (configuration?: Configuration, basePa * @summary Renew the SSL certificate for a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -18113,7 +18111,7 @@ export class DomainsApi extends BaseAPI { * @summary Delete a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DomainsApi @@ -18140,7 +18138,7 @@ export class DomainsApi extends BaseAPI { * @summary Get details of a single domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DomainsApi @@ -18154,7 +18152,7 @@ export class DomainsApi extends BaseAPI { * @summary Renew the SSL certificate for a domain * @param {string} organization Organization identifier * @param {string} project Project identifier - * @param {string} domain Domain identifier + * @param {string} domain Domain id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DomainsApi @@ -19224,8 +19222,8 @@ export const HeadersApiAxiosParamCreator = function (configuration?: Configurati /** * * @summary Create or update custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19272,8 +19270,8 @@ export const HeadersApiAxiosParamCreator = function (configuration?: Configurati /** * * @summary Delete custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19320,8 +19318,8 @@ export const HeadersApiAxiosParamCreator = function (configuration?: Configurati /** * * @summary List custom headers for a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19372,8 +19370,8 @@ export const HeadersApiFp = function(configuration?: Configuration) { /** * * @summary Create or update custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19387,8 +19385,8 @@ export const HeadersApiFp = function(configuration?: Configuration) { /** * * @summary Delete custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19402,8 +19400,8 @@ export const HeadersApiFp = function(configuration?: Configuration) { /** * * @summary List custom headers for a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19426,8 +19424,8 @@ export const HeadersApiFactory = function (configuration?: Configuration, basePa /** * * @summary Create or update custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19438,8 +19436,8 @@ export const HeadersApiFactory = function (configuration?: Configuration, basePa /** * * @summary Delete custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19450,8 +19448,8 @@ export const HeadersApiFactory = function (configuration?: Configuration, basePa /** * * @summary List custom headers for a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19471,8 +19469,8 @@ export class HeadersApi extends BaseAPI { /** * * @summary Create or update custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19485,8 +19483,8 @@ export class HeadersApi extends BaseAPI { /** * * @summary Delete custom headers - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2CustomHeaderRequest} v2CustomHeaderRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19499,8 +19497,8 @@ export class HeadersApi extends BaseAPI { /** * * @summary List custom headers for a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HeadersApi @@ -19521,8 +19519,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary Add a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2StoreRequest} v2StoreRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19569,8 +19567,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary Delete a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19615,8 +19613,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary Add an item to a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {V2StoreItemRequest} v2StoreItemRequest * @param {*} [options] Override http request option. @@ -19667,8 +19665,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary Delete an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -19717,8 +19715,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary List items in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} [cursor] Cursor for pagination * @param {number} [limit] Number of items to return @@ -19783,8 +19781,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction. * @summary Get an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -19833,8 +19831,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary Update an item in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {V2StoreItemUpdateRequest} v2StoreItemUpdateRequest @@ -19889,8 +19887,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary List key-value stores - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -19931,8 +19929,8 @@ export const KVApiAxiosParamCreator = function (configuration?: Configuration) { /** * * @summary Get a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -19987,8 +19985,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary Add a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2StoreRequest} v2StoreRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20002,8 +20000,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary Delete a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20017,8 +20015,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary Add an item to a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {V2StoreItemRequest} v2StoreItemRequest * @param {*} [options] Override http request option. @@ -20033,8 +20031,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary Delete an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -20049,8 +20047,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary List items in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} [cursor] Cursor for pagination * @param {number} [limit] Number of items to return @@ -20068,8 +20066,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction. * @summary Get an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -20084,8 +20082,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary Update an item in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {V2StoreItemUpdateRequest} v2StoreItemUpdateRequest @@ -20101,8 +20099,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary List key-value stores - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20115,8 +20113,8 @@ export const KVApiFp = function(configuration?: Configuration) { /** * * @summary Get a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20140,8 +20138,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary Add a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2StoreRequest} v2StoreRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20152,8 +20150,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary Delete a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20164,8 +20162,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary Add an item to a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {V2StoreItemRequest} v2StoreItemRequest * @param {*} [options] Override http request option. @@ -20177,8 +20175,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary Delete an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -20190,8 +20188,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary List items in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} [cursor] Cursor for pagination * @param {number} [limit] Number of items to return @@ -20206,8 +20204,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction. * @summary Get an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -20219,8 +20217,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary Update an item in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {V2StoreItemUpdateRequest} v2StoreItemUpdateRequest @@ -20233,8 +20231,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary List key-value stores - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20244,8 +20242,8 @@ export const KVApiFactory = function (configuration?: Configuration, basePath?: /** * * @summary Get a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20266,8 +20264,8 @@ export class KVApi extends BaseAPI { /** * * @summary Add a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2StoreRequest} v2StoreRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20280,8 +20278,8 @@ export class KVApi extends BaseAPI { /** * * @summary Delete a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20294,8 +20292,8 @@ export class KVApi extends BaseAPI { /** * * @summary Add an item to a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {V2StoreItemRequest} v2StoreItemRequest * @param {*} [options] Override http request option. @@ -20309,8 +20307,8 @@ export class KVApi extends BaseAPI { /** * * @summary Delete an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -20324,8 +20322,8 @@ export class KVApi extends BaseAPI { /** * * @summary List items in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} [cursor] Cursor for pagination * @param {number} [limit] Number of items to return @@ -20342,8 +20340,8 @@ export class KVApi extends BaseAPI { /** * Retrieves an item from the KV store. **Security Note:** If the item was stored as a secret (secret=true), the value will be redacted and returned as \'[ENCRYPTED]\' for security. Secrets should be accessed directly via the Quant Cloud platform KVStore abstraction. * @summary Get an item from a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {*} [options] Override http request option. @@ -20357,8 +20355,8 @@ export class KVApi extends BaseAPI { /** * * @summary Update an item in a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {string} key * @param {V2StoreItemUpdateRequest} v2StoreItemUpdateRequest @@ -20373,8 +20371,8 @@ export class KVApi extends BaseAPI { /** * * @summary List key-value stores - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof KVApi @@ -20386,8 +20384,8 @@ export class KVApi extends BaseAPI { /** * * @summary Get a kv store - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {string} storeId * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20443,7 +20441,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi /** * * @summary Get details of a single organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20503,7 +20501,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { /** * * @summary Get details of a single organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20535,7 +20533,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, /** * * @summary Get details of a single organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20566,7 +20564,7 @@ export class OrganizationsApi extends BaseAPI { /** * * @summary Get details of a single organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationsApi @@ -20587,7 +20585,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Create a new project - * @param {string} organization + * @param {string} organization Organization identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20631,8 +20629,8 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Delete a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20673,7 +20671,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Retrieve all projects for an organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20711,8 +20709,8 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Get details of a single project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {boolean} withToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20760,8 +20758,8 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat /** * * @summary Update a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20818,7 +20816,7 @@ export const ProjectsApiFp = function(configuration?: Configuration) { /** * * @summary Create a new project - * @param {string} organization + * @param {string} organization Organization identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20832,8 +20830,8 @@ export const ProjectsApiFp = function(configuration?: Configuration) { /** * * @summary Delete a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20846,7 +20844,7 @@ export const ProjectsApiFp = function(configuration?: Configuration) { /** * * @summary Retrieve all projects for an organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20859,8 +20857,8 @@ export const ProjectsApiFp = function(configuration?: Configuration) { /** * * @summary Get details of a single project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {boolean} withToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20874,8 +20872,8 @@ export const ProjectsApiFp = function(configuration?: Configuration) { /** * * @summary Update a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20899,7 +20897,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP /** * * @summary Create a new project - * @param {string} organization + * @param {string} organization Organization identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20910,8 +20908,8 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP /** * * @summary Delete a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20921,7 +20919,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP /** * * @summary Retrieve all projects for an organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -20931,8 +20929,8 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP /** * * @summary Get details of a single project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {boolean} withToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20943,8 +20941,8 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP /** * * @summary Update a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20965,7 +20963,7 @@ export class ProjectsApi extends BaseAPI { /** * * @summary Create a new project - * @param {string} organization + * @param {string} organization Organization identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -20978,8 +20976,8 @@ export class ProjectsApi extends BaseAPI { /** * * @summary Delete a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi @@ -20991,7 +20989,7 @@ export class ProjectsApi extends BaseAPI { /** * * @summary Retrieve all projects for an organization - * @param {string} organization + * @param {string} organization Organization identifier * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProjectsApi @@ -21003,8 +21001,8 @@ export class ProjectsApi extends BaseAPI { /** * * @summary Get details of a single project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {boolean} withToken * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -21017,8 +21015,8 @@ export class ProjectsApi extends BaseAPI { /** * * @summary Update a project - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {V2ProjectRequest} v2ProjectRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -21040,8 +21038,8 @@ export const PurgeApiAxiosParamCreator = function (configuration?: Configuration /** * * @summary Purge cache via URL or cache keys - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {PurgeCreateRequest} purgeCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -21098,8 +21096,8 @@ export const PurgeApiFp = function(configuration?: Configuration) { /** * * @summary Purge cache via URL or cache keys - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {PurgeCreateRequest} purgeCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -21123,8 +21121,8 @@ export const PurgeApiFactory = function (configuration?: Configuration, basePath /** * * @summary Purge cache via URL or cache keys - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {PurgeCreateRequest} purgeCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -21145,8 +21143,8 @@ export class PurgeApi extends BaseAPI { /** * * @summary Purge cache via URL or cache keys - * @param {string} organization - * @param {string} project + * @param {string} organization Organization identifier + * @param {string} project Project identifier * @param {PurgeCreateRequest} purgeCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -25158,9 +25156,9 @@ export const SSHAccessApiAxiosParamCreator = function (configuration?: Configura /** * * @summary Get SSH access credentials for an environment - * @param {string} organisation The organisation machine name - * @param {string} application The application name - * @param {string} environment The environment name + * @param {string} organisation The organisation ID + * @param {string} application The application ID + * @param {string} environment The environment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25214,9 +25212,9 @@ export const SSHAccessApiFp = function(configuration?: Configuration) { /** * * @summary Get SSH access credentials for an environment - * @param {string} organisation The organisation machine name - * @param {string} application The application name - * @param {string} environment The environment name + * @param {string} organisation The organisation ID + * @param {string} application The application ID + * @param {string} environment The environment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25239,9 +25237,9 @@ export const SSHAccessApiFactory = function (configuration?: Configuration, base /** * * @summary Get SSH access credentials for an environment - * @param {string} organisation The organisation machine name - * @param {string} application The application name - * @param {string} environment The environment name + * @param {string} organisation The organisation ID + * @param {string} application The application ID + * @param {string} environment The environment ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25261,9 +25259,9 @@ export class SSHAccessApi extends BaseAPI { /** * * @summary Get SSH access credentials for an environment - * @param {string} organisation The organisation machine name - * @param {string} application The application name - * @param {string} environment The environment name + * @param {string} organisation The organisation ID + * @param {string} application The application ID + * @param {string} environment The environment ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SSHAccessApi diff --git a/docs/CrawlersApi.md b/docs/CrawlersApi.md index 5f6d65c..ddbdb78 100644 --- a/docs/CrawlersApi.md +++ b/docs/CrawlersApi.md @@ -89,7 +89,7 @@ const apiInstance = new CrawlersApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) -let crawler: string; // (default to undefined) +let crawler: string; //The UUID of the crawler (default to undefined) const { status, data } = await apiInstance.crawlersDelete( organization, @@ -104,7 +104,7 @@ const { status, data } = await apiInstance.crawlersDelete( |------------- | ------------- | ------------- | -------------| | **organization** | [**string**] | Organization identifier | defaults to undefined| | **project** | [**string**] | Project identifier | defaults to undefined| -| **crawler** | [**string**] | | defaults to undefined| +| **crawler** | [**string**] | The UUID of the crawler | defaults to undefined| ### Return type @@ -254,7 +254,7 @@ const { status, data } = await apiInstance.crawlersGetRuns( [[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) # **crawlersList** -> Array crawlersList() +> crawlersList() ### Example @@ -287,7 +287,7 @@ const { status, data } = await apiInstance.crawlersList( ### Return type -**Array** +void (empty response body) ### Authorization @@ -302,7 +302,6 @@ const { status, data } = await apiInstance.crawlersList( ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -|**200** | The request has succeeded. | - | |**400** | The server could not understand the request due to invalid syntax. | - | |**403** | Access is forbidden. | - | @@ -325,7 +324,7 @@ const apiInstance = new CrawlersApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) -let crawler: string; // (default to undefined) +let crawler: string; //The UUID of the crawler (default to undefined) const { status, data } = await apiInstance.crawlersRead( organization, @@ -340,7 +339,7 @@ const { status, data } = await apiInstance.crawlersRead( |------------- | ------------- | ------------- | -------------| | **organization** | [**string**] | Organization identifier | defaults to undefined| | **project** | [**string**] | Project identifier | defaults to undefined| -| **crawler** | [**string**] | | defaults to undefined| +| **crawler** | [**string**] | The UUID of the crawler | defaults to undefined| ### Return type @@ -367,7 +366,7 @@ const { status, data } = await apiInstance.crawlersRead( [[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) # **crawlersRun** -> CrawlersRun200Response crawlersRun(crawlersRunRequest) +> CrawlersRun200Response crawlersRun() ### Example @@ -385,7 +384,7 @@ const apiInstance = new CrawlersApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) let crawler: string; //Crawler identifier (default to undefined) -let crawlersRunRequest: CrawlersRunRequest; // +let crawlersRunRequest: CrawlersRunRequest; // (optional) const { status, data } = await apiInstance.crawlersRun( organization, @@ -448,7 +447,7 @@ const apiInstance = new CrawlersApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) -let crawler: string; // (default to undefined) +let crawler: string; //The UUID of the crawler (default to undefined) let v2CrawlerRequest: V2CrawlerRequest; // const { status, data } = await apiInstance.crawlersUpdate( @@ -466,7 +465,7 @@ const { status, data } = await apiInstance.crawlersUpdate( | **v2CrawlerRequest** | **V2CrawlerRequest**| | | | **organization** | [**string**] | Organization identifier | defaults to undefined| | **project** | [**string**] | Project identifier | defaults to undefined| -| **crawler** | [**string**] | | defaults to undefined| +| **crawler** | [**string**] | The UUID of the crawler | defaults to undefined| ### Return type diff --git a/docs/CrawlersRunRequest.md b/docs/CrawlersRunRequest.md index 59d0d12..831e216 100644 --- a/docs/CrawlersRunRequest.md +++ b/docs/CrawlersRunRequest.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**urls** | **Array<string>** | URLs to crawl | [optional] [default to undefined] +**urls** | **Array<string>** | Optional URLs to crawl (overrides crawler\'s default URL configuration). If not provided, the crawler will use its configured URLs or perform a full crawl. | [optional] [default to undefined] ## Example diff --git a/docs/DomainsApi.md b/docs/DomainsApi.md index 6db1b29..937bb96 100644 --- a/docs/DomainsApi.md +++ b/docs/DomainsApi.md @@ -86,7 +86,7 @@ const apiInstance = new DomainsApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) -let domain: string; //Domain identifier (default to undefined) +let domain: string; //Domain id (default to undefined) const { status, data } = await apiInstance.domainsDelete( organization, @@ -101,7 +101,7 @@ const { status, data } = await apiInstance.domainsDelete( |------------- | ------------- | ------------- | -------------| | **organization** | [**string**] | Organization identifier | defaults to undefined| | **project** | [**string**] | Project identifier | defaults to undefined| -| **domain** | [**string**] | Domain identifier | defaults to undefined| +| **domain** | [**string**] | Domain id | defaults to undefined| ### Return type @@ -199,7 +199,7 @@ const apiInstance = new DomainsApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) -let domain: string; //Domain identifier (default to undefined) +let domain: string; //Domain id (default to undefined) const { status, data } = await apiInstance.domainsRead( organization, @@ -214,7 +214,7 @@ const { status, data } = await apiInstance.domainsRead( |------------- | ------------- | ------------- | -------------| | **organization** | [**string**] | Organization identifier | defaults to undefined| | **project** | [**string**] | Project identifier | defaults to undefined| -| **domain** | [**string**] | Domain identifier | defaults to undefined| +| **domain** | [**string**] | Domain id | defaults to undefined| ### Return type @@ -257,7 +257,7 @@ const apiInstance = new DomainsApi(configuration); let organization: string; //Organization identifier (default to undefined) let project: string; //Project identifier (default to undefined) -let domain: string; //Domain identifier (default to undefined) +let domain: string; //Domain id (default to undefined) const { status, data } = await apiInstance.domainsRenew( organization, @@ -272,7 +272,7 @@ const { status, data } = await apiInstance.domainsRenew( |------------- | ------------- | ------------- | -------------| | **organization** | [**string**] | Organization identifier | defaults to undefined| | **project** | [**string**] | Project identifier | defaults to undefined| -| **domain** | [**string**] | Domain identifier | defaults to undefined| +| **domain** | [**string**] | Domain id | defaults to undefined| ### Return type diff --git a/docs/HeadersApi.md b/docs/HeadersApi.md index f24f62e..a1ed5f2 100644 --- a/docs/HeadersApi.md +++ b/docs/HeadersApi.md @@ -24,8 +24,8 @@ import { const configuration = new Configuration(); const apiInstance = new HeadersApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let v2CustomHeaderRequest: V2CustomHeaderRequest; // const { status, data } = await apiInstance.headersCreate( @@ -40,8 +40,8 @@ const { status, data } = await apiInstance.headersCreate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2CustomHeaderRequest** | **V2CustomHeaderRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type @@ -83,8 +83,8 @@ import { const configuration = new Configuration(); const apiInstance = new HeadersApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let v2CustomHeaderRequest: V2CustomHeaderRequest; // const { status, data } = await apiInstance.headersDelete( @@ -99,8 +99,8 @@ const { status, data } = await apiInstance.headersDelete( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2CustomHeaderRequest** | **V2CustomHeaderRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type @@ -141,8 +141,8 @@ import { const configuration = new Configuration(); const apiInstance = new HeadersApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) const { status, data } = await apiInstance.headersList( organization, @@ -154,8 +154,8 @@ const { status, data } = await apiInstance.headersList( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type diff --git a/docs/KVApi.md b/docs/KVApi.md index f2faf49..829f346 100644 --- a/docs/KVApi.md +++ b/docs/KVApi.md @@ -30,8 +30,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let v2StoreRequest: V2StoreRequest; // const { status, data } = await apiInstance.kVCreate( @@ -46,8 +46,8 @@ const { status, data } = await apiInstance.kVCreate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2StoreRequest** | **V2StoreRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type @@ -88,8 +88,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) const { status, data } = await apiInstance.kVDelete( @@ -103,8 +103,8 @@ const { status, data } = await apiInstance.kVDelete( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| @@ -147,8 +147,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) let v2StoreItemRequest: V2StoreItemRequest; // @@ -165,8 +165,8 @@ const { status, data } = await apiInstance.kVItemsCreate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2StoreItemRequest** | **V2StoreItemRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| @@ -209,8 +209,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) let key: string; // (default to undefined) @@ -226,8 +226,8 @@ const { status, data } = await apiInstance.kVItemsDelete( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| | **key** | [**string**] | | defaults to undefined| @@ -270,8 +270,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) let cursor: string; //Cursor for pagination (optional) (default to undefined) let limit: number; //Number of items to return (optional) (default to 10) @@ -293,8 +293,8 @@ const { status, data } = await apiInstance.kVItemsList( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| | **cursor** | [**string**] | Cursor for pagination | (optional) defaults to undefined| | **limit** | [**number**] | Number of items to return | (optional) defaults to 10| @@ -341,8 +341,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) let key: string; // (default to undefined) @@ -358,8 +358,8 @@ const { status, data } = await apiInstance.kVItemsShow( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| | **key** | [**string**] | | defaults to undefined| @@ -403,8 +403,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) let key: string; // (default to undefined) let v2StoreItemUpdateRequest: V2StoreItemUpdateRequest; // @@ -423,8 +423,8 @@ const { status, data } = await apiInstance.kVItemsUpdate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2StoreItemUpdateRequest** | **V2StoreItemUpdateRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| | **key** | [**string**] | | defaults to undefined| @@ -468,8 +468,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) const { status, data } = await apiInstance.kVList( organization, @@ -481,8 +481,8 @@ const { status, data } = await apiInstance.kVList( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type @@ -523,8 +523,8 @@ import { const configuration = new Configuration(); const apiInstance = new KVApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let storeId: string; // (default to undefined) const { status, data } = await apiInstance.kVShow( @@ -538,8 +538,8 @@ const { status, data } = await apiInstance.kVShow( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **storeId** | [**string**] | | defaults to undefined| diff --git a/docs/OrganizationsApi.md b/docs/OrganizationsApi.md index 092618c..ef6e97b 100644 --- a/docs/OrganizationsApi.md +++ b/docs/OrganizationsApi.md @@ -67,7 +67,7 @@ import { const configuration = new Configuration(); const apiInstance = new OrganizationsApi(configuration); -let organization: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) const { status, data } = await apiInstance.organizationsRead( organization @@ -78,7 +78,7 @@ const { status, data } = await apiInstance.organizationsRead( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| ### Return type @@ -99,6 +99,7 @@ const { status, data } = await apiInstance.organizationsRead( | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | The request has succeeded. | - | +|**404** | Organization not found. | - | |**400** | The server could not understand the request due to invalid syntax. | - | |**403** | Access is forbidden. | - | diff --git a/docs/ProjectsApi.md b/docs/ProjectsApi.md index 2ae18d7..9f73997 100644 --- a/docs/ProjectsApi.md +++ b/docs/ProjectsApi.md @@ -26,7 +26,7 @@ import { const configuration = new Configuration(); const apiInstance = new ProjectsApi(configuration); -let organization: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) let v2ProjectRequest: V2ProjectRequest; // const { status, data } = await apiInstance.projectsCreate( @@ -40,7 +40,7 @@ const { status, data } = await apiInstance.projectsCreate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2ProjectRequest** | **V2ProjectRequest**| | | -| **organization** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| ### Return type @@ -81,8 +81,8 @@ import { const configuration = new Configuration(); const apiInstance = new ProjectsApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) const { status, data } = await apiInstance.projectsDelete( organization, @@ -94,8 +94,8 @@ const { status, data } = await apiInstance.projectsDelete( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type @@ -136,7 +136,7 @@ import { const configuration = new Configuration(); const apiInstance = new ProjectsApi(configuration); -let organization: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) const { status, data } = await apiInstance.projectsList( organization @@ -147,7 +147,7 @@ const { status, data } = await apiInstance.projectsList( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| ### Return type @@ -188,8 +188,8 @@ import { const configuration = new Configuration(); const apiInstance = new ProjectsApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let withToken: boolean; // (default to false) const { status, data } = await apiInstance.projectsRead( @@ -203,8 +203,8 @@ const { status, data } = await apiInstance.projectsRead( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| | **withToken** | [**boolean**] | | defaults to false| @@ -247,8 +247,8 @@ import { const configuration = new Configuration(); const apiInstance = new ProjectsApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let v2ProjectRequest: V2ProjectRequest; // const { status, data } = await apiInstance.projectsUpdate( @@ -263,8 +263,8 @@ const { status, data } = await apiInstance.projectsUpdate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **v2ProjectRequest** | **V2ProjectRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type diff --git a/docs/PurgeApi.md b/docs/PurgeApi.md index e907ecd..22211f5 100644 --- a/docs/PurgeApi.md +++ b/docs/PurgeApi.md @@ -22,8 +22,8 @@ import { const configuration = new Configuration(); const apiInstance = new PurgeApi(configuration); -let organization: string; // (default to undefined) -let project: string; // (default to undefined) +let organization: string; //Organization identifier (default to undefined) +let project: string; //Project identifier (default to undefined) let purgeCreateRequest: PurgeCreateRequest; // const { status, data } = await apiInstance.purgeCreate( @@ -38,8 +38,8 @@ const { status, data } = await apiInstance.purgeCreate( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **purgeCreateRequest** | **PurgeCreateRequest**| | | -| **organization** | [**string**] | | defaults to undefined| -| **project** | [**string**] | | defaults to undefined| +| **organization** | [**string**] | Organization identifier | defaults to undefined| +| **project** | [**string**] | Project identifier | defaults to undefined| ### Return type diff --git a/docs/SSHAccessApi.md b/docs/SSHAccessApi.md index db76425..cfaaaba 100644 --- a/docs/SSHAccessApi.md +++ b/docs/SSHAccessApi.md @@ -21,9 +21,9 @@ import { const configuration = new Configuration(); const apiInstance = new SSHAccessApi(configuration); -let organisation: string; //The organisation machine name (default to undefined) -let application: string; //The application name (default to undefined) -let environment: string; //The environment name (default to undefined) +let organisation: string; //The organisation ID (default to undefined) +let application: string; //The application ID (default to undefined) +let environment: string; //The environment ID (default to undefined) const { status, data } = await apiInstance.getSshAccessCredentials( organisation, @@ -36,9 +36,9 @@ const { status, data } = await apiInstance.getSshAccessCredentials( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **organisation** | [**string**] | The organisation machine name | defaults to undefined| -| **application** | [**string**] | The application name | defaults to undefined| -| **environment** | [**string**] | The environment name | defaults to undefined| +| **organisation** | [**string**] | The organisation ID | defaults to undefined| +| **application** | [**string**] | The application ID | defaults to undefined| +| **environment** | [**string**] | The environment ID | defaults to undefined| ### Return type