# README
hubspot-go
# Functions
HubSpotResponseError checks the response for errors and returns an error if any are found.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewCompanyClient returns a new client for the HubSpot API.
NewContactClient returns a new client for the HubSpot API.
NewDealClient returns a new client for the HubSpot API.
NewDefaultClient returns a new HubSpot client with the given token source and options.
NewDiscountClient returns a new client for the HubSpot API.
No description provided by the author
No description provided by the author
NewFeeClient returns a new client for the HubSpot API.
NewFeedbackSubmissionClient returns a new client for the HubSpot API.
NewGoalClient returns a new client for the HubSpot API.
NewHTTPClient returns a new HTTP client that uses the given token source to authenticate requests to the HubSpot API.
NewLineItemClient returns a new client for the HubSpot API.
No description provided by the author
NewObjectClient returns a new object client for the given object type.
NewProductClient returns a new client for the HubSpot API.
No description provided by the author
No description provided by the author
NewPropertyGroupClient returns a new property group client that uses the given HTTP client to make requests to the endpoint.
NewQuoteClient returns a new client for the HubSpot API.
NewTaxClient returns a new client for the HubSpot API.
NewTicketClient returns a new client for the HubSpot API.
NewTypedClient returns a new HubSpot client with the given token source and options.
WithAfter sets the after option for the request.
WithArchived sets the archived option for the request.
WithAssociations sets the associations option for the request.
WithContext sets the context for the client.
WithIDProperty sets the ID property option for the request.
WithLimit sets the limit option for the request.
WithLimiter sets the rate limiter for the client.
WithProperties sets the properties option for the request.
WithPropertiesWithHistory sets the properties with history option for the request.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Alias for "string".
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ErrEncryptedAccessTokenTooShort is returned when the encrypted access token is too short.
ErrEncryptionKeyTooShort is returned when the encryption key is too short.
ErrEnvKeyRequired is returned when an environment variable key is required but not provided.
ErrEnvVarNotSet is returned when an environment variable is not set.
ErrNilParam is an error returned when a required parameter is nil.
ErrTokenInvalid is returned when the access token is invalid.
ErrTokenSourceRequired is returned when a token source is required but not provided.
OAuth2Endpoint is the OAuth 2.0 endpoint for HubSpot.
# Structs
AccessToken is an OAuth 2.0 access token as retrieved from [endpoint.OAuthAccessTokens].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EnvTokenSource implements the oauth2.TokenSource interface and retrieves the token from an environment variable.
EnvTokenSourceEncrypted implements the oauth2.TokenSource interface and retrieves the token from an environment variable, as [EnvTokenSource], caching an encrypted version of the token in memory.
No description provided by the author
No description provided by the author
No description provided by the author
HubSpotError represents an error returned by the HubSpot API.
No description provided by the author
HubSpotSubError represents a sub-error returned by the HubSpot API.
No description provided by the author
OAuthClient is a client for the HubSpot OAuth API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ObjectMutationRequestBody is a generic struct that contains the request body for creating or updating an object in the HubSpot API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RefreshToken is an OAuth 2.0 refresh token as retrieved from [endpoint.OAuthRefreshTokens].
RequestConfig is a struct that contains options for making requests to the HubSpot API.
Results is a generic struct that contains a list of results of type T returned by the HubSpot API.
No description provided by the author
No description provided by the author
Token is an OAuth 2.0 as retrieved from [endpoint.OAuthToken] after a successful code exchange or refresh.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CompanyPropertiesEmbedder is the interface that must be implemented to create a client for the Company object.
ContactPropertiesEmbedder is the interface that must be implemented to create a client for the Contact object.
DealPropertiesEmbedder is the interface that must be implemented to create a client for the Deal object.
DiscountPropertiesEmbedder is the interface that must be implemented to create a client for the Discount object.
FeedbackSubmissionPropertiesEmbedder is the interface that must be implemented to create a client for the FeedbackSubmission object.
FeePropertiesEmbedder is the interface that must be implemented to create a client for the Fee object.
GoalPropertiesEmbedder is the interface that must be implemented to create a client for the Goal object.
LineItemPropertiesEmbedder is the interface that must be implemented to create a client for the LineItem object.
Default objects' properties embedder.
ProductPropertiesEmbedder is the interface that must be implemented to create a client for the Product object.
QuotePropertiesEmbedder is the interface that must be implemented to create a client for the Quote object.
TaxPropertiesEmbedder is the interface that must be implemented to create a client for the Tax object.
TicketPropertiesEmbedder is the interface that must be implemented to create a client for the Ticket object.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
Date is a time.Time compatible with HubSpot's date properties.
DateTime is a time.Time compatible with HubSpot's date properties.
No description provided by the author
No description provided by the author
No description provided by the author
HubSpotSubErrors represents a list of sub-errors returned by the HubSpot API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author