webhooks

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 webhooks provides primitives to interact with the openapi HTTP API.

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

Package webhooks 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 DefaultServer = "https://api.hubapi.com/"

DefaultServer is the default server to be used.

View Source 
const (
	HapikeyScopes = "hapikey.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ArchiveSubscriptionResponse 

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

func (ArchiveSubscriptionResponse) Status 

func (r ArchiveSubscriptionResponse) Status() string

Status returns HTTPResponse.Status

func (ArchiveSubscriptionResponse) StatusCode 

func (r ArchiveSubscriptionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type BatchInputSubscriptionBatchUpdateRequest 

type BatchInputSubscriptionBatchUpdateRequest struct {
	Inputs []SubscriptionBatchUpdateRequest `json:"inputs"`
}

BatchInputSubscriptionBatchUpdateRequest defines model for BatchInputSubscriptionBatchUpdateRequest.

type BatchResponseSubscriptionResponse 

type BatchResponseSubscriptionResponse struct {
	CompletedAt time.Time                                `json:"completedAt"`
	Links       *BatchResponseSubscriptionResponse_Links `json:"links,omitempty"`
	RequestedAt *time.Time                               `json:"requestedAt,omitempty"`
	Results     []SubscriptionResponse                   `json:"results"`
	StartedAt   time.Time                                `json:"startedAt"`
	Status      BatchResponseSubscriptionResponseStatus  `json:"status"`
}

BatchResponseSubscriptionResponse defines model for BatchResponseSubscriptionResponse.

type BatchResponseSubscriptionResponseStatus 

type BatchResponseSubscriptionResponseStatus string

BatchResponseSubscriptionResponseStatus defines model for BatchResponseSubscriptionResponse.Status. 

const (
	BatchResponseSubscriptionResponseStatusCANCELED BatchResponseSubscriptionResponseStatus = "CANCELED"

	BatchResponseSubscriptionResponseStatusCOMPLETE BatchResponseSubscriptionResponseStatus = "COMPLETE"

	BatchResponseSubscriptionResponseStatusPENDING BatchResponseSubscriptionResponseStatus = "PENDING"

	BatchResponseSubscriptionResponseStatusPROCESSING BatchResponseSubscriptionResponseStatus = "PROCESSING"
)

Defines values for BatchResponseSubscriptionResponseStatus.

type BatchResponseSubscriptionResponseWithErrors 

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

BatchResponseSubscriptionResponseWithErrors defines model for BatchResponseSubscriptionResponseWithErrors.

type BatchResponseSubscriptionResponseWithErrorsStatus 

type BatchResponseSubscriptionResponseWithErrorsStatus string

BatchResponseSubscriptionResponseWithErrorsStatus defines model for BatchResponseSubscriptionResponseWithErrors.Status. 

const (
	BatchResponseSubscriptionResponseWithErrorsStatusCANCELED BatchResponseSubscriptionResponseWithErrorsStatus = "CANCELED"

	BatchResponseSubscriptionResponseWithErrorsStatusCOMPLETE BatchResponseSubscriptionResponseWithErrorsStatus = "COMPLETE"

	BatchResponseSubscriptionResponseWithErrorsStatusPENDING BatchResponseSubscriptionResponseWithErrorsStatus = "PENDING"

	BatchResponseSubscriptionResponseWithErrorsStatusPROCESSING BatchResponseSubscriptionResponseWithErrorsStatus = "PROCESSING"
)

Defines values for BatchResponseSubscriptionResponseWithErrorsStatus. 

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

BatchResponseSubscriptionResponseWithErrors_Links defines model for BatchResponseSubscriptionResponseWithErrors.Links.

func (BatchResponseSubscriptionResponseWithErrors_Links) Get 

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

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

func (BatchResponseSubscriptionResponseWithErrors_Links) MarshalJSON 

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

Override default JSON handling for BatchResponseSubscriptionResponseWithErrors_Links to handle AdditionalProperties

func (*BatchResponseSubscriptionResponseWithErrors_Links) Set 

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

Setter for additional properties for BatchResponseSubscriptionResponseWithErrors_Links

func (*BatchResponseSubscriptionResponseWithErrors_Links) UnmarshalJSON 

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

Override default JSON handling for BatchResponseSubscriptionResponseWithErrors_Links to handle AdditionalProperties 

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

BatchResponseSubscriptionResponse_Links defines model for BatchResponseSubscriptionResponse.Links.

func (BatchResponseSubscriptionResponse_Links) Get 

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

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

func (BatchResponseSubscriptionResponse_Links) MarshalJSON 

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

Override default JSON handling for BatchResponseSubscriptionResponse_Links to handle AdditionalProperties

func (*BatchResponseSubscriptionResponse_Links) Set 

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

Setter for additional properties for BatchResponseSubscriptionResponse_Links

func (*BatchResponseSubscriptionResponse_Links) UnmarshalJSON 

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

Override default JSON handling for BatchResponseSubscriptionResponse_Links to handle AdditionalProperties

type ClearSettingsResponse 

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

func (ClearSettingsResponse) Status 

func (r ClearSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (ClearSettingsResponse) StatusCode 

func (r ClearSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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

func (c *Client) ArchiveSubscription(ctx context.Context, appId int32, subscriptionId int32, reqEditors ...client.RequestEditorFn) (*ArchiveSubscriptionResponse, error)

ArchiveSubscription request returning *ArchiveSubscriptionResponse

func (*Client) ClearSettings 

func (c *Client) ClearSettings(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*ClearSettingsResponse, error)

ClearSettings request returning *ClearSettingsResponse

func (*Client) ConfigureSettings 

func (c *Client) ConfigureSettings(ctx context.Context, appId int32, body ConfigureSettingsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ConfigureSettingsResponse, error)

func (*Client) ConfigureSettingsWithBody 

func (c *Client) ConfigureSettingsWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ConfigureSettingsResponse, error)

ConfigureSettingsWithBody request with arbitrary body returning *ConfigureSettingsResponse

func (*Client) CreateSubscriptions 

func (c *Client) CreateSubscriptions(ctx context.Context, appId int32, body CreateSubscriptionsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateSubscriptionsResponse, error)

func (*Client) CreateSubscriptionsWithBody 

func (c *Client) CreateSubscriptionsWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateSubscriptionsResponse, error)

CreateSubscriptionsWithBody request with arbitrary body returning *CreateSubscriptionsResponse

func (*Client) GetAllSettings 

func (c *Client) GetAllSettings(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllSettingsResponse, error)

GetAllSettings request returning *GetAllSettingsResponse

func (*Client) GetAllSubscriptions 

func (c *Client) GetAllSubscriptions(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllSubscriptionsResponse, error)

GetAllSubscriptions request returning *GetAllSubscriptionsResponse

func (*Client) GetSubscription 

func (c *Client) GetSubscription(ctx context.Context, appId int32, subscriptionId int32, reqEditors ...client.RequestEditorFn) (*GetSubscriptionResponse, error)

GetSubscription request returning *GetSubscriptionResponse

func (*Client) UpdateBatch 

func (c *Client) UpdateBatch(ctx context.Context, appId int32, body UpdateBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateBatchResponse, error)

func (*Client) UpdateBatchWithBody 

func (c *Client) UpdateBatchWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateBatchResponse, error)

UpdateBatchWithBody request with arbitrary body returning *UpdateBatchResponse

func (*Client) UpdateSubscription 

func (c *Client) UpdateSubscription(ctx context.Context, appId int32, subscriptionId int32, body UpdateSubscriptionJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateSubscriptionResponse, error)

func (*Client) UpdateSubscriptionWithBody 

func (c *Client) UpdateSubscriptionWithBody(ctx context.Context, appId int32, subscriptionId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateSubscriptionResponse, error)

UpdateSubscriptionWithBody request with arbitrary body returning *UpdateSubscriptionResponse

type ClientInterface 

type ClientInterface interface {
	// ClearSettings request
	ClearSettings(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*ClearSettingsResponse, error)

	// GetAllSettings request
	GetAllSettings(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllSettingsResponse, error)

	// ConfigureSettings request with any body
	ConfigureSettingsWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*ConfigureSettingsResponse, error)
	ConfigureSettings(ctx context.Context, appId int32, body ConfigureSettingsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*ConfigureSettingsResponse, error)

	// GetAllSubscriptions request
	GetAllSubscriptions(ctx context.Context, appId int32, reqEditors ...client.RequestEditorFn) (*GetAllSubscriptionsResponse, error)

	// CreateSubscriptions request with any body
	CreateSubscriptionsWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*CreateSubscriptionsResponse, error)
	CreateSubscriptions(ctx context.Context, appId int32, body CreateSubscriptionsJSONRequestBody, reqEditors ...client.RequestEditorFn) (*CreateSubscriptionsResponse, error)

	// UpdateBatch request with any body
	UpdateBatchWithBody(ctx context.Context, appId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateBatchResponse, error)
	UpdateBatch(ctx context.Context, appId int32, body UpdateBatchJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateBatchResponse, error)

	// ArchiveSubscription request
	ArchiveSubscription(ctx context.Context, appId int32, subscriptionId int32, reqEditors ...client.RequestEditorFn) (*ArchiveSubscriptionResponse, error)

	// GetSubscription request
	GetSubscription(ctx context.Context, appId int32, subscriptionId int32, reqEditors ...client.RequestEditorFn) (*GetSubscriptionResponse, error)

	// UpdateSubscription request with any body
	UpdateSubscriptionWithBody(ctx context.Context, appId int32, subscriptionId int32, contentType string, body io.Reader, reqEditors ...client.RequestEditorFn) (*UpdateSubscriptionResponse, error)
	UpdateSubscription(ctx context.Context, appId int32, subscriptionId int32, body UpdateSubscriptionJSONRequestBody, reqEditors ...client.RequestEditorFn) (*UpdateSubscriptionResponse, error)
}

ClientInterface interface specification for the client.

type ConfigureSettingsJSONBody 

type ConfigureSettingsJSONBody SettingsChangeRequest

ConfigureSettingsJSONBody defines parameters for ConfigureSettings.

type ConfigureSettingsJSONRequestBody 

type ConfigureSettingsJSONRequestBody ConfigureSettingsJSONBody

ConfigureSettingsJSONRequestBody defines body for ConfigureSettings for application/json ContentType.

type ConfigureSettingsResponse 

type ConfigureSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SettingsResponse
}

func (ConfigureSettingsResponse) Status 

func (r ConfigureSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (ConfigureSettingsResponse) StatusCode 

func (r ConfigureSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSubscriptionsJSONBody 

type CreateSubscriptionsJSONBody SubscriptionCreateRequest

CreateSubscriptionsJSONBody defines parameters for CreateSubscriptions.

type CreateSubscriptionsJSONRequestBody 

type CreateSubscriptionsJSONRequestBody CreateSubscriptionsJSONBody

CreateSubscriptionsJSONRequestBody defines body for CreateSubscriptions for application/json ContentType.

type CreateSubscriptionsResponse 

type CreateSubscriptionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *SubscriptionResponse
}

func (CreateSubscriptionsResponse) Status 

func (r CreateSubscriptionsResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSubscriptionsResponse) StatusCode 

func (r CreateSubscriptionsResponse) 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 GetAllSettingsResponse 

type GetAllSettingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SettingsResponse
}

func (GetAllSettingsResponse) Status 

func (r GetAllSettingsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllSettingsResponse) StatusCode 

func (r GetAllSettingsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAllSubscriptionsResponse 

type GetAllSubscriptionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionListResponse
}

func (GetAllSubscriptionsResponse) Status 

func (r GetAllSubscriptionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllSubscriptionsResponse) StatusCode 

func (r GetAllSubscriptionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSubscriptionResponse 

type GetSubscriptionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionResponse
}

func (GetSubscriptionResponse) Status 

func (r GetSubscriptionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSubscriptionResponse) StatusCode 

func (r GetSubscriptionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SettingsChangeRequest 

type SettingsChangeRequest struct {
	// A publicly available URL for Hubspot to call where event payloads will be delivered. See [link-so-some-doc](#) for details about the format of these event payloads.
	TargetUrl string `json:"targetUrl"`

	// Configuration details for webhook throttling.
	Throttling ThrottlingSettings `json:"throttling"`
}

New or updated webhook settings for an app.

type SettingsResponse 

type SettingsResponse struct {
	// When this subscription was created. Formatted as milliseconds from the [Unix epoch](#).
	CreatedAt time.Time `json:"createdAt"`

	// A publicly available URL for Hubspot to call where event payloads will be delivered. See [link-so-some-doc](#) for details about the format of these event payloads.
	TargetUrl string `json:"targetUrl"`

	// Configuration details for webhook throttling.
	Throttling ThrottlingSettings `json:"throttling"`

	// When this subscription was last updated. Formatted as milliseconds from the [Unix epoch](#).
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

Webhook settings for an app.

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 SubscriptionBatchUpdateRequest 

type SubscriptionBatchUpdateRequest struct {
	Active bool  `json:"active"`
	Id     int32 `json:"id"`
}

SubscriptionBatchUpdateRequest defines model for SubscriptionBatchUpdateRequest.

type SubscriptionCreateRequest 

type SubscriptionCreateRequest struct {
	// Determines if the subscription is active or paused. Defaults to false.
	Active *bool `json:"active,omitempty"`

	// Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`.
	EventType SubscriptionCreateRequestEventType `json:"eventType"`

	// The internal name of the property to monitor for changes. Only applies when `eventType` is `propertyChange`.
	PropertyName *string `json:"propertyName,omitempty"`
}

New webhook settings for an app.

type SubscriptionCreateRequestEventType 

type SubscriptionCreateRequestEventType string

Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`. 

const (
	SubscriptionCreateRequestEventTypeCompanyCreation SubscriptionCreateRequestEventType = "company.creation"

	SubscriptionCreateRequestEventTypeCompanyDeletion SubscriptionCreateRequestEventType = "company.deletion"

	SubscriptionCreateRequestEventTypeCompanyPropertyChange SubscriptionCreateRequestEventType = "company.propertyChange"

	SubscriptionCreateRequestEventTypeContactCreation SubscriptionCreateRequestEventType = "contact.creation"

	SubscriptionCreateRequestEventTypeContactDeletion SubscriptionCreateRequestEventType = "contact.deletion"

	SubscriptionCreateRequestEventTypeContactPrivacyDeletion SubscriptionCreateRequestEventType = "contact.privacyDeletion"

	SubscriptionCreateRequestEventTypeContactPropertyChange SubscriptionCreateRequestEventType = "contact.propertyChange"

	SubscriptionCreateRequestEventTypeDealCreation SubscriptionCreateRequestEventType = "deal.creation"

	SubscriptionCreateRequestEventTypeDealDeletion SubscriptionCreateRequestEventType = "deal.deletion"

	SubscriptionCreateRequestEventTypeDealPropertyChange SubscriptionCreateRequestEventType = "deal.propertyChange"
)

Defines values for SubscriptionCreateRequestEventType.

type SubscriptionListResponse 

type SubscriptionListResponse struct {
	// List of event subscriptions for your app
	Results []SubscriptionResponse `json:"results"`
}

List of event subscriptions for your app

type SubscriptionPatchRequest 

type SubscriptionPatchRequest struct {
	// Determines if the subscription is active or paused.
	Active *bool `json:"active,omitempty"`
}

Updated details for the subscription.

type SubscriptionResponse 

type SubscriptionResponse struct {
	// Determines if the subscription is active or paused.
	Active bool `json:"active"`

	// When this subscription was created. Formatted as milliseconds from the [Unix epoch](#).
	CreatedAt time.Time `json:"createdAt"`

	// Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`.
	EventType SubscriptionResponseEventType `json:"eventType"`

	// The unique ID of the subscription.
	Id string `json:"id"`

	// The internal name of the property being monitored for changes. Only applies when `eventType` is `propertyChange`.
	PropertyName *string `json:"propertyName,omitempty"`

	// When this subscription was last updated. Formatted as milliseconds from the [Unix epoch](#).
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

Complete details for an event subscription.

type SubscriptionResponseEventType 

type SubscriptionResponseEventType string

Type of event to listen for. Can be one of `create`, `delete`, `deletedForPrivacy`, or `propertyChange`. 

const (
	SubscriptionResponseEventTypeCompanyCreation SubscriptionResponseEventType = "company.creation"

	SubscriptionResponseEventTypeCompanyDeletion SubscriptionResponseEventType = "company.deletion"

	SubscriptionResponseEventTypeCompanyPropertyChange SubscriptionResponseEventType = "company.propertyChange"

	SubscriptionResponseEventTypeContactCreation SubscriptionResponseEventType = "contact.creation"

	SubscriptionResponseEventTypeContactDeletion SubscriptionResponseEventType = "contact.deletion"

	SubscriptionResponseEventTypeContactPrivacyDeletion SubscriptionResponseEventType = "contact.privacyDeletion"

	SubscriptionResponseEventTypeContactPropertyChange SubscriptionResponseEventType = "contact.propertyChange"

	SubscriptionResponseEventTypeDealCreation SubscriptionResponseEventType = "deal.creation"

	SubscriptionResponseEventTypeDealDeletion SubscriptionResponseEventType = "deal.deletion"

	SubscriptionResponseEventTypeDealPropertyChange SubscriptionResponseEventType = "deal.propertyChange"
)

Defines values for SubscriptionResponseEventType.

type ThrottlingSettings 

type ThrottlingSettings struct {
	// The maximum number of HTTP requests HubSpot will attempt to make to your app in a given time frame determined by `period`.
	MaxConcurrentRequests int32 `json:"maxConcurrentRequests"`

	// Time scale for this setting. Can be either `SECONDLY` (per second) or `ROLLING_MINUTE` (per minute).
	Period ThrottlingSettingsPeriod `json:"period"`
}

Configuration details for webhook throttling.

type ThrottlingSettingsPeriod 

type ThrottlingSettingsPeriod string

Time scale for this setting. Can be either `SECONDLY` (per second) or `ROLLING_MINUTE` (per minute). 

const (
	ThrottlingSettingsPeriodROLLINGMINUTE ThrottlingSettingsPeriod = "ROLLING_MINUTE"

	ThrottlingSettingsPeriodSECONDLY ThrottlingSettingsPeriod = "SECONDLY"
)

Defines values for ThrottlingSettingsPeriod.

type UpdateBatchJSONBody 

type UpdateBatchJSONBody BatchInputSubscriptionBatchUpdateRequest

UpdateBatchJSONBody defines parameters for UpdateBatch.

type UpdateBatchJSONRequestBody 

type UpdateBatchJSONRequestBody UpdateBatchJSONBody

UpdateBatchJSONRequestBody defines body for UpdateBatch for application/json ContentType.

type UpdateBatchResponse 

type UpdateBatchResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BatchResponseSubscriptionResponse
	JSON207      *BatchResponseSubscriptionResponseWithErrors
}

func (UpdateBatchResponse) Status 

func (r UpdateBatchResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateBatchResponse) StatusCode 

func (r UpdateBatchResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateSubscriptionJSONBody 

type UpdateSubscriptionJSONBody SubscriptionPatchRequest

UpdateSubscriptionJSONBody defines parameters for UpdateSubscription.

type UpdateSubscriptionJSONRequestBody 

type UpdateSubscriptionJSONRequestBody UpdateSubscriptionJSONBody

UpdateSubscriptionJSONRequestBody defines body for UpdateSubscription for application/json ContentType.

type UpdateSubscriptionResponse 

type UpdateSubscriptionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SubscriptionResponse
}

func (UpdateSubscriptionResponse) Status 

func (r UpdateSubscriptionResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSubscriptionResponse) StatusCode 

func (r UpdateSubscriptionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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.