events

package
v0.1.3 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2023 License: MIT Imports: 23 Imported by: 0

README

Go API client for events

API for accessing CRM object events.

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 events "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(), events.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(), events.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(), events.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), events.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 GetPage Get /events/v3/events Returns a collection of events matching a query.

Documentation For Models

Documentation For Authorization

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

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
	// contains filtered or unexported fields
}

APIClient manages communication with the HubSpot Events API 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 ApiGetPageRequest 

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

func (ApiGetPageRequest) After 

func (r ApiGetPageRequest) After(after string) ApiGetPageRequest

An additional parameter that may be used to get the next `limit` set of results.

func (ApiGetPageRequest) Before 

func (r ApiGetPageRequest) Before(before string) ApiGetPageRequest

func (ApiGetPageRequest) EventType 

func (r ApiGetPageRequest) EventType(eventType string) ApiGetPageRequest

Limits the response to the specified event type. For example `&eventType=e_visited_page` returns only `e_visited_page` events. If not present all event types are returned.

func (ApiGetPageRequest) Execute 

func (r ApiGetPageRequest) Execute() (*CollectionResponseExternalUnifiedEvent, *http.Response, error)

func (ApiGetPageRequest) Limit 

func (r ApiGetPageRequest) Limit(limit int32) ApiGetPageRequest

The maximum number of events to return, defaults to 20.

func (ApiGetPageRequest) ObjectId 

func (r ApiGetPageRequest) ObjectId(objectId int64) ApiGetPageRequest

The id of the selected object. If not present, then the `objectProperty` parameter is required.

func (ApiGetPageRequest) ObjectType 

func (r ApiGetPageRequest) ObjectType(objectType string) ApiGetPageRequest

The type of object being selected. Valid values are hubspot named object types (e.g. `contact`).

func (ApiGetPageRequest) OccurredAfter 

func (r ApiGetPageRequest) OccurredAfter(occurredAfter time.Time) ApiGetPageRequest

The starting time as an ISO 8601 timestamp.

func (ApiGetPageRequest) OccurredBefore 

func (r ApiGetPageRequest) OccurredBefore(occurredBefore time.Time) ApiGetPageRequest

The ending time as an ISO 8601 timestamp.

func (ApiGetPageRequest) Sort 

func (r ApiGetPageRequest) Sort(sort []string) ApiGetPageRequest

Selects the sort field and order. Defaults to ascending, prefix with `-` for descending order. `occurredAt` is the only field supported for sorting.

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 CollectionResponseExternalUnifiedEvent 

type CollectionResponseExternalUnifiedEvent struct {
	Results []ExternalUnifiedEvent `json:"results"`
	Paging  *Paging                `json:"paging,omitempty"`
}

CollectionResponseExternalUnifiedEvent struct for CollectionResponseExternalUnifiedEvent

func NewCollectionResponseExternalUnifiedEvent 

func NewCollectionResponseExternalUnifiedEvent(results []ExternalUnifiedEvent) *CollectionResponseExternalUnifiedEvent

NewCollectionResponseExternalUnifiedEvent instantiates a new CollectionResponseExternalUnifiedEvent 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 NewCollectionResponseExternalUnifiedEventWithDefaults 

func NewCollectionResponseExternalUnifiedEventWithDefaults() *CollectionResponseExternalUnifiedEvent

NewCollectionResponseExternalUnifiedEventWithDefaults instantiates a new CollectionResponseExternalUnifiedEvent 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 (*CollectionResponseExternalUnifiedEvent) GetPaging 

func (o *CollectionResponseExternalUnifiedEvent) GetPaging() Paging

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

func (*CollectionResponseExternalUnifiedEvent) GetPagingOk 

func (o *CollectionResponseExternalUnifiedEvent) GetPagingOk() (*Paging, bool)

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

func (*CollectionResponseExternalUnifiedEvent) GetResults 

func (o *CollectionResponseExternalUnifiedEvent) GetResults() []ExternalUnifiedEvent

GetResults returns the Results field value

func (*CollectionResponseExternalUnifiedEvent) GetResultsOk 

func (o *CollectionResponseExternalUnifiedEvent) GetResultsOk() ([]ExternalUnifiedEvent, bool)

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

func (*CollectionResponseExternalUnifiedEvent) HasPaging 

func (o *CollectionResponseExternalUnifiedEvent) HasPaging() bool

HasPaging returns a boolean if a field has been set.

func (CollectionResponseExternalUnifiedEvent) MarshalJSON 

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

func (*CollectionResponseExternalUnifiedEvent) SetPaging 

func (o *CollectionResponseExternalUnifiedEvent) SetPaging(v Paging)

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

func (*CollectionResponseExternalUnifiedEvent) SetResults 

func (o *CollectionResponseExternalUnifiedEvent) SetResults(v []ExternalUnifiedEvent)

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 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 EventsApiService 

type EventsApiService service

EventsApiService EventsApi service

func (*EventsApiService) GetPage 

func (a *EventsApiService) GetPage(ctx context.Context) ApiGetPageRequest

GetPage Returns a collection of events matching a query. 

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

func (*EventsApiService) GetPageExecute 

func (a *EventsApiService) GetPageExecute(r ApiGetPageRequest) (*CollectionResponseExternalUnifiedEvent, *http.Response, error)

Execute executes the request 

@return CollectionResponseExternalUnifiedEvent

type ExternalUnifiedEvent 

type ExternalUnifiedEvent struct {
	// The objectType for the object which did the event.
	ObjectType string `json:"objectType"`
	// The objectId of the object which did the event.
	ObjectId string `json:"objectId"`
	// The format of the `eventType` string is `ae{appId}_{eventTypeLabel}`, `pe{portalId}_{eventTypeLabel}`, or just `e_{eventTypeLabel}` for HubSpot events.
	EventType string `json:"eventType"`
	// An ISO 8601 timestamp when the event occurred.
	OccurredAt time.Time `json:"occurredAt"`
	// A unique identifier for the event.
	Id         string            `json:"id"`
	Properties map[string]string `json:"properties"`
}

ExternalUnifiedEvent Used to represent any event. With this format, the `objectType` and `eventType` values are stringified CRM types. Example object: <br/> ``` { \"objectType\": \"CONTACT\", \"objectId\": 208451632, \"eventType\": \"e_visited_page\", \"occurredAt\": 1567377501421, \"id\": \"leviathan-be3335d3-46f1-3985-988e-ff38e6e7b9d8\", \"properties\": { \"hs_url\": \"https://some-website.com/\", \"hs_title\": \"Home\", \"hs_referrer\": \"https://some-other-website.com/blog/why-we-love-big-data-and-you-should-too\", \"hs_userAgent\": \"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.80 Safari/537.36\", \"hs_city\": \"lund\", \"hs_region\": \"m\", \"hs_country\": \"se\", \"hs_session_id\" : \"leviathan-be3335d3-46f1-3985-988e-ff38e6e7b9d8\", \"hs_session_source\" : \"DIRECT\" } } ```

func NewExternalUnifiedEvent 

func NewExternalUnifiedEvent(objectType string, objectId string, eventType string, occurredAt time.Time, id string, properties map[string]string) *ExternalUnifiedEvent

NewExternalUnifiedEvent instantiates a new ExternalUnifiedEvent 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 NewExternalUnifiedEventWithDefaults 

func NewExternalUnifiedEventWithDefaults() *ExternalUnifiedEvent

NewExternalUnifiedEventWithDefaults instantiates a new ExternalUnifiedEvent 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 (*ExternalUnifiedEvent) GetEventType 

func (o *ExternalUnifiedEvent) GetEventType() string

GetEventType returns the EventType field value

func (*ExternalUnifiedEvent) GetEventTypeOk 

func (o *ExternalUnifiedEvent) GetEventTypeOk() (*string, bool)

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

func (*ExternalUnifiedEvent) GetId 

func (o *ExternalUnifiedEvent) GetId() string

GetId returns the Id field value

func (*ExternalUnifiedEvent) GetIdOk 

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

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

func (*ExternalUnifiedEvent) GetObjectId 

func (o *ExternalUnifiedEvent) GetObjectId() string

GetObjectId returns the ObjectId field value

func (*ExternalUnifiedEvent) GetObjectIdOk 

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

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

func (*ExternalUnifiedEvent) GetObjectType 

func (o *ExternalUnifiedEvent) GetObjectType() string

GetObjectType returns the ObjectType field value

func (*ExternalUnifiedEvent) GetObjectTypeOk 

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

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

func (*ExternalUnifiedEvent) GetOccurredAt 

func (o *ExternalUnifiedEvent) GetOccurredAt() time.Time

GetOccurredAt returns the OccurredAt field value

func (*ExternalUnifiedEvent) GetOccurredAtOk 

func (o *ExternalUnifiedEvent) GetOccurredAtOk() (*time.Time, bool)

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

func (*ExternalUnifiedEvent) GetProperties 

func (o *ExternalUnifiedEvent) GetProperties() map[string]string

GetProperties returns the Properties field value

func (*ExternalUnifiedEvent) GetPropertiesOk 

func (o *ExternalUnifiedEvent) GetPropertiesOk() (*map[string]string, bool)

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

func (ExternalUnifiedEvent) MarshalJSON 

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

func (*ExternalUnifiedEvent) SetEventType 

func (o *ExternalUnifiedEvent) SetEventType(v string)

SetEventType sets field value

func (*ExternalUnifiedEvent) SetId 

func (o *ExternalUnifiedEvent) SetId(v string)

SetId sets field value

func (*ExternalUnifiedEvent) SetObjectId 

func (o *ExternalUnifiedEvent) SetObjectId(v string)

SetObjectId sets field value

func (*ExternalUnifiedEvent) SetObjectType 

func (o *ExternalUnifiedEvent) SetObjectType(v string)

SetObjectType sets field value

func (*ExternalUnifiedEvent) SetOccurredAt 

func (o *ExternalUnifiedEvent) SetOccurredAt(v time.Time)

SetOccurredAt sets field value

func (*ExternalUnifiedEvent) SetProperties 

func (o *ExternalUnifiedEvent) SetProperties(v map[string]string)

SetProperties sets field value

type GenericOpenAPIError 

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

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

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

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

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type NextPage 

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

NextPage struct for NextPage

func NewNextPage 

func NewNextPage(after string) *NextPage

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

func NewNextPageWithDefaults 

func NewNextPageWithDefaults() *NextPage

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

func (*NextPage) GetAfter 

func (o *NextPage) GetAfter() string

GetAfter returns the After field value

func (*NextPage) GetAfterOk 

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

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

func (o *NextPage) GetLink() string

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

func (*NextPage) GetLinkOk 

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

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

func (o *NextPage) HasLink() bool

HasLink returns a boolean if a field has been set.

func (NextPage) MarshalJSON 

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

func (*NextPage) SetAfter 

func (o *NextPage) SetAfter(v string)

SetAfter sets field value 

func (o *NextPage) SetLink(v string)

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

type NullableBool 

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

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

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

func (*NullableBool) Set 

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

func (*NullableBool) UnmarshalJSON 

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

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableCollectionResponseExternalUnifiedEvent 

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

func NewNullableCollectionResponseExternalUnifiedEvent 

func NewNullableCollectionResponseExternalUnifiedEvent(val *CollectionResponseExternalUnifiedEvent) *NullableCollectionResponseExternalUnifiedEvent

func (NullableCollectionResponseExternalUnifiedEvent) Get 

func (v NullableCollectionResponseExternalUnifiedEvent) Get() *CollectionResponseExternalUnifiedEvent

func (NullableCollectionResponseExternalUnifiedEvent) IsSet 

func (v NullableCollectionResponseExternalUnifiedEvent) IsSet() bool

func (NullableCollectionResponseExternalUnifiedEvent) MarshalJSON 

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

func (*NullableCollectionResponseExternalUnifiedEvent) Set 

func (v *NullableCollectionResponseExternalUnifiedEvent) Set(val *CollectionResponseExternalUnifiedEvent)

func (*NullableCollectionResponseExternalUnifiedEvent) UnmarshalJSON 

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

func (*NullableCollectionResponseExternalUnifiedEvent) Unset 

func (v *NullableCollectionResponseExternalUnifiedEvent) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

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

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

func (v *NullableError) Unset()

type NullableErrorDetail 

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

func NewNullableErrorDetail 

func NewNullableErrorDetail(val *ErrorDetail) *NullableErrorDetail

func (NullableErrorDetail) Get 

func (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 NullableExternalUnifiedEvent 

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

func NewNullableExternalUnifiedEvent 

func NewNullableExternalUnifiedEvent(val *ExternalUnifiedEvent) *NullableExternalUnifiedEvent

func (NullableExternalUnifiedEvent) Get 

func (v NullableExternalUnifiedEvent) Get() *ExternalUnifiedEvent

func (NullableExternalUnifiedEvent) IsSet 

func (v NullableExternalUnifiedEvent) IsSet() bool

func (NullableExternalUnifiedEvent) MarshalJSON 

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

func (*NullableExternalUnifiedEvent) Set 

func (v *NullableExternalUnifiedEvent) Set(val *ExternalUnifiedEvent)

func (*NullableExternalUnifiedEvent) UnmarshalJSON 

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

func (*NullableExternalUnifiedEvent) Unset 

func (v *NullableExternalUnifiedEvent) 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 NullableNextPage 

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

func NewNullableNextPage 

func NewNullableNextPage(val *NextPage) *NullableNextPage

func (NullableNextPage) Get 

func (v NullableNextPage) Get() *NextPage

func (NullableNextPage) IsSet 

func (v NullableNextPage) IsSet() bool

func (NullableNextPage) MarshalJSON 

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

func (*NullableNextPage) Set 

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

func (*NullableNextPage) UnmarshalJSON 

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

func (*NullableNextPage) Unset 

func (v *NullableNextPage) Unset()

type NullablePaging 

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

func NewNullablePaging 

func NewNullablePaging(val *Paging) *NullablePaging

func (NullablePaging) Get 

func (v NullablePaging) Get() *Paging

func (NullablePaging) IsSet 

func (v NullablePaging) IsSet() bool

func (NullablePaging) MarshalJSON 

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

func (*NullablePaging) Set 

func (v *NullablePaging) Set(val *Paging)

func (*NullablePaging) UnmarshalJSON 

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

func (*NullablePaging) Unset 

func (v *NullablePaging) 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 Paging 

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

Paging struct for Paging

func NewPaging 

func NewPaging() *Paging

NewPaging instantiates a new Paging 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 NewPagingWithDefaults 

func NewPagingWithDefaults() *Paging

NewPagingWithDefaults instantiates a new Paging 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 (*Paging) GetNext 

func (o *Paging) GetNext() NextPage

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

func (*Paging) GetNextOk 

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

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

func (*Paging) HasNext 

func (o *Paging) HasNext() bool

HasNext returns a boolean if a field has been set.

func (Paging) MarshalJSON 

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

func (*Paging) SetNext 

func (o *Paging) SetNext(v NextPage)

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

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

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.