# README

Go API client for actions

Create custom workflow actions

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: v4
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 actions "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(), actions.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(), actions.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(), actions.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), actions.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
CallbacksApi	CallbackComplete	Post /automation/v4/actions/callbacks/{callbackId}/complete	Complete a callback
CallbacksApi	CallbackCompleteBatch	Post /automation/v4/actions/callbacks/complete	Complete a batch of callbacks
DefinitionsApi	Archive	Delete /automation/v4/actions/{appId}/{definitionId}	Archive a custom action
DefinitionsApi	Create	Post /automation/v4/actions/{appId}	Create new custom action
DefinitionsApi	GetByID	Get /automation/v4/actions/{appId}/{definitionId}	Get a custom action
DefinitionsApi	GetPage	Get /automation/v4/actions/{appId}	Get all custom actions
DefinitionsApi	Update	Patch /automation/v4/actions/{appId}/{definitionId}	Update a custom action
FunctionsApi	FunctionsArchive	Delete /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}	Delete a custom action function
FunctionsApi	FunctionsArchiveByType	Delete /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}	Delete a custom action function
FunctionsApi	FunctionsCreateOrReplace	Put /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}	Create or replace a custom action function
FunctionsApi	FunctionsCreateOrReplaceByType	Put /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}	Create or replace a custom action function
FunctionsApi	FunctionsGetByID	Get /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}	Get a custom action function
FunctionsApi	FunctionsGetByType	Get /automation/v4/actions/{appId}/{definitionId}/functions/{functionType}	Get a custom action function
FunctionsApi	FunctionsGetPage	Get /automation/v4/actions/{appId}/{definitionId}/functions	Get all custom action functions
RevisionsApi	RevisionsGetByID	Get /automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId}	Get a revision for a custom action
RevisionsApi	RevisionsGetPage	Get /automation/v4/actions/{appId}/{definitionId}/revisions	Get all revisions for a custom action

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:
automation: Read from and write to my Workflows

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)

developer_hapikey

Type: API key
API key parameter name: hapikey
Location: URL query string

Note, each API key must be added to a map of map[string]APIKey where the key is: hapikey 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