README
Adobe I/O Console SDK Library
Installing
$ npm install @adobe/aio-lib-console
Usage
- Initialize the SDK
const sdk = require('@adobe/aio-lib-console')
async function sdkTest() {
//initialize sdk
const client = await sdk.init('<valid auth token>', 'x-api-key')
}
- Call methods using the initialized SDK
const sdk = require('@adobe/aio-lib-console')
async function sdkTest() {
// initialize sdk
const client = await sdk.init('<valid auth token>', 'x-api-key')
// call methods
try {
// get... something
const result = await client.getOrganizations()
console.log(result)
} catch (e) {
console.error(e)
}
}
Classes
- CoreConsoleAPI
This class provides methods to call your CoreConsoleAPI APIs. Before calling any method, initialize the instance by calling the
init
method on it with valid values for apiKey and accessToken
Functions
- createRequestOptions(apiKey, options) ⇒
Array
Create request options compatible with the console swagger definition
- requestInterceptorBuilder(coreConsoleAPIInstance, apihost) ⇒
function
Build a swagger request interceptor for the console sdk
- responseInterceptor(res) ⇒
object
A swagger response interceptor for the console sdk
- init(accessToken, apiKey, [env]) ⇒
Promise.<CoreConsoleAPI>
Returns a Promise that resolves with a new CoreConsoleAPI object
Typedefs
- Response :
object
- ProjectDetails :
object
- WorkspaceDetails :
object
- AdobeIdIntegrationDetails :
object
CoreConsoleAPI
This class provides methods to call your CoreConsoleAPI APIs.
Before calling any method, initialize the instance by calling the init
method on it
with valid values for apiKey and accessToken
Kind: global class
- CoreConsoleAPI
- .init(accessToken, apiKey, [env]) ⇒
Promise.<CoreConsoleAPI>
- .getProjectsForOrg(organizationId) ⇒
Promise.<Response>
- .createFireflyProject(organizationId, projectDetails) ⇒
Promise.<Response>
- .createProject(organizationId, projectDetails) ⇒
Promise.<Response>
- .getWorkspacesForProject(organizationId, projectId) ⇒
Promise.<Response>
- .deleteProject(organizationId, projectId) ⇒
Promise.<Response>
- .editProject(organizationId, projectId, projectDetails) ⇒
Promise.<Response>
- .getProject(organizationId, projectId) ⇒
Promise.<Response>
- .downloadWorkspaceJson(organizationId, projectId, workspaceId) ⇒
Promise.<Response>
- .createWorkspace(organizationId, projectId, workspaceDetails) ⇒
Promise.<Response>
- .editWorkspace(organizationId, projectId, workspaceId, workspaceDetails) ⇒
Promise.<Response>
- .getWorkspace(organizationId, projectId, workspaceId) ⇒
Promise.<Response>
- .deleteWorkspace(organizationId, projectId, workspaceId) ⇒
Promise.<Response>
- .getCredentials(organizationId, projectId, workspaceId) ⇒
Promise.<Response>
- .createEnterpriseCredential(organizationId, projectId, workspaceId, certificate, name, description) ⇒
Promise.<Response>
- .createAdobeIdCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒
Promise.<Response>
- .createAnalyticsCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒
Promise.<Response>
- .subscribeCredentialToServices(organizationId, projectId, workspaceId, credentialType, credentialId, serviceInfo) ⇒
Promise.<Response>
- .getWorkspaceForCredential(organizationId, credentialId) ⇒
Promise.<Response>
- .getProjectForWorkspace(organizationId, workspaceId) ⇒
Promise.<Response>
- .deleteCredential(organizationId, projectId, workspaceId, credentialType, credentialId) ⇒
Promise.<Response>
- .getOrganizations() ⇒
Promise.<Response>
- .getServicesForOrg(organizationId) ⇒
Promise.<Response>
- .createRuntimeNamespace(organizationId, projectId, workspaceId) ⇒
Promise.<Response>
- .getPluginsForWorkspace(organizationId, projectId, workspaceId) ⇒
Promise.<Response>
- .getIntegrationsForOrg(organizationId) ⇒
Promise.<Response>
- .createEnterpriseIntegration(organizationId, certificate, name, description) ⇒
Promise.<Response>
- .createAdobeIdIntegration(organizationId, integrationDetails) ⇒
Promise.<Response>
- .updateAdobeIdIntegration(organizationId, integrationId, integrationDetails) ⇒
Promise.<Response>
- .subscribeAdobeIdIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒
Promise.<Response>
- .subscribeEnterpriseIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒
Promise.<Response>
- .getBindingsForIntegration(organizationId, integrationId) ⇒
Promise.<Response>
- .uploadAndBindCertificate(organizationId, integrationId, certificate) ⇒
Promise.<Response>
- .deleteBinding(organizationId, integrationId, bindingId) ⇒
Promise.<Response>
- .getIntegration(organizationId, integrationId) ⇒
Promise.<Response>
- .getIntegrationSecrets(organizationId, integrationId) ⇒
Promise.<Response>
- .deleteIntegration(organizationId, integrationId) ⇒
Promise.<Response>
- .createIMSOrg() ⇒
Promise.<Response>
- .getAtlasApplicationPolicy(organizationId, integrationId) ⇒
Promise.<Response>
- .getAtlasQuotaUsage(organizationId, integrationId) ⇒
Promise.<Response>
- .validateApplicationName(organizationId, applicationName) ⇒
Promise.<Response>
- .getApplicationById(organizationId, applicationId) ⇒
Promise.<Response>
- .updateApplication(organizationId, applicationId, applicationDetails) ⇒
Promise.<Response>
- .deleteApplication(organizationId, applicationId) ⇒
Promise.<Response>
- .getApplicationByName(organizationId, applicationName) ⇒
Promise.<Response>
- .submitApplication(organizationId, applicationId, submitterNotes) ⇒
Promise.<Response>
- .getAllApplicationsForUser(organizationId, offset, pageSize) ⇒
Promise.<Response>
- .uploadApplicationIcon(organizationId, applicationId, icon) ⇒
Promise.<Response>
- .getAppRegistryHealth(organizationId) ⇒
Promise.<Response>
- .getSDKProperties(organizationId, integrationId, sdkCode) ⇒
Promise.<ConsoleResponse>
- .init(accessToken, apiKey, [env]) ⇒
Promise.<CoreConsoleAPI>
coreConsoleAPI.init(accessToken, apiKey, [env]) ⇒ Initializes a CoreConsoleAPI object and returns it
Kind: instance method of CoreConsoleAPI
Returns: Promise.<CoreConsoleAPI>
- a CoreConsoleAPI object
Param | Type | Default | Description |
---|---|---|---|
accessToken | string |
the access token corresponding to an integration or user token | |
apiKey | string |
api key to access the Developer Console | |
[env] | string |
"prod" |
the server environment ('prod' or 'stage') |
Promise.<Response>
coreConsoleAPI.getProjectsForOrg(organizationId) ⇒ Get all Projects in an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
Promise.<Response>
coreConsoleAPI.createFireflyProject(organizationId, projectDetails) ⇒ Create a new Firefly Project (from template) in an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectDetails | ProjectDetails |
Project details including name, title, who_created, description and type |
Promise.<Response>
coreConsoleAPI.createProject(organizationId, projectDetails) ⇒ Create a new Project in an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectDetails | ProjectDetails |
Project details including name, title, who_created, description and type |
Promise.<Response>
coreConsoleAPI.getWorkspacesForProject(organizationId, projectId) ⇒ Get all Workspaces for a Project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
Promise.<Response>
coreConsoleAPI.deleteProject(organizationId, projectId) ⇒ Delete a Project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
Promise.<Response>
coreConsoleAPI.editProject(organizationId, projectId, projectDetails) ⇒ Edit a Project
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
projectDetails | ProjectDetails |
Project details including name, title, who_created, description and type |
Promise.<Response>
coreConsoleAPI.getProject(organizationId, projectId) ⇒ Get a Project by ID
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
Promise.<Response>
coreConsoleAPI.downloadWorkspaceJson(organizationId, projectId, workspaceId) ⇒ Download the Workspace Configuration File (json)
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.createWorkspace(organizationId, projectId, workspaceDetails) ⇒ Create a new Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceDetails | WorkspaceDetails |
Workspace details including name, title, who_created, description, type and quotaRule |
Promise.<Response>
coreConsoleAPI.editWorkspace(organizationId, projectId, workspaceId, workspaceDetails) ⇒ Edit a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
workspaceDetails | WorkspaceDetails |
Workspace details including name, title, who_created, description, type and quotaRule |
Promise.<Response>
coreConsoleAPI.getWorkspace(organizationId, projectId, workspaceId) ⇒ Get a Workspace by ID
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.deleteWorkspace(organizationId, projectId, workspaceId) ⇒ Delete a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.getCredentials(organizationId, projectId, workspaceId) ⇒ Get all credentials for a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.createEnterpriseCredential(organizationId, projectId, workspaceId, certificate, name, description) ⇒ Create a new Enterprise Credential for a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
certificate | object |
A Readable stream with certificate content. eg: fs.createReadStream() |
name | string |
Credential name |
description | string |
Credential description |
Promise.<Response>
coreConsoleAPI.createAdobeIdCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒ Create a new AdobeID Credential for a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
credentialDetails | AdobeIdIntegrationDetails |
Credential details |
Promise.<Response>
coreConsoleAPI.createAnalyticsCredential(organizationId, projectId, workspaceId, credentialDetails) ⇒ Create a new Analytics Credential for a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
credentialDetails | AdobeIdIntegrationDetails |
Credential details |
Promise.<Response>
coreConsoleAPI.subscribeCredentialToServices(organizationId, projectId, workspaceId, credentialType, credentialId, serviceInfo) ⇒ Subscribe a Workspace Credential to Services
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
credentialType | string |
Credential type (adobeid, analytics or entp) |
credentialId | string |
Credential ID |
serviceInfo | object |
Information about the services like SDK Codes, licenseConfig and roles |
Promise.<Response>
coreConsoleAPI.getWorkspaceForCredential(organizationId, credentialId) ⇒ Get the Workspace from a Credential ID
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
credentialId | string |
Credential ID |
Promise.<Response>
coreConsoleAPI.getProjectForWorkspace(organizationId, workspaceId) ⇒ Get the Project of a Workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.deleteCredential(organizationId, projectId, workspaceId, credentialType, credentialId) ⇒ Delete a Workspace Credential
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
credentialType | string |
Credential type (adobeid, analytics or entp) |
credentialId | string |
Credential ID |
Promise.<Response>
coreConsoleAPI.getOrganizations() ⇒ Get all Organizations
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Promise.<Response>
coreConsoleAPI.getServicesForOrg(organizationId) ⇒ Get all Services available to an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
Promise.<Response>
coreConsoleAPI.createRuntimeNamespace(organizationId, projectId, workspaceId) ⇒ Create an Adobe I/O Runtime namespace in the given workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.getPluginsForWorkspace(organizationId, projectId, workspaceId) ⇒ Get plugins for workspace
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
projectId | string |
Project ID |
workspaceId | string |
Workspace ID |
Promise.<Response>
coreConsoleAPI.getIntegrationsForOrg(organizationId) ⇒ Get Integrations for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
Promise.<Response>
coreConsoleAPI.createEnterpriseIntegration(organizationId, certificate, name, description) ⇒ Create a new Enterprise Integration for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
certificate | object |
A Readable stream with certificate content. eg: fs.createReadStream() |
name | string |
Integration name |
description | string |
Integration description |
Promise.<Response>
coreConsoleAPI.createAdobeIdIntegration(organizationId, integrationDetails) ⇒ Create a new AdobeID Integration for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationDetails | AdobeIdIntegrationDetails |
Integration details |
Promise.<Response>
coreConsoleAPI.updateAdobeIdIntegration(organizationId, integrationId, integrationDetails) ⇒ Update an AdobeID Integration for an Organization
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID to update |
integrationDetails | AdobeIdIntegrationDetails |
Integration details |
Promise.<Response>
coreConsoleAPI.subscribeAdobeIdIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Subscribe Organization AdobeId Integration to Services
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
serviceInfo | object |
Information about the services like SDK Codes, licenseConfig and roles |
Promise.<Response>
coreConsoleAPI.subscribeEnterpriseIntegrationToServices(organizationId, integrationId, serviceInfo) ⇒ Subscribe Organization Enterprise Integration to Services
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
serviceInfo | object |
Information about the services like SDK Codes, licenseConfig and roles |
Promise.<Response>
coreConsoleAPI.getBindingsForIntegration(organizationId, integrationId) ⇒ List certification bindings for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
Promise.<Response>
coreConsoleAPI.uploadAndBindCertificate(organizationId, integrationId, certificate) ⇒ Upload and bind a certificate to an Organization Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
certificate | object |
A Readable stream with certificate content. eg: fs.createReadStream() |
Promise.<Response>
coreConsoleAPI.deleteBinding(organizationId, integrationId, bindingId) ⇒ Delete a certificate binding for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
bindingId | string |
Binding ID |
Promise.<Response>
coreConsoleAPI.getIntegration(organizationId, integrationId) ⇒ Get Integration details
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
Promise.<Response>
coreConsoleAPI.getIntegrationSecrets(organizationId, integrationId) ⇒ Get Integration secrets
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
Promise.<Response>
coreConsoleAPI.deleteIntegration(organizationId, integrationId) ⇒ Delete an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
Promise.<Response>
coreConsoleAPI.createIMSOrg() ⇒ Create an IMS Org
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Promise.<Response>
coreConsoleAPI.getAtlasApplicationPolicy(organizationId, integrationId) ⇒ Get Application Atlas Policy for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
Promise.<Response>
coreConsoleAPI.getAtlasQuotaUsage(organizationId, integrationId) ⇒ Get Atlas quota usage for an Integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
Promise.<Response>
coreConsoleAPI.validateApplicationName(organizationId, applicationName) ⇒ Validate App Registry (Exchange) Application name
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationName | string |
Application name to validate |
Promise.<Response>
coreConsoleAPI.getApplicationById(organizationId, applicationId) ⇒ Get App Registry (Exchange) Application details
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationId | string |
Application ID |
Promise.<Response>
coreConsoleAPI.updateApplication(organizationId, applicationId, applicationDetails) ⇒ Update App Registry (Exchange) Application, application details are patched.
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationId | string |
Application ID |
applicationDetails | object |
Application details to update |
Promise.<Response>
coreConsoleAPI.deleteApplication(organizationId, applicationId) ⇒ Delete App Registry (Exchange) Application
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationId | string |
Application ID |
Promise.<Response>
coreConsoleAPI.getApplicationByName(organizationId, applicationName) ⇒ Get App Registry (Exchange) Application by name
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationName | string |
Application Name |
Promise.<Response>
coreConsoleAPI.submitApplication(organizationId, applicationId, submitterNotes) ⇒ Submit an Application to App Registry (Exchange)
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationId | string |
Application ID |
submitterNotes | string |
Notes from submitter |
Promise.<Response>
coreConsoleAPI.getAllApplicationsForUser(organizationId, offset, pageSize) ⇒ Get all App Registry (Exchange) Application
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
offset | number |
offset for returned list |
pageSize | number |
number of elements to return |
Promise.<Response>
coreConsoleAPI.uploadApplicationIcon(organizationId, applicationId, icon) ⇒ Upload an Icon for an Application in App Registry (Exchange)
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
applicationId | string |
Application Name |
icon | object |
A Readable stream with the Icon file content. eg: fs.createReadStream(). The icon must be of size 512x512 and of type png or jpg. |
Promise.<Response>
coreConsoleAPI.getAppRegistryHealth(organizationId) ⇒ Get App Registry (Exchange) health
Kind: instance method of CoreConsoleAPI
Returns: Promise.<Response>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
Promise.<ConsoleResponse>
coreConsoleAPI.getSDKProperties(organizationId, integrationId, sdkCode) ⇒ Get details about a service (SDK) subscribed to an integration
Kind: instance method of CoreConsoleAPI
Returns: Promise.<ConsoleResponse>
- the response
Param | Type | Description |
---|---|---|
organizationId | string |
Organization AMS ID |
integrationId | string |
Integration ID |
sdkCode | string |
the service sdkCode to query (e.g. AdobeAnalyticsSDK) |
Array
createRequestOptions(apiKey, options) ⇒ Create request options compatible with the console swagger definition
Kind: global function
Returns: Array
- [{ swaggerParameters }, { requestBody }]
Param | Type | Description |
---|---|---|
apiKey | string |
apiKey to access console api |
options | object |
optional data used for building the request options |
[options.parameters] | object |
parameters to set to the request, specific to each endpoint |
[options.body] | object |
request body for the request |
function
requestInterceptorBuilder(coreConsoleAPIInstance, apihost) ⇒ Build a swagger request interceptor for the console sdk
Kind: global function
Returns: function
- a request interceptor
Param | Type | Description |
---|---|---|
coreConsoleAPIInstance | object |
console core api instance |
apihost | string |
console api url host |
object
responseInterceptor(res) ⇒ A swagger response interceptor for the console sdk
Kind: global function
Returns: object
- the response object
Param | Type | Description |
---|---|---|
res | object |
the response object |
Promise.<CoreConsoleAPI>
init(accessToken, apiKey, [env]) ⇒ Returns a Promise that resolves with a new CoreConsoleAPI object
Kind: global function
Returns: Promise.<CoreConsoleAPI>
- a Promise with a CoreConsoleAPI object
Param | Type | Default | Description |
---|---|---|---|
accessToken | string |
the access token corresponding to an integration or user token | |
apiKey | string |
api key to access the Developer Console | |
[env] | string |
"prod" |
the server environment ('prod' or 'stage') |
object
Response : Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
url | string |
requested url |
ok | boolean |
response ok indicator |
status | number |
response status code |
statusText | number |
response status text |
headers | object |
response headers |
body | object |
response body object |
obj | object |
response body object |
data | object |
response body string |
text | object |
response body string |
object
ProjectDetails : Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
name | string |
Name |
title | string |
Title |
[who_created] | string |
Creator name |
[description] | string |
Description |
type | string |
Type (default or jaeger) |
object
WorkspaceDetails : Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
name | string |
Name |
[title] | string |
Title |
[who_created] | string |
Creator name |
[description] | string |
Description |
[type] | string |
Type |
[quotaRule] | string |
quotaRule |
object
AdobeIdIntegrationDetails : Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
name | string |
Name |
description | string |
Description |
platform | string |
Platform |
[urlScheme] | string |
url scheme |
[redirectUriList] | object |
List of redirect URIs |
[defaultRedirectUri] | string |
Default redirect URI |
[domain] | string |
domain |
[approvalInfo] | object |
approvalInfo |
Debug Logs
LOG_LEVEL=debug <your_call_here>
Prepend the LOG_LEVEL
environment variable and debug
value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.
Contributing
Contributions are welcome! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.