import type { APIProduct } from '../models/APIProduct'; import type { APIProductPatch } from '../models/APIProductPatch'; import type { AttributeValue } from '../models/AttributeValue'; import type { CommonEntityNameList } from '../models/CommonEntityNameList'; import type { CommonEntityNames } from '../models/CommonEntityNames'; import type { CommonName } from '../models/CommonName'; import type { EntityDeriveRequest } from '../models/EntityDeriveRequest'; import type { SemVer } from '../models/SemVer'; export declare class ApiProductsService { /** * @returns APIProduct list of API Products * @throws ApiError */ static listApiProducts({ organizationName, pageSize, pageNumber, sortFieldName, sortDirection, 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'; /** 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>; /** * @returns APIProduct New API Product * @throws ApiError */ static createApiProduct({ organizationName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** Application domains have a name and topic domain. **/ requestBody?: APIProduct; }): Promise; /** * @returns APIProduct an API Product * @throws ApiError */ static getApiProduct({ organizationName, apiProductName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; }): Promise; /** * @returns APIProduct Updated API Product * @throws ApiError */ static updateApiProduct({ organizationName, apiProductName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; /** Provide the etag value for a previous GET request of a resource on update (PATCH) in order to avoid "lost updates" **/ ifMatch?: string; /** Application domains have a name and topic domain. **/ requestBody?: APIProductPatch; }): Promise; /** * @returns void * @throws ApiError */ static deleteApiProduct({ organizationName, apiProductName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; }): Promise; /** * @returns CommonName api names associated with the api product * @throws ApiError */ static listApiProductApis({ organizationName, apiProductName, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: 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'; }): Promise>; /** * @returns APIProduct Derived API Product * @throws ApiError */ static createDerivedApiProduct({ organizationName, apiProductName, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; /** Name and display name of the derived API Product **/ requestBody?: EntityDeriveRequest; }): Promise; /** * @returns CommonEntityNames other api products derived from the api product * @throws ApiError */ static listDerivedApiProducts({ organizationName, apiProductName, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: 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'; }): Promise>; /** * @returns any async api sepc * @throws ApiError */ static getApiProductApiSpecification({ organizationName, apiProductName, apiName, format, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; /** the name of the api **/ apiName: CommonName; format?: 'application/json' | 'application/x-yaml' | 'application/zip'; }): Promise; /** * @returns CommonEntityNameList api names associated with the api product * @throws ApiError */ static listAppReferencesToApiProducts({ organizationName, apiProductName, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: 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'; }): Promise; /** * @returns SemVer revisions of the api product * @throws ApiError */ static listApiProductRevisions({ organizationName, apiProductName, pageSize, pageNumber, sortFieldName, sortDirection, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: 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'; }): Promise>; /** * @returns APIProduct revision of the API Product * @throws ApiError */ static getApiProductRevision({ organizationName, apiProductName, semver, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; semver: SemVer; }): Promise; /** * @returns AttributeValue attribute value * @throws ApiError */ static getApiProductAttribute({ organizationName, apiProductName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; attributeName: string; }): Promise; /** * @returns AttributeValue Updated Attribute Value * @throws ApiError */ static createApiProductAttribute({ organizationName, apiProductName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; 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 updateApiProductAttribute({ organizationName, apiProductName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; 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 deleteApiProductAttribute({ organizationName, apiProductName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; attributeName: string; }): Promise; /** * @returns AttributeValue attribute value * @throws ApiError */ static getApiProductMetaAttribute({ organizationName, apiProductName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; attributeName: string; }): Promise; /** * @returns AttributeValue Updated Attribute Value * @throws ApiError */ static createApiProductMetaAttribute({ organizationName, apiProductName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; 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 updateApiProductMetaAttribute({ organizationName, apiProductName, attributeName, ifMatch, requestBody, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; 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 deleteApiProductMetaAttribute({ organizationName, apiProductName, attributeName, }: { /** the name of the organization (tenant) a resource belongs to **/ organizationName: string; /** the id of the api product **/ apiProductName: string; attributeName: string; }): Promise; }