requests

package
v1.7.0 Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2025 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	MAX_PAGE_SIZE = 1000
	DEFAULT_LIMIT = 50
)
View Source
const DEFAULT_TIMEOUT = 15 * time.Second

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticatedRequest

type AuthenticatedRequest struct {
	StandardRequest
	APIKey    string
	APISecret string
}

type Body

type Body interface {
	Validate() error
}

type KeysetBasedList

type KeysetBasedList struct {
	Limit       int                     `json:"limit"`
	Cursor      string                  `json:"cursor"`
	DateFilters []relational.DateFilter `json:"date_filters"`
}

func (*KeysetBasedList) ParseDatesToUnix

func (r *KeysetBasedList) ParseDatesToUnix(validDBColumns []string) error

func (*KeysetBasedList) Validate

func (r *KeysetBasedList) Validate() error

type OffsetBasedList

type OffsetBasedList struct {
	Limit       int                     `json:"limit"`
	Offset      int                     `json:"offset"`
	DateFilters []relational.DateFilter `json:"date_filters"`
}

func (*OffsetBasedList) ParseDatesToUnix

func (r *OffsetBasedList) ParseDatesToUnix(validDBColumns []string) error

func (*OffsetBasedList) Validate

func (r *OffsetBasedList) Validate() error

type Option

type Option func(*StandardRequest)

Option is a function that modifies the Request.

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout returns an Option that sets the timeout for the request context.

type Request

type Request interface {
	GetID() string
	GetIP() string
	GetClient() string
	GetHeader() http.Header
	GetBody() Body
	SetBody(Body)
	GetCreatedAt() time.Time
	GetContext() context.Context
	SetContext(context.Context)
}

type StandardRequest

type StandardRequest struct {
	ID        string
	IP        string
	Client    string
	Header    http.Header
	Body      Body
	CreatedAt time.Time
	Context   context.Context
	Cancel    context.CancelFunc
}

func New

func New(header http.Header, ip string, opts ...Option) *StandardRequest

func (StandardRequest) Authenticate

func (r StandardRequest) Authenticate() (*AuthenticatedRequest, error)

func (*StandardRequest) GetBody

func (r *StandardRequest) GetBody() Body

func (*StandardRequest) GetClient

func (r *StandardRequest) GetClient() string

func (*StandardRequest) GetContext

func (r *StandardRequest) GetContext() context.Context

func (*StandardRequest) GetCreatedAt

func (r *StandardRequest) GetCreatedAt() time.Time

func (*StandardRequest) GetHeader

func (r *StandardRequest) GetHeader() http.Header

func (*StandardRequest) GetID

func (r *StandardRequest) GetID() string

func (*StandardRequest) GetIP

func (r *StandardRequest) GetIP() string

func (*StandardRequest) SetBody

func (r *StandardRequest) SetBody(body Body)

func (*StandardRequest) SetContext

func (r *StandardRequest) SetContext(ctx context.Context)

Jump to

Keyboard shortcuts

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