timeline

package
v2.0.1 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2022 License: MIT Imports: 22 Imported by: 0

README

Go API client for timeline

This feature allows an app to create and configure custom events that can show up in the timelines of certain CRM objects like contacts, companies, tickets, or deals. You'll find multiple use cases for this API in the sections below.

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 timeline "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(), timeline.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(), timeline.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(), timeline.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), timeline.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
EventsApi BatchCreate Post /crm/v3/timeline/events/batch/create Creates multiple events
EventsApi Create Post /crm/v3/timeline/events Create a single event
EventsApi GetByID Get /crm/v3/timeline/events/{eventTemplateId}/{eventId} Gets the event
EventsApi GetDetailByID Get /crm/v3/timeline/events/{eventTemplateId}/{eventId}/detail Gets the detailTemplate as rendered
EventsApi GetRenderByID Get /crm/v3/timeline/events/{eventTemplateId}/{eventId}/render Renders the header or detail as HTML
TemplatesApi TemplateCreate Post /crm/v3/timeline/{appId}/event-templates Create an event template for your app
TemplatesApi TemplateGetAll Get /crm/v3/timeline/{appId}/event-templates List all event templates for your app
TemplatesApi TemplatesArchive Delete /crm/v3/timeline/{appId}/event-templates/{eventTemplateId} Deletes an event template for the app
TemplatesApi TemplatesGetByID Get /crm/v3/timeline/{appId}/event-templates/{eventTemplateId} Gets a specific event template for your app
TemplatesApi TemplatesUpdate Put /crm/v3/timeline/{appId}/event-templates/{eventTemplateId} Update an existing event template
TokensApi TemplatesTokensArchive Delete /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} Removes a token from the event template
TokensApi TemplatesTokensCreate Post /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}/tokens Adds a token to an existing event template
TokensApi TemplatesTokensUpdate Put /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} Updates an existing token on an event template

Documentation For Models

Documentation For Authorization

developer_hapikey
  • Type: API key
  • API key parameter name: hapikey
  • Location: URL query string

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

oauth2_legacy
  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://app.hubspot.com/oauth/authorize
  • Scopes:
  • tickets: Read and write tickets
  • timeline: Create timeline events
  • contacts: Read from and write to my Contacts

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 {
	EventsApi *EventsApiService

	TemplatesApi *TemplatesApiService

	TokensApi *TokensApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Timeline events 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 ApiBatchCreateRequest 

type ApiBatchCreateRequest struct {
	ApiService *EventsApiService
	// contains filtered or unexported fields
}

func (ApiBatchCreateRequest) BatchInputTimelineEvent 

func (r ApiBatchCreateRequest) BatchInputTimelineEvent(batchInputTimelineEvent BatchInputTimelineEvent) ApiBatchCreateRequest

The timeline event definition.

func (ApiBatchCreateRequest) Execute 

func (r ApiBatchCreateRequest) Execute() (*BatchResponseTimelineEventResponse, *http.Response, error)

type ApiCreateRequest 

type ApiCreateRequest struct {
	ApiService *EventsApiService
	// contains filtered or unexported fields
}

func (ApiCreateRequest) Execute 

func (r ApiCreateRequest) Execute() (*TimelineEventResponse, *http.Response, error)

func (ApiCreateRequest) TimelineEvent 

func (r ApiCreateRequest) TimelineEvent(timelineEvent TimelineEvent) ApiCreateRequest

The timeline event definition.

type ApiGetByIDRequest 

type ApiGetByIDRequest struct {
	ApiService *EventsApiService
	// contains filtered or unexported fields
}

func (ApiGetByIDRequest) Execute 

func (r ApiGetByIDRequest) Execute() (*TimelineEventResponse, *http.Response, error)

type ApiGetDetailByIDRequest 

type ApiGetDetailByIDRequest struct {
	ApiService *EventsApiService
	// contains filtered or unexported fields
}

func (ApiGetDetailByIDRequest) Execute 

func (r ApiGetDetailByIDRequest) Execute() (*EventDetail, *http.Response, error)

type ApiGetRenderByIDRequest 

type ApiGetRenderByIDRequest struct {
	ApiService *EventsApiService
	// contains filtered or unexported fields
}

func (ApiGetRenderByIDRequest) Detail 

func (r ApiGetRenderByIDRequest) Detail(detail bool) ApiGetRenderByIDRequest

Set to 'true', we want to render the `detailTemplate` instead of the `headerTemplate`.

func (ApiGetRenderByIDRequest) Execute 

func (r ApiGetRenderByIDRequest) Execute() (string, *http.Response, error)

type ApiTemplateCreateRequest 

type ApiTemplateCreateRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplateCreateRequest) Execute 

func (r ApiTemplateCreateRequest) Execute() (*TimelineEventTemplate, *http.Response, error)

func (ApiTemplateCreateRequest) TimelineEventTemplateCreateRequest 

func (r ApiTemplateCreateRequest) TimelineEventTemplateCreateRequest(timelineEventTemplateCreateRequest TimelineEventTemplateCreateRequest) ApiTemplateCreateRequest

The new event template definition.

type ApiTemplateGetAllRequest 

type ApiTemplateGetAllRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplateGetAllRequest) Execute 

func (r ApiTemplateGetAllRequest) Execute() (*CollectionResponseTimelineEventTemplateNoPaging, *http.Response, error)

type ApiTemplatesArchiveRequest 

type ApiTemplatesArchiveRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesArchiveRequest) Execute 

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

type ApiTemplatesGetByIDRequest 

type ApiTemplatesGetByIDRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesGetByIDRequest) Execute 

func (r ApiTemplatesGetByIDRequest) Execute() (*TimelineEventTemplate, *http.Response, error)

type ApiTemplatesTokensArchiveRequest 

type ApiTemplatesTokensArchiveRequest struct {
	ApiService *TokensApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesTokensArchiveRequest) Execute 

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

type ApiTemplatesTokensCreateRequest 

type ApiTemplatesTokensCreateRequest struct {
	ApiService *TokensApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesTokensCreateRequest) Execute 

func (r ApiTemplatesTokensCreateRequest) Execute() (*TimelineEventTemplateToken, *http.Response, error)

func (ApiTemplatesTokensCreateRequest) TimelineEventTemplateToken 

func (r ApiTemplatesTokensCreateRequest) TimelineEventTemplateToken(timelineEventTemplateToken TimelineEventTemplateToken) ApiTemplatesTokensCreateRequest

The new token definition.

type ApiTemplatesTokensUpdateRequest 

type ApiTemplatesTokensUpdateRequest struct {
	ApiService *TokensApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesTokensUpdateRequest) Execute 

func (r ApiTemplatesTokensUpdateRequest) Execute() (*TimelineEventTemplateToken, *http.Response, error)

func (ApiTemplatesTokensUpdateRequest) TimelineEventTemplateTokenUpdateRequest 

func (r ApiTemplatesTokensUpdateRequest) TimelineEventTemplateTokenUpdateRequest(timelineEventTemplateTokenUpdateRequest TimelineEventTemplateTokenUpdateRequest) ApiTemplatesTokensUpdateRequest

The updated token definition.

type ApiTemplatesUpdateRequest 

type ApiTemplatesUpdateRequest struct {
	ApiService *TemplatesApiService
	// contains filtered or unexported fields
}

func (ApiTemplatesUpdateRequest) Execute 

func (r ApiTemplatesUpdateRequest) Execute() (*TimelineEventTemplate, *http.Response, error)

func (ApiTemplatesUpdateRequest) TimelineEventTemplateUpdateRequest 

func (r ApiTemplatesUpdateRequest) TimelineEventTemplateUpdateRequest(timelineEventTemplateUpdateRequest TimelineEventTemplateUpdateRequest) ApiTemplatesUpdateRequest

The updated event template definition.

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 BatchInputTimelineEvent 

type BatchInputTimelineEvent struct {
	// A collection of timeline events we want to create.
	Inputs []TimelineEvent `json:"inputs"`
}

BatchInputTimelineEvent Used to create timeline events in batches.

func NewBatchInputTimelineEvent 

func NewBatchInputTimelineEvent(inputs []TimelineEvent) *BatchInputTimelineEvent

NewBatchInputTimelineEvent instantiates a new BatchInputTimelineEvent 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 NewBatchInputTimelineEventWithDefaults 

func NewBatchInputTimelineEventWithDefaults() *BatchInputTimelineEvent

NewBatchInputTimelineEventWithDefaults instantiates a new BatchInputTimelineEvent 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 (*BatchInputTimelineEvent) GetInputs 

func (o *BatchInputTimelineEvent) GetInputs() []TimelineEvent

GetInputs returns the Inputs field value

func (*BatchInputTimelineEvent) GetInputsOk 

func (o *BatchInputTimelineEvent) GetInputsOk() ([]TimelineEvent, bool)

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

func (BatchInputTimelineEvent) MarshalJSON 

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

func (*BatchInputTimelineEvent) SetInputs 

func (o *BatchInputTimelineEvent) SetInputs(v []TimelineEvent)

SetInputs sets field value

type BatchResponseTimelineEventResponse 

type BatchResponseTimelineEventResponse struct {
	// The status of the batch response. Should always be COMPLETED if processed.
	Status string `json:"status"`
	// Successfully created events.
	Results []TimelineEventResponse `json:"results"`
	// The time the request occurred.
	RequestedAt *time.Time `json:"requestedAt,omitempty"`
	// The time the request began processing.
	StartedAt time.Time `json:"startedAt"`
	// The time the request was completed.
	CompletedAt time.Time          `json:"completedAt"`
	Links       *map[string]string `json:"links,omitempty"`
}

BatchResponseTimelineEventResponse The state of the batch event request.

func NewBatchResponseTimelineEventResponse 

func NewBatchResponseTimelineEventResponse(status string, results []TimelineEventResponse, startedAt time.Time, completedAt time.Time) *BatchResponseTimelineEventResponse

NewBatchResponseTimelineEventResponse instantiates a new BatchResponseTimelineEventResponse 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 NewBatchResponseTimelineEventResponseWithDefaults 

func NewBatchResponseTimelineEventResponseWithDefaults() *BatchResponseTimelineEventResponse

NewBatchResponseTimelineEventResponseWithDefaults instantiates a new BatchResponseTimelineEventResponse 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 (*BatchResponseTimelineEventResponse) GetCompletedAt 

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

GetCompletedAt returns the CompletedAt field value

func (*BatchResponseTimelineEventResponse) GetCompletedAtOk 

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

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

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

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

func (*BatchResponseTimelineEventResponse) GetLinksOk 

func (o *BatchResponseTimelineEventResponse) 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 (*BatchResponseTimelineEventResponse) GetRequestedAt 

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

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

func (*BatchResponseTimelineEventResponse) GetRequestedAtOk 

func (o *BatchResponseTimelineEventResponse) 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 (*BatchResponseTimelineEventResponse) GetResults 

func (o *BatchResponseTimelineEventResponse) GetResults() []TimelineEventResponse

GetResults returns the Results field value

func (*BatchResponseTimelineEventResponse) GetResultsOk 

func (o *BatchResponseTimelineEventResponse) GetResultsOk() ([]TimelineEventResponse, bool)

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

func (*BatchResponseTimelineEventResponse) GetStartedAt 

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

GetStartedAt returns the StartedAt field value

func (*BatchResponseTimelineEventResponse) GetStartedAtOk 

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

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

func (*BatchResponseTimelineEventResponse) GetStatus 

func (o *BatchResponseTimelineEventResponse) GetStatus() string

GetStatus returns the Status field value

func (*BatchResponseTimelineEventResponse) GetStatusOk 

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

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

func (o *BatchResponseTimelineEventResponse) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*BatchResponseTimelineEventResponse) HasRequestedAt 

func (o *BatchResponseTimelineEventResponse) HasRequestedAt() bool

HasRequestedAt returns a boolean if a field has been set.

func (BatchResponseTimelineEventResponse) MarshalJSON 

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

func (*BatchResponseTimelineEventResponse) SetCompletedAt 

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

SetCompletedAt sets field value 

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

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

func (*BatchResponseTimelineEventResponse) SetRequestedAt 

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

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

func (*BatchResponseTimelineEventResponse) SetResults 

func (o *BatchResponseTimelineEventResponse) SetResults(v []TimelineEventResponse)

SetResults sets field value

func (*BatchResponseTimelineEventResponse) SetStartedAt 

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

SetStartedAt sets field value

func (*BatchResponseTimelineEventResponse) SetStatus 

func (o *BatchResponseTimelineEventResponse) SetStatus(v string)

SetStatus sets field value

type BatchResponseTimelineEventResponseWithErrors 

type BatchResponseTimelineEventResponseWithErrors struct {
	Status      string                  `json:"status"`
	Results     []TimelineEventResponse `json:"results"`
	NumErrors   *int32                  `json:"numErrors,omitempty"`
	Errors      []StandardError         `json:"errors,omitempty"`
	RequestedAt *time.Time              `json:"requestedAt,omitempty"`
	StartedAt   time.Time               `json:"startedAt"`
	CompletedAt time.Time               `json:"completedAt"`
	Links       *map[string]string      `json:"links,omitempty"`
}

BatchResponseTimelineEventResponseWithErrors struct for BatchResponseTimelineEventResponseWithErrors

func NewBatchResponseTimelineEventResponseWithErrors 

func NewBatchResponseTimelineEventResponseWithErrors(status string, results []TimelineEventResponse, startedAt time.Time, completedAt time.Time) *BatchResponseTimelineEventResponseWithErrors

NewBatchResponseTimelineEventResponseWithErrors instantiates a new BatchResponseTimelineEventResponseWithErrors 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 NewBatchResponseTimelineEventResponseWithErrorsWithDefaults 

func NewBatchResponseTimelineEventResponseWithErrorsWithDefaults() *BatchResponseTimelineEventResponseWithErrors

NewBatchResponseTimelineEventResponseWithErrorsWithDefaults instantiates a new BatchResponseTimelineEventResponseWithErrors 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 (*BatchResponseTimelineEventResponseWithErrors) GetCompletedAt 

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

GetCompletedAt returns the CompletedAt field value

func (*BatchResponseTimelineEventResponseWithErrors) GetCompletedAtOk 

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

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

func (*BatchResponseTimelineEventResponseWithErrors) GetErrors 

func (o *BatchResponseTimelineEventResponseWithErrors) GetErrors() []StandardError

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

func (*BatchResponseTimelineEventResponseWithErrors) GetErrorsOk 

func (o *BatchResponseTimelineEventResponseWithErrors) GetErrorsOk() ([]StandardError, 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 *BatchResponseTimelineEventResponseWithErrors) GetLinks() map[string]string

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

func (*BatchResponseTimelineEventResponseWithErrors) GetLinksOk 

func (o *BatchResponseTimelineEventResponseWithErrors) 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 (*BatchResponseTimelineEventResponseWithErrors) GetNumErrors 

func (o *BatchResponseTimelineEventResponseWithErrors) GetNumErrors() int32

GetNumErrors returns the NumErrors field value if set, zero value otherwise.

func (*BatchResponseTimelineEventResponseWithErrors) GetNumErrorsOk 

func (o *BatchResponseTimelineEventResponseWithErrors) GetNumErrorsOk() (*int32, bool)

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

func (*BatchResponseTimelineEventResponseWithErrors) GetRequestedAt 

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

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

func (*BatchResponseTimelineEventResponseWithErrors) GetRequestedAtOk 

func (o *BatchResponseTimelineEventResponseWithErrors) 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 (*BatchResponseTimelineEventResponseWithErrors) GetResults 

func (o *BatchResponseTimelineEventResponseWithErrors) GetResults() []TimelineEventResponse

GetResults returns the Results field value

func (*BatchResponseTimelineEventResponseWithErrors) GetResultsOk 

func (o *BatchResponseTimelineEventResponseWithErrors) GetResultsOk() ([]TimelineEventResponse, bool)

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

func (*BatchResponseTimelineEventResponseWithErrors) GetStartedAt 

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

GetStartedAt returns the StartedAt field value

func (*BatchResponseTimelineEventResponseWithErrors) GetStartedAtOk 

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

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

func (*BatchResponseTimelineEventResponseWithErrors) GetStatus 

func (o *BatchResponseTimelineEventResponseWithErrors) GetStatus() string

GetStatus returns the Status field value

func (*BatchResponseTimelineEventResponseWithErrors) GetStatusOk 

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

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

func (*BatchResponseTimelineEventResponseWithErrors) HasErrors 

func (o *BatchResponseTimelineEventResponseWithErrors) HasErrors() bool

HasErrors returns a boolean if a field has been set. 

func (o *BatchResponseTimelineEventResponseWithErrors) HasLinks() bool

HasLinks returns a boolean if a field has been set.

func (*BatchResponseTimelineEventResponseWithErrors) HasNumErrors 

func (o *BatchResponseTimelineEventResponseWithErrors) HasNumErrors() bool

HasNumErrors returns a boolean if a field has been set.

func (*BatchResponseTimelineEventResponseWithErrors) HasRequestedAt 

func (o *BatchResponseTimelineEventResponseWithErrors) HasRequestedAt() bool

HasRequestedAt returns a boolean if a field has been set.

func (BatchResponseTimelineEventResponseWithErrors) MarshalJSON 

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

func (*BatchResponseTimelineEventResponseWithErrors) SetCompletedAt 

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

SetCompletedAt sets field value

func (*BatchResponseTimelineEventResponseWithErrors) SetErrors 

func (o *BatchResponseTimelineEventResponseWithErrors) SetErrors(v []StandardError)

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

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

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

func (*BatchResponseTimelineEventResponseWithErrors) SetNumErrors 

func (o *BatchResponseTimelineEventResponseWithErrors) SetNumErrors(v int32)

SetNumErrors gets a reference to the given int32 and assigns it to the NumErrors field.

func (*BatchResponseTimelineEventResponseWithErrors) SetRequestedAt 

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

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

func (*BatchResponseTimelineEventResponseWithErrors) SetResults 

func (o *BatchResponseTimelineEventResponseWithErrors) SetResults(v []TimelineEventResponse)

SetResults sets field value

func (*BatchResponseTimelineEventResponseWithErrors) SetStartedAt 

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

SetStartedAt sets field value

func (*BatchResponseTimelineEventResponseWithErrors) SetStatus 

func (o *BatchResponseTimelineEventResponseWithErrors) SetStatus(v string)

SetStatus sets field value

type CollectionResponseTimelineEventTemplateNoPaging 

type CollectionResponseTimelineEventTemplateNoPaging struct {
	Results []TimelineEventTemplate `json:"results"`
}

CollectionResponseTimelineEventTemplateNoPaging struct for CollectionResponseTimelineEventTemplateNoPaging

func NewCollectionResponseTimelineEventTemplateNoPaging 

func NewCollectionResponseTimelineEventTemplateNoPaging(results []TimelineEventTemplate) *CollectionResponseTimelineEventTemplateNoPaging

NewCollectionResponseTimelineEventTemplateNoPaging instantiates a new CollectionResponseTimelineEventTemplateNoPaging 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 NewCollectionResponseTimelineEventTemplateNoPagingWithDefaults 

func NewCollectionResponseTimelineEventTemplateNoPagingWithDefaults() *CollectionResponseTimelineEventTemplateNoPaging

NewCollectionResponseTimelineEventTemplateNoPagingWithDefaults instantiates a new CollectionResponseTimelineEventTemplateNoPaging 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 (*CollectionResponseTimelineEventTemplateNoPaging) GetResults 

func (o *CollectionResponseTimelineEventTemplateNoPaging) GetResults() []TimelineEventTemplate

GetResults returns the Results field value

func (*CollectionResponseTimelineEventTemplateNoPaging) GetResultsOk 

func (o *CollectionResponseTimelineEventTemplateNoPaging) GetResultsOk() ([]TimelineEventTemplate, bool)

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

func (CollectionResponseTimelineEventTemplateNoPaging) MarshalJSON 

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

func (*CollectionResponseTimelineEventTemplateNoPaging) SetResults 

func (o *CollectionResponseTimelineEventTemplateNoPaging) SetResults(v []TimelineEventTemplate)

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 Error 

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

Error struct for Error

func NewError 

func NewError(message string, correlationId 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 ErrorCategory 

type ErrorCategory struct {
	HttpStatus string `json:"httpStatus"`
	Name       string `json:"name"`
}

ErrorCategory struct for ErrorCategory

func NewErrorCategory 

func NewErrorCategory(httpStatus string, name string) *ErrorCategory

NewErrorCategory instantiates a new ErrorCategory 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 NewErrorCategoryWithDefaults 

func NewErrorCategoryWithDefaults() *ErrorCategory

NewErrorCategoryWithDefaults instantiates a new ErrorCategory 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 (*ErrorCategory) GetHttpStatus 

func (o *ErrorCategory) GetHttpStatus() string

GetHttpStatus returns the HttpStatus field value

func (*ErrorCategory) GetHttpStatusOk 

func (o *ErrorCategory) GetHttpStatusOk() (*string, bool)

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

func (*ErrorCategory) GetName 

func (o *ErrorCategory) GetName() string

GetName returns the Name field value

func (*ErrorCategory) GetNameOk 

func (o *ErrorCategory) GetNameOk() (*string, bool)

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

func (ErrorCategory) MarshalJSON 

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

func (*ErrorCategory) SetHttpStatus 

func (o *ErrorCategory) SetHttpStatus(v string)

SetHttpStatus sets field value

func (*ErrorCategory) SetName 

func (o *ErrorCategory) SetName(v string)

SetName sets field value

type ErrorDetail 

type ErrorDetail struct {
	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`
	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`
	// 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"`
}

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 EventDetail 

type EventDetail struct {
	// The details Markdown rendered as HTML.
	Details string `json:"details"`
}

EventDetail The details Markdown rendered as HTML.

func NewEventDetail 

func NewEventDetail(details string) *EventDetail

NewEventDetail instantiates a new EventDetail 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 NewEventDetailWithDefaults 

func NewEventDetailWithDefaults() *EventDetail

NewEventDetailWithDefaults instantiates a new EventDetail 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 (*EventDetail) GetDetails 

func (o *EventDetail) GetDetails() string

GetDetails returns the Details field value

func (*EventDetail) GetDetailsOk 

func (o *EventDetail) GetDetailsOk() (*string, bool)

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

func (EventDetail) MarshalJSON 

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

func (*EventDetail) SetDetails 

func (o *EventDetail) SetDetails(v string)

SetDetails sets field value

type EventsApiService 

type EventsApiService service

EventsApiService EventsApi service

func (*EventsApiService) BatchCreate 

func (a *EventsApiService) BatchCreate(ctx context.Context) ApiBatchCreateRequest

BatchCreate Creates multiple events

Creates multiple instances of timeline events based on an event template. Once created, these event are immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via `objectPropertyName`, this call will also attempt to updates those properties, or add them if they don't exist. 

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

func (*EventsApiService) BatchCreateExecute 

func (a *EventsApiService) BatchCreateExecute(r ApiBatchCreateRequest) (*BatchResponseTimelineEventResponse, *http.Response, error)

Execute executes the request 

@return BatchResponseTimelineEventResponse

func (*EventsApiService) Create 

func (a *EventsApiService) Create(ctx context.Context) ApiCreateRequest

Create Create a single event

Creates an instance of a timeline event based on an event template. Once created, this event is immutable on the object timeline and cannot be modified. If the event template was configured to update object properties via `objectPropertyName`, this call will also attempt to updates those properties, or add them if they don't exist. 

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

func (*EventsApiService) CreateExecute 

func (a *EventsApiService) CreateExecute(r ApiCreateRequest) (*TimelineEventResponse, *http.Response, error)

Execute executes the request 

@return TimelineEventResponse

func (*EventsApiService) GetByID 

func (a *EventsApiService) GetByID(ctx context.Context, eventTemplateId string, eventId string) ApiGetByIDRequest

GetByID Gets the event

This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param eventId The event ID.
@return ApiGetByIDRequest

func (*EventsApiService) GetByIDExecute 

func (a *EventsApiService) GetByIDExecute(r ApiGetByIDRequest) (*TimelineEventResponse, *http.Response, error)

Execute executes the request 

@return TimelineEventResponse

func (*EventsApiService) GetDetailByID 

func (a *EventsApiService) GetDetailByID(ctx context.Context, eventTemplateId string, eventId string) ApiGetDetailByIDRequest

GetDetailByID Gets the detailTemplate as rendered

This will take the `detailTemplate` from the event template and return an object rendering the specified event. If the template references `extraData` that isn't found in the event, it will be ignored and we'll render without it. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param eventId The event ID.
@return ApiGetDetailByIDRequest

func (*EventsApiService) GetDetailByIDExecute 

func (a *EventsApiService) GetDetailByIDExecute(r ApiGetDetailByIDRequest) (*EventDetail, *http.Response, error)

Execute executes the request 

@return EventDetail

func (*EventsApiService) GetRenderByID 

func (a *EventsApiService) GetRenderByID(ctx context.Context, eventTemplateId string, eventId string) ApiGetRenderByIDRequest

GetRenderByID Renders the header or detail as HTML

This will take either the `headerTemplate` or `detailTemplate` from the event template and render for the specified event as HTML. If the template references `extraData` that isn't found in the event, it will be ignored and we'll render without it. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param eventId The event ID.
@return ApiGetRenderByIDRequest

func (*EventsApiService) GetRenderByIDExecute 

func (a *EventsApiService) GetRenderByIDExecute(r ApiGetRenderByIDRequest) (string, *http.Response, error)

Execute executes the request 

@return string

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 NullableBatchInputTimelineEvent 

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

func NewNullableBatchInputTimelineEvent 

func NewNullableBatchInputTimelineEvent(val *BatchInputTimelineEvent) *NullableBatchInputTimelineEvent

func (NullableBatchInputTimelineEvent) Get 

func (v NullableBatchInputTimelineEvent) Get() *BatchInputTimelineEvent

func (NullableBatchInputTimelineEvent) IsSet 

func (v NullableBatchInputTimelineEvent) IsSet() bool

func (NullableBatchInputTimelineEvent) MarshalJSON 

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

func (*NullableBatchInputTimelineEvent) Set 

func (v *NullableBatchInputTimelineEvent) Set(val *BatchInputTimelineEvent)

func (*NullableBatchInputTimelineEvent) UnmarshalJSON 

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

func (*NullableBatchInputTimelineEvent) Unset 

func (v *NullableBatchInputTimelineEvent) Unset()

type NullableBatchResponseTimelineEventResponse 

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

func NewNullableBatchResponseTimelineEventResponse 

func NewNullableBatchResponseTimelineEventResponse(val *BatchResponseTimelineEventResponse) *NullableBatchResponseTimelineEventResponse

func (NullableBatchResponseTimelineEventResponse) Get 

func (v NullableBatchResponseTimelineEventResponse) Get() *BatchResponseTimelineEventResponse

func (NullableBatchResponseTimelineEventResponse) IsSet 

func (v NullableBatchResponseTimelineEventResponse) IsSet() bool

func (NullableBatchResponseTimelineEventResponse) MarshalJSON 

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

func (*NullableBatchResponseTimelineEventResponse) Set 

func (v *NullableBatchResponseTimelineEventResponse) Set(val *BatchResponseTimelineEventResponse)

func (*NullableBatchResponseTimelineEventResponse) UnmarshalJSON 

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

func (*NullableBatchResponseTimelineEventResponse) Unset 

func (v *NullableBatchResponseTimelineEventResponse) Unset()

type NullableBatchResponseTimelineEventResponseWithErrors 

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

func NewNullableBatchResponseTimelineEventResponseWithErrors 

func NewNullableBatchResponseTimelineEventResponseWithErrors(val *BatchResponseTimelineEventResponseWithErrors) *NullableBatchResponseTimelineEventResponseWithErrors

func (NullableBatchResponseTimelineEventResponseWithErrors) Get 

func (v NullableBatchResponseTimelineEventResponseWithErrors) Get() *BatchResponseTimelineEventResponseWithErrors

func (NullableBatchResponseTimelineEventResponseWithErrors) IsSet 

func (v NullableBatchResponseTimelineEventResponseWithErrors) IsSet() bool

func (NullableBatchResponseTimelineEventResponseWithErrors) MarshalJSON 

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

func (*NullableBatchResponseTimelineEventResponseWithErrors) Set 

func (v *NullableBatchResponseTimelineEventResponseWithErrors) Set(val *BatchResponseTimelineEventResponseWithErrors)

func (*NullableBatchResponseTimelineEventResponseWithErrors) UnmarshalJSON 

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

func (*NullableBatchResponseTimelineEventResponseWithErrors) Unset 

func (v *NullableBatchResponseTimelineEventResponseWithErrors) Unset()

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 NullableCollectionResponseTimelineEventTemplateNoPaging 

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

func NewNullableCollectionResponseTimelineEventTemplateNoPaging 

func NewNullableCollectionResponseTimelineEventTemplateNoPaging(val *CollectionResponseTimelineEventTemplateNoPaging) *NullableCollectionResponseTimelineEventTemplateNoPaging

func (NullableCollectionResponseTimelineEventTemplateNoPaging) Get 

func (v NullableCollectionResponseTimelineEventTemplateNoPaging) Get() *CollectionResponseTimelineEventTemplateNoPaging

func (NullableCollectionResponseTimelineEventTemplateNoPaging) IsSet 

func (v NullableCollectionResponseTimelineEventTemplateNoPaging) IsSet() bool

func (NullableCollectionResponseTimelineEventTemplateNoPaging) MarshalJSON 

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

func (*NullableCollectionResponseTimelineEventTemplateNoPaging) Set 

func (v *NullableCollectionResponseTimelineEventTemplateNoPaging) Set(val *CollectionResponseTimelineEventTemplateNoPaging)

func (*NullableCollectionResponseTimelineEventTemplateNoPaging) UnmarshalJSON 

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

func (*NullableCollectionResponseTimelineEventTemplateNoPaging) Unset 

func (v *NullableCollectionResponseTimelineEventTemplateNoPaging) 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 NullableErrorCategory 

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

func NewNullableErrorCategory 

func NewNullableErrorCategory(val *ErrorCategory) *NullableErrorCategory

func (NullableErrorCategory) Get 

func (v NullableErrorCategory) Get() *ErrorCategory

func (NullableErrorCategory) IsSet 

func (v NullableErrorCategory) IsSet() bool

func (NullableErrorCategory) MarshalJSON 

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

func (*NullableErrorCategory) Set 

func (v *NullableErrorCategory) Set(val *ErrorCategory)

func (*NullableErrorCategory) UnmarshalJSON 

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

func (*NullableErrorCategory) Unset 

func (v *NullableErrorCategory) Unset()

type NullableErrorDetail 

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

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (v NullableErrorDetail) Get() *ErrorDetail

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 NullableEventDetail 

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

func NewNullableEventDetail 

func NewNullableEventDetail(val *EventDetail) *NullableEventDetail

func (NullableEventDetail) Get 

func (v NullableEventDetail) Get() *EventDetail

func (NullableEventDetail) IsSet 

func (v NullableEventDetail) IsSet() bool

func (NullableEventDetail) MarshalJSON 

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

func (*NullableEventDetail) Set 

func (v *NullableEventDetail) Set(val *EventDetail)

func (*NullableEventDetail) UnmarshalJSON 

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

func (*NullableEventDetail) Unset 

func (v *NullableEventDetail) 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 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 NullableStandardError 

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

func NewNullableStandardError 

func NewNullableStandardError(val *StandardError) *NullableStandardError

func (NullableStandardError) Get 

func (v NullableStandardError) Get() *StandardError

func (NullableStandardError) IsSet 

func (v NullableStandardError) IsSet() bool

func (NullableStandardError) MarshalJSON 

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

func (*NullableStandardError) Set 

func (v *NullableStandardError) Set(val *StandardError)

func (*NullableStandardError) UnmarshalJSON 

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

func (*NullableStandardError) Unset 

func (v *NullableStandardError) 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 NullableTimelineEvent 

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

func NewNullableTimelineEvent 

func NewNullableTimelineEvent(val *TimelineEvent) *NullableTimelineEvent

func (NullableTimelineEvent) Get 

func (v NullableTimelineEvent) Get() *TimelineEvent

func (NullableTimelineEvent) IsSet 

func (v NullableTimelineEvent) IsSet() bool

func (NullableTimelineEvent) MarshalJSON 

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

func (*NullableTimelineEvent) Set 

func (v *NullableTimelineEvent) Set(val *TimelineEvent)

func (*NullableTimelineEvent) UnmarshalJSON 

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

func (*NullableTimelineEvent) Unset 

func (v *NullableTimelineEvent) Unset()

type NullableTimelineEventIFrame 

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

func NewNullableTimelineEventIFrame 

func NewNullableTimelineEventIFrame(val *TimelineEventIFrame) *NullableTimelineEventIFrame

func (NullableTimelineEventIFrame) Get 

func (v NullableTimelineEventIFrame) Get() *TimelineEventIFrame

func (NullableTimelineEventIFrame) IsSet 

func (v NullableTimelineEventIFrame) IsSet() bool

func (NullableTimelineEventIFrame) MarshalJSON 

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

func (*NullableTimelineEventIFrame) Set 

func (v *NullableTimelineEventIFrame) Set(val *TimelineEventIFrame)

func (*NullableTimelineEventIFrame) UnmarshalJSON 

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

func (*NullableTimelineEventIFrame) Unset 

func (v *NullableTimelineEventIFrame) Unset()

type NullableTimelineEventResponse 

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

func NewNullableTimelineEventResponse 

func NewNullableTimelineEventResponse(val *TimelineEventResponse) *NullableTimelineEventResponse

func (NullableTimelineEventResponse) Get 

func (v NullableTimelineEventResponse) Get() *TimelineEventResponse

func (NullableTimelineEventResponse) IsSet 

func (v NullableTimelineEventResponse) IsSet() bool

func (NullableTimelineEventResponse) MarshalJSON 

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

func (*NullableTimelineEventResponse) Set 

func (v *NullableTimelineEventResponse) Set(val *TimelineEventResponse)

func (*NullableTimelineEventResponse) UnmarshalJSON 

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

func (*NullableTimelineEventResponse) Unset 

func (v *NullableTimelineEventResponse) Unset()

type NullableTimelineEventTemplate 

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

func NewNullableTimelineEventTemplate 

func NewNullableTimelineEventTemplate(val *TimelineEventTemplate) *NullableTimelineEventTemplate

func (NullableTimelineEventTemplate) Get 

func (v NullableTimelineEventTemplate) Get() *TimelineEventTemplate

func (NullableTimelineEventTemplate) IsSet 

func (v NullableTimelineEventTemplate) IsSet() bool

func (NullableTimelineEventTemplate) MarshalJSON 

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

func (*NullableTimelineEventTemplate) Set 

func (v *NullableTimelineEventTemplate) Set(val *TimelineEventTemplate)

func (*NullableTimelineEventTemplate) UnmarshalJSON 

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

func (*NullableTimelineEventTemplate) Unset 

func (v *NullableTimelineEventTemplate) Unset()

type NullableTimelineEventTemplateCreateRequest 

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

func NewNullableTimelineEventTemplateCreateRequest 

func NewNullableTimelineEventTemplateCreateRequest(val *TimelineEventTemplateCreateRequest) *NullableTimelineEventTemplateCreateRequest

func (NullableTimelineEventTemplateCreateRequest) Get 

func (v NullableTimelineEventTemplateCreateRequest) Get() *TimelineEventTemplateCreateRequest

func (NullableTimelineEventTemplateCreateRequest) IsSet 

func (v NullableTimelineEventTemplateCreateRequest) IsSet() bool

func (NullableTimelineEventTemplateCreateRequest) MarshalJSON 

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

func (*NullableTimelineEventTemplateCreateRequest) Set 

func (v *NullableTimelineEventTemplateCreateRequest) Set(val *TimelineEventTemplateCreateRequest)

func (*NullableTimelineEventTemplateCreateRequest) UnmarshalJSON 

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

func (*NullableTimelineEventTemplateCreateRequest) Unset 

func (v *NullableTimelineEventTemplateCreateRequest) Unset()

type NullableTimelineEventTemplateToken 

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

func NewNullableTimelineEventTemplateToken 

func NewNullableTimelineEventTemplateToken(val *TimelineEventTemplateToken) *NullableTimelineEventTemplateToken

func (NullableTimelineEventTemplateToken) Get 

func (v NullableTimelineEventTemplateToken) Get() *TimelineEventTemplateToken

func (NullableTimelineEventTemplateToken) IsSet 

func (v NullableTimelineEventTemplateToken) IsSet() bool

func (NullableTimelineEventTemplateToken) MarshalJSON 

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

func (*NullableTimelineEventTemplateToken) Set 

func (v *NullableTimelineEventTemplateToken) Set(val *TimelineEventTemplateToken)

func (*NullableTimelineEventTemplateToken) UnmarshalJSON 

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

func (*NullableTimelineEventTemplateToken) Unset 

func (v *NullableTimelineEventTemplateToken) Unset()

type NullableTimelineEventTemplateTokenOption 

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

func NewNullableTimelineEventTemplateTokenOption 

func NewNullableTimelineEventTemplateTokenOption(val *TimelineEventTemplateTokenOption) *NullableTimelineEventTemplateTokenOption

func (NullableTimelineEventTemplateTokenOption) Get 

func (v NullableTimelineEventTemplateTokenOption) Get() *TimelineEventTemplateTokenOption

func (NullableTimelineEventTemplateTokenOption) IsSet 

func (v NullableTimelineEventTemplateTokenOption) IsSet() bool

func (NullableTimelineEventTemplateTokenOption) MarshalJSON 

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

func (*NullableTimelineEventTemplateTokenOption) Set 

func (v *NullableTimelineEventTemplateTokenOption) Set(val *TimelineEventTemplateTokenOption)

func (*NullableTimelineEventTemplateTokenOption) UnmarshalJSON 

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

func (*NullableTimelineEventTemplateTokenOption) Unset 

func (v *NullableTimelineEventTemplateTokenOption) Unset()

type NullableTimelineEventTemplateTokenUpdateRequest 

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

func NewNullableTimelineEventTemplateTokenUpdateRequest 

func NewNullableTimelineEventTemplateTokenUpdateRequest(val *TimelineEventTemplateTokenUpdateRequest) *NullableTimelineEventTemplateTokenUpdateRequest

func (NullableTimelineEventTemplateTokenUpdateRequest) Get 

func (v NullableTimelineEventTemplateTokenUpdateRequest) Get() *TimelineEventTemplateTokenUpdateRequest

func (NullableTimelineEventTemplateTokenUpdateRequest) IsSet 

func (v NullableTimelineEventTemplateTokenUpdateRequest) IsSet() bool

func (NullableTimelineEventTemplateTokenUpdateRequest) MarshalJSON 

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

func (*NullableTimelineEventTemplateTokenUpdateRequest) Set 

func (v *NullableTimelineEventTemplateTokenUpdateRequest) Set(val *TimelineEventTemplateTokenUpdateRequest)

func (*NullableTimelineEventTemplateTokenUpdateRequest) UnmarshalJSON 

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

func (*NullableTimelineEventTemplateTokenUpdateRequest) Unset 

func (v *NullableTimelineEventTemplateTokenUpdateRequest) Unset()

type NullableTimelineEventTemplateUpdateRequest 

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

func NewNullableTimelineEventTemplateUpdateRequest 

func NewNullableTimelineEventTemplateUpdateRequest(val *TimelineEventTemplateUpdateRequest) *NullableTimelineEventTemplateUpdateRequest

func (NullableTimelineEventTemplateUpdateRequest) Get 

func (v NullableTimelineEventTemplateUpdateRequest) Get() *TimelineEventTemplateUpdateRequest

func (NullableTimelineEventTemplateUpdateRequest) IsSet 

func (v NullableTimelineEventTemplateUpdateRequest) IsSet() bool

func (NullableTimelineEventTemplateUpdateRequest) MarshalJSON 

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

func (*NullableTimelineEventTemplateUpdateRequest) Set 

func (v *NullableTimelineEventTemplateUpdateRequest) Set(val *TimelineEventTemplateUpdateRequest)

func (*NullableTimelineEventTemplateUpdateRequest) UnmarshalJSON 

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

func (*NullableTimelineEventTemplateUpdateRequest) Unset 

func (v *NullableTimelineEventTemplateUpdateRequest) Unset()

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 StandardError 

type StandardError struct {
	Status      string                 `json:"status"`
	Id          *string                `json:"id,omitempty"`
	Category    ErrorCategory          `json:"category"`
	SubCategory map[string]interface{} `json:"subCategory,omitempty"`
	Message     string                 `json:"message"`
	Errors      []ErrorDetail          `json:"errors"`
	Context     map[string][]string    `json:"context"`
	Links       map[string]string      `json:"links"`
}

StandardError struct for StandardError

func NewStandardError 

func NewStandardError(status string, category ErrorCategory, message string, errors []ErrorDetail, context map[string][]string, links map[string]string) *StandardError

NewStandardError instantiates a new StandardError 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 NewStandardErrorWithDefaults 

func NewStandardErrorWithDefaults() *StandardError

NewStandardErrorWithDefaults instantiates a new StandardError 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 (*StandardError) GetCategory 

func (o *StandardError) GetCategory() ErrorCategory

GetCategory returns the Category field value

func (*StandardError) GetCategoryOk 

func (o *StandardError) GetCategoryOk() (*ErrorCategory, bool)

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

func (*StandardError) GetContext 

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

GetContext returns the Context field value

func (*StandardError) GetContextOk 

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

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

func (*StandardError) GetErrors 

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

GetErrors returns the Errors field value

func (*StandardError) GetErrorsOk 

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

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

func (*StandardError) GetId 

func (o *StandardError) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*StandardError) GetIdOk 

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

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

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

GetLinks returns the Links field value

func (*StandardError) GetLinksOk 

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

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

func (*StandardError) GetMessage 

func (o *StandardError) GetMessage() string

GetMessage returns the Message field value

func (*StandardError) GetMessageOk 

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

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

func (*StandardError) GetStatus 

func (o *StandardError) GetStatus() string

GetStatus returns the Status field value

func (*StandardError) GetStatusOk 

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

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

func (*StandardError) GetSubCategory 

func (o *StandardError) GetSubCategory() map[string]interface{}

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

func (*StandardError) GetSubCategoryOk 

func (o *StandardError) GetSubCategoryOk() (map[string]interface{}, 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 (*StandardError) HasId 

func (o *StandardError) HasId() bool

HasId returns a boolean if a field has been set.

func (*StandardError) HasSubCategory 

func (o *StandardError) HasSubCategory() bool

HasSubCategory returns a boolean if a field has been set.

func (StandardError) MarshalJSON 

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

func (*StandardError) SetCategory 

func (o *StandardError) SetCategory(v ErrorCategory)

SetCategory sets field value

func (*StandardError) SetContext 

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

SetContext sets field value

func (*StandardError) SetErrors 

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

SetErrors sets field value

func (*StandardError) SetId 

func (o *StandardError) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field. 

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

SetLinks sets field value

func (*StandardError) SetMessage 

func (o *StandardError) SetMessage(v string)

SetMessage sets field value

func (*StandardError) SetStatus 

func (o *StandardError) SetStatus(v string)

SetStatus sets field value

func (*StandardError) SetSubCategory 

func (o *StandardError) SetSubCategory(v map[string]interface{})

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

type TemplatesApiService 

type TemplatesApiService service

TemplatesApiService TemplatesApi service

func (*TemplatesApiService) TemplateCreate 

func (a *TemplatesApiService) TemplateCreate(ctx context.Context, appId int32) ApiTemplateCreateRequest

TemplateCreate Create an event template for your app

Event templates define the general structure for a custom timeline event. This includes formatted copy for its heading and details, as well as any custom property definitions. The event could be something like viewing a video, registering for a webinar, or filling out a survey. A single app can define multiple event templates.

Event templates will be created for contacts by default, but they can be created for companies, tickets, and deals as well.

Each event template contains its own set of tokens and `Markdown` templates. These tokens can be associated with any CRM object properties via the `objectPropertyName` field to fully build out CRM objects.

You must create an event template before you can create events. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId The ID of the target app.
@return ApiTemplateCreateRequest

func (*TemplatesApiService) TemplateCreateExecute 

func (a *TemplatesApiService) TemplateCreateExecute(r ApiTemplateCreateRequest) (*TimelineEventTemplate, *http.Response, error)

Execute executes the request 

@return TimelineEventTemplate

func (*TemplatesApiService) TemplateGetAll 

func (a *TemplatesApiService) TemplateGetAll(ctx context.Context, appId int32) ApiTemplateGetAllRequest

TemplateGetAll List all event templates for your app

Use this to list all event templates owned by your app. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param appId The ID of the target app.
@return ApiTemplateGetAllRequest

func (*TemplatesApiService) TemplateGetAllExecute 

func (a *TemplatesApiService) TemplateGetAllExecute(r ApiTemplateGetAllRequest) (*CollectionResponseTimelineEventTemplateNoPaging, *http.Response, error)

Execute executes the request 

@return CollectionResponseTimelineEventTemplateNoPaging

func (*TemplatesApiService) TemplatesArchive 

func (a *TemplatesApiService) TemplatesArchive(ctx context.Context, eventTemplateId string, appId int32) ApiTemplatesArchiveRequest

TemplatesArchive Deletes an event template for the app

This will delete the event template. All associated events will be removed from search results and the timeline UI.

This action can't be undone, so it's highly recommended that you stop using any associated events before deleting a template. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param appId The ID of the target app.
@return ApiTemplatesArchiveRequest

func (*TemplatesApiService) TemplatesArchiveExecute 

func (a *TemplatesApiService) TemplatesArchiveExecute(r ApiTemplatesArchiveRequest) (*http.Response, error)

Execute executes the request

func (*TemplatesApiService) TemplatesGetByID 

func (a *TemplatesApiService) TemplatesGetByID(ctx context.Context, eventTemplateId string, appId int32) ApiTemplatesGetByIDRequest

TemplatesGetByID Gets a specific event template for your app

View the current state of a specific template and its tokens. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param appId The ID of the target app.
@return ApiTemplatesGetByIDRequest

func (*TemplatesApiService) TemplatesGetByIDExecute 

func (a *TemplatesApiService) TemplatesGetByIDExecute(r ApiTemplatesGetByIDRequest) (*TimelineEventTemplate, *http.Response, error)

Execute executes the request 

@return TimelineEventTemplate

func (*TemplatesApiService) TemplatesUpdate 

func (a *TemplatesApiService) TemplatesUpdate(ctx context.Context, eventTemplateId string, appId int32) ApiTemplatesUpdateRequest

TemplatesUpdate Update an existing event template

Updates an existing template and its tokens. This is primarily used to update the headerTemplate/detailTemplate, and those changes will take effect for existing events.

You can also update or replace all the tokens in the template here instead of doing individual API calls on the `/tokens` endpoint. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param appId The ID of the target app.
@return ApiTemplatesUpdateRequest

func (*TemplatesApiService) TemplatesUpdateExecute 

func (a *TemplatesApiService) TemplatesUpdateExecute(r ApiTemplatesUpdateRequest) (*TimelineEventTemplate, *http.Response, error)

Execute executes the request 

@return TimelineEventTemplate

type TimelineEvent 

type TimelineEvent struct {
	// The event template ID.
	EventTemplateId string `json:"eventTemplateId"`
	// 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 CRM object identifier. This is required for every event other than contacts (where utk or email can be used).
	ObjectId *string `json:"objectId,omitempty"`
	// 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 event domain (often paired with utk).
	Domain *string `json:"domain,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 map[string]string `json:"tokens"`
	// Additional event-specific data that can be interpreted by the template's markdown.
	ExtraData      map[string]interface{} `json:"extraData,omitempty"`
	TimelineIFrame *TimelineEventIFrame   `json:"timelineIFrame,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,omitempty"`
}

TimelineEvent The state of the timeline event.

func NewTimelineEvent 

func NewTimelineEvent(eventTemplateId string, tokens map[string]string) *TimelineEvent

NewTimelineEvent instantiates a new TimelineEvent 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 NewTimelineEventWithDefaults 

func NewTimelineEventWithDefaults() *TimelineEvent

NewTimelineEventWithDefaults instantiates a new TimelineEvent 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 (*TimelineEvent) GetDomain 

func (o *TimelineEvent) GetDomain() string

GetDomain returns the Domain field value if set, zero value otherwise.

func (*TimelineEvent) GetDomainOk 

func (o *TimelineEvent) GetDomainOk() (*string, bool)

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

func (*TimelineEvent) GetEmail 

func (o *TimelineEvent) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise.

func (*TimelineEvent) GetEmailOk 

func (o *TimelineEvent) GetEmailOk() (*string, bool)

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

func (*TimelineEvent) GetEventTemplateId 

func (o *TimelineEvent) GetEventTemplateId() string

GetEventTemplateId returns the EventTemplateId field value

func (*TimelineEvent) GetEventTemplateIdOk 

func (o *TimelineEvent) GetEventTemplateIdOk() (*string, bool)

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

func (*TimelineEvent) GetExtraData 

func (o *TimelineEvent) GetExtraData() map[string]interface{}

GetExtraData returns the ExtraData field value if set, zero value otherwise.

func (*TimelineEvent) GetExtraDataOk 

func (o *TimelineEvent) GetExtraDataOk() (map[string]interface{}, bool)

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

func (*TimelineEvent) GetId 

func (o *TimelineEvent) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*TimelineEvent) GetIdOk 

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

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

func (*TimelineEvent) GetObjectId 

func (o *TimelineEvent) GetObjectId() string

GetObjectId returns the ObjectId field value if set, zero value otherwise.

func (*TimelineEvent) GetObjectIdOk 

func (o *TimelineEvent) GetObjectIdOk() (*string, bool)

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

func (*TimelineEvent) GetTimelineIFrame 

func (o *TimelineEvent) GetTimelineIFrame() TimelineEventIFrame

GetTimelineIFrame returns the TimelineIFrame field value if set, zero value otherwise.

func (*TimelineEvent) GetTimelineIFrameOk 

func (o *TimelineEvent) GetTimelineIFrameOk() (*TimelineEventIFrame, bool)

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

func (*TimelineEvent) GetTimestamp 

func (o *TimelineEvent) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*TimelineEvent) GetTimestampOk 

func (o *TimelineEvent) GetTimestampOk() (*time.Time, bool)

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

func (*TimelineEvent) GetTokens 

func (o *TimelineEvent) GetTokens() map[string]string

GetTokens returns the Tokens field value

func (*TimelineEvent) GetTokensOk 

func (o *TimelineEvent) GetTokensOk() (*map[string]string, bool)

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

func (*TimelineEvent) GetUtk 

func (o *TimelineEvent) GetUtk() string

GetUtk returns the Utk field value if set, zero value otherwise.

func (*TimelineEvent) GetUtkOk 

func (o *TimelineEvent) GetUtkOk() (*string, bool)

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

func (*TimelineEvent) HasDomain 

func (o *TimelineEvent) HasDomain() bool

HasDomain returns a boolean if a field has been set.

func (*TimelineEvent) HasEmail 

func (o *TimelineEvent) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*TimelineEvent) HasExtraData 

func (o *TimelineEvent) HasExtraData() bool

HasExtraData returns a boolean if a field has been set.

func (*TimelineEvent) HasId 

func (o *TimelineEvent) HasId() bool

HasId returns a boolean if a field has been set.

func (*TimelineEvent) HasObjectId 

func (o *TimelineEvent) HasObjectId() bool

HasObjectId returns a boolean if a field has been set.

func (*TimelineEvent) HasTimelineIFrame 

func (o *TimelineEvent) HasTimelineIFrame() bool

HasTimelineIFrame returns a boolean if a field has been set.

func (*TimelineEvent) HasTimestamp 

func (o *TimelineEvent) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (*TimelineEvent) HasUtk 

func (o *TimelineEvent) HasUtk() bool

HasUtk returns a boolean if a field has been set.

func (TimelineEvent) MarshalJSON 

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

func (*TimelineEvent) SetDomain 

func (o *TimelineEvent) SetDomain(v string)

SetDomain gets a reference to the given string and assigns it to the Domain field.

func (*TimelineEvent) SetEmail 

func (o *TimelineEvent) SetEmail(v string)

SetEmail gets a reference to the given string and assigns it to the Email field.

func (*TimelineEvent) SetEventTemplateId 

func (o *TimelineEvent) SetEventTemplateId(v string)

SetEventTemplateId sets field value

func (*TimelineEvent) SetExtraData 

func (o *TimelineEvent) SetExtraData(v map[string]interface{})

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

func (*TimelineEvent) SetId 

func (o *TimelineEvent) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (*TimelineEvent) SetObjectId 

func (o *TimelineEvent) SetObjectId(v string)

SetObjectId gets a reference to the given string and assigns it to the ObjectId field.

func (*TimelineEvent) SetTimelineIFrame 

func (o *TimelineEvent) SetTimelineIFrame(v TimelineEventIFrame)

SetTimelineIFrame gets a reference to the given TimelineEventIFrame and assigns it to the TimelineIFrame field.

func (*TimelineEvent) SetTimestamp 

func (o *TimelineEvent) SetTimestamp(v time.Time)

SetTimestamp gets a reference to the given time.Time and assigns it to the Timestamp field.

func (*TimelineEvent) SetTokens 

func (o *TimelineEvent) SetTokens(v map[string]string)

SetTokens sets field value

func (*TimelineEvent) SetUtk 

func (o *TimelineEvent) SetUtk(v string)

SetUtk gets a reference to the given string and assigns it to the Utk field.

type TimelineEventIFrame 

type TimelineEventIFrame struct {
	// The text displaying the link that will display the iframe.
	LinkLabel string `json:"linkLabel"`
	// The label of the modal window that displays the iframe contents.
	HeaderLabel string `json:"headerLabel"`
	// The URI of the iframe contents.
	Url string `json:"url"`
	// The width of the modal window in pixels.
	Width int32 `json:"width"`
	// The height of the modal window in pixels.
	Height int32 `json:"height"`
}

TimelineEventIFrame struct for TimelineEventIFrame

func NewTimelineEventIFrame 

func NewTimelineEventIFrame(linkLabel string, headerLabel string, url string, width int32, height int32) *TimelineEventIFrame

NewTimelineEventIFrame instantiates a new TimelineEventIFrame 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 NewTimelineEventIFrameWithDefaults 

func NewTimelineEventIFrameWithDefaults() *TimelineEventIFrame

NewTimelineEventIFrameWithDefaults instantiates a new TimelineEventIFrame 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 (*TimelineEventIFrame) GetHeaderLabel 

func (o *TimelineEventIFrame) GetHeaderLabel() string

GetHeaderLabel returns the HeaderLabel field value

func (*TimelineEventIFrame) GetHeaderLabelOk 

func (o *TimelineEventIFrame) GetHeaderLabelOk() (*string, bool)

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

func (*TimelineEventIFrame) GetHeight 

func (o *TimelineEventIFrame) GetHeight() int32

GetHeight returns the Height field value

func (*TimelineEventIFrame) GetHeightOk 

func (o *TimelineEventIFrame) GetHeightOk() (*int32, bool)

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

func (*TimelineEventIFrame) GetLinkLabel 

func (o *TimelineEventIFrame) GetLinkLabel() string

GetLinkLabel returns the LinkLabel field value

func (*TimelineEventIFrame) GetLinkLabelOk 

func (o *TimelineEventIFrame) GetLinkLabelOk() (*string, bool)

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

func (*TimelineEventIFrame) GetUrl 

func (o *TimelineEventIFrame) GetUrl() string

GetUrl returns the Url field value

func (*TimelineEventIFrame) GetUrlOk 

func (o *TimelineEventIFrame) GetUrlOk() (*string, bool)

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

func (*TimelineEventIFrame) GetWidth 

func (o *TimelineEventIFrame) GetWidth() int32

GetWidth returns the Width field value

func (*TimelineEventIFrame) GetWidthOk 

func (o *TimelineEventIFrame) GetWidthOk() (*int32, bool)

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

func (TimelineEventIFrame) MarshalJSON 

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

func (*TimelineEventIFrame) SetHeaderLabel 

func (o *TimelineEventIFrame) SetHeaderLabel(v string)

SetHeaderLabel sets field value

func (*TimelineEventIFrame) SetHeight 

func (o *TimelineEventIFrame) SetHeight(v int32)

SetHeight sets field value

func (*TimelineEventIFrame) SetLinkLabel 

func (o *TimelineEventIFrame) SetLinkLabel(v string)

SetLinkLabel sets field value

func (*TimelineEventIFrame) SetUrl 

func (o *TimelineEventIFrame) SetUrl(v string)

SetUrl sets field value

func (*TimelineEventIFrame) SetWidth 

func (o *TimelineEventIFrame) SetWidth(v int32)

SetWidth sets field value

type TimelineEventResponse 

type TimelineEventResponse struct {
	// 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 event template ID.
	EventTemplateId string `json:"eventTemplateId"`
	// 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 CRM object identifier. This is required for every event other than contacts (where utk or email can be used).
	ObjectId *string `json:"objectId,omitempty"`
	// 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 event domain (often paired with utk).
	Domain *string `json:"domain,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 map[string]string `json:"tokens"`
	// Additional event-specific data that can be interpreted by the template's markdown.
	ExtraData      map[string]interface{} `json:"extraData,omitempty"`
	TimelineIFrame *TimelineEventIFrame   `json:"timelineIFrame,omitempty"`
	// The ObjectType associated with the EventTemplate.
	ObjectType string     `json:"objectType"`
	CreatedAt  *time.Time `json:"createdAt,omitempty"`
}

TimelineEventResponse The current state of the timeline event.

func NewTimelineEventResponse 

func NewTimelineEventResponse(id string, eventTemplateId string, tokens map[string]string, objectType string) *TimelineEventResponse

NewTimelineEventResponse instantiates a new TimelineEventResponse 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 NewTimelineEventResponseWithDefaults 

func NewTimelineEventResponseWithDefaults() *TimelineEventResponse

NewTimelineEventResponseWithDefaults instantiates a new TimelineEventResponse 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 (*TimelineEventResponse) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*TimelineEventResponse) GetCreatedAtOk 

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

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

func (*TimelineEventResponse) GetDomain 

func (o *TimelineEventResponse) GetDomain() string

GetDomain returns the Domain field value if set, zero value otherwise.

func (*TimelineEventResponse) GetDomainOk 

func (o *TimelineEventResponse) GetDomainOk() (*string, bool)

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

func (*TimelineEventResponse) GetEmail 

func (o *TimelineEventResponse) GetEmail() string

GetEmail returns the Email field value if set, zero value otherwise.

func (*TimelineEventResponse) GetEmailOk 

func (o *TimelineEventResponse) GetEmailOk() (*string, bool)

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

func (*TimelineEventResponse) GetEventTemplateId 

func (o *TimelineEventResponse) GetEventTemplateId() string

GetEventTemplateId returns the EventTemplateId field value

func (*TimelineEventResponse) GetEventTemplateIdOk 

func (o *TimelineEventResponse) GetEventTemplateIdOk() (*string, bool)

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

func (*TimelineEventResponse) GetExtraData 

func (o *TimelineEventResponse) GetExtraData() map[string]interface{}

GetExtraData returns the ExtraData field value if set, zero value otherwise.

func (*TimelineEventResponse) GetExtraDataOk 

func (o *TimelineEventResponse) GetExtraDataOk() (map[string]interface{}, bool)

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

func (*TimelineEventResponse) GetId 

func (o *TimelineEventResponse) GetId() string

GetId returns the Id field value

func (*TimelineEventResponse) GetIdOk 

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

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

func (*TimelineEventResponse) GetObjectId 

func (o *TimelineEventResponse) GetObjectId() string

GetObjectId returns the ObjectId field value if set, zero value otherwise.

func (*TimelineEventResponse) GetObjectIdOk 

func (o *TimelineEventResponse) GetObjectIdOk() (*string, bool)

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

func (*TimelineEventResponse) GetObjectType 

func (o *TimelineEventResponse) GetObjectType() string

GetObjectType returns the ObjectType field value

func (*TimelineEventResponse) GetObjectTypeOk 

func (o *TimelineEventResponse) GetObjectTypeOk() (*string, bool)

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

func (*TimelineEventResponse) GetTimelineIFrame 

func (o *TimelineEventResponse) GetTimelineIFrame() TimelineEventIFrame

GetTimelineIFrame returns the TimelineIFrame field value if set, zero value otherwise.

func (*TimelineEventResponse) GetTimelineIFrameOk 

func (o *TimelineEventResponse) GetTimelineIFrameOk() (*TimelineEventIFrame, bool)

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

func (*TimelineEventResponse) GetTimestamp 

func (o *TimelineEventResponse) GetTimestamp() time.Time

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*TimelineEventResponse) GetTimestampOk 

func (o *TimelineEventResponse) GetTimestampOk() (*time.Time, bool)

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

func (*TimelineEventResponse) GetTokens 

func (o *TimelineEventResponse) GetTokens() map[string]string

GetTokens returns the Tokens field value

func (*TimelineEventResponse) GetTokensOk 

func (o *TimelineEventResponse) GetTokensOk() (*map[string]string, bool)

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

func (*TimelineEventResponse) GetUtk 

func (o *TimelineEventResponse) GetUtk() string

GetUtk returns the Utk field value if set, zero value otherwise.

func (*TimelineEventResponse) GetUtkOk 

func (o *TimelineEventResponse) GetUtkOk() (*string, bool)

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

func (*TimelineEventResponse) HasCreatedAt 

func (o *TimelineEventResponse) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*TimelineEventResponse) HasDomain 

func (o *TimelineEventResponse) HasDomain() bool

HasDomain returns a boolean if a field has been set.

func (*TimelineEventResponse) HasEmail 

func (o *TimelineEventResponse) HasEmail() bool

HasEmail returns a boolean if a field has been set.

func (*TimelineEventResponse) HasExtraData 

func (o *TimelineEventResponse) HasExtraData() bool

HasExtraData returns a boolean if a field has been set.

func (*TimelineEventResponse) HasObjectId 

func (o *TimelineEventResponse) HasObjectId() bool

HasObjectId returns a boolean if a field has been set.

func (*TimelineEventResponse) HasTimelineIFrame 

func (o *TimelineEventResponse) HasTimelineIFrame() bool

HasTimelineIFrame returns a boolean if a field has been set.

func (*TimelineEventResponse) HasTimestamp 

func (o *TimelineEventResponse) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (*TimelineEventResponse) HasUtk 

func (o *TimelineEventResponse) HasUtk() bool

HasUtk returns a boolean if a field has been set.

func (TimelineEventResponse) MarshalJSON 

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

func (*TimelineEventResponse) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*TimelineEventResponse) SetDomain 

func (o *TimelineEventResponse) SetDomain(v string)

SetDomain gets a reference to the given string and assigns it to the Domain field.

func (*TimelineEventResponse) SetEmail 

func (o *TimelineEventResponse) SetEmail(v string)

SetEmail gets a reference to the given string and assigns it to the Email field.

func (*TimelineEventResponse) SetEventTemplateId 

func (o *TimelineEventResponse) SetEventTemplateId(v string)

SetEventTemplateId sets field value

func (*TimelineEventResponse) SetExtraData 

func (o *TimelineEventResponse) SetExtraData(v map[string]interface{})

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

func (*TimelineEventResponse) SetId 

func (o *TimelineEventResponse) SetId(v string)

SetId sets field value

func (*TimelineEventResponse) SetObjectId 

func (o *TimelineEventResponse) SetObjectId(v string)

SetObjectId gets a reference to the given string and assigns it to the ObjectId field.

func (*TimelineEventResponse) SetObjectType 

func (o *TimelineEventResponse) SetObjectType(v string)

SetObjectType sets field value

func (*TimelineEventResponse) SetTimelineIFrame 

func (o *TimelineEventResponse) SetTimelineIFrame(v TimelineEventIFrame)

SetTimelineIFrame gets a reference to the given TimelineEventIFrame and assigns it to the TimelineIFrame field.

func (*TimelineEventResponse) SetTimestamp 

func (o *TimelineEventResponse) SetTimestamp(v time.Time)

SetTimestamp gets a reference to the given time.Time and assigns it to the Timestamp field.

func (*TimelineEventResponse) SetTokens 

func (o *TimelineEventResponse) SetTokens(v map[string]string)

SetTokens sets field value

func (*TimelineEventResponse) SetUtk 

func (o *TimelineEventResponse) SetUtk(v string)

SetUtk gets a reference to the given string and assigns it to the Utk field.

type TimelineEventTemplate 

type TimelineEventTemplate struct {
	// The template name.
	Name string `json:"name"`
	// This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
	HeaderTemplate *string `json:"headerTemplate,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"`
	// 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 template ID.
	Id string `json:"id"`
	// The type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported.
	ObjectType string `json:"objectType"`
	// 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"`
	// 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"`
}

TimelineEventTemplate The current state of the template definition.

func NewTimelineEventTemplate 

func NewTimelineEventTemplate(name string, tokens []TimelineEventTemplateToken, id string, objectType string) *TimelineEventTemplate

NewTimelineEventTemplate instantiates a new TimelineEventTemplate 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 NewTimelineEventTemplateWithDefaults 

func NewTimelineEventTemplateWithDefaults() *TimelineEventTemplate

NewTimelineEventTemplateWithDefaults instantiates a new TimelineEventTemplate 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 (*TimelineEventTemplate) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*TimelineEventTemplate) GetCreatedAtOk 

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

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

func (*TimelineEventTemplate) GetDetailTemplate 

func (o *TimelineEventTemplate) GetDetailTemplate() string

GetDetailTemplate returns the DetailTemplate field value if set, zero value otherwise.

func (*TimelineEventTemplate) GetDetailTemplateOk 

func (o *TimelineEventTemplate) GetDetailTemplateOk() (*string, bool)

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

func (*TimelineEventTemplate) GetHeaderTemplate 

func (o *TimelineEventTemplate) GetHeaderTemplate() string

GetHeaderTemplate returns the HeaderTemplate field value if set, zero value otherwise.

func (*TimelineEventTemplate) GetHeaderTemplateOk 

func (o *TimelineEventTemplate) GetHeaderTemplateOk() (*string, bool)

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

func (*TimelineEventTemplate) GetId 

func (o *TimelineEventTemplate) GetId() string

GetId returns the Id field value

func (*TimelineEventTemplate) GetIdOk 

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

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

func (*TimelineEventTemplate) GetName 

func (o *TimelineEventTemplate) GetName() string

GetName returns the Name field value

func (*TimelineEventTemplate) GetNameOk 

func (o *TimelineEventTemplate) GetNameOk() (*string, bool)

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

func (*TimelineEventTemplate) GetObjectType 

func (o *TimelineEventTemplate) GetObjectType() string

GetObjectType returns the ObjectType field value

func (*TimelineEventTemplate) GetObjectTypeOk 

func (o *TimelineEventTemplate) GetObjectTypeOk() (*string, bool)

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

func (*TimelineEventTemplate) GetTokens 

func (o *TimelineEventTemplate) GetTokens() []TimelineEventTemplateToken

GetTokens returns the Tokens field value

func (*TimelineEventTemplate) GetTokensOk 

func (o *TimelineEventTemplate) GetTokensOk() ([]TimelineEventTemplateToken, bool)

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

func (*TimelineEventTemplate) GetUpdatedAt 

func (o *TimelineEventTemplate) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*TimelineEventTemplate) GetUpdatedAtOk 

func (o *TimelineEventTemplate) GetUpdatedAtOk() (*time.Time, bool)

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

func (*TimelineEventTemplate) HasCreatedAt 

func (o *TimelineEventTemplate) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*TimelineEventTemplate) HasDetailTemplate 

func (o *TimelineEventTemplate) HasDetailTemplate() bool

HasDetailTemplate returns a boolean if a field has been set.

func (*TimelineEventTemplate) HasHeaderTemplate 

func (o *TimelineEventTemplate) HasHeaderTemplate() bool

HasHeaderTemplate returns a boolean if a field has been set.

func (*TimelineEventTemplate) HasUpdatedAt 

func (o *TimelineEventTemplate) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (TimelineEventTemplate) MarshalJSON 

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

func (*TimelineEventTemplate) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*TimelineEventTemplate) SetDetailTemplate 

func (o *TimelineEventTemplate) SetDetailTemplate(v string)

SetDetailTemplate gets a reference to the given string and assigns it to the DetailTemplate field.

func (*TimelineEventTemplate) SetHeaderTemplate 

func (o *TimelineEventTemplate) SetHeaderTemplate(v string)

SetHeaderTemplate gets a reference to the given string and assigns it to the HeaderTemplate field.

func (*TimelineEventTemplate) SetId 

func (o *TimelineEventTemplate) SetId(v string)

SetId sets field value

func (*TimelineEventTemplate) SetName 

func (o *TimelineEventTemplate) SetName(v string)

SetName sets field value

func (*TimelineEventTemplate) SetObjectType 

func (o *TimelineEventTemplate) SetObjectType(v string)

SetObjectType sets field value

func (*TimelineEventTemplate) SetTokens 

func (o *TimelineEventTemplate) SetTokens(v []TimelineEventTemplateToken)

SetTokens sets field value

func (*TimelineEventTemplate) SetUpdatedAt 

func (o *TimelineEventTemplate) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

type TimelineEventTemplateCreateRequest 

type TimelineEventTemplateCreateRequest struct {
	// The template name.
	Name string `json:"name"`
	// This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
	HeaderTemplate *string `json:"headerTemplate,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"`
	// 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 type of CRM object this template is for. [Contacts, companies, tickets, and deals] are supported.
	ObjectType string `json:"objectType"`
}

TimelineEventTemplateCreateRequest State of the template definition being created.

func NewTimelineEventTemplateCreateRequest 

func NewTimelineEventTemplateCreateRequest(name string, tokens []TimelineEventTemplateToken, objectType string) *TimelineEventTemplateCreateRequest

NewTimelineEventTemplateCreateRequest instantiates a new TimelineEventTemplateCreateRequest 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 NewTimelineEventTemplateCreateRequestWithDefaults 

func NewTimelineEventTemplateCreateRequestWithDefaults() *TimelineEventTemplateCreateRequest

NewTimelineEventTemplateCreateRequestWithDefaults instantiates a new TimelineEventTemplateCreateRequest 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 (*TimelineEventTemplateCreateRequest) GetDetailTemplate 

func (o *TimelineEventTemplateCreateRequest) GetDetailTemplate() string

GetDetailTemplate returns the DetailTemplate field value if set, zero value otherwise.

func (*TimelineEventTemplateCreateRequest) GetDetailTemplateOk 

func (o *TimelineEventTemplateCreateRequest) GetDetailTemplateOk() (*string, bool)

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

func (*TimelineEventTemplateCreateRequest) GetHeaderTemplate 

func (o *TimelineEventTemplateCreateRequest) GetHeaderTemplate() string

GetHeaderTemplate returns the HeaderTemplate field value if set, zero value otherwise.

func (*TimelineEventTemplateCreateRequest) GetHeaderTemplateOk 

func (o *TimelineEventTemplateCreateRequest) GetHeaderTemplateOk() (*string, bool)

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

func (*TimelineEventTemplateCreateRequest) GetName 

func (o *TimelineEventTemplateCreateRequest) GetName() string

GetName returns the Name field value

func (*TimelineEventTemplateCreateRequest) GetNameOk 

func (o *TimelineEventTemplateCreateRequest) GetNameOk() (*string, bool)

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

func (*TimelineEventTemplateCreateRequest) GetObjectType 

func (o *TimelineEventTemplateCreateRequest) GetObjectType() string

GetObjectType returns the ObjectType field value

func (*TimelineEventTemplateCreateRequest) GetObjectTypeOk 

func (o *TimelineEventTemplateCreateRequest) GetObjectTypeOk() (*string, bool)

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

func (*TimelineEventTemplateCreateRequest) GetTokens 

func (o *TimelineEventTemplateCreateRequest) GetTokens() []TimelineEventTemplateToken

GetTokens returns the Tokens field value

func (*TimelineEventTemplateCreateRequest) GetTokensOk 

func (o *TimelineEventTemplateCreateRequest) GetTokensOk() ([]TimelineEventTemplateToken, bool)

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

func (*TimelineEventTemplateCreateRequest) HasDetailTemplate 

func (o *TimelineEventTemplateCreateRequest) HasDetailTemplate() bool

HasDetailTemplate returns a boolean if a field has been set.

func (*TimelineEventTemplateCreateRequest) HasHeaderTemplate 

func (o *TimelineEventTemplateCreateRequest) HasHeaderTemplate() bool

HasHeaderTemplate returns a boolean if a field has been set.

func (TimelineEventTemplateCreateRequest) MarshalJSON 

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

func (*TimelineEventTemplateCreateRequest) SetDetailTemplate 

func (o *TimelineEventTemplateCreateRequest) SetDetailTemplate(v string)

SetDetailTemplate gets a reference to the given string and assigns it to the DetailTemplate field.

func (*TimelineEventTemplateCreateRequest) SetHeaderTemplate 

func (o *TimelineEventTemplateCreateRequest) SetHeaderTemplate(v string)

SetHeaderTemplate gets a reference to the given string and assigns it to the HeaderTemplate field.

func (*TimelineEventTemplateCreateRequest) SetName 

func (o *TimelineEventTemplateCreateRequest) SetName(v string)

SetName sets field value

func (*TimelineEventTemplateCreateRequest) SetObjectType 

func (o *TimelineEventTemplateCreateRequest) SetObjectType(v string)

SetObjectType sets field value

func (*TimelineEventTemplateCreateRequest) SetTokens 

func (o *TimelineEventTemplateCreateRequest) SetTokens(v []TimelineEventTemplateToken)

SetTokens sets field value

type TimelineEventTemplateToken 

type TimelineEventTemplateToken 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"`
	// 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 data type of the token. You can currently choose from [string, number, date, enumeration].
	Type string `json:"type"`
	// 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"`
	// 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"`
}

TimelineEventTemplateToken State of the token definition.

func NewTimelineEventTemplateToken 

func NewTimelineEventTemplateToken(label string, options []TimelineEventTemplateTokenOption, name string, type_ string) *TimelineEventTemplateToken

NewTimelineEventTemplateToken instantiates a new TimelineEventTemplateToken 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 NewTimelineEventTemplateTokenWithDefaults 

func NewTimelineEventTemplateTokenWithDefaults() *TimelineEventTemplateToken

NewTimelineEventTemplateTokenWithDefaults instantiates a new TimelineEventTemplateToken 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 (*TimelineEventTemplateToken) GetCreatedAt 

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

GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.

func (*TimelineEventTemplateToken) GetCreatedAtOk 

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

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

func (*TimelineEventTemplateToken) GetLabel 

func (o *TimelineEventTemplateToken) GetLabel() string

GetLabel returns the Label field value

func (*TimelineEventTemplateToken) GetLabelOk 

func (o *TimelineEventTemplateToken) GetLabelOk() (*string, bool)

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

func (*TimelineEventTemplateToken) GetName 

func (o *TimelineEventTemplateToken) GetName() string

GetName returns the Name field value

func (*TimelineEventTemplateToken) GetNameOk 

func (o *TimelineEventTemplateToken) GetNameOk() (*string, bool)

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

func (*TimelineEventTemplateToken) GetObjectPropertyName 

func (o *TimelineEventTemplateToken) GetObjectPropertyName() string

GetObjectPropertyName returns the ObjectPropertyName field value if set, zero value otherwise.

func (*TimelineEventTemplateToken) GetObjectPropertyNameOk 

func (o *TimelineEventTemplateToken) GetObjectPropertyNameOk() (*string, bool)

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

func (*TimelineEventTemplateToken) GetOptions 

func (o *TimelineEventTemplateToken) GetOptions() []TimelineEventTemplateTokenOption

GetOptions returns the Options field value

func (*TimelineEventTemplateToken) GetOptionsOk 

func (o *TimelineEventTemplateToken) GetOptionsOk() ([]TimelineEventTemplateTokenOption, bool)

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

func (*TimelineEventTemplateToken) GetType 

func (o *TimelineEventTemplateToken) GetType() string

GetType returns the Type field value

func (*TimelineEventTemplateToken) GetTypeOk 

func (o *TimelineEventTemplateToken) GetTypeOk() (*string, bool)

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

func (*TimelineEventTemplateToken) GetUpdatedAt 

func (o *TimelineEventTemplateToken) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field value if set, zero value otherwise.

func (*TimelineEventTemplateToken) GetUpdatedAtOk 

func (o *TimelineEventTemplateToken) GetUpdatedAtOk() (*time.Time, bool)

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

func (*TimelineEventTemplateToken) HasCreatedAt 

func (o *TimelineEventTemplateToken) HasCreatedAt() bool

HasCreatedAt returns a boolean if a field has been set.

func (*TimelineEventTemplateToken) HasObjectPropertyName 

func (o *TimelineEventTemplateToken) HasObjectPropertyName() bool

HasObjectPropertyName returns a boolean if a field has been set.

func (*TimelineEventTemplateToken) HasUpdatedAt 

func (o *TimelineEventTemplateToken) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

func (TimelineEventTemplateToken) MarshalJSON 

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

func (*TimelineEventTemplateToken) SetCreatedAt 

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

SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.

func (*TimelineEventTemplateToken) SetLabel 

func (o *TimelineEventTemplateToken) SetLabel(v string)

SetLabel sets field value

func (*TimelineEventTemplateToken) SetName 

func (o *TimelineEventTemplateToken) SetName(v string)

SetName sets field value

func (*TimelineEventTemplateToken) SetObjectPropertyName 

func (o *TimelineEventTemplateToken) SetObjectPropertyName(v string)

SetObjectPropertyName gets a reference to the given string and assigns it to the ObjectPropertyName field.

func (*TimelineEventTemplateToken) SetOptions 

func (o *TimelineEventTemplateToken) SetOptions(v []TimelineEventTemplateTokenOption)

SetOptions sets field value

func (*TimelineEventTemplateToken) SetType 

func (o *TimelineEventTemplateToken) SetType(v string)

SetType sets field value

func (*TimelineEventTemplateToken) SetUpdatedAt 

func (o *TimelineEventTemplateToken) SetUpdatedAt(v time.Time)

SetUpdatedAt gets a reference to the given time.Time and assigns it to the UpdatedAt field.

type TimelineEventTemplateTokenOption 

type TimelineEventTemplateTokenOption struct {
	Value string `json:"value"`
	Label string `json:"label"`
}

TimelineEventTemplateTokenOption struct for TimelineEventTemplateTokenOption

func NewTimelineEventTemplateTokenOption 

func NewTimelineEventTemplateTokenOption(value string, label string) *TimelineEventTemplateTokenOption

NewTimelineEventTemplateTokenOption instantiates a new TimelineEventTemplateTokenOption 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 NewTimelineEventTemplateTokenOptionWithDefaults 

func NewTimelineEventTemplateTokenOptionWithDefaults() *TimelineEventTemplateTokenOption

NewTimelineEventTemplateTokenOptionWithDefaults instantiates a new TimelineEventTemplateTokenOption 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 (*TimelineEventTemplateTokenOption) GetLabel 

func (o *TimelineEventTemplateTokenOption) GetLabel() string

GetLabel returns the Label field value

func (*TimelineEventTemplateTokenOption) GetLabelOk 

func (o *TimelineEventTemplateTokenOption) GetLabelOk() (*string, bool)

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

func (*TimelineEventTemplateTokenOption) GetValue 

func (o *TimelineEventTemplateTokenOption) GetValue() string

GetValue returns the Value field value

func (*TimelineEventTemplateTokenOption) GetValueOk 

func (o *TimelineEventTemplateTokenOption) GetValueOk() (*string, bool)

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

func (TimelineEventTemplateTokenOption) MarshalJSON 

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

func (*TimelineEventTemplateTokenOption) SetLabel 

func (o *TimelineEventTemplateTokenOption) SetLabel(v string)

SetLabel sets field value

func (*TimelineEventTemplateTokenOption) SetValue 

func (o *TimelineEventTemplateTokenOption) SetValue(v string)

SetValue sets field value

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"`
}

TimelineEventTemplateTokenUpdateRequest State of the token definition for update requests.

func NewTimelineEventTemplateTokenUpdateRequest 

func NewTimelineEventTemplateTokenUpdateRequest(label string, options []TimelineEventTemplateTokenOption) *TimelineEventTemplateTokenUpdateRequest

NewTimelineEventTemplateTokenUpdateRequest instantiates a new TimelineEventTemplateTokenUpdateRequest 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 NewTimelineEventTemplateTokenUpdateRequestWithDefaults 

func NewTimelineEventTemplateTokenUpdateRequestWithDefaults() *TimelineEventTemplateTokenUpdateRequest

NewTimelineEventTemplateTokenUpdateRequestWithDefaults instantiates a new TimelineEventTemplateTokenUpdateRequest 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 (*TimelineEventTemplateTokenUpdateRequest) GetLabel 

func (o *TimelineEventTemplateTokenUpdateRequest) GetLabel() string

GetLabel returns the Label field value

func (*TimelineEventTemplateTokenUpdateRequest) GetLabelOk 

func (o *TimelineEventTemplateTokenUpdateRequest) GetLabelOk() (*string, bool)

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

func (*TimelineEventTemplateTokenUpdateRequest) GetObjectPropertyName 

func (o *TimelineEventTemplateTokenUpdateRequest) GetObjectPropertyName() string

GetObjectPropertyName returns the ObjectPropertyName field value if set, zero value otherwise.

func (*TimelineEventTemplateTokenUpdateRequest) GetObjectPropertyNameOk 

func (o *TimelineEventTemplateTokenUpdateRequest) GetObjectPropertyNameOk() (*string, bool)

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

func (*TimelineEventTemplateTokenUpdateRequest) GetOptions 

func (o *TimelineEventTemplateTokenUpdateRequest) GetOptions() []TimelineEventTemplateTokenOption

GetOptions returns the Options field value

func (*TimelineEventTemplateTokenUpdateRequest) GetOptionsOk 

func (o *TimelineEventTemplateTokenUpdateRequest) GetOptionsOk() ([]TimelineEventTemplateTokenOption, bool)

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

func (*TimelineEventTemplateTokenUpdateRequest) HasObjectPropertyName 

func (o *TimelineEventTemplateTokenUpdateRequest) HasObjectPropertyName() bool

HasObjectPropertyName returns a boolean if a field has been set.

func (TimelineEventTemplateTokenUpdateRequest) MarshalJSON 

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

func (*TimelineEventTemplateTokenUpdateRequest) SetLabel 

func (o *TimelineEventTemplateTokenUpdateRequest) SetLabel(v string)

SetLabel sets field value

func (*TimelineEventTemplateTokenUpdateRequest) SetObjectPropertyName 

func (o *TimelineEventTemplateTokenUpdateRequest) SetObjectPropertyName(v string)

SetObjectPropertyName gets a reference to the given string and assigns it to the ObjectPropertyName field.

func (*TimelineEventTemplateTokenUpdateRequest) SetOptions 

func (o *TimelineEventTemplateTokenUpdateRequest) SetOptions(v []TimelineEventTemplateTokenOption)

SetOptions sets field value

type TimelineEventTemplateUpdateRequest 

type TimelineEventTemplateUpdateRequest struct {
	// The template name.
	Name string `json:"name"`
	// This uses Markdown syntax with Handlebars and event-specific data to render HTML on a timeline as a header.
	HeaderTemplate *string `json:"headerTemplate,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"`
	// 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 template ID.
	Id string `json:"id"`
}

TimelineEventTemplateUpdateRequest State of the template definition being updated.

func NewTimelineEventTemplateUpdateRequest 

func NewTimelineEventTemplateUpdateRequest(name string, tokens []TimelineEventTemplateToken, id string) *TimelineEventTemplateUpdateRequest

NewTimelineEventTemplateUpdateRequest instantiates a new TimelineEventTemplateUpdateRequest 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 NewTimelineEventTemplateUpdateRequestWithDefaults 

func NewTimelineEventTemplateUpdateRequestWithDefaults() *TimelineEventTemplateUpdateRequest

NewTimelineEventTemplateUpdateRequestWithDefaults instantiates a new TimelineEventTemplateUpdateRequest 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 (*TimelineEventTemplateUpdateRequest) GetDetailTemplate 

func (o *TimelineEventTemplateUpdateRequest) GetDetailTemplate() string

GetDetailTemplate returns the DetailTemplate field value if set, zero value otherwise.

func (*TimelineEventTemplateUpdateRequest) GetDetailTemplateOk 

func (o *TimelineEventTemplateUpdateRequest) GetDetailTemplateOk() (*string, bool)

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

func (*TimelineEventTemplateUpdateRequest) GetHeaderTemplate 

func (o *TimelineEventTemplateUpdateRequest) GetHeaderTemplate() string

GetHeaderTemplate returns the HeaderTemplate field value if set, zero value otherwise.

func (*TimelineEventTemplateUpdateRequest) GetHeaderTemplateOk 

func (o *TimelineEventTemplateUpdateRequest) GetHeaderTemplateOk() (*string, bool)

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

func (*TimelineEventTemplateUpdateRequest) GetId 

func (o *TimelineEventTemplateUpdateRequest) GetId() string

GetId returns the Id field value

func (*TimelineEventTemplateUpdateRequest) GetIdOk 

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

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

func (*TimelineEventTemplateUpdateRequest) GetName 

func (o *TimelineEventTemplateUpdateRequest) GetName() string

GetName returns the Name field value

func (*TimelineEventTemplateUpdateRequest) GetNameOk 

func (o *TimelineEventTemplateUpdateRequest) GetNameOk() (*string, bool)

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

func (*TimelineEventTemplateUpdateRequest) GetTokens 

func (o *TimelineEventTemplateUpdateRequest) GetTokens() []TimelineEventTemplateToken

GetTokens returns the Tokens field value

func (*TimelineEventTemplateUpdateRequest) GetTokensOk 

func (o *TimelineEventTemplateUpdateRequest) GetTokensOk() ([]TimelineEventTemplateToken, bool)

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

func (*TimelineEventTemplateUpdateRequest) HasDetailTemplate 

func (o *TimelineEventTemplateUpdateRequest) HasDetailTemplate() bool

HasDetailTemplate returns a boolean if a field has been set.

func (*TimelineEventTemplateUpdateRequest) HasHeaderTemplate 

func (o *TimelineEventTemplateUpdateRequest) HasHeaderTemplate() bool

HasHeaderTemplate returns a boolean if a field has been set.

func (TimelineEventTemplateUpdateRequest) MarshalJSON 

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

func (*TimelineEventTemplateUpdateRequest) SetDetailTemplate 

func (o *TimelineEventTemplateUpdateRequest) SetDetailTemplate(v string)

SetDetailTemplate gets a reference to the given string and assigns it to the DetailTemplate field.

func (*TimelineEventTemplateUpdateRequest) SetHeaderTemplate 

func (o *TimelineEventTemplateUpdateRequest) SetHeaderTemplate(v string)

SetHeaderTemplate gets a reference to the given string and assigns it to the HeaderTemplate field.

func (*TimelineEventTemplateUpdateRequest) SetId 

func (o *TimelineEventTemplateUpdateRequest) SetId(v string)

SetId sets field value

func (*TimelineEventTemplateUpdateRequest) SetName 

func (o *TimelineEventTemplateUpdateRequest) SetName(v string)

SetName sets field value

func (*TimelineEventTemplateUpdateRequest) SetTokens 

func (o *TimelineEventTemplateUpdateRequest) SetTokens(v []TimelineEventTemplateToken)

SetTokens sets field value

type TokensApiService 

type TokensApiService service

TokensApiService TokensApi service

func (*TokensApiService) TemplatesTokensArchive 

func (a *TokensApiService) TemplatesTokensArchive(ctx context.Context, eventTemplateId string, tokenName string, appId int32) ApiTemplatesTokensArchiveRequest

TemplatesTokensArchive Removes a token from the event template

This will remove the token from an existing template. Existing events and CRM objects will still retain the token and its mapped object properties, but new ones will not.

The timeline will still display this property for older CRM objects if it's still referenced in the template `Markdown`. New events will not.

Any lists or reports referencing deleted tokens will no longer return new contacts, but old ones will still exist in the lists. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param tokenName The token name.
@param appId The ID of the target app.
@return ApiTemplatesTokensArchiveRequest

func (*TokensApiService) TemplatesTokensArchiveExecute 

func (a *TokensApiService) TemplatesTokensArchiveExecute(r ApiTemplatesTokensArchiveRequest) (*http.Response, error)

Execute executes the request

func (*TokensApiService) TemplatesTokensCreate 

func (a *TokensApiService) TemplatesTokensCreate(ctx context.Context, eventTemplateId string, appId int32) ApiTemplatesTokensCreateRequest

TemplatesTokensCreate Adds a token to an existing event template

Once you've defined an event template, it's likely that you'll want to define tokens for it as well. You can do this on the event template itself or update individual tokens here.

Event type tokens allow you to attach custom data to events displayed in a timeline or used for list segmentation.

You can also use `objectPropertyName` to associate any CRM object properties. This will allow you to fully build out CRM objects.

Token names should be unique across the template. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param appId The ID of the target app.
@return ApiTemplatesTokensCreateRequest

func (*TokensApiService) TemplatesTokensCreateExecute 

func (a *TokensApiService) TemplatesTokensCreateExecute(r ApiTemplatesTokensCreateRequest) (*TimelineEventTemplateToken, *http.Response, error)

Execute executes the request 

@return TimelineEventTemplateToken

func (*TokensApiService) TemplatesTokensUpdate 

func (a *TokensApiService) TemplatesTokensUpdate(ctx context.Context, eventTemplateId string, tokenName string, appId int32) ApiTemplatesTokensUpdateRequest

TemplatesTokensUpdate Updates an existing token on an event template

This will update the existing token on an event template. Name and type can't be changed on existing tokens. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param eventTemplateId The event template ID.
@param tokenName The token name.
@param appId The ID of the target app.
@return ApiTemplatesTokensUpdateRequest

func (*TokensApiService) TemplatesTokensUpdateExecute 

func (a *TokensApiService) TemplatesTokensUpdateExecute(r ApiTemplatesTokensUpdateRequest) (*TimelineEventTemplateToken, *http.Response, error)

Execute executes the request 

@return TimelineEventTemplateToken

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.