requestconfig

type Attempt ¶

type Attempt func(ctx context.Context, idempotencyKey string) (*http.Response, error)

Attempt performs one network round-trip with the per-attempt context and the idempotency key to set as a header.

type Config ¶

type Config struct {
	BaseURL        string
	APIKey         string
	Region         string
	APIVersion     string
	HTTPClient     *http.Client
	MaxRetries     int
	Timeout        time.Duration
	IdempotencyKey string
	WebhookSecret  string
	Header         http.Header
	ResponseInto   *Response
	EmailDefaults  EmailDefaults
	// Sealed is set on the per-call config so construction-only options
	// (WithBaseURL/WithAPIKey/WithHTTPClient) can reject being applied per call.
	Sealed bool
}

Config is the settings for a single API call. Client options seed it at construction; per-call options Clone it and override individual fields.

BaseURL, APIKey, Region, and HTTPClient take effect at client construction only — the underlying HTTP client is built once. The remaining fields are honored per call.

func (c Config) Clone() Config

func (cfg Config) Execute(ctx context.Context, mutation bool, call Attempt) ([]byte, error)

type EmailDefaults ¶

type EmailDefaults struct {
	From        string
	ReplyTo     []string
	Category    oapi.EmailMessageCategory
	TrackOpens  *bool
	TrackClicks *bool
	Headers     map[string]string
	Tags        []oapi.Tag
	Metadata    map[string]interface{}
}

EmailDefaults are values applied to an email send when the per-send params leave the corresponding field unset. Re-exported as bird.EmailDefaults.

type Response ¶

type Response struct {
	Status    int
	Header    http.Header
	RequestID string
}

Response is the transport metadata for one call, populated when the caller passes option.WithResponseInto. Re-exported as bird.Response.