Documentation ¶
Index ¶
- func Bool(v bool) *bool
- func OptionBaseURL(endpoint string) func(*Client)
- func OptionDebug(b bool) func(*Client)
- func OptionHTTPClient(client httpClient) func(*Client)
- func OptionLog(l logger) func(*Client)
- func OptionSubuser(subuser string) func(*Client)
- func String(v string) *string
- type APIKey
- type ARecord
- type ARecordValidationResults
- type BrandedLink
- type Client
- func (c *Client) ActivateTemplateVersion(ctx context.Context, templateID, versionID string) (*OutputActivateTemplateVersion, error)
- func (c *Client) AddIPToAuthenticatedDomain(ctx context.Context, domainId int64, input *InputAddIPToAuthenticatedDomain) (*OutputAddIPToAuthenticatedDomain, error)
- func (c *Client) AddOptions(s string, opts interface{}) (string, error)
- func (c *Client) AssociateAuthenticatedDomainWithSubuser(ctx context.Context, domainId int64, ...) (*OutputAssociateAuthenticatedDomainWithSubuser, error)
- func (c *Client) AssociateBrandedLinkWithSubuser(ctx context.Context, id int64, input *InputAssociateBrandedLinkWithSubuser) (*OutputAssociateBrandedLinkWithSubuser, error)
- func (c *Client) AuthenticateDomain(ctx context.Context, input *InputAuthenticateDomain) (*OutputAuthenticateDomain, error)
- func (c *Client) CompletedStepsVerifiedSender(ctx context.Context) (*CompletedStepsVerifiedSender, error)
- func (c *Client) CreateAPIKey(ctx context.Context, input *InputCreateAPIKey) (*OutputCreateAPIKey, error)
- func (c *Client) CreateBrandedLink(ctx context.Context, input *InputCreateBrandedLink) (*OutputCreateBrandedLink, error)
- func (c *Client) CreateReverseDNS(ctx context.Context, input *InputCreateReverseDNS) (*OutputCreateReverseDNS, error)
- func (c *Client) CreateSSOCertificate(ctx context.Context, input *InputCreateSSOCertificate) (*OutputCreateSSOCertificate, error)
- func (c *Client) CreateSSOIntegration(ctx context.Context, input *InputCreateSSOIntegration) (*OutputCreateSSOIntegration, error)
- func (c *Client) CreateSubuser(ctx context.Context, input *InputCreateSubuser) (*OutputCreateSubuser, error)
- func (c *Client) CreateSuppressionGroup(ctx context.Context, input *InputCreateSuppressionGroup) (*OutputCreateSuppressionGroup, error)
- func (c *Client) CreateTemplate(ctx context.Context, input *InputCreateTemplate) (*OutputCreateTemplate, error)
- func (c *Client) CreateTemplateVersion(ctx context.Context, templateID string, input *InputCreateTemplateVersion) (*OutputCreateTemplateVersion, error)
- func (c *Client) CreateVerifiedSenderRequest(ctx context.Context, input *InputCreateVerifiedSenderRequest) (*OutputCreateVerifiedSenderRequest, error)
- func (c *Client) Debug() bool
- func (c *Client) Debugf(format string, v ...interface{})
- func (c *Client) Debugln(v ...interface{})
- func (c *Client) DeleteAPIKey(ctx context.Context, apiKeyId string) error
- func (c *Client) DeleteAuthenticatedDomain(ctx context.Context, domainId int64) error
- func (c *Client) DeleteBrandedLink(ctx context.Context, id int64) error
- func (c *Client) DeletePendingTeammate(ctx context.Context, token string) error
- func (c *Client) DeleteReverseDNS(ctx context.Context, id int64) error
- func (c *Client) DeleteSSOCertificate(ctx context.Context, id int64) error
- func (c *Client) DeleteSSOIntegration(ctx context.Context, id string) error
- func (c *Client) DeleteSubuser(ctx context.Context, username string) error
- func (c *Client) DeleteSuppressionGroup(ctx context.Context, id int64) error
- func (c *Client) DeleteTeammate(ctx context.Context, username string) error
- func (c *Client) DeleteTemplate(ctx context.Context, id string) error
- func (c *Client) DeleteTemplateVersion(ctx context.Context, templateID, versionID string) error
- func (c *Client) DeleteVerifiedSender(ctx context.Context, id int64) error
- func (c *Client) DisassociateAuthenticatedDomainFromSubuser(ctx context.Context, subuserName string) error
- func (c *Client) DisassociateBrandedLinkWithSubuser(ctx context.Context, username string) error
- func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) error
- func (c *Client) DuplicateTemplate(ctx context.Context, id string, input *InputDuplicateTemplate) (*OutputDuplicateTemplate, error)
- func (c *Client) GetAPIKey(ctx context.Context, apiKeyId string) (*OutputGetAPIKey, error)
- func (c *Client) GetAPIKeys(ctx context.Context) (*OutputGetAPIKeys, error)
- func (c *Client) GetAuthenticatedDomain(ctx context.Context, domainId int64) (*OutputGetAuthenticatedDomain, error)
- func (c *Client) GetAuthenticatedDomainAssociatedWithSubuser(ctx context.Context, subuserName string) (*OutputGetAuthenticatedDomainAssociatedWithSubuser, error)
- func (c *Client) GetAuthenticatedDomains(ctx context.Context, input *InputGetAuthenticatedDomains) ([]*DomainAuthentication, error)
- func (c *Client) GetBrandedLink(ctx context.Context, id int64) (*OutputGetBrandedLink, error)
- func (c *Client) GetBrandedLinks(ctx context.Context, input *InputGetBrandedLinks) ([]*BrandedLink, error)
- func (c *Client) GetClickTrackingSettings(ctx context.Context) (*OutputGetClickTrackingSettings, error)
- func (c *Client) GetDefaultAuthentication(ctx context.Context, input *InputGetDefaultAuthentication) (*OutputGetDefaultAuthentication, error)
- func (c *Client) GetDefaultBrandedLink(ctx context.Context) (*OutputGetDefaultBrandedLink, error)
- func (c *Client) GetEnforceTLS(ctx context.Context) (*OutputGetEnforceTLS, error)
- func (c *Client) GetGoogleAnalyticsSettings(ctx context.Context) (*OutputGetGoogleAnalyticsSettings, error)
- func (c *Client) GetOpenTrackingSettings(ctx context.Context) (*OutputGetOpenTrackingSettings, error)
- func (c *Client) GetPendingTeammates(ctx context.Context) (*OutputGetPendingTeammates, error)
- func (c *Client) GetReverseDNS(ctx context.Context, id int64) (*OutputGetReverseDNS, error)
- func (c *Client) GetReverseDNSs(ctx context.Context, input *InputGetReverseDNSs) ([]*OutputGetReverseDNS, error)
- func (c *Client) GetSSOCertificate(ctx context.Context, id int64) (*OutputGetSSOCertificate, error)
- func (c *Client) GetSSOCertificates(ctx context.Context, integrationID string) ([]*SSOCertificate, error)
- func (c *Client) GetSSOIntegration(ctx context.Context, id string) (*OutputGetSSOIntegration, error)
- func (c *Client) GetSSOIntegrations(ctx context.Context, input *InputGetSSOIntegrations) ([]*SSOIntegration, error)
- func (c *Client) GetSenderVerificationDomainWarnList(ctx context.Context) (*CompletedStepsVerifiedSender, error)
- func (c *Client) GetSubscriptionTrackingSettings(ctx context.Context) (*OutputGetSubscriptionTrackingSettings, error)
- func (c *Client) GetSubuserBrandedLink(ctx context.Context, subuser string) (*OutputGetSubuserBrandedLink, error)
- func (c *Client) GetSubuserReputations(ctx context.Context, usernames string) ([]*Reputation, error)
- func (c *Client) GetSubusers(ctx context.Context, input *InputGetSubusers) ([]*Subuser, error)
- func (c *Client) GetSuppressionGroup(ctx context.Context, id int64) (*SuppressionGroup, error)
- func (c *Client) GetSuppressionGroups(ctx context.Context) ([]*SuppressionGroup, error)
- func (c *Client) GetTeammate(ctx context.Context, username string) (*OutputGetTeammate, error)
- func (c *Client) GetTeammates(ctx context.Context) (*OutputGetTeammates, error)
- func (c *Client) GetTemplate(ctx context.Context, id string) (*OutputGetTemplate, error)
- func (c *Client) GetTemplateVersion(ctx context.Context, templateID, versionID string) (*OutputGetTemplateVersion, error)
- func (c *Client) GetTemplates(ctx context.Context, input *InputGetTemplates) (*OutputGetTemplates, error)
- func (c *Client) GetTrackingSettings(ctx context.Context) (*OutputGetTrackingSettings, error)
- func (c *Client) GetVerifiedSenders(ctx context.Context, input *InputGetVerifiedSenders) ([]*VerifiedSender, error)
- func (c *Client) InviteTeammate(ctx context.Context, input *InputInviteTeammate) (*OutputInviteTeammate, error)
- func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)
- func (c *Client) RemoveIPFromAuthenticatedDomain(ctx context.Context, domainId int64, ip string) error
- func (c *Client) ResendVerifiedSenderRequest(ctx context.Context, id int64) error
- func (c *Client) UpdateAPIKeyName(ctx context.Context, apiKeyId string, input *InputUpdateAPIKeyName) (*OutputUpdateAPIKeyName, error)
- func (c *Client) UpdateAPIKeyNameAndScopes(ctx context.Context, apiKeyId string, input *InputUpdateAPIKeyNameAndScopes) (*OutputUpdateAPIKeyNameAndScopes, error)
- func (c *Client) UpdateBrandedLink(ctx context.Context, id int64, input *InputUpdateBrandedLink) (*OutputUpdateBrandedLink, error)
- func (c *Client) UpdateClickTrackingSettings(ctx context.Context, input *InputUpdateClickTrackingSettings) (*OutputUpdateClickTrackingSettings, error)
- func (c *Client) UpdateDomainAuthentication(ctx context.Context, domainId int64, input *InputUpdateDomainAuthentication) (*OutputUpdateDomainAuthentication, error)
- func (c *Client) UpdateEnforceTLS(ctx context.Context, input *InputUpdateEnforceTLS) (*OutputUpdateEnforceTLS, error)
- func (c *Client) UpdateGoogleAnalyticsSettings(ctx context.Context, input *InputUpdateGoogleAnalyticsSettings) (*OutputUpdateGoogleAnalyticsSettings, error)
- func (c *Client) UpdateOpenTrackingSettings(ctx context.Context, input *InputUpdateOpenTrackingSettings) (*OutputUpdateOpenTrackingSettings, error)
- func (c *Client) UpdateSSOCertificate(ctx context.Context, id int64, input *InputUpdateSSOCertificate) (*OutputUpdateSSOCertificate, error)
- func (c *Client) UpdateSSOIntegration(ctx context.Context, id string, input *InputUpdateSSOIntegration) (*OutputUpdateSSOIntegration, error)
- func (c *Client) UpdateSubscriptionTrackingSettings(ctx context.Context, input *InputUpdateSubscriptionTrackingSettings) (*OutputUpdateSubscriptionTrackingSettings, error)
- func (c *Client) UpdateSubuserIps(ctx context.Context, username string, ips []string) error
- func (c *Client) UpdateSubuserStatus(ctx context.Context, username string, input *InputUpdateSubuserStatus) error
- func (c *Client) UpdateSuppressionGroup(ctx context.Context, id int64, input *InputUpdateSuppressionGroup) (*OutputUpdateSuppressionGroup, error)
- func (c *Client) UpdateTeammatePermissions(ctx context.Context, username string, input *InputUpdateTeammatePermissions) (*OutputUpdateTeammatePermissions, error)
- func (c *Client) UpdateTemplate(ctx context.Context, id string, input *InputUpdateTemplate) (*OutputUpdateTemplate, error)
- func (c *Client) UpdateTemplateVersion(ctx context.Context, templateID, versionID string, ...) (*OutputUpdateTemplateVersion, error)
- func (c *Client) UpdateVerifiedSender(ctx context.Context, id int64, input *InputUpdateVerifiedSender) (*OutputUpdateVerifiedSender, error)
- func (c *Client) ValidateBrandedLink(ctx context.Context, id int64) (*OutputValidateBrandedLink, error)
- func (c *Client) ValidateDomainAuthentication(ctx context.Context, domainId int64) (*OutputValidateDomainAuthentication, error)
- func (c *Client) ValidateReverseDNS(ctx context.Context, id int64) (*OutputValidateReverseDNS, error)
- func (c *Client) VerifySenderRequest(ctx context.Context, token string) error
- type CompletedStepsVerifiedSender
- type CreditAllocation
- type DNS
- type DNSBrandedLink
- type DomainAuthentication
- type Error
- type ErrorResponse
- type ErrorsResponse
- type InputAddIPToAuthenticatedDomain
- type InputAssociateAuthenticatedDomainWithSubuser
- type InputAssociateBrandedLinkWithSubuser
- type InputAuthenticateDomain
- type InputCreateAPIKey
- type InputCreateBrandedLink
- type InputCreateReverseDNS
- type InputCreateSSOCertificate
- type InputCreateSSOIntegration
- type InputCreateSubuser
- type InputCreateSuppressionGroup
- type InputCreateTemplate
- type InputCreateTemplateVersion
- type InputCreateVerifiedSenderRequest
- type InputDuplicateTemplate
- type InputGetAuthenticatedDomains
- type InputGetBrandedLinks
- type InputGetDefaultAuthentication
- type InputGetReverseDNSs
- type InputGetSSOIntegrations
- type InputGetSubusers
- type InputGetTemplates
- type InputGetVerifiedSenders
- type InputInviteTeammate
- type InputUpdateAPIKeyName
- type InputUpdateAPIKeyNameAndScopes
- type InputUpdateBrandedLink
- type InputUpdateClickTrackingSettings
- type InputUpdateDomainAuthentication
- type InputUpdateEnforceTLS
- type InputUpdateGoogleAnalyticsSettings
- type InputUpdateOpenTrackingSettings
- type InputUpdateSSOCertificate
- type InputUpdateSSOIntegration
- type InputUpdateSubscriptionTrackingSettings
- type InputUpdateSubuserStatus
- type InputUpdateSuppressionGroup
- type InputUpdateTeammatePermissions
- type InputUpdateTemplate
- type InputUpdateTemplateVersion
- type InputUpdateVerifiedSender
- type Metadata
- type Option
- type OutputActivateTemplateVersion
- type OutputAddIPToAuthenticatedDomain
- type OutputAssociateAuthenticatedDomainWithSubuser
- type OutputAssociateBrandedLinkWithSubuser
- type OutputAuthenticateDomain
- type OutputCompletedStepsVerifiedSender
- type OutputCreateAPIKey
- type OutputCreateBrandedLink
- type OutputCreateReverseDNS
- type OutputCreateSSOCertificate
- type OutputCreateSSOIntegration
- type OutputCreateSubuser
- type OutputCreateSuppressionGroup
- type OutputCreateTemplate
- type OutputCreateTemplateVersion
- type OutputCreateVerifiedSenderRequest
- type OutputDuplicateTemplate
- type OutputGetAPIKey
- type OutputGetAPIKeys
- type OutputGetAuthenticatedDomain
- type OutputGetAuthenticatedDomainAssociatedWithSubuser
- type OutputGetBrandedLink
- type OutputGetClickTrackingSettings
- type OutputGetDefaultAuthentication
- type OutputGetDefaultBrandedLink
- type OutputGetEnforceTLS
- type OutputGetGoogleAnalyticsSettings
- type OutputGetOpenTrackingSettings
- type OutputGetPendingTeammates
- type OutputGetReverseDNS
- type OutputGetSSOCertificate
- type OutputGetSSOIntegration
- type OutputGetSubscriptionTrackingSettings
- type OutputGetSubuserBrandedLink
- type OutputGetTeammate
- type OutputGetTeammates
- type OutputGetTemplate
- type OutputGetTemplateVersion
- type OutputGetTemplates
- type OutputGetTrackingSettings
- type OutputGetVerifiedSenders
- type OutputInviteTeammate
- type OutputUpdateAPIKeyName
- type OutputUpdateAPIKeyNameAndScopes
- type OutputUpdateBrandedLink
- type OutputUpdateClickTrackingSettings
- type OutputUpdateDomainAuthentication
- type OutputUpdateEnforceTLS
- type OutputUpdateGoogleAnalyticsSettings
- type OutputUpdateOpenTrackingSettings
- type OutputUpdateSSOCertificate
- type OutputUpdateSSOIntegration
- type OutputUpdateSubscriptionTrackingSettings
- type OutputUpdateSuppressionGroup
- type OutputUpdateTeammatePermissions
- type OutputUpdateTemplate
- type OutputUpdateTemplateVersion
- type OutputUpdateVerifiedSender
- type OutputValidateBrandedLink
- type OutputValidateDomainAuthentication
- type OutputValidateReverseDNS
- type PendingTeammate
- type RateLimitedError
- type Record
- type Reputation
- type ResultGetTrackingSettings
- type SSOCertificate
- type SSOIntegration
- type Subuser
- type SubuserSenderAuthentication
- type SuppressionGroup
- type Teammate
- type Template
- type User
- type ValidationResult
- type ValidationResults
- type ValidationResultsBrandedLink
- type ValidationResultsReverseDNS
- type VerifiedSender
- type Version
- type Warning
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Bool ¶
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
func OptionBaseURL ¶
OptionBaseURL - provide a custom base url to the sendgrid client.
func OptionDebug ¶
OptionDebug enable debugging for the client
func OptionHTTPClient ¶
func OptionHTTPClient(client httpClient) func(*Client)
OptionHTTPClient - provide a custom http client to the sendgrid client.
func OptionSubuser ¶
OptionBaseURL - provide a custom base url to the sendgrid client.
Types ¶
type ARecordValidationResults ¶ added in v0.0.17
type BrandedLink ¶ added in v0.0.7
type BrandedLink struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client : sendgrid client
func (*Client) ActivateTemplateVersion ¶ added in v0.0.14
func (*Client) AddIPToAuthenticatedDomain ¶ added in v0.0.6
func (c *Client) AddIPToAuthenticatedDomain(ctx context.Context, domainId int64, input *InputAddIPToAuthenticatedDomain) (*OutputAddIPToAuthenticatedDomain, error)
NOTE: The 'dns' key in the API response for adding an IP to the authenticated domain is different from what is documented. see: https://docs.sendgrid.com/api-reference/domain-authentication/add-an-ip-to-an-authenticated-domain#responses
func (*Client) AddOptions ¶
AddOptions adds the parameters in opt as URL query parameters to s. opt must be a struct whose fields may contain "url" tags.
func (*Client) AssociateAuthenticatedDomainWithSubuser ¶ added in v0.0.6
func (c *Client) AssociateAuthenticatedDomainWithSubuser(ctx context.Context, domainId int64, input *InputAssociateAuthenticatedDomainWithSubuser) (*OutputAssociateAuthenticatedDomainWithSubuser, error)
func (*Client) AssociateBrandedLinkWithSubuser ¶ added in v0.0.7
func (c *Client) AssociateBrandedLinkWithSubuser(ctx context.Context, id int64, input *InputAssociateBrandedLinkWithSubuser) (*OutputAssociateBrandedLinkWithSubuser, error)
func (*Client) AuthenticateDomain ¶ added in v0.0.6
func (c *Client) AuthenticateDomain(ctx context.Context, input *InputAuthenticateDomain) (*OutputAuthenticateDomain, error)
func (*Client) CompletedStepsVerifiedSender ¶ added in v0.0.10
func (c *Client) CompletedStepsVerifiedSender(ctx context.Context) (*CompletedStepsVerifiedSender, error)
func (*Client) CreateAPIKey ¶ added in v0.0.2
func (c *Client) CreateAPIKey(ctx context.Context, input *InputCreateAPIKey) (*OutputCreateAPIKey, error)
func (*Client) CreateBrandedLink ¶ added in v0.0.7
func (c *Client) CreateBrandedLink(ctx context.Context, input *InputCreateBrandedLink) (*OutputCreateBrandedLink, error)
func (*Client) CreateReverseDNS ¶ added in v0.0.17
func (c *Client) CreateReverseDNS(ctx context.Context, input *InputCreateReverseDNS) (*OutputCreateReverseDNS, error)
see: https://docs.sendgrid.com/api-reference/reverse-dns/set-up-reverse-dns
func (*Client) CreateSSOCertificate ¶ added in v0.0.20
func (c *Client) CreateSSOCertificate(ctx context.Context, input *InputCreateSSOCertificate) (*OutputCreateSSOCertificate, error)
func (*Client) CreateSSOIntegration ¶ added in v0.0.19
func (c *Client) CreateSSOIntegration(ctx context.Context, input *InputCreateSSOIntegration) (*OutputCreateSSOIntegration, error)
see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/create-an-sso-integration
func (*Client) CreateSubuser ¶ added in v0.0.3
func (c *Client) CreateSubuser(ctx context.Context, input *InputCreateSubuser) (*OutputCreateSubuser, error)
func (*Client) CreateSuppressionGroup ¶ added in v0.0.13
func (c *Client) CreateSuppressionGroup(ctx context.Context, input *InputCreateSuppressionGroup) (*OutputCreateSuppressionGroup, error)
func (*Client) CreateTemplate ¶ added in v0.0.14
func (c *Client) CreateTemplate(ctx context.Context, input *InputCreateTemplate) (*OutputCreateTemplate, error)
see: https://docs.sendgrid.com/api-reference/transactional-templates/create-a-transactional-template
func (*Client) CreateTemplateVersion ¶ added in v0.0.14
func (c *Client) CreateTemplateVersion(ctx context.Context, templateID string, input *InputCreateTemplateVersion) (*OutputCreateTemplateVersion, error)
func (*Client) CreateVerifiedSenderRequest ¶ added in v0.0.10
func (c *Client) CreateVerifiedSenderRequest(ctx context.Context, input *InputCreateVerifiedSenderRequest) (*OutputCreateVerifiedSenderRequest, error)
func (*Client) DeleteAPIKey ¶ added in v0.0.2
func (*Client) DeleteAuthenticatedDomain ¶ added in v0.0.6
func (*Client) DeleteBrandedLink ¶ added in v0.0.7
func (*Client) DeletePendingTeammate ¶
func (*Client) DeleteReverseDNS ¶ added in v0.0.17
see: https://docs.sendgrid.com/api-reference/reverse-dns/delete-a-reverse-dns-record
func (*Client) DeleteSSOCertificate ¶ added in v0.0.19
see: https://docs.sendgrid.com/api-reference/certificates/delete-an-sso-certificate
func (*Client) DeleteSSOIntegration ¶ added in v0.0.19
see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/delete-an-sso-integration
func (*Client) DeleteSubuser ¶ added in v0.0.3
func (*Client) DeleteSuppressionGroup ¶ added in v0.0.13
see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/delete-a-suppression-group
func (*Client) DeleteTeammate ¶
func (*Client) DeleteTemplate ¶ added in v0.0.14
see: https://docs.sendgrid.com/api-reference/transactional-templates/delete-a-template
func (*Client) DeleteTemplateVersion ¶ added in v0.0.14
func (*Client) DeleteVerifiedSender ¶ added in v0.0.10
func (*Client) DisassociateAuthenticatedDomainFromSubuser ¶ added in v0.0.6
func (*Client) DisassociateBrandedLinkWithSubuser ¶ added in v0.0.7
func (*Client) Do ¶
Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response body will be written to v, without attempting to first decode it. If rate limit is exceeded and reset time is in the future, Do returns *RateLimitError immediately without making a network API call.
The provided ctx must be non-nil, if it is nil an error is returned. If it is canceled or times out, ctx.Err() will be returned.
func (*Client) DuplicateTemplate ¶ added in v0.0.14
func (c *Client) DuplicateTemplate(ctx context.Context, id string, input *InputDuplicateTemplate) (*OutputDuplicateTemplate, error)
see: https://docs.sendgrid.com/api-reference/transactional-templates/duplicate-a-transactional-template
func (*Client) GetAPIKeys ¶ added in v0.0.2
func (c *Client) GetAPIKeys(ctx context.Context) (*OutputGetAPIKeys, error)
func (*Client) GetAuthenticatedDomain ¶ added in v0.0.6
func (*Client) GetAuthenticatedDomainAssociatedWithSubuser ¶ added in v0.0.6
func (*Client) GetAuthenticatedDomains ¶ added in v0.0.6
func (c *Client) GetAuthenticatedDomains(ctx context.Context, input *InputGetAuthenticatedDomains) ([]*DomainAuthentication, error)
func (*Client) GetBrandedLink ¶ added in v0.0.7
func (*Client) GetBrandedLinks ¶ added in v0.0.7
func (c *Client) GetBrandedLinks(ctx context.Context, input *InputGetBrandedLinks) ([]*BrandedLink, error)
func (*Client) GetClickTrackingSettings ¶ added in v0.0.18
func (c *Client) GetClickTrackingSettings(ctx context.Context) (*OutputGetClickTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-click-track-settings
func (*Client) GetDefaultAuthentication ¶ added in v0.0.6
func (c *Client) GetDefaultAuthentication(ctx context.Context, input *InputGetDefaultAuthentication) (*OutputGetDefaultAuthentication, error)
func (*Client) GetDefaultBrandedLink ¶ added in v0.0.7
func (c *Client) GetDefaultBrandedLink(ctx context.Context) (*OutputGetDefaultBrandedLink, error)
func (*Client) GetEnforceTLS ¶ added in v0.0.15
func (c *Client) GetEnforceTLS(ctx context.Context) (*OutputGetEnforceTLS, error)
see: https://docs.sendgrid.com/api-reference/settings-enforced-tls/retrieve-current-enforced-tls-settings
func (*Client) GetGoogleAnalyticsSettings ¶ added in v0.0.18
func (c *Client) GetGoogleAnalyticsSettings(ctx context.Context) (*OutputGetGoogleAnalyticsSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-google-analytics-settings
func (*Client) GetOpenTrackingSettings ¶ added in v0.0.18
func (c *Client) GetOpenTrackingSettings(ctx context.Context) (*OutputGetOpenTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/get-open-tracking-settings
func (*Client) GetPendingTeammates ¶
func (c *Client) GetPendingTeammates(ctx context.Context) (*OutputGetPendingTeammates, error)
func (*Client) GetReverseDNS ¶ added in v0.0.17
see: https://docs.sendgrid.com/api-reference/reverse-dns/retrieve-a-reverse-dns-record
func (*Client) GetReverseDNSs ¶ added in v0.0.17
func (c *Client) GetReverseDNSs(ctx context.Context, input *InputGetReverseDNSs) ([]*OutputGetReverseDNS, error)
see: https://docs.sendgrid.com/api-reference/reverse-dns/retrieve-all-reverse-dns-records
func (*Client) GetSSOCertificate ¶ added in v0.0.19
see: https://docs.sendgrid.com/api-reference/certificates/get-an-sso-certificate
func (*Client) GetSSOCertificates ¶ added in v0.0.19
func (c *Client) GetSSOCertificates(ctx context.Context, integrationID string) ([]*SSOCertificate, error)
see: https://docs.sendgrid.com/api-reference/certificates/get-all-sso-certificates-by-integration
func (*Client) GetSSOIntegration ¶ added in v0.0.19
func (c *Client) GetSSOIntegration(ctx context.Context, id string) (*OutputGetSSOIntegration, error)
see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/get-an-sso-integration
func (*Client) GetSSOIntegrations ¶ added in v0.0.19
func (c *Client) GetSSOIntegrations(ctx context.Context, input *InputGetSSOIntegrations) ([]*SSOIntegration, error)
see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/get-all-sso-integrations
func (*Client) GetSenderVerificationDomainWarnList ¶ added in v0.0.10
func (c *Client) GetSenderVerificationDomainWarnList(ctx context.Context) (*CompletedStepsVerifiedSender, error)
see: https://docs.sendgrid.com/api-reference/sender-verification/domain-warn-list This endpoint returns a list of domains known to implement DMARC and categorizes them by failure type — hard failure or soft failure. Domains listed as hard failures will not deliver mail when used as a Sender Identity due to the domain's DMARC policy settings.
func (*Client) GetSubscriptionTrackingSettings ¶ added in v0.0.18
func (c *Client) GetSubscriptionTrackingSettings(ctx context.Context) (*OutputGetSubscriptionTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-subscription-tracking-settings
func (*Client) GetSubuserBrandedLink ¶ added in v0.0.7
func (*Client) GetSubuserReputations ¶ added in v0.0.3
func (*Client) GetSubusers ¶ added in v0.0.3
func (*Client) GetSuppressionGroup ¶ added in v0.0.13
func (*Client) GetSuppressionGroups ¶ added in v0.0.13
func (c *Client) GetSuppressionGroups(ctx context.Context) ([]*SuppressionGroup, error)
func (*Client) GetTeammate ¶
func (*Client) GetTeammates ¶
func (c *Client) GetTeammates(ctx context.Context) (*OutputGetTeammates, error)
func (*Client) GetTemplate ¶ added in v0.0.14
func (*Client) GetTemplateVersion ¶ added in v0.0.14
func (*Client) GetTemplates ¶ added in v0.0.14
func (c *Client) GetTemplates(ctx context.Context, input *InputGetTemplates) (*OutputGetTemplates, error)
func (*Client) GetTrackingSettings ¶ added in v0.0.18
func (c *Client) GetTrackingSettings(ctx context.Context) (*OutputGetTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-tracking-settings
func (*Client) GetVerifiedSenders ¶ added in v0.0.10
func (c *Client) GetVerifiedSenders(ctx context.Context, input *InputGetVerifiedSenders) ([]*VerifiedSender, error)
func (*Client) InviteTeammate ¶
func (c *Client) InviteTeammate(ctx context.Context, input *InputInviteTeammate) (*OutputInviteTeammate, error)
func (*Client) NewRequest ¶
NewRequest creates an API request. A relative URL can be provided in urlStr, in which case it is resolved relative to the BaseURL of the Client. Relative URLs should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.
func (*Client) RemoveIPFromAuthenticatedDomain ¶ added in v0.0.6
func (c *Client) RemoveIPFromAuthenticatedDomain(ctx context.Context, domainId int64, ip string) error
NOTE: The 'dns' key in the API response for removing an IP to the authenticated domain is different from what is documented. see: https://docs.sendgrid.com/api-reference/domain-authentication/remove-an-ip-from-an-authenticated-domain#responses
func (*Client) ResendVerifiedSenderRequest ¶ added in v0.0.10
func (*Client) UpdateAPIKeyName ¶ added in v0.0.2
func (c *Client) UpdateAPIKeyName(ctx context.Context, apiKeyId string, input *InputUpdateAPIKeyName) (*OutputUpdateAPIKeyName, error)
func (*Client) UpdateAPIKeyNameAndScopes ¶ added in v0.0.2
func (c *Client) UpdateAPIKeyNameAndScopes(ctx context.Context, apiKeyId string, input *InputUpdateAPIKeyNameAndScopes) (*OutputUpdateAPIKeyNameAndScopes, error)
func (*Client) UpdateBrandedLink ¶ added in v0.0.7
func (c *Client) UpdateBrandedLink(ctx context.Context, id int64, input *InputUpdateBrandedLink) (*OutputUpdateBrandedLink, error)
func (*Client) UpdateClickTrackingSettings ¶ added in v0.0.18
func (c *Client) UpdateClickTrackingSettings(ctx context.Context, input *InputUpdateClickTrackingSettings) (*OutputUpdateClickTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/update-click-tracking-settings
func (*Client) UpdateDomainAuthentication ¶ added in v0.0.6
func (c *Client) UpdateDomainAuthentication(ctx context.Context, domainId int64, input *InputUpdateDomainAuthentication) (*OutputUpdateDomainAuthentication, error)
func (*Client) UpdateEnforceTLS ¶ added in v0.0.15
func (c *Client) UpdateEnforceTLS(ctx context.Context, input *InputUpdateEnforceTLS) (*OutputUpdateEnforceTLS, error)
see: https://docs.sendgrid.com/api-reference/settings-enforced-tls/update-enforced-tls-settings
func (*Client) UpdateGoogleAnalyticsSettings ¶ added in v0.0.18
func (c *Client) UpdateGoogleAnalyticsSettings(ctx context.Context, input *InputUpdateGoogleAnalyticsSettings) (*OutputUpdateGoogleAnalyticsSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/update-google-analytics-settings
func (*Client) UpdateOpenTrackingSettings ¶ added in v0.0.18
func (c *Client) UpdateOpenTrackingSettings(ctx context.Context, input *InputUpdateOpenTrackingSettings) (*OutputUpdateOpenTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/update-open-tracking-settings
func (*Client) UpdateSSOCertificate ¶ added in v0.0.19
func (c *Client) UpdateSSOCertificate(ctx context.Context, id int64, input *InputUpdateSSOCertificate) (*OutputUpdateSSOCertificate, error)
see: https://docs.sendgrid.com/api-reference/certificates/update-sso-certificate
func (*Client) UpdateSSOIntegration ¶ added in v0.0.19
func (c *Client) UpdateSSOIntegration(ctx context.Context, id string, input *InputUpdateSSOIntegration) (*OutputUpdateSSOIntegration, error)
see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/update-an-sso-integration
func (*Client) UpdateSubscriptionTrackingSettings ¶ added in v0.0.18
func (c *Client) UpdateSubscriptionTrackingSettings(ctx context.Context, input *InputUpdateSubscriptionTrackingSettings) (*OutputUpdateSubscriptionTrackingSettings, error)
see: https://docs.sendgrid.com/api-reference/settings-tracking/update-subscription-tracking-settings
func (*Client) UpdateSubuserIps ¶ added in v0.0.3
func (*Client) UpdateSubuserStatus ¶ added in v0.0.3
func (*Client) UpdateSuppressionGroup ¶ added in v0.0.13
func (c *Client) UpdateSuppressionGroup(ctx context.Context, id int64, input *InputUpdateSuppressionGroup) (*OutputUpdateSuppressionGroup, error)
see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/update-a-suppression-group
func (*Client) UpdateTeammatePermissions ¶
func (c *Client) UpdateTeammatePermissions(ctx context.Context, username string, input *InputUpdateTeammatePermissions) (*OutputUpdateTeammatePermissions, error)
func (*Client) UpdateTemplate ¶ added in v0.0.14
func (c *Client) UpdateTemplate(ctx context.Context, id string, input *InputUpdateTemplate) (*OutputUpdateTemplate, error)
see: https://docs.sendgrid.com/api-reference/transactional-templates/edit-a-transactional-template
func (*Client) UpdateTemplateVersion ¶ added in v0.0.14
func (c *Client) UpdateTemplateVersion(ctx context.Context, templateID, versionID string, input *InputUpdateTemplateVersion) (*OutputUpdateTemplateVersion, error)
func (*Client) UpdateVerifiedSender ¶ added in v0.0.10
func (c *Client) UpdateVerifiedSender(ctx context.Context, id int64, input *InputUpdateVerifiedSender) (*OutputUpdateVerifiedSender, error)
func (*Client) ValidateBrandedLink ¶ added in v0.0.7
func (*Client) ValidateDomainAuthentication ¶ added in v0.0.6
func (*Client) ValidateReverseDNS ¶ added in v0.0.17
func (c *Client) ValidateReverseDNS(ctx context.Context, id int64) (*OutputValidateReverseDNS, error)
see: https://docs.sendgrid.com/api-reference/reverse-dns/set-up-reverse-dns
type CompletedStepsVerifiedSender ¶ added in v0.0.10
type CreditAllocation ¶ added in v0.0.3
type CreditAllocation struct {
Type string `json:"type"`
}
type DNSBrandedLink ¶ added in v0.0.7
type DomainAuthentication ¶ added in v0.0.6
type DomainAuthentication struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` Subusers []SubuserSenderAuthentication `json:"subusers,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` }
type Error ¶
type Error struct { Field *string `json:"field,omitempty"` Message *string `json:"message,omitempty"` }
Error is sendgrid error
type ErrorResponse ¶
type ErrorResponse struct {
Error string `json:"error"`
}
ErrorResponse is sendgrid error response
type ErrorsResponse ¶ added in v0.0.16
type ErrorsResponse struct {
Errors []*Error `json:"errors"`
}
ErrorsResponse is sendgrid error response
func (ErrorsResponse) Errs ¶ added in v0.0.16
func (t ErrorsResponse) Errs() error
Errs : error list
type InputAddIPToAuthenticatedDomain ¶ added in v0.0.6
type InputAddIPToAuthenticatedDomain struct {
IP string `json:"ip,omitempty"`
}
type InputAssociateAuthenticatedDomainWithSubuser ¶ added in v0.0.6
type InputAssociateAuthenticatedDomainWithSubuser struct {
Username string `json:"username,omitempty"`
}
type InputAssociateBrandedLinkWithSubuser ¶ added in v0.0.7
type InputAssociateBrandedLinkWithSubuser struct {
Username string `json:"username,omitempty"`
}
type InputAuthenticateDomain ¶ added in v0.0.6
type InputAuthenticateDomain struct { Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` CustomDkimSelector string `json:"custom_dkim_selector,omitempty"` }
type InputCreateAPIKey ¶ added in v0.0.2
type InputCreateBrandedLink ¶ added in v0.0.7
type InputCreateReverseDNS ¶ added in v0.0.17
type InputCreateSSOCertificate ¶ added in v0.0.20
type InputCreateSSOIntegration ¶ added in v0.0.19
type InputCreateSSOIntegration struct { Name string `json:"name,omitempty"` Enabled bool `json:"enabled,omitempty"` SigninURL string `json:"signin_url,omitempty"` SignoutURL string `json:"signout_url,omitempty"` EntityID string `json:"entity_id,omitempty"` CompletedIntegration bool `json:"completed_integration,omitempty"` }
type InputCreateSubuser ¶ added in v0.0.3
type InputCreateSuppressionGroup ¶ added in v0.0.13
type InputCreateTemplate ¶ added in v0.0.14
type InputCreateTemplateVersion ¶ added in v0.0.14
type InputCreateTemplateVersion struct { Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` }
type InputCreateVerifiedSenderRequest ¶ added in v0.0.10
type InputCreateVerifiedSenderRequest struct { Nickname string `json:"nickname,omitempty"` FromEmail string `json:"from_email,omitempty"` FromName string `json:"from_name,omitempty"` ReplyTo string `json:"reply_to,omitempty"` ReplyToName string `json:"reply_to_name,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` State string `json:"state,omitempty"` City string `json:"city,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` }
type InputDuplicateTemplate ¶ added in v0.0.14
type InputDuplicateTemplate struct {
Name string `json:"name,omitempty"`
}
type InputGetAuthenticatedDomains ¶ added in v0.0.6
type InputGetBrandedLinks ¶ added in v0.0.7
type InputGetBrandedLinks struct {
Limit int
}
type InputGetDefaultAuthentication ¶ added in v0.0.6
type InputGetDefaultAuthentication struct {
Domain string
}
type InputGetReverseDNSs ¶ added in v0.0.17
type InputGetSSOIntegrations ¶ added in v0.0.19
type InputGetSSOIntegrations struct {
Si bool `json:"si,omitempty"`
}
type InputGetSubusers ¶ added in v0.0.3
type InputGetTemplates ¶ added in v0.0.14
type InputGetVerifiedSenders ¶ added in v0.0.10
type InputInviteTeammate ¶
type InputUpdateAPIKeyName ¶ added in v0.0.2
type InputUpdateAPIKeyName struct {
Name string `json:"name"`
}
type InputUpdateAPIKeyNameAndScopes ¶ added in v0.0.2
type InputUpdateBrandedLink ¶ added in v0.0.7
type InputUpdateBrandedLink struct {
Default bool `json:"default"`
}
type InputUpdateClickTrackingSettings ¶ added in v0.0.18
type InputUpdateClickTrackingSettings struct {
Enabled bool `json:"enabled,omitempty"`
}
type InputUpdateDomainAuthentication ¶ added in v0.0.6
type InputUpdateEnforceTLS ¶ added in v0.0.15
type InputUpdateGoogleAnalyticsSettings ¶ added in v0.0.18
type InputUpdateGoogleAnalyticsSettings struct { Enabled bool `json:"enabled,omitempty"` UTMCampaign string `json:"utm_campaign,omitempty"` UTMContent string `json:"utm_content,omitempty"` UTMMedium string `json:"utm_medium,omitempty"` UTMSource string `json:"utm_source,omitempty"` UTMTerm string `json:"utm_term,omitempty"` }
type InputUpdateOpenTrackingSettings ¶ added in v0.0.18
type InputUpdateOpenTrackingSettings struct {
Enabled bool `json:"enabled,omitempty"`
}
type InputUpdateSSOCertificate ¶ added in v0.0.19
type InputUpdateSSOIntegration ¶ added in v0.0.19
type InputUpdateSSOIntegration struct { Name string `json:"name,omitempty"` Enabled bool `json:"enabled,omitempty"` SigninURL string `json:"signin_url,omitempty"` SignoutURL string `json:"signout_url,omitempty"` EntityID string `json:"entity_id,omitempty"` CompletedIntegration bool `json:"completed_integration,omitempty"` }
type InputUpdateSubscriptionTrackingSettings ¶ added in v0.0.18
type InputUpdateSubscriptionTrackingSettings struct { Enabled bool `json:"enabled,omitempty"` HTMLContent string `json:"html_content,omitempty"` Landing string `json:"landing,omitempty"` PlainContent string `json:"plain_content,omitempty"` Replace string `json:"replace,omitempty"` URL string `json:"url,omitempty"` }
type InputUpdateSubuserStatus ¶ added in v0.0.3
type InputUpdateSubuserStatus struct {
Disabled bool `json:"disabled"`
}
type InputUpdateSuppressionGroup ¶ added in v0.0.13
type InputUpdateTemplate ¶ added in v0.0.14
type InputUpdateTemplate struct {
Name string `json:"name,omitempty"`
}
type InputUpdateTemplateVersion ¶ added in v0.0.14
type InputUpdateTemplateVersion struct { Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` }
type InputUpdateVerifiedSender ¶ added in v0.0.10
type InputUpdateVerifiedSender struct { Nickname string `json:"nickname,omitempty"` FromEmail string `json:"from_email,omitempty"` FromName string `json:"from_name,omitempty"` ReplyTo string `json:"reply_to,omitempty"` ReplyToName string `json:"reply_to_name,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` State string `json:"state,omitempty"` City string `json:"city,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` }
type OutputActivateTemplateVersion ¶ added in v0.0.14
type OutputActivateTemplateVersion struct { ID string `json:"id,omitempty"` TemplateID string `json:"template_id,omitempty"` Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` UpdatedAt string `json:"updated_at,omitempty"` Warnings []Warning `json:"warnings,omitempty"` ThumbnailURL string `json:"thumbnail_url,omitempty"` }
type OutputAddIPToAuthenticatedDomain ¶ added in v0.0.6
type OutputAddIPToAuthenticatedDomain struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` }
type OutputAssociateAuthenticatedDomainWithSubuser ¶ added in v0.0.6
type OutputAssociateAuthenticatedDomainWithSubuser struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` }
type OutputAssociateBrandedLinkWithSubuser ¶ added in v0.0.7
type OutputAssociateBrandedLinkWithSubuser struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type OutputAuthenticateDomain ¶ added in v0.0.6
type OutputAuthenticateDomain struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` }
type OutputCompletedStepsVerifiedSender ¶ added in v0.0.10
type OutputCompletedStepsVerifiedSender struct {
CompletedStepsVerifiedSender *CompletedStepsVerifiedSender `json:"results,omitempty"`
}
type OutputCreateAPIKey ¶ added in v0.0.2
type OutputCreateBrandedLink ¶ added in v0.0.7
type OutputCreateBrandedLink struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type OutputCreateReverseDNS ¶ added in v0.0.17
type OutputCreateReverseDNS struct { ID int64 `json:"id,omitempty"` IP string `json:"ip,omitempty"` RDNS string `json:"rdns,omitempty"` Users []*User `json:"users,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` ARecord ARecord `json:"a_record,omitempty"` }
type OutputCreateSSOCertificate ¶ added in v0.0.20
type OutputCreateSSOIntegration ¶ added in v0.0.19
type OutputCreateSSOIntegration struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Enabled bool `json:"enabled,omitempty"` SigninURL string `json:"signin_url,omitempty"` SignoutURL string `json:"signout_url,omitempty"` EntityID string `json:"entity_id,omitempty"` CompletedIntegration bool `json:"completed_integration,omitempty"` LastUpdated int64 `json:"last_updated,omitempty"` SingleSignonURL string `json:"single_signon_url,omitempty"` AudienceURL string `json:"audience_url,omitempty"` }
type OutputCreateSubuser ¶ added in v0.0.3
type OutputCreateSuppressionGroup ¶ added in v0.0.13
type OutputCreateTemplate ¶ added in v0.0.14
type OutputCreateTemplateVersion ¶ added in v0.0.14
type OutputCreateTemplateVersion struct { ID string `json:"id,omitempty"` TemplateID string `json:"template_id,omitempty"` Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` UpdatedAt string `json:"updated_at,omitempty"` Warnings []Warning `json:"warnings,omitempty"` ThumbnailURL string `json:"thumbnail_url,omitempty"` }
type OutputCreateVerifiedSenderRequest ¶ added in v0.0.10
type OutputCreateVerifiedSenderRequest struct { ID int64 `json:"id,omitempty"` Nickname string `json:"nickname,omitempty"` FromEmail string `json:"from_email,omitempty"` FromName string `json:"from_name,omitempty"` ReplyTo string `json:"reply_to,omitempty"` ReplyToName string `json:"reply_to_name,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` State string `json:"state,omitempty"` City string `json:"city,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` Verified bool `json:"verified,omitempty"` Locked bool `json:"locked,omitempty"` }
type OutputDuplicateTemplate ¶ added in v0.0.14
type OutputGetAPIKey ¶ added in v0.0.2
type OutputGetAPIKeys ¶ added in v0.0.2
type OutputGetAPIKeys struct {
APIKeys []APIKey `json:"result,omitempty"`
}
type OutputGetAuthenticatedDomain ¶ added in v0.0.6
type OutputGetAuthenticatedDomain struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` }
type OutputGetAuthenticatedDomainAssociatedWithSubuser ¶ added in v0.0.6
type OutputGetAuthenticatedDomainAssociatedWithSubuser struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` }
type OutputGetBrandedLink ¶ added in v0.0.7
type OutputGetBrandedLink struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type OutputGetClickTrackingSettings ¶ added in v0.0.18
type OutputGetDefaultAuthentication ¶ added in v0.0.6
type OutputGetDefaultAuthentication struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` Subusers []SubuserSenderAuthentication `json:"subusers,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` }
type OutputGetDefaultBrandedLink ¶ added in v0.0.7
type OutputGetDefaultBrandedLink struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type OutputGetEnforceTLS ¶ added in v0.0.15
type OutputGetGoogleAnalyticsSettings ¶ added in v0.0.18
type OutputGetGoogleAnalyticsSettings struct { Enabled bool `json:"enabled,omitempty"` UTMCampaign string `json:"utm_campaign,omitempty"` UTMContent string `json:"utm_content,omitempty"` UTMMedium string `json:"utm_medium,omitempty"` UTMSource string `json:"utm_source,omitempty"` UTMTerm string `json:"utm_term,omitempty"` }
type OutputGetOpenTrackingSettings ¶ added in v0.0.18
type OutputGetOpenTrackingSettings struct {
Enabled bool `json:"enabled,omitempty"`
}
type OutputGetPendingTeammates ¶
type OutputGetPendingTeammates struct {
PendingTeammates []PendingTeammate `json:"result,omitempty"`
}
type OutputGetReverseDNS ¶ added in v0.0.17
type OutputGetReverseDNS struct { ID int64 `json:"id,omitempty"` IP string `json:"ip,omitempty"` RDNS string `json:"rdns,omitempty"` Users []*User `json:"users,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` ARecord ARecord `json:"a_record,omitempty"` }
type OutputGetSSOCertificate ¶ added in v0.0.19
type OutputGetSSOIntegration ¶ added in v0.0.19
type OutputGetSSOIntegration struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Enabled bool `json:"enabled,omitempty"` SigninURL string `json:"signin_url,omitempty"` SignoutURL string `json:"signout_url,omitempty"` EntityID string `json:"entity_id,omitempty"` CompletedIntegration bool `json:"completed_integration,omitempty"` LastUpdated int64 `json:"last_updated,omitempty"` SingleSignonURL string `json:"single_signon_url,omitempty"` AudienceURL string `json:"audience_url,omitempty"` }
type OutputGetSubscriptionTrackingSettings ¶ added in v0.0.18
type OutputGetSubscriptionTrackingSettings struct { Enabled bool `json:"enabled,omitempty"` HTMLContent string `json:"html_content,omitempty"` Landing string `json:"landing,omitempty"` PlainContent string `json:"plain_content,omitempty"` Replace string `json:"replace,omitempty"` URL string `json:"url,omitempty"` }
type OutputGetSubuserBrandedLink ¶ added in v0.0.7
type OutputGetSubuserBrandedLink struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type OutputGetTeammate ¶
type OutputGetTeammate struct { Username string `json:"username,omitempty"` FirstName string `json:"first_name,omitempty"` LastName string `json:"last_name,omitempty"` Email string `json:"email,omitempty"` Scopes []string `json:"scopes,omitempty"` UserType string `json:"user_type,omitempty"` IsAdmin bool `json:"is_admin,omitempty"` Phone string `json:"phone,omitempty"` Website string `json:"website,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` City string `json:"city,omitempty"` State string `json:"state,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` }
type OutputGetTeammates ¶
type OutputGetTeammates struct {
Teammates []Teammate `json:"result,omitempty"`
}
type OutputGetTemplate ¶ added in v0.0.14
type OutputGetTemplateVersion ¶ added in v0.0.14
type OutputGetTemplateVersion struct { ID string `json:"id,omitempty"` TemplateID string `json:"template_id,omitempty"` Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` UpdatedAt string `json:"updated_at,omitempty"` Warnings Warning `json:"warnings,omitempty"` ThumbnailURL string `json:"thumbnail_url,omitempty"` }
type OutputGetTemplates ¶ added in v0.0.14
type OutputGetTrackingSettings ¶ added in v0.0.18
type OutputGetTrackingSettings struct {
Result []*ResultGetTrackingSettings `json:"result,omitempty"`
}
type OutputGetVerifiedSenders ¶ added in v0.0.10
type OutputGetVerifiedSenders struct {
VerifiedSenders []*VerifiedSender `json:"results,omitempty"`
}
type OutputInviteTeammate ¶
type OutputUpdateAPIKeyName ¶ added in v0.0.2
type OutputUpdateAPIKeyNameAndScopes ¶ added in v0.0.2
type OutputUpdateBrandedLink ¶ added in v0.0.7
type OutputUpdateBrandedLink struct { ID int64 `json:"id,omitempty"` Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` UserID int64 `json:"user_id,omitempty"` Default bool `json:"default,omitempty"` Valid bool `json:"valid,omitempty"` Legacy bool `json:"legacy,omitempty"` DNS DNSBrandedLink `json:"dns,omitempty"` }
type OutputUpdateClickTrackingSettings ¶ added in v0.0.18
type OutputUpdateDomainAuthentication ¶ added in v0.0.6
type OutputUpdateDomainAuthentication struct { ID int64 `json:"id,omitempty"` UserID int64 `json:"user_id,omitempty"` Subdomain string `json:"subdomain,omitempty"` Domain string `json:"domain,omitempty"` Username string `json:"username,omitempty"` IPs []string `json:"ips,omitempty"` CustomSpf bool `json:"custom_spf,omitempty"` Default bool `json:"default,omitempty"` Legacy bool `json:"legacy,omitempty"` AutomaticSecurity bool `json:"automatic_security,omitempty"` Valid bool `json:"valid,omitempty"` DNS DNS `json:"dns,omitempty"` Subusers []SubuserSenderAuthentication `json:"subusers,omitempty"` LastValidationAttemptAt int64 `json:"last_validation_attempt_at,omitempty"` }
type OutputUpdateEnforceTLS ¶ added in v0.0.15
type OutputUpdateGoogleAnalyticsSettings ¶ added in v0.0.18
type OutputUpdateGoogleAnalyticsSettings struct { Enabled bool `json:"enabled,omitempty"` UTMCampaign string `json:"utm_campaign,omitempty"` UTMContent string `json:"utm_content,omitempty"` UTMMedium string `json:"utm_medium,omitempty"` UTMSource string `json:"utm_source,omitempty"` UTMTerm string `json:"utm_term,omitempty"` }
type OutputUpdateOpenTrackingSettings ¶ added in v0.0.18
type OutputUpdateOpenTrackingSettings struct {
Enabled bool `json:"enabled,omitempty"`
}
type OutputUpdateSSOCertificate ¶ added in v0.0.19
type OutputUpdateSSOIntegration ¶ added in v0.0.19
type OutputUpdateSSOIntegration struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Enabled bool `json:"enabled,omitempty"` SigninURL string `json:"signin_url,omitempty"` SignoutURL string `json:"signout_url,omitempty"` EntityID string `json:"entity_id,omitempty"` CompletedIntegration bool `json:"completed_integration,omitempty"` LastUpdated int64 `json:"last_updated,omitempty"` SingleSignonURL string `json:"single_signon_url,omitempty"` AudienceURL string `json:"audience_url,omitempty"` }
type OutputUpdateSubscriptionTrackingSettings ¶ added in v0.0.18
type OutputUpdateSubscriptionTrackingSettings struct { Enabled bool `json:"enabled,omitempty"` HTMLContent string `json:"html_content,omitempty"` Landing string `json:"landing,omitempty"` PlainContent string `json:"plain_content,omitempty"` Replace string `json:"replace,omitempty"` URL string `json:"url,omitempty"` }
type OutputUpdateSuppressionGroup ¶ added in v0.0.13
type OutputUpdateSuppressionGroup struct { ID int64 `json:"id,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` IsDefault bool `json:"is_default,omitempty"` LastEmailSentAt string `json:"last_email_sent_at,omitempty"` Unsubscribes int64 `json:"unsubscribes,omitempty"` }
type OutputUpdateTeammatePermissions ¶
type OutputUpdateTeammatePermissions struct { Username string `json:"username,omitempty"` FirstName string `json:"first_name,omitempty"` LastName string `json:"last_name,omitempty"` Email string `json:"email,omitempty"` Scopes []string `json:"scopes,omitempty"` UserType string `json:"user_type,omitempty"` IsAdmin bool `json:"is_admin,omitempty"` Phone string `json:"phone,omitempty"` Website string `json:"website,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` City string `json:"city,omitempty"` State string `json:"state,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` }
type OutputUpdateTemplate ¶ added in v0.0.14
type OutputUpdateTemplateVersion ¶ added in v0.0.14
type OutputUpdateTemplateVersion struct { ID string `json:"id,omitempty"` TemplateID string `json:"template_id,omitempty"` Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` UpdatedAt string `json:"updated_at,omitempty"` Warnings []Warning `json:"warnings,omitempty"` ThumbnailURL string `json:"thumbnail_url,omitempty"` }
type OutputUpdateVerifiedSender ¶ added in v0.0.10
type OutputUpdateVerifiedSender struct { ID int64 `json:"id,omitempty"` Nickname string `json:"nickname,omitempty"` FromEmail string `json:"from_email,omitempty"` FromName string `json:"from_name,omitempty"` ReplyTo string `json:"reply_to,omitempty"` ReplyToName string `json:"reply_to_name,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` State string `json:"state,omitempty"` City string `json:"city,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` Verified bool `json:"verified,omitempty"` Locked bool `json:"locked,omitempty"` }
type OutputValidateBrandedLink ¶ added in v0.0.7
type OutputValidateBrandedLink struct { ID int64 `json:"id,omitempty"` Valid bool `json:"valid,omitempty"` ValidationResults ValidationResultsBrandedLink `json:"validation_results,omitempty"` }
type OutputValidateDomainAuthentication ¶ added in v0.0.6
type OutputValidateDomainAuthentication struct { ID int64 `json:"id,omitempty"` Valid bool `json:"valid,omitempty"` ValidationResults ValidationResults `json:"validation_results,omitempty"` }
type OutputValidateReverseDNS ¶ added in v0.0.17
type OutputValidateReverseDNS struct { ID int64 `json:"id,omitempty"` Valid bool `json:"valid,omitempty"` ValidationResults ValidationResultsReverseDNS `json:"validation_results,omitempty"` }
type PendingTeammate ¶
type RateLimitedError ¶ added in v1.0.0
func (*RateLimitedError) Error ¶ added in v1.0.0
func (e *RateLimitedError) Error() string
type Reputation ¶ added in v0.0.3
type ResultGetTrackingSettings ¶ added in v0.0.18
type SSOCertificate ¶ added in v0.0.19
type SSOIntegration ¶ added in v0.0.19
type SSOIntegration struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Enabled bool `json:"enabled,omitempty"` SigninURL string `json:"signin_url,omitempty"` SignoutURL string `json:"signout_url,omitempty"` EntityID string `json:"entity_id,omitempty"` CompletedIntegration bool `json:"completed_integration,omitempty"` LastUpdated int64 `json:"last_updated,omitempty"` SingleSignonURL string `json:"single_signon_url,omitempty"` AudienceURL string `json:"audience_url,omitempty"` }
type SubuserSenderAuthentication ¶ added in v0.0.6
type SuppressionGroup ¶ added in v0.0.13
type SuppressionGroup struct { ID int64 `json:"id,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` IsDefault bool `json:"is_default,omitempty"` Unsubscribes int64 `json:"unsubscribes,omitempty"` LastEmailSentAt string `json:"last_email_sent_at,omitempty"` }
type Teammate ¶
type Teammate struct { Username string `json:"username,omitempty"` Email string `json:"email,omitempty"` FirstName string `json:"first_name,omitempty"` LastName string `json:"last_name,omitempty"` UserType string `json:"user_type,omitempty"` IsAdmin bool `json:"is_admin,omitempty"` Phone string `json:"phone,omitempty"` Website string `json:"website,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` City string `json:"city,omitempty"` State string `json:"state,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` }
type ValidationResult ¶ added in v0.0.6
type ValidationResults ¶ added in v0.0.6
type ValidationResults struct { MailCname ValidationResult `json:"mail_cname,omitempty"` Dkim1 ValidationResult `json:"dkim1,omitempty"` Dkim2 ValidationResult `json:"dkim2,omitempty"` SPF ValidationResult `json:"spf,omitempty"` }
type ValidationResultsBrandedLink ¶ added in v0.0.7
type ValidationResultsBrandedLink struct { DomainCname ValidationResult `json:"domain_cname,omitempty"` OwnerCname ValidationResult `json:"owner_cname,omitempty"` }
type ValidationResultsReverseDNS ¶ added in v0.0.17
type ValidationResultsReverseDNS struct {
ARecordValidationResults ARecordValidationResults `json:"a_record,omitempty"`
}
type VerifiedSender ¶ added in v0.0.10
type VerifiedSender struct { ID int64 `json:"id,omitempty"` Nickname string `json:"nickname,omitempty"` FromEmail string `json:"from_email,omitempty"` FromName string `json:"from_name,omitempty"` ReplyTo string `json:"reply_to,omitempty"` ReplyToName string `json:"reply_to_name,omitempty"` Address string `json:"address,omitempty"` Address2 string `json:"address2,omitempty"` State string `json:"state,omitempty"` City string `json:"city,omitempty"` Zip string `json:"zip,omitempty"` Country string `json:"country,omitempty"` Verified bool `json:"verified,omitempty"` Locked bool `json:"locked,omitempty"` }
type Version ¶ added in v0.0.14
type Version struct { ID string `json:"id,omitempty"` TemplateID string `json:"template_id,omitempty"` Name string `json:"name,omitempty"` Subject string `json:"subject,omitempty"` UpdatedAt string `json:"updated_at,omitempty"` GeneratePlainContent bool `json:"generate_plain_content,omitempty"` HTMLContent string `json:"html_content,omitempty"` PlainContent string `json:"plain_content,omitempty"` Editor string `json:"editor,omitempty"` ThumbnailURL string `json:"thumbnail_url,omitempty"` }