hasura

type Action struct {
	Comment     *string          `json:"comment,omitempty"`     //  Comment
	Definition  ActionDefinition `json:"definition"`            //  Definition of the action
	Name        string           `json:"name"`                  //  Name of the action
	Permissions *Permissions     `json:"permissions,omitempty"` //  Permissions of the action
}

type ActionDefinition struct {
	Arguments            []InputArgument       `json:"arguments"`
	ForwardClientHeaders *bool                 `json:"forward_client_headers,omitempty"`
	Handler              string                `json:"handler"` //  A String value which supports templating environment variables enclosed in {{ and }}.; Template example: https://{{ACTION_API_DOMAIN}}/create-user
	Headers              []Header              `json:"headers"`
	Kind                 *string               `json:"kind,omitempty"`
	OutputType           *string               `json:"output_type,omitempty"`
	Type                 *ActionDefinitionType `json:"type,omitempty"`
}

type ActionDefinitionType string

type ActionName string

type AllowList struct {
	Collection string `json:"collection"` //  Name of a query collection to be added to the allow-list
}

type ArrRelUsing struct {
	ForeignKeyConstraintOn *ArrRelUsingFKeyOn        `json:"foreign_key_constraint_on,omitempty"` //  The column with foreign key constraint
	ManualConfiguration    *ArrRelUsingManualMapping `json:"manual_configuration,omitempty"`      //  Manual mapping of table and columns
}

type ArrRelUsingFKeyOn struct {
	Column string     `json:"column"`
	Table  *TableName `json:"table"`
}

type ArrRelUsingManualMapping struct {
	ColumnMapping map[string]string `json:"column_mapping"` //  Mapping of columns from current table to remote table
	RemoteTable   *TableName        `json:"remote_table"`   //  The table to which the relationship has to be established
}

type ArrayRelationship struct {
	Comment *string     `json:"comment,omitempty"` //  Comment
	Name    string      `json:"name"`              //  Name of the new relationship
	Using   ArrRelUsing `json:"using"`             //  Use one of the available ways to define an array relationship
}

type Client struct {
	Endpoint    string
	AdminSecret string
	Client      *http.Client
	CLI         string
}

type CollectionName string

type ColumnPresetsExpression map[string]string

type Columns string

type CommonMetadataOperations interface {
	ExportMetadata() (metadata io.Reader, err error)
	ClearMetadata() (io.Reader, error)
	ReloadMetadata() (io.Reader, error)
	DropInconsistentMetadata() (io.Reader, error)
	ReplaceMetadata(metadata io.Reader) (io.Reader, error)
	GetInconsistentMetadata() (*GetInconsistentMetadataResponse, error)
	GetInconsistentMetadataReader() (io.Reader, error)
}

type ComputedField struct {
	Comment    *string                 `json:"comment,omitempty"` //  Comment
	Definition ComputedFieldDefinition `json:"definition"`        //  The computed field definition
	Name       string                  `json:"name"`              //  Name of the new computed field
}

type ComputedFieldDefinition struct {
	Function        *FunctionName `json:"function"`                   //  The SQL function
	SessionArgument *string       `json:"session_argument,omitempty"` //  Name of the argument which accepts the Hasura session object as a JSON/JSONB value. If; omitted, the Hasura session object is not passed to the function
	TableArgument   *string       `json:"table_argument,omitempty"`   //  Name of the argument which accepts a table row type. If omitted, the first argument is; considered a table argument
}

type ComputedFieldName string

type CronTrigger struct {
	Comment           *string                `json:"comment,omitempty"`    //  Custom comment.
	Headers           []Header               `json:"headers"`              //  List of headers to be sent with the webhook
	IncludeInMetadata bool                   `json:"include_in_metadata"`  //  Flag to indicate whether a trigger should be included in the metadata. When a cron; trigger is included in the metadata, the user will be able to export it when the metadata; of the graphql-engine is exported.
	Name              string                 `json:"name"`                 //  Name of the cron trigger
	Payload           map[string]interface{} `json:"payload,omitempty"`    //  Any JSON payload which will be sent when the webhook is invoked.
	RetryConf         *RetryConfST           `json:"retry_conf,omitempty"` //  Retry configuration if scheduled invocation delivery fails
	Schedule          string                 `json:"schedule"`             //  Cron expression at which the trigger should be invoked.
	Webhook           string                 `json:"webhook"`              //  URL of the webhook
}

type CustomColumnNames map[string]string

type CustomFunction struct {
	Configuration *FunctionConfiguration `json:"configuration,omitempty"` //  Configuration for the SQL function
	Function      *FunctionName          `json:"function"`                //  Name of the SQL function
}

type CustomRootFields struct {
	Delete          *string `json:"delete,omitempty"`           //  Customise the `delete_<table-name>` root field
	DeleteByPk      *string `json:"delete_by_pk,omitempty"`     //  Customise the `delete_<table-name>_by_pk` root field
	Insert          *string `json:"insert,omitempty"`           //  Customise the `insert_<table-name>` root field
	InsertOne       *string `json:"insert_one,omitempty"`       //  Customise the `insert_<table-name>_one` root field
	Select          *string `json:"select,omitempty"`           //  Customise the `<table-name>` root field
	SelectAggregate *string `json:"select_aggregate,omitempty"` //  Customise the `<table-name>_aggregate` root field
	SelectByPk      *string `json:"select_by_pk,omitempty"`     //  Customise the `<table-name>_by_pk` root field
	Update          *string `json:"update,omitempty"`           //  Customise the `update_<table-name>` root field
	UpdateByPk      *string `json:"update_by_pk,omitempty"`     //  Customise the `update_<table-name>_by_pk` root field
}

type CustomTypeObjectRelationship struct {
	FieldMapping map[string]string                `json:"field_mapping"` //  Mapping of fields of object type to columns of remote table
	Name         string                           `json:"name"`          //  Name of the relationship, shouldn’t conflict with existing field names
	RemoteTable  *TableName                       `json:"remote_table"`  //  The table to which relationship is defined
	Type         CustomTypeObjectRelationshipType `json:"type"`          //  Type of the relationship
}

type CustomTypeObjectRelationshipType string

type CustomTypes struct {
	Enums        []EnumType        `json:"enums"`
	InputObjects []InputObjectType `json:"input_objects"`
	Objects      []ObjectType      `json:"objects"`
	Scalars      []ScalarType      `json:"scalars"`
}

type Definition struct {
	Queries []QueryCollection `json:"queries"`
}

type DeletePermission struct {
	Filter map[string]*Filter `json:"filter,omitempty"` //  Only the rows where this precondition holds true are updatable
}

type DeletePermissionEntry struct {
	Comment    *string          `json:"comment,omitempty"` //  Comment
	Permission DeletePermission `json:"permission"`        //  The permission definition
	Role       string           `json:"role"`              //  Role
}

type EnumType struct {
	Description *string     `json:"description,omitempty"` //  Description of the Enum type
	Name        string      `json:"name"`                  //  Name of the Enum type
	Values      []EnumValue `json:"values"`                //  Values of the Enum type
}

type EnumValue struct {
	Description  *string `json:"description,omitempty"`   //  Description of the Enum value
	IsDeprecated *bool   `json:"is_deprecated,omitempty"` //  If set to true, the enum value is marked as deprecated
	Value        string  `json:"value"`                   //  Value of the Enum type
}

type EventTrigger struct {
	Definition     EventTriggerDefinition `json:"definition"`        //  The SQL function
	Headers        []Header               `json:"headers"`           //  The SQL function
	Name           string                 `json:"name"`              //  Name of the event trigger
	RetryConf      RetryConf              `json:"retry_conf"`        //  The SQL function
	Webhook        *string                `json:"webhook,omitempty"` //  The SQL function
	WebhookFromEnv *string                `json:"webhook_from_env,omitempty"`
}

type EventTriggerColumns struct {
	Enum        *Columns
	StringArray []string
}

type EventTriggerDefinition struct {
	Delete       *OperationSpec `json:"delete,omitempty"` //  ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/event-triggers.html#operationspec
	EnableManual bool           `json:"enable_manual"`
	Insert       *OperationSpec `json:"insert,omitempty"` //  ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/event-triggers.html#operationspec
	Update       *OperationSpec `json:"update,omitempty"` //  ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/event-triggers.html#operationspec
}

type Filter struct {
	AnythingMap map[string]interface{}
	Double      *float64
	String      *string
}

type FunctionConfiguration struct {
	SessionArgument *string `json:"session_argument,omitempty"` //  Function argument which accepts session info JSON; Currently, only functions which satisfy the following constraints can be exposed over the; GraphQL API (terminology from Postgres docs):; - Function behaviour: ONLY `STABLE` or `IMMUTABLE`; - Return type: MUST be `SETOF <table-name>`; - Argument modes: ONLY `IN`
}

type FunctionName struct {
	QualifiedFunction *QualifiedFunction
	String            *string
}

type GetInconsistentMetadataResponse struct {
	IsConsistent        bool          `json:"is_consistent"`
	InconsistentObjects []interface{} `json:"inconsistent_objects"`
}

type GraphQLName string

type GraphQLType string

type HasuraMetadataV2 struct {
	Actions          []Action               `json:"actions"`
	Allowlist        []AllowList            `json:"allowlist"`
	CronTriggers     []CronTrigger          `json:"cron_triggers"`
	CustomTypes      *CustomTypes           `json:"custom_types,omitempty"`
	Functions        []CustomFunction       `json:"functions"`
	QueryCollections []QueryCollectionEntry `json:"query_collections"`
	RemoteSchemas    []RemoteSchema         `json:"remote_schemas"`
	Tables           []TableEntry           `json:"tables"`
	Version          float64                `json:"version"`
}

type HasuraMetadataV3 struct {
	ActionsGraphQL []Action `json:"actions.graphql"`
	ActionsYAML    []Action `json:"actions.yaml"`

	Allowlist    []AllowList
	CronTriggers []CronTrigger
	//  CustomTypes      *CustomTypes           `json:"custom_types,omitempty"`
	Functions        []CustomFunction       `json:"functions"`
	QueryCollections []QueryCollectionEntry `json:"query_collections"`
	RemoteSchemas    []RemoteSchema         `json:"remote_schemas"`
	Tables           []TableEntry           `json:"tables"`
	Version          float64                `json:"version"`
}

type Header struct {
	Name         string  `json:"name"`                     //  Name of the header
	Value        *string `json:"value,omitempty"`          //  Value of the header
	ValueFromEnv *string `json:"value_from_env,omitempty"` //  Name of the environment variable which holds the value of the header
}

type HeaderFromEnv struct {
	Name         string `json:"name"`           //  Name of the header
	ValueFromEnv string `json:"value_from_env"` //  Name of the environment variable which holds the value of the header
}

type HeaderFromValue struct {
	Name  string `json:"name"`  //  Name of the header
	Value string `json:"value"` //  Value of the header
}

type InputArgument struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type InputArguments map[string]string

type InputObjectField struct {
	Description *string `json:"description,omitempty"` //  Description of the Input object type
	Name        string  `json:"name"`                  //  Name of the Input object type
	Type        string  `json:"type"`                  //  GraphQL type of the Input object type
}

type InputObjectType struct {
	Description *string            `json:"description,omitempty"` //  Description of the Input object type
	Fields      []InputObjectField `json:"fields"`                //  Fields of the Input object type
	Name        string             `json:"name"`                  //  Name of the Input object type
}

type InsertPermission struct {
	BackendOnly *bool                `json:"backend_only,omitempty"` //  When set to true the mutation is accessible only if x-hasura-use-backend-only-permissions; session variable exists; and is set to true and request is made with x-hasura-admin-secret set if any auth is; configured
	Check       map[string]*Filter   `json:"check,omitempty"`        //  This expression has to hold true for every new row that is inserted
	Columns     *EventTriggerColumns `json:"columns"`                //  Can insert into only these columns (or all when '*' is specified)
	Set         map[string]string    `json:"set,omitempty"`          //  Preset values for columns that can be sourced from session variables or static values
}

type InsertPermissionEntry struct {
	Comment    *string          `json:"comment,omitempty"` //  Comment
	Permission InsertPermission `json:"permission"`        //  The permission definition
	Role       string           `json:"role"`              //  Role
}

type Migration struct {
	Name      string
	Version   int64
	SQLFile   string
	SQLServer bool
	Location  string
	Data      []byte
}

type ObjRelUsing struct {
	ForeignKeyConstraintOn *string                   `json:"foreign_key_constraint_on,omitempty"` //  The column with foreign key constraint
	ManualConfiguration    *ObjRelUsingManualMapping `json:"manual_configuration,omitempty"`      //  Manual mapping of table and columns
}

type ObjRelUsingManualMapping struct {
	ColumnMapping map[string]string `json:"column_mapping"` //  Mapping of columns from current table to remote table
	RemoteTable   *TableName        `json:"remote_table"`   //  The table to which the relationship has to be established
}

type ObjectField struct {
	Description *string `json:"description,omitempty"` //  Description of the Input object type
	Name        string  `json:"name"`                  //  Name of the Input object type
	Type        string  `json:"type"`                  //  GraphQL type of the Input object type
}

type ObjectRelationship struct {
	Comment *string     `json:"comment,omitempty"` //  Comment
	Name    string      `json:"name"`              //  Name of the new relationship
	Using   ObjRelUsing `json:"using"`             //  Use one of the available ways to define an object relationship
}

type ObjectType struct {
	Description   *string                        `json:"description,omitempty"` //  Description of the Input object type
	Fields        []InputObjectField             `json:"fields"`                //  Fields of the Input object type
	Name          string                         `json:"name"`                  //  Name of the Input object type
	Relationships []CustomTypeObjectRelationship `json:"relationships"`         //  Relationships of the Object type to tables
}

type OperationSpec struct {
	Columns *EventTriggerColumns `json:"columns"` //  ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/event-triggers.html#eventtriggercolumns
	Payload *EventTriggerColumns `json:"payload"` //  ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/event-triggers.html#eventtriggercolumns
}

type PGColumn string

type PGDumpRequest struct {
	Opts        []string `json:"opts"`
	CleanOutput bool     `json:"clean_output"`
	SourceName  string   `json:"source,omitempty"`
}

type Permissions struct {
	Role string `json:"role"`
}

type QualifiedFunction struct {
	Name   string `json:"name"`
	Schema string `json:"schema"`
}

type QualifiedTable struct {
	Name   string `json:"name"`
	Schema string `json:"schema"`
}

type QueryCollection struct {
	Name  string `json:"name"`
	Query string `json:"query"`
}

type QueryCollectionEntry struct {
	Comment    *string    `json:"comment,omitempty"` //  Comment
	Definition Definition `json:"definition"`        //  List of queries
	Name       string     `json:"name"`              //  Name of the query collection
}

type RelationshipName string

type RemoteField map[string]RemoteFieldValue

type RemoteFieldValue struct {
	Arguments map[string]string           `json:"arguments"`
	Field     map[string]RemoteFieldValue `json:"field,omitempty"` //  A recursive tree structure that points to the field in the remote schema that needs to be; joined with.; It is recursive because the remote field maybe nested deeply in the remote schema.; ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/remote-relationships.html#remotefield
}

type RemoteRelationship struct {
	Definition RemoteRelationshipDef `json:"definition"` //  Definition object
	Name       string                `json:"name"`       //  Name of the remote relationship
}

type RemoteRelationshipDef struct {
	HasuraFields []string                    `json:"hasura_fields"` //  Column(s) in the table that is used for joining with remote schema field.; All join keys in remote_field must appear here.
	RemoteField  map[string]RemoteFieldValue `json:"remote_field"`  //  The schema tree ending at the field in remote schema which needs to be joined with.
	RemoteSchema string                      `json:"remote_schema"` //  Name of the remote schema to join with
}

type RemoteRelationshipName string

type RemoteSchema struct {
	Comment    *string         `json:"comment,omitempty"` //  Comment
	Definition RemoteSchemaDef `json:"definition"`        //  Name of the remote schema
	Name       string          `json:"name"`              //  Name of the remote schema
}

type RemoteSchemaDef struct {
	ForwardClientHeaders *bool    `json:"forward_client_headers,omitempty"`
	Headers              []Header `json:"headers"`
	TimeoutSeconds       *float64 `json:"timeout_seconds,omitempty"`
	URL                  *string  `json:"url,omitempty"`
	URLFromEnv           *string  `json:"url_from_env,omitempty"`
}

type RemoteSchemaName string

type RequestBody struct {
	Type    string      `json:"type"`
	Version uint        `json:"version,omitempty"`
	Args    interface{} `json:"args"`
}

type Response struct {
	Path  string `json:"path"`
	Error string `json:"error"`
	Code  string `json:"code"`
}

type RetryConf struct {
	IntervalSEC *int64 `json:"interval_sec,omitempty"` //  Number of seconds to wait between each retry.; Default: 10
	NumRetries  *int64 `json:"num_retries,omitempty"`  //  Number of times to retry delivery.; Default: 0
	TimeoutSEC  *int64 `json:"timeout_sec,omitempty"`  //  Number of seconds to wait for response before timing out.; Default: 60
}

type RetryConfST struct {
	NumRetries           *int64 `json:"num_retries,omitempty"`            //  Number of times to retry delivery.; Default: 0
	RetryIntervalSeconds *int64 `json:"retry_interval_seconds,omitempty"` //  Number of seconds to wait between each retry.; Default: 10
	TimeoutSeconds       *int64 `json:"timeout_seconds,omitempty"`        //  Number of seconds to wait for response before timing out.; Default: 60
	ToleranceSeconds     *int64 `json:"tolerance_seconds,omitempty"`      //  Number of seconds between scheduled time and actual delivery time that is acceptable. If; the time difference is more than this, then the event is dropped.; Default: 21600 (6 hours)
}

type RoleName string

type ScalarType struct {
	Description *string `json:"description,omitempty"` //  Description of the Scalar type
	Name        string  `json:"name"`                  //  Name of the Scalar type
}

type SelectPermission struct {
	AllowAggregations *bool                `json:"allow_aggregations,omitempty"` //  Toggle allowing aggregate queries
	Columns           *EventTriggerColumns `json:"columns"`                      //  Only these columns are selectable (or all when '*' is specified)
	ComputedFields    []string             `json:"computed_fields"`              //  Only these computed fields are selectable
	Filter            map[string]*Filter   `json:"filter,omitempty"`             //  Only the rows where this precondition holds true are selectable
	Limit             *int64               `json:"limit,omitempty"`              //  The maximum number of rows that can be returned
}

type SelectPermissionEntry struct {
	Comment    *string          `json:"comment,omitempty"` //  Comment
	Permission SelectPermission `json:"permission"`        //  The permission definition
	Role       string           `json:"role"`              //  Role
}

type TableConfig struct {
	CustomColumnNames map[string]string `json:"custom_column_names,omitempty"` //  Customise the column names
	CustomRootFields  *CustomRootFields `json:"custom_root_fields,omitempty"`  //  Customise the root fields
}

type TableEntry struct {
	ArrayRelationships  []ArrayRelationship     `json:"array_relationships"`
	ComputedFields      []ComputedField         `json:"computed_fields"`
	Configuration       *TableConfig            `json:"configuration,omitempty"` //  Configuration for the table/view; ; https://hasura.io/docs/latest/graphql/core/api-reference/schema-metadata-api/table-view.html#table-config
	DeletePermissions   []DeletePermissionEntry `json:"delete_permissions"`
	EventTriggers       []EventTrigger          `json:"event_triggers"`
	InsertPermissions   []InsertPermissionEntry `json:"insert_permissions"`
	IsEnum              *bool                   `json:"is_enum,omitempty"`
	ObjectRelationships []ObjectRelationship    `json:"object_relationships"`
	RemoteRelationships []RemoteRelationship    `json:"remote_relationships"`
	SelectPermissions   []SelectPermissionEntry `json:"select_permissions"`
	Table               QualifiedTable          `json:"table"`
	UpdatePermissions   []UpdatePermissionEntry `json:"update_permissions"`
}

type TableName struct {
	QualifiedTable *QualifiedTable
	String         *string
}

type TriggerName string

type UpdatePermission struct {
	Check   map[string]*Filter   `json:"check,omitempty"`  //  Postcondition which must be satisfied by rows which have been updated
	Columns *EventTriggerColumns `json:"columns"`          //  Only these columns are selectable (or all when '*' is specified)
	Filter  map[string]*Filter   `json:"filter,omitempty"` //  Only the rows where this precondition holds true are updatable
	Set     map[string]string    `json:"set,omitempty"`    //  Preset values for columns that can be sourced from session variables or static values
}

type UpdatePermissionEntry struct {
	Comment    *string          `json:"comment,omitempty"` //  Comment
	Permission UpdatePermission `json:"permission"`        //  The permission definition
	Role       string           `json:"role"`              //  Role
}

type V2ReplaceMetadataArgs struct {
	AllowInconsistentMetadata bool        `json:"allow_inconsistent_metadata"`
	Metadata                  interface{} `json:"metadata"`
}

type V2ReplaceMetadataResponse struct {
	IsConsistent        bool        `json:"is_consistent"`
	InconsistentObjects interface{} `json:"inconsistent_objects"`
}

type WebhookURL string