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

# README

Go API client for blog_posts

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 blog_posts "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(), blog_posts.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(), blog_posts.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(), blog_posts.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), blog_posts.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
BlogPostsApiArchiveDelete /cms/v3/blogs/posts/{objectId}Delete a Blog Post
BlogPostsApiAttachToLanguageGroupPost /cms/v3/blogs/posts/multi-language/attach-to-lang-groupAttach a Blog Post to a multi-language group
BlogPostsApiBatchArchivePost /cms/v3/blogs/posts/batch/archiveDelete a batch of Blog Posts
BlogPostsApiBatchCreatePost /cms/v3/blogs/posts/batch/createCreate a batch of Blog Posts
BlogPostsApiBatchReadPost /cms/v3/blogs/posts/batch/readRetrieve a batch of Blog Posts
BlogPostsApiBatchUpdatePost /cms/v3/blogs/posts/batch/updateUpdate a batch of Blog Posts
BlogPostsApiClonePost /cms/v3/blogs/posts/cloneClone a Blog Post
BlogPostsApiCreatePost /cms/v3/blogs/postsCreate a new Blog Post
BlogPostsApiCreateLanguageVariationPost /cms/v3/blogs/posts/multi-language/create-language-variationCreate a new language variation
BlogPostsApiDetachFromLanguageGroupPost /cms/v3/blogs/posts/multi-language/detach-from-lang-groupDetach a Blog Post from a multi-language group
BlogPostsApiGetByIDGet /cms/v3/blogs/posts/{objectId}Retrieve a Blog Post
BlogPostsApiGetDraftByIDGet /cms/v3/blogs/posts/{objectId}/draftRetrieve the full draft version of the Blog Post
BlogPostsApiGetPageGet /cms/v3/blogs/postsGet all Blog Posts
BlogPostsApiGetPreviousVersionGet /cms/v3/blogs/posts/{objectId}/revisions/{revisionId}Retrieves a previous version of a blog post
BlogPostsApiGetPreviousVersionsGet /cms/v3/blogs/posts/{objectId}/revisionsRetrieves all the previous versions of a blog post
BlogPostsApiPushLivePost /cms/v3/blogs/posts/{objectId}/draft/push-livePush Blog Post draft edits live
BlogPostsApiResetDraftPost /cms/v3/blogs/posts/{objectId}/draft/resetReset the Blog Post draft to the live version
BlogPostsApiRestorePreviousVersionPost /cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restoreRestore a previous version of a blog post
BlogPostsApiRestorePreviousVersionToDraftPost /cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore-to-draftRestore a previous version of a blog post, to the draft version of the blog post
BlogPostsApiSchedulePost /cms/v3/blogs/posts/scheduleSchedule a Blog Post to be Published
BlogPostsApiSetLanguagePrimaryPut /cms/v3/blogs/posts/multi-language/set-new-lang-primarySet a new primary language
BlogPostsApiUpdatePatch /cms/v3/blogs/posts/{objectId}Update a Blog Post
BlogPostsApiUpdateDraftPatch /cms/v3/blogs/posts/{objectId}/draftUpdate a Blog Post draft
BlogPostsApiUpdateLanguagesPost /cms/v3/blogs/posts/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