properties

package
v0.0.0-...-2284865 Latest Latest
Warning

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

Go to latest
Published: Oct 26, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

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

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

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

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

Index

Constants

View Source
const (
	HapikeyScopes       = "hapikey.Scopes"
	Oauth2Scopes        = "oauth2.Scopes"
	Oauth2_legacyScopes = "oauth2_legacy.Scopes"
)
View Source
const DefaultServer = "https://api.hubapi.com/"

DefaultServer is the default server to be used.

Variables

This section is empty.

Functions

This section is empty.

Types

type ArchiveBatchJSONBody

type ArchiveBatchJSONBody BatchInputPropertyName

ArchiveBatchJSONBody defines parameters for ArchiveBatch.

type ArchiveBatchJSONRequestBody

type ArchiveBatchJSONRequestBody ArchiveBatchJSONBody

ArchiveBatchJSONRequestBody defines body for ArchiveBatch for application/json ContentType.

type ArchiveBatchResponse

type ArchiveBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchiveBatchResponse) Status

func (r ArchiveBatchResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveBatchResponse) StatusCode

func (r ArchiveBatchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchiveGroupNameResponse

type ArchiveGroupNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchiveGroupNameResponse) Status

func (r ArchiveGroupNameResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveGroupNameResponse) StatusCode

func (r ArchiveGroupNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ArchivePropertyNameResponse

type ArchivePropertyNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func (ArchivePropertyNameResponse) Status

Status returns HTTPResponse.Status

func (ArchivePropertyNameResponse) StatusCode

func (r ArchivePropertyNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchInputPropertyCreate

type BatchInputPropertyCreate struct {
	Inputs []PropertyCreate `json:"inputs"`
}

BatchInputPropertyCreate defines model for BatchInputPropertyCreate.

type BatchInputPropertyName

type BatchInputPropertyName struct {
	Inputs []PropertyName `json:"inputs"`
}

BatchInputPropertyName defines model for BatchInputPropertyName.

type BatchReadInputPropertyName

type BatchReadInputPropertyName struct {
	Archived bool           `json:"archived"`
	Inputs   []PropertyName `json:"inputs"`
}

BatchReadInputPropertyName defines model for BatchReadInputPropertyName.

type BatchResponseProperty

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

BatchResponseProperty defines model for BatchResponseProperty.

type BatchResponsePropertyStatus

type BatchResponsePropertyStatus string

BatchResponsePropertyStatus defines model for BatchResponseProperty.Status.

const (
	BatchResponsePropertyStatusCANCELED BatchResponsePropertyStatus = "CANCELED"

	BatchResponsePropertyStatusCOMPLETE BatchResponsePropertyStatus = "COMPLETE"

	BatchResponsePropertyStatusPENDING BatchResponsePropertyStatus = "PENDING"

	BatchResponsePropertyStatusPROCESSING BatchResponsePropertyStatus = "PROCESSING"
)

Defines values for BatchResponsePropertyStatus.

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

BatchResponseProperty_Links defines model for BatchResponseProperty.Links.

func (BatchResponseProperty_Links) Get

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

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

func (BatchResponseProperty_Links) MarshalJSON

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

Override default JSON handling for BatchResponseProperty_Links to handle AdditionalProperties

func (*BatchResponseProperty_Links) Set

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

Setter for additional properties for BatchResponseProperty_Links

func (*BatchResponseProperty_Links) UnmarshalJSON

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

Override default JSON handling for BatchResponseProperty_Links to handle AdditionalProperties

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) ArchiveBatch

func (c *Client) ArchiveBatch(ctx context.Context, objectType string, body ArchiveBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ArchiveBatchResponse, error)

func (*Client) ArchiveBatchWithBody

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

ArchiveBatchWithBody request with arbitrary body returning *ArchiveBatchResponse

func (*Client) ArchiveGroupName

func (c *Client) ArchiveGroupName(ctx context.Context, objectType string, groupName string, reqEditors ...client.RequestEditorFn) (*ArchiveGroupNameResponse, error)

ArchiveGroupName request returning *ArchiveGroupNameResponse

func (*Client) ArchivePropertyName

func (c *Client) ArchivePropertyName(ctx context.Context, objectType string, propertyName string, reqEditors ...client.RequestEditorFn) (*ArchivePropertyNameResponse, error)

ArchivePropertyName request returning *ArchivePropertyNameResponse

func (*Client) CreateBatch

func (c *Client) CreateBatch(ctx context.Context, objectType string, body CreateBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error)

func (*Client) CreateBatchWithBody

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

CreateBatchWithBody request with arbitrary body returning *CreateBatchResponse

func (*Client) CreateGroups

func (c *Client) CreateGroups(ctx context.Context, objectType string, body CreateGroupsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateGroupsResponse, error)

func (*Client) CreateGroupsWithBody

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

CreateGroupsWithBody request with arbitrary body returning *CreateGroupsResponse

func (*Client) CreateObjectType

func (c *Client) CreateObjectType(ctx context.Context, objectType string, body CreateObjectTypeJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)

func (*Client) CreateObjectTypeWithBody

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

CreateObjectTypeWithBody request with arbitrary body returning *CreateObjectTypeResponse

func (*Client) GetAllGroups

func (c *Client) GetAllGroups(ctx context.Context, objectType string, reqEditors ...client.RequestEditorFn) (*GetAllGroupsResponse, error)

GetAllGroups request returning *GetAllGroupsResponse

func (*Client) GetAllObjectType

func (c *Client) GetAllObjectType(ctx context.Context, objectType string, params *GetAllObjectTypeParams, reqEditors ...client.RequestEditorFn) (*GetAllObjectTypeResponse, error)

GetAllObjectType request returning *GetAllObjectTypeResponse

func (*Client) GetByNameGroupName

func (c *Client) GetByNameGroupName(ctx context.Context, objectType string, groupName string, reqEditors ...client.RequestEditorFn) (*GetByNameGroupNameResponse, error)

GetByNameGroupName request returning *GetByNameGroupNameResponse

func (*Client) GetByNamePropertyName

func (c *Client) GetByNamePropertyName(ctx context.Context, objectType string, propertyName string, params *GetByNamePropertyNameParams, reqEditors ...client.RequestEditorFn) (*GetByNamePropertyNameResponse, error)

GetByNamePropertyName request returning *GetByNamePropertyNameResponse

func (*Client) ReadBatch

func (c *Client) ReadBatch(ctx context.Context, objectType string, body ReadBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)

func (*Client) ReadBatchWithBody

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

ReadBatchWithBody request with arbitrary body returning *ReadBatchResponse

func (*Client) UpdateGroupName

func (c *Client) UpdateGroupName(ctx context.Context, objectType string, groupName string, body UpdateGroupNameJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateGroupNameResponse, error)

func (*Client) UpdateGroupNameWithBody

func (c *Client) UpdateGroupNameWithBody(ctx context.Context, objectType string, groupName string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateGroupNameResponse, error)

UpdateGroupNameWithBody request with arbitrary body returning *UpdateGroupNameResponse

func (*Client) UpdatePropertyName

func (c *Client) UpdatePropertyName(ctx context.Context, objectType string, propertyName string, body UpdatePropertyNameJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdatePropertyNameResponse, error)

func (*Client) UpdatePropertyNameWithBody

func (c *Client) UpdatePropertyNameWithBody(ctx context.Context, objectType string, propertyName string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdatePropertyNameResponse, error)

UpdatePropertyNameWithBody request with arbitrary body returning *UpdatePropertyNameResponse

type ClientInterface

type ClientInterface interface {
	// GetAllObjectType request
	GetAllObjectType(ctx context.Context, objectType string, params *GetAllObjectTypeParams, reqEditors ...client.RequestEditorFn) (*GetAllObjectTypeResponse, error)

	// CreateObjectType request with any body
	CreateObjectTypeWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)
	CreateObjectType(ctx context.Context, objectType string, body CreateObjectTypeJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateObjectTypeResponse, error)

	// ArchiveBatch request with any body
	ArchiveBatchWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ArchiveBatchResponse, error)
	ArchiveBatch(ctx context.Context, objectType string, body ArchiveBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ArchiveBatchResponse, error)

	// CreateBatch request with any body
	CreateBatchWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error)
	CreateBatch(ctx context.Context, objectType string, body CreateBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateBatchResponse, error)

	// ReadBatch request with any body
	ReadBatchWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)
	ReadBatch(ctx context.Context, objectType string, body ReadBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ReadBatchResponse, error)

	// GetAllGroups request
	GetAllGroups(ctx context.Context, objectType string, reqEditors ...client.RequestEditorFn) (*GetAllGroupsResponse, error)

	// CreateGroups request with any body
	CreateGroupsWithBody(ctx context.Context, objectType string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateGroupsResponse, error)
	CreateGroups(ctx context.Context, objectType string, body CreateGroupsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateGroupsResponse, error)

	// ArchiveGroupName request
	ArchiveGroupName(ctx context.Context, objectType string, groupName string, reqEditors ...client.RequestEditorFn) (*ArchiveGroupNameResponse, error)

	// GetByNameGroupName request
	GetByNameGroupName(ctx context.Context, objectType string, groupName string, reqEditors ...client.RequestEditorFn) (*GetByNameGroupNameResponse, error)

	// UpdateGroupName request with any body
	UpdateGroupNameWithBody(ctx context.Context, objectType string, groupName string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateGroupNameResponse, error)
	UpdateGroupName(ctx context.Context, objectType string, groupName string, body UpdateGroupNameJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateGroupNameResponse, error)

	// ArchivePropertyName request
	ArchivePropertyName(ctx context.Context, objectType string, propertyName string, reqEditors ...client.RequestEditorFn) (*ArchivePropertyNameResponse, error)

	// GetByNamePropertyName request
	GetByNamePropertyName(ctx context.Context, objectType string, propertyName string, params *GetByNamePropertyNameParams, reqEditors ...client.RequestEditorFn) (*GetByNamePropertyNameResponse, error)

	// UpdatePropertyName request with any body
	UpdatePropertyNameWithBody(ctx context.Context, objectType string, propertyName string, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdatePropertyNameResponse, error)
	UpdatePropertyName(ctx context.Context, objectType string, propertyName string, body UpdatePropertyNameJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdatePropertyNameResponse, error)
}

ClientInterface interface specification for the client.

type CollectionResponseProperty

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

CollectionResponseProperty defines model for CollectionResponseProperty.

type CollectionResponsePropertyGroup

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

CollectionResponsePropertyGroup defines model for CollectionResponsePropertyGroup.

type CreateBatchJSONBody

type CreateBatchJSONBody BatchInputPropertyCreate

CreateBatchJSONBody defines parameters for CreateBatch.

type CreateBatchJSONRequestBody

type CreateBatchJSONRequestBody CreateBatchJSONBody

CreateBatchJSONRequestBody defines body for CreateBatch for application/json ContentType.

type CreateBatchResponse

type CreateBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *BatchResponseProperty
	JSON207      *BatchResponseProperty
}

func (CreateBatchResponse) Status

func (r CreateBatchResponse) Status() string

Status returns HTTPResponse.Status

func (CreateBatchResponse) StatusCode

func (r CreateBatchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateGroupsJSONBody

type CreateGroupsJSONBody PropertyGroupCreate

CreateGroupsJSONBody defines parameters for CreateGroups.

type CreateGroupsJSONRequestBody

type CreateGroupsJSONRequestBody CreateGroupsJSONBody

CreateGroupsJSONRequestBody defines body for CreateGroups for application/json ContentType.

type CreateGroupsResponse

type CreateGroupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *PropertyGroup
}

func (CreateGroupsResponse) Status

func (r CreateGroupsResponse) Status() string

Status returns HTTPResponse.Status

func (CreateGroupsResponse) StatusCode

func (r CreateGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateObjectTypeJSONBody

type CreateObjectTypeJSONBody PropertyCreate

CreateObjectTypeJSONBody defines parameters for CreateObjectType.

type CreateObjectTypeJSONRequestBody

type CreateObjectTypeJSONRequestBody CreateObjectTypeJSONBody

CreateObjectTypeJSONRequestBody defines body for CreateObjectType for application/json ContentType.

type CreateObjectTypeResponse

type CreateObjectTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Property
}

func (CreateObjectTypeResponse) Status

func (r CreateObjectTypeResponse) Status() string

Status returns HTTPResponse.Status

func (CreateObjectTypeResponse) StatusCode

func (r CreateObjectTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

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

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

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

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

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

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

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

Error defines model for Error.

type ErrorCategory

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

ErrorCategory defines model for ErrorCategory.

type ErrorCategoryHttpStatus

type ErrorCategoryHttpStatus string

ErrorCategoryHttpStatus defines model for ErrorCategory.HttpStatus.

const (
	ErrorCategoryHttpStatusACCEPTED ErrorCategoryHttpStatus = "ACCEPTED"

	ErrorCategoryHttpStatusALREADYREPORTED ErrorCategoryHttpStatus = "ALREADY_REPORTED"

	ErrorCategoryHttpStatusBADGATEWAY ErrorCategoryHttpStatus = "BAD_GATEWAY"

	ErrorCategoryHttpStatusBADREQUEST ErrorCategoryHttpStatus = "BAD_REQUEST"

	ErrorCategoryHttpStatusCONFLICT ErrorCategoryHttpStatus = "CONFLICT"

	ErrorCategoryHttpStatusCONTINUE ErrorCategoryHttpStatus = "CONTINUE"

	ErrorCategoryHttpStatusCREATED ErrorCategoryHttpStatus = "CREATED"

	ErrorCategoryHttpStatusEXPECTATIONFAILED ErrorCategoryHttpStatus = "EXPECTATION_FAILED"

	ErrorCategoryHttpStatusFAILEDDEPENDENCY ErrorCategoryHttpStatus = "FAILED_DEPENDENCY"

	ErrorCategoryHttpStatusFORBIDDEN ErrorCategoryHttpStatus = "FORBIDDEN"

	ErrorCategoryHttpStatusFOUND ErrorCategoryHttpStatus = "FOUND"

	ErrorCategoryHttpStatusGATEWAYTIMEOUT ErrorCategoryHttpStatus = "GATEWAY_TIMEOUT"

	ErrorCategoryHttpStatusGONE ErrorCategoryHttpStatus = "GONE"

	ErrorCategoryHttpStatusHTTPVERSIONNOTSUPPORTED ErrorCategoryHttpStatus = "HTTP_VERSION_NOT_SUPPORTED"

	ErrorCategoryHttpStatusIMATEAPOT ErrorCategoryHttpStatus = "IM_A_TEAPOT"

	ErrorCategoryHttpStatusIMUSED ErrorCategoryHttpStatus = "IM_USED"

	ErrorCategoryHttpStatusINSUFFICIENTSTORAGE ErrorCategoryHttpStatus = "INSUFFICIENT_STORAGE"

	ErrorCategoryHttpStatusINTERNALSERVERERROR ErrorCategoryHttpStatus = "INTERNAL_SERVER_ERROR"

	ErrorCategoryHttpStatusINTERNALSTALESERVICEDISCOVERY ErrorCategoryHttpStatus = "INTERNAL_STALE_SERVICE_DISCOVERY"

	ErrorCategoryHttpStatusLENGTHREQUIRED ErrorCategoryHttpStatus = "LENGTH_REQUIRED"

	ErrorCategoryHttpStatusLOCKED ErrorCategoryHttpStatus = "LOCKED"

	ErrorCategoryHttpStatusLOOPDETECTED ErrorCategoryHttpStatus = "LOOP_DETECTED"

	ErrorCategoryHttpStatusMETHODNOTALLOWED ErrorCategoryHttpStatus = "METHOD_NOT_ALLOWED"

	ErrorCategoryHttpStatusMISDIRECTEDREQUEST ErrorCategoryHttpStatus = "MISDIRECTED_REQUEST"

	ErrorCategoryHttpStatusMOVEDPERMANENTLY ErrorCategoryHttpStatus = "MOVED_PERMANENTLY"

	ErrorCategoryHttpStatusMULTIPLECHOICES ErrorCategoryHttpStatus = "MULTIPLE_CHOICES"

	ErrorCategoryHttpStatusMULTISTATUS ErrorCategoryHttpStatus = "MULTI_STATUS"

	ErrorCategoryHttpStatusNETWORKAUTHENTICATIONREQUIRED ErrorCategoryHttpStatus = "NETWORK_AUTHENTICATION_REQUIRED"

	ErrorCategoryHttpStatusNOCONTENT ErrorCategoryHttpStatus = "NO_CONTENT"

	ErrorCategoryHttpStatusNONAUTHORITATIVEINFORMATION ErrorCategoryHttpStatus = "NON_AUTHORITATIVE_INFORMATION"

	ErrorCategoryHttpStatusNOTACCEPTABLE ErrorCategoryHttpStatus = "NOT_ACCEPTABLE"

	ErrorCategoryHttpStatusNOTEXTENDED ErrorCategoryHttpStatus = "NOT_EXTENDED"

	ErrorCategoryHttpStatusNOTFOUND ErrorCategoryHttpStatus = "NOT_FOUND"

	ErrorCategoryHttpStatusNOTIMPLEMENTED ErrorCategoryHttpStatus = "NOT_IMPLEMENTED"

	ErrorCategoryHttpStatusNOTMODIFIED ErrorCategoryHttpStatus = "NOT_MODIFIED"

	ErrorCategoryHttpStatusOK ErrorCategoryHttpStatus = "OK"

	ErrorCategoryHttpStatusPARTIALCONTENT ErrorCategoryHttpStatus = "PARTIAL_CONTENT"

	ErrorCategoryHttpStatusPAYMENTREQUIRED ErrorCategoryHttpStatus = "PAYMENT_REQUIRED"

	ErrorCategoryHttpStatusPERMANENTREDIRECT ErrorCategoryHttpStatus = "PERMANENT_REDIRECT"

	ErrorCategoryHttpStatusPRECONDITIONFAILED ErrorCategoryHttpStatus = "PRECONDITION_FAILED"

	ErrorCategoryHttpStatusPRECONDITIONREQUIRED ErrorCategoryHttpStatus = "PRECONDITION_REQUIRED"

	ErrorCategoryHttpStatusPROCESSING ErrorCategoryHttpStatus = "PROCESSING"

	ErrorCategoryHttpStatusPROXYAUTHENTICATIONREQUIRED ErrorCategoryHttpStatus = "PROXY_AUTHENTICATION_REQUIRED"

	ErrorCategoryHttpStatusREQUESTEDRANGENOTSATISFIABLE ErrorCategoryHttpStatus = "REQUESTED_RANGE_NOT_SATISFIABLE"

	ErrorCategoryHttpStatusREQUESTENTITYTOOLARGE ErrorCategoryHttpStatus = "REQUEST_ENTITY_TOO_LARGE"

	ErrorCategoryHttpStatusREQUESTHEADERSFIELDSTOOLARGE ErrorCategoryHttpStatus = "REQUEST_HEADERS_FIELDS_TOO_LARGE"

	ErrorCategoryHttpStatusREQUESTTIMEOUT ErrorCategoryHttpStatus = "REQUEST_TIMEOUT"

	ErrorCategoryHttpStatusREQUESTURITOOLONG ErrorCategoryHttpStatus = "REQUEST_URI_TOO_LONG"

	ErrorCategoryHttpStatusRESETCONTENT ErrorCategoryHttpStatus = "RESET_CONTENT"

	ErrorCategoryHttpStatusSEEOTHER ErrorCategoryHttpStatus = "SEE_OTHER"

	ErrorCategoryHttpStatusSERVICEUNAVAILABLE ErrorCategoryHttpStatus = "SERVICE_UNAVAILABLE"

	ErrorCategoryHttpStatusSWITCHINGPROTOCOLS ErrorCategoryHttpStatus = "SWITCHING_PROTOCOLS"

	ErrorCategoryHttpStatusTEMPORARYREDIRECT ErrorCategoryHttpStatus = "TEMPORARY_REDIRECT"

	ErrorCategoryHttpStatusTOOMANYREQUESTS ErrorCategoryHttpStatus = "TOO_MANY_REQUESTS"

	ErrorCategoryHttpStatusUNAUTHORIZED ErrorCategoryHttpStatus = "UNAUTHORIZED"

	ErrorCategoryHttpStatusUNAVAILABLEFORLEGALREASONS ErrorCategoryHttpStatus = "UNAVAILABLE_FOR_LEGAL_REASONS"

	ErrorCategoryHttpStatusUNPROCESSABLEENTITY ErrorCategoryHttpStatus = "UNPROCESSABLE_ENTITY"

	ErrorCategoryHttpStatusUNSUPPORTEDMEDIATYPE ErrorCategoryHttpStatus = "UNSUPPORTED_MEDIA_TYPE"

	ErrorCategoryHttpStatusUPGRADEREQUIRED ErrorCategoryHttpStatus = "UPGRADE_REQUIRED"

	ErrorCategoryHttpStatusUSEPROXY ErrorCategoryHttpStatus = "USE_PROXY"

	ErrorCategoryHttpStatusVARIANTALSONEGOTIATES ErrorCategoryHttpStatus = "VARIANT_ALSO_NEGOTIATES"
)

Defines values for ErrorCategoryHttpStatus.

type ErrorDetail

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

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

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

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

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

ErrorDetail defines model for ErrorDetail.

type ErrorDetail_Context

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

type GetAllGroupsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponsePropertyGroup
}

func (GetAllGroupsResponse) Status

func (r GetAllGroupsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllGroupsResponse) StatusCode

func (r GetAllGroupsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllObjectTypeParams

type GetAllObjectTypeParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

GetAllObjectTypeParams defines parameters for GetAllObjectType.

type GetAllObjectTypeResponse

type GetAllObjectTypeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CollectionResponseProperty
}

func (GetAllObjectTypeResponse) Status

func (r GetAllObjectTypeResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllObjectTypeResponse) StatusCode

func (r GetAllObjectTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetByNameGroupNameResponse

type GetByNameGroupNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertyGroup
}

func (GetByNameGroupNameResponse) Status

Status returns HTTPResponse.Status

func (GetByNameGroupNameResponse) StatusCode

func (r GetByNameGroupNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetByNamePropertyNameParams

type GetByNamePropertyNameParams struct {
	// Whether to return only results that have been archived.
	Archived *bool `json:"archived,omitempty"`
}

GetByNamePropertyNameParams defines parameters for GetByNamePropertyName.

type GetByNamePropertyNameResponse

type GetByNamePropertyNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Property
}

func (GetByNamePropertyNameResponse) Status

Status returns HTTPResponse.Status

func (GetByNamePropertyNameResponse) StatusCode

func (r GetByNamePropertyNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type NextPage

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

NextPage defines model for NextPage.

type Option

type Option struct {
	// A description of the option.
	Description *string `json:"description,omitempty"`

	// Options are displayed in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// Hidden options will not be displayed in HubSpot.
	Hidden bool `json:"hidden"`

	// A human-readable option label that will be shown in HubSpot.
	Label string `json:"label"`

	// The internal value of the option, which must be used when setting the property value through the API.
	Value string `json:"value"`
}

Option defines model for Option.

type OptionInput

type OptionInput struct {
	// A description of the option.
	Description *string `json:"description,omitempty"`

	// Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// Hidden options won't be shown in HubSpot.
	Hidden bool `json:"hidden"`

	// A human-readable option label that will be shown in HubSpot.
	Label string `json:"label"`

	// The internal value of the option, which must be used when setting the property value through the API.
	Value string `json:"value"`
}

OptionInput defines model for OptionInput.

type Paging

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

Paging defines model for Paging.

type Property

type Property struct {
	// Whether or not the property is archived.
	Archived *bool `json:"archived,omitempty"`

	// When the property was archived.
	ArchivedAt *time.Time `json:"archivedAt,omitempty"`

	// For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
	Calculated *bool      `json:"calculated,omitempty"`
	CreatedAt  *time.Time `json:"createdAt,omitempty"`

	// The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
	CreatedUserId *string `json:"createdUserId,omitempty"`

	// A description of the property that will be shown as help text in HubSpot.
	Description string `json:"description"`

	// Properties are shown in order, starting with the lowest positive integer value.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// For default properties, true indicates that the options are stored externally to the property settings.
	ExternalOptions *bool `json:"externalOptions,omitempty"`

	// Controls how the property appears in HubSpot.
	FieldType string `json:"fieldType"`

	// Whether or not the property can be used in a HubSpot form.
	FormField *bool `json:"formField,omitempty"`

	// The name of the property group the property belongs to.
	GroupName string `json:"groupName"`

	// Whether or not the property's value must be unique. Once set, this can't be changed.
	HasUniqueValue *bool `json:"hasUniqueValue,omitempty"`

	// Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.
	Hidden *bool `json:"hidden,omitempty"`

	// This will be true for default object properties built into HubSpot.
	HubspotDefined *bool `json:"hubspotDefined,omitempty"`

	// A human-readable property label that will be shown in HubSpot.
	Label                string                        `json:"label"`
	ModificationMetadata *PropertyModificationMetadata `json:"modificationMetadata,omitempty"`

	// The internal property name, which must be used when referencing the property via the API.
	Name string `json:"name"`

	// A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.
	Options []Option `json:"options"`

	// If this property is related to other object(s), they'll be listed here.
	ReferencedObjectType *string `json:"referencedObjectType,omitempty"`

	// Whether or not the property will display the currency symbol set in the account settings.
	ShowCurrencySymbol *bool `json:"showCurrencySymbol,omitempty"`

	// The property data type.
	Type      string     `json:"type"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`

	// The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.
	UpdatedUserId *string `json:"updatedUserId,omitempty"`
}

Property defines model for Property.

type PropertyCreate

type PropertyCreate struct {
	// A description of the property that will be shown as help text in HubSpot.
	Description *string `json:"description,omitempty"`

	// Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// Controls how the property appears in HubSpot.
	FieldType PropertyCreateFieldType `json:"fieldType"`

	// Whether or not the property can be used in a HubSpot form.
	FormField *bool `json:"formField,omitempty"`

	// The name of the property group the property belongs to.
	GroupName string `json:"groupName"`

	// Whether or not the property's value must be unique. Once set, this can't be changed.
	HasUniqueValue *bool `json:"hasUniqueValue,omitempty"`

	// If true, the property won't be visible and can't be used in HubSpot.
	Hidden *bool `json:"hidden,omitempty"`

	// A human-readable property label that will be shown in HubSpot.
	Label string `json:"label"`

	// The internal property name, which must be used when referencing the property via the API.
	Name string `json:"name"`

	// A list of valid options for the property. This field is required for enumerated properties.
	Options *[]OptionInput `json:"options,omitempty"`

	// The data type of the property.
	Type PropertyCreateType `json:"type"`
}

PropertyCreate defines model for PropertyCreate.

type PropertyCreateFieldType

type PropertyCreateFieldType string

Controls how the property appears in HubSpot.

const (
	PropertyCreateFieldTypeBooleancheckbox PropertyCreateFieldType = "booleancheckbox"

	PropertyCreateFieldTypeCheckbox PropertyCreateFieldType = "checkbox"

	PropertyCreateFieldTypeDate PropertyCreateFieldType = "date"

	PropertyCreateFieldTypeFile PropertyCreateFieldType = "file"

	PropertyCreateFieldTypeNumber PropertyCreateFieldType = "number"

	PropertyCreateFieldTypeRadio PropertyCreateFieldType = "radio"

	PropertyCreateFieldTypeSelect PropertyCreateFieldType = "select"

	PropertyCreateFieldTypeText PropertyCreateFieldType = "text"

	PropertyCreateFieldTypeTextarea PropertyCreateFieldType = "textarea"
)

Defines values for PropertyCreateFieldType.

type PropertyCreateType

type PropertyCreateType string

The data type of the property.

const (
	PropertyCreateTypeDate PropertyCreateType = "date"

	PropertyCreateTypeDatetime PropertyCreateType = "datetime"

	PropertyCreateTypeEnumeration PropertyCreateType = "enumeration"

	PropertyCreateTypeNumber PropertyCreateType = "number"

	PropertyCreateTypeString PropertyCreateType = "string"
)

Defines values for PropertyCreateType.

type PropertyGroup

type PropertyGroup struct {
	Archived bool `json:"archived"`

	// Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
	DisplayOrder int32 `json:"displayOrder"`

	// A human-readable label that will be shown in HubSpot.
	Label string `json:"label"`

	// The internal property group name, which must be used when referencing the property group via the API.
	Name string `json:"name"`
}

An ID for a group of properties

type PropertyGroupCreate

type PropertyGroupCreate struct {
	// Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// A human-readable label that will be shown in HubSpot.
	Label string `json:"label"`

	// The internal property group name, which must be used when referencing the property group via the API.
	Name string `json:"name"`
}

PropertyGroupCreate defines model for PropertyGroupCreate.

type PropertyGroupUpdate

type PropertyGroupUpdate struct {
	// Property groups are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property group to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// A human-readable label that will be shown in HubSpot.
	Label *string `json:"label,omitempty"`
}

PropertyGroupUpdate defines model for PropertyGroupUpdate.

type PropertyModificationMetadata

type PropertyModificationMetadata struct {
	Archivable         bool  `json:"archivable"`
	ReadOnlyDefinition bool  `json:"readOnlyDefinition"`
	ReadOnlyOptions    *bool `json:"readOnlyOptions,omitempty"`
	ReadOnlyValue      bool  `json:"readOnlyValue"`
}

PropertyModificationMetadata defines model for PropertyModificationMetadata.

type PropertyName

type PropertyName struct {
	// The name of the property to read or modify.
	Name string `json:"name"`
}

PropertyName defines model for PropertyName.

type PropertyUpdate

type PropertyUpdate struct {
	// A description of the property that will be shown as help text in HubSpot.
	Description *string `json:"description,omitempty"`

	// Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.
	DisplayOrder *int32 `json:"displayOrder,omitempty"`

	// Controls how the property appears in HubSpot.
	FieldType *PropertyUpdateFieldType `json:"fieldType,omitempty"`

	// Whether or not the property can be used in a HubSpot form.
	FormField *bool `json:"formField,omitempty"`

	// The name of the property group the property belongs to.
	GroupName *string `json:"groupName,omitempty"`

	// If true, the property won't be visible and can't be used in HubSpot.
	Hidden *bool `json:"hidden,omitempty"`

	// A human-readable property label that will be shown in HubSpot.
	Label *string `json:"label,omitempty"`

	// A list of valid options for the property.
	Options *[]OptionInput `json:"options,omitempty"`

	// The data type of the property.
	Type *PropertyUpdateType `json:"type,omitempty"`
}

PropertyUpdate defines model for PropertyUpdate.

type PropertyUpdateFieldType

type PropertyUpdateFieldType string

Controls how the property appears in HubSpot.

const (
	PropertyUpdateFieldTypeBooleancheckbox PropertyUpdateFieldType = "booleancheckbox"

	PropertyUpdateFieldTypeCheckbox PropertyUpdateFieldType = "checkbox"

	PropertyUpdateFieldTypeDate PropertyUpdateFieldType = "date"

	PropertyUpdateFieldTypeFile PropertyUpdateFieldType = "file"

	PropertyUpdateFieldTypeNumber PropertyUpdateFieldType = "number"

	PropertyUpdateFieldTypeRadio PropertyUpdateFieldType = "radio"

	PropertyUpdateFieldTypeSelect PropertyUpdateFieldType = "select"

	PropertyUpdateFieldTypeText PropertyUpdateFieldType = "text"

	PropertyUpdateFieldTypeTextarea PropertyUpdateFieldType = "textarea"
)

Defines values for PropertyUpdateFieldType.

type PropertyUpdateType

type PropertyUpdateType string

The data type of the property.

const (
	PropertyUpdateTypeDate PropertyUpdateType = "date"

	PropertyUpdateTypeDatetime PropertyUpdateType = "datetime"

	PropertyUpdateTypeEnumeration PropertyUpdateType = "enumeration"

	PropertyUpdateTypeNumber PropertyUpdateType = "number"

	PropertyUpdateTypeString PropertyUpdateType = "string"
)

Defines values for PropertyUpdateType.

type ReadBatchJSONBody

type ReadBatchJSONBody BatchReadInputPropertyName

ReadBatchJSONBody defines parameters for ReadBatch.

type ReadBatchJSONRequestBody

type ReadBatchJSONRequestBody ReadBatchJSONBody

ReadBatchJSONRequestBody defines body for ReadBatch for application/json ContentType.

type ReadBatchResponse

type ReadBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BatchResponseProperty
	JSON207      *BatchResponseProperty
}

func (ReadBatchResponse) Status

func (r ReadBatchResponse) Status() string

Status returns HTTPResponse.Status

func (ReadBatchResponse) StatusCode

func (r ReadBatchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StandardError

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

StandardError defines model for StandardError.

type StandardError_Context

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

StandardError_Context defines model for StandardError.Context.

func (StandardError_Context) Get

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

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

func (StandardError_Context) MarshalJSON

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

Override default JSON handling for StandardError_Context to handle AdditionalProperties

func (*StandardError_Context) Set

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

Setter for additional properties for StandardError_Context

func (*StandardError_Context) UnmarshalJSON

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

Override default JSON handling for StandardError_Context to handle AdditionalProperties

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

StandardError_Links defines model for StandardError.Links.

func (StandardError_Links) Get

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

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

func (StandardError_Links) MarshalJSON

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

Override default JSON handling for StandardError_Links to handle AdditionalProperties

func (*StandardError_Links) Set

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

Setter for additional properties for StandardError_Links

func (*StandardError_Links) UnmarshalJSON

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

Override default JSON handling for StandardError_Links to handle AdditionalProperties

type UpdateGroupNameJSONBody

type UpdateGroupNameJSONBody PropertyGroupUpdate

UpdateGroupNameJSONBody defines parameters for UpdateGroupName.

type UpdateGroupNameJSONRequestBody

type UpdateGroupNameJSONRequestBody UpdateGroupNameJSONBody

UpdateGroupNameJSONRequestBody defines body for UpdateGroupName for application/json ContentType.

type UpdateGroupNameResponse

type UpdateGroupNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PropertyGroup
}

func (UpdateGroupNameResponse) Status

func (r UpdateGroupNameResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateGroupNameResponse) StatusCode

func (r UpdateGroupNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdatePropertyNameJSONBody

type UpdatePropertyNameJSONBody PropertyUpdate

UpdatePropertyNameJSONBody defines parameters for UpdatePropertyName.

type UpdatePropertyNameJSONRequestBody

type UpdatePropertyNameJSONRequestBody UpdatePropertyNameJSONBody

UpdatePropertyNameJSONRequestBody defines body for UpdatePropertyName for application/json ContentType.

type UpdatePropertyNameResponse

type UpdatePropertyNameResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Property
}

func (UpdatePropertyNameResponse) Status

Status returns HTTPResponse.Status

func (UpdatePropertyNameResponse) StatusCode

func (r UpdatePropertyNameResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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