Categorygithub.com/threecolts/go-hubspotgeneratedv3objects

package

0.0.0-20230706133641-ea9cd22a1136

Repository: https://github.com/threecolts/go-hubspot.git

Documentation: pkg.go.dev

# README

Go API client for objects

CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.

Supported Object Types

This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the CRM Object Properties API.

Object Type	Properties returned by default
`companies`	`name`, `domain`
`contacts`	`firstname`, `lastname`, `email`
`deals`	`dealname`, `amount`, `closedate`, `pipeline`, `dealstage`
`products`	`name`, `description`, `price`
`tickets`	`content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject`

Find a list of all properties for an object type using the CRM Object Properties API. e.g. GET https://api.hubapi.com/properties/v2/companies/properties. Change the properties returned in the response using the properties array in the request body.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: v3
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import objects "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), objects.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), objects.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), objects.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), objects.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hubapi.com

Class	Method	HTTP request	Description
AssociationsApi	AssociationsArchive	Delete /crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}	Remove an association between two objects
AssociationsApi	AssociationsCreate	Put /crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}	Associate an object with another object
AssociationsApi	AssociationsGetAll	Get /crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}	List associations of an object by type
BasicApi	Archive	Delete /crm/v3/objects/{objectType}/{objectId}	Archive
BasicApi	Create	Post /crm/v3/objects/{objectType}	Create
BasicApi	GetByID	Get /crm/v3/objects/{objectType}/{objectId}	Read
BasicApi	GetPage	Get /crm/v3/objects/{objectType}	List
BasicApi	Update	Patch /crm/v3/objects/{objectType}/{objectId}	Update
BatchApi	BatchArchive	Post /crm/v3/objects/{objectType}/batch/archive	Archive a batch of objects by ID
BatchApi	BatchCreate	Post /crm/v3/objects/{objectType}/batch/create	Create a batch of objects
BatchApi	BatchRead	Post /crm/v3/objects/{objectType}/batch/read	Read a batch of objects by internal ID, or unique property values
BatchApi	BatchUpdate	Post /crm/v3/objects/{objectType}/batch/update	Update a batch of objects
GDPRApi	Delete	Post /crm/v3/objects/{objectType}/gdpr-delete	GDPR DELETE
PublicObjectApi	Merge	Post /crm/v3/objects/{objectType}/merge	Merge two objects with same type
SearchApi	Search	Post /crm/v3/objects/{objectType}/search

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2_legacy

Type: OAuth
Flow: accessCode
Authorization URL: https://app.hubspot.com/oauth/authorize
Scopes:
tickets: Read and write tickets
crm.objects.goals.read: Read goals
crm.objects.custom.read: View custom object records
crm.objects.custom.write: Change custom object records
e-commerce: e-commerce
media_bridge.read: Read media and media events

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://app.hubspot.com/oauth/authorize
Scopes:
crm.objects.line_items.read: Line Items
crm.objects.deals.read:
crm.objects.quotes.write: Quotes
crm.objects.contacts.read:
crm.objects.contacts.write:
crm.objects.companies.write:
crm.objects.companies.read:
crm.objects.line_items.write: Line Items
crm.objects.quotes.read: Quotes
crm.objects.deals.write:

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

private_apps_legacy

Type: API key
API key parameter name: private-app-legacy
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app-legacy and passed in as the auth context for each request.

private_apps

Type: API key
API key parameter name: private-app
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: private-app and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime