Documentation ¶
Overview ¶
Package timeline provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Package timeline provides primitives to interact with the openapi HTTP API.
Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.
Index ¶
- Constants
- type ArchiveEventTemplateResponse
- type ArchiveTokenNameResponse
- type BatchInputTimelineEvent
- type BatchResponseTimelineEventResponse
- type BatchResponseTimelineEventResponseStatus
- type BatchResponseTimelineEventResponseWithErrors
- type BatchResponseTimelineEventResponseWithErrorsStatus
- type BatchResponseTimelineEventResponseWithErrors_Links
- func (a BatchResponseTimelineEventResponseWithErrors_Links) Get(fieldName string) (value string, found bool)
- func (a BatchResponseTimelineEventResponseWithErrors_Links) MarshalJSON() ([]byte, error)
- func (a *BatchResponseTimelineEventResponseWithErrors_Links) Set(fieldName string, value string)
- func (a *BatchResponseTimelineEventResponseWithErrors_Links) UnmarshalJSON(b []byte) error
- type BatchResponseTimelineEventResponse_Links
- func (a BatchResponseTimelineEventResponse_Links) Get(fieldName string) (value string, found bool)
- func (a BatchResponseTimelineEventResponse_Links) MarshalJSON() ([]byte, error)
- func (a *BatchResponseTimelineEventResponse_Links) Set(fieldName string, value string)
- func (a *BatchResponseTimelineEventResponse_Links) UnmarshalJSON(b []byte) error
- type Client
- func (c *Client) ArchiveEventTemplate(ctx context.Context, appId int32, eventTemplateId string, ...) (*ArchiveEventTemplateResponse, error)
- func (c *Client) ArchiveTokenName(ctx context.Context, appId int32, eventTemplateId string, tokenName string, ...) (*ArchiveTokenNameResponse, error)
- func (c *Client) CreateBatch(ctx context.Context, body CreateBatchJSONRequestBody, ...) (*CreateBatchResponse, error)
- func (c *Client) CreateBatchWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*CreateBatchResponse, error)
- func (c *Client) CreateEventTemplates(ctx context.Context, appId int32, body CreateEventTemplatesJSONRequestBody, ...) (*CreateEventTemplatesResponse, error)
- func (c *Client) CreateEventTemplatesWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, ...) (*CreateEventTemplatesResponse, error)
- func (c *Client) CreateEvents(ctx context.Context, body CreateEventsJSONRequestBody, ...) (*CreateEventsResponse, error)
- func (c *Client) CreateEventsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*CreateEventsResponse, error)
- func (c *Client) CreateTokens(ctx context.Context, appId int32, eventTemplateId string, ...) (*CreateTokensResponse, error)
- func (c *Client) CreateTokensWithBody(ctx context.Context, appId int32, eventTemplateId string, contentType string, ...) (*CreateTokensResponse, error)
- func (c *Client) GetAllEventTemplates(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllEventTemplatesResponse, error)
- func (c *Client) GetDetailById(ctx context.Context, eventTemplateId string, eventId string, ...) (*GetDetailByIdResponse, error)
- func (c *Client) GetEvent(ctx context.Context, eventTemplateId string, eventId string, ...) (*GetEventResponse, error)
- func (c *Client) GetEventTemplate(ctx context.Context, appId int32, eventTemplateId string, ...) (*GetEventTemplateResponse, error)
- func (c *Client) GetRenderById(ctx context.Context, eventTemplateId string, eventId string, ...) (*GetRenderByIdResponse, error)
- func (c *Client) UpdateEventTemplate(ctx context.Context, appId int32, eventTemplateId string, ...) (*UpdateEventTemplateResponse, error)
- func (c *Client) UpdateEventTemplateWithBody(ctx context.Context, appId int32, eventTemplateId string, contentType string, ...) (*UpdateEventTemplateResponse, error)
- func (c *Client) UpdateTokenName(ctx context.Context, appId int32, eventTemplateId string, tokenName string, ...) (*UpdateTokenNameResponse, error)
- func (c *Client) UpdateTokenNameWithBody(ctx context.Context, appId int32, eventTemplateId string, tokenName string, ...) (*UpdateTokenNameResponse, error)
- type ClientInterface
- type CollectionResponseTimelineEventTemplateNoPaging
- type CreateBatchJSONBody
- type CreateBatchJSONRequestBody
- type CreateBatchResponse
- type CreateEventTemplatesJSONBody
- type CreateEventTemplatesJSONRequestBody
- type CreateEventTemplatesResponse
- type CreateEventsJSONBody
- type CreateEventsJSONRequestBody
- type CreateEventsResponse
- type CreateTokensJSONBody
- type CreateTokensJSONRequestBody
- type CreateTokensResponse
- type Error
- type ErrorCategory
- type ErrorCategoryHttpStatus
- type ErrorDetail
- type ErrorDetail_Context
- type Error_Context
- type Error_Links
- type EventDetail
- type GetAllEventTemplatesResponse
- type GetDetailByIdResponse
- type GetEventResponse
- type GetEventTemplateResponse
- type GetRenderByIdParams
- type GetRenderByIdResponse
- type StandardError
- type StandardError_Context
- type StandardError_Links
- type TimelineEvent
- type TimelineEventIFrame
- type TimelineEventResponse
- type TimelineEventResponse_Tokens
- type TimelineEventTemplate
- type TimelineEventTemplateCreateRequest
- type TimelineEventTemplateToken
- type TimelineEventTemplateTokenOption
- type TimelineEventTemplateTokenType
- type TimelineEventTemplateTokenUpdateRequest
- type TimelineEventTemplateUpdateRequest
- type TimelineEvent_Tokens
- type UpdateEventTemplateJSONBody
- type UpdateEventTemplateJSONRequestBody
- type UpdateEventTemplateResponse
- type UpdateTokenNameJSONBody
- type UpdateTokenNameJSONRequestBody
- type UpdateTokenNameResponse
Constants ¶
const ( Developer_hapikeyScopes = "developer_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 ArchiveEventTemplateResponse ¶
func (ArchiveEventTemplateResponse) Status ¶
func (r ArchiveEventTemplateResponse) Status() string
Status returns HTTPResponse.Status
func (ArchiveEventTemplateResponse) StatusCode ¶
func (r ArchiveEventTemplateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ArchiveTokenNameResponse ¶
func (ArchiveTokenNameResponse) Status ¶
func (r ArchiveTokenNameResponse) Status() string
Status returns HTTPResponse.Status
func (ArchiveTokenNameResponse) StatusCode ¶
func (r ArchiveTokenNameResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type BatchInputTimelineEvent ¶
type BatchInputTimelineEvent struct { // A collection of timeline events we want to create. Inputs []TimelineEvent `json:"inputs"` }
Used to create timeline events in batches.
type BatchResponseTimelineEventResponse ¶
type BatchResponseTimelineEventResponse struct { // The time the request was completed. CompletedAt time.Time `json:"completedAt"` Links *BatchResponseTimelineEventResponse_Links `json:"links,omitempty"` // The time the request occurred. RequestedAt *time.Time `json:"requestedAt,omitempty"` // Successfully created events. Results []TimelineEventResponse `json:"results"` // The time the request began processing. StartedAt time.Time `json:"startedAt"` // The status of the batch response. Should always be COMPLETED if processed. Status BatchResponseTimelineEventResponseStatus `json:"status"` }
The state of the batch event request.
type BatchResponseTimelineEventResponseStatus ¶
type BatchResponseTimelineEventResponseStatus string
The status of the batch response. Should always be COMPLETED if processed.
const ( BatchResponseTimelineEventResponseStatusCANCELED BatchResponseTimelineEventResponseStatus = "CANCELED" BatchResponseTimelineEventResponseStatusCOMPLETE BatchResponseTimelineEventResponseStatus = "COMPLETE" BatchResponseTimelineEventResponseStatusPENDING BatchResponseTimelineEventResponseStatus = "PENDING" BatchResponseTimelineEventResponseStatusPROCESSING BatchResponseTimelineEventResponseStatus = "PROCESSING" )
Defines values for BatchResponseTimelineEventResponseStatus.
type BatchResponseTimelineEventResponseWithErrors ¶
type BatchResponseTimelineEventResponseWithErrors struct { CompletedAt time.Time `json:"completedAt"` Errors *[]StandardError `json:"errors,omitempty"` Links *BatchResponseTimelineEventResponseWithErrors_Links `json:"links,omitempty"` NumErrors *int32 `json:"numErrors,omitempty"` RequestedAt *time.Time `json:"requestedAt,omitempty"` Results []TimelineEventResponse `json:"results"` StartedAt time.Time `json:"startedAt"` Status BatchResponseTimelineEventResponseWithErrorsStatus `json:"status"` }
BatchResponseTimelineEventResponseWithErrors defines model for BatchResponseTimelineEventResponseWithErrors.
type BatchResponseTimelineEventResponseWithErrorsStatus ¶
type BatchResponseTimelineEventResponseWithErrorsStatus string
BatchResponseTimelineEventResponseWithErrorsStatus defines model for BatchResponseTimelineEventResponseWithErrors.Status.
const ( BatchResponseTimelineEventResponseWithErrorsStatusCANCELED BatchResponseTimelineEventResponseWithErrorsStatus = "CANCELED" BatchResponseTimelineEventResponseWithErrorsStatusCOMPLETE BatchResponseTimelineEventResponseWithErrorsStatus = "COMPLETE" BatchResponseTimelineEventResponseWithErrorsStatusPENDING BatchResponseTimelineEventResponseWithErrorsStatus = "PENDING" BatchResponseTimelineEventResponseWithErrorsStatusPROCESSING BatchResponseTimelineEventResponseWithErrorsStatus = "PROCESSING" )
Defines values for BatchResponseTimelineEventResponseWithErrorsStatus.
type BatchResponseTimelineEventResponseWithErrors_Links ¶
type BatchResponseTimelineEventResponseWithErrors_Links struct {
AdditionalProperties map[string]string `json:"-"`
}
BatchResponseTimelineEventResponseWithErrors_Links defines model for BatchResponseTimelineEventResponseWithErrors.Links.
func (BatchResponseTimelineEventResponseWithErrors_Links) Get ¶
func (a BatchResponseTimelineEventResponseWithErrors_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for BatchResponseTimelineEventResponseWithErrors_Links. Returns the specified element and whether it was found
func (BatchResponseTimelineEventResponseWithErrors_Links) MarshalJSON ¶
func (a BatchResponseTimelineEventResponseWithErrors_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for BatchResponseTimelineEventResponseWithErrors_Links to handle AdditionalProperties
func (*BatchResponseTimelineEventResponseWithErrors_Links) Set ¶
func (a *BatchResponseTimelineEventResponseWithErrors_Links) Set(fieldName string, value string)
Setter for additional properties for BatchResponseTimelineEventResponseWithErrors_Links
func (*BatchResponseTimelineEventResponseWithErrors_Links) UnmarshalJSON ¶
func (a *BatchResponseTimelineEventResponseWithErrors_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for BatchResponseTimelineEventResponseWithErrors_Links to handle AdditionalProperties
type BatchResponseTimelineEventResponse_Links ¶
type BatchResponseTimelineEventResponse_Links struct {
AdditionalProperties map[string]string `json:"-"`
}
BatchResponseTimelineEventResponse_Links defines model for BatchResponseTimelineEventResponse.Links.
func (BatchResponseTimelineEventResponse_Links) Get ¶
func (a BatchResponseTimelineEventResponse_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for BatchResponseTimelineEventResponse_Links. Returns the specified element and whether it was found
func (BatchResponseTimelineEventResponse_Links) MarshalJSON ¶
func (a BatchResponseTimelineEventResponse_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for BatchResponseTimelineEventResponse_Links to handle AdditionalProperties
func (*BatchResponseTimelineEventResponse_Links) Set ¶
func (a *BatchResponseTimelineEventResponse_Links) Set(fieldName string, value string)
Setter for additional properties for BatchResponseTimelineEventResponse_Links
func (*BatchResponseTimelineEventResponse_Links) UnmarshalJSON ¶
func (a *BatchResponseTimelineEventResponse_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for BatchResponseTimelineEventResponse_Links to handle AdditionalProperties
type Client ¶
Client conforms to the OpenAPI3 specification for this service.
func (*Client) ArchiveEventTemplate ¶
func (c *Client) ArchiveEventTemplate(ctx context.Context, appId int32, eventTemplateId string, reqEditors ...client.RequestEditorFn) (*ArchiveEventTemplateResponse, error)
ArchiveEventTemplate request returning *ArchiveEventTemplateResponse
func (*Client) ArchiveTokenName ¶
func (c *Client) ArchiveTokenName(ctx context.Context, appId int32, eventTemplateId string, tokenName string, reqEditors ...client.RequestEditorFn) (*ArchiveTokenNameResponse, error)
ArchiveTokenName request returning *ArchiveTokenNameResponse
func (*Client) CreateBatch ¶
func (c *Client) CreateBatch(ctx context.Context, body CreateBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error)
func (*Client) CreateBatchWithBody ¶
func (c *Client) CreateBatchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error)
CreateBatchWithBody request with arbitrary body returning *CreateBatchResponse
func (*Client) CreateEventTemplates ¶
func (c *Client) CreateEventTemplates(ctx context.Context, appId int32, body CreateEventTemplatesJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateEventTemplatesResponse, error)
func (*Client) CreateEventTemplatesWithBody ¶
func (c *Client) CreateEventTemplatesWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateEventTemplatesResponse, error)
CreateEventTemplatesWithBody request with arbitrary body returning *CreateEventTemplatesResponse
func (*Client) CreateEvents ¶
func (c *Client) CreateEvents(ctx context.Context, body CreateEventsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateEventsResponse, error)
func (*Client) CreateEventsWithBody ¶
func (c *Client) CreateEventsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateEventsResponse, error)
CreateEventsWithBody request with arbitrary body returning *CreateEventsResponse
func (*Client) CreateTokens ¶
func (c *Client) CreateTokens(ctx context.Context, appId int32, eventTemplateId string, body CreateTokensJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateTokensResponse, error)
func (*Client) CreateTokensWithBody ¶
func (c *Client) CreateTokensWithBody(ctx context.Context, appId int32, eventTemplateId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateTokensResponse, error)
CreateTokensWithBody request with arbitrary body returning *CreateTokensResponse
func (*Client) GetAllEventTemplates ¶
func (c *Client) GetAllEventTemplates(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllEventTemplatesResponse, error)
GetAllEventTemplates request returning *GetAllEventTemplatesResponse
func (*Client) GetDetailById ¶
func (c *Client) GetDetailById(ctx context.Context, eventTemplateId string, eventId string, reqEditors ...client.RequestEditorFn) (*GetDetailByIdResponse, error)
GetDetailById request returning *GetDetailByIdResponse
func (*Client) GetEvent ¶
func (c *Client) GetEvent(ctx context.Context, eventTemplateId string, eventId string, reqEditors ...client.RequestEditorFn) (*GetEventResponse, error)
GetEvent request returning *GetEventResponse
func (*Client) GetEventTemplate ¶
func (c *Client) GetEventTemplate(ctx context.Context, appId int32, eventTemplateId string, reqEditors ...client.RequestEditorFn) (*GetEventTemplateResponse, error)
GetEventTemplate request returning *GetEventTemplateResponse
func (*Client) GetRenderById ¶
func (c *Client) GetRenderById(ctx context.Context, eventTemplateId string, eventId string, params *GetRenderByIdParams, reqEditors ...client.RequestEditorFn) (*GetRenderByIdResponse, error)
GetRenderById request returning *GetRenderByIdResponse
func (*Client) UpdateEventTemplate ¶
func (c *Client) UpdateEventTemplate(ctx context.Context, appId int32, eventTemplateId string, body UpdateEventTemplateJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateEventTemplateResponse, error)
func (*Client) UpdateEventTemplateWithBody ¶
func (c *Client) UpdateEventTemplateWithBody(ctx context.Context, appId int32, eventTemplateId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateEventTemplateResponse, error)
UpdateEventTemplateWithBody request with arbitrary body returning *UpdateEventTemplateResponse
func (*Client) UpdateTokenName ¶
func (c *Client) UpdateTokenName(ctx context.Context, appId int32, eventTemplateId string, tokenName string, body UpdateTokenNameJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateTokenNameResponse, error)
func (*Client) UpdateTokenNameWithBody ¶
func (c *Client) UpdateTokenNameWithBody(ctx context.Context, appId int32, eventTemplateId string, tokenName string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateTokenNameResponse, error)
UpdateTokenNameWithBody request with arbitrary body returning *UpdateTokenNameResponse
type ClientInterface ¶
type ClientInterface interface { // CreateEvents request with any body CreateEventsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateEventsResponse, error) CreateEvents(ctx context.Context, body CreateEventsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateEventsResponse, error) // CreateBatch request with any body CreateBatchWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error) CreateBatch(ctx context.Context, body CreateBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error) // GetEvent request GetEvent(ctx context.Context, eventTemplateId string, eventId string, reqEditors ...client.RequestEditorFn) (*GetEventResponse, error) // GetDetailById request GetDetailById(ctx context.Context, eventTemplateId string, eventId string, reqEditors ...client.RequestEditorFn) (*GetDetailByIdResponse, error) // GetRenderById request GetRenderById(ctx context.Context, eventTemplateId string, eventId string, params *GetRenderByIdParams, reqEditors ...client.RequestEditorFn) (*GetRenderByIdResponse, error) // GetAllEventTemplates request GetAllEventTemplates(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllEventTemplatesResponse, error) // CreateEventTemplates request with any body CreateEventTemplatesWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateEventTemplatesResponse, error) CreateEventTemplates(ctx context.Context, appId int32, body CreateEventTemplatesJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateEventTemplatesResponse, error) // ArchiveEventTemplate request ArchiveEventTemplate(ctx context.Context, appId int32, eventTemplateId string, reqEditors ...client.RequestEditorFn) (*ArchiveEventTemplateResponse, error) // GetEventTemplate request GetEventTemplate(ctx context.Context, appId int32, eventTemplateId string, reqEditors ...client.RequestEditorFn) (*GetEventTemplateResponse, error) // UpdateEventTemplate request with any body UpdateEventTemplateWithBody(ctx context.Context, appId int32, eventTemplateId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateEventTemplateResponse, error) UpdateEventTemplate(ctx context.Context, appId int32, eventTemplateId string, body UpdateEventTemplateJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateEventTemplateResponse, error) // CreateTokens request with any body CreateTokensWithBody(ctx context.Context, appId int32, eventTemplateId string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateTokensResponse, error) CreateTokens(ctx context.Context, appId int32, eventTemplateId string, body CreateTokensJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateTokensResponse, error) // ArchiveTokenName request ArchiveTokenName(ctx context.Context, appId int32, eventTemplateId string, tokenName string, reqEditors ...client.RequestEditorFn) (*ArchiveTokenNameResponse, error) // UpdateTokenName request with any body UpdateTokenNameWithBody(ctx context.Context, appId int32, eventTemplateId string, tokenName string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateTokenNameResponse, error) UpdateTokenName(ctx context.Context, appId int32, eventTemplateId string, tokenName string, body UpdateTokenNameJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateTokenNameResponse, error) }
ClientInterface interface specification for the client.
type CollectionResponseTimelineEventTemplateNoPaging ¶
type CollectionResponseTimelineEventTemplateNoPaging struct {
Results []TimelineEventTemplate `json:"results"`
}
CollectionResponseTimelineEventTemplateNoPaging defines model for CollectionResponseTimelineEventTemplateNoPaging.
type CreateBatchJSONBody ¶
type CreateBatchJSONBody BatchInputTimelineEvent
CreateBatchJSONBody defines parameters for CreateBatch.
type CreateBatchJSONRequestBody ¶
type CreateBatchJSONRequestBody CreateBatchJSONBody
CreateBatchJSONRequestBody defines body for CreateBatch for application/json ContentType.
type CreateBatchResponse ¶
type CreateBatchResponse struct { Body []byte HTTPResponse *http.Response JSON201 *BatchResponseTimelineEventResponse JSON207 *BatchResponseTimelineEventResponseWithErrors }
func (CreateBatchResponse) Status ¶
func (r CreateBatchResponse) Status() string
Status returns HTTPResponse.Status
func (CreateBatchResponse) StatusCode ¶
func (r CreateBatchResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateEventTemplatesJSONBody ¶
type CreateEventTemplatesJSONBody TimelineEventTemplateCreateRequest
CreateEventTemplatesJSONBody defines parameters for CreateEventTemplates.
type CreateEventTemplatesJSONRequestBody ¶
type CreateEventTemplatesJSONRequestBody CreateEventTemplatesJSONBody
CreateEventTemplatesJSONRequestBody defines body for CreateEventTemplates for application/json ContentType.
type CreateEventTemplatesResponse ¶
type CreateEventTemplatesResponse struct { Body []byte HTTPResponse *http.Response JSON201 *TimelineEventTemplate }
func (CreateEventTemplatesResponse) Status ¶
func (r CreateEventTemplatesResponse) Status() string
Status returns HTTPResponse.Status
func (CreateEventTemplatesResponse) StatusCode ¶
func (r CreateEventTemplatesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateEventsJSONBody ¶
type CreateEventsJSONBody TimelineEvent
CreateEventsJSONBody defines parameters for CreateEvents.
type CreateEventsJSONRequestBody ¶
type CreateEventsJSONRequestBody CreateEventsJSONBody
CreateEventsJSONRequestBody defines body for CreateEvents for application/json ContentType.
type CreateEventsResponse ¶
type CreateEventsResponse struct { Body []byte HTTPResponse *http.Response JSON201 *TimelineEventResponse }
func (CreateEventsResponse) Status ¶
func (r CreateEventsResponse) Status() string
Status returns HTTPResponse.Status
func (CreateEventsResponse) StatusCode ¶
func (r CreateEventsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateTokensJSONBody ¶
type CreateTokensJSONBody TimelineEventTemplateToken
CreateTokensJSONBody defines parameters for CreateTokens.
type CreateTokensJSONRequestBody ¶
type CreateTokensJSONRequestBody CreateTokensJSONBody
CreateTokensJSONRequestBody defines body for CreateTokens for application/json ContentType.
type CreateTokensResponse ¶
type CreateTokensResponse struct { Body []byte HTTPResponse *http.Response JSON200 *TimelineEventTemplateToken }
func (CreateTokensResponse) Status ¶
func (r CreateTokensResponse) Status() string
Status returns HTTPResponse.Status
func (CreateTokensResponse) StatusCode ¶
func (r CreateTokensResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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 ErrorCategory ¶
type ErrorCategory struct { HttpStatus ErrorCategoryHttpStatus `json:"httpStatus"` Name string `json:"name"` }
ErrorCategory defines model for ErrorCategory.
type ErrorCategoryHttpStatus ¶
type ErrorCategoryHttpStatus string
ErrorCategoryHttpStatus defines model for ErrorCategory.HttpStatus.
const ( ErrorCategoryHttpStatusACCEPTED ErrorCategoryHttpStatus = "ACCEPTED" ErrorCategoryHttpStatusALREADYREPORTED ErrorCategoryHttpStatus = "ALREADY_REPORTED" ErrorCategoryHttpStatusBADGATEWAY ErrorCategoryHttpStatus = "BAD_GATEWAY" ErrorCategoryHttpStatusBADREQUEST ErrorCategoryHttpStatus = "BAD_REQUEST" ErrorCategoryHttpStatusCONFLICT ErrorCategoryHttpStatus = "CONFLICT" ErrorCategoryHttpStatusCONTINUE ErrorCategoryHttpStatus = "CONTINUE" ErrorCategoryHttpStatusCREATED ErrorCategoryHttpStatus = "CREATED" ErrorCategoryHttpStatusEXPECTATIONFAILED ErrorCategoryHttpStatus = "EXPECTATION_FAILED" ErrorCategoryHttpStatusFAILEDDEPENDENCY ErrorCategoryHttpStatus = "FAILED_DEPENDENCY" ErrorCategoryHttpStatusFORBIDDEN ErrorCategoryHttpStatus = "FORBIDDEN" ErrorCategoryHttpStatusFOUND ErrorCategoryHttpStatus = "FOUND" ErrorCategoryHttpStatusGATEWAYTIMEOUT ErrorCategoryHttpStatus = "GATEWAY_TIMEOUT" ErrorCategoryHttpStatusGONE ErrorCategoryHttpStatus = "GONE" ErrorCategoryHttpStatusHTTPVERSIONNOTSUPPORTED ErrorCategoryHttpStatus = "HTTP_VERSION_NOT_SUPPORTED" ErrorCategoryHttpStatusIMATEAPOT ErrorCategoryHttpStatus = "IM_A_TEAPOT" ErrorCategoryHttpStatusIMUSED ErrorCategoryHttpStatus = "IM_USED" ErrorCategoryHttpStatusINSUFFICIENTSTORAGE ErrorCategoryHttpStatus = "INSUFFICIENT_STORAGE" ErrorCategoryHttpStatusINTERNALSERVERERROR ErrorCategoryHttpStatus = "INTERNAL_SERVER_ERROR" ErrorCategoryHttpStatusINTERNALSTALESERVICEDISCOVERY ErrorCategoryHttpStatus = "INTERNAL_STALE_SERVICE_DISCOVERY" ErrorCategoryHttpStatusLENGTHREQUIRED ErrorCategoryHttpStatus = "LENGTH_REQUIRED" ErrorCategoryHttpStatusLOCKED ErrorCategoryHttpStatus = "LOCKED" ErrorCategoryHttpStatusLOOPDETECTED ErrorCategoryHttpStatus = "LOOP_DETECTED" ErrorCategoryHttpStatusMETHODNOTALLOWED ErrorCategoryHttpStatus = "METHOD_NOT_ALLOWED" ErrorCategoryHttpStatusMISDIRECTEDREQUEST ErrorCategoryHttpStatus = "MISDIRECTED_REQUEST" ErrorCategoryHttpStatusMOVEDPERMANENTLY ErrorCategoryHttpStatus = "MOVED_PERMANENTLY" ErrorCategoryHttpStatusMULTIPLECHOICES ErrorCategoryHttpStatus = "MULTIPLE_CHOICES" ErrorCategoryHttpStatusMULTISTATUS ErrorCategoryHttpStatus = "MULTI_STATUS" ErrorCategoryHttpStatusNETWORKAUTHENTICATIONREQUIRED ErrorCategoryHttpStatus = "NETWORK_AUTHENTICATION_REQUIRED" ErrorCategoryHttpStatusNOCONTENT ErrorCategoryHttpStatus = "NO_CONTENT" ErrorCategoryHttpStatusNONAUTHORITATIVEINFORMATION ErrorCategoryHttpStatus = "NON_AUTHORITATIVE_INFORMATION" ErrorCategoryHttpStatusNOTACCEPTABLE ErrorCategoryHttpStatus = "NOT_ACCEPTABLE" ErrorCategoryHttpStatusNOTEXTENDED ErrorCategoryHttpStatus = "NOT_EXTENDED" ErrorCategoryHttpStatusNOTFOUND ErrorCategoryHttpStatus = "NOT_FOUND" ErrorCategoryHttpStatusNOTIMPLEMENTED ErrorCategoryHttpStatus = "NOT_IMPLEMENTED" ErrorCategoryHttpStatusNOTMODIFIED ErrorCategoryHttpStatus = "NOT_MODIFIED" ErrorCategoryHttpStatusOK ErrorCategoryHttpStatus = "OK" ErrorCategoryHttpStatusPARTIALCONTENT ErrorCategoryHttpStatus = "PARTIAL_CONTENT" ErrorCategoryHttpStatusPAYMENTREQUIRED ErrorCategoryHttpStatus = "PAYMENT_REQUIRED" ErrorCategoryHttpStatusPERMANENTREDIRECT ErrorCategoryHttpStatus = "PERMANENT_REDIRECT" ErrorCategoryHttpStatusPRECONDITIONFAILED ErrorCategoryHttpStatus = "PRECONDITION_FAILED" ErrorCategoryHttpStatusPRECONDITIONREQUIRED ErrorCategoryHttpStatus = "PRECONDITION_REQUIRED" ErrorCategoryHttpStatusPROCESSING ErrorCategoryHttpStatus = "PROCESSING" ErrorCategoryHttpStatusPROXYAUTHENTICATIONREQUIRED ErrorCategoryHttpStatus = "PROXY_AUTHENTICATION_REQUIRED" ErrorCategoryHttpStatusREQUESTEDRANGENOTSATISFIABLE ErrorCategoryHttpStatus = "REQUESTED_RANGE_NOT_SATISFIABLE" ErrorCategoryHttpStatusREQUESTENTITYTOOLARGE ErrorCategoryHttpStatus = "REQUEST_ENTITY_TOO_LARGE" ErrorCategoryHttpStatusREQUESTHEADERSFIELDSTOOLARGE ErrorCategoryHttpStatus = "REQUEST_HEADERS_FIELDS_TOO_LARGE" ErrorCategoryHttpStatusREQUESTTIMEOUT ErrorCategoryHttpStatus = "REQUEST_TIMEOUT" ErrorCategoryHttpStatusREQUESTURITOOLONG ErrorCategoryHttpStatus = "REQUEST_URI_TOO_LONG" ErrorCategoryHttpStatusRESETCONTENT ErrorCategoryHttpStatus = "RESET_CONTENT" ErrorCategoryHttpStatusSEEOTHER ErrorCategoryHttpStatus = "SEE_OTHER" ErrorCategoryHttpStatusSERVICEUNAVAILABLE ErrorCategoryHttpStatus = "SERVICE_UNAVAILABLE" ErrorCategoryHttpStatusSWITCHINGPROTOCOLS ErrorCategoryHttpStatus = "SWITCHING_PROTOCOLS" ErrorCategoryHttpStatusTEMPORARYREDIRECT ErrorCategoryHttpStatus = "TEMPORARY_REDIRECT" ErrorCategoryHttpStatusTOOMANYREQUESTS ErrorCategoryHttpStatus = "TOO_MANY_REQUESTS" ErrorCategoryHttpStatusUNAUTHORIZED ErrorCategoryHttpStatus = "UNAUTHORIZED" ErrorCategoryHttpStatusUNAVAILABLEFORLEGALREASONS ErrorCategoryHttpStatus = "UNAVAILABLE_FOR_LEGAL_REASONS" ErrorCategoryHttpStatusUNPROCESSABLEENTITY ErrorCategoryHttpStatus = "UNPROCESSABLE_ENTITY" ErrorCategoryHttpStatusUNSUPPORTEDMEDIATYPE ErrorCategoryHttpStatus = "UNSUPPORTED_MEDIA_TYPE" ErrorCategoryHttpStatusUPGRADEREQUIRED ErrorCategoryHttpStatus = "UPGRADE_REQUIRED" ErrorCategoryHttpStatusUSEPROXY ErrorCategoryHttpStatus = "USE_PROXY" ErrorCategoryHttpStatusVARIANTALSONEGOTIATES ErrorCategoryHttpStatus = "VARIANT_ALSO_NEGOTIATES" )
Defines values for ErrorCategoryHttpStatus.
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 EventDetail ¶
type EventDetail struct { // The details Markdown rendered as HTML. Details string `json:"details"` }
The details Markdown rendered as HTML.
type GetAllEventTemplatesResponse ¶
type GetAllEventTemplatesResponse struct { Body []byte HTTPResponse *http.Response JSON200 *CollectionResponseTimelineEventTemplateNoPaging }
func (GetAllEventTemplatesResponse) Status ¶
func (r GetAllEventTemplatesResponse) Status() string
Status returns HTTPResponse.Status
func (GetAllEventTemplatesResponse) StatusCode ¶
func (r GetAllEventTemplatesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDetailByIdResponse ¶
type GetDetailByIdResponse struct { Body []byte HTTPResponse *http.Response JSON200 *EventDetail }
func (GetDetailByIdResponse) Status ¶
func (r GetDetailByIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetDetailByIdResponse) StatusCode ¶
func (r GetDetailByIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEventResponse ¶
type GetEventResponse struct { Body []byte HTTPResponse *http.Response JSON200 *TimelineEventResponse }
func (GetEventResponse) Status ¶
func (r GetEventResponse) Status() string
Status returns HTTPResponse.Status
func (GetEventResponse) StatusCode ¶
func (r GetEventResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetEventTemplateResponse ¶
type GetEventTemplateResponse struct { Body []byte HTTPResponse *http.Response JSON200 *TimelineEventTemplate }
func (GetEventTemplateResponse) Status ¶
func (r GetEventTemplateResponse) Status() string
Status returns HTTPResponse.Status
func (GetEventTemplateResponse) StatusCode ¶
func (r GetEventTemplateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetRenderByIdParams ¶
type GetRenderByIdParams struct { // Set to 'true', we want to render the `detailTemplate` instead of the `headerTemplate`. Detail *bool `json:"detail,omitempty"` }
GetRenderByIdParams defines parameters for GetRenderById.
type GetRenderByIdResponse ¶
func (GetRenderByIdResponse) Status ¶
func (r GetRenderByIdResponse) Status() string
Status returns HTTPResponse.Status
func (GetRenderByIdResponse) StatusCode ¶
func (r GetRenderByIdResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type StandardError ¶
type StandardError struct { Category ErrorCategory `json:"category"` Context StandardError_Context `json:"context"` Errors []ErrorDetail `json:"errors"` Id *string `json:"id,omitempty"` Links StandardError_Links `json:"links"` Message string `json:"message"` Status string `json:"status"` SubCategory *map[string]interface{} `json:"subCategory,omitempty"` }
StandardError defines model for StandardError.
type StandardError_Context ¶
StandardError_Context defines model for StandardError.Context.
func (StandardError_Context) Get ¶
func (a StandardError_Context) Get(fieldName string) (value []string, found bool)
Getter for additional properties for StandardError_Context. Returns the specified element and whether it was found
func (StandardError_Context) MarshalJSON ¶
func (a StandardError_Context) MarshalJSON() ([]byte, error)
Override default JSON handling for StandardError_Context to handle AdditionalProperties
func (*StandardError_Context) Set ¶
func (a *StandardError_Context) Set(fieldName string, value []string)
Setter for additional properties for StandardError_Context
func (*StandardError_Context) UnmarshalJSON ¶
func (a *StandardError_Context) UnmarshalJSON(b []byte) error
Override default JSON handling for StandardError_Context to handle AdditionalProperties
type StandardError_Links ¶
StandardError_Links defines model for StandardError.Links.
func (StandardError_Links) Get ¶
func (a StandardError_Links) Get(fieldName string) (value string, found bool)
Getter for additional properties for StandardError_Links. Returns the specified element and whether it was found
func (StandardError_Links) MarshalJSON ¶
func (a StandardError_Links) MarshalJSON() ([]byte, error)
Override default JSON handling for StandardError_Links to handle AdditionalProperties
func (*StandardError_Links) Set ¶
func (a *StandardError_Links) Set(fieldName string, value string)
Setter for additional properties for StandardError_Links
func (*StandardError_Links) UnmarshalJSON ¶
func (a *StandardError_Links) UnmarshalJSON(b []byte) error
Override default JSON handling for StandardError_Links to handle AdditionalProperties
type TimelineEvent ¶
type TimelineEvent struct { // The event domain (often paired with utk). Domain *string `json:"domain,omitempty"` // The email address used for contact-specific events. This can be used to identify existing contacts, create new ones, or change the email for an existing contact (if paired with the `objectId`). Email *string `json:"email,omitempty"` // The event template ID. EventTemplateId string `json:"eventTemplateId"` // Additional event-specific data that can be interpreted by the template's markdown. ExtraData *map[string]interface{} `json:"extraData,omitempty"` // Identifier for the event. This is optional, and we recommend you do not pass this in. We will create one for you if you omit this. You can also use `{{uuid}}` anywhere in the ID to generate a unique string, guaranteeing uniqueness. Id string `json:"id"` // The CRM object identifier. This is required for every event other than contacts (where utk or email can be used). ObjectId *string `json:"objectId,omitempty"` TimelineIFrame *TimelineEventIFrame `json:"timelineIFrame,omitempty"` // The time the event occurred. If not passed in, the curren time will be assumed. This is used to determine where an event is shown on a CRM object's timeline. Timestamp *time.Time `json:"timestamp,omitempty"` // A collection of token keys and values associated with the template tokens. Tokens TimelineEvent_Tokens `json:"tokens"` // Use the `utk` parameter to associate an event with a contact by `usertoken`. This is recommended if you don't know a user's email, but have an identifying user token in your cookie. Utk *string `json:"utk,omitempty"` }
The state of the timeline event.
type TimelineEventIFrame ¶
type TimelineEventIFrame struct { // The label of the modal window that displays the iframe contents. HeaderLabel string `json:"headerLabel"` // The height of the modal window in pixels. Height int32 `json:"height"` // The text displaying the link that will display the iframe. LinkLabel string `json:"linkLabel"` // The URI of the iframe contents. Url string `json:"url"` // The width of the modal window in pixels. Width int32 `json:"width"` }
TimelineEventIFrame defines model for TimelineEventIFrame.
type TimelineEventResponse ¶
type TimelineEventResponse struct { CreatedAt *time.Time `json:"createdAt,omitempty"` // The event domain (often paired with utk). Domain *string `json:"domain,omitempty"` // The email address used for contact-specific events. This can be used to identify existing contacts, create new ones, or change the email for an existing contact (if paired with the `objectId`). Email *string `json:"email,omitempty"` // The event template ID. EventTemplateId string `json:"eventTemplateId"` // Additional event-specific data that can be interpreted by the template's markdown. ExtraData *map[string]interface{} `json:"extraData,omitempty"` // Identifier for the event. This should be unique to the app and event template. If you use the same ID for different CRM objects, the last to be processed will win and the first will not have a record. You can also use `{{uuid}}` anywhere in the ID to generate a unique string, guaranteeing uniqueness. Id string `json:"id"` // The CRM object identifier. This is required for every event other than contacts (where utk or email can be used). ObjectId *string `json:"objectId,omitempty"` // The ObjectType associated with the EventTemplate. ObjectType string `json:"objectType"` TimelineIFrame *TimelineEventIFrame `json:"timelineIFrame,omitempty"` // The time the event occurred. If not passed in, the curren time will be assumed. This is used to determine where an event is shown on a CRM object's timeline. Timestamp *time.Time `json:"timestamp,omitempty"` // A collection of token keys and values associated with the template tokens. Tokens TimelineEventResponse_Tokens `json:"tokens"` // Use the `utk` parameter to associate an event with a contact by `usertoken`. This is recommended if you don't know a user's email, but have an identifying user token in your cookie. Utk *string `json:"utk,omitempty"` }
The current state of the timeline event.
type TimelineEventResponse_Tokens ¶
A collection of token keys and values associated with the template tokens.
func (TimelineEventResponse_Tokens) Get ¶
func (a TimelineEventResponse_Tokens) Get(fieldName string) (value string, found bool)
Getter for additional properties for TimelineEventResponse_Tokens. Returns the specified element and whether it was found
func (TimelineEventResponse_Tokens) MarshalJSON ¶
func (a TimelineEventResponse_Tokens) MarshalJSON() ([]byte, error)
Override default JSON handling for TimelineEventResponse_Tokens to handle AdditionalProperties
func (*TimelineEventResponse_Tokens) Set ¶
func (a *TimelineEventResponse_Tokens) Set(fieldName string, value string)
Setter for additional properties for TimelineEventResponse_Tokens
func (*TimelineEventResponse_Tokens) UnmarshalJSON ¶
func (a *TimelineEventResponse_Tokens) UnmarshalJSON(b []byte) error
Override default JSON handling for TimelineEventResponse_Tokens to handle AdditionalProperties
type TimelineEventTemplate ¶
type TimelineEventTemplate struct { // The date and time that the Event Template was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. CreatedAt *time.Time `json:"createdAt,omitempty"` // This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details. DetailTemplate *string `json:"detailTemplate,omitempty"` // This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header. HeaderTemplate *string `json:"headerTemplate,omitempty"` // The template ID. Id string `json:"id"` // The template name. Name string `json:"name"` // The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported. ObjectType string `json:"objectType"` // A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects. Tokens []TimelineEventTemplateToken `json:"tokens"` // The date and time that the Event Template was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. UpdatedAt *time.Time `json:"updatedAt,omitempty"` }
The current state of the template definition.
type TimelineEventTemplateCreateRequest ¶
type TimelineEventTemplateCreateRequest struct { // This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details. DetailTemplate *string `json:"detailTemplate,omitempty"` // This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header. HeaderTemplate *string `json:"headerTemplate,omitempty"` // The template name. Name string `json:"name"` // The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported. ObjectType string `json:"objectType"` // A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects. Tokens []TimelineEventTemplateToken `json:"tokens"` }
State of the template definition being created.
type TimelineEventTemplateToken ¶
type TimelineEventTemplateToken struct { // The date and time that the Event Template Token was created, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. CreatedAt *time.Time `json:"createdAt,omitempty"` // Used for list segmentation and reporting. Label string `json:"label"` // The name of the token referenced in the templates. This must be unique for the specific template. It may only contain alphanumeric characters, periods, dashes, or underscores (. - _). Name string `json:"name"` // The name of the CRM object property. This will populate the CRM object property associated with the event. With enough of these, you can fully build CRM objects via the Timeline API. ObjectPropertyName *string `json:"objectPropertyName,omitempty"` // If type is `enumeration`, we should have a list of options to choose from. Options []TimelineEventTemplateTokenOption `json:"options"` // The data type of the token. You can currently choose from [string, number, date, enumeration]. Type TimelineEventTemplateTokenType `json:"type"` // The date and time that the Event Template Token was last updated, as an ISO 8601 timestamp. Will be null if the template was created before Feb 18th, 2020. UpdatedAt *time.Time `json:"updatedAt,omitempty"` }
State of the token definition.
type TimelineEventTemplateTokenOption ¶
type TimelineEventTemplateTokenOption struct { Label string `json:"label"` Value string `json:"value"` }
TimelineEventTemplateTokenOption defines model for TimelineEventTemplateTokenOption.
type TimelineEventTemplateTokenType ¶
type TimelineEventTemplateTokenType string
The data type of the token. You can currently choose from [string, number, date, enumeration].
const ( TimelineEventTemplateTokenTypeDate TimelineEventTemplateTokenType = "date" TimelineEventTemplateTokenTypeEnumeration TimelineEventTemplateTokenType = "enumeration" TimelineEventTemplateTokenTypeNumber TimelineEventTemplateTokenType = "number" TimelineEventTemplateTokenTypeString TimelineEventTemplateTokenType = "string" )
Defines values for TimelineEventTemplateTokenType.
type TimelineEventTemplateTokenUpdateRequest ¶
type TimelineEventTemplateTokenUpdateRequest struct { // Used for list segmentation and reporting. Label string `json:"label"` // The name of the CRM object property. This will populate the CRM object property associated with the event. With enough of these, you can fully build CRM objects via the Timeline API. ObjectPropertyName *string `json:"objectPropertyName,omitempty"` // If type is `enumeration`, we should have a list of options to choose from. Options []TimelineEventTemplateTokenOption `json:"options"` }
State of the token definition for update requests.
type TimelineEventTemplateUpdateRequest ¶
type TimelineEventTemplateUpdateRequest struct { // This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline when you expand the details. DetailTemplate *string `json:"detailTemplate,omitempty"` // This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header. HeaderTemplate *string `json:"headerTemplate,omitempty"` // The template ID. Id string `json:"id"` // The template name. Name string `json:"name"` // A collection of tokens that can be used as custom properties on the event and to create fully fledged CRM objects. Tokens []TimelineEventTemplateToken `json:"tokens"` }
State of the template definition being updated.
type TimelineEvent_Tokens ¶
A collection of token keys and values associated with the template tokens.
func (TimelineEvent_Tokens) Get ¶
func (a TimelineEvent_Tokens) Get(fieldName string) (value string, found bool)
Getter for additional properties for TimelineEvent_Tokens. Returns the specified element and whether it was found
func (TimelineEvent_Tokens) MarshalJSON ¶
func (a TimelineEvent_Tokens) MarshalJSON() ([]byte, error)
Override default JSON handling for TimelineEvent_Tokens to handle AdditionalProperties
func (*TimelineEvent_Tokens) Set ¶
func (a *TimelineEvent_Tokens) Set(fieldName string, value string)
Setter for additional properties for TimelineEvent_Tokens
func (*TimelineEvent_Tokens) UnmarshalJSON ¶
func (a *TimelineEvent_Tokens) UnmarshalJSON(b []byte) error
Override default JSON handling for TimelineEvent_Tokens to handle AdditionalProperties
type UpdateEventTemplateJSONBody ¶
type UpdateEventTemplateJSONBody TimelineEventTemplateUpdateRequest
UpdateEventTemplateJSONBody defines parameters for UpdateEventTemplate.
type UpdateEventTemplateJSONRequestBody ¶
type UpdateEventTemplateJSONRequestBody UpdateEventTemplateJSONBody
UpdateEventTemplateJSONRequestBody defines body for UpdateEventTemplate for application/json ContentType.
type UpdateEventTemplateResponse ¶
type UpdateEventTemplateResponse struct { Body []byte HTTPResponse *http.Response JSON200 *TimelineEventTemplate }
func (UpdateEventTemplateResponse) Status ¶
func (r UpdateEventTemplateResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateEventTemplateResponse) StatusCode ¶
func (r UpdateEventTemplateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateTokenNameJSONBody ¶
type UpdateTokenNameJSONBody TimelineEventTemplateTokenUpdateRequest
UpdateTokenNameJSONBody defines parameters for UpdateTokenName.
type UpdateTokenNameJSONRequestBody ¶
type UpdateTokenNameJSONRequestBody UpdateTokenNameJSONBody
UpdateTokenNameJSONRequestBody defines body for UpdateTokenName for application/json ContentType.
type UpdateTokenNameResponse ¶
type UpdateTokenNameResponse struct { Body []byte HTTPResponse *http.Response JSON200 *TimelineEventTemplateToken }
func (UpdateTokenNameResponse) Status ¶
func (r UpdateTokenNameResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateTokenNameResponse) StatusCode ¶
func (r UpdateTokenNameResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode