github.com/pyscht/hubspot-go-api/apis/crm/companies

Go API client for companies

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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 companies "github.com/pyscht/hubspot-go-api/apis/crm/companies"

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(), companies.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(), companies.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(), companies.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), companies.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
BasicApi	DeleteCrmV3ObjectsCompaniesCompanyIdArchive	Delete /crm/v3/objects/companies/{companyId}	Archive
BasicApi	GetCrmV3ObjectsCompaniesCompanyIdGetById	Get /crm/v3/objects/companies/{companyId}	Read
BasicApi	GetCrmV3ObjectsCompaniesGetPage	Get /crm/v3/objects/companies	List
BasicApi	PatchCrmV3ObjectsCompaniesCompanyIdUpdate	Patch /crm/v3/objects/companies/{companyId}	Update
BasicApi	PostCrmV3ObjectsCompaniesCreate	Post /crm/v3/objects/companies	Create
BatchApi	PostCrmV3ObjectsCompaniesBatchArchiveArchive	Post /crm/v3/objects/companies/batch/archive	Archive a batch of companies by ID
BatchApi	PostCrmV3ObjectsCompaniesBatchCreateCreate	Post /crm/v3/objects/companies/batch/create	Create a batch of companies
BatchApi	PostCrmV3ObjectsCompaniesBatchReadRead	Post /crm/v3/objects/companies/batch/read	Read a batch of companies by internal ID, or unique property values
BatchApi	PostCrmV3ObjectsCompaniesBatchUpdateUpdate	Post /crm/v3/objects/companies/batch/update	Update a batch of companies
PublicObjectApi	PostCrmV3ObjectsCompaniesMergeMerge	Post /crm/v3/objects/companies/merge	Merge two companies with same type
SearchApi	PostCrmV3ObjectsCompaniesSearchDoSearch	Post /crm/v3/objects/companies/search

Documentation For Models

• AssociatedId
• AssociationSpec
• BatchInputSimplePublicObjectBatchInput
• BatchInputSimplePublicObjectId
• BatchInputSimplePublicObjectInputForCreate
• BatchReadInputSimplePublicObjectId
• BatchResponseSimplePublicObject
• BatchResponseSimplePublicObjectWithErrors
• CollectionResponseAssociatedId
• CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
• CollectionResponseWithTotalSimplePublicObjectForwardPaging
• Error
• ErrorDetail
• Filter
• FilterGroup
• ForwardPaging
• NextPage
• Paging
• PreviousPage
• PublicAssociationsForObject
• PublicMergeInput
• PublicObjectId
• PublicObjectSearchRequest
• SimplePublicObject
• SimplePublicObjectBatchInput
• SimplePublicObjectId
• SimplePublicObjectInput
• SimplePublicObjectInputForCreate
• SimplePublicObjectWithAssociations
• StandardError
• ValueWithTimestamp

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://app.hubspot.com/oauth/authorize
• Scopes:
• crm.objects.companies.read:
• crm.objects.companies.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

Author