transactional

package
v0.0.0-...-abe38a1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2024 License: MIT Imports: 23 Imported by: 0

README

Go API client for transactional

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v3
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import transactional "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), transactional.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), transactional.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), transactional.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), transactional.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class Method HTTP request Description
PublicSmtpTokensApi ArchiveToken Delete /marketing/v3/transactional/smtp-tokens/{tokenId} Delete a single token by ID.
PublicSmtpTokensApi CreateToken Post /marketing/v3/transactional/smtp-tokens Create a SMTP API token.
PublicSmtpTokensApi GetTokenByID Get /marketing/v3/transactional/smtp-tokens/{tokenId} Query a single token by ID.
PublicSmtpTokensApi GetTokensPage Get /marketing/v3/transactional/smtp-tokens Query SMTP API tokens by campaign name or an emailCampaignId.
PublicSmtpTokensApi ResetPassword Post /marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset Reset the password of an existing token.
SingleSendApi SendEmail Post /marketing/v3/transactional/single-email/send Send a single transactional email asynchronously.

Documentation For Models

Documentation For Authorization

oauth2_legacy

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
private_apps_legacy
  • Type: API key
  • API key parameter name: private-app-legacy
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app-legacy and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	PublicSmtpTokensApi *PublicSmtpTokensApiService

	SingleSendApi *SingleSendApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Transactional Single Send API vv3 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiArchiveTokenRequest

type ApiArchiveTokenRequest struct {
	ApiService *PublicSmtpTokensApiService
	// contains filtered or unexported fields
}

func (ApiArchiveTokenRequest) Execute

func (r ApiArchiveTokenRequest) Execute() (*http.Response, error)

type ApiCreateTokenRequest

type ApiCreateTokenRequest struct {
	ApiService *PublicSmtpTokensApiService
	// contains filtered or unexported fields
}

func (ApiCreateTokenRequest) Execute

func (ApiCreateTokenRequest) SmtpApiTokenRequestEgg

func (r ApiCreateTokenRequest) SmtpApiTokenRequestEgg(smtpApiTokenRequestEgg SmtpApiTokenRequestEgg) ApiCreateTokenRequest

A request object that includes the campaign name tied to the token and whether contacts should be created for email recipients.

type ApiGetTokenByIDRequest

type ApiGetTokenByIDRequest struct {
	ApiService *PublicSmtpTokensApiService
	// contains filtered or unexported fields
}

func (ApiGetTokenByIDRequest) Execute

type ApiGetTokensPageRequest

type ApiGetTokensPageRequest struct {
	ApiService *PublicSmtpTokensApiService
	// contains filtered or unexported fields
}

func (ApiGetTokensPageRequest) After

Starting point to get the next set of results.

func (ApiGetTokensPageRequest) CampaignName

func (r ApiGetTokensPageRequest) CampaignName(campaignName string) ApiGetTokensPageRequest

A name for the campaign tied to the SMTP API token.

func (ApiGetTokensPageRequest) EmailCampaignId

func (r ApiGetTokensPageRequest) EmailCampaignId(emailCampaignId string) ApiGetTokensPageRequest

Identifier assigned to the campaign provided during the token creation.

func (ApiGetTokensPageRequest) Execute

func (ApiGetTokensPageRequest) Limit

Maximum number of tokens to return.

type ApiResetPasswordRequest

type ApiResetPasswordRequest struct {
	ApiService *PublicSmtpTokensApiService
	// contains filtered or unexported fields
}

func (ApiResetPasswordRequest) Execute

type ApiSendEmailRequest

type ApiSendEmailRequest struct {
	ApiService *SingleSendApiService
	// contains filtered or unexported fields
}

func (ApiSendEmailRequest) Execute

func (ApiSendEmailRequest) PublicSingleSendRequestEgg

func (r ApiSendEmailRequest) PublicSingleSendRequestEgg(publicSingleSendRequestEgg PublicSingleSendRequestEgg) ApiSendEmailRequest

A request object describing the email to send.

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CollectionResponseSmtpApiTokenViewForwardPaging

type CollectionResponseSmtpApiTokenViewForwardPaging struct {
	Paging  *ForwardPaging     `json:"paging,omitempty"`
	Results []SmtpApiTokenView `json:"results"`
}

CollectionResponseSmtpApiTokenViewForwardPaging struct for CollectionResponseSmtpApiTokenViewForwardPaging

func NewCollectionResponseSmtpApiTokenViewForwardPaging

func NewCollectionResponseSmtpApiTokenViewForwardPaging(results []SmtpApiTokenView) *CollectionResponseSmtpApiTokenViewForwardPaging

NewCollectionResponseSmtpApiTokenViewForwardPaging instantiates a new CollectionResponseSmtpApiTokenViewForwardPaging object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCollectionResponseSmtpApiTokenViewForwardPagingWithDefaults

func NewCollectionResponseSmtpApiTokenViewForwardPagingWithDefaults() *CollectionResponseSmtpApiTokenViewForwardPaging

NewCollectionResponseSmtpApiTokenViewForwardPagingWithDefaults instantiates a new CollectionResponseSmtpApiTokenViewForwardPaging object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CollectionResponseSmtpApiTokenViewForwardPaging) GetPaging

GetPaging returns the Paging field value if set, zero value otherwise.

func (*CollectionResponseSmtpApiTokenViewForwardPaging) GetPagingOk

GetPagingOk returns a tuple with the Paging field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CollectionResponseSmtpApiTokenViewForwardPaging) GetResults

GetResults returns the Results field value

func (*CollectionResponseSmtpApiTokenViewForwardPaging) GetResultsOk

GetResultsOk returns a tuple with the Results field value and a boolean to check if the value has been set.

func (*CollectionResponseSmtpApiTokenViewForwardPaging) HasPaging

HasPaging returns a boolean if a field has been set.

func (CollectionResponseSmtpApiTokenViewForwardPaging) MarshalJSON

func (*CollectionResponseSmtpApiTokenViewForwardPaging) SetPaging

SetPaging gets a reference to the given ForwardPaging and assigns it to the Paging field.

func (*CollectionResponseSmtpApiTokenViewForwardPaging) SetResults

SetResults sets field value

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type EmailSendStatusView

type EmailSendStatusView struct {
	EventId *EventIdView `json:"eventId,omitempty"`
	// Time when the send was completed.
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	// Identifier used to query the status of the send.
	StatusId string `json:"statusId"`
	// Result of the send.
	SendResult *string `json:"sendResult,omitempty"`
	// Time when the send was requested.
	RequestedAt *time.Time `json:"requestedAt,omitempty"`
	// Time when the send began processing.
	StartedAt *time.Time `json:"startedAt,omitempty"`
	// Status of the send request.
	Status string `json:"status"`
}

EmailSendStatusView Describes the status of an email send request.

func NewEmailSendStatusView

func NewEmailSendStatusView(statusId string, status string) *EmailSendStatusView

NewEmailSendStatusView instantiates a new EmailSendStatusView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEmailSendStatusViewWithDefaults

func NewEmailSendStatusViewWithDefaults() *EmailSendStatusView

NewEmailSendStatusViewWithDefaults instantiates a new EmailSendStatusView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EmailSendStatusView) GetCompletedAt

func (o *EmailSendStatusView) GetCompletedAt() time.Time

GetCompletedAt returns the CompletedAt field value if set, zero value otherwise.

func (*EmailSendStatusView) GetCompletedAtOk

func (o *EmailSendStatusView) GetCompletedAtOk() (*time.Time, bool)

GetCompletedAtOk returns a tuple with the CompletedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EmailSendStatusView) GetEventId

func (o *EmailSendStatusView) GetEventId() EventIdView

GetEventId returns the EventId field value if set, zero value otherwise.

func (*EmailSendStatusView) GetEventIdOk

func (o *EmailSendStatusView) GetEventIdOk() (*EventIdView, bool)

GetEventIdOk returns a tuple with the EventId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EmailSendStatusView) GetRequestedAt

func (o *EmailSendStatusView) GetRequestedAt() time.Time

GetRequestedAt returns the RequestedAt field value if set, zero value otherwise.

func (*EmailSendStatusView) GetRequestedAtOk

func (o *EmailSendStatusView) GetRequestedAtOk() (*time.Time, bool)

GetRequestedAtOk returns a tuple with the RequestedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EmailSendStatusView) GetSendResult

func (o *EmailSendStatusView) GetSendResult() string

GetSendResult returns the SendResult field value if set, zero value otherwise.

func (*EmailSendStatusView) GetSendResultOk

func (o *EmailSendStatusView) GetSendResultOk() (*string, bool)

GetSendResultOk returns a tuple with the SendResult field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EmailSendStatusView) GetStartedAt

func (o *EmailSendStatusView) GetStartedAt() time.Time

GetStartedAt returns the StartedAt field value if set, zero value otherwise.

func (*EmailSendStatusView) GetStartedAtOk

func (o *EmailSendStatusView) GetStartedAtOk() (*time.Time, bool)

GetStartedAtOk returns a tuple with the StartedAt field value if set, nil otherwise and a boolean to check if the value has been set.

func (*EmailSendStatusView) GetStatus

func (o *EmailSendStatusView) GetStatus() string

GetStatus returns the Status field value

func (*EmailSendStatusView) GetStatusId

func (o *EmailSendStatusView) GetStatusId() string

GetStatusId returns the StatusId field value

func (*EmailSendStatusView) GetStatusIdOk

func (o *EmailSendStatusView) GetStatusIdOk() (*string, bool)

GetStatusIdOk returns a tuple with the StatusId field value and a boolean to check if the value has been set.

func (*EmailSendStatusView) GetStatusOk

func (o *EmailSendStatusView) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (*EmailSendStatusView) HasCompletedAt

func (o *EmailSendStatusView) HasCompletedAt() bool

HasCompletedAt returns a boolean if a field has been set.

func (*EmailSendStatusView) HasEventId

func (o *EmailSendStatusView) HasEventId() bool

HasEventId returns a boolean if a field has been set.

func (*EmailSendStatusView) HasRequestedAt

func (o *EmailSendStatusView) HasRequestedAt() bool

HasRequestedAt returns a boolean if a field has been set.

func (*EmailSendStatusView) HasSendResult

func (o *EmailSendStatusView) HasSendResult() bool

HasSendResult returns a boolean if a field has been set.

func (*EmailSendStatusView) HasStartedAt

func (o *EmailSendStatusView) HasStartedAt() bool

HasStartedAt returns a boolean if a field has been set.

func (EmailSendStatusView) MarshalJSON

func (o EmailSendStatusView) MarshalJSON() ([]byte, error)

func (*EmailSendStatusView) SetCompletedAt

func (o *EmailSendStatusView) SetCompletedAt(v time.Time)

SetCompletedAt gets a reference to the given time.Time and assigns it to the CompletedAt field.

func (*EmailSendStatusView) SetEventId

func (o *EmailSendStatusView) SetEventId(v EventIdView)

SetEventId gets a reference to the given EventIdView and assigns it to the EventId field.

func (*EmailSendStatusView) SetRequestedAt

func (o *EmailSendStatusView) SetRequestedAt(v time.Time)

SetRequestedAt gets a reference to the given time.Time and assigns it to the RequestedAt field.

func (*EmailSendStatusView) SetSendResult

func (o *EmailSendStatusView) SetSendResult(v string)

SetSendResult gets a reference to the given string and assigns it to the SendResult field.

func (*EmailSendStatusView) SetStartedAt

func (o *EmailSendStatusView) SetStartedAt(v time.Time)

SetStartedAt gets a reference to the given time.Time and assigns it to the StartedAt field.

func (*EmailSendStatusView) SetStatus

func (o *EmailSendStatusView) SetStatus(v string)

SetStatus sets field value

func (*EmailSendStatusView) SetStatusId

func (o *EmailSendStatusView) SetStatusId(v string)

SetStatusId sets field value

type Error

type Error struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`
	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *map[string]string `json:"links,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The error category
	Category string `json:"category"`
	// further information about the error
	Errors []ErrorDetail `json:"errors,omitempty"`
}

Error struct for Error

func NewError

func NewError(correlationId string, message string, category string) *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetCategory

func (o *Error) GetCategory() string

GetCategory returns the Category field value

func (*Error) GetCategoryOk

func (o *Error) GetCategoryOk() (*string, bool)

GetCategoryOk returns a tuple with the Category field value and a boolean to check if the value has been set.

func (*Error) GetContext

func (o *Error) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*Error) GetContextOk

func (o *Error) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetCorrelationId

func (o *Error) GetCorrelationId() string

GetCorrelationId returns the CorrelationId field value

func (*Error) GetCorrelationIdOk

func (o *Error) GetCorrelationIdOk() (*string, bool)

GetCorrelationIdOk returns a tuple with the CorrelationId field value and a boolean to check if the value has been set.

func (*Error) GetErrors

func (o *Error) GetErrors() []ErrorDetail

GetErrors returns the Errors field value if set, zero value otherwise.

func (*Error) GetErrorsOk

func (o *Error) GetErrorsOk() ([]ErrorDetail, bool)

GetErrorsOk returns a tuple with the Errors field value if set, nil otherwise and a boolean to check if the value has been set.

func (o *Error) GetLinks() map[string]string

GetLinks returns the Links field value if set, zero value otherwise.

func (*Error) GetLinksOk

func (o *Error) GetLinksOk() (*map[string]string, bool)

GetLinksOk returns a tuple with the Links field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) GetMessage

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*Error) GetSubCategory

func (o *Error) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*Error) GetSubCategoryOk

func (o *Error) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Error) HasContext

func (o *Error) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*Error) HasErrors

func (o *Error) HasErrors() bool

HasErrors returns a boolean if a field has been set.

func (o *Error) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*Error) HasSubCategory

func (o *Error) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (Error) MarshalJSON

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetCategory

func (o *Error) SetCategory(v string)

SetCategory sets field value

func (*Error) SetContext

func (o *Error) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*Error) SetCorrelationId

func (o *Error) SetCorrelationId(v string)

SetCorrelationId sets field value

func (*Error) SetErrors

func (o *Error) SetErrors(v []ErrorDetail)

SetErrors gets a reference to the given []ErrorDetail and assigns it to the Errors field.

func (o *Error) SetLinks(v map[string]string)

SetLinks gets a reference to the given map[string]string and assigns it to the Links field.

func (*Error) SetMessage

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (*Error) SetSubCategory

func (o *Error) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type ErrorDetail

type ErrorDetail struct {
	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// Context about the error condition
	Context *map[string][]string `json:"context,omitempty"`
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
}

ErrorDetail struct for ErrorDetail

func NewErrorDetail

func NewErrorDetail(message string) *ErrorDetail

NewErrorDetail instantiates a new ErrorDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorDetailWithDefaults

func NewErrorDetailWithDefaults() *ErrorDetail

NewErrorDetailWithDefaults instantiates a new ErrorDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ErrorDetail) GetCode

func (o *ErrorDetail) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*ErrorDetail) GetCodeOk

func (o *ErrorDetail) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetContext

func (o *ErrorDetail) GetContext() map[string][]string

GetContext returns the Context field value if set, zero value otherwise.

func (*ErrorDetail) GetContextOk

func (o *ErrorDetail) GetContextOk() (*map[string][]string, bool)

GetContextOk returns a tuple with the Context field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetIn

func (o *ErrorDetail) GetIn() string

GetIn returns the In field value if set, zero value otherwise.

func (*ErrorDetail) GetInOk

func (o *ErrorDetail) GetInOk() (*string, bool)

GetInOk returns a tuple with the In field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) GetMessage

func (o *ErrorDetail) GetMessage() string

GetMessage returns the Message field value

func (*ErrorDetail) GetMessageOk

func (o *ErrorDetail) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*ErrorDetail) GetSubCategory

func (o *ErrorDetail) GetSubCategory() string

GetSubCategory returns the SubCategory field value if set, zero value otherwise.

func (*ErrorDetail) GetSubCategoryOk

func (o *ErrorDetail) GetSubCategoryOk() (*string, bool)

GetSubCategoryOk returns a tuple with the SubCategory field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ErrorDetail) HasCode

func (o *ErrorDetail) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*ErrorDetail) HasContext

func (o *ErrorDetail) HasContext() bool

HasContext returns a boolean if a field has been set.

func (*ErrorDetail) HasIn

func (o *ErrorDetail) HasIn() bool

HasIn returns a boolean if a field has been set.

func (*ErrorDetail) HasSubCategory

func (o *ErrorDetail) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (ErrorDetail) MarshalJSON

func (o ErrorDetail) MarshalJSON() ([]byte, error)

func (*ErrorDetail) SetCode

func (o *ErrorDetail) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*ErrorDetail) SetContext

func (o *ErrorDetail) SetContext(v map[string][]string)

SetContext gets a reference to the given map[string][]string and assigns it to the Context field.

func (*ErrorDetail) SetIn

func (o *ErrorDetail) SetIn(v string)

SetIn gets a reference to the given string and assigns it to the In field.

func (*ErrorDetail) SetMessage

func (o *ErrorDetail) SetMessage(v string)

SetMessage sets field value

func (*ErrorDetail) SetSubCategory

func (o *ErrorDetail) SetSubCategory(v string)

SetSubCategory gets a reference to the given string and assigns it to the SubCategory field.

type EventIdView

type EventIdView struct {
	// Time of event creation.
	Created time.Time `json:"created"`
	// Identifier of event.
	Id string `json:"id"`
}

EventIdView The ID of a send event.

func NewEventIdView

func NewEventIdView(created time.Time, id string) *EventIdView

NewEventIdView instantiates a new EventIdView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewEventIdViewWithDefaults

func NewEventIdViewWithDefaults() *EventIdView

NewEventIdViewWithDefaults instantiates a new EventIdView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*EventIdView) GetCreated

func (o *EventIdView) GetCreated() time.Time

GetCreated returns the Created field value

func (*EventIdView) GetCreatedOk

func (o *EventIdView) GetCreatedOk() (*time.Time, bool)

GetCreatedOk returns a tuple with the Created field value and a boolean to check if the value has been set.

func (*EventIdView) GetId

func (o *EventIdView) GetId() string

GetId returns the Id field value

func (*EventIdView) GetIdOk

func (o *EventIdView) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (EventIdView) MarshalJSON

func (o EventIdView) MarshalJSON() ([]byte, error)

func (*EventIdView) SetCreated

func (o *EventIdView) SetCreated(v time.Time)

SetCreated sets field value

func (*EventIdView) SetId

func (o *EventIdView) SetId(v string)

SetId sets field value

type ForwardPaging

type ForwardPaging struct {
	Next *NextPage `json:"next,omitempty"`
}

ForwardPaging struct for ForwardPaging

func NewForwardPaging

func NewForwardPaging() *ForwardPaging

NewForwardPaging instantiates a new ForwardPaging object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewForwardPagingWithDefaults

func NewForwardPagingWithDefaults() *ForwardPaging

NewForwardPagingWithDefaults instantiates a new ForwardPaging object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ForwardPaging) GetNext

func (o *ForwardPaging) GetNext() NextPage

GetNext returns the Next field value if set, zero value otherwise.

func (*ForwardPaging) GetNextOk

func (o *ForwardPaging) GetNextOk() (*NextPage, bool)

GetNextOk returns a tuple with the Next field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ForwardPaging) HasNext

func (o *ForwardPaging) HasNext() bool

HasNext returns a boolean if a field has been set.

func (ForwardPaging) MarshalJSON

func (o ForwardPaging) MarshalJSON() ([]byte, error)

func (*ForwardPaging) SetNext

func (o *ForwardPaging) SetNext(v NextPage)

SetNext gets a reference to the given NextPage and assigns it to the Next field.

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type NextPage

type NextPage struct {
	//
	Link *string `json:"link,omitempty"`
	//
	After string `json:"after"`
}

NextPage struct for NextPage

func NewNextPage

func NewNextPage(after string) *NextPage

NewNextPage instantiates a new NextPage object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewNextPageWithDefaults

func NewNextPageWithDefaults() *NextPage

NewNextPageWithDefaults instantiates a new NextPage object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*NextPage) GetAfter

func (o *NextPage) GetAfter() string

GetAfter returns the After field value

func (*NextPage) GetAfterOk

func (o *NextPage) GetAfterOk() (*string, bool)

GetAfterOk returns a tuple with the After field value and a boolean to check if the value has been set.

func (o *NextPage) GetLink() string

GetLink returns the Link field value if set, zero value otherwise.

func (*NextPage) GetLinkOk

func (o *NextPage) GetLinkOk() (*string, bool)

GetLinkOk returns a tuple with the Link field value if set, nil otherwise and a boolean to check if the value has been set.

func (o *NextPage) HasLink() bool

HasLink returns a boolean if a field has been set.

func (NextPage) MarshalJSON

func (o NextPage) MarshalJSON() ([]byte, error)

func (*NextPage) SetAfter

func (o *NextPage) SetAfter(v string)

SetAfter sets field value

func (o *NextPage) SetLink(v string)

SetLink gets a reference to the given string and assigns it to the Link field.

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableCollectionResponseSmtpApiTokenViewForwardPaging

type NullableCollectionResponseSmtpApiTokenViewForwardPaging struct {
	// contains filtered or unexported fields
}

func (NullableCollectionResponseSmtpApiTokenViewForwardPaging) Get

func (NullableCollectionResponseSmtpApiTokenViewForwardPaging) IsSet

func (NullableCollectionResponseSmtpApiTokenViewForwardPaging) MarshalJSON

func (*NullableCollectionResponseSmtpApiTokenViewForwardPaging) Set

func (*NullableCollectionResponseSmtpApiTokenViewForwardPaging) UnmarshalJSON

func (*NullableCollectionResponseSmtpApiTokenViewForwardPaging) Unset

type NullableEmailSendStatusView

type NullableEmailSendStatusView struct {
	// contains filtered or unexported fields
}

func NewNullableEmailSendStatusView

func NewNullableEmailSendStatusView(val *EmailSendStatusView) *NullableEmailSendStatusView

func (NullableEmailSendStatusView) Get

func (NullableEmailSendStatusView) IsSet

func (NullableEmailSendStatusView) MarshalJSON

func (v NullableEmailSendStatusView) MarshalJSON() ([]byte, error)

func (*NullableEmailSendStatusView) Set

func (*NullableEmailSendStatusView) UnmarshalJSON

func (v *NullableEmailSendStatusView) UnmarshalJSON(src []byte) error

func (*NullableEmailSendStatusView) Unset

func (v *NullableEmailSendStatusView) Unset()

type NullableError

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError

func NewNullableError(val *Error) *NullableError

func (NullableError) Get

func (v NullableError) Get() *Error

func (NullableError) IsSet

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset

func (v *NullableError) Unset()

type NullableErrorDetail

type NullableErrorDetail struct {
	// contains filtered or unexported fields
}

func NewNullableErrorDetail

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get

func (NullableErrorDetail) IsSet

func (v NullableErrorDetail) IsSet() bool

func (NullableErrorDetail) MarshalJSON

func (v NullableErrorDetail) MarshalJSON() ([]byte, error)

func (*NullableErrorDetail) Set

func (v *NullableErrorDetail) Set(val *ErrorDetail)

func (*NullableErrorDetail) UnmarshalJSON

func (v *NullableErrorDetail) UnmarshalJSON(src []byte) error

func (*NullableErrorDetail) Unset

func (v *NullableErrorDetail) Unset()

type NullableEventIdView

type NullableEventIdView struct {
	// contains filtered or unexported fields
}

func NewNullableEventIdView

func NewNullableEventIdView(val *EventIdView) *NullableEventIdView

func (NullableEventIdView) Get

func (NullableEventIdView) IsSet

func (v NullableEventIdView) IsSet() bool

func (NullableEventIdView) MarshalJSON

func (v NullableEventIdView) MarshalJSON() ([]byte, error)

func (*NullableEventIdView) Set

func (v *NullableEventIdView) Set(val *EventIdView)

func (*NullableEventIdView) UnmarshalJSON

func (v *NullableEventIdView) UnmarshalJSON(src []byte) error

func (*NullableEventIdView) Unset

func (v *NullableEventIdView) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableForwardPaging

type NullableForwardPaging struct {
	// contains filtered or unexported fields
}

func NewNullableForwardPaging

func NewNullableForwardPaging(val *ForwardPaging) *NullableForwardPaging

func (NullableForwardPaging) Get

func (NullableForwardPaging) IsSet

func (v NullableForwardPaging) IsSet() bool

func (NullableForwardPaging) MarshalJSON

func (v NullableForwardPaging) MarshalJSON() ([]byte, error)

func (*NullableForwardPaging) Set

func (v *NullableForwardPaging) Set(val *ForwardPaging)

func (*NullableForwardPaging) UnmarshalJSON

func (v *NullableForwardPaging) UnmarshalJSON(src []byte) error

func (*NullableForwardPaging) Unset

func (v *NullableForwardPaging) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableNextPage

type NullableNextPage struct {
	// contains filtered or unexported fields
}

func NewNullableNextPage

func NewNullableNextPage(val *NextPage) *NullableNextPage

func (NullableNextPage) Get

func (v NullableNextPage) Get() *NextPage

func (NullableNextPage) IsSet

func (v NullableNextPage) IsSet() bool

func (NullableNextPage) MarshalJSON

func (v NullableNextPage) MarshalJSON() ([]byte, error)

func (*NullableNextPage) Set

func (v *NullableNextPage) Set(val *NextPage)

func (*NullableNextPage) UnmarshalJSON

func (v *NullableNextPage) UnmarshalJSON(src []byte) error

func (*NullableNextPage) Unset

func (v *NullableNextPage) Unset()

type NullablePublicSingleSendEmail

type NullablePublicSingleSendEmail struct {
	// contains filtered or unexported fields
}

func (NullablePublicSingleSendEmail) Get

func (NullablePublicSingleSendEmail) IsSet

func (NullablePublicSingleSendEmail) MarshalJSON

func (v NullablePublicSingleSendEmail) MarshalJSON() ([]byte, error)

func (*NullablePublicSingleSendEmail) Set

func (*NullablePublicSingleSendEmail) UnmarshalJSON

func (v *NullablePublicSingleSendEmail) UnmarshalJSON(src []byte) error

func (*NullablePublicSingleSendEmail) Unset

func (v *NullablePublicSingleSendEmail) Unset()

type NullablePublicSingleSendRequestEgg

type NullablePublicSingleSendRequestEgg struct {
	// contains filtered or unexported fields
}

func (NullablePublicSingleSendRequestEgg) Get

func (NullablePublicSingleSendRequestEgg) IsSet

func (NullablePublicSingleSendRequestEgg) MarshalJSON

func (v NullablePublicSingleSendRequestEgg) MarshalJSON() ([]byte, error)

func (*NullablePublicSingleSendRequestEgg) Set

func (*NullablePublicSingleSendRequestEgg) UnmarshalJSON

func (v *NullablePublicSingleSendRequestEgg) UnmarshalJSON(src []byte) error

func (*NullablePublicSingleSendRequestEgg) Unset

type NullableSmtpApiTokenRequestEgg

type NullableSmtpApiTokenRequestEgg struct {
	// contains filtered or unexported fields
}

func (NullableSmtpApiTokenRequestEgg) Get

func (NullableSmtpApiTokenRequestEgg) IsSet

func (NullableSmtpApiTokenRequestEgg) MarshalJSON

func (v NullableSmtpApiTokenRequestEgg) MarshalJSON() ([]byte, error)

func (*NullableSmtpApiTokenRequestEgg) Set

func (*NullableSmtpApiTokenRequestEgg) UnmarshalJSON

func (v *NullableSmtpApiTokenRequestEgg) UnmarshalJSON(src []byte) error

func (*NullableSmtpApiTokenRequestEgg) Unset

func (v *NullableSmtpApiTokenRequestEgg) Unset()

type NullableSmtpApiTokenView

type NullableSmtpApiTokenView struct {
	// contains filtered or unexported fields
}

func NewNullableSmtpApiTokenView

func NewNullableSmtpApiTokenView(val *SmtpApiTokenView) *NullableSmtpApiTokenView

func (NullableSmtpApiTokenView) Get

func (NullableSmtpApiTokenView) IsSet

func (v NullableSmtpApiTokenView) IsSet() bool

func (NullableSmtpApiTokenView) MarshalJSON

func (v NullableSmtpApiTokenView) MarshalJSON() ([]byte, error)

func (*NullableSmtpApiTokenView) Set

func (*NullableSmtpApiTokenView) UnmarshalJSON

func (v *NullableSmtpApiTokenView) UnmarshalJSON(src []byte) error

func (*NullableSmtpApiTokenView) Unset

func (v *NullableSmtpApiTokenView) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type PublicSingleSendEmail

type PublicSingleSendEmail struct {
	// List of email addresses to send as Cc.
	Cc []string `json:"cc,omitempty"`
	// ID for a particular send. No more than one email will be sent per sendId.
	SendId *string `json:"sendId,omitempty"`
	// List of email addresses to send as Bcc.
	Bcc []string `json:"bcc,omitempty"`
	// List of Reply-To header values for the email.
	ReplyTo []string `json:"replyTo,omitempty"`
	// The From header for the email.
	From *string `json:"from,omitempty"`
	// The recipient of the email.
	To string `json:"to"`
}

PublicSingleSendEmail A JSON object containing anything you want to override.

func NewPublicSingleSendEmail

func NewPublicSingleSendEmail(to string) *PublicSingleSendEmail

NewPublicSingleSendEmail instantiates a new PublicSingleSendEmail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPublicSingleSendEmailWithDefaults

func NewPublicSingleSendEmailWithDefaults() *PublicSingleSendEmail

NewPublicSingleSendEmailWithDefaults instantiates a new PublicSingleSendEmail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PublicSingleSendEmail) GetBcc

func (o *PublicSingleSendEmail) GetBcc() []string

GetBcc returns the Bcc field value if set, zero value otherwise.

func (*PublicSingleSendEmail) GetBccOk

func (o *PublicSingleSendEmail) GetBccOk() ([]string, bool)

GetBccOk returns a tuple with the Bcc field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendEmail) GetCc

func (o *PublicSingleSendEmail) GetCc() []string

GetCc returns the Cc field value if set, zero value otherwise.

func (*PublicSingleSendEmail) GetCcOk

func (o *PublicSingleSendEmail) GetCcOk() ([]string, bool)

GetCcOk returns a tuple with the Cc field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendEmail) GetFrom

func (o *PublicSingleSendEmail) GetFrom() string

GetFrom returns the From field value if set, zero value otherwise.

func (*PublicSingleSendEmail) GetFromOk

func (o *PublicSingleSendEmail) GetFromOk() (*string, bool)

GetFromOk returns a tuple with the From field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendEmail) GetReplyTo

func (o *PublicSingleSendEmail) GetReplyTo() []string

GetReplyTo returns the ReplyTo field value if set, zero value otherwise.

func (*PublicSingleSendEmail) GetReplyToOk

func (o *PublicSingleSendEmail) GetReplyToOk() ([]string, bool)

GetReplyToOk returns a tuple with the ReplyTo field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendEmail) GetSendId

func (o *PublicSingleSendEmail) GetSendId() string

GetSendId returns the SendId field value if set, zero value otherwise.

func (*PublicSingleSendEmail) GetSendIdOk

func (o *PublicSingleSendEmail) GetSendIdOk() (*string, bool)

GetSendIdOk returns a tuple with the SendId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendEmail) GetTo

func (o *PublicSingleSendEmail) GetTo() string

GetTo returns the To field value

func (*PublicSingleSendEmail) GetToOk

func (o *PublicSingleSendEmail) GetToOk() (*string, bool)

GetToOk returns a tuple with the To field value and a boolean to check if the value has been set.

func (*PublicSingleSendEmail) HasBcc

func (o *PublicSingleSendEmail) HasBcc() bool

HasBcc returns a boolean if a field has been set.

func (*PublicSingleSendEmail) HasCc

func (o *PublicSingleSendEmail) HasCc() bool

HasCc returns a boolean if a field has been set.

func (*PublicSingleSendEmail) HasFrom

func (o *PublicSingleSendEmail) HasFrom() bool

HasFrom returns a boolean if a field has been set.

func (*PublicSingleSendEmail) HasReplyTo

func (o *PublicSingleSendEmail) HasReplyTo() bool

HasReplyTo returns a boolean if a field has been set.

func (*PublicSingleSendEmail) HasSendId

func (o *PublicSingleSendEmail) HasSendId() bool

HasSendId returns a boolean if a field has been set.

func (PublicSingleSendEmail) MarshalJSON

func (o PublicSingleSendEmail) MarshalJSON() ([]byte, error)

func (*PublicSingleSendEmail) SetBcc

func (o *PublicSingleSendEmail) SetBcc(v []string)

SetBcc gets a reference to the given []string and assigns it to the Bcc field.

func (*PublicSingleSendEmail) SetCc

func (o *PublicSingleSendEmail) SetCc(v []string)

SetCc gets a reference to the given []string and assigns it to the Cc field.

func (*PublicSingleSendEmail) SetFrom

func (o *PublicSingleSendEmail) SetFrom(v string)

SetFrom gets a reference to the given string and assigns it to the From field.

func (*PublicSingleSendEmail) SetReplyTo

func (o *PublicSingleSendEmail) SetReplyTo(v []string)

SetReplyTo gets a reference to the given []string and assigns it to the ReplyTo field.

func (*PublicSingleSendEmail) SetSendId

func (o *PublicSingleSendEmail) SetSendId(v string)

SetSendId gets a reference to the given string and assigns it to the SendId field.

func (*PublicSingleSendEmail) SetTo

func (o *PublicSingleSendEmail) SetTo(v string)

SetTo sets field value

type PublicSingleSendRequestEgg

type PublicSingleSendRequestEgg struct {
	// 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]map[string]interface{} `json:"customProperties,omitempty"`
	// The content ID for the transactional email, which can be found in email tool UI.
	EmailId int32                 `json:"emailId"`
	Message PublicSingleSendEmail `json:"message"`
	// 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 *map[string]string `json:"contactProperties,omitempty"`
}

PublicSingleSendRequestEgg A request to send a single transactional email asynchronously.

func NewPublicSingleSendRequestEgg

func NewPublicSingleSendRequestEgg(emailId int32, message PublicSingleSendEmail) *PublicSingleSendRequestEgg

NewPublicSingleSendRequestEgg instantiates a new PublicSingleSendRequestEgg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewPublicSingleSendRequestEggWithDefaults

func NewPublicSingleSendRequestEggWithDefaults() *PublicSingleSendRequestEgg

NewPublicSingleSendRequestEggWithDefaults instantiates a new PublicSingleSendRequestEgg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*PublicSingleSendRequestEgg) GetContactProperties

func (o *PublicSingleSendRequestEgg) GetContactProperties() map[string]string

GetContactProperties returns the ContactProperties field value if set, zero value otherwise.

func (*PublicSingleSendRequestEgg) GetContactPropertiesOk

func (o *PublicSingleSendRequestEgg) GetContactPropertiesOk() (*map[string]string, bool)

GetContactPropertiesOk returns a tuple with the ContactProperties field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendRequestEgg) GetCustomProperties

func (o *PublicSingleSendRequestEgg) GetCustomProperties() map[string]map[string]interface{}

GetCustomProperties returns the CustomProperties field value if set, zero value otherwise.

func (*PublicSingleSendRequestEgg) GetCustomPropertiesOk

func (o *PublicSingleSendRequestEgg) GetCustomPropertiesOk() (map[string]map[string]interface{}, bool)

GetCustomPropertiesOk returns a tuple with the CustomProperties field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublicSingleSendRequestEgg) GetEmailId

func (o *PublicSingleSendRequestEgg) GetEmailId() int32

GetEmailId returns the EmailId field value

func (*PublicSingleSendRequestEgg) GetEmailIdOk

func (o *PublicSingleSendRequestEgg) GetEmailIdOk() (*int32, bool)

GetEmailIdOk returns a tuple with the EmailId field value and a boolean to check if the value has been set.

func (*PublicSingleSendRequestEgg) GetMessage

GetMessage returns the Message field value

func (*PublicSingleSendRequestEgg) GetMessageOk

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (*PublicSingleSendRequestEgg) HasContactProperties

func (o *PublicSingleSendRequestEgg) HasContactProperties() bool

HasContactProperties returns a boolean if a field has been set.

func (*PublicSingleSendRequestEgg) HasCustomProperties

func (o *PublicSingleSendRequestEgg) HasCustomProperties() bool

HasCustomProperties returns a boolean if a field has been set.

func (PublicSingleSendRequestEgg) MarshalJSON

func (o PublicSingleSendRequestEgg) MarshalJSON() ([]byte, error)

func (*PublicSingleSendRequestEgg) SetContactProperties

func (o *PublicSingleSendRequestEgg) SetContactProperties(v map[string]string)

SetContactProperties gets a reference to the given map[string]string and assigns it to the ContactProperties field.

func (*PublicSingleSendRequestEgg) SetCustomProperties

func (o *PublicSingleSendRequestEgg) SetCustomProperties(v map[string]map[string]interface{})

SetCustomProperties gets a reference to the given map[string]map[string]interface{} and assigns it to the CustomProperties field.

func (*PublicSingleSendRequestEgg) SetEmailId

func (o *PublicSingleSendRequestEgg) SetEmailId(v int32)

SetEmailId sets field value

func (*PublicSingleSendRequestEgg) SetMessage

SetMessage sets field value

type PublicSmtpTokensApiService

type PublicSmtpTokensApiService service

PublicSmtpTokensApiService PublicSmtpTokensApi service

func (*PublicSmtpTokensApiService) ArchiveToken

ArchiveToken Delete a single token by ID.

Delete a single token by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tokenId Identifier generated when a token is created.
@return ApiArchiveTokenRequest

func (*PublicSmtpTokensApiService) ArchiveTokenExecute

Execute executes the request

func (*PublicSmtpTokensApiService) CreateToken

CreateToken Create a SMTP API token.

Create a SMTP API token.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateTokenRequest

func (*PublicSmtpTokensApiService) CreateTokenExecute

Execute executes the request

@return SmtpApiTokenView

func (*PublicSmtpTokensApiService) GetTokenByID

GetTokenByID Query a single token by ID.

Query a single token by ID.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tokenId Identifier generated when a token is created.
@return ApiGetTokenByIDRequest

func (*PublicSmtpTokensApiService) GetTokenByIDExecute

Execute executes the request

@return SmtpApiTokenView

func (*PublicSmtpTokensApiService) GetTokensPage

GetTokensPage Query SMTP API tokens by campaign name or an emailCampaignId.

Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetTokensPageRequest

func (*PublicSmtpTokensApiService) GetTokensPageExecute

Execute executes the request

@return CollectionResponseSmtpApiTokenViewForwardPaging

func (*PublicSmtpTokensApiService) ResetPassword

ResetPassword Reset the password of an existing token.

Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tokenId Identifier generated when a token is created.
@return ApiResetPasswordRequest

func (*PublicSmtpTokensApiService) ResetPasswordExecute

Execute executes the request

@return SmtpApiTokenView

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SingleSendApiService

type SingleSendApiService service

SingleSendApiService SingleSendApi service

func (*SingleSendApiService) SendEmail

SendEmail Send a single transactional email asynchronously.

Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiSendEmailRequest

func (*SingleSendApiService) SendEmailExecute

Execute executes the request

@return EmailSendStatusView

type SmtpApiTokenRequestEgg

type SmtpApiTokenRequestEgg struct {
	// Indicates whether a contact should be created for email recipients.
	CreateContact bool `json:"createContact"`
	// A name for the campaign tied to the SMTP API token.
	CampaignName string `json:"campaignName"`
}

SmtpApiTokenRequestEgg A request object to create a SMTP API token

func NewSmtpApiTokenRequestEgg

func NewSmtpApiTokenRequestEgg(createContact bool, campaignName string) *SmtpApiTokenRequestEgg

NewSmtpApiTokenRequestEgg instantiates a new SmtpApiTokenRequestEgg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSmtpApiTokenRequestEggWithDefaults

func NewSmtpApiTokenRequestEggWithDefaults() *SmtpApiTokenRequestEgg

NewSmtpApiTokenRequestEggWithDefaults instantiates a new SmtpApiTokenRequestEgg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SmtpApiTokenRequestEgg) GetCampaignName

func (o *SmtpApiTokenRequestEgg) GetCampaignName() string

GetCampaignName returns the CampaignName field value

func (*SmtpApiTokenRequestEgg) GetCampaignNameOk

func (o *SmtpApiTokenRequestEgg) GetCampaignNameOk() (*string, bool)

GetCampaignNameOk returns a tuple with the CampaignName field value and a boolean to check if the value has been set.

func (*SmtpApiTokenRequestEgg) GetCreateContact

func (o *SmtpApiTokenRequestEgg) GetCreateContact() bool

GetCreateContact returns the CreateContact field value

func (*SmtpApiTokenRequestEgg) GetCreateContactOk

func (o *SmtpApiTokenRequestEgg) GetCreateContactOk() (*bool, bool)

GetCreateContactOk returns a tuple with the CreateContact field value and a boolean to check if the value has been set.

func (SmtpApiTokenRequestEgg) MarshalJSON

func (o SmtpApiTokenRequestEgg) MarshalJSON() ([]byte, error)

func (*SmtpApiTokenRequestEgg) SetCampaignName

func (o *SmtpApiTokenRequestEgg) SetCampaignName(v string)

SetCampaignName sets field value

func (*SmtpApiTokenRequestEgg) SetCreateContact

func (o *SmtpApiTokenRequestEgg) SetCreateContact(v bool)

SetCreateContact sets field value

type SmtpApiTokenView

type SmtpApiTokenView struct {
	// Timestamp generated when a token is created.
	CreatedAt time.Time `json:"createdAt"`
	// Password used to log into the HubSpot SMTP server.
	Password *string `json:"password,omitempty"`
	// Email address of the user that sent the token creation request.
	CreatedBy string `json:"createdBy"`
	// Indicates whether a contact should be created for email recipients.
	CreateContact bool `json:"createContact"`
	// User name to log into the HubSpot SMTP server.
	Id string `json:"id"`
	// Identifier assigned to the campaign provided in the token creation request.
	EmailCampaignId string `json:"emailCampaignId"`
	// A name for the campaign tied to the token.
	CampaignName string `json:"campaignName"`
}

SmtpApiTokenView A SMTP API token provides both an ID and password that can be used to send email through the HubSpot SMTP API.

func NewSmtpApiTokenView

func NewSmtpApiTokenView(createdAt time.Time, createdBy string, createContact bool, id string, emailCampaignId string, campaignName string) *SmtpApiTokenView

NewSmtpApiTokenView instantiates a new SmtpApiTokenView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewSmtpApiTokenViewWithDefaults

func NewSmtpApiTokenViewWithDefaults() *SmtpApiTokenView

NewSmtpApiTokenViewWithDefaults instantiates a new SmtpApiTokenView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*SmtpApiTokenView) GetCampaignName

func (o *SmtpApiTokenView) GetCampaignName() string

GetCampaignName returns the CampaignName field value

func (*SmtpApiTokenView) GetCampaignNameOk

func (o *SmtpApiTokenView) GetCampaignNameOk() (*string, bool)

GetCampaignNameOk returns a tuple with the CampaignName field value and a boolean to check if the value has been set.

func (*SmtpApiTokenView) GetCreateContact

func (o *SmtpApiTokenView) GetCreateContact() bool

GetCreateContact returns the CreateContact field value

func (*SmtpApiTokenView) GetCreateContactOk

func (o *SmtpApiTokenView) GetCreateContactOk() (*bool, bool)

GetCreateContactOk returns a tuple with the CreateContact field value and a boolean to check if the value has been set.

func (*SmtpApiTokenView) GetCreatedAt

func (o *SmtpApiTokenView) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value

func (*SmtpApiTokenView) GetCreatedAtOk

func (o *SmtpApiTokenView) GetCreatedAtOk() (*time.Time, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field value and a boolean to check if the value has been set.

func (*SmtpApiTokenView) GetCreatedBy

func (o *SmtpApiTokenView) GetCreatedBy() string

GetCreatedBy returns the CreatedBy field value

func (*SmtpApiTokenView) GetCreatedByOk

func (o *SmtpApiTokenView) GetCreatedByOk() (*string, bool)

GetCreatedByOk returns a tuple with the CreatedBy field value and a boolean to check if the value has been set.

func (*SmtpApiTokenView) GetEmailCampaignId

func (o *SmtpApiTokenView) GetEmailCampaignId() string

GetEmailCampaignId returns the EmailCampaignId field value

func (*SmtpApiTokenView) GetEmailCampaignIdOk

func (o *SmtpApiTokenView) GetEmailCampaignIdOk() (*string, bool)

GetEmailCampaignIdOk returns a tuple with the EmailCampaignId field value and a boolean to check if the value has been set.

func (*SmtpApiTokenView) GetId

func (o *SmtpApiTokenView) GetId() string

GetId returns the Id field value

func (*SmtpApiTokenView) GetIdOk

func (o *SmtpApiTokenView) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field value and a boolean to check if the value has been set.

func (*SmtpApiTokenView) GetPassword

func (o *SmtpApiTokenView) GetPassword() string

GetPassword returns the Password field value if set, zero value otherwise.

func (*SmtpApiTokenView) GetPasswordOk

func (o *SmtpApiTokenView) GetPasswordOk() (*string, bool)

GetPasswordOk returns a tuple with the Password field value if set, nil otherwise and a boolean to check if the value has been set.

func (*SmtpApiTokenView) HasPassword

func (o *SmtpApiTokenView) HasPassword() bool

HasPassword returns a boolean if a field has been set.

func (SmtpApiTokenView) MarshalJSON

func (o SmtpApiTokenView) MarshalJSON() ([]byte, error)

func (*SmtpApiTokenView) SetCampaignName

func (o *SmtpApiTokenView) SetCampaignName(v string)

SetCampaignName sets field value

func (*SmtpApiTokenView) SetCreateContact

func (o *SmtpApiTokenView) SetCreateContact(v bool)

SetCreateContact sets field value

func (*SmtpApiTokenView) SetCreatedAt

func (o *SmtpApiTokenView) SetCreatedAt(v time.Time)

SetCreatedAt sets field value

func (*SmtpApiTokenView) SetCreatedBy

func (o *SmtpApiTokenView) SetCreatedBy(v string)

SetCreatedBy sets field value

func (*SmtpApiTokenView) SetEmailCampaignId

func (o *SmtpApiTokenView) SetEmailCampaignId(v string)

SetEmailCampaignId sets field value

func (*SmtpApiTokenView) SetId

func (o *SmtpApiTokenView) SetId(v string)

SetId sets field value

func (*SmtpApiTokenView) SetPassword

func (o *SmtpApiTokenView) SetPassword(v string)

SetPassword gets a reference to the given string and assigns it to the Password field.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL