Documentation
¶
Overview ¶
Package transactional provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Package transactional provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Index ¶
- Constants
- type ArchiveTokenResponse
- type Client
- func (c *Client) ArchiveToken(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*ArchiveTokenResponse, error)
- func (c *Client) CreateTokenSmtpTokens(ctx context.Context, body CreateTokenSmtpTokensJSONRequestBody, ...) (*CreateTokenSmtpTokensResponse, error)
- func (c *Client) CreateTokenSmtpTokensWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*CreateTokenSmtpTokensResponse, error)
- func (c *Client) GetTokenById(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*GetTokenByIdResponse, error)
- func (c *Client) GetTokensPageSmtpTokens(ctx context.Context, params *GetTokensPageSmtpTokensParams, ...) (*GetTokensPageSmtpTokensResponse, error)
- func (c *Client) ResetPasswordPasswordReset(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*ResetPasswordPasswordResetResponse, error)
- func (c *Client) SendEmail(ctx context.Context, body SendEmailJSONRequestBody, ...) (*SendEmailResponse, error)
- func (c *Client) SendEmailWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*SendEmailResponse, error)
- type ClientInterface
- type CollectionResponseSmtpApiTokenView
- type CreateTokenSmtpTokensJSONBody
- type CreateTokenSmtpTokensJSONRequestBody
- type CreateTokenSmtpTokensResponse
- type EmailSendStatusView
- type EmailSendStatusViewSendResult
- type EmailSendStatusViewStatus
- type Error
- type ErrorDetail
- type ErrorDetail_Context
- type Error_Context
- type Error_Links
- type EventIdView
- type GetTokenByIdResponse
- type GetTokensPageSmtpTokensParams
- type GetTokensPageSmtpTokensResponse
- type NextPage
- type Paging
- type PublicSingleSendEmail
- type PublicSingleSendRequestEgg
- type PublicSingleSendRequestEgg_ContactProperties
- func (a PublicSingleSendRequestEgg_ContactProperties) Get(fieldName string) (value string, found bool)
- func (a PublicSingleSendRequestEgg_ContactProperties) MarshalJSON() ([]byte, error)
- func (a *PublicSingleSendRequestEgg_ContactProperties) Set(fieldName string, value string)
- func (a *PublicSingleSendRequestEgg_ContactProperties) UnmarshalJSON(b []byte) error
- type ResetPasswordPasswordResetResponse
- type SendEmailJSONBody
- type SendEmailJSONRequestBody
- type SendEmailResponse
- type SmtpApiTokenRequestEgg
- type SmtpApiTokenView
Constants ¶
const ( HapikeyScopes = "hapikey.Scopes" Oauth2_legacyScopes = "oauth2_legacy.Scopes" )
const DefaultServer = "https://api.hubapi.com/"
DefaultServer is the default server to be used.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArchiveTokenResponse ¶
func (ArchiveTokenResponse) Status ¶
func (r ArchiveTokenResponse) Status() string
Status returns HTTPResponse.Status
func (ArchiveTokenResponse) StatusCode ¶
func (r ArchiveTokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Client ¶
Client conforms to the OpenAPI3 specification for this service.
func NewClient ¶
NewClient creates a new Client with reasonable defaults.
func (*Client) ArchiveToken ¶
func (c *Client) ArchiveToken(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*ArchiveTokenResponse, error)
ArchiveToken request returning *ArchiveTokenResponse
func (*Client) CreateTokenSmtpTokens ¶
func (c *Client) CreateTokenSmtpTokens(ctx context.Context, body CreateTokenSmtpTokensJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateTokenSmtpTokensResponse, error)
func (*Client) CreateTokenSmtpTokensWithBody ¶
func (c *Client) CreateTokenSmtpTokensWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateTokenSmtpTokensResponse, error)
CreateTokenSmtpTokensWithBody request with arbitrary body returning *CreateTokenSmtpTokensResponse
func (*Client) GetTokenById ¶
func (c *Client) GetTokenById(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*GetTokenByIdResponse, error)
GetTokenById request returning *GetTokenByIdResponse
func (*Client) GetTokensPageSmtpTokens ¶
func (c *Client) GetTokensPageSmtpTokens(ctx context.Context, params *GetTokensPageSmtpTokensParams, reqEditors ...client.RequestEditorFn) (*GetTokensPageSmtpTokensResponse, error)
GetTokensPageSmtpTokens request returning *GetTokensPageSmtpTokensResponse
func (*Client) ResetPasswordPasswordReset ¶
func (c *Client) ResetPasswordPasswordReset(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*ResetPasswordPasswordResetResponse, error)
ResetPasswordPasswordReset request returning *ResetPasswordPasswordResetResponse
func (*Client) SendEmail ¶
func (c *Client) SendEmail(ctx context.Context, body SendEmailJSONRequestBody, reqEditors ...client.RequestEditorFn) (*SendEmailResponse, error)
type ClientInterface ¶
type ClientInterface interface {
// SendEmail request with any body
SendEmailWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*SendEmailResponse, error)
SendEmail(ctx context.Context, body SendEmailJSONRequestBody, reqEditors ...client.RequestEditorFn) (*SendEmailResponse, error)
// GetTokensPageSmtpTokens request
GetTokensPageSmtpTokens(ctx context.Context, params *GetTokensPageSmtpTokensParams, reqEditors ...client.RequestEditorFn) (*GetTokensPageSmtpTokensResponse, error)
// CreateTokenSmtpTokens request with any body
CreateTokenSmtpTokensWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateTokenSmtpTokensResponse, error)
CreateTokenSmtpTokens(ctx context.Context, body CreateTokenSmtpTokensJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateTokenSmtpTokensResponse, error)
// ArchiveToken request
ArchiveToken(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*ArchiveTokenResponse, error)
// GetTokenById request
GetTokenById(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*GetTokenByIdResponse, error)
// ResetPasswordPasswordReset request
ResetPasswordPasswordReset(ctx context.Context, tokenId string, reqEditors ...client.RequestEditorFn) (*ResetPasswordPasswordResetResponse, error)
}
ClientInterface interface specification for the client.
type CollectionResponseSmtpApiTokenView ¶
type CollectionResponseSmtpApiTokenView struct {
Paging *Paging `json:"paging,omitempty"`
// The actual collection of tokens.
Results []SmtpApiTokenView `json:"results"`
}
A collection of SMTP API tokens.
type CreateTokenSmtpTokensJSONBody ¶
type CreateTokenSmtpTokensJSONBody SmtpApiTokenRequestEgg
CreateTokenSmtpTokensJSONBody defines parameters for CreateTokenSmtpTokens.
type CreateTokenSmtpTokensJSONRequestBody ¶
type CreateTokenSmtpTokensJSONRequestBody CreateTokenSmtpTokensJSONBody
CreateTokenSmtpTokensJSONRequestBody defines body for CreateTokenSmtpTokens for application/json ContentType.
type CreateTokenSmtpTokensResponse ¶
type CreateTokenSmtpTokensResponse struct {
Body []byte
HTTPResponse *http.Response
JSON201 *SmtpApiTokenView
}
func (CreateTokenSmtpTokensResponse) Status ¶
func (r CreateTokenSmtpTokensResponse) Status() string
Status returns HTTPResponse.Status
func (CreateTokenSmtpTokensResponse) StatusCode ¶
func (r CreateTokenSmtpTokensResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type EmailSendStatusView ¶
type EmailSendStatusView struct {
// Time when the send was completed.
CompletedAt *time.Time `json:"completedAt,omitempty"`
// The ID of a send event.
EventId *EventIdView `json:"eventId,omitempty"`
// Time when the send was requested.
RequestedAt *time.Time `json:"requestedAt,omitempty"`
// Result of the send.
SendResult *EmailSendStatusViewSendResult `json:"sendResult,omitempty"`
// Time when the send began processing.
StartedAt *time.Time `json:"startedAt,omitempty"`
// Status of the send request.
Status EmailSendStatusViewStatus `json:"status"`
// Identifier used to query the status of the send.
StatusId string `json:"statusId"`
}
Describes the status of an email send request.
type EmailSendStatusViewSendResult ¶
type EmailSendStatusViewSendResult string
Result of the send.
const ( EmailSendStatusViewSendResultADDRESSLISTBOMBED EmailSendStatusViewSendResult = "ADDRESS_LIST_BOMBED" EmailSendStatusViewSendResultADDRESSONLYACCEPTEDONPROD EmailSendStatusViewSendResult = "ADDRESS_ONLY_ACCEPTED_ON_PROD" EmailSendStatusViewSendResultADDRESSOPTEDOUT EmailSendStatusViewSendResult = "ADDRESS_OPTED_OUT" EmailSendStatusViewSendResultBLOCKEDADDRESS EmailSendStatusViewSendResult = "BLOCKED_ADDRESS" EmailSendStatusViewSendResultBLOCKEDDOMAIN EmailSendStatusViewSendResult = "BLOCKED_DOMAIN" EmailSendStatusViewSendResultCAMPAIGNCANCELLED EmailSendStatusViewSendResult = "CAMPAIGN_CANCELLED" EmailSendStatusViewSendResultCANCELLEDABUSE EmailSendStatusViewSendResult = "CANCELLED_ABUSE" EmailSendStatusViewSendResultCORRUPTINPUT EmailSendStatusViewSendResult = "CORRUPT_INPUT" EmailSendStatusViewSendResultEMAILDISABLED EmailSendStatusViewSendResult = "EMAIL_DISABLED" EmailSendStatusViewSendResultEMAILUNCONFIRMED EmailSendStatusViewSendResult = "EMAIL_UNCONFIRMED" EmailSendStatusViewSendResultGRAYMAILSUPPRESSED EmailSendStatusViewSendResult = "GRAYMAIL_SUPPRESSED" EmailSendStatusViewSendResultIDEMPOTENTFAIL EmailSendStatusViewSendResult = "IDEMPOTENT_FAIL" EmailSendStatusViewSendResultIDEMPOTENTIGNORE EmailSendStatusViewSendResult = "IDEMPOTENT_IGNORE" EmailSendStatusViewSendResultINVALIDFROMADDRESS EmailSendStatusViewSendResult = "INVALID_FROM_ADDRESS" EmailSendStatusViewSendResultINVALIDTOADDRESS EmailSendStatusViewSendResult = "INVALID_TO_ADDRESS" EmailSendStatusViewSendResultMISSINGCONTENT EmailSendStatusViewSendResult = "MISSING_CONTENT" EmailSendStatusViewSendResultMISSINGREQUIREDPARAMETER EmailSendStatusViewSendResult = "MISSING_REQUIRED_PARAMETER" EmailSendStatusViewSendResultMISSINGTEMPLATEPROPERTIES EmailSendStatusViewSendResult = "MISSING_TEMPLATE_PROPERTIES" EmailSendStatusViewSendResultMTAIGNORE EmailSendStatusViewSendResult = "MTA_IGNORE" EmailSendStatusViewSendResultNONMARKETABLECONTACT EmailSendStatusViewSendResult = "NON_MARKETABLE_CONTACT" EmailSendStatusViewSendResultPORTALAUTHENTICATIONFAILURE EmailSendStatusViewSendResult = "PORTAL_AUTHENTICATION_FAILURE" EmailSendStatusViewSendResultPORTALEXPIRED EmailSendStatusViewSendResult = "PORTAL_EXPIRED" EmailSendStatusViewSendResultPORTALMISSINGMARKETINGSCOPE EmailSendStatusViewSendResult = "PORTAL_MISSING_MARKETING_SCOPE" EmailSendStatusViewSendResultPORTALNOTAUTHORIZEDFORAPPLICATION EmailSendStatusViewSendResult = "PORTAL_NOT_AUTHORIZED_FOR_APPLICATION" EmailSendStatusViewSendResultPORTALOVERLIMIT EmailSendStatusViewSendResult = "PORTAL_OVER_LIMIT" EmailSendStatusViewSendResultPORTALSUSPENDED EmailSendStatusViewSendResult = "PORTAL_SUSPENDED" EmailSendStatusViewSendResultPREVIOUSLYBOUNCED EmailSendStatusViewSendResult = "PREVIOUSLY_BOUNCED" EmailSendStatusViewSendResultPREVIOUSLYUNSUBSCRIBEDBRAND EmailSendStatusViewSendResult = "PREVIOUSLY_UNSUBSCRIBED_BRAND" EmailSendStatusViewSendResultPREVIOUSLYUNSUBSCRIBEDMESSAGE EmailSendStatusViewSendResult = "PREVIOUSLY_UNSUBSCRIBED_MESSAGE" EmailSendStatusViewSendResultPREVIOUSLYUNSUBSCRIBEDPORTAL EmailSendStatusViewSendResult = "PREVIOUSLY_UNSUBSCRIBED_PORTAL" EmailSendStatusViewSendResultPREVIOUSSPAM EmailSendStatusViewSendResult = "PREVIOUS_SPAM" EmailSendStatusViewSendResultQUARANTINEDADDRESS EmailSendStatusViewSendResult = "QUARANTINED_ADDRESS" EmailSendStatusViewSendResultQUEUED EmailSendStatusViewSendResult = "QUEUED" EmailSendStatusViewSendResultRECIPIENTFATIGUESUPPRESSED EmailSendStatusViewSendResult = "RECIPIENT_FATIGUE_SUPPRESSED" EmailSendStatusViewSendResultSENT EmailSendStatusViewSendResult = "SENT" EmailSendStatusViewSendResultTEMPLATERENDEREXCEPTION EmailSendStatusViewSendResult = "TEMPLATE_RENDER_EXCEPTION" EmailSendStatusViewSendResultTHROTTLED EmailSendStatusViewSendResult = "THROTTLED" EmailSendStatusViewSendResultTOOMANYRECIPIENTS EmailSendStatusViewSendResult = "TOO_MANY_RECIPIENTS" EmailSendStatusViewSendResultUNCONFIGUREDSENDINGDOMAIN EmailSendStatusViewSendResult = "UNCONFIGURED_SENDING_DOMAIN" EmailSendStatusViewSendResultUNDELIVERABLE EmailSendStatusViewSendResult = "UNDELIVERABLE" EmailSendStatusViewSendResultVALIDATIONFAILED EmailSendStatusViewSendResult = "VALIDATION_FAILED" )
Defines values for EmailSendStatusViewSendResult.
type EmailSendStatusViewStatus ¶
type EmailSendStatusViewStatus string
Status of the send request.
const ( EmailSendStatusViewStatusCANCELED EmailSendStatusViewStatus = "CANCELED" EmailSendStatusViewStatusCOMPLETE EmailSendStatusViewStatus = "COMPLETE" EmailSendStatusViewStatusPENDING EmailSendStatusViewStatus = "PENDING" EmailSendStatusViewStatusPROCESSING EmailSendStatusViewStatus = "PROCESSING" )
Defines values for EmailSendStatusViewStatus.
type Error ¶
type Error struct {
// The error category
Category string `json:"category"`
// Context about the error condition
Context *Error_Context `json:"context,omitempty"`
// A unique identifier for the request. Include this value with any error reports or support tickets
CorrelationId string `json:"correlationId"`
// further information about the error
Errors *[]ErrorDetail `json:"errors,omitempty"`
// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
Links *Error_Links `json:"links,omitempty"`
// A human readable message describing the error along with remediation steps where appropriate
Message string `json:"message"`
// A specific category that contains more specific detail about the error
SubCategory *string `json:"subCategory,omitempty"`
}
Error defines model for Error.
type ErrorDetail ¶
type ErrorDetail struct {
// The status code associated with the error detail
Code *string `json:"code,omitempty"`
// Context about the error condition
Context *ErrorDetail_Context `json:"context,omitempty"`
// The name of the field or parameter in which the error was found.
In *string `json:"in,omitempty"`
// A human readable message describing the error along with remediation steps where appropriate
Message string `json:"message"`
// A specific category that contains more specific detail about the error
SubCategory *string `json:"subCategory,omitempty"`
}
ErrorDetail defines model for ErrorDetail.
type ErrorDetail_Context ¶
Context about the error condition
func (ErrorDetail_Context) Get ¶
func (a ErrorDetail_Context) Get(fieldName string) (value []string, found bool)
Getter for additional properties for ErrorDetail_Context. Returns the specified element and whether it was found
func (ErrorDetail_Context) MarshalJSON ¶
func (a ErrorDetail_Context) MarshalJSON() ([]byte, error)
Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties
func (*ErrorDetail_Context) Set ¶
func (a *ErrorDetail_Context) Set(fieldName string, value []string)
Setter for additional properties for ErrorDetail_Context
func (*ErrorDetail_Context) UnmarshalJSON ¶
func (a *ErrorDetail_Context) UnmarshalJSON(b []byte) error
Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties
type Error_Context ¶
Context about the error condition
func (Error_Context) Get ¶
func (a Error_Context) Get(fieldName string) (value []string, found bool)
Getter for additional properties for Error_Context. Returns the specified element and whether it was found
func (Error_Context) MarshalJSON ¶
func (a Error_Context) MarshalJSON() ([]byte, error)
Override default JSON handling for Error_Context to handle AdditionalProperties
func (*Error_Context) Set ¶
func (a *Error_Context) Set(fieldName string, value []string)
Setter for additional properties for Error_Context
func (*Error_Context) UnmarshalJSON ¶
func (a *Error_Context) UnmarshalJSON(b []byte) error
Override default JSON handling for Error_Context to handle AdditionalProperties
type Error_Links ¶
A map of link names to associated URIs containing documentation about the error or recommended remediation steps
func (Error_Links) Get ¶
func (a Error_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for Error_Links. Returns the specified element and whether it was found
func (Error_Links) MarshalJSON ¶
func (a Error_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for Error_Links to handle AdditionalProperties
func (*Error_Links) Set ¶
func (a *Error_Links) Set(fieldName string, value string)
Setter for additional properties for Error_Links
func (*Error_Links) UnmarshalJSON ¶
func (a *Error_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for Error_Links to handle AdditionalProperties
type EventIdView ¶
type EventIdView struct {
// Time of event creation.
Created time.Time `json:"created"`
// Identifier of event.
Id string `json:"id"`
}
The ID of a send event.
type GetTokenByIdResponse ¶
type GetTokenByIdResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SmtpApiTokenView
}
func (GetTokenByIdResponse) Status ¶
func (r GetTokenByIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetTokenByIdResponse) StatusCode ¶
func (r GetTokenByIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetTokensPageSmtpTokensParams ¶
type GetTokensPageSmtpTokensParams struct {
// A name for the campaign tied to the SMTP API token.
CampaignName *string `json:"campaignName,omitempty"`
// Identifier assigned to the campaign provided during the token creation.
EmailCampaignId *string `json:"emailCampaignId,omitempty"`
// Starting point to get the next set of results.
After *string `json:"after,omitempty"`
// Maximum number of tokens to return.
Limit *int32 `json:"limit,omitempty"`
}
GetTokensPageSmtpTokensParams defines parameters for GetTokensPageSmtpTokens.
type GetTokensPageSmtpTokensResponse ¶
type GetTokensPageSmtpTokensResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *CollectionResponseSmtpApiTokenView
}
func (GetTokensPageSmtpTokensResponse) Status ¶
func (r GetTokensPageSmtpTokensResponse) Status() string
Status returns HTTPResponse.Status
func (GetTokensPageSmtpTokensResponse) StatusCode ¶
func (r GetTokensPageSmtpTokensResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type NextPage ¶
NextPage defines model for NextPage.
type Paging ¶
type Paging struct {
Next *NextPage `json:"next,omitempty"`
}
Paging defines model for Paging.
type PublicSingleSendEmail ¶
type PublicSingleSendEmail struct {
// List of email addresses to send as Bcc.
Bcc []string `json:"bcc"`
// List of email addresses to send as Cc.
Cc []string `json:"cc"`
// The From header for the email.
From *string `json:"from,omitempty"`
// List of Reply-To header values for the email.
ReplyTo []string `json:"replyTo"`
// ID for a particular send. No more than one email will be sent per sendId.
SendId *string `json:"sendId,omitempty"`
// The recipient of the email.
To *string `json:"to,omitempty"`
}
A JSON object containing anything you want to override.
type PublicSingleSendRequestEgg ¶
type PublicSingleSendRequestEgg struct {
// The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a reciept you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.
ContactProperties PublicSingleSendRequestEgg_ContactProperties `json:"contactProperties"`
// The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.
// Note: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.
CustomProperties map[string]interface{} `json:"customProperties"`
// The content ID for the transactional email, which can be found in email tool UI.
EmailId int32 `json:"emailId"`
// A JSON object containing anything you want to override.
Message PublicSingleSendEmail `json:"message"`
}
A request to send a single transactional email asynchronously.
type PublicSingleSendRequestEgg_ContactProperties ¶
type PublicSingleSendRequestEgg_ContactProperties struct {
AdditionalProperties map[string]string `json:"-"`
}
The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a reciept you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.
func (PublicSingleSendRequestEgg_ContactProperties) Get ¶
func (a PublicSingleSendRequestEgg_ContactProperties) Get(fieldName string) (value string, found bool)
Getter for additional properties for PublicSingleSendRequestEgg_ContactProperties. Returns the specified element and whether it was found
func (PublicSingleSendRequestEgg_ContactProperties) MarshalJSON ¶
func (a PublicSingleSendRequestEgg_ContactProperties) MarshalJSON() ([]byte, error)
Override default JSON handling for PublicSingleSendRequestEgg_ContactProperties to handle AdditionalProperties
func (*PublicSingleSendRequestEgg_ContactProperties) Set ¶
func (a *PublicSingleSendRequestEgg_ContactProperties) Set(fieldName string, value string)
Setter for additional properties for PublicSingleSendRequestEgg_ContactProperties
func (*PublicSingleSendRequestEgg_ContactProperties) UnmarshalJSON ¶
func (a *PublicSingleSendRequestEgg_ContactProperties) UnmarshalJSON(b []byte) error
Override default JSON handling for PublicSingleSendRequestEgg_ContactProperties to handle AdditionalProperties
type ResetPasswordPasswordResetResponse ¶
type ResetPasswordPasswordResetResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *SmtpApiTokenView
}
func (ResetPasswordPasswordResetResponse) Status ¶
func (r ResetPasswordPasswordResetResponse) Status() string
Status returns HTTPResponse.Status
func (ResetPasswordPasswordResetResponse) StatusCode ¶
func (r ResetPasswordPasswordResetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SendEmailJSONBody ¶
type SendEmailJSONBody PublicSingleSendRequestEgg
SendEmailJSONBody defines parameters for SendEmail.
type SendEmailJSONRequestBody ¶
type SendEmailJSONRequestBody SendEmailJSONBody
SendEmailJSONRequestBody defines body for SendEmail for application/json ContentType.
type SendEmailResponse ¶
type SendEmailResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *EmailSendStatusView
}
func (SendEmailResponse) Status ¶
func (r SendEmailResponse) Status() string
Status returns HTTPResponse.Status
func (SendEmailResponse) StatusCode ¶
func (r SendEmailResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SmtpApiTokenRequestEgg ¶
type SmtpApiTokenRequestEgg struct {
// A name for the campaign tied to the SMTP API token.
CampaignName string `json:"campaignName"`
// Indicates whether a contact should be created for recipients of emails.
CreateContact bool `json:"createContact"`
}
A request object to create a SMTP API token
type SmtpApiTokenView ¶
type SmtpApiTokenView struct {
// A name for the campaign tied to the token.
CampaignName string `json:"campaignName"`
// Indicates whether a contact should be created for recipients of emails.
CreateContact bool `json:"createContact"`
// Timestamp generated when a token is created.
CreatedAt time.Time `json:"createdAt"`
// Email address of the user that sent the token creation request.
CreatedBy string `json:"createdBy"`
// Identifier assigned to the campaign provided in the token creation request.
EmailCampaignId string `json:"emailCampaignId"`
// User name to log into the HubSpot SMTP server.
Id string `json:"id"`
// Password used to log into the HubSpot SMTP server.
Password *string `json:"password,omitempty"`
}
A SMTP API token provides both an ID and password that can be used to send email through the HubSpot SMTP API.
Source Files
¶
- client.gen.go
- servers.gen.go
- types.gen.go