models

type HashicorpCloudWebhookCreateWebhookRequestBody struct {

	// The required information for delivering event payloads.
	Config *HashicorpCloudWebhookWebhookConfig `json:"config,omitempty"`

	// The webhook description. Useful for providing a summary of the webhook.
	Description string `json:"description,omitempty"`

	// When set to 'true', a verification request will be sent and the webhook created enabled and only if the verification succeeds.
	// When set to 'false', the webhook configuration won't be verified and the webhook created disabled.
	// When left unset, a verification request will be sent and the webhook will be created enabled if it succeeds,
	// or disabled if it fails.
	Enabled *bool `json:"enabled,omitempty"`

	// The webhook name.
	Name string `json:"name,omitempty"`

	// The resource lifecycle events that this webhook is subscribed to.
	Subscriptions []*HashicorpCloudWebhookWebhookSubscription `json:"subscriptions"`

	// The optional payload used to deliver a test request to validate the webhook configuration.
	// If not set, the webhook service delivers a generic payload.
	TestPayload *HashicorpCloudWebhookWebhookPayload `json:"test_payload,omitempty"`
}

type HashicorpCloudWebhookCreateWebhookResponse struct {

	// The newly create webhook.
	Webhook *HashicorpCloudWebhookWebhook `json:"webhook,omitempty"`
}

type HashicorpCloudWebhookDeleteWebhookResponse interface{}

type HashicorpCloudWebhookGetWebhookResponse struct {

	// The fetched webhook.
	Webhook *HashicorpCloudWebhookWebhook `json:"webhook,omitempty"`
}

type HashicorpCloudWebhookListWebhookDeliveriesResponse struct {

	// The list of webhook deliveries.
	Deliveries []*HashicorpCloudWebhookWebhookDelivery `json:"deliveries"`

	// Pagination tokens for a subsequent request.
	Pagination *cloud.HashicorpCloudCommonPaginationResponse `json:"pagination,omitempty"`
}

type HashicorpCloudWebhookListWebhooksResponse struct {

	// Pagination tokens for a subsequent request.
	Pagination *cloud.HashicorpCloudCommonPaginationResponse `json:"pagination,omitempty"`

	// The list of webhooks.
	Webhooks []*HashicorpCloudWebhookWebhook `json:"webhooks"`
}

type HashicorpCloudWebhookTestWebhookRequestBody struct {

	// The required information necessary for delivering the test payload.
	Config *HashicorpCloudWebhookWebhookConfig `json:"config,omitempty"`

	// The optional testing payload to send to the webhook. If not set, the webhook service delivers a generic payload.
	TestPayload *HashicorpCloudWebhookWebhookPayload `json:"test_payload,omitempty"`

	// The optional webhook UUID. If specified, the test is stored as a delivery for this webhook.
	WebhookResourceID string `json:"webhook_resource_id,omitempty"`
}

type HashicorpCloudWebhookTestWebhookResponse interface{}

type HashicorpCloudWebhookUpdateWebhookNameRequestBody struct {

	// The updated name for the webhook.
	Name string `json:"name,omitempty"`
}

type HashicorpCloudWebhookUpdateWebhookNameResponse struct {

	// The updated webhook.
	Webhook *HashicorpCloudWebhookWebhook `json:"webhook,omitempty"`
}

type HashicorpCloudWebhookUpdateWebhookRequestBody struct {

	// The optional payload used to deliver a test request to validate the webhook configuration.
	// The endpoint only sends the test payload when the `webhook.config` is updated or webhook is enabled.
	// Othewise, the webhook service delivers a generic payload.
	TestPayload *HashicorpCloudWebhookWebhookPayload `json:"test_payload,omitempty"`

	// The required mask of webhook fields to update. The endpoint converts field names to the lower-camel naming convention.
	// Fields that you can update are `description`, `config`, `subscriptions`, and `enabled`.
	//
	// Example of usage:
	// * `"description,config"` updates the description, `config.url`, and `config.hmac_key`.
	// * `"config.hmacKey"` only updates `config.hmac_key`.
	// * `"description,config,subscriptions,enabled"` update all allowed fields.
	UpdateMask string `json:"update_mask,omitempty"`

	// The webhook to update.
	Webhook *HashicorpCloudWebhookWebhook `json:"webhook,omitempty"`
}

type HashicorpCloudWebhookUpdateWebhookResponse struct {

	// The updated webhook.
	Webhook *HashicorpCloudWebhookWebhook `json:"webhook,omitempty"`
}

type HashicorpCloudWebhookWebhook struct {

	// The information for delivering event payloads.
	Config *HashicorpCloudWebhookWebhookConfig `json:"config,omitempty"`

	// The time the webhook was created.
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// The description of this webhook.
	Description string `json:"description,omitempty"`

	// When `true`, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.
	Enabled bool `json:"enabled,omitempty"`

	// The latest delivery to the webhook.
	LastDelivery *HashicorpCloudWebhookWebhookDelivery `json:"last_delivery,omitempty"`

	// Unique identifier for the platform.
	ResourceID string `json:"resource_id,omitempty"`

	// The human-readable identifier for the platform. For example, `webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>`.
	ResourceName string `json:"resource_name,omitempty"`

	// The resource events this webhook is subscribed to.
	Subscriptions []*HashicorpCloudWebhookWebhookSubscription `json:"subscriptions"`

	// The time the webhook was last updated.
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}

type HashicorpCloudWebhookWebhookConfig struct {

	// The optional HMAC key used to sign all requests.
	HmacKey string `json:"hmac_key,omitempty"`

	// The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.
	URL string `json:"url,omitempty"`
}

type HashicorpCloudWebhookWebhookDelivery struct {

	// The unique identifier for the delivery.
	ID string `json:"id,omitempty"`

	// The request that delivers the event payload.
	Request *HashicorpCloudWebhookWebhookRequest `json:"request,omitempty"`

	// The response received from the external webhook service when a request was sent to deliver the payload.
	Response *HashicorpCloudWebhookWebhookResponse `json:"response,omitempty"`

	// The number of times HCP Packer resent the request before successfully delivering the payload.
	Retries int32 `json:"retries,omitempty"`

	// The ID of the webhook to which the payload was delivered.
	WebhookResourceID string `json:"webhook_resource_id,omitempty"`
}

type HashicorpCloudWebhookWebhookPayload struct {

	// The type of action performed by this event, for example `create`.
	EventAction string `json:"event_action,omitempty"`

	// The event description, for example `Created iteration`.
	EventDescription string `json:"event_description,omitempty"`

	// The unique identifier for the event generated by the services that own the resources. The value format is: `<service>.event:<random string>`,
	// for example, `packer.event:t79BRg8WhTmDPBRM`.
	EventID string `json:"event_id,omitempty"`

	// The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.
	EventPayload interface{} `json:"event_payload,omitempty"`

	// Refers to the source of the event, for example `hashicorp.packer.version`.
	// The event source type may differ from the resource that the webhook is subscribed to when the event is from a
	// descendent resource.
	// For example, webhooks subscribed to `hashicorp.packer.registry` receive events for the descendant's resources,
	// such as a `hashicorp.packer.version`.
	EventSource string `json:"event_source,omitempty"`

	// The version of the payload being sent.
	EventVersion string `json:"event_version,omitempty"`

	// The ID of the resource the event is related to.
	ResourceID string `json:"resource_id,omitempty"`

	// The name of the resource the event is related to.
	ResourceName string `json:"resource_name,omitempty"`
}

type HashicorpCloudWebhookWebhookRequest struct {

	// The request headers.
	Headers map[string]string `json:"headers,omitempty"`

	// The request body.
	Payload *HashicorpCloudWebhookWebhookPayload `json:"payload,omitempty"`

	// The UTC time the request was sent.
	// Format: date-time
	SentAt strfmt.DateTime `json:"sent_at,omitempty"`

	// The request's destination URL.
	URL string `json:"url,omitempty"`
}

type HashicorpCloudWebhookWebhookResponse struct {

	// The response body.
	Body string `json:"body,omitempty"`

	// The response headers.
	Headers map[string]string `json:"headers,omitempty"`

	// The response status code.
	StatusCode int32 `json:"status_code,omitempty"`
}

type HashicorpCloudWebhookWebhookSubscription struct {

	// The list of resource lifecycle events that the webhook is subscribed to.
	// Events are a combination of event source and event action.
	// For example, `hashicorp.packer.version:create`.
	// The wildcard(`*`) subscribes the webhook to all the source's events, for example `hashicorp.packer.version:*`.
	Events []*HashicorpCloudWebhookWebhookSubscriptionEvent `json:"events"`

	// Refers to the resource the webhook is subscribed to.
	// If not set, the webhook subscribes to the emitted events listed in `events`
	// for any resource in the webhook's project.
	ResourceID string `json:"resource_id,omitempty"`
}

type HashicorpCloudWebhookWebhookSubscriptionEvent struct {

	// The type of action of this event, such as `create`, `update`, or `delete`.
	// When the action is '*', it means that the webhook is subscribed to all event actions for the event source.
	Action string `json:"action,omitempty"`

	// The source of the event, such as `hashicorp.packer.version`.
	Source string `json:"source,omitempty"`
}