ConnectorApi.md

Apideck.Connector

Class Name

ConnectorApi

Methods

• Get API Resource Coverage
• Get API Resource
• List APIs
• Get API
• Get Connector Doc Content
• Get Connector Resource
• List Connectors
• Get Connector

Get API Resource Coverage

Method: apiResourceCoverageOne

connectorApi.apiResourceCoverageOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
resourceId	[string]	ID of the resource you are acting upon.
appId	[string]	The ID of your Unify application	(optional)

Response Type

GetApiResourceCoverageResponse

HTTP response details

Status code	Description
200	ApiResources
401	Unauthorized
402	Payment Required
404	The specified resource was not found
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {
  id: 'id_example',
  resourceId: 'resource_id_example'
}

try {
  const { data } = await apideck.connector.apiResourceCoverageOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get API Resource

Method: apiResourcesOne

connectorApi.apiResourcesOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
resourceId	[string]	ID of the resource you are acting upon.
appId	[string]	The ID of your Unify application	(optional)

Response Type

GetApiResourceResponse

HTTP response details

Status code	Description
200	ApiResources
401	Unauthorized
402	Payment Required
404	The specified resource was not found
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {
  id: 'id_example',
  resourceId: 'resource_id_example'
}

try {
  const { data } = await apideck.connector.apiResourcesOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List APIs

Method: apisAll

connectorApi.apisAll(body)

Parameters

Name	Type	Description	Notes
appId	[string]	The ID of your Unify application	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
filter	ApisFilter	Apply filters	(optional)

Response Type

GetApisResponse

HTTP response details

Status code	Description
200	Apis
400	Bad Request
401	Unauthorized
402	Payment Required
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {}

try {
  const { data } = await apideck.connector.apisAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get API

Method: apisOne

connectorApi.apisOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
appId	[string]	The ID of your Unify application	(optional)

Response Type

GetApiResponse

HTTP response details

Status code	Description
200	Apis
401	Unauthorized
402	Payment Required
404	The specified resource was not found
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {
  id: 'id_example'
}

try {
  const { data } = await apideck.connector.apisOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Connector Doc Content

Method: connectorDocsOne

connectorApi.connectorDocsOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
docId	[string]	ID of the Doc
appId	[string]	The ID of your Unify application	(optional)

Response Type

string

HTTP response details

Status code	Description
200	Connectors
401	Unauthorized
402	Payment Required
404	The specified resource was not found
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {
  id: 'id_example',
  docId: 'application_owner+oauth_credentials'
}

try {
  const { data } = await apideck.connector.connectorDocsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Connector Resource

Method: connectorResourcesOne

connectorApi.connectorResourcesOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
resourceId	[string]	ID of the resource you are acting upon.
appId	[string]	The ID of your Unify application	(optional)
unifiedApi	UnifiedApiId	Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs	(optional)

Response Type

GetConnectorResourceResponse

HTTP response details

Status code	Description
200	ConnectorResources
401	Unauthorized
402	Payment Required
404	The specified resource was not found
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {
  id: 'id_example',
  resourceId: 'resource_id_example'
}

try {
  const { data } = await apideck.connector.connectorResourcesOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Connectors

Method: connectorsAll

connectorApi.connectorsAll(body)

Parameters

Name	Type	Description	Notes
appId	[string]	The ID of your Unify application	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
filter	ConnectorsFilter	Apply filters	(optional)

Response Type

GetConnectorsResponse

HTTP response details

Status code	Description
200	Connectors
400	Bad Request
401	Unauthorized
402	Payment Required
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {}

try {
  const { data } = await apideck.connector.connectorsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Connector

Method: connectorsOne

connectorApi.connectorsOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
appId	[string]	The ID of your Unify application	(optional)

Response Type

GetConnectorResponse

HTTP response details

Status code	Description
200	Connectors
401	Unauthorized
402	Payment Required
404	The specified resource was not found
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID'
});

const params = {
  id: 'id_example'
}

try {
  const { data } = await apideck.connector.connectorsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]