Versions in this module Expand all Collapse all v1 v1.0.0 Aug 13, 2026 Changes in this version + const APIVersion + const DefaultBaseURL + const DefaultTimeout + const DefaultUserAgent + const SDKName + const SDKVersion + func IsForbidden(err error) bool + func IsNotFound(err error) bool + func IsUnauthorized(err error) bool + func IsValidation(err error) bool + func Ptr[T any](value T) *T + type APIError struct + Payload any + RawBody []byte + StatusCode int + func (e *APIError) Error() string + type Attributes map[string]any + type Client struct + Contacts *ContactsService + Domains *DomainsService + Emails *EmailsService + Fields *FieldsService + Suppressions *SuppressionsService + func New(apiKey string, options ...Option) (*Client, error) + func (c *Client) Delete(ctx context.Context, path []string, query map[string]any, result any) error + func (c *Client) Do(ctx context.Context, request Request, result any) error + func (c *Client) Get(ctx context.Context, path []string, query map[string]any, result any) error + func (c *Client) Post(ctx context.Context, path []string, body any, query map[string]any, result any) error + type Contact struct + Attributes Attributes + CreatedAt time.Time + Provider *string + Subscribed bool + UUID string + UpdatedAt time.Time + type ContactEvent struct + Attributes *ContactEventAttributes + CreatedAt time.Time + EventName string + UUID string + type ContactEventAttributes map[string]any + type ContactEventListParams struct + Page int + PerPage int + Search string + type ContactEventsService struct + func (service *ContactEventsService) Create(ctx context.Context, params CreateContactEventParams) error + func (service *ContactEventsService) List(ctx context.Context, params *ContactEventListParams) (*Page[ContactEvent], error) + func (service *ContactEventsService) NewPager(params *ContactEventListParams) *Pager[ContactEvent] + type ContactListParams struct + Page int + PerPage int + type ContactsService struct + func (service *ContactsService) Create(ctx context.Context, params CreateContactParams) (*Contact, error) + func (service *ContactsService) Events(identifier string) *ContactEventsService + func (service *ContactsService) Get(ctx context.Context, identifier string) (*Contact, error) + func (service *ContactsService) List(ctx context.Context, params *ContactListParams) (*Page[Contact], error) + func (service *ContactsService) NewPager(params *ContactListParams) *Pager[Contact] + func (service *ContactsService) Subscribe(ctx context.Context, identifier string) (*Contact, error) + func (service *ContactsService) Unsubscribe(ctx context.Context, identifier string) (*Contact, error) + func (service *ContactsService) Update(ctx context.Context, identifier string, params UpdateContactParams) (*Contact, error) + type CreateContactEventParams struct + Attributes ContactEventAttributes + EventName string + type CreateContactParams struct + Attributes Attributes + Subscribed *bool + type CreateDomainAddressParams struct + Address string + CompanyAddress string + CompanyAddress2 Optional[string] + CompanyCity string + CompanyCountry string + CompanyState string + CompanyZIP string + DisplayName string + ReplyTo string + type CreateDomainParams struct + DKIMSelectors Optional[[]string] + Name string + TrackingMode Optional[DomainTrackingMode] + TrackingSubdomain Optional[string] + type CreateFieldParams struct + Format Optional[FieldFormat] + Name string + Type FieldType + type CreateSuppressionParams struct + Email string + Type *SuppressionType + type Domain struct + CreatedAt time.Time + DNS []DomainDNSRecord + Domain string + MailFromDomain string + MailFromVerified bool + Name string + Provider DomainProvider + Status DomainStatus + UUID string + UpdatedAt time.Time + Verification DomainVerification + Verified bool + type DomainAddress struct + Address string + CreatedAt time.Time + DisplayName string + DomainUUID string + FullAddress string + Provider *DomainProvider + UUID string + UpdatedAt time.Time + Verification DomainVerification + type DomainAddressListParams struct + Page int + PerPage int + type DomainAddressesService struct + func (service *DomainAddressesService) Create(ctx context.Context, params CreateDomainAddressParams) (*DomainAddress, error) + func (service *DomainAddressesService) Delete(ctx context.Context, uuid string) error + func (service *DomainAddressesService) Get(ctx context.Context, uuid string) (*DomainAddress, error) + func (service *DomainAddressesService) List(ctx context.Context, params *DomainAddressListParams) (*Page[DomainAddress], error) + func (service *DomainAddressesService) NewPager(params *DomainAddressListParams) *Pager[DomainAddress] + type DomainDNSRecord struct + IsValid bool + Name string + Type string + Value string + type DomainListParams struct + Page int + PerPage int + Search string + type DomainProvider string + const DomainProviderAWS + const DomainProviderLeadpush + type DomainStatus string + const DomainStatusPending + type DomainTrackingMode string + const DomainTrackingModeCloudflare + const DomainTrackingModeDirect + type DomainVerification string + const DomainVerificationCompleted + const DomainVerificationFailed + const DomainVerificationPending + type DomainsService struct + func (service *DomainsService) Addresses(uuid string) *DomainAddressesService + func (service *DomainsService) Create(ctx context.Context, params CreateDomainParams) (*Domain, error) + func (service *DomainsService) Delete(ctx context.Context, uuid string) error + func (service *DomainsService) Get(ctx context.Context, uuid string) (*Domain, error) + func (service *DomainsService) List(ctx context.Context, params *DomainListParams) (*Page[Domain], error) + func (service *DomainsService) NewPager(params *DomainListParams) *Pager[Domain] + func (service *DomainsService) Verify(ctx context.Context, uuid string) (*Domain, error) + type EmailRecipientType string + const EmailRecipientTypeBCC + const EmailRecipientTypeTo + type EmailSend struct + Accepted bool + MessageCount int + Messages []EmailSendMessage + type EmailSendMessage struct + From string + Recipient string + Status string + Type EmailRecipientType + UUID string + type EmailsService struct + func (service *EmailsService) Send(ctx context.Context, params SendEmailParams) (*EmailSend, error) + type Field struct + CreatedAt time.Time + Format *FieldFormat + Name string + Type FieldType + UUID string + type FieldFilter struct + ID FieldFilterID + Value []FieldType + type FieldFilterID string + const FieldFilterIDType + type FieldFormat struct + ISOFormat *string + Pattern *string + Text *FieldTextFormat + type FieldListParams struct + Filters []FieldFilter + Page int + PerPage int + Search string + type FieldTextFormat string + const FieldTextFormatEmail + const FieldTextFormatPhone + const FieldTextFormatRegex + const FieldTextFormatURL + const FieldTextFormatUUID + type FieldType string + const FieldTypeBoolean + const FieldTypeDate + const FieldTypeDateTime + const FieldTypeInteger + const FieldTypeText + type FieldsService struct + func (service *FieldsService) Create(ctx context.Context, params CreateFieldParams) (*Field, error) + func (service *FieldsService) Get(ctx context.Context, uuid string) (*Field, error) + func (service *FieldsService) List(ctx context.Context, params *FieldListParams) (*Page[Field], error) + func (service *FieldsService) NewPager(params *FieldListParams) *Pager[Field] + func (service *FieldsService) Update(ctx context.Context, uuid string, params UpdateFieldParams) (*Field, error) + type HTTPClient interface + Do func(*http.Request) (*http.Response, error) + type Option func(*clientConfig) + func WithBaseURL(baseURL string) Option + func WithHTTPClient(client HTTPClient) Option + func WithHeaders(headers map[string]string) Option + func WithTimeout(timeout time.Duration) Option + func WithUserAgent(userAgent string) Option + type Optional struct + func Null[T any]() Optional[T] + func Some[T any](value T) Optional[T] + func (o *Optional[T]) UnmarshalJSON(data []byte) error + func (o Optional[T]) IsNull() bool + func (o Optional[T]) IsSet() bool + func (o Optional[T]) IsZero() bool + func (o Optional[T]) MarshalJSON() ([]byte, error) + func (o Optional[T]) Value() (T, bool) + type Page struct + Data []T + Meta PaginationMeta + type Pager struct + func (p *Pager[T]) Err() error + func (p *Pager[T]) Next(ctx context.Context) bool + func (p *Pager[T]) Page() *Page[T] + type PaginationError struct + CurrentPage int + RequestedPage int + func (e *PaginationError) Error() string + type PaginationMeta struct + CurrentPage int + HasNext bool + LastPage int + PerPage int + Total int + type Request struct + Body any + Method string + Path []string + Query map[string]any + type SendEmailParams struct + BCC []string + From string + HTML *string + Headers map[string]string + ReplyTo *string + Subject string + Text *string + To []string + type Suppression struct + CreatedAt time.Time + Email string + Type SuppressionType + UUID string + type SuppressionFilter struct + ID SuppressionFilterID + Value []SuppressionType + type SuppressionFilterID string + const SuppressionFilterIDType + type SuppressionListParams struct + Filters []SuppressionFilter + Page int + PerPage int + Search string + type SuppressionType string + const SuppressionTypeBounce + const SuppressionTypeComplaint + const SuppressionTypeManual + type SuppressionsService struct + func (service *SuppressionsService) Create(ctx context.Context, params CreateSuppressionParams) (*Suppression, error) + func (service *SuppressionsService) Get(ctx context.Context, uuid string) (*Suppression, error) + func (service *SuppressionsService) List(ctx context.Context, params *SuppressionListParams) (*Page[Suppression], error) + func (service *SuppressionsService) NewPager(params *SuppressionListParams) *Pager[Suppression] + type TimeoutError struct + Err error + Timeout time.Duration + func (e *TimeoutError) Error() string + func (e *TimeoutError) Unwrap() error + type UpdateContactParams struct + Attributes Attributes + Subscribed *bool + type UpdateFieldParams struct + Format Optional[FieldFormat] + Name *string + Type *FieldType
Go to main page