ConfigAsCodeRequests

Requests to make to Atlassian GraphQL Gateway, scoped to Compass related configuration as code entities and actions.

Constructors

new ConfigAsCodeRequests(api: Default, cr: CompassRequests): ConfigAsCodeRequests

1
2
const configAsCodeRequests = new ConfigAsCodeRequests(
  {}
)

Properties

Methods

SyncComponentWithFile

syncComponentWithFile(input: SyncComponentWithFileInput): Promise<ApiPayload<ComponentPayload>>

Updates a component with data coming from the configuration as code file.

Required Oauth Scopes: write:component:compass

1
2
const resp = configAsCodeRequests.syncComponentWithFile(
  {
    "additionalExternalAliases": [
      {
        "externalId": "string",
        "externalSource": "string"
      }
    ],
    "additionalLinks": [
      {
        "name": "string",
        "type": "CHAT_CHANNEL",
        "url": "string"
      }
    ],
    "cloudId": "2d492f5d-068a-4e9c-a9d3-3618589b56c1",
    "configFile": "string",
    "configFileMetadata": {
      "configFileAction": "CREATE",
      "deduplicationId": "string",
      "newPath": "string",
      "oldPath": "string"
    },
    "externalSourceURL": "string"
  }
)

UnlinkComponent

unlinkComponent(input: UnLinkComponentInput): Promise<ApiPayload<ComponentPayload>>

Unlinks a component with data coming from the configuration as code file. The following are performed: Remove Data Manager Remove External Alias Returns an array of errors or success to the caller.

Required Oauth Scopes: write:component:compass

1
2
const resp = configAsCodeRequests.unlinkComponent(
  {
    "additionalExternalAliasesToRemove": [
      {
        "externalId": "string",
        "externalSource": "string"
      }
    ],
    "cloudId": "2d492f5d-068a-4e9c-a9d3-3618589b56c1",
    "componentId": "ari:cloud:compass:2d492f5d-068a-4e9c-a9d3-3618589b56c1:component/b11fd1ac-032a-44cf-a740-0c168b619cba/c27f43a0-f394-45f1-bf17-5da9451f5003",
    "deduplicationId": "string",
    "filePath": "string"
  }
)