/** * Apimatic APILib * * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { Schema } from '../schema.js'; import { Parameter } from './parameter.js'; import { Response } from './response.js'; import { TestCase } from './testCase.js'; /** This structure encapsulates all the attributes of an API Endpoint. */ export interface Endpoint { /** Unique Endpoint Identifier */ id: string; /** Unique API Identifier */ apiId: string; /** Endpoint Name */ name: string; /** Endpoint Method */ httpMethod: string; /** The Group Endpoint belongs to */ group: string; /** If Endpoint warrants authentication or not */ skipAuthentication: boolean; /** The Endpoint route */ route: string; /** The structure encapsulates all details of a request response */ response: Response; /** Enabling this option allows optional query parameters */ hasOptionalQueryParams: boolean; /** Enabling this option allows optional field parameters */ hasOptionalFieldParams: boolean; /** Enabling this option collects API endpoint parameters as collections */ collectParameters: boolean; /** Enabling this option allows wrapping of body in objects */ wrapBodyInObject: boolean; /** What scopes apply to an Endpoint */ requiredScopes: string[]; /** Endpoint Paramaters */ parameters: Parameter[]; /** Errors that Endpoint may output */ errors: unknown[]; /** Test Cases associated with Endpoint */ testCases: TestCase[]; additionalProperties?: Record; } export declare const endpointSchema: Schema; //# sourceMappingURL=endpoint.d.ts.map