Options
All
  • Public
  • Public/Protected
  • All
Menu

@aaronhayes/hasura-sdk

Index

Classes

Interfaces

Type aliases

Type aliases

ActionName

ActionName: string

CollectionName

CollectionName: string

ComputedFieldName

ComputedFieldName: string

CreateCronTriggerParams

CreateCronTriggerParams: { comment?: string; headers?: keyof EventHeader[]; include_in_metadata?: boolean; name: string; payload?: EventPayload; replace?: boolean; retry_conf?: TriggerRetryConfigST; schedule: CronExpression; webhook: WebhookUrl }

Type declaration

  • Optional Readonly comment?: string
  • Optional Readonly headers?: keyof EventHeader[]
  • Optional Readonly include_in_metadata?: boolean
  • Readonly name: string
  • Optional Readonly payload?: EventPayload
  • Optional Readonly replace?: boolean
  • Optional Readonly retry_conf?: TriggerRetryConfigST
  • Readonly schedule: CronExpression
  • Readonly webhook: WebhookUrl

CreateEventTriggerParams

CreateEventTriggerParams: { delete?: OperationSpec; headers?: keyof EventHeader[]; insert?: OperationSpec; name: string; replace?: boolean; retry_conf?: TriggerRetryConfig; table: QualifiedTable; update?: OperationSpec; webhook?: string; webhook_from_env?: string }

Type declaration

CreateScheduledEventParams

CreateScheduledEventParams: { comment?: string; headers?: keyof EventHeader[]; payload?: EventPayload; retry_conf?: TriggerRetryConfigST; schedule_at: string; webhook: string }

Type declaration

  • Optional Readonly comment?: string
  • Optional Readonly headers?: keyof EventHeader[]
  • Optional Readonly payload?: EventPayload
  • Optional Readonly retry_conf?: TriggerRetryConfigST
  • Readonly schedule_at: string
  • Readonly webhook: string

CronExpression

CronExpression: string

EventHeader

EventHeader: HeaderFromValue | HeaderFromEnv

EventPayload

EventPayload: {}

Type declaration

  • [key: string]: any

EventTriggerColumns

EventTriggerColumns: "*" | PGColumn[]

https://hasura.io/docs/1.0/graphql/manual/api-reference/schema-metadata-api/event-triggers.html#eventtriggercolumns

FunctionName

FunctionName: string | QualifiedFunction

GraphQLName

GraphQLName: string

GraphQLType

GraphQLType: string

HasuraConfig

HasuraConfig: { adminSecret: string; endpoint: string }

Type declaration

  • Readonly adminSecret: string
  • Readonly endpoint: string

HasuraQueryResponse

HasuraQueryResponse: { args: object; tyep: string; version?: number }

Type declaration

  • Readonly args: object
  • Readonly tyep: string
  • Optional Readonly version?: number

HasuraResponse

HasuraResponse: AxiosResponse<HasuraQueryResponse>

HasuraRunSQLAxiosResponse

HasuraRunSQLAxiosResponse: AxiosResponse<HasuraRunSQLResponse>

HasuraRunSQLResponse

HasuraRunSQLResponse: { result?: keyof ResultTuple[]; result_type: string }

Type declaration

  • Optional Readonly result?: keyof ResultTuple[]
  • Readonly result_type: string

InvokeEventTriggerParams

InvokeEventTriggerParams: { name: string; payload: EventPayload }

Type declaration

PGColumn

PGColumn: string

RelationshipName

RelationshipName: string

RemoteRelationshipName

RemoteRelationshipName: string

RemoteSchemaName

RemoteSchemaName: string

ResultTuple

ResultTuple: keyof string[]

RoleName

RoleName: string

RunSQLParams

RunSQLParams: { cascade?: boolean; check_metadata_consistency?: boolean; read_only?: boolean; sql: string }

Type declaration

  • Optional Readonly cascade?: boolean
  • Optional Readonly check_metadata_consistency?: boolean
  • Optional Readonly read_only?: boolean
  • Readonly sql: string

SetEnumTableArgs

SetEnumTableArgs: { is_enum: boolean; table: TableName }

Type declaration

  • Readonly is_enum: boolean
  • Readonly table: TableName

SetTableCustomFieldsArgs

SetTableCustomFieldsArgs: { custom_column_name?: CustomColumnNames; custom_root_fields?: CustomRootFields; table: TableName }

Type declaration

SetTableCustomFieldsResponse

SetTableCustomFieldsResponse: AxiosResponse<{ message: string }>

SetTableIsEnumResponse

SetTableIsEnumResponse: AxiosResponse<{ message: string }>

TableName

TableName: string | QualifiedTable

TrackTableArgs

TrackTableArgs: { is_enum?: boolean; table: TableName }

Type declaration

  • Optional Readonly is_enum?: boolean
  • Readonly table: TableName

TrackTableResponse

TrackTableResponse: AxiosResponse<{ message: string }>

TrackTableV2Args

TrackTableV2Args: { configuration: TableConfig; table: TableName }

Type declaration

TriggerName

TriggerName: string

TriggerRetryConfig

TriggerRetryConfig: { num_retries?: number; retry_interval_seconds?: number; timeout_seconds?: number }

Type declaration

  • Optional Readonly num_retries?: number
  • Optional Readonly retry_interval_seconds?: number
  • Optional Readonly timeout_seconds?: number

TriggerRetryConfigST

TriggerRetryConfigST: { num_retries?: number; retry_interval_seconds?: number; timeout_seconds?: number; tolerance_seconds?: number }

Type declaration

  • Optional Readonly num_retries?: number
  • Optional Readonly retry_interval_seconds?: number
  • Optional Readonly timeout_seconds?: number
  • Optional Readonly tolerance_seconds?: number

UntrackTableArgs

UntrackTableArgs: { cascade?: boolean; table: TableName }

Type declaration

  • Optional Readonly cascade?: boolean
  • Readonly table: TableName

UntrackTableResponse

UntrackTableResponse: AxiosResponse<{ message: string }>

WebhookURL

WebhookURL: string

A String value which supports templating environment variables enclosed in {{ and }}. Template example: https://{{ACTION_API_DOMAIN}}/create-user

WebhookUrl

WebhookUrl: string

Generated using TypeDoc