Skip to content

Latest commit

 

History

History
244 lines (177 loc) · 9.03 KB

README.md

File metadata and controls

244 lines (177 loc) · 9.03 KB
Raw

Go API client for quotes

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 quotes "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(), quotes.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(), quotes.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(), quotes.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), quotes.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 Archive Delete /crm/v3/objects/quotes/{quoteId} Archive
BasicApi Create Post /crm/v3/objects/quotes Create
BasicApi GetByID Get /crm/v3/objects/quotes/{quoteId} Read
BasicApi GetPage Get /crm/v3/objects/quotes List
BasicApi Update Patch /crm/v3/objects/quotes/{quoteId} Update
BatchApi BatchArchive Post /crm/v3/objects/quotes/batch/archive Archive a batch of quotes by ID
BatchApi BatchCreate Post /crm/v3/objects/quotes/batch/create Create a batch of quotes
BatchApi BatchRead Post /crm/v3/objects/quotes/batch/read Read a batch of quotes by internal ID, or unique property values
BatchApi BatchUpdate Post /crm/v3/objects/quotes/batch/update Update a batch of quotes
GDPRApi PostCrmV3ObjectsQuotesGdprDeletePurge Post /crm/v3/objects/quotes/gdpr-delete GDPR DELETE
PublicObjectApi Merge Post /crm/v3/objects/quotes/merge Merge two quotes with same type
SearchApi Search Post /crm/v3/objects/quotes/search

Documentation For Models

Documentation For Authorization

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)

oauth2_legacy

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

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

  • 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.

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.

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