audit

package
v3.0.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package audit provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.

Index

Constants

View Source
const (
	HTTPBearerScopes hTTPBearerContextKey = "HTTPBearer.Scopes"
)

Variables

This section is empty.

Functions

func NewCreateForwarderRequestWithApplicationVndAPIPlusJSONBody added in v3.0.15

func NewCreateForwarderRequestWithApplicationVndAPIPlusJSONBody(server string, body CreateForwarderApplicationVndAPIPlusJSONRequestBody) (*http.Request, error)

NewCreateForwarderRequestWithApplicationVndAPIPlusJSONBody calls the generic CreateForwarder builder with application/vnd.api+json body

func NewCreateForwarderRequestWithBody added in v3.0.15

func NewCreateForwarderRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateForwarderRequestWithBody generates requests for CreateForwarder with any type of body

func NewDeleteForwarderRequest added in v3.0.15

func NewDeleteForwarderRequest(server string, forwarderId openapi_types.UUID) (*http.Request, error)

NewDeleteForwarderRequest generates requests for DeleteForwarder

func NewExecuteTestForwarderRequest added in v3.0.15

func NewExecuteTestForwarderRequest(server string, body ExecuteTestForwarderJSONRequestBody) (*http.Request, error)

NewExecuteTestForwarderRequest calls the generic ExecuteTestForwarder builder with application/json body

func NewExecuteTestForwarderRequestWithBody added in v3.0.15

func NewExecuteTestForwarderRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExecuteTestForwarderRequestWithBody generates requests for ExecuteTestForwarder with any type of body

func NewGetEventRequest

func NewGetEventRequest(server string, eventId openapi_types.UUID) (*http.Request, error)

NewGetEventRequest generates requests for GetEvent

func NewGetForwarderRequest added in v3.0.15

func NewGetForwarderRequest(server string, forwarderId openapi_types.UUID) (*http.Request, error)

NewGetForwarderRequest generates requests for GetForwarder

func NewListEventsRequest

func NewListEventsRequest(server string, params *ListEventsParams) (*http.Request, error)

NewListEventsRequest generates requests for ListEvents

func NewListForwarderDeliveriesRequest added in v3.0.15

func NewListForwarderDeliveriesRequest(server string, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams) (*http.Request, error)

NewListForwarderDeliveriesRequest generates requests for ListForwarderDeliveries

func NewListForwardersRequest added in v3.0.15

func NewListForwardersRequest(server string, params *ListForwardersParams) (*http.Request, error)

NewListForwardersRequest generates requests for ListForwarders

func NewListUsageRequest

func NewListUsageRequest(server string, params *ListUsageParams) (*http.Request, error)

NewListUsageRequest generates requests for ListUsage

func NewRecordEventRequestWithApplicationVndAPIPlusJSONBody added in v3.0.12

func NewRecordEventRequestWithApplicationVndAPIPlusJSONBody(server string, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody) (*http.Request, error)

NewRecordEventRequestWithApplicationVndAPIPlusJSONBody calls the generic RecordEvent builder with application/vnd.api+json body

func NewRecordEventRequestWithBody added in v3.0.12

func NewRecordEventRequestWithBody(server string, params *RecordEventParams, contentType string, body io.Reader) (*http.Request, error)

NewRecordEventRequestWithBody generates requests for RecordEvent with any type of body

func NewRetryFailedForwarderDeliveriesRequest added in v3.0.15

func NewRetryFailedForwarderDeliveriesRequest(server string, forwarderId openapi_types.UUID) (*http.Request, error)

NewRetryFailedForwarderDeliveriesRequest generates requests for RetryFailedForwarderDeliveries

func NewRetryForwarderDeliveryRequest added in v3.0.15

func NewRetryForwarderDeliveryRequest(server string, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID) (*http.Request, error)

NewRetryForwarderDeliveryRequest generates requests for RetryForwarderDelivery

func NewUpdateForwarderRequestWithApplicationVndAPIPlusJSONBody added in v3.0.15

func NewUpdateForwarderRequestWithApplicationVndAPIPlusJSONBody(server string, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody) (*http.Request, error)

NewUpdateForwarderRequestWithApplicationVndAPIPlusJSONBody calls the generic UpdateForwarder builder with application/vnd.api+json body

func NewUpdateForwarderRequestWithBody added in v3.0.15

func NewUpdateForwarderRequestWithBody(server string, forwarderId openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)

NewUpdateForwarderRequestWithBody generates requests for UpdateForwarder with any type of body

Types

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateForwarderWithApplicationVndAPIPlusJSONBody added in v3.0.15

func (c *Client) CreateForwarderWithApplicationVndAPIPlusJSONBody(ctx context.Context, body CreateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateForwarderWithBody added in v3.0.15

func (c *Client) CreateForwarderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteForwarder added in v3.0.15

func (c *Client) DeleteForwarder(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExecuteTestForwarder added in v3.0.15

func (c *Client) ExecuteTestForwarder(ctx context.Context, body ExecuteTestForwarderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ExecuteTestForwarderWithBody added in v3.0.15

func (c *Client) ExecuteTestForwarderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetEvent

func (c *Client) GetEvent(ctx context.Context, eventId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetForwarder added in v3.0.15

func (c *Client) GetForwarder(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListEvents

func (c *Client) ListEvents(ctx context.Context, params *ListEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListForwarderDeliveries added in v3.0.15

func (c *Client) ListForwarderDeliveries(ctx context.Context, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListForwarders added in v3.0.15

func (c *Client) ListForwarders(ctx context.Context, params *ListForwardersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListUsage

func (c *Client) ListUsage(ctx context.Context, params *ListUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RecordEventWithApplicationVndAPIPlusJSONBody added in v3.0.12

func (c *Client) RecordEventWithApplicationVndAPIPlusJSONBody(ctx context.Context, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RecordEventWithBody added in v3.0.12

func (c *Client) RecordEventWithBody(ctx context.Context, params *RecordEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetryFailedForwarderDeliveries added in v3.0.15

func (c *Client) RetryFailedForwarderDeliveries(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetryForwarderDelivery added in v3.0.15

func (c *Client) RetryForwarderDelivery(ctx context.Context, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateForwarderWithApplicationVndAPIPlusJSONBody added in v3.0.15

func (c *Client) UpdateForwarderWithApplicationVndAPIPlusJSONBody(ctx context.Context, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateForwarderWithBody added in v3.0.15

func (c *Client) UpdateForwarderWithBody(ctx context.Context, forwarderId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// ListEvents request
	ListEvents(ctx context.Context, params *ListEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RecordEventWithBody request with any body
	RecordEventWithBody(ctx context.Context, params *RecordEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RecordEventWithApplicationVndAPIPlusJSONBody(ctx context.Context, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEvent request
	GetEvent(ctx context.Context, eventId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListForwarders request
	ListForwarders(ctx context.Context, params *ListForwardersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateForwarderWithBody request with any body
	CreateForwarderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateForwarderWithApplicationVndAPIPlusJSONBody(ctx context.Context, body CreateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteForwarder request
	DeleteForwarder(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetForwarder request
	GetForwarder(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateForwarderWithBody request with any body
	UpdateForwarderWithBody(ctx context.Context, forwarderId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateForwarderWithApplicationVndAPIPlusJSONBody(ctx context.Context, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryFailedForwarderDeliveries request
	RetryFailedForwarderDeliveries(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListForwarderDeliveries request
	ListForwarderDeliveries(ctx context.Context, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetryForwarderDelivery request
	RetryForwarderDelivery(ctx context.Context, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteTestForwarderWithBody request with any body
	ExecuteTestForwarderWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ExecuteTestForwarder(ctx context.Context, body ExecuteTestForwarderJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListUsage request
	ListUsage(ctx context.Context, params *ListUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse added in v3.0.15

func (c *ClientWithResponses) CreateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body CreateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateForwarderResponse, error)

func (*ClientWithResponses) CreateForwarderWithBodyWithResponse added in v3.0.15

func (c *ClientWithResponses) CreateForwarderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateForwarderResponse, error)

CreateForwarderWithBodyWithResponse request with arbitrary body returning *CreateForwarderResponse

func (*ClientWithResponses) DeleteForwarderWithResponse added in v3.0.15

func (c *ClientWithResponses) DeleteForwarderWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteForwarderResponse, error)

DeleteForwarderWithResponse request returning *DeleteForwarderResponse

func (*ClientWithResponses) ExecuteTestForwarderWithBodyWithResponse added in v3.0.15

func (c *ClientWithResponses) ExecuteTestForwarderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTestForwarderResponse, error)

ExecuteTestForwarderWithBodyWithResponse request with arbitrary body returning *ExecuteTestForwarderResponse

func (*ClientWithResponses) ExecuteTestForwarderWithResponse added in v3.0.15

func (c *ClientWithResponses) ExecuteTestForwarderWithResponse(ctx context.Context, body ExecuteTestForwarderJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTestForwarderResponse, error)

func (*ClientWithResponses) GetEventWithResponse

func (c *ClientWithResponses) GetEventWithResponse(ctx context.Context, eventId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetEventResponse, error)

GetEventWithResponse request returning *GetEventResponse

func (*ClientWithResponses) GetForwarderWithResponse added in v3.0.15

func (c *ClientWithResponses) GetForwarderWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetForwarderResponse, error)

GetForwarderWithResponse request returning *GetForwarderResponse

func (*ClientWithResponses) ListEventsWithResponse

func (c *ClientWithResponses) ListEventsWithResponse(ctx context.Context, params *ListEventsParams, reqEditors ...RequestEditorFn) (*ListEventsResponse, error)

ListEventsWithResponse request returning *ListEventsResponse

func (*ClientWithResponses) ListForwarderDeliveriesWithResponse added in v3.0.15

func (c *ClientWithResponses) ListForwarderDeliveriesWithResponse(ctx context.Context, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams, reqEditors ...RequestEditorFn) (*ListForwarderDeliveriesResponse, error)

ListForwarderDeliveriesWithResponse request returning *ListForwarderDeliveriesResponse

func (*ClientWithResponses) ListForwardersWithResponse added in v3.0.15

func (c *ClientWithResponses) ListForwardersWithResponse(ctx context.Context, params *ListForwardersParams, reqEditors ...RequestEditorFn) (*ListForwardersResponse, error)

ListForwardersWithResponse request returning *ListForwardersResponse

func (*ClientWithResponses) ListUsageWithResponse

func (c *ClientWithResponses) ListUsageWithResponse(ctx context.Context, params *ListUsageParams, reqEditors ...RequestEditorFn) (*ListUsageResponse, error)

ListUsageWithResponse request returning *ListUsageResponse

func (*ClientWithResponses) RecordEventWithApplicationVndAPIPlusJSONBodyWithResponse added in v3.0.12

func (c *ClientWithResponses) RecordEventWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*RecordEventResponse, error)

func (*ClientWithResponses) RecordEventWithBodyWithResponse added in v3.0.12

func (c *ClientWithResponses) RecordEventWithBodyWithResponse(ctx context.Context, params *RecordEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecordEventResponse, error)

RecordEventWithBodyWithResponse request with arbitrary body returning *RecordEventResponse

func (*ClientWithResponses) RetryFailedForwarderDeliveriesWithResponse added in v3.0.15

func (c *ClientWithResponses) RetryFailedForwarderDeliveriesWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*RetryFailedForwarderDeliveriesResponse, error)

RetryFailedForwarderDeliveriesWithResponse request returning *RetryFailedForwarderDeliveriesResponse

func (*ClientWithResponses) RetryForwarderDeliveryWithResponse added in v3.0.15

func (c *ClientWithResponses) RetryForwarderDeliveryWithResponse(ctx context.Context, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID, reqEditors ...RequestEditorFn) (*RetryForwarderDeliveryResponse, error)

RetryForwarderDeliveryWithResponse request returning *RetryForwarderDeliveryResponse

func (*ClientWithResponses) UpdateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse added in v3.0.15

func (c *ClientWithResponses) UpdateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateForwarderResponse, error)

func (*ClientWithResponses) UpdateForwarderWithBodyWithResponse added in v3.0.15

func (c *ClientWithResponses) UpdateForwarderWithBodyWithResponse(ctx context.Context, forwarderId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateForwarderResponse, error)

UpdateForwarderWithBodyWithResponse request with arbitrary body returning *UpdateForwarderResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ListEventsWithResponse request
	ListEventsWithResponse(ctx context.Context, params *ListEventsParams, reqEditors ...RequestEditorFn) (*ListEventsResponse, error)

	// RecordEventWithBodyWithResponse request with any body
	RecordEventWithBodyWithResponse(ctx context.Context, params *RecordEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RecordEventResponse, error)

	RecordEventWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, params *RecordEventParams, body RecordEventApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*RecordEventResponse, error)

	// GetEventWithResponse request
	GetEventWithResponse(ctx context.Context, eventId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetEventResponse, error)

	// ListForwardersWithResponse request
	ListForwardersWithResponse(ctx context.Context, params *ListForwardersParams, reqEditors ...RequestEditorFn) (*ListForwardersResponse, error)

	// CreateForwarderWithBodyWithResponse request with any body
	CreateForwarderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateForwarderResponse, error)

	CreateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body CreateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateForwarderResponse, error)

	// DeleteForwarderWithResponse request
	DeleteForwarderWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteForwarderResponse, error)

	// GetForwarderWithResponse request
	GetForwarderWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetForwarderResponse, error)

	// UpdateForwarderWithBodyWithResponse request with any body
	UpdateForwarderWithBodyWithResponse(ctx context.Context, forwarderId openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateForwarderResponse, error)

	UpdateForwarderWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, forwarderId openapi_types.UUID, body UpdateForwarderApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateForwarderResponse, error)

	// RetryFailedForwarderDeliveriesWithResponse request
	RetryFailedForwarderDeliveriesWithResponse(ctx context.Context, forwarderId openapi_types.UUID, reqEditors ...RequestEditorFn) (*RetryFailedForwarderDeliveriesResponse, error)

	// ListForwarderDeliveriesWithResponse request
	ListForwarderDeliveriesWithResponse(ctx context.Context, forwarderId openapi_types.UUID, params *ListForwarderDeliveriesParams, reqEditors ...RequestEditorFn) (*ListForwarderDeliveriesResponse, error)

	// RetryForwarderDeliveryWithResponse request
	RetryForwarderDeliveryWithResponse(ctx context.Context, forwarderId openapi_types.UUID, deliveryId openapi_types.UUID, reqEditors ...RequestEditorFn) (*RetryForwarderDeliveryResponse, error)

	// ExecuteTestForwarderWithBodyWithResponse request with any body
	ExecuteTestForwarderWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteTestForwarderResponse, error)

	ExecuteTestForwarderWithResponse(ctx context.Context, body ExecuteTestForwarderJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteTestForwarderResponse, error)

	// ListUsageWithResponse request
	ListUsageWithResponse(ctx context.Context, params *ListUsageParams, reqEditors ...RequestEditorFn) (*ListUsageResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateForwarderApplicationVndAPIPlusJSONRequestBody added in v3.0.15

type CreateForwarderApplicationVndAPIPlusJSONRequestBody = ForwarderResponse

CreateForwarderApplicationVndAPIPlusJSONRequestBody defines body for CreateForwarder for application/vnd.api+json ContentType.

type CreateForwarderResponse added in v3.0.15

type CreateForwarderResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON201 *ForwarderResponse
}

func ParseCreateForwarderResponse added in v3.0.15

func ParseCreateForwarderResponse(rsp *http.Response) (*CreateForwarderResponse, error)

ParseCreateForwarderResponse parses an HTTP response from a CreateForwarderWithResponse call

func (CreateForwarderResponse) ContentType added in v3.0.15

func (r CreateForwarderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateForwarderResponse) Status added in v3.0.15

func (r CreateForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (CreateForwarderResponse) StatusCode added in v3.0.15

func (r CreateForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteForwarderResponse added in v3.0.15

type DeleteForwarderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteForwarderResponse added in v3.0.15

func ParseDeleteForwarderResponse(rsp *http.Response) (*DeleteForwarderResponse, error)

ParseDeleteForwarderResponse parses an HTTP response from a DeleteForwarderWithResponse call

func (DeleteForwarderResponse) ContentType added in v3.0.15

func (r DeleteForwarderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteForwarderResponse) Status added in v3.0.15

func (r DeleteForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteForwarderResponse) StatusCode added in v3.0.15

func (r DeleteForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Event

type Event struct {
	Action     string                  `json:"action"`
	ActorId    *openapi_types.UUID     `json:"actor_id,omitempty"`
	ActorLabel *string                 `json:"actor_label,omitempty"`
	ActorType  *string                 `json:"actor_type,omitempty"`
	CreatedAt  *time.Time              `json:"created_at,omitempty"`
	Data       *map[string]interface{} `json:"data,omitempty"`

	// DoNotForward When true, this event is recorded normally but is not forwarded to any configured SIEM forwarder. A forwarder_delivery row with status=skipped_do_not_forward is recorded for each enabled forwarder so the skip is visible in the delivery log.
	DoNotForward   *bool                   `json:"do_not_forward,omitempty"`
	IdempotencyKey *string                 `json:"idempotency_key,omitempty"`
	OccurredAt     *time.Time              `json:"occurred_at,omitempty"`
	ResourceId     string                  `json:"resource_id"`
	ResourceType   string                  `json:"resource_type"`
	Snapshot       *map[string]interface{} `json:"snapshot,omitempty"`
}

Event Public-facing event resource.

Attribute set on POST /api/v1/events:

  • action (required)
  • resource_type (required)
  • resource_id (required)
  • occurred_at (optional; defaults to “created_at“)
  • snapshot (optional)
  • data (optional; defaults to “{}“)

Attribute set on GET responses includes everything above plus the server-populated fields: “created_at“, “actor_type“, “actor_id“, “actor_label“, “idempotency_key“.

type EventListLinks struct {
	Next *string `json:"next,omitempty"`
}

EventListLinks defines model for EventListLinks.

type EventListMeta

type EventListMeta struct {
	PageSize int `json:"page_size"`
}

EventListMeta defines model for EventListMeta.

type EventListResponse

type EventListResponse struct {
	Data  []EventResource `json:"data"`
	Links *EventListLinks `json:"links,omitempty"`
	Meta  EventListMeta   `json:"meta"`
}

EventListResponse JSON:API collection response with cursor pagination metadata.

type EventResource

type EventResource struct {
	// Attributes Public-facing event resource.
	//
	// Attribute set on POST /api/v1/events:
	//     - action (required)
	//     - resource_type (required)
	//     - resource_id (required)
	//     - occurred_at (optional; defaults to “created_at“)
	//     - snapshot (optional)
	//     - data (optional; defaults to “{}“)
	//
	// Attribute set on GET responses includes everything above plus the
	// server-populated fields: “created_at“, “actor_type“, “actor_id“,
	// “actor_label“, “idempotency_key“.
	Attributes Event   `json:"attributes"`
	Id         string  `json:"id"`
	Type       *string `json:"type,omitempty"`
}

EventResource JSON:API resource envelope for an audit event.

type EventResponse

type EventResponse struct {
	// Data JSON:API resource envelope for an audit event.
	Data EventResource `json:"data"`
}

EventResponse JSON:API single-resource response.

type ExecuteTestForwarderJSONRequestBody added in v3.0.15

type ExecuteTestForwarderJSONRequestBody = TestForwarderRequest

ExecuteTestForwarderJSONRequestBody defines body for ExecuteTestForwarder for application/json ContentType.

type ExecuteTestForwarderResponse added in v3.0.15

type ExecuteTestForwarderResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TestForwarderResponse
}

func ParseExecuteTestForwarderResponse added in v3.0.15

func ParseExecuteTestForwarderResponse(rsp *http.Response) (*ExecuteTestForwarderResponse, error)

ParseExecuteTestForwarderResponse parses an HTTP response from a ExecuteTestForwarderWithResponse call

func (ExecuteTestForwarderResponse) ContentType added in v3.0.15

func (r ExecuteTestForwarderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExecuteTestForwarderResponse) Status added in v3.0.15

Status returns HTTPResponse.Status

func (ExecuteTestForwarderResponse) StatusCode added in v3.0.15

func (r ExecuteTestForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Forwarder added in v3.0.15

type Forwarder struct {
	CreatedAt     *time.Time              `json:"created_at,omitempty"`
	Data          *map[string]interface{} `json:"data,omitempty"`
	DeletedAt     *time.Time              `json:"deleted_at,omitempty"`
	Enabled       *bool                   `json:"enabled,omitempty"`
	Filter        *map[string]interface{} `json:"filter,omitempty"`
	ForwarderType string                  `json:"forwarder_type"`

	// Http The destination HTTP request shape stored encrypted on a forwarder.
	//
	// “success_status“ is a string: either a single status code (e.g.
	// “"200"“, “"204"“) or a class (e.g. “"2xx"“, “"3xx"“). The
	// string-only contract is intentional — a Pydantic “int | str“ union
	// confused several SDK code generators (Java in particular wrote the
	// default “"2xx"“ unquoted into a typed enum). String covers both
	// shapes universally with a single wire type.
	Http      ForwarderHttp `json:"http"`
	Name      string        `json:"name"`
	Slug      *string       `json:"slug,omitempty"`
	Transform *string       `json:"transform,omitempty"`
	UpdatedAt *time.Time    `json:"updated_at,omitempty"`
	Version   *int          `json:"version,omitempty"`
}

Forwarder Public-facing forwarder resource.

Attribute set on POST /api/v1/forwarders:

  • name (required)
  • forwarder_type (required)
  • http (required)
  • enabled (optional, defaults true)
  • filter (optional, JSON Logic)
  • transform (optional, JSONata)

The slug is server-derived from name on create; it is immutable on update because consumers (UI, observability) key off it.

type ForwarderDelivery added in v3.0.15

type ForwarderDelivery struct {
	AttemptNumber  int                     `json:"attempt_number"`
	CreatedAt      *time.Time              `json:"created_at,omitempty"`
	Error          *string                 `json:"error,omitempty"`
	EventId        openapi_types.UUID      `json:"event_id"`
	ForwarderId    openapi_types.UUID      `json:"forwarder_id"`
	LatencyMs      *int                    `json:"latency_ms,omitempty"`
	Request        *map[string]interface{} `json:"request,omitempty"`
	ResponseBody   *string                 `json:"response_body,omitempty"`
	ResponseStatus *int                    `json:"response_status,omitempty"`
	Status         ForwarderDeliveryStatus `json:"status"`
}

ForwarderDelivery Read-only delivery log row.

All fields are server-populated. Headers in “request“ always show redacted values, regardless of who configured them.

type ForwarderDeliveryListResponse added in v3.0.15

type ForwarderDeliveryListResponse struct {
	Data  []ForwarderDeliveryResource `json:"data"`
	Links *ForwarderListLinks         `json:"links,omitempty"`
	Meta  ForwarderListMeta           `json:"meta"`
}

ForwarderDeliveryListResponse defines model for ForwarderDeliveryListResponse.

type ForwarderDeliveryResource added in v3.0.15

type ForwarderDeliveryResource struct {
	// Attributes Read-only delivery log row.
	//
	// All fields are server-populated. Headers in “request“ always show
	// redacted values, regardless of who configured them.
	Attributes ForwarderDelivery `json:"attributes"`
	Id         string            `json:"id"`
	Type       *string           `json:"type,omitempty"`
}

ForwarderDeliveryResource defines model for ForwarderDeliveryResource.

type ForwarderDeliveryResponse added in v3.0.15

type ForwarderDeliveryResponse struct {
	Data ForwarderDeliveryResource `json:"data"`
}

ForwarderDeliveryResponse defines model for ForwarderDeliveryResponse.

type ForwarderDeliveryStatus added in v3.0.15

type ForwarderDeliveryStatus string

ForwarderDeliveryStatus defines model for ForwarderDelivery.Status.

const (
	Failed              ForwarderDeliveryStatus = "failed"
	FilteredOut         ForwarderDeliveryStatus = "filtered_out"
	SkippedDoNotForward ForwarderDeliveryStatus = "skipped_do_not_forward"
	Succeeded           ForwarderDeliveryStatus = "succeeded"
)

Defines values for ForwarderDeliveryStatus.

func (ForwarderDeliveryStatus) Valid added in v3.0.15

func (e ForwarderDeliveryStatus) Valid() bool

Valid indicates whether the value is a known member of the ForwarderDeliveryStatus enum.

type ForwarderHttp added in v3.0.15

type ForwarderHttp struct {
	Body          *string       `json:"body,omitempty"`
	Headers       *[]HttpHeader `json:"headers,omitempty"`
	Method        *string       `json:"method,omitempty"`
	SuccessStatus *string       `json:"success_status,omitempty"`
	Url           string        `json:"url"`
}

ForwarderHttp The destination HTTP request shape stored encrypted on a forwarder.

“success_status“ is a string: either a single status code (e.g. “"200"“, “"204"“) or a class (e.g. “"2xx"“, “"3xx"“). The string-only contract is intentional — a Pydantic “int | str“ union confused several SDK code generators (Java in particular wrote the default “"2xx"“ unquoted into a typed enum). String covers both shapes universally with a single wire type.

type ForwarderListLinks struct {
	Next *string `json:"next,omitempty"`
}

ForwarderListLinks defines model for ForwarderListLinks.

type ForwarderListMeta added in v3.0.15

type ForwarderListMeta struct {
	PageSize int `json:"page_size"`
}

ForwarderListMeta defines model for ForwarderListMeta.

type ForwarderListResponse added in v3.0.15

type ForwarderListResponse struct {
	Data  []ForwarderResource `json:"data"`
	Links *ForwarderListLinks `json:"links,omitempty"`
	Meta  ForwarderListMeta   `json:"meta"`
}

ForwarderListResponse defines model for ForwarderListResponse.

type ForwarderResource added in v3.0.15

type ForwarderResource struct {
	// Attributes Public-facing forwarder resource.
	//
	// Attribute set on POST /api/v1/forwarders:
	//     - name (required)
	//     - forwarder_type (required)
	//     - http (required)
	//     - enabled (optional, defaults true)
	//     - filter (optional, JSON Logic)
	//     - transform (optional, JSONata)
	//
	// The slug is server-derived from name on create; it is immutable on
	// update because consumers (UI, observability) key off it.
	Attributes Forwarder `json:"attributes"`
	Id         string    `json:"id"`
	Type       *string   `json:"type,omitempty"`
}

ForwarderResource defines model for ForwarderResource.

type ForwarderResponse added in v3.0.15

type ForwarderResponse struct {
	Data ForwarderResource `json:"data"`
}

ForwarderResponse defines model for ForwarderResponse.

type GetEventResponse

type GetEventResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventResponse
}

func ParseGetEventResponse

func ParseGetEventResponse(rsp *http.Response) (*GetEventResponse, error)

ParseGetEventResponse parses an HTTP response from a GetEventWithResponse call

func (GetEventResponse) ContentType

func (r GetEventResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetEventResponse) Status

func (r GetEventResponse) Status() string

Status returns HTTPResponse.Status

func (GetEventResponse) StatusCode

func (r GetEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetForwarderResponse added in v3.0.15

type GetForwarderResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderResponse
}

func ParseGetForwarderResponse added in v3.0.15

func ParseGetForwarderResponse(rsp *http.Response) (*GetForwarderResponse, error)

ParseGetForwarderResponse parses an HTTP response from a GetForwarderWithResponse call

func (GetForwarderResponse) ContentType added in v3.0.15

func (r GetForwarderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetForwarderResponse) Status added in v3.0.15

func (r GetForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (GetForwarderResponse) StatusCode added in v3.0.15

func (r GetForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpHeader added in v3.0.15

type HttpHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

HttpHeader A single header on a forwarder's HTTP destination.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListEventsParams

type ListEventsParams struct {
	FilterOccurredAt   *string             `form:"filter[occurred_at],omitempty" json:"filter[occurred_at],omitempty"`
	FilterActorType    *string             `form:"filter[actor_type],omitempty" json:"filter[actor_type],omitempty"`
	FilterActorId      *openapi_types.UUID `form:"filter[actor_id],omitempty" json:"filter[actor_id],omitempty"`
	FilterAction       *string             `form:"filter[action],omitempty" json:"filter[action],omitempty"`
	FilterResourceType *string             `form:"filter[resource_type],omitempty" json:"filter[resource_type],omitempty"`
	FilterResourceId   *string             `form:"filter[resource_id],omitempty" json:"filter[resource_id],omitempty"`
	PageSize           *int                `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter          *string             `form:"page[after],omitempty" json:"page[after],omitempty"`
}

ListEventsParams defines parameters for ListEvents.

type ListEventsResponse

type ListEventsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventListResponse
}

func ParseListEventsResponse

func ParseListEventsResponse(rsp *http.Response) (*ListEventsResponse, error)

ParseListEventsResponse parses an HTTP response from a ListEventsWithResponse call

func (ListEventsResponse) ContentType

func (r ListEventsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListEventsResponse) Status

func (r ListEventsResponse) Status() string

Status returns HTTPResponse.Status

func (ListEventsResponse) StatusCode

func (r ListEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListForwarderDeliveriesParams added in v3.0.15

type ListForwarderDeliveriesParams struct {
	FilterStatus    *string `form:"filter[status],omitempty" json:"filter[status],omitempty"`
	FilterCreatedAt *string `form:"filter[created_at],omitempty" json:"filter[created_at],omitempty"`
	PageSize        *int    `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter       *string `form:"page[after],omitempty" json:"page[after],omitempty"`
}

ListForwarderDeliveriesParams defines parameters for ListForwarderDeliveries.

type ListForwarderDeliveriesResponse added in v3.0.15

type ListForwarderDeliveriesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderDeliveryListResponse
}

func ParseListForwarderDeliveriesResponse added in v3.0.15

func ParseListForwarderDeliveriesResponse(rsp *http.Response) (*ListForwarderDeliveriesResponse, error)

ParseListForwarderDeliveriesResponse parses an HTTP response from a ListForwarderDeliveriesWithResponse call

func (ListForwarderDeliveriesResponse) ContentType added in v3.0.15

func (r ListForwarderDeliveriesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListForwarderDeliveriesResponse) Status added in v3.0.15

Status returns HTTPResponse.Status

func (ListForwarderDeliveriesResponse) StatusCode added in v3.0.15

func (r ListForwarderDeliveriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListForwardersParams added in v3.0.15

type ListForwardersParams struct {
	FilterForwarderType *string `form:"filter[forwarder_type],omitempty" json:"filter[forwarder_type],omitempty"`
	FilterEnabled       *bool   `form:"filter[enabled],omitempty" json:"filter[enabled],omitempty"`
	PageSize            *int    `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter           *string `form:"page[after],omitempty" json:"page[after],omitempty"`
}

ListForwardersParams defines parameters for ListForwarders.

type ListForwardersResponse added in v3.0.15

type ListForwardersResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderListResponse
}

func ParseListForwardersResponse added in v3.0.15

func ParseListForwardersResponse(rsp *http.Response) (*ListForwardersResponse, error)

ParseListForwardersResponse parses an HTTP response from a ListForwardersWithResponse call

func (ListForwardersResponse) ContentType added in v3.0.15

func (r ListForwardersResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListForwardersResponse) Status added in v3.0.15

func (r ListForwardersResponse) Status() string

Status returns HTTPResponse.Status

func (ListForwardersResponse) StatusCode added in v3.0.15

func (r ListForwardersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListUsageParams

type ListUsageParams struct {
	FilterPeriod string `form:"filter[period]" json:"filter[period]"`
}

ListUsageParams defines parameters for ListUsage.

type ListUsageResponse

type ListUsageResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *UsageResponse
}

func ParseListUsageResponse

func ParseListUsageResponse(rsp *http.Response) (*ListUsageResponse, error)

ParseListUsageResponse parses an HTTP response from a ListUsageWithResponse call

func (ListUsageResponse) ContentType

func (r ListUsageResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListUsageResponse) Status

func (r ListUsageResponse) Status() string

Status returns HTTPResponse.Status

func (ListUsageResponse) StatusCode

func (r ListUsageResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RecordEventApplicationVndAPIPlusJSONRequestBody added in v3.0.12

type RecordEventApplicationVndAPIPlusJSONRequestBody = EventResponse

RecordEventApplicationVndAPIPlusJSONRequestBody defines body for RecordEvent for application/vnd.api+json ContentType.

type RecordEventParams added in v3.0.12

type RecordEventParams struct {
	IdempotencyKey *string `json:"Idempotency-Key,omitempty"`
}

RecordEventParams defines parameters for RecordEvent.

type RecordEventResponse added in v3.0.12

type RecordEventResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *EventResponse
	ApplicationvndApiJSON201 *EventResponse
}

func ParseRecordEventResponse added in v3.0.12

func ParseRecordEventResponse(rsp *http.Response) (*RecordEventResponse, error)

ParseRecordEventResponse parses an HTTP response from a RecordEventWithResponse call

func (RecordEventResponse) ContentType added in v3.0.12

func (r RecordEventResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RecordEventResponse) Status added in v3.0.12

func (r RecordEventResponse) Status() string

Status returns HTTPResponse.Status

func (RecordEventResponse) StatusCode added in v3.0.12

func (r RecordEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RetryFailedDeliveriesSummary added in v3.0.15

type RetryFailedDeliveriesSummary struct {
	Attempted int `json:"attempted"`
	Failed    int `json:"failed"`
	Succeeded int `json:"succeeded"`
}

RetryFailedDeliveriesSummary defines model for RetryFailedDeliveriesSummary.

type RetryFailedForwarderDeliveriesResponse added in v3.0.15

type RetryFailedForwarderDeliveriesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *RetryFailedDeliveriesSummary
}

func ParseRetryFailedForwarderDeliveriesResponse added in v3.0.15

func ParseRetryFailedForwarderDeliveriesResponse(rsp *http.Response) (*RetryFailedForwarderDeliveriesResponse, error)

ParseRetryFailedForwarderDeliveriesResponse parses an HTTP response from a RetryFailedForwarderDeliveriesWithResponse call

func (RetryFailedForwarderDeliveriesResponse) ContentType added in v3.0.15

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RetryFailedForwarderDeliveriesResponse) Status added in v3.0.15

Status returns HTTPResponse.Status

func (RetryFailedForwarderDeliveriesResponse) StatusCode added in v3.0.15

StatusCode returns HTTPResponse.StatusCode

type RetryForwarderDeliveryResponse added in v3.0.15

type RetryForwarderDeliveryResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderDeliveryResponse
}

func ParseRetryForwarderDeliveryResponse added in v3.0.15

func ParseRetryForwarderDeliveryResponse(rsp *http.Response) (*RetryForwarderDeliveryResponse, error)

ParseRetryForwarderDeliveryResponse parses an HTTP response from a RetryForwarderDeliveryWithResponse call

func (RetryForwarderDeliveryResponse) ContentType added in v3.0.15

func (r RetryForwarderDeliveryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (RetryForwarderDeliveryResponse) Status added in v3.0.15

Status returns HTTPResponse.Status

func (RetryForwarderDeliveryResponse) StatusCode added in v3.0.15

func (r RetryForwarderDeliveryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TestForwarderRequest added in v3.0.15

type TestForwarderRequest struct {
	Body          *string       `json:"body,omitempty"`
	Headers       *[]HttpHeader `json:"headers,omitempty"`
	Method        *string       `json:"method,omitempty"`
	SuccessStatus *string       `json:"success_status,omitempty"`
	TimeoutMs     *int          `json:"timeout_ms,omitempty"`
	Url           string        `json:"url"`
}

TestForwarderRequest Plain-JSON body for the test_forwarder execute action.

Mirrors the encrypted “ForwarderHttp“ shape with one addition — “timeout_ms“, capped server-side.

type TestForwarderResponse added in v3.0.15

type TestForwarderResponse struct {
	Error           *string            `json:"error,omitempty"`
	LatencyMs       *int               `json:"latency_ms"`
	ResponseBody    *string            `json:"response_body,omitempty"`
	ResponseHeaders *map[string]string `json:"response_headers,omitempty"`
	ResponseStatus  *int               `json:"response_status"`
	Succeeded       bool               `json:"succeeded"`
}

TestForwarderResponse Plain-JSON response body. Headers are echoed back unredacted because the caller already supplied them — the response is for the caller, not persisted into the delivery log.

type UpdateForwarderApplicationVndAPIPlusJSONRequestBody added in v3.0.15

type UpdateForwarderApplicationVndAPIPlusJSONRequestBody = ForwarderResponse

UpdateForwarderApplicationVndAPIPlusJSONRequestBody defines body for UpdateForwarder for application/vnd.api+json ContentType.

type UpdateForwarderResponse added in v3.0.15

type UpdateForwarderResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ForwarderResponse
}

func ParseUpdateForwarderResponse added in v3.0.15

func ParseUpdateForwarderResponse(rsp *http.Response) (*UpdateForwarderResponse, error)

ParseUpdateForwarderResponse parses an HTTP response from a UpdateForwarderWithResponse call

func (UpdateForwarderResponse) ContentType added in v3.0.15

func (r UpdateForwarderResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateForwarderResponse) Status added in v3.0.15

func (r UpdateForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateForwarderResponse) StatusCode added in v3.0.15

func (r UpdateForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UsageResource

type UsageResource struct {
	Attributes map[string]interface{} `json:"attributes"`
	Id         string                 `json:"id"`
	Type       *string                `json:"type,omitempty"`
}

UsageResource defines model for UsageResource.

type UsageResponse

type UsageResponse struct {
	Data []UsageResource `json:"data"`
}

UsageResponse defines model for UsageResponse.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL