@gridly/client@1.5.0

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @gridly/client@1.5.0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AutomationApi	bulkTrigger	POST /v1/automations/trigger
AutomationApi	get	GET /v1/automations/{automationId}
AutomationApi	getExecution	GET /v1/automations/{automationId}/executions/{executionId}
AutomationApi	getExecutions	GET /v1/automations/{automationId}/executions
AutomationApi	list	GET /v1/automations
AutomationApi	trigger	POST /v1/automations/{automationId}/trigger
BranchApi	_delete	DELETE /v1/branches/{branchId}	delete
BranchApi	create	POST /v1/branches	create
BranchApi	createDiffCheck	POST /v1/branches/diffcheck	createDiffCheck
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
CdnApi	list	GET /v1/cdns	list
CdnApi	publish	PUT /v1/cdns/{cdnId}/publish	publish
CdnApi	unPublish	PUT /v1/cdns/{cdnId}/unpublish	unPublish
DatabaseApi	_delete	DELETE /v1/databases/{dbId}	delete
DatabaseApi	create	POST /v1/databases	create
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	_delete	DELETE /v1/glossaries/{id}	Delete a glossary
GlossaryApi	create	POST /v1/glossaries	Create a new 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	_delete	DELETE /v1/grids/{gridId}	delete
GridApi	create	POST /v1/grids	create
GridApi	createCategory	POST /v1/grids/{gridId}/settings/categories	createCategory
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
LocaleApi	create	GET /v1/locales/all	create
LqaModelApi	getLQAModel	GET /v1/lqa-models	Get default lqa model
PathApi	_delete	DELETE /v1/views/{viewId}/paths	delete
PathApi	create	POST /v1/views/{viewId}/paths	create
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
PathApi	updatePathNode	PUT /v1/views/{viewId}/paths	updatePathNode
ProjectApi	_delete	DELETE /v1/projects/{projectId}	delete
ProjectApi	create	POST /v1/projects	create
ProjectApi	findOne	GET /v1/projects/{projectId}	findOne
ProjectApi	list	GET /v1/projects	list
ProjectApi	update	PUT /v1/projects/{projectId}	update
RecordApi	_delete	DELETE /v1/views/{viewId}/records	delete
RecordApi	create	POST /v1/views/{viewId}/records	create
RecordApi	downloadRecordHistories	GET /v1/views/{viewId}/record-histories/export/{taskId}	downloadRecordHistories
RecordApi	exportRecordHistories	POST /v1/views/{viewId}/record-histories/export	exportRecordHistories
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	_delete	DELETE /v1/views/{viewId}/shares	delete
ShareViewApi	create	PUT /v1/views/{viewId}/shares	create
ShareViewApi	get	GET /v1/views/{viewId}/shares	get
TaskApi	get	GET /v1/tasks/{taskId}	get
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	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	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	_delete	DELETE /v1/views/{viewId}	delete
ViewApi	_export	GET /v1/views/{viewId}/export	export
ViewApi	create	POST /v1/views	create
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	_delete	DELETE /v1/views/{viewId}/columns/{columnId}	delete
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	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	_delete	DELETE /v1/views/{viewId}/dependencies	delete
ViewDependencyApi	create	POST /v1/views/{viewId}/dependencies	create
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
• Automation
• AutomationNode
• AutomationTrigger
• Branch
• BranchDiffCell
• BranchDiffRecord
• BulkExecutionTriggerRequest
• CDN
• Cell
• CellHistory
• ColumnReference
• ColumnStatistic
• CreateBranch
• CreateColumn
• CreateDatabase
• CreateDependency
• CreateFileCategory
• CreateGlossary
• CreateGrid
• CreatePath
• CreateProject
• CreateShareView
• CreateTransMem
• CreateView
• Database
• DateTimeFormat
• DeleteDependency
• DeleteFile
• DeletePath
• DeleteRecord
• Dependency
• ExecutionResponse
• ExecutionTriggerRequest
• ExportFileHeader
• ExportGlossaryFormat
• ExportRecordHistory
• ExportTransMemFormat
• FetchFileOption
• FetchRecordHistoryRequest
• FileCategory
• FileInfoResponse
• FileType
• FilterField
• Formula
• Glossary
• GlossaryProject
• Grid
• GridSetting
• Group
• ImportGlossaryOption
• LQAModelCategoryResponse
• LQAModelProjectResponse
• LQAModelResponse
• LQAModelSeverityResponse
• LQAModelStatus
• LQAModelSubCategoryResponse
• LengthLimitSetting
• MergeBranchRequest
• MergeCellConflict
• MergeRecordConflict
• MergeRecordOption
• MovePath
• NumberFormat
• PathList
• PathNode
• PathSingle
• Project
• ProjectDetail
• Record
• RecordHistory
• RecordIdentifierWrapper
• Reference
• ReferencedColumn
• ReferencedGrid
• Selection
• SelectionOption
• SetCell
• SetRecord
• SettingFile
• ShareView
• SubCategorySeverityResponse
• Task
• TransMem
• TranslationCount
• TranslationStatus
• UpdateCategory
• UpdateColumn
• UpdateDatabase
• UpdateDependency
• UpdateGlossary
• UpdateGrid
• UpdateGridSetting
• UpdatePath
• UpdateProject
• UpdateTransMem
• UploadSettingFileRequest
• UploadedFile
• View
• ViewColumn
• ViewStatistic

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

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