requests

package
v1.4.2 Latest Latest
Warning

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

Go to latest
Published: Mar 11, 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 added in v1.2.0

type AuthenticatedRequest struct {
	StandardRequest
	APIKey    string
	APISecret string
}

type Body

type Body interface {
	Validate() error
}

type KeysetBasedList added in v1.1.1

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

func (*KeysetBasedList) ParseDatesToUnix added in v1.1.1

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

func (*KeysetBasedList) Validate added in v1.1.1

func (r *KeysetBasedList) Validate() error

type OffsetBasedList added in v1.1.1

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

func (*OffsetBasedList) ParseDatesToUnix added in v1.1.1

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

func (*OffsetBasedList) Validate added in v1.1.1

func (r *OffsetBasedList) Validate() error

type Option added in v1.1.2

type Option func(*StandardRequest)

Option is a function that modifies the Request.

func WithTimeout added in v1.1.2

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 added in v1.2.0

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 added in v1.2.2

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

func (*StandardRequest) GetBody added in v1.2.0

func (r *StandardRequest) GetBody() Body

func (*StandardRequest) GetClient added in v1.2.0

func (r *StandardRequest) GetClient() string

func (*StandardRequest) GetContext added in v1.2.0

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

func (*StandardRequest) GetCreatedAt added in v1.3.4

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

func (*StandardRequest) GetHeader added in v1.3.4

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

func (*StandardRequest) GetID added in v1.2.0

func (r *StandardRequest) GetID() string

func (*StandardRequest) GetIP added in v1.2.0

func (r *StandardRequest) GetIP() string

func (*StandardRequest) SetBody added in v1.2.0

func (r *StandardRequest) SetBody(body Body)

func (*StandardRequest) SetContext added in v1.2.0

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