@apideck/node
Version:
Apideck Node.js SDK
571 lines (488 loc) • 16.9 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* 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 {
ApisFilter,
ConnectorsFilter,
GetApiResourceCoverageResponse,
GetApiResourceCoverageResponseFromJSON,
GetApiResourceResponse,
GetApiResourceResponseFromJSON,
GetApiResponse,
GetApiResponseFromJSON,
GetApisResponse,
GetApisResponseFromJSON,
GetConnectorResourceResponse,
GetConnectorResourceResponseFromJSON,
GetConnectorResponse,
GetConnectorResponseFromJSON,
GetConnectorsResponse,
GetConnectorsResponseFromJSON,
UnifiedApiId
} from '../models'
import * as runtime from '../runtime'
export interface ConnectorApiApiResourceCoverageOneRequest {
id: string
resourceId: string
appId?: string
}
export interface ConnectorApiApiResourcesOneRequest {
id: string
resourceId: string
appId?: string
}
export interface ConnectorApiApisAllRequest {
appId?: string
cursor?: string | null
limit?: number
filter?: ApisFilter
}
export interface ConnectorApiApisOneRequest {
id: string
appId?: string
}
export interface ConnectorApiConnectorDocsOneRequest {
id: string
docId: string
appId?: string
}
export interface ConnectorApiConnectorResourcesOneRequest {
id: string
resourceId: string
appId?: string
unifiedApi?: UnifiedApiId
}
export interface ConnectorApiConnectorsAllRequest {
appId?: string
cursor?: string | null
limit?: number
filter?: ConnectorsFilter
}
export interface ConnectorApiConnectorsOneRequest {
id: string
appId?: string
}
/**
*
*/
export class ConnectorApi extends runtime.BaseAPI {
/**
* Get API Resource Coverage
* Get API Resource Coverage
*/
async apiResourceCoverageOneRaw(
requestParameters: ConnectorApiApiResourceCoverageOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetApiResourceCoverageResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling apiResourceCoverageOne.'
)
}
if (requestParameters.resourceId === null || requestParameters.resourceId === undefined) {
throw new runtime.RequiredError(
'resourceId',
'Required parameter requestParameters.resourceId was null or undefined when calling apiResourceCoverageOne.'
)
}
const queryParameters: any = {}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/apis/{id}/resources/{resource_id}/coverage`
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id)))
.replace(`{${'resource_id'}}`, encodeURIComponent(String(requestParameters.resourceId))),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetApiResourceCoverageResponseFromJSON(jsonValue)
)
}
/**
* Get API Resource Coverage
* Get API Resource Coverage
*/
async apiResourceCoverageOne(
requestParameters: ConnectorApiApiResourceCoverageOneRequest,
initOverrides?: RequestInit
): Promise<GetApiResourceCoverageResponse> {
const response = await this.apiResourceCoverageOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get API Resource
* Get API Resource
*/
async apiResourcesOneRaw(
requestParameters: ConnectorApiApiResourcesOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetApiResourceResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling apiResourcesOne.'
)
}
if (requestParameters.resourceId === null || requestParameters.resourceId === undefined) {
throw new runtime.RequiredError(
'resourceId',
'Required parameter requestParameters.resourceId was null or undefined when calling apiResourcesOne.'
)
}
const queryParameters: any = {}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/apis/{id}/resources/{resource_id}`
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id)))
.replace(`{${'resource_id'}}`, encodeURIComponent(String(requestParameters.resourceId))),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetApiResourceResponseFromJSON(jsonValue)
)
}
/**
* Get API Resource
* Get API Resource
*/
async apiResourcesOne(
requestParameters: ConnectorApiApiResourcesOneRequest,
initOverrides?: RequestInit
): Promise<GetApiResourceResponse> {
const response = await this.apiResourcesOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* List APIs
* List APIs
*/
async apisAllRaw(
requestParameters: ConnectorApiApisAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetApisResponse>> {
const queryParameters: any = {}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/apis`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue => GetApisResponseFromJSON(jsonValue))
}
/**
* List APIs
* List APIs
*/
async apisAll(
requestParameters: ConnectorApiApisAllRequest = {},
initOverrides?: RequestInit
): Promise<GetApisResponse> {
const response = await this.apisAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get API
* Get API
*/
async apisOneRaw(
requestParameters: ConnectorApiApisOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetApiResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling apisOne.'
)
}
const queryParameters: any = {}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/apis/{id}`.replace(
`{${'id'}}`,
encodeURIComponent(String(requestParameters.id))
),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue => GetApiResponseFromJSON(jsonValue))
}
/**
* Get API
* Get API
*/
async apisOne(
requestParameters: ConnectorApiApisOneRequest,
initOverrides?: RequestInit
): Promise<GetApiResponse> {
const response = await this.apisOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Connector Doc content
* Get Connector Doc content
*/
async connectorDocsOneRaw(
requestParameters: ConnectorApiConnectorDocsOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<string>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling connectorDocsOne.'
)
}
if (requestParameters.docId === null || requestParameters.docId === undefined) {
throw new runtime.RequiredError(
'docId',
'Required parameter requestParameters.docId was null or undefined when calling connectorDocsOne.'
)
}
const queryParameters: any = {}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/connectors/{id}/docs/{doc_id}`
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id)))
.replace(`{${'doc_id'}}`, encodeURIComponent(String(requestParameters.docId))),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.TextApiResponse(response) as any
}
/**
* Get Connector Doc content
* Get Connector Doc content
*/
async connectorDocsOne(
requestParameters: ConnectorApiConnectorDocsOneRequest,
initOverrides?: RequestInit
): Promise<string> {
const response = await this.connectorDocsOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Connector Resource
* Get Connector Resource
*/
async connectorResourcesOneRaw(
requestParameters: ConnectorApiConnectorResourcesOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetConnectorResourceResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling connectorResourcesOne.'
)
}
if (requestParameters.resourceId === null || requestParameters.resourceId === undefined) {
throw new runtime.RequiredError(
'resourceId',
'Required parameter requestParameters.resourceId was null or undefined when calling connectorResourcesOne.'
)
}
const queryParameters: any = {}
if (requestParameters.unifiedApi !== undefined) {
queryParameters['unified_api'] = requestParameters.unifiedApi
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/connectors/{id}/resources/{resource_id}`
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id)))
.replace(`{${'resource_id'}}`, encodeURIComponent(String(requestParameters.resourceId))),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetConnectorResourceResponseFromJSON(jsonValue)
)
}
/**
* Get Connector Resource
* Get Connector Resource
*/
async connectorResourcesOne(
requestParameters: ConnectorApiConnectorResourcesOneRequest,
initOverrides?: RequestInit
): Promise<GetConnectorResourceResponse> {
const response = await this.connectorResourcesOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* List Connectors
* List Connectors
*/
async connectorsAllRaw(
requestParameters: ConnectorApiConnectorsAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetConnectorsResponse>> {
const queryParameters: any = {}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/connectors`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetConnectorsResponseFromJSON(jsonValue)
)
}
/**
* List Connectors
* List Connectors
*/
async connectorsAll(
requestParameters: ConnectorApiConnectorsAllRequest = {},
initOverrides?: RequestInit
): Promise<GetConnectorsResponse> {
const response = await this.connectorsAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Connector
* Get Connector
*/
async connectorsOneRaw(
requestParameters: ConnectorApiConnectorsOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetConnectorResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling connectorsOne.'
)
}
const queryParameters: any = {}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/connector/connectors/{id}`.replace(
`{${'id'}}`,
encodeURIComponent(String(requestParameters.id))
),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetConnectorResponseFromJSON(jsonValue)
)
}
/**
* Get Connector
* Get Connector
*/
async connectorsOne(
requestParameters: ConnectorApiConnectorsOneRequest,
initOverrides?: RequestInit
): Promise<GetConnectorResponse> {
const response = await this.connectorsOneRaw(requestParameters, initOverrides)
return await response.value()
}
}