added new model to docs

This commit is contained in:
Philip Ellis
2024-04-03 14:20:00 -04:00
parent 8b6d4a9e78
commit e2e0545e2f
2 changed files with 63 additions and 0 deletions

1
.gitignore vendored
View File

@@ -16,6 +16,7 @@
.env.test.local .env.test.local
.env.production.local .env.production.local
.env .env
.npmrc
npm-debug.log* npm-debug.log*
yarn-debug.log* yarn-debug.log*

View File

@@ -0,0 +1,62 @@
---
id: connectivity-customizers-config
title: Customizer Config Object
pagination_label: Config Object
sidebar_label: Config Object
sidebar_position: 6.5
sidebar_class_name: saasConnectivity
keywords: ['connectivity', 'connectors', customizers]
description: The config object in a customizer
slug: /connectivity/saas-connectivity/customizers/config
tags: ['Connectivity']
---
# Customizer Config Object
The connector config object holds all the config values that are set in the SaaS connector. These can be used to fetch custom settings added by the user, as well as inspect values from the connector instance itself.
The config object is fetched during initialization of the connector
```typescript
const config: Config = await readConfig()
```
### Example Config Object
Below is an example object model that can be used to type your config. Any values set by the connector itself are added at the top level json.
```typescript
export interface Config {
beforeProvisioningRule: any
cloudCacheUpdate: number
cloudDisplayName: string
cloudExternalId: string
connectionType: string
connectorName: string
deleteThresholdPercentage: number
deltaAggregation: DeltaAggregation
deltaAggregationEnabled: boolean
formPath: any
hasFullAggregationCompleted: boolean
healthCheckTimeout: number
healthy: boolean
idnProxyType: string
managementWorkgroup: any
managerCorrelationFilter: any
since: string
"slpt-source-diagnostics": string
sourceConnected: boolean
sourceDescription: string
spConnEnableStatefulCommands: boolean
spConnectorInstanceId: string
spConnectorSpecId: string
status: string
supportsDeltaAgg: boolean
templateApplication: string
}
export interface DeltaAggregation {
"std:account:list": any
"std:entitlement:list": any
}
```