Versions in this module Expand all Collapse all v0 v0.1.0 Jul 22, 2026 Changes in this version + const EnvAPIKey + const Version + type Account struct + Address *Address + Country *string + CreatedAt *string + Email string + EmailVerified bool + ID string + IdentityVerified *string + Name *string + Notifications Notifications + Organization *string + Phone *string + TwoFactorEnabled bool + VATID *string + type AccountService struct + func (s *AccountService) Get(ctx context.Context, opts ...RequestOption) (*Account, error) + func (s *AccountService) Update(ctx context.Context, params AccountUpdateParams, opts ...RequestOption) (*Account, error) + type AccountUpdateParams struct + Address *AddressUpdateParams + Country Optional[string] + Name *string + Notifications *NotificationsUpdateParams + Organization Optional[string] + Phone Optional[string] + VATID Optional[string] + type Address struct + City *string + Country *string + Line1 *string + Line2 *string + PostalCode *string + State *string + type AddressUpdateParams struct + City Optional[string] + Country Optional[string] + Line1 Optional[string] + Line2 Optional[string] + PostalCode Optional[string] + State Optional[string] + type BatchVerifyCancelResult struct + Success bool + type BatchVerifyCreateParams struct + Emails []string + WebhookURL string + type BatchVerifyJob struct + ID string + type BatchVerifyResults struct + ID string + Results []VerifyResult + type BatchVerifyResultsParams struct + Next string + PerPage int + type BatchVerifyService struct + func (s *BatchVerifyService) Cancel(ctx context.Context, id string, opts ...RequestOption) (*BatchVerifyCancelResult, error) + func (s *BatchVerifyService) Create(ctx context.Context, params BatchVerifyCreateParams, opts ...RequestOption) (*BatchVerifyJob, error) + func (s *BatchVerifyService) Results(ctx context.Context, id string, params BatchVerifyResultsParams, ...) (*BatchVerifyResults, error) + func (s *BatchVerifyService) Status(ctx context.Context, id string, opts ...RequestOption) (*BatchVerifyStatus, error) + type BatchVerifyStatus struct + Progress float64 + Status string + type CheckKeyParams struct + APIKey string + CheckCredits string + CheckPlan string + GetToken string + PublicKey string + type CheckKeyResult struct + ExtraCredits float64 + FreeMatches float64 + Name string + Organization string + PlanType string + type CheckKeyService struct + func (s *CheckKeyService) Get(ctx context.Context, params CheckKeyParams, opts ...RequestOption) (*CheckKeyResult, error) + type Client struct + Account *AccountService + BatchVerify *BatchVerifyService + CheckKey *CheckKeyService + Erasures *ErasuresService + Integrations *IntegrationsService + Jobs *JobsService + Organization *OrganizationService + Reports *ReportsService + Users *UsersService + Verify *VerifyService + func New(opts ...Option) (*Client, error) + type Connection struct + CreatedAt *string + ID string + LastSyncedAt *string + Name string + Settings ConnectionSettings + Status string + type ConnectionChecks struct + AcceptAll bool + BannedWords bool + Bounced bool + Complainers bool + Deactivated bool + Disposable bool + FailedExchange bool + InboxFull bool + Nonexistent bool + RoleBased bool + Spam bool + Unverified bool + type ConnectionChecksUpdate struct + AcceptAll *bool + BannedWords *bool + Bounced *bool + Complainers *bool + Deactivated *bool + Disposable *bool + FailedExchange *bool + InboxFull *bool + Nonexistent *bool + RoleBased *bool + Spam *bool + Unverified *bool + type ConnectionCreateParams struct + Credentials map[string]string + Name string + type ConnectionDeleted struct + DisconnectedAt string + ID string + Status string + Type string + type ConnectionSettings struct + Action *string + Aggressiveness string + Autofloss bool + BlacklistCount int + Checks ConnectionChecks + DecayProtection bool + Instafloss bool + ManualMode bool + WhitelistCount int + type ConnectionTestResult struct + CredentialValid bool + ID string + Reason string + TestedAt string + Type string + type ConnectionUpdateParams struct + Action *string + Aggressiveness *string + Autofloss *bool + Checks *ConnectionChecksUpdate + DecayProtection *bool + ManualMode *bool + type DisconnectedConnection struct + CreatedAt *string + DisconnectedAt *string + ID string + Name string + Status string + type ErasureCreateParams struct + Emails []string + WebhookURL string + type ErasureResult struct + Success bool + type ErasuresService struct + func (s *ErasuresService) Create(ctx context.Context, params ErasureCreateParams, opts ...RequestOption) (*ErasureResult, error) + type Error struct + Code string + Message string + RequestID string + Status int + Type string + func (e *Error) Error() string + type Integration struct + Connected bool + ConnectionCount int + Connections []Connection + DisconnectedConnections []DisconnectedConnection + Type string + type IntegrationPrimary struct + ID string + Name string + type IntegrationSummary struct + Connected bool + ConnectionCount int + DisconnectedCount int + Primary *IntegrationPrimary + Type string + type IntegrationsListParams struct + Cursor string + PerPage int + type IntegrationsService struct + func (s *IntegrationsService) AddKeywords(ctx context.Context, integrationType, id string, list KeywordList, ...) (*KeywordRules, error) + func (s *IntegrationsService) CreateConnection(ctx context.Context, integrationType string, params ConnectionCreateParams, ...) (*Connection, error) + func (s *IntegrationsService) DeleteConnection(ctx context.Context, integrationType, id string, opts ...RequestOption) (*ConnectionDeleted, error) + func (s *IntegrationsService) DeleteKeyword(ctx context.Context, integrationType, id string, list KeywordList, ...) (*KeywordDeleted, error) + func (s *IntegrationsService) Get(ctx context.Context, integrationType string, opts ...RequestOption) (*Integration, error) + func (s *IntegrationsService) GetConnection(ctx context.Context, integrationType, id string, opts ...RequestOption) (*Connection, error) + func (s *IntegrationsService) List(ctx context.Context, params IntegrationsListParams, opts ...RequestOption) (*ListResponse[IntegrationSummary], error) + func (s *IntegrationsService) ListKeywords(ctx context.Context, integrationType, id string, list KeywordList, ...) (*ListResponse[KeywordRule], error) + func (s *IntegrationsService) SyncConnection(ctx context.Context, integrationType, id string, opts ...RequestOption) (*Connection, error) + func (s *IntegrationsService) TestConnection(ctx context.Context, integrationType, id string, opts ...RequestOption) (*ConnectionTestResult, error) + func (s *IntegrationsService) UpdateConnection(ctx context.Context, integrationType, id string, params ConnectionUpdateParams, ...) (*Connection, error) + type Job struct + CreatedAt *string + FinishedAt *string + ID string + Results *JobResults + Source string + SourceIntegration *string + Status string + type JobResults struct + Failed int + Passed int + Processed int + Reasons *ReasonCounts + Risky int + Total int + Undeliverable int + Unknown int + type JobsListParams struct + Cursor string + PerPage int + Source string + Status string + type JobsService struct + func (s *JobsService) Get(ctx context.Context, id string, opts ...RequestOption) (*Job, error) + func (s *JobsService) List(ctx context.Context, params JobsListParams, opts ...RequestOption) (*ListResponse[Job], error) + type KeywordAddParams struct + Rules []KeywordRuleInput + type KeywordAppliesTo struct + Domain bool + Email bool + Localpart bool + type KeywordDeleted struct + Deleted bool + ID string + type KeywordList string + const KeywordListBlacklist + const KeywordListWhitelist + type KeywordRule struct + AppliesTo KeywordAppliesTo + ID string + Keyword string + Match string + type KeywordRuleInput struct + AppliesTo KeywordAppliesTo + Keyword string + Match string + type KeywordRules struct + Data []KeywordRule + type KeywordsListParams struct + Cursor string + PerPage int + type ListResponse struct + Data []T + Pagination Pagination + type Notifications struct + AfterFlossing bool + MonthlyReport bool + PaymentReceipts bool + WeeklyReport bool + type NotificationsUpdateParams struct + AfterFlossing *bool + MonthlyReport *bool + PaymentReceipts *bool + WeeklyReport *bool + type Option func(*Client) + func WithAPIKey(key string) Option + func WithBaseURL(u string) Option + func WithHTTPClient(hc *http.Client) Option + func WithMaxRetries(n int) Option + func WithSleep(fn func(time.Duration)) Option + type Optional struct + func Null[T any]() Optional[T] + func Set[T any](v T) Optional[T] + func (o *Optional[T]) UnmarshalJSON(data []byte) error + func (o Optional[T]) IsNull() bool + func (o Optional[T]) IsZero() bool + func (o Optional[T]) MarshalJSON() ([]byte, error) + func (o Optional[T]) Value() (T, bool) + type Organization struct + CreatedAt string + Credits OrganizationCredits + Email *string + Entitlements OrganizationEntitlements + Name *string + Plan string + PlanID *string + Status string + Trial OrganizationTrial + Usage OrganizationUsage + type OrganizationCredits struct + Prepaid int + Subscription int + Total int + type OrganizationEntitlements struct + Autofloss bool + DecayBasic bool + DecayCustom bool + Exclusions bool + Instafloss bool + SSO bool + TypoFixer bool + UpdateTags bool + Webhooks bool + type OrganizationService struct + func (s *OrganizationService) Get(ctx context.Context, opts ...RequestOption) (*Organization, error) + type OrganizationTrial struct + Active bool + EndsAt *string + StartedAt *string + type OrganizationUsage struct + CurrentPeriodEnd string + CurrentPeriodStart string + CurrentPeriodTotal int + type Pagination struct + HasMore bool + NextCursor *string + type ReasonCounts struct + AcceptAll int + Available int + BannedWords int + Blacklisted int + Bounced int + Complained int + Deactivated int + Disposable int + FailedExchange int + Illegitimate int + InboxFull int + Invalid int + Nonexistent int + RoleBased int + Spam int + Unverified int + type ReportsService struct + func (s *ReportsService) Usage(ctx context.Context, params UsageParams, opts ...RequestOption) (*UsageReport, error) + type RequestOption func(*requestOptions) + func WithIdempotencyKey(key string) RequestOption + type UsageParams struct + ConnectionID string + Period string + type UsageRange struct + End string + Start string + type UsageReport struct + ConnectionID *string + Period string + Range *UsageRange + Reasons *ReasonCounts + Statuses *UsageStatuses + Total int + type UsageStatuses struct + Failed int + Passed int + Risky int + Undeliverable int + Unknown int + type User struct + CreatedAt *string + Email string + ID string + IsPrimary bool + Name *string + Role string + Status string + type UsersListParams struct + Cursor string + PerPage int + type UsersService struct + func (s *UsersService) Get(ctx context.Context, userID string, opts ...RequestOption) (*User, error) + func (s *UsersService) List(ctx context.Context, params UsersListParams, opts ...RequestOption) (*ListResponse[User], error) + type VerifyParams struct + Email string + Timeout *float64 + type VerifyResult struct + Disposable *bool + Domain string + Email string + Free *bool + Meta string + Passed bool + Reason string + Role *bool + Status string + Suggestion string + type VerifyService struct + func (s *VerifyService) Check(ctx context.Context, params VerifyParams, opts ...RequestOption) (*VerifyResult, error)
Go to main page