Go API client for gridly

Gridly API documentation

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: 4.33.0
• Package version: 1.3.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.gridly.com

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
BranchApi	Create	Post /v1/branches	create
BranchApi	CreateDiffCheck	Post /v1/branches/diffcheck	createDiffCheck
BranchApi	Delete	Delete /v1/branches/{branchId}	delete
BranchApi	Get	Get /v1/branches/{branchId}	get
BranchApi	GetDiffCheck	Get /v1/branches/diffcheck/{taskId}	getDiffCheck
BranchApi	List	Get /v1/branches	list
BranchApi	Merge	Post /v1/branches/{branchId}/merge	merge
DatabaseApi	Create	Post /v1/databases	create
DatabaseApi	Delete	Delete /v1/databases/{dbId}	delete
DatabaseApi	Duplicate	Post /v1/databases/{dbId}/duplicate	duplicate
DatabaseApi	Get	Get /v1/databases/{dbId}	get
DatabaseApi	List	Get /v1/databases	list
DatabaseApi	Update	Put /v1/databases/{dbId}	update
GlossaryApi	Create	Post /v1/glossaries	Create a new glossary
GlossaryApi	Delete	Delete /v1/glossaries/{id}	Delete a glossary
GlossaryApi	ExportFile	Get /v1/glossaries/{id}/export	Export a glossary
GlossaryApi	Get	Get /v1/glossaries/{id}	get glossary info
GlossaryApi	GetAll	Get /v1/glossaries	List all glossaries
GlossaryApi	ImportFile	Post /v1/glossaries/{id}/import	Import a glossary from file
GlossaryApi	Update	Put /v1/glossaries/{id}	Update glossary info
GridApi	Create	Post /v1/grids	create
GridApi	CreateCategory	Post /v1/grids/{gridId}/settings/categories	createCategory
GridApi	Delete	Delete /v1/grids/{gridId}	delete
GridApi	DeleteCategory	Delete /v1/grids/{gridId}/settings/categories/{categoryId}	deleteCategory
GridApi	DeleteFile	Delete /v1/grids/{gridId}/settings/categories/{categoryId}/files/{fileId}	deleteFile
GridApi	Get	Get /v1/grids/{gridId}	get
GridApi	GetSetting	Get /v1/grids/{gridId}/settings	getSetting
GridApi	List	Get /v1/grids	list
GridApi	ListFiles	Get /v1/grids/{gridId}/settings/files	listFiles
GridApi	ListTemplateGrids	Get /v1/template-grids	listTemplateGrids
GridApi	Update	Patch /v1/grids/{gridId}	update
GridApi	UpdateCategory	Put /v1/grids/{gridId}/settings/categories/{categoryId}	updateCategory
GridApi	UpdateSetting	Patch /v1/grids/{gridId}/settings	updateSetting
GridApi	UploadSettingFile	Post /v1/grids/{gridId}/settings/categories/{categoryId}/files	uploadSettingFile
PathApi	Create	Post /v1/views/{viewId}/paths	create
PathApi	Delete	Delete /v1/views/{viewId}/paths	delete
PathApi	List	Get /v1/views/{viewId}/paths/tree	list
PathApi	Move	Post /v1/views/{viewId}/paths/move	move
PathApi	Update	Put /v1/views/{viewId}/paths/{path}	update
ProjectApi	Create	Post /v1/projects	create
ProjectApi	Delete	Delete /v1/projects/{projectId}	delete
ProjectApi	FindOne	Get /v1/projects/{projectId}	findOne
ProjectApi	List	Get /v1/projects	list
ProjectApi	Update	Put /v1/projects/{projectId}	update
RecordApi	Create	Post /v1/views/{viewId}/records	create
RecordApi	Delete	Delete /v1/views/{viewId}/records	delete
RecordApi	Fetch	Get /v1/views/{viewId}/records	fetch
RecordApi	FetchHistories	Get /v1/views/{viewId}/records/{recordId}/histories	fetchHistories
RecordApi	Update	Patch /v1/views/{viewId}/records	update
RecordApi	UpdateRecord	Patch /v1/views/{viewId}/records/{id}	updateRecord
ShareViewApi	Create	Put /v1/views/{viewId}/shares	create
ShareViewApi	Delete	Delete /v1/views/{viewId}/shares	delete
ShareViewApi	Get	Get /v1/views/{viewId}/shares	get
TaskApi	Get	Get /v1/tasks/{taskId}	get
TransmemApi	Cleanup	Put /v1/transmems/{tmId}/cleanup	Erases all the translation data of the provided tmId
TransmemApi	Create	Post /v1/transmems	Create a new translation memory
TransmemApi	CreateWithFile	Post /v1/transmems/upload	Create a new translation memory by uploading tmx file
TransmemApi	Delete	Delete /v1/transmems/{tmId}	Delete a translation memory by id
TransmemApi	Export	Get /v1/transmems/{tmId}/export	Export translation memory tmx file
TransmemApi	Get	Get /v1/transmems/{tmId}	Get translation memory info by id
TransmemApi	ImportTmx	Post /v1/transmems/{tmId}/import	Import a translation memory from tmx file
TransmemApi	ListTM	Get /v1/transmems	List all available translation memories or create default one if there is no translation memory
TransmemApi	Update	Put /v1/transmems/{tmId}	Update a translation memory
ViewApi	Create	Post /v1/views	create
ViewApi	Export	Get /v1/views/{viewId}/export	export
ViewApi	Get	Get /v1/views/{viewId}	get
ViewApi	GetStatistic	Get /v1/views/{viewId}/statistic	getStatistic
ViewApi	ImportView	Post /v1/views/{viewId}/import	importView
ViewApi	List	Get /v1/views	list
ViewApi	Merge	Post /v1/views/{viewId}/merge	merge
ViewColumnApi	Add	Post /v1/views/{viewId}/columns/{columnId}/add	add
ViewColumnApi	BulkCreate	Post /v1/views/{viewId}/columns/bulk	bulkCreate
ViewColumnApi	Create	Post /v1/views/{viewId}/columns	create
ViewColumnApi	Delete	Delete /v1/views/{viewId}/columns/{columnId}	delete
ViewColumnApi	Get	Get /v1/views/{viewId}/columns/{columnId}	get
ViewColumnApi	Remove	Post /v1/views/{viewId}/columns/{columnId}/remove	remove
ViewColumnApi	Update	Patch /v1/views/{viewId}/columns/{columnId}	update
ViewDependencyApi	Create	Post /v1/views/{viewId}/dependencies	create
ViewDependencyApi	Delete	Delete /v1/views/{viewId}/dependencies	delete
ViewDependencyApi	DeleteById	Delete /v1/views/{viewId}/dependencies/{dependencyId}	deleteById
ViewDependencyApi	Get	Get /v1/views/{viewId}/dependencies/{dependencyId}	get
ViewDependencyApi	List	Get /v1/views/{viewId}/dependencies	list
ViewDependencyApi	Update	Put /v1/views/{viewId}/dependencies/{dependencyId}	update
ViewFileApi	Delete	Delete /v1/views/{viewId}/files	delete
ViewFileApi	Download	Get /v1/views/{viewId}/files/{fileId}	download
ViewFileApi	Upload	Post /v1/views/{viewId}/files	upload
ViewFileApi	UploadZip	Post /v1/views/{viewId}/files/zip	uploadZip

Documentation For Models

• AddViewColumn
• Branch
• BranchDiffCell
• BranchDiffRecord
• Cell
• CellHistory
• ColumnReference
• ColumnStatistic
• CreateBranch
• CreateColumn
• CreateDatabase
• CreateDependency
• CreateFileCategory
• CreateGlossary
• CreateGrid
• CreatePath
• CreateProject
• CreateShareView
• CreateTransMem
• CreateView
• Database
• DateTimeFormat
• DeleteDependency
• DeleteFile
• DeletePath
• DeleteRecord
• Dependency
• ExportFileHeader
• ExportFormat
• FetchFileOption
• FetchRecordHistoryRequest
• FileCategory
• FilterField
• Formula
• Glossary
• GlossaryExportFormat
• GlossaryProject
• Grid
• GridSetting
• Group
• ImportOption
• MergeBranchRequest
• MergeCellConflict
• MergeRecordConflict
• MovePath
• NumberFormat
• PathList
• PathNode
• PathSingle
• Privilege
• Project
• ProjectDetail
• Record
• RecordHistory
• RecordIdentifierWrapper
• Reference
• ReferencedColumn
• ReferencedGrid
• Role
• SetCell
• SetRecord
• SettingFile
• ShareView
• Task
• TransMem
• TranslationCount
• TranslationStatus
• UpdateCategory
• UpdateColumn
• UpdateDatabase
• UpdateDependency
• UpdateGlossary
• UpdateGrid
• UpdateGridSetting
• UpdatePath
• UpdateProject
• UpdateTransMem
• UploadSettingFileRequest
• UploadZipRequest
• UploadedFile
• View
• ViewColumn
• ViewStatistic

Documentation For Authorization

ApiKey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

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

[email protected]