audit

package
v3.0.34 Latest Latest
Warning

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

 Go to latest Published: May 11, 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.14 

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.14 

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.14 

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

NewDeleteForwarderRequest generates requests for DeleteForwarder

func NewExecuteTestForwarderRequest added in v3.0.14 

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.14 

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

NewExecuteTestForwarderRequestWithBody generates requests for ExecuteTestForwarder with any type of body

func NewExecuteWipeRequest added in v3.0.24 

func NewExecuteWipeRequest(server string, body ExecuteWipeJSONRequestBody) (*http.Request, error)

NewExecuteWipeRequest calls the generic ExecuteWipe builder with application/json body

func NewExecuteWipeRequestWithBody added in v3.0.24 

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

NewExecuteWipeRequestWithBody generates requests for ExecuteWipe 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.14 

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

NewGetForwarderRequest generates requests for GetForwarder

func NewListActionsRequest added in v3.0.24 

func NewListActionsRequest(server string, params *ListActionsParams) (*http.Request, error)

NewListActionsRequest generates requests for ListActions

func NewListEventsRequest 

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

NewListEventsRequest generates requests for ListEvents

func NewListForwarderDeliveriesRequest added in v3.0.14 

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

NewListForwarderDeliveriesRequest generates requests for ListForwarderDeliveries

func NewListForwardersRequest added in v3.0.14 

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

NewListForwardersRequest generates requests for ListForwarders

func NewListResourceTypesRequest added in v3.0.24 

func NewListResourceTypesRequest(server string, params *ListResourceTypesParams) (*http.Request, error)

NewListResourceTypesRequest generates requests for ListResourceTypes

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.14 

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

NewRetryFailedForwarderDeliveriesRequest generates requests for RetryFailedForwarderDeliveries

func NewRetryForwarderDeliveryRequest added in v3.0.14 

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.14 

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.14 

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 ActionAttributes added in v3.0.24 

type ActionAttributes struct {
	// Action The action slug. Same as the JSON:API “id“.
	Action string `json:"action"`

	// CreatedAt First sighting of this action for the account. When the request includes “filter[resource_type]“, this is the first sighting of the (action, resource_type) triple rather than the action overall.
	CreatedAt time.Time `json:"created_at"`
}

ActionAttributes defines model for ActionAttributes. 

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

ActionListLinks defines model for ActionListLinks.

type ActionListMeta added in v3.0.24 

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

ActionListMeta defines model for ActionListMeta.

type ActionListResponse added in v3.0.24 

type ActionListResponse struct {
	Data  []ActionResource `json:"data"`
	Links *ActionListLinks `json:"links,omitempty"`
	Meta  ActionListMeta   `json:"meta"`
}

ActionListResponse defines model for ActionListResponse.

type ActionResource added in v3.0.24 

type ActionResource struct {
	Attributes ActionAttributes `json:"attributes"`

	// Id The action slug.
	Id   string  `json:"id"`
	Type *string `json:"type,omitempty"`
}

ActionResource defines model for ActionResource.

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.14 

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

func (*Client) CreateForwarderWithBody added in v3.0.14 

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

func (*Client) DeleteForwarder added in v3.0.14 

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

func (*Client) ExecuteTestForwarder added in v3.0.14 

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

func (*Client) ExecuteTestForwarderWithBody added in v3.0.14 

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

func (*Client) ExecuteWipe added in v3.0.24 

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

func (*Client) ExecuteWipeWithBody added in v3.0.24 

func (c *Client) ExecuteWipeWithBody(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.14 

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

func (*Client) ListActions added in v3.0.24 

func (c *Client) ListActions(ctx context.Context, params *ListActionsParams, 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.14 

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.14 

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

func (*Client) ListResourceTypes added in v3.0.24 

func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesParams, 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.14 

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

func (*Client) RetryForwarderDelivery added in v3.0.14 

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.14 

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.14 

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 {
	// ListActions request
	ListActions(ctx context.Context, params *ListActionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// 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)

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

	ExecuteWipe(ctx context.Context, body ExecuteWipeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListResourceTypes request
	ListResourceTypes(ctx context.Context, params *ListResourceTypesParams, 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.14 

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

func (*ClientWithResponses) CreateForwarderWithBodyWithResponse added in v3.0.14 

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.14 

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.14 

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.14 

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

func (*ClientWithResponses) ExecuteWipeWithBodyWithResponse added in v3.0.24 

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

ExecuteWipeWithBodyWithResponse request with arbitrary body returning *ExecuteWipeResponse

func (*ClientWithResponses) ExecuteWipeWithResponse added in v3.0.24 

func (c *ClientWithResponses) ExecuteWipeWithResponse(ctx context.Context, body ExecuteWipeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteWipeResponse, 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.14 

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

GetForwarderWithResponse request returning *GetForwarderResponse

func (*ClientWithResponses) ListActionsWithResponse added in v3.0.24 

func (c *ClientWithResponses) ListActionsWithResponse(ctx context.Context, params *ListActionsParams, reqEditors ...RequestEditorFn) (*ListActionsResponse, error)

ListActionsWithResponse request returning *ListActionsResponse

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.14 

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.14 

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

ListForwardersWithResponse request returning *ListForwardersResponse

func (*ClientWithResponses) ListResourceTypesWithResponse added in v3.0.24 

func (c *ClientWithResponses) ListResourceTypesWithResponse(ctx context.Context, params *ListResourceTypesParams, reqEditors ...RequestEditorFn) (*ListResourceTypesResponse, error)

ListResourceTypesWithResponse request returning *ListResourceTypesResponse

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.14 

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.14 

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.14 

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

func (*ClientWithResponses) UpdateForwarderWithBodyWithResponse added in v3.0.14 

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 {
	// ListActionsWithResponse request
	ListActionsWithResponse(ctx context.Context, params *ListActionsParams, reqEditors ...RequestEditorFn) (*ListActionsResponse, error)

	// 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)

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

	ExecuteWipeWithResponse(ctx context.Context, body ExecuteWipeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteWipeResponse, error)

	// ListResourceTypesWithResponse request
	ListResourceTypesWithResponse(ctx context.Context, params *ListResourceTypesParams, reqEditors ...RequestEditorFn) (*ListResourceTypesResponse, 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.14 

type CreateForwarderApplicationVndAPIPlusJSONRequestBody = ForwarderRequest

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

type CreateForwarderResponse added in v3.0.14 

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

func ParseCreateForwarderResponse added in v3.0.14 

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

ParseCreateForwarderResponse parses an HTTP response from a CreateForwarderWithResponse call

func (CreateForwarderResponse) ContentType added in v3.0.14 

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.14 

func (r CreateForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (CreateForwarderResponse) StatusCode added in v3.0.14 

func (r CreateForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteForwarderResponse added in v3.0.14 

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

func ParseDeleteForwarderResponse added in v3.0.14 

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

ParseDeleteForwarderResponse parses an HTTP response from a DeleteForwarderWithResponse call

func (DeleteForwarderResponse) ContentType added in v3.0.14 

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.14 

func (r DeleteForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteForwarderResponse) StatusCode added in v3.0.14 

func (r DeleteForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Event 

type Event struct {
	// Action Slug for what happened, e.g. `user.created`. Lowercase, dot-separated.
	Action string `json:"action"`

	// ActorId Identifier of the actor that emitted the event.
	ActorId *openapi_types.UUID `json:"actor_id,omitempty"`

	// ActorLabel Human-readable label for the actor (e.g. the user's email address or the API key name) at the time the event was recorded.
	ActorLabel *string `json:"actor_label,omitempty"`

	// ActorType Kind of credential that emitted the event, e.g. `USER` or `API_KEY`. Resolved server-side from the request credential.
	ActorType *string `json:"actor_type,omitempty"`

	// CreatedAt When the event was received and recorded.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Data Free-form payload attached to the event. Use it for resource snapshots (by convention under `data.snapshot`), request identifiers, or any other context the event needs to carry.
	Data *map[string]interface{} `json:"data,omitempty"`

	// DoNotForward When `true`, the event is recorded but not delivered to any forwarder. A delivery log entry with status `SKIPPED_DO_NOT_FORWARD` is written for each enabled forwarder so the skip is visible in the delivery log.
	DoNotForward *bool `json:"do_not_forward,omitempty"`

	// IdempotencyKey The idempotency key used to deduplicate the record. Echoes the `Idempotency-Key` header if one was supplied, otherwise a key derived from the event's content.
	IdempotencyKey *string `json:"idempotency_key,omitempty"`

	// OccurredAt When the event actually happened. Defaults to the server receipt time (`created_at`).
	OccurredAt *time.Time `json:"occurred_at,omitempty"`

	// ResourceId Identifier of the specific resource the event is about.
	ResourceId string `json:"resource_id"`

	// ResourceType Slug for the kind of resource the event is about, e.g. `user`. Lowercase, dot-separated.
	ResourceType string `json:"resource_type"`
}

Event An audit event — a record that something happened, attributed to an actor and a resource.

When recording a snapshot of the resource at the time of the event, place it inside `data`. smplkit's own integrations nest it under `data.snapshot`, but the slot is yours to use however you like. 

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 for audit events.

type EventRequest added in v3.0.34 

type EventRequest struct {
	// Data JSON:API resource envelope for an audit event.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data EventResource `json:"data"`
}

EventRequest JSON:API request envelope for recording an audit event.

type EventResource 

type EventResource struct {
	// Attributes An audit event — a record that something happened, attributed to
	// an actor and a resource.
	//
	// When recording a snapshot of the resource at the time of the event,
	// place it inside `data`. smplkit's own integrations nest it under
	// `data.snapshot`, but the slot is yours to use however you like.
	Attributes Event   `json:"attributes"`
	Id         *string `json:"id,omitempty"`
	Type       *string `json:"type,omitempty"`
}

EventResource JSON:API resource envelope for an audit event.

`id` must not be specified for create requests (the server assigns it).

type EventResponse 

type EventResponse struct {
	// Data JSON:API resource envelope for an audit event.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data EventResource `json:"data"`
}

EventResponse JSON:API single-resource response for an audit event.

type ExecuteTestForwarderJSONRequestBody added in v3.0.14 

type ExecuteTestForwarderJSONRequestBody = TestForwarderRequest

ExecuteTestForwarderJSONRequestBody defines body for ExecuteTestForwarder for application/json ContentType.

type ExecuteTestForwarderResponse added in v3.0.14 

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

func ParseExecuteTestForwarderResponse added in v3.0.14 

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

ParseExecuteTestForwarderResponse parses an HTTP response from a ExecuteTestForwarderWithResponse call

func (ExecuteTestForwarderResponse) ContentType added in v3.0.14 

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.14 

func (r ExecuteTestForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (ExecuteTestForwarderResponse) StatusCode added in v3.0.14 

func (r ExecuteTestForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExecuteWipeJSONRequestBody added in v3.0.24 

type ExecuteWipeJSONRequestBody = WipeRequest

ExecuteWipeJSONRequestBody defines body for ExecuteWipe for application/json ContentType.

type ExecuteWipeResponse added in v3.0.24 

type ExecuteWipeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WipeResponse
}

func ParseExecuteWipeResponse added in v3.0.24 

func ParseExecuteWipeResponse(rsp *http.Response) (*ExecuteWipeResponse, error)

ParseExecuteWipeResponse parses an HTTP response from a ExecuteWipeWithResponse call

func (ExecuteWipeResponse) ContentType added in v3.0.24 

func (r ExecuteWipeResponse) ContentType() string

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

func (ExecuteWipeResponse) Status added in v3.0.24 

func (r ExecuteWipeResponse) Status() string

Status returns HTTPResponse.Status

func (ExecuteWipeResponse) StatusCode added in v3.0.24 

func (r ExecuteWipeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Forwarder added in v3.0.14 

type Forwarder struct {
	// CreatedAt When the forwarder was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// DeletedAt When the forwarder was deleted. `null` for active forwarders.
	DeletedAt *time.Time `json:"deleted_at,omitempty"`

	// Enabled Whether the forwarder is currently delivering events. Set to `false` to pause deliveries without deleting the forwarder.
	Enabled *bool `json:"enabled,omitempty"`

	// Filter JSON Logic expression evaluated against each event. The event is delivered only if the expression returns truthy. Omit to deliver every event.
	Filter *map[string]interface{} `json:"filter,omitempty"`

	// ForwarderType Supported forwarder destination types.
	ForwarderType ForwarderType `json:"forwarder_type"`

	// Http HTTP request configuration used to deliver an event to the destination.
	Http ForwarderHttp `json:"http"`

	// Name Human-readable name for the forwarder.
	Name string `json:"name"`

	// Slug URL-safe identifier derived from `name` at create time. Stable for the lifetime of the forwarder.
	Slug *string `json:"slug,omitempty"`

	// Transform JSONata template applied to each event before delivery. Omit to deliver the event unchanged.
	Transform *string `json:"transform,omitempty"`

	// UpdatedAt When the forwarder was last modified.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// Version Monotonic counter incremented on every update, starting at 1.
	Version *int `json:"version,omitempty"`
}

Forwarder A destination that receives audit events recorded for the account.

Each event recorded for the account is evaluated against every enabled forwarder. If the filter expression evaluates truthy — or is absent — the event is delivered to the destination using the configured HTTP request. The slug, derived from `name` at create time, is the stable identifier used by the console and other tooling.

type ForwarderDelivery added in v3.0.14 

type ForwarderDelivery struct {
	// AttemptNumber 1 for the initial delivery, incremented for each retry.
	AttemptNumber int `json:"attempt_number"`

	// CreatedAt When the delivery attempt was recorded.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Error Error message if the delivery did not complete.
	Error *string `json:"error,omitempty"`

	// EventId Event that was being delivered.
	EventId openapi_types.UUID `json:"event_id"`

	// ForwarderId Forwarder the delivery belongs to.
	ForwarderId openapi_types.UUID `json:"forwarder_id"`

	// LatencyMs Elapsed time of the delivery attempt in milliseconds.
	LatencyMs *int `json:"latency_ms,omitempty"`

	// Request The HTTP request as it was sent to the destination. Header values are redacted.
	Request *map[string]interface{} `json:"request,omitempty"`

	// ResponseBody Response body returned by the destination.
	ResponseBody *string `json:"response_body,omitempty"`

	// ResponseStatus HTTP status code returned by the destination.
	ResponseStatus *int `json:"response_status,omitempty"`

	// Status Delivery outcome. `SUCCEEDED` and `FAILED` are the live-delivery outcomes; `FILTERED_OUT` is recorded when the forwarder's filter rejected the event; `SKIPPED_DO_NOT_FORWARD` is recorded when the event was emitted with `do_not_forward=true`.
	Status ForwarderDeliveryStatus `json:"status"`
}

ForwarderDelivery A log entry for one attempt to deliver an event to a forwarder.

type ForwarderDeliveryListResponse added in v3.0.14 

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

ForwarderDeliveryListResponse JSON:API collection response for forwarder deliveries.

type ForwarderDeliveryResource added in v3.0.14 

type ForwarderDeliveryResource struct {
	// Attributes A log entry for one attempt to deliver an event to a forwarder.
	Attributes ForwarderDelivery `json:"attributes"`
	Id         string            `json:"id"`
	Type       *string           `json:"type,omitempty"`
}

ForwarderDeliveryResource JSON:API resource envelope for a forwarder delivery log entry.

type ForwarderDeliveryResponse added in v3.0.14 

type ForwarderDeliveryResponse struct {
	// Data JSON:API resource envelope for a forwarder delivery log entry.
	Data ForwarderDeliveryResource `json:"data"`
}

ForwarderDeliveryResponse JSON:API single-resource response for a forwarder delivery.

type ForwarderDeliveryStatus added in v3.0.14 

type ForwarderDeliveryStatus string

ForwarderDeliveryStatus Delivery outcome. `SUCCEEDED` and `FAILED` are the live-delivery outcomes; `FILTERED_OUT` is recorded when the forwarder's filter rejected the event; `SKIPPED_DO_NOT_FORWARD` is recorded when the event was emitted with `do_not_forward=true`. 

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.14 

func (e ForwarderDeliveryStatus) Valid() bool

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

type ForwarderHttp added in v3.0.14 

type ForwarderHttp struct {
	// Body Request body sent to the destination. If omitted, the event JSON is sent as the body.
	Body *string `json:"body,omitempty"`

	// Headers HTTP headers attached to each delivery request.
	Headers *[]HttpHeader `json:"headers,omitempty"`

	// Method HTTP method used when delivering an event.
	Method *ForwarderHttpMethod `json:"method,omitempty"`

	// SuccessStatus HTTP response status that indicates a successful delivery. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
	SuccessStatus *string `json:"success_status,omitempty"`

	// Url Destination URL.
	Url string `json:"url"`
}

ForwarderHttp HTTP request configuration used to deliver an event to the destination.

type ForwarderHttpMethod added in v3.0.34 

type ForwarderHttpMethod string

ForwarderHttpMethod HTTP method used when delivering an event. 

const (
	ForwarderHttpMethodDELETE ForwarderHttpMethod = "DELETE"
	ForwarderHttpMethodGET    ForwarderHttpMethod = "GET"
	ForwarderHttpMethodPATCH  ForwarderHttpMethod = "PATCH"
	ForwarderHttpMethodPOST   ForwarderHttpMethod = "POST"
	ForwarderHttpMethodPUT    ForwarderHttpMethod = "PUT"
)

Defines values for ForwarderHttpMethod.

func (ForwarderHttpMethod) Valid added in v3.0.34 

func (e ForwarderHttpMethod) Valid() bool

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

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

ForwarderListLinks defines model for ForwarderListLinks.

type ForwarderListMeta added in v3.0.14 

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

ForwarderListMeta defines model for ForwarderListMeta.

type ForwarderListResponse added in v3.0.14 

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

ForwarderListResponse JSON:API collection response for forwarders.

type ForwarderRequest added in v3.0.34 

type ForwarderRequest struct {
	// Data JSON:API resource envelope for a forwarder.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data ForwarderResource `json:"data"`
}

ForwarderRequest JSON:API request envelope for creating or updating a forwarder.

type ForwarderResource added in v3.0.14 

type ForwarderResource struct {
	// Attributes A destination that receives audit events recorded for the account.
	//
	// Each event recorded for the account is evaluated against every enabled
	// forwarder. If the filter expression evaluates truthy — or is absent —
	// the event is delivered to the destination using the configured HTTP
	// request. The slug, derived from `name` at create time, is the stable
	// identifier used by the console and other tooling.
	Attributes Forwarder `json:"attributes"`
	Id         *string   `json:"id,omitempty"`
	Type       *string   `json:"type,omitempty"`
}

ForwarderResource JSON:API resource envelope for a forwarder.

`id` must not be specified for create requests (the server assigns it).

type ForwarderResponse added in v3.0.14 

type ForwarderResponse struct {
	// Data JSON:API resource envelope for a forwarder.
	//
	// `id` must not be specified for create requests (the server assigns it).
	Data ForwarderResource `json:"data"`
}

ForwarderResponse JSON:API single-resource response envelope for a forwarder.

type ForwarderType added in v3.0.25 

type ForwarderType string

ForwarderType Supported forwarder destination types. 

const (
	DATADOG   ForwarderType = "DATADOG"
	ELASTIC   ForwarderType = "ELASTIC"
	HONEYCOMB ForwarderType = "HONEYCOMB"
	HTTP      ForwarderType = "HTTP"
	NEWRELIC  ForwarderType = "NEW_RELIC"
	SPLUNKHEC ForwarderType = "SPLUNK_HEC"
	SUMOLOGIC ForwarderType = "SUMO_LOGIC"
)

Defines values for ForwarderType.

func (ForwarderType) Valid added in v3.0.25 

func (e ForwarderType) Valid() bool

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

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.14 

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

func ParseGetForwarderResponse added in v3.0.14 

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

ParseGetForwarderResponse parses an HTTP response from a GetForwarderWithResponse call

func (GetForwarderResponse) ContentType added in v3.0.14 

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.14 

func (r GetForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (GetForwarderResponse) StatusCode added in v3.0.14 

func (r GetForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpHeader added in v3.0.14 

type HttpHeader struct {
	// Name Header name.
	Name string `json:"name"`

	// Value Header value.
	Value string `json:"value"`
}

HttpHeader A single HTTP header attached to a forwarder delivery request.

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ListActionsParams added in v3.0.24 

type ListActionsParams struct {
	FilterResourceType *string `form:"filter[resource_type],omitempty" json:"filter[resource_type],omitempty"`
	PageSize           *int    `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter          *string `form:"page[after],omitempty" json:"page[after],omitempty"`
}

ListActionsParams defines parameters for ListActions.

type ListActionsResponse added in v3.0.24 

type ListActionsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ActionListResponse
}

func ParseListActionsResponse added in v3.0.24 

func ParseListActionsResponse(rsp *http.Response) (*ListActionsResponse, error)

ParseListActionsResponse parses an HTTP response from a ListActionsWithResponse call

func (ListActionsResponse) ContentType added in v3.0.24 

func (r ListActionsResponse) ContentType() string

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

func (ListActionsResponse) Status added in v3.0.24 

func (r ListActionsResponse) Status() string

Status returns HTTPResponse.Status

func (ListActionsResponse) StatusCode added in v3.0.24 

func (r ListActionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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"`

	// FilterSearch Case-insensitive substring match against `resource_id`. Use `filter[resource_id]` for an exact match.
	FilterSearch *string `form:"filter[search],omitempty" json:"filter[search],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.14 

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"`
	FilterEventId   *string `form:"filter[event_id],omitempty" json:"filter[event_id],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.14 

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

func ParseListForwarderDeliveriesResponse added in v3.0.14 

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

ParseListForwarderDeliveriesResponse parses an HTTP response from a ListForwarderDeliveriesWithResponse call

func (ListForwarderDeliveriesResponse) ContentType added in v3.0.14 

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.14 

func (r ListForwarderDeliveriesResponse) Status() string

Status returns HTTPResponse.Status

func (ListForwarderDeliveriesResponse) StatusCode added in v3.0.14 

func (r ListForwarderDeliveriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListForwardersParams added in v3.0.14 

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.14 

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

func ParseListForwardersResponse added in v3.0.14 

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

ParseListForwardersResponse parses an HTTP response from a ListForwardersWithResponse call

func (ListForwardersResponse) ContentType added in v3.0.14 

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.14 

func (r ListForwardersResponse) Status() string

Status returns HTTPResponse.Status

func (ListForwardersResponse) StatusCode added in v3.0.14 

func (r ListForwardersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListResourceTypesParams added in v3.0.24 

type ListResourceTypesParams struct {
	PageSize  *int    `form:"page[size],omitempty" json:"page[size],omitempty"`
	PageAfter *string `form:"page[after],omitempty" json:"page[after],omitempty"`
}

ListResourceTypesParams defines parameters for ListResourceTypes.

type ListResourceTypesResponse added in v3.0.24 

type ListResourceTypesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ResourceTypeListResponse
}

func ParseListResourceTypesResponse added in v3.0.24 

func ParseListResourceTypesResponse(rsp *http.Response) (*ListResourceTypesResponse, error)

ParseListResourceTypesResponse parses an HTTP response from a ListResourceTypesWithResponse call

func (ListResourceTypesResponse) ContentType added in v3.0.24 

func (r ListResourceTypesResponse) ContentType() string

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

func (ListResourceTypesResponse) Status added in v3.0.24 

func (r ListResourceTypesResponse) Status() string

Status returns HTTPResponse.Status

func (ListResourceTypesResponse) StatusCode added in v3.0.24 

func (r ListResourceTypesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListUsageParams 

type ListUsageParams struct {
	// FilterPeriod Period to report. `current` is the only supported value.
	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 = EventRequest

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 ResourceTypeAttributes added in v3.0.24 

type ResourceTypeAttributes struct {
	// CreatedAt First sighting of this resource_type for the account.
	CreatedAt time.Time `json:"created_at"`

	// ResourceType The resource_type slug. Same as the JSON:API “id“.
	ResourceType string `json:"resource_type"`
}

ResourceTypeAttributes defines model for ResourceTypeAttributes. 

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

ResourceTypeListLinks defines model for ResourceTypeListLinks.

type ResourceTypeListMeta added in v3.0.24 

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

ResourceTypeListMeta defines model for ResourceTypeListMeta.

type ResourceTypeListResponse added in v3.0.24 

type ResourceTypeListResponse struct {
	Data  []ResourceTypeResource `json:"data"`
	Links *ResourceTypeListLinks `json:"links,omitempty"`
	Meta  ResourceTypeListMeta   `json:"meta"`
}

ResourceTypeListResponse defines model for ResourceTypeListResponse.

type ResourceTypeResource added in v3.0.24 

type ResourceTypeResource struct {
	Attributes ResourceTypeAttributes `json:"attributes"`

	// Id The resource_type slug.
	Id   string  `json:"id"`
	Type *string `json:"type,omitempty"`
}

ResourceTypeResource defines model for ResourceTypeResource.

type RetryFailedDeliveriesSummary added in v3.0.14 

type RetryFailedDeliveriesSummary struct {
	// Attempted Number of failed deliveries that were re-attempted.
	Attempted int `json:"attempted"`

	// Failed Number of re-attempts that failed again.
	Failed int `json:"failed"`

	// Succeeded Number of re-attempts that succeeded.
	Succeeded int `json:"succeeded"`
}

RetryFailedDeliveriesSummary Counts returned by the retry-failed-deliveries action.

type RetryFailedForwarderDeliveriesResponse added in v3.0.14 

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

func ParseRetryFailedForwarderDeliveriesResponse added in v3.0.14 

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

ParseRetryFailedForwarderDeliveriesResponse parses an HTTP response from a RetryFailedForwarderDeliveriesWithResponse call

func (RetryFailedForwarderDeliveriesResponse) ContentType added in v3.0.14 

func (r RetryFailedForwarderDeliveriesResponse) ContentType() string

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

func (RetryFailedForwarderDeliveriesResponse) Status added in v3.0.14 

func (r RetryFailedForwarderDeliveriesResponse) Status() string

Status returns HTTPResponse.Status

func (RetryFailedForwarderDeliveriesResponse) StatusCode added in v3.0.14 

func (r RetryFailedForwarderDeliveriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RetryForwarderDeliveryResponse added in v3.0.14 

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

func ParseRetryForwarderDeliveryResponse added in v3.0.14 

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

ParseRetryForwarderDeliveryResponse parses an HTTP response from a RetryForwarderDeliveryWithResponse call

func (RetryForwarderDeliveryResponse) ContentType added in v3.0.14 

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.14 

func (r RetryForwarderDeliveryResponse) Status() string

Status returns HTTPResponse.Status

func (RetryForwarderDeliveryResponse) StatusCode added in v3.0.14 

func (r RetryForwarderDeliveryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type TestForwarderRequest added in v3.0.14 

type TestForwarderRequest struct {
	// Body Request body. If omitted, an empty body is sent.
	Body *string `json:"body,omitempty"`

	// Headers HTTP headers attached to the test request.
	Headers *[]HttpHeader `json:"headers,omitempty"`

	// Method HTTP method used for the test request.
	Method *TestForwarderRequestMethod `json:"method,omitempty"`

	// SuccessStatus HTTP response status that indicates success. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
	SuccessStatus *string `json:"success_status,omitempty"`

	// TimeoutMs Per-request timeout in milliseconds. Capped at 30 seconds.
	TimeoutMs *int `json:"timeout_ms,omitempty"`

	// Url Destination URL.
	Url string `json:"url"`
}

TestForwarderRequest Inputs to the test-forwarder action.

Mirrors a forwarder's HTTP destination configuration with one addition: `timeout_ms`, applied per-request and capped server-side.

type TestForwarderRequestMethod added in v3.0.34 

type TestForwarderRequestMethod string

TestForwarderRequestMethod HTTP method used for the test request. 

const (
	TestForwarderRequestMethodDELETE TestForwarderRequestMethod = "DELETE"
	TestForwarderRequestMethodGET    TestForwarderRequestMethod = "GET"
	TestForwarderRequestMethodPATCH  TestForwarderRequestMethod = "PATCH"
	TestForwarderRequestMethodPOST   TestForwarderRequestMethod = "POST"
	TestForwarderRequestMethodPUT    TestForwarderRequestMethod = "PUT"
)

Defines values for TestForwarderRequestMethod.

func (TestForwarderRequestMethod) Valid added in v3.0.34 

func (e TestForwarderRequestMethod) Valid() bool

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

type TestForwarderResponse added in v3.0.14 

type TestForwarderResponse struct {
	// Error Error message if the request did not complete.
	Error *string `json:"error,omitempty"`

	// LatencyMs Elapsed time of the request in milliseconds.
	LatencyMs *int `json:"latency_ms"`

	// ResponseBody Response body returned by the destination.
	ResponseBody *string `json:"response_body,omitempty"`

	// ResponseHeaders Headers returned by the destination.
	ResponseHeaders *map[string]string `json:"response_headers,omitempty"`

	// ResponseStatus HTTP status code returned by the destination.
	ResponseStatus *int `json:"response_status"`

	// Succeeded True if the destination responded with a status matching `success_status`.
	Succeeded bool `json:"succeeded"`
}

TestForwarderResponse Result of a test-forwarder execution.

type UpdateForwarderApplicationVndAPIPlusJSONRequestBody added in v3.0.14 

type UpdateForwarderApplicationVndAPIPlusJSONRequestBody = ForwarderRequest

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

type UpdateForwarderResponse added in v3.0.14 

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

func ParseUpdateForwarderResponse added in v3.0.14 

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

ParseUpdateForwarderResponse parses an HTTP response from a UpdateForwarderWithResponse call

func (UpdateForwarderResponse) ContentType added in v3.0.14 

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.14 

func (r UpdateForwarderResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateForwarderResponse) StatusCode added in v3.0.14 

func (r UpdateForwarderResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UsageAttributes added in v3.0.23 

type UsageAttributes struct {
	// LimitKey Identifier of the metered limit, e.g. `audit.customer_events_per_month`.
	LimitKey string `json:"limit_key"`

	// Period Period the counter covers. `current` is the only supported value.
	Period string `json:"period"`

	// Value Count for the period.
	Value int `json:"value"`
}

UsageAttributes Usage counter for a single metered limit.

type UsageResource 

type UsageResource struct {
	// Attributes Usage counter for a single metered limit.
	Attributes UsageAttributes `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.

type WipeRequest added in v3.0.24 

type WipeRequest = map[string]interface{}

WipeRequest Empty body — the action takes no parameters.

type WipeResponse added in v3.0.24 

type WipeResponse struct {
	// CompletedAt When the wipe completed.
	CompletedAt time.Time `json:"completed_at"`

	// Tables Counts of records deleted, broken down by record kind.
	Tables WipeTablesSummary `json:"tables"`

	// Wiped Always `true` for a successful wipe.
	Wiped *bool `json:"wiped,omitempty"`
}

WipeResponse Summary of a completed wipe action.

type WipeTablesSummary added in v3.0.24 

type WipeTablesSummary struct {
	// Action Number of distinct `action` entries deleted.
	Action int `json:"action"`

	// AuditEvent Number of audit events deleted.
	AuditEvent int `json:"audit_event"`

	// AuditEventQuota Number of monthly usage-quota counters deleted.
	AuditEventQuota int `json:"audit_event_quota"`

	// Forwarder Number of forwarders deleted.
	Forwarder int `json:"forwarder"`

	// ForwarderDelivery Number of forwarder delivery log entries deleted.
	ForwarderDelivery int `json:"forwarder_delivery"`

	// ResourceType Number of distinct `resource_type` entries deleted.
	ResourceType int `json:"resource_type"`
}

WipeTablesSummary Counts of records deleted, broken down by record kind.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.