visitoridentification

Documentation

Overview

Package visitoridentification provides primitives to interact with the openapi HTTP API.

Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.

Package visitoridentification provides primitives to interact with the openapi HTTP API.

Code generated by github.com/faetools/devtool version (devel) DO NOT EDIT.

Index

• Constants
• type Client
  • func NewClient(opts ...client.Option) (*Client, error)
  • func (c *Client) GenerateTokenCreate(ctx context.Context, body GenerateTokenCreateJSONRequestBody, ...) (*GenerateTokenCreateResponse, error)
  • func (c *Client) GenerateTokenCreateWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*GenerateTokenCreateResponse, error)
• type ClientInterface
• type Error
• type ErrorDetail
• type ErrorDetail_Context
  • func (a ErrorDetail_Context) Get(fieldName string) (value []string, found bool)
  • func (a ErrorDetail_Context) MarshalJSON() ([]byte, error)
  • func (a *ErrorDetail_Context) Set(fieldName string, value []string)
  • func (a *ErrorDetail_Context) UnmarshalJSON(b []byte) error
• type Error_Context
  • func (a Error_Context) Get(fieldName string) (value []string, found bool)
  • func (a Error_Context) MarshalJSON() ([]byte, error)
  • func (a *Error_Context) Set(fieldName string, value []string)
  • func (a *Error_Context) UnmarshalJSON(b []byte) error
• type Error_Links
  • func (a Error_Links) Get(fieldName string) (value string, found bool)
  • func (a Error_Links) MarshalJSON() ([]byte, error)
  • func (a *Error_Links) Set(fieldName string, value string)
  • func (a *Error_Links) UnmarshalJSON(b []byte) error
• type GenerateTokenCreateJSONBody
• type GenerateTokenCreateJSONRequestBody
• type GenerateTokenCreateResponse
  • func (r GenerateTokenCreateResponse) Status() string
  • func (r GenerateTokenCreateResponse) StatusCode() int
• type IdentificationTokenGenerationRequest
• type IdentificationTokenResponse

Constants

const (
	HapikeyScopes       = "hapikey.Scopes"
	Oauth2_legacyScopes = "oauth2_legacy.Scopes"
)

const DefaultServer = "https://api.hubapi.com/"

DefaultServer is the default server to be used.

Types

type Client

type Client client.Client

Client conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(opts ...client.Option) (*Client, error)

NewClient creates a new Client with reasonable defaults.

func (*Client) GenerateTokenCreate

func (c *Client) GenerateTokenCreate(ctx context.Context, body GenerateTokenCreateJSONRequestBody, reqEditors ...client.RequestEditorFn) (*GenerateTokenCreateResponse, error)

func (*Client) GenerateTokenCreateWithBody

func (c *Client) GenerateTokenCreateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*GenerateTokenCreateResponse, error)

GenerateTokenCreateWithBody request with arbitrary body returning *GenerateTokenCreateResponse

type ClientInterface

type ClientInterface interface {
	// GenerateTokenCreate request with any body
	GenerateTokenCreateWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*GenerateTokenCreateResponse, error)
	GenerateTokenCreate(ctx context.Context, body GenerateTokenCreateJSONRequestBody, reqEditors ...client.RequestEditorFn) (*GenerateTokenCreateResponse, error)
}

ClientInterface interface specification for the client.

type Error

type Error struct {
	// The error category
	Category string `json:"category"`

	// Context about the error condition
	Context *Error_Context `json:"context,omitempty"`

	// A unique identifier for the request. Include this value with any error reports or support tickets
	CorrelationId string `json:"correlationId"`

	// further information about the error
	Errors *[]ErrorDetail `json:"errors,omitempty"`

	// A map of link names to associated URIs containing documentation about the error or recommended remediation steps
	Links *Error_Links `json:"links,omitempty"`

	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`

	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
}

Error defines model for Error.

type ErrorDetail

type ErrorDetail struct {
	// The status code associated with the error detail
	Code *string `json:"code,omitempty"`

	// Context about the error condition
	Context *ErrorDetail_Context `json:"context,omitempty"`

	// The name of the field or parameter in which the error was found.
	In *string `json:"in,omitempty"`

	// A human readable message describing the error along with remediation steps where appropriate
	Message string `json:"message"`

	// A specific category that contains more specific detail about the error
	SubCategory *string `json:"subCategory,omitempty"`
}

ErrorDetail defines model for ErrorDetail.

type ErrorDetail_Context

type ErrorDetail_Context struct {
	AdditionalProperties map[string][]string `json:"-"`
}

Context about the error condition

func (ErrorDetail_Context) Get

func (a ErrorDetail_Context) Get(fieldName string) (value []string, found bool)

Getter for additional properties for ErrorDetail_Context. Returns the specified element and whether it was found

func (ErrorDetail_Context) MarshalJSON

func (a ErrorDetail_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

func (*ErrorDetail_Context) Set

func (a *ErrorDetail_Context) Set(fieldName string, value []string)

Setter for additional properties for ErrorDetail_Context

func (*ErrorDetail_Context) UnmarshalJSON

func (a *ErrorDetail_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for ErrorDetail_Context to handle AdditionalProperties

type Error_Context

type Error_Context struct {
	AdditionalProperties map[string][]string `json:"-"`
}

Context about the error condition

func (Error_Context) Get

func (a Error_Context) Get(fieldName string) (value []string, found bool)

Getter for additional properties for Error_Context. Returns the specified element and whether it was found

func (Error_Context) MarshalJSON

func (a Error_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for Error_Context to handle AdditionalProperties

func (*Error_Context) Set

func (a *Error_Context) Set(fieldName string, value []string)

Setter for additional properties for Error_Context

func (*Error_Context) UnmarshalJSON

func (a *Error_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for Error_Context to handle AdditionalProperties

type Error_Links

type Error_Links struct {
	AdditionalProperties map[string]string `json:"-"`
}

A map of link names to associated URIs containing documentation about the error or recommended remediation steps

func (Error_Links) Get

func (a Error_Links) Get(fieldName string) (value string, found bool)

Getter for additional properties for Error_Links. Returns the specified element and whether it was found

func (Error_Links) MarshalJSON

func (a Error_Links) MarshalJSON() ([]byte, error)

Override default JSON handling for Error_Links to handle AdditionalProperties

func (*Error_Links) Set

func (a *Error_Links) Set(fieldName string, value string)

Setter for additional properties for Error_Links

func (*Error_Links) UnmarshalJSON

func (a *Error_Links) UnmarshalJSON(b []byte) error

Override default JSON handling for Error_Links to handle AdditionalProperties

type GenerateTokenCreateJSONBody

type GenerateTokenCreateJSONBody IdentificationTokenGenerationRequest

GenerateTokenCreateJSONBody defines parameters for GenerateTokenCreate.

type GenerateTokenCreateJSONRequestBody

type GenerateTokenCreateJSONRequestBody GenerateTokenCreateJSONBody

GenerateTokenCreateJSONRequestBody defines body for GenerateTokenCreate for application/json ContentType.

type GenerateTokenCreateResponse

type GenerateTokenCreateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *IdentificationTokenResponse
}

func (GenerateTokenCreateResponse) Status

func (r GenerateTokenCreateResponse) Status() string

Status returns HTTPResponse.Status

func (GenerateTokenCreateResponse) StatusCode

func (r GenerateTokenCreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type IdentificationTokenGenerationRequest

type IdentificationTokenGenerationRequest struct {
	// The email of the visitor that you wish to identify
	Email string `json:"email"`

	// The first name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where first name is unknown. Optional.
	FirstName *string `json:"firstName,omitempty"`

	// The last name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where last name is unknown. Optional.
	LastName *string `json:"lastName,omitempty"`
}

Information used to generate a token

type IdentificationTokenResponse

type IdentificationTokenResponse struct {
	Token string `json:"token"`
}

The identification token to be passed to the Conversations JS API to identify the visitor