import type { APIImport } from '../models/APIImport'; import type { APIInfo } from '../models/APIInfo'; import type { APIInfoList } from '../models/APIInfoList'; import type { APIInfoPatch } from '../models/APIInfoPatch'; import type { APIList } from '../models/APIList'; import type { APISummaryList } from '../models/APISummaryList'; import type { APIVersionInfoPatch } from '../models/APIVersionInfoPatch'; import type { AttributeValue } from '../models/AttributeValue'; import type { CommonEntityNameList } from '../models/CommonEntityNameList'; import type { CommonName } from '../models/CommonName'; import type { CommonVersion } from '../models/CommonVersion'; import type { String2MB } from '../models/String2MB'; import type { Version } from '../models/Version'; export declare class ApisService { /** * @returns any list of APIs * @throws ApiError */ static listApis({ organizationName, pageSize, pageNumber, sortFieldName, sortDirection, format, filter, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** The number of items to get per page. Min: 1 Max: 100 **/ pageSize?: number; /** The page number to get. Min: 1 **/ pageNumber?: number; /** name of a field to sort on **/ sortFieldName?: string; /** sort direction **/ sortDirection?: 'asc' | 'desc'; /** the format of the API List returned, compact returns the API names, summary and extended return additional API metadata **/ format?: 'compact' | 'summary' | 'extended'; /** specify search terms to filter results on, multiple search terms can be supplied. Search will return results matching any of the terms (OR). Enclose search terms in quotes to limit results to recoirds matching ALL terms (AND).) **/ filter?: string; }): Promise<(APIList | APISummaryList | APIInfoList)>; /** * Imports an Async API from an external source * @returns any New API that was imported * @throws ApiError */ static importApi({ organizationName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** Import request. **/ requestBody?: APIImport; }): Promise; /** * @returns any The async API specification * @throws ApiError */ static createApi({ organizationName, apiName, mode, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; /** Set the mode that applies to a create (POST or PUT) operation, in test mode the data is validated but not persisted, any validation results are returned to the client. The server defaults to write mode itf parameter is omitted **/ mode?: 'test' | 'write'; /** Async API specification **/ requestBody?: String2MB; }): Promise; /** * @returns any async api sepc * @throws ApiError */ static getApi({ organizationName, apiName, format, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; format?: 'application/json' | 'application/x-yaml' | 'application/zip'; }): Promise; /** * @returns any updated async api specification * @throws ApiError */ static updateApi({ organizationName, apiName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** async api specification **/ requestBody?: String2MB; }): Promise; /** * @returns void * @throws ApiError */ static deleteApi({ organizationName, apiName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; }): Promise; /** * @returns APIInfo API meta information * @throws ApiError */ static getApiInfo({ organizationName, apiName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; }): Promise; /** * @returns APIInfo updated API Info * @throws ApiError */ static updateApiInfo({ organizationName, apiName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** update to an API Info, only attributes and meta information can be changed. The only elements of the Meta Object that will be updated are the lastModifiedBy and createdBy attributes. **/ requestBody?: APIInfoPatch; }): Promise; /** * @returns CommonVersion revisions of the api * @throws ApiError */ static listApiRevisions({ organizationName, apiName, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; /** The number of items to get per page. Min: 1 Max: 100 **/ pageSize?: number; /** The page number to get. Min: 1 **/ pageNumber?: number; /** name of a field to sort on **/ sortFieldName?: string; /** sort direction **/ sortDirection?: 'asc' | 'desc'; }): Promise>; /** * @returns any async api sepc * @throws ApiError */ static getApiRevision({ organizationName, apiName, version, format, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; version: Version; format?: 'application/json' | 'application/x-yaml' | 'application/zip'; }): Promise; /** * @returns APIInfo API meta information * @throws ApiError */ static getApiVersionInfo({ organizationName, apiName, version, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; version: Version; }): Promise; /** * @returns APIInfo updated API Info * @throws ApiError */ static updateApiVersionInfo({ organizationName, apiName, version, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; version: Version; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** update to an API Info, only attributes and meta information can be changed. The only elements of the Meta Object that will be updated are the lastModifiedBy and createdBy attributes. **/ requestBody?: APIVersionInfoPatch; }): Promise; /** * @returns CommonEntityNameList API Products that reference this API revision * @throws ApiError */ static getApiRevisionApiProductReferences({ organizationName, apiName, version, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; version: Version; }): Promise; /** * @returns CommonEntityNameList API Products that reference this API * @throws ApiError */ static getApiReferencedByApiProducts({ organizationName, apiName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; }): Promise; /** * @returns AttributeValue attribute value * @throws ApiError */ static getApiAttribute({ organizationName, apiName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; }): Promise; /** * @returns AttributeValue Updated Attribute Value * @throws ApiError */ static createApiAttribute({ organizationName, apiName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Attribute value **/ requestBody?: AttributeValue; }): Promise; /** * @returns AttributeValue Updated Attribute Value * @throws ApiError */ static updateApiAttribute({ organizationName, apiName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Attribute value **/ requestBody?: AttributeValue; }): Promise; /** * @returns void * @throws ApiError */ static deleteApiAttribute({ organizationName, apiName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; }): Promise; /** * @returns AttributeValue attribute value * @throws ApiError */ static getApiMetaAttribute({ organizationName, apiName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; }): Promise; /** * @returns AttributeValue Updated Attribute Value * @throws ApiError */ static createApiMetaAttribute({ organizationName, apiName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Attribute value **/ requestBody?: AttributeValue; }): Promise; /** * @returns AttributeValue Updated Attribute Value * @throws ApiError */ static updateApiMetaAttribute({ organizationName, apiName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Attribute value **/ requestBody?: AttributeValue; }): Promise; /** * @returns void * @throws ApiError */ static deleteApiMetaAttribute({ organizationName, apiName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the name of the api **/ apiName: CommonName; attributeName: string; }): Promise; }