Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Integration

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:integration"

links

links: { fx:client: Client; fx:store: Backend.Rels.Store; fx:user: User; self: Integration }

Type declaration

  • fx:client: Client

    API client details.

  • fx:store: Backend.Rels.Store

    Store this integration is assigned to.

  • fx:user: User

    Admin user who created this integration.

  • self: Integration

    This resource.

props

props: { added_by_email: string; added_by_name: string; client_id: string; company_logo: string; company_name: string; company_url: string; contact_email: string; contact_name: string; expires: number; project_description: string; project_name: string; scope: string; user_uri: string }

Type declaration

  • added_by_email: string

    Maps to the email of the user resource.

  • added_by_name: string

    Maps to the first_name and last_name of the user resource.

  • client_id: string

    A unique identifier for this client. Maps to the client_id of the client resource.

  • company_logo: string

    Maps to the company_logo of the client resource.

  • company_name: string

    Maps to the company_name of the client resource.

  • company_url: string

    Maps to the company_url of the client resource.

  • contact_email: string

    Maps to the contact_email of the client resource.

  • contact_name: string

    Maps to the contact_name of the client resource.

  • expires: number

    When this OAuth refresh token expires.

  • project_description: string

    Maps to the project_description of the client resource.

  • project_name: string

    Maps to the project_name of the client resource.

  • scope: string

    The OAuth scope granted to this integration.

  • user_uri: string

    A full API URI of the user resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc