models

type AndRule []*Rules

type Bucket struct {

	// auth
	Auth *BucketAuth `json:"auth,omitempty"`

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// If ephemeral is enabled, Webhook Relay will not persist request body, headers or response details
	Ephemeral bool `json:"ephemeral,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// inputs
	// Read Only: true
	Inputs []*Input `json:"inputs"`

	// name
	Name string `json:"name,omitempty"`

	// outputs
	// Read Only: true
	Outputs []*Output `json:"outputs"`

	// Enable/disabled streaming to WebSocket clients from this bucket
	Stream bool `json:"stream,omitempty"`

	// Indicates that webhooks will not be received due to quota limits
	// Read Only: true
	Suspended *bool `json:"suspended,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

type BucketAuth struct {

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// password
	Password string `json:"password,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// type
	Type string `json:"type,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// username
	Username string `json:"username,omitempty"`
}

type BucketRequest struct {

	// description
	Description string `json:"description,omitempty"`

	// name
	Name string `json:"name,omitempty"`
}

type Domain struct {

	// created
	// Read Only: true
	Created int64 `json:"created,omitempty"`

	// Name of the domain to reserve, for example joe.hooks.webhookrelay.com, hooks.example.com, tunnel.mydomain.com, etc.
	Domain string `json:"domain,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// updated
	// Read Only: true
	Updated int64 `json:"updated,omitempty"`
}

type Function struct {

	// compression
	// Read Only: true
	Compression string `json:"compression,omitempty"`

	// created
	// Read Only: true
	Created string `json:"created,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// metadata
	Metadata map[string]string `json:"metadata,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// base64 encoded function body
	Payload string `json:"payload,omitempty"`

	// payload size
	// Read Only: true
	PayloadSize string `json:"payload_size,omitempty"`

	// updated
	// Read Only: true
	Updated string `json:"updated,omitempty"`
}

type FunctionConfig struct {

	// Key that will be used to access it from the function
	Key string `json:"key,omitempty"`

	// Your configuration value
	Value string `json:"value,omitempty"`
}

type FunctionRequest struct {

	// Driver name (Lua, WASI)
	Driver string `json:"driver,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// base64 encoded function payload
	Payload string `json:"payload,omitempty"`
}

type HeaderItem []string

type Headers map[string]HeaderItem

type Input struct {

	// Response body to return when this input receives a webhook
	Body string `json:"body,omitempty"`

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// Specify any custom domain from your Reserved Domains, such as example.hooks.webhookrelay.com or hooks.example.com (if used with your own top level domain name, create a CNAME pointing at hooks.webhookrelay.com)
	CustomDomain string `json:"custom_domain,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// ID of the function that will be executed for this input
	FunctionID string `json:"function_id,omitempty"`

	// headers
	Headers Headers `json:"headers,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// When used with custom domains, path_prefix can host multiple input endpoints on a single domain, such as hooks.example.com/github -> Jenkins CI, hooks.example.com/gitlab -> Spinnaker
	PathPrefix string `json:"path_prefix,omitempty"`

	// Output ID to specify a single output for response or set it to 'anyOutput' to return response from any output. Output should respond within 10 seconds
	ResponseFromOutput string `json:"response_from_output,omitempty"`

	// Response status code to return when this input receives a webhook
	StatusCode int64 `json:"status_code,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

type IntegrationConfiguration struct {

	// buckets
	Buckets []*Bucket `json:"buckets"`

	// created
	// Read Only: true
	Created int64 `json:"created,omitempty"`

	// Free form description field
	Description string `json:"description,omitempty"`

	// Disable/enable notification configuration. Consistently failing configurations will be disabled
	Disabled bool `json:"disabled,omitempty"`

	// Event types, currently supported are: 'forwarding.function.error' for failed functions and 'forwarding.delivery.error' for failed webhook delivery. Learn more here https://webhookrelay.com/v1/guide/integrations
	Events []string `json:"events"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// Status description
	Message string `json:"message,omitempty"`

	// Plugin to use, more info about webhook plugin can be found in the docs here: https://webhookrelay.com/v1/guide/integrations#Webhook
	// Enum: [slack webhook]
	Plugin string `json:"plugin,omitempty"`

	// Plugin status
	// Read Only: true
	Status string `json:"status,omitempty"`

	// updated
	// Read Only: true
	Updated int64 `json:"updated,omitempty"`
}

type Log struct {

	// body
	Body string `json:"body,omitempty"`

	// bucket id
	// Read Only: true
	BucketID string `json:"bucket_id,omitempty"`

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// This field is inherited from the bucket, if set - request/response body will not be set
	Ephemeral bool `json:"ephemeral,omitempty"`

	// headers
	Headers Headers `json:"headers,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// input id
	// Read Only: true
	InputID string `json:"input_id,omitempty"`

	// When internal output receives webhook, it forwards it to any connected agent (relay CLI, Docker agent or WebSocket connection)
	Internal bool `json:"internal,omitempty"`

	// method
	Method string `json:"method,omitempty"`

	// output id
	// Read Only: true
	OutputID string `json:"output_id,omitempty"`

	// raw query for example request to http://example.com?foo=bar is foo=bar
	RawQuery string `json:"raw_query,omitempty"`

	// response body
	ResponseBody string `json:"response_body,omitempty"`

	// response headers
	ResponseHeaders Headers `json:"response_headers,omitempty"`

	// Retries taken so far
	Retries int64 `json:"retries,omitempty"`

	// Request status, example values 'preparing', 'sent', 'failed', 'stalled', 'received', 'rejected'
	Status string `json:"status,omitempty"`

	// status code
	StatusCode int64 `json:"status_code,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

type LogAction struct {

	// Log action, for example 'resend'
	Action string `json:"action,omitempty"`

	// Optional, only set to an output ID if you want to resend this log to the specific output instead of all bucket outputs
	Output string `json:"output,omitempty"`
}

type LogsResponse struct {

	// data
	Data []*Log `json:"data"`

	// limit
	Limit int64 `json:"limit,omitempty"`

	// offset
	Offset int64 `json:"offset,omitempty"`

	// total
	Total int64 `json:"total,omitempty"`
}

type MatchRule struct {

	// parameter
	Parameter *RuleParameter `json:"parameter,omitempty"`

	// regex
	Regex string `json:"regex,omitempty"`

	// secret
	Secret string `json:"secret,omitempty"`

	// substring
	Substring string `json:"substring,omitempty"`

	// type
	// Enum: [value contains does-not-contain regex payload-hash-sha1 payload-hash-sha256]
	Type string `json:"type,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

type NotRule []*Rules

type OrRule []*Rules

type Output struct {

	// bucket id
	// Read Only: true
	BucketID string `json:"bucket_id,omitempty"`

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// Destination, where to forward the webhook, such as 'http://localhost:4000'
	Destination string `json:"destination,omitempty"`

	// ID of the function that will be executed for this output
	FunctionID string `json:"function_id,omitempty"`

	// Headers to override (for example Host)
	Headers Headers `json:"headers,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// When internal output receives webhook, it forwards it to any connected agent (relay CLI, Docker agent or WebSocket connection)
	Internal bool `json:"internal,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// Request matching rules, documentation can be found here https://webhookrelay.com/v1/guide/webhook-forwarding.html#Request-matching-rules
	Rules *Rules `json:"rules,omitempty"`

	// Timeout in seconds, value between 0 and 180
	Timeout int64 `json:"timeout,omitempty"`

	// Enforce TLS verification where possible (internal and public destinations)
	TLSVerification bool `json:"tls_verification,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

type Response struct {

	// ID of the object
	ID string `json:"id,omitempty"`

	// Status of the action
	Status string `json:"status,omitempty"`
}

type RuleParameter struct {

	// name
	Name string `json:"name,omitempty"`

	// source
	// Enum: [header payload query]
	Source string `json:"source,omitempty"`
}

type Rules struct {

	// and
	And AndRule `json:"and,omitempty"`

	// match
	Match *MatchRule `json:"match,omitempty"`

	// not
	Not NotRule `json:"not,omitempty"`

	// or
	Or OrRule `json:"or,omitempty"`
}

type Token struct {

	// Enable/disable API access. If disabled, it can only be used to open tunnel connections or forward webhooks but not change any existing configuration
	// Enum: [disabled enabled]
	APIAccess string `json:"api_access,omitempty"`

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// last login
	// Read Only: true
	LastLogin string `json:"last_login,omitempty"`

	// scopes
	Scopes *TokenScopes `json:"scopes,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

type TokenCreateResponse struct {

	// Token key, this is an alias to token ID
	Key string `json:"key,omitempty"`

	// This is the only time secret is revealed as it is already encrypted by the system
	Secret string `json:"secret,omitempty"`
}

type TokenScopes struct {

	// buckets
	Buckets []string `json:"buckets"`

	// tunnels
	Tunnels []string `json:"tunnels"`
}

type Tunnel struct {

	// auth
	Auth *TunnelAuth `json:"auth,omitempty"`

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// Tunnel encryption type
	// Enum: [off flexible full full-strict tls-pass-through]
	Crypto string `json:"crypto,omitempty"`

	// description
	Description string `json:"description,omitempty"`

	// destination
	Destination string `json:"destination,omitempty"`

	// Groups allow agents to subscribe to one or more tunnels
	Group string `json:"group,omitempty"`

	// host
	Host string `json:"host,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// protocol
	Protocol string `json:"protocol,omitempty"`

	// Tunnel region
	// Enum: [ us-west eu au]
	Region string `json:"region,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

type TunnelAuth struct {

	// created at
	// Read Only: true
	CreatedAt int64 `json:"created_at,omitempty"`

	// id
	// Read Only: true
	ID string `json:"id,omitempty"`

	// password
	Password string `json:"password,omitempty"`

	// token
	Token string `json:"token,omitempty"`

	// type
	Type string `json:"type,omitempty"`

	// updated at
	// Read Only: true
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// username
	Username string `json:"username,omitempty"`
}