embargo

Documentation

Index

• type CheckResult
• type Client
  • func New(cfg *pangea.Config) Client
• type IPCheckRequest
• type ISOCheckRequest
• type Sanction

Types

type CheckResult

type CheckResult struct {
	Count     int        `json:"count"`
	Sanctions []Sanction `json:"sanctions"`
}

type Client

type Client interface {
	IPCheck(ctx context.Context, input *IPCheckRequest) (*pangea.PangeaResponse[CheckResult], error)
	ISOCheck(ctx context.Context, input *ISOCheckRequest) (*pangea.PangeaResponse[CheckResult], error)
	// Base service methods
	GetPendingRequestID() []string
	PollResultByError(ctx context.Context, e pangea.AcceptedError) (*pangea.PangeaResponse[any], error)
	PollResultByID(ctx context.Context, rid string, v any) (*pangea.PangeaResponse[any], error)
	PollResultRaw(ctx context.Context, requestID string) (*pangea.PangeaResponse[map[string]any], error)
}

func New

func New(cfg *pangea.Config) Client

type IPCheckRequest

type IPCheckRequest struct {
	pangea.BaseRequest

	// Check this IP against the enabled embargo lists.
	// Accepts both IPV4 and IPV6 strings.
	IP string `json:"ip,omitempty"`
}

type ISOCheckRequest

type ISOCheckRequest struct {
	pangea.BaseRequest

	// Check this two character country ISO-code against the enabled embargo lists.
	ISOCode string `json:"iso_code,omitempty"`
}

type Sanction

type Sanction struct {
	EmbargoedCountryISOCode string                 `json:"embargoed_country_iso_code"`
	IssuingCountry          string                 `json:"issuing_country"`
	ListName                string                 `json:"list_name"`
	EmbargoedCountryName    string                 `json:"embargoed_country_name"`
	Annotations             map[string]interface{} `json:"annotations"`
}