@apideck/node
Version:
Apideck Node.js SDK
98 lines (97 loc) • 2.36 kB
TypeScript
/**
* Apideck
* The Apideck OpenAPI Spec: SDK Optimized
*
* The version of the OpenAPI document: 10.13.0
* Contact: support@apideck.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { ApiResources } from './ApiResources';
import { ApiStatus } from './ApiStatus';
/**
*
* @export
* @interface Api
*/
export interface Api {
/**
* ID of the API.
* @type {string}
* @memberof Api
*/
readonly id?: string;
/**
* Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API.
* @type {string}
* @memberof Api
*/
type?: ApiType;
/**
* Name of the API.
* @type {string}
* @memberof Api
*/
name?: string;
/**
* Description of the API.
* @type {string}
* @memberof Api
*/
description?: string | null;
/**
*
* @type {ApiStatus}
* @memberof Api
*/
status?: ApiStatus;
/**
* Link to the latest OpenAPI specification of the API.
* @type {string}
* @memberof Api
*/
spec_url?: string;
/**
* Link to the API reference of the API.
* @type {string}
* @memberof Api
*/
api_reference_url?: string;
/**
* ID of the Postman collection of the API.
* @type {string}
* @memberof Api
*/
postman_collection_id?: string | null;
/**
* List of categories the API belongs to.
* @type {Array<string>}
* @memberof Api
*/
categories?: Array<string>;
/**
* List of resources supported in this API.
* @type {Array<ApiResources>}
* @memberof Api
*/
resources?: Array<ApiResources>;
/**
* List of event types this API supports.
* @type {Array<string>}
* @memberof Api
*/
events?: Array<string>;
}
/**
* @export
* @enum {string}
*/
export declare enum ApiType {
platform = "platform",
unified = "unified"
}
export declare function ApiFromJSON(json: any): Api;
export declare function ApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): Api;
export declare function ApiToJSON(value?: Api | null): any;