@apideck/node
Version:
Apideck Node.js SDK
109 lines (108 loc) • 3.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 { PaginationCoverage } from './PaginationCoverage';
import { ResourceStatus } from './ResourceStatus';
import { SupportedProperty } from './SupportedProperty';
/**
*
* @export
* @interface ConnectorResource
*/
export interface ConnectorResource {
/**
* ID of the resource, typically a lowercased version of name.
* @type {string}
* @memberof ConnectorResource
*/
id?: string;
/**
* Name of the resource (plural)
* @type {string}
* @memberof ConnectorResource
*/
name?: string;
/**
* ID of the resource in the Connector's API (downstream)
* @type {string}
* @memberof ConnectorResource
*/
downstream_id?: string;
/**
* Name of the resource in the Connector's API (downstream)
* @type {string}
* @memberof ConnectorResource
*/
downstream_name?: string;
/**
*
* @type {ResourceStatus}
* @memberof ConnectorResource
*/
status?: ResourceStatus;
/**
* Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource.
* @type {boolean}
* @memberof ConnectorResource
*/
pagination_supported?: boolean;
/**
*
* @type {PaginationCoverage}
* @memberof ConnectorResource
*/
pagination?: PaginationCoverage;
/**
* Indicates if custom fields are supported on this resource.
* @type {boolean}
* @memberof ConnectorResource
*/
custom_fields_supported?: boolean;
/**
* List of supported operations on the resource.
* @type {Array<string>}
* @memberof ConnectorResource
*/
supported_operations?: Array<string>;
/**
* List of operations that are not supported on the downstream.
* @type {Array<string>}
* @memberof ConnectorResource
*/
downstream_unsupported_operations?: Array<string>;
/**
* Supported filters on the list endpoint of the resource.
* @type {Array<string>}
* @memberof ConnectorResource
*/
supported_filters?: Array<string>;
/**
* Supported sorting properties on the list endpoint of the resource.
* @type {Array<string>}
* @memberof ConnectorResource
*/
supported_sort_by?: Array<string>;
/**
* Supported fields on the detail endpoint.
* @type {Array<SupportedProperty>}
* @memberof ConnectorResource
*/
supported_fields?: Array<SupportedProperty>;
/**
* Supported fields on the list endpoint.
* @type {Array<SupportedProperty>}
* @memberof ConnectorResource
*/
supported_list_fields?: Array<SupportedProperty>;
}
export declare function ConnectorResourceFromJSON(json: any): ConnectorResource;
export declare function ConnectorResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectorResource;
export declare function ConnectorResourceToJSON(value?: ConnectorResource | null): any;