Documentation
¶
Index ¶
- Variables
- func ParseDomainAuthentication(respBody string) (*DomainAuthentication, RequestError)
- func RetryOnRateLimit(ctx context.Context, d *schema.ResourceData, ...) (interface{}, error)
- type APIKey
- type Client
- func (c *Client) ConfigureEventWebhookSigning(enabled bool) (*EventWebhookSigning, RequestError)
- func (c *Client) CreateAPIKey(req *APIKey) (*APIKey, RequestError)
- func (c *Client) CreateDomainAuthentication(domain string, subdomain string, ips []string, customSpf bool, isDefault bool, ...) (*DomainAuthentication, RequestError)
- func (c *Client) CreateLinkBranding(domain string, subdomain string, isDefault bool) (*LinkBranding, RequestError)
- func (c *Client) CreateParseWebhook(hostname string, url string, spamCheck bool, sendRaw bool) (*ParseWebhook, RequestError)
- func (c Client) CreateSSOCertificate(publicCertificate string, integrationID string) (*SSOCertificate, RequestError)
- func (c Client) CreateSSOIntegration(name string, enabled bool, signInURL string, signOutURL string, ...) (*SSOIntegration, RequestError)
- func (c *Client) CreateSubuser(username, email, password string, ips []string) (*SubUser, RequestError)
- func (c *Client) CreateTemplate(name, generation string) (*Template, error)
- func (c *Client) CreateTemplateVersion(t TemplateVersion) (*TemplateVersion, error)
- func (c *Client) CreateUnsubscribeGroup(name string, description string, isDefault bool) (*UnsubscribeGroup, RequestError)
- func (c *Client) DeleteAPIKey(id string) (bool, *RequestError)
- func (c *Client) DeleteDomainAuthentication(id string) (bool, RequestError)
- func (c *Client) DeleteLinkBranding(id string) (bool, RequestError)
- func (c *Client) DeleteParseWebhook(hostname string) (bool, RequestError)
- func (c Client) DeleteSSOCertificate(id string) (bool, RequestError)
- func (c Client) DeleteSSOIntegration(id string) (bool, RequestError)
- func (c *Client) DeleteSubuser(username string) (bool, RequestError)
- func (c *Client) DeleteTemplate(id string) (bool, *RequestError)
- func (c *Client) DeleteTemplateVersion(templateID, id string) (bool, error)
- func (c *Client) DeleteUnsubscribeGroup(id string) (bool, RequestError)
- func (c *Client) Get(method rest.Method, endpoint string) (string, int, error)
- func (c Client) ListSSOCertificates() ([]*SSOCertificate, RequestError)
- func (c Client) ListSSOIntegrations() ([]*SSOIntegration, RequestError)
- func (c *Client) PatchEventWebhook(enabled bool, url string, groupResubscribe bool, delivered bool, ...) (*EventWebhook, RequestError)
- func (c *Client) Post(method rest.Method, endpoint string, body interface{}) (string, int, error)
- func (c *Client) ReadAPIKey(id string) (*APIKey, RequestError)
- func (c *Client) ReadAPIKeys() ([]APIKey, RequestError)
- func (c *Client) ReadDomainAuthentication(id string) (*DomainAuthentication, RequestError)
- func (c *Client) ReadEventWebhook() (*EventWebhook, RequestError)
- func (c *Client) ReadEventWebhookSigning() (*EventWebhookSigning, RequestError)
- func (c *Client) ReadLinkBranding(id string) (*LinkBranding, RequestError)
- func (c *Client) ReadParseWebhook(hostname string) (*ParseWebhook, RequestError)
- func (c Client) ReadSSOCertificate(id string) (*SSOCertificate, RequestError)
- func (c Client) ReadSSOIntegration(id string) (*SSOIntegration, RequestError)
- func (c *Client) ReadSubUser(username string) ([]SubUser, RequestError)
- func (c *Client) ReadTemplate(id string) (*Template, error)
- func (c *Client) ReadTemplateVersion(templateID, id string) (*TemplateVersion, error)
- func (c *Client) ReadTemplates(generation string) ([]Template, error)
- func (c *Client) ReadUnsubscribeGroup(id string) (*UnsubscribeGroup, RequestError)
- func (c *Client) ReadUnsubscribeGroups() ([]UnsubscribeGroup, RequestError)
- func (c *Client) UpdateAPIKey(id string, req *APIKey) (*APIKey, RequestError)
- func (c *Client) UpdateDomainAuthentication(id string, isDefault bool, customSPF bool) (*DomainAuthentication, RequestError)
- func (c *Client) UpdateLinkBranding(id string, isDefault bool) (*LinkBranding, RequestError)
- func (c *Client) UpdateParseWebhook(hostname string, spamCheck bool, sendRaw bool) RequestError
- func (c Client) UpdateSSOCertificate(id string, publicCertificate string, integrationID string) (*SSOCertificate, RequestError)
- func (c Client) UpdateSSOIntegration(id string, name string, enabled bool, signInURL string, signOutURL string, ...) (*SSOIntegration, RequestError)
- func (c *Client) UpdateSubuser(username string, disabled bool) (bool, RequestError)
- func (c *Client) UpdateSubuserIPs(username string, ips []string) RequestError
- func (c *Client) UpdateSubuserPassword(username string, oldPassword string, newPassword string) RequestError
- func (c *Client) UpdateTemplate(id, name string) (*Template, error)
- func (c *Client) UpdateTemplateVersion(t TemplateVersion) (*TemplateVersion, error)
- func (c *Client) UpdateUnsubscribeGroup(id string, name string, description string, isDefault bool) (*UnsubscribeGroup, RequestError)
- func (c *Client) ValidateDomainAuthentication(id string) RequestError
- func (c *Client) ValidateLinkBranding(id string) RequestError
- type DomainAuthentication
- type DomainAuthenticationDNS
- type DomainAuthenticationDNSValue
- type EventWebhook
- type EventWebhookSigning
- type LinkBranding
- type LinkBrandingDNS
- type LinkBrandingDNSValue
- type ParseWebhook
- type RequestError
- type SSOCertificate
- type SSOIntegration
- type SubUser
- type Template
- type TemplateVersion
- type Templates
- type UnsubscribeGroup
- type UpdateSubUserPassword
Constants ¶
This section is empty.
Variables ¶
var ( // ErrBodyNotNil low error displayed when the prepared body for a POST call // to the API is nil. ErrBodyNotNil = errors.New("body must not be nil") // ErrNameRequired error displayed when an api key name wasn't specified. ErrNameRequired = errors.New("a name is required") // ErrAPIKeyIDRequired error displayed when an api key ID wasn't specified. ErrAPIKeyIDRequired = errors.New("an API Key ID is required") // ErrFailedCreatingAPIKey error displayed when the provider can not create an api key. ErrFailedCreatingAPIKey = errors.New("failed creating apiKey") // ErrFailedDeletingAPIKey error displayed when the provider can not delete an api key. ErrFailedDeletingAPIKey = errors.New("failed deleting apiKey") // ErrUsernameRequired error displayed when a subUser username wasn't specified. ErrUsernameRequired = errors.New("a username is required") // ErrEmailRequired error displayed when a subUser email wasn't specified. ErrEmailRequired = errors.New("an email is required") // ErrPasswordRequired error displayed when a subUser password wasn't specified. ErrPasswordRequired = errors.New("a password is required") // ErrIPRequired error displayed when at least one IP per subUser wasn't specified. ErrIPRequired = errors.New("at least one ip address is required") // ErrFailedCreatingSubUser error displayed when the provider can not create a subuser. ErrFailedCreatingSubUser = errors.New("failed creating subUser") // ErrFailedDeletingSubUser error displayed when the provider can not delete a subuser. ErrFailedDeletingSubUser = errors.New("failed deleting subUser") // ErrFailedCreatingTemplate ErrFailedCreatingTemplate = errors.New("failed creating template") // ErrFailedGettingTemplate ErrFailedGettingTemplate = errors.New("failed getting template") // ErrFailedUpdatingTemplate ErrFailedUpdatingTemplate = errors.New("failed updating template") // ErrTemplateIDRequired error displayed when a template ID wasn't specified. ErrTemplateIDRequired = errors.New("a template ID is required") // ErrTemplateNameRequired error displayed when a template name wasn't specified. ErrTemplateNameRequired = errors.New("a template name is required") // ErrTemplateVersionIDRequired error displayed when a template version ID wasn't specified. ErrTemplateVersionIDRequired = errors.New("a template version ID is required") // ErrTemplateVersionNameRequired error displayed when a template version ID wasn't specified. ErrTemplateVersionNameRequired = errors.New("a template version name is required") // ErrTemplateVersionSubjectRequired error displayed when a template version subject wasn't specified. ErrTemplateVersionSubjectRequired = errors.New("a template version subject is required") ErrFailedCreatingUnsubscribeGroup = errors.New("failed to create unsubscribe list") ErrUnsubscribeGroupIDRequired = errors.New("unsubscribe list id is required") ErrFailedDeletingUnsubscribeGroup = errors.New("failed deleting unsubscribe list") ErrFailedCreatingParseWebhook = errors.New("failed to create parse webhook") ErrFailedDeletingParseWebhook = errors.New("failed deleting parse webhook") ErrHostnameRequired = errors.New("a hostname is required") ErrURLRequired = errors.New("a url is required") ErrFailedPatchingEventWebhook = errors.New("failed to patch event webhook") ErrFailedCreatingDomainAuthentication = errors.New("failed to create domain authentication") ErrDomainAuthenticationIDRequired = errors.New("id for domain authentication is required") ErrFailedDeletingDomainAuthentication = errors.New("failed deleting domain authentication") ErrLinkBrandingIDRequired = errors.New("link branding id is required") ErrFailedDeletingLinkBranding = errors.New("failed to delete link branding") ErrFailedCreatingLinkBranding = errors.New("failed to create link branding") // ErrSubUserPassword should be empty. ErrSubUserPassword = errors.New("new password must be non empty") // ErrSSOIntegrationMissingField error displayed when a required SSO integration field is not specified. ErrSSOIntegrationMissingField = errors.New("SSO integration field is missing") // ErrFailedCreatingSSOIntegration error displayed when an SSO integration creation request fails. ErrFailedCreatingSSOIntegration = errors.New("failed to create SSO integration") // ErrFailedUpdatingSSOIntegration error displayed when an SSO integration update request fails. ErrFailedUpdatingSSOIntegration = errors.New("failed to update SSO integration") // ErrSSOCertificateMissingField error displayed when a required SSO certificate field is not specified. ErrSSOCertificateMissingField = errors.New("SSO certificate field is missing") // ErrFailedCreatingSSOCertificate error displayed when an SSO certificate creation request fails. ErrFailedCreatingSSOCertificate = errors.New("failed to create SSO certificate") // ErrFailedUpdatingSSOCertificate error displayed when an SSO certificate update request fails. ErrFailedUpdatingSSOCertificate = errors.New("failed to update SSO certificate") )
Functions ¶
func ParseDomainAuthentication ¶
func ParseDomainAuthentication(respBody string) (*DomainAuthentication, RequestError)
func RetryOnRateLimit ¶
func RetryOnRateLimit( ctx context.Context, d *schema.ResourceData, f func() (interface{}, RequestError)) (interface{}, error)
RetryOnRateLimit management of RequestErrors, and launch a retry if needed.
Types ¶
type APIKey ¶
type APIKey struct { ID string `json:"api_key_id,omitempty"` APIKey string `json:"api_key,omitempty"` Name string `json:"name,omitempty"` Scopes []string `json:"scopes,omitempty"` }
APIKey is a Sendgrid API key.
type Client ¶
type Client struct { OnBehalfOf string // contains filtered or unexported fields }
Client is a Sendgrid client.
func (*Client) ConfigureEventWebhookSigning ¶
func (c *Client) ConfigureEventWebhookSigning(enabled bool) (*EventWebhookSigning, RequestError)
func (*Client) CreateAPIKey ¶
func (c *Client) CreateAPIKey(req *APIKey) (*APIKey, RequestError)
CreateAPIKey creates an APIKey and returns it.
func (*Client) CreateDomainAuthentication ¶
func (c *Client) CreateDomainAuthentication( domain string, subdomain string, ips []string, customSpf bool, isDefault bool, automaticSecurity bool, customDKIMSelector string) (*DomainAuthentication, RequestError)
CreateDomainAuthentication creates an DomainAuthentication and returns it.
func (*Client) CreateLinkBranding ¶
func (c *Client) CreateLinkBranding(domain string, subdomain string, isDefault bool) (*LinkBranding, RequestError)
CreateLinkBranding creates an LinkBranding and returns it.
func (*Client) CreateParseWebhook ¶
func (c *Client) CreateParseWebhook( hostname string, url string, spamCheck bool, sendRaw bool) (*ParseWebhook, RequestError)
CreateParseWebhook creates an ParseWebhook and returns it.
func (Client) CreateSSOCertificate ¶
func (c Client) CreateSSOCertificate( publicCertificate string, integrationID string, ) (*SSOCertificate, RequestError)
CreateSSOCertificate creates an SSO certificate and returns it.
func (Client) CreateSSOIntegration ¶
func (c Client) CreateSSOIntegration( name string, enabled bool, signInURL string, signOutURL string, entityID string, ) (*SSOIntegration, RequestError)
CreateSSOIntegration creates an SSO integration and returns it.
func (*Client) CreateSubuser ¶
func (c *Client) CreateSubuser(username, email, password string, ips []string) (*SubUser, RequestError)
CreateSubuser creates a subuser and returns it.
func (*Client) CreateTemplate ¶
CreateTemplate creates a transactional template and returns it.
func (*Client) CreateTemplateVersion ¶
func (c *Client) CreateTemplateVersion(t TemplateVersion) (*TemplateVersion, error)
CreateTemplateVersion creates a new version of a transactional template and returns it.
func (*Client) CreateUnsubscribeGroup ¶
func (c *Client) CreateUnsubscribeGroup( name string, description string, isDefault bool) (*UnsubscribeGroup, RequestError)
CreateUnsubscribeGroup creates an UnsubscribeGroup and returns it.
func (*Client) DeleteAPIKey ¶
func (c *Client) DeleteAPIKey(id string) (bool, *RequestError)
DeleteAPIKey deletes an APIKey.
func (*Client) DeleteDomainAuthentication ¶
func (c *Client) DeleteDomainAuthentication(id string) (bool, RequestError)
DeleteDomainAuthentication deletes an DomainAuthentication.
func (*Client) DeleteLinkBranding ¶
func (c *Client) DeleteLinkBranding(id string) (bool, RequestError)
DeleteLinkBranding deletes an LinkBranding.
func (*Client) DeleteParseWebhook ¶
func (c *Client) DeleteParseWebhook(hostname string) (bool, RequestError)
DeleteParseWebhook deletes an ParseWebhook.
func (Client) DeleteSSOCertificate ¶
func (c Client) DeleteSSOCertificate(id string) (bool, RequestError)
DeleteSSOCertificate deletes an SSO certificate by ID.
func (Client) DeleteSSOIntegration ¶
func (c Client) DeleteSSOIntegration(id string) (bool, RequestError)
DeleteSSOIntegration deletes an SSO integration by ID.
func (*Client) DeleteSubuser ¶
func (c *Client) DeleteSubuser(username string) (bool, RequestError)
DeleteSubuser deletes a subuser.
func (*Client) DeleteTemplate ¶
func (c *Client) DeleteTemplate(id string) (bool, *RequestError)
DeleteTemplate deletes a transactional template.
func (*Client) DeleteTemplateVersion ¶
DeleteTemplateVersion deletes a version of a transactional template.
func (*Client) DeleteUnsubscribeGroup ¶
func (c *Client) DeleteUnsubscribeGroup(id string) (bool, RequestError)
DeleteUnsubscribeGroup deletes an UnsubscribeGroup.
func (Client) ListSSOCertificates ¶
func (c Client) ListSSOCertificates() ([]*SSOCertificate, RequestError)
ListSSOCertificates retrieves all existing SSO certificates.
func (Client) ListSSOIntegrations ¶
func (c Client) ListSSOIntegrations() ([]*SSOIntegration, RequestError)
ListSSOIntegrations returns a list of SSO integrations.
func (*Client) PatchEventWebhook ¶
func (c *Client) PatchEventWebhook( enabled bool, url string, groupResubscribe bool, delivered bool, groupUnsubscribe bool, spamReport bool, bounce bool, deferred bool, unsubscribe bool, processed bool, open bool, click bool, dropped bool, oauthClientID string, oauthClientSecret string, oauthTokenURL string) (*EventWebhook, RequestError)
CreateEventWebhook creates an EventWebhook and returns it.
func (*Client) ReadAPIKey ¶
func (c *Client) ReadAPIKey(id string) (*APIKey, RequestError)
ReadAPIKey retreives an APIKey and returns it.
func (*Client) ReadAPIKeys ¶
func (c *Client) ReadAPIKeys() ([]APIKey, RequestError)
func (*Client) ReadDomainAuthentication ¶
func (c *Client) ReadDomainAuthentication(id string) (*DomainAuthentication, RequestError)
ReadDomainAuthentication retrieves an DomainAuthentication and returns it.
func (*Client) ReadEventWebhook ¶
func (c *Client) ReadEventWebhook() (*EventWebhook, RequestError)
ReadEventWebhook retrieves an EventWebhook and returns it.
func (*Client) ReadEventWebhookSigning ¶
func (c *Client) ReadEventWebhookSigning() (*EventWebhookSigning, RequestError)
func (*Client) ReadLinkBranding ¶
func (c *Client) ReadLinkBranding(id string) (*LinkBranding, RequestError)
ReadLinkBranding retrieves an LinkBranding and returns it.
func (*Client) ReadParseWebhook ¶
func (c *Client) ReadParseWebhook(hostname string) (*ParseWebhook, RequestError)
ReadParseWebhook retreives an ParseWebhook and returns it.
func (Client) ReadSSOCertificate ¶
func (c Client) ReadSSOCertificate(id string) (*SSOCertificate, RequestError)
ReadSSOCertificate retrieves an SSO certificate by ID.
func (Client) ReadSSOIntegration ¶
func (c Client) ReadSSOIntegration(id string) (*SSOIntegration, RequestError)
ReadSSOIntegration retrieves an SSO integration by ID.
func (*Client) ReadSubUser ¶
func (c *Client) ReadSubUser(username string) ([]SubUser, RequestError)
ReadSubUser retreives a subuser and returns it.
func (*Client) ReadTemplate ¶
ReadTemplate retreives a transactional template and returns it.
func (*Client) ReadTemplateVersion ¶
func (c *Client) ReadTemplateVersion(templateID, id string) (*TemplateVersion, error)
ReadTemplateVersion retreives a version of a transactional template and returns it.
func (*Client) ReadTemplates ¶
func (*Client) ReadUnsubscribeGroup ¶
func (c *Client) ReadUnsubscribeGroup(id string) (*UnsubscribeGroup, RequestError)
ReadUnsubscribeGroup retreives an UnsubscribeGroup and returns it.
func (*Client) ReadUnsubscribeGroups ¶
func (c *Client) ReadUnsubscribeGroups() ([]UnsubscribeGroup, RequestError)
ReadUnsubscribeGroups retrieves all UnsubscribeGroup and returns them.
func (*Client) UpdateAPIKey ¶
func (c *Client) UpdateAPIKey(id string, req *APIKey) (*APIKey, RequestError)
UpdateAPIKey edits an APIKey and returns it.
func (*Client) UpdateDomainAuthentication ¶
func (c *Client) UpdateDomainAuthentication( id string, isDefault bool, customSPF bool) (*DomainAuthentication, RequestError)
UpdateDomainAuthentication edits an DomainAuthentication and returns it.
func (*Client) UpdateLinkBranding ¶
func (c *Client) UpdateLinkBranding(id string, isDefault bool) (*LinkBranding, RequestError)
UpdateLinkBranding edits an LinkBranding and returns it.
func (*Client) UpdateParseWebhook ¶
func (c *Client) UpdateParseWebhook(hostname string, spamCheck bool, sendRaw bool) RequestError
UpdateParseWebhook edits an ParseWebhook and returns it.
func (Client) UpdateSSOCertificate ¶
func (c Client) UpdateSSOCertificate( id string, publicCertificate string, integrationID string, ) (*SSOCertificate, RequestError)
UpdateSSOCertificate updates an existing SSO certificate by ID.
func (Client) UpdateSSOIntegration ¶
func (c Client) UpdateSSOIntegration( id string, name string, enabled bool, signInURL string, signOutURL string, entityID string, ) (*SSOIntegration, RequestError)
UpdateSSOIntegration updates an existing SSO integration by ID.
func (*Client) UpdateSubuser ¶
func (c *Client) UpdateSubuser(username string, disabled bool) (bool, RequestError)
UpdateSubuser enables/disables a subuser.
func (*Client) UpdateSubuserIPs ¶
func (c *Client) UpdateSubuserIPs(username string, ips []string) RequestError
func (*Client) UpdateSubuserPassword ¶
func (c *Client) UpdateSubuserPassword(username string, oldPassword string, newPassword string) RequestError
func (*Client) UpdateTemplate ¶
UpdateTemplate edits a transactional template and returns it. We can't change the "generation" of a transactional template.
func (*Client) UpdateTemplateVersion ¶
func (c *Client) UpdateTemplateVersion(t TemplateVersion) (*TemplateVersion, error)
UpdateTemplateVersion edits a version of a transactional template and returns it.
func (*Client) UpdateUnsubscribeGroup ¶
func (c *Client) UpdateUnsubscribeGroup( id string, name string, description string, isDefault bool) (*UnsubscribeGroup, RequestError)
UpdateUnsubscribeGroup edits an UnsubscribeGroup and returns it.
func (*Client) ValidateDomainAuthentication ¶
func (c *Client) ValidateDomainAuthentication(id string) RequestError
func (*Client) ValidateLinkBranding ¶
func (c *Client) ValidateLinkBranding(id string) RequestError
type DomainAuthentication ¶
type DomainAuthentication struct { ID int32 `json:"id,omitempty"` UserID int32 `json:"user_id,omitempty"` //nolint:tagliatelle 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"` //nolint:tagliatelle IsDefault bool `json:"default"` AutomaticSecurity bool `json:"automatic_security"` //nolint:tagliatelle CustomDKIMSelector string `json:"custom_dkim_selector"` //nolint:tagliatelle Legacy bool `json:"legacy,omitempty"` Valid bool `json:"valid,omitempty"` DNS DomainAuthenticationDNS `json:"dns,omitempty"` }
DomainAuthentication is a Sendgrid domain authentication.
type DomainAuthenticationDNS ¶
type DomainAuthenticationDNS struct { MailCNAME DomainAuthenticationDNSValue `json:"mail_cname,omitempty"` //nolint:tagliatelle DKIM1 DomainAuthenticationDNSValue `json:"dkim1,omitempty"` DKIM2 DomainAuthenticationDNSValue `json:"dkim2,omitempty"` MailServer DomainAuthenticationDNSValue `json:"mail_server,omitempty"` //nolint:tagliatelle SubDomainSPF DomainAuthenticationDNSValue `json:"subdomain_spf,omitempty"` //nolint:tagliatelle DKIM DomainAuthenticationDNSValue `json:"dkim,omitempty"` }
type EventWebhook ¶
type EventWebhook struct { Enabled bool `json:"enabled"` URL string `json:"url,omitempty"` GroupResubscribe bool `json:"group_resubscribe"` //nolint:tagliatelle Delivered bool `json:"delivered"` GroupUnsubscribe bool `json:"group_unsubscribe"` //nolint:tagliatelle SpamReport bool `json:"spam_report"` //nolint:tagliatelle Bounce bool `json:"bounce"` Deferred bool `json:"deferred"` Unsubscribe bool `json:"unsubscribe"` Processed bool `json:"processed"` Open bool `json:"open"` Click bool `json:"click"` Dropped bool `json:"dropped"` OAuthClientID string `json:"oauth_client_id,omitempty"` //nolint:tagliatelle OAuthClientSecret string `json:"oauth_client_secret,omitempty"` //nolint:tagliatelle OAuthTokenURL string `json:"oauth_token_url,omitempty"` //nolint:tagliatelle }
EventWebhook is a Sendgrid event webhook settings.
type EventWebhookSigning ¶
type LinkBranding ¶
type LinkBranding struct { ID int32 `json:"id,omitempty"` UserID int32 `json:"user_id,omitempty"` //nolint:tagliatelle Domain string `json:"domain,omitempty"` Subdomain string `json:"subdomain,omitempty"` Username string `json:"username,omitempty"` IsDefault bool `json:"default"` Legacy bool `json:"legacy,omitempty"` Valid bool `json:"valid,omitempty"` DNS LinkBrandingDNS `json:"dns,omitempty"` }
LinkBranding is a Sendgrid domain authentication.
type LinkBrandingDNS ¶
type LinkBrandingDNS struct { DomainCNAME LinkBrandingDNSValue `json:"domain_cname,omitempty"` //nolint:tagliatelle OwnerCNAME LinkBrandingDNSValue `json:"owner_cname,omitempty"` //nolint:tagliatelle }
type LinkBrandingDNSValue ¶
type ParseWebhook ¶
type ParseWebhook struct { Hostname string `json:"hostname,omitempty"` URL string `json:"url,omitempty"` SpamCheck bool `json:"spam_check"` //nolint:tagliatelle SendRaw bool `json:"send_raw"` //nolint:tagliatelle }
ParseWebhook is a Sendgrid inbound parse settings.
type RequestError ¶
RequestError struct permits to embed to return the statucode and the error to the parent function.
func (*RequestError) Error ¶ added in v0.2.0
func (err *RequestError) Error() string
type SSOCertificate ¶
type SSOCertificate struct { PublicCertificate string `json:"public_certificate"` //nolint:tagliatelle IntegrationID string `json:"integration_id"` //nolint:tagliatelle ID int32 `json:"id,omitempty"` }
SSOCertificate maps a public certificate to an SSO integration, allowing the SSO integration to verify SAML requests from an IdP.
type SSOIntegration ¶
type SSOIntegration struct { CompletedIntegration bool `json:"completed_integration,omitempty"` //nolint:tagliatelle Enabled bool `json:"enabled"` Name string `json:"name"` SignInURL string `json:"signin_url"` //nolint:tagliatelle SignOutURL string `json:"signout_url"` //nolint:tagliatelle EntityID string `json:"entity_id"` //nolint:tagliatelle ID string `json:"id,omitempty"` SingleSignOnURL string `json:"single_signon_url,omitempty"` //nolint:tagliatelle AudienceURL string `json:"audience_url,omitempty"` //nolint:tagliatelle }
SSOIntegration is a Sendgrid SSO configuration set.
type SubUser ¶
type SubUser struct { ID int `json:"id,omitempty"` UserID int `json:"user_id,omitempty"` //nolint:tagliatelle UserName string `json:"username,omitempty"` Password string `json:"password,omitempty"` ConfirmPassword string `json:"confirm_password,omitempty"` //nolint:tagliatelle Email string `json:"email,omitempty"` IPs []string `json:"ips,omitempty"` Disabled bool `json:"disabled,omitempty"` SignupSessionToken string `json:"signup_session_token,omitempty"` //nolint:tagliatelle AuthorizationToken string `json:"authorization_token,omitempty"` //nolint:tagliatelle CreditAllocation creditAllocation `json:"credit_allocation,omitempty"` //nolint:tagliatelle }
SubUser is a Sendgrid SubUser.
type Template ¶
type Template struct { ID string `json:"id,omitempty"` Name string `json:"name,omitempty"` Generation string `json:"generation,omitempty"` UpdatedAt string `json:"updated_at,omitempty"` Versions []TemplateVersion `json:"versions,omitempty"` Warnings []string `json:"warnings,omitempty"` }
Template is a Sendgrid transactional template.
type TemplateVersion ¶
type TemplateVersion struct { ID string `json:"id,omitempty"` TemplateID string `json:"template_id,omitempty"` //nolint:tagliatelle UpdatedAt string `json:"updated_at,omitempty"` //nolint:tagliatelle ThumbnailURL string `json:"thumbnail_url,omitempty"` //nolint:tagliatelle Warnings []string `json:"warnings,omitempty"` Active int `json:"active,omitempty"` Name string `json:"name,omitempty"` HTMLContent string `json:"html_content,omitempty"` //nolint:tagliatelle PlainContent string `json:"plain_content,omitempty"` //nolint:tagliatelle GeneratePlainContent bool `json:"generate_plain_content,omitempty"` //nolint:tagliatelle Subject string `json:"subject,omitempty"` Editor string `json:"editor,omitempty"` TestData string `json:"test_data,omitempty"` //nolint:tagliatelle }
TemplateVersion is a Sendgrid transactional template version.
type UnsubscribeGroup ¶
type UnsubscribeGroup struct { ID int32 `json:"id,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` IsDefault bool `json:"is_default"` //nolint:tagliatelle Unsubscribes int32 `json:"unsubscribes,omitempty"` }
UnsubscribeGroup is a Sendgrid - Suppressions - Unsubscribe Group.