package
0.0.0-20230706133641-ea9cd22a1136
Repository: https://github.com/threecolts/go-hubspot.git
Documentation: pkg.go.dev

# README

Go API client for authors

Use these endpoints for interacting with Blog Posts, Blog Authors, and Blog Tags

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 authors "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(), authors.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(), authors.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(), authors.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), authors.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
BlogAuthorsApiArchiveDelete /cms/v3/blogs/authors/{objectId}Delete a Blog Author
BlogAuthorsApiAttachToLanguageGroupPost /cms/v3/blogs/authors/multi-language/attach-to-lang-groupAttach a Blog Author to a multi-language group
BlogAuthorsApiBatchArchivePost /cms/v3/blogs/authors/batch/archiveDelete a batch of Blog Authors
BlogAuthorsApiBatchCreatePost /cms/v3/blogs/authors/batch/createCreate a batch of Blog Authors
BlogAuthorsApiBatchReadPost /cms/v3/blogs/authors/batch/readRetrieve a batch of Blog Authors
BlogAuthorsApiBatchUpdatePost /cms/v3/blogs/authors/batch/updateUpdate a batch of Blog Authors
BlogAuthorsApiCreatePost /cms/v3/blogs/authorsCreate a new Blog Author
BlogAuthorsApiCreateLanguageVariationPost /cms/v3/blogs/authors/multi-language/create-language-variationCreate a new language variation
BlogAuthorsApiDetachFromLanguageGroupPost /cms/v3/blogs/authors/multi-language/detach-from-lang-groupDetach a Blog Author from a multi-language group
BlogAuthorsApiGetByIDGet /cms/v3/blogs/authors/{objectId}Retrieve a Blog Author
BlogAuthorsApiGetPageGet /cms/v3/blogs/authorsGet all Blog Authors
BlogAuthorsApiSetLanguagePrimaryPut /cms/v3/blogs/authors/multi-language/set-new-lang-primarySet a new primary language
BlogAuthorsApiUpdatePatch /cms/v3/blogs/authors/{objectId}Update a Blog Author
BlogAuthorsApiUpdateLanguagesPost /cms/v3/blogs/authors/multi-language/update-languagesUpdate languages of multi-language group

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2_legacy

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.

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

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewAttachToLangPrimaryRequestVNext instantiates a new AttachToLangPrimaryRequestVNext object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAttachToLangPrimaryRequestVNextWithDefaults instantiates a new AttachToLangPrimaryRequestVNext object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBatchInputBlogAuthor instantiates a new BatchInputBlogAuthor object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBatchInputBlogAuthorWithDefaults instantiates a new BatchInputBlogAuthor object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBatchInputJsonNode instantiates a new BatchInputJsonNode object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBatchInputJsonNodeWithDefaults instantiates a new BatchInputJsonNode object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBatchInputString instantiates a new BatchInputString object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBatchInputStringWithDefaults instantiates a new BatchInputString object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBatchResponseBlogAuthor instantiates a new BatchResponseBlogAuthor object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBatchResponseBlogAuthorWithDefaults instantiates a new BatchResponseBlogAuthor object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBatchResponseBlogAuthorWithErrors instantiates a new BatchResponseBlogAuthorWithErrors object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBatchResponseBlogAuthorWithErrorsWithDefaults instantiates a new BatchResponseBlogAuthorWithErrors object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBlogAuthor instantiates a new BlogAuthor object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBlogAuthorCloneRequestVNext instantiates a new BlogAuthorCloneRequestVNext object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBlogAuthorCloneRequestVNextWithDefaults instantiates a new BlogAuthorCloneRequestVNext object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBlogAuthorWithDefaults instantiates a new BlogAuthor object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCollectionResponseWithTotalBlogAuthorForwardPaging instantiates a new CollectionResponseWithTotalBlogAuthorForwardPaging object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCollectionResponseWithTotalBlogAuthorForwardPagingWithDefaults instantiates a new CollectionResponseWithTotalBlogAuthorForwardPaging object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewDetachFromLangGroupRequestVNext instantiates a new DetachFromLangGroupRequestVNext object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDetachFromLangGroupRequestVNextWithDefaults instantiates a new DetachFromLangGroupRequestVNext object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorDetail instantiates a new ErrorDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorDetailWithDefaults instantiates a new ErrorDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewForwardPaging instantiates a new ForwardPaging object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewForwardPagingWithDefaults instantiates a new ForwardPaging object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNextPage instantiates a new NextPage object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNextPageWithDefaults instantiates a new NextPage object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
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
NewSetNewLanguagePrimaryRequestVNext instantiates a new SetNewLanguagePrimaryRequestVNext object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSetNewLanguagePrimaryRequestVNextWithDefaults instantiates a new SetNewLanguagePrimaryRequestVNext object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStandardError instantiates a new StandardError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStandardErrorWithDefaults instantiates a new StandardError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateLanguagesRequestVNext instantiates a new UpdateLanguagesRequestVNext object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateLanguagesRequestVNextWithDefaults instantiates a new UpdateLanguagesRequestVNext object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAPIKeys takes a string apikey as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

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
APIClient manages communication with the Blog Post endpoints API vv3 In most cases there should be only one, shared, APIClient.
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
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
AttachToLangPrimaryRequestVNext Request body object fro attaching objects to multi-language groups.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
BatchInputBlogAuthor Wrapper for providing an array of blog authors as inputs.
BatchInputJsonNode Wrapper for providing an array of JSON nodes as inputs.
BatchInputString Wrapper for providing an array of strings as inputs.
BatchResponseBlogAuthor Response object for batch operations on blog authors.
BatchResponseBlogAuthorWithErrors Response object for batch operations on blog authors with errors.
BlogAuthor Model definition for a Blog Author.
BlogAuthorCloneRequestVNext Request body object for cloning blog authors.
CollectionResponseWithTotalBlogAuthorForwardPaging Response object for collections of blog authors with pagination information.
Configuration stores the configuration of the API client.
DetachFromLangGroupRequestVNext Request body object for detaching objects from multi-language groups.
Error struct for Error.
ErrorDetail struct for ErrorDetail.
ForwardPaging Model definition for forward paging.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
NextPage Model definition for a next page.
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
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SetNewLanguagePrimaryRequestVNext Request body object for setting a new primary language.
StandardError Model definition for a standard error.
UpdateLanguagesRequestVNext Request object for updating languages within a multi-language group.

# Interfaces

No description provided by the author

# Type aliases

BlogAuthorsApiService BlogAuthorsApi service.
ServerConfigurations stores multiple ServerConfiguration items.