Skip to content

consumerconnection.md

Latest commit

 

History

History
62 lines (57 loc) · 20.6 KB

consumerconnection.md

File metadata and controls

62 lines (57 loc) · 20.6 KB

ConsumerConnection

Example Usage

import { ConsumerConnection } from "@apideck/unify/models/components";

let value: ConsumerConnection = {
  id: "1111+test_user_id",
  name: "Salesforce",
  icon:
    "https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png",
  logo:
    "https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg",
  website: "https://www.salesforce.com",
  tagLine:
    "CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.",
  serviceId: "teamleader",
  unifiedApi: "crm",
  consumerId: "test_user_id",
  authType: "oauth2",
  enabled: true,
  settings: {
    "instance_url": "https://eu28.salesforce.com",
  },
  metadata: {
    "account": {
      "name": "My Company",
      "id": "c01458a5-7276-41ce-bc19-639906b0450a",
    },
    "plan": "enterprise",
  },
  createdAt: "2020-09-19T12:18:37.071Z",
  updatedAt: "2020-09-19T12:18:37.071Z",
  state: "authorized",
  health: "ok",
};

Fields

Field Type Required Description Example
id string ➖ N/A 1111+test_user_id
name string ➖ N/A Salesforce
icon string ➖ N/A https://res.cloudinary.com/apideck/image/upload/v1529456047/catalog/salesforce/icon128x128.png
logo string ➖ N/A https://c1.sfdcstatic.com/content/dam/web/en_us/www/images/home/logo-salesforce-m.svg
website string ➖ N/A https://www.salesforce.com
tagLine string ➖ N/A CRM software solutions and enterprise cloud computing from Salesforce, the leader in customer relationship management (CRM) and PaaS. Free 30 day trial.
serviceId string ➖ N/A teamleader
unifiedApi string ➖ N/A crm
consumerId string ➖ N/A test_user_id
authType components.AuthType ➖ Type of authorization used by the connector oauth2
enabled boolean ➖ N/A true
settings Record<string, any> ➖ Connection settings. Values will persist to form_fields with corresponding id {
"instance_url": "https://eu28.salesforce.com"
}
metadata Record<string, any> ➖ Attach your own consumer specific metadata {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
}
createdAt string ➖ N/A 2020-09-19T12:18:37.071Z
updatedAt string ➖ N/A 2020-09-19T12:18:37.071Z
state components.ConnectionState ➖ Connection state flow authorized
health components.ConnectionHealth ➖ The operational health status of the connection ok
credentialsExpireAt string ➖ ISO 8601 timestamp indicating when credentials will be cleared if token refresh continues to fail. Only present when connection health is pending_refresh and a retention window is active.
lastRefreshFailedAt string ➖ ISO 8601 timestamp of the most recent token refresh failure. Only present when connection has experienced refresh failures.