gridly-client

GridlyClient - JavaScript client for gridly-client Gridly API documentation This SDK is automatically generated by the OpenAPI Generator project:

• API version: 6.13.0
• Package version: 6.13.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.gridly.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install gridly-client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your gridly-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/gridly-spreadsheet-CMS/GIT_REPO_ID then install it via:

    npm install gridly-spreadsheet-CMS/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var GridlyClient = require('gridly-client');

var defaultClient = GridlyClient.ApiClient.instance;
// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['Authorization'] = "Token"

var api = new GridlyClient.AutomationApi()
var bulkExecutionTriggerRequest = new GridlyClient.BulkExecutionTriggerRequest(); // {BulkExecutionTriggerRequest} 
api.bulkTrigger(bulkExecutionTriggerRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
GridlyClient.AutomationApi	bulkTrigger	POST /v1/automations/trigger
GridlyClient.AutomationApi	get	GET /v1/automations/{automationId}
GridlyClient.AutomationApi	getExecution	GET /v1/automations/{automationId}/executions/{executionId}
GridlyClient.AutomationApi	getExecutions	GET /v1/automations/{automationId}/executions
GridlyClient.AutomationApi	list	GET /v1/automations
GridlyClient.AutomationApi	trigger	POST /v1/automations/{automationId}/trigger
GridlyClient.BranchApi	callDelete	DELETE /v1/branches/{branchId}	delete
GridlyClient.BranchApi	create	POST /v1/branches	create
GridlyClient.BranchApi	createDiffCheck	POST /v1/branches/diffcheck	createDiffCheck
GridlyClient.BranchApi	get	GET /v1/branches/{branchId}	get
GridlyClient.BranchApi	getDiffCheck	GET /v1/branches/diffcheck/{taskId}	getDiffCheck
GridlyClient.BranchApi	list	GET /v1/branches	list
GridlyClient.BranchApi	merge	POST /v1/branches/{branchId}/merge	merge
GridlyClient.CdnApi	list	GET /v1/cdns	list
GridlyClient.CdnApi	publish	PUT /v1/cdns/{cdnId}/publish	publish
GridlyClient.CdnApi	unPublish	PUT /v1/cdns/{cdnId}/unpublish	unPublish
GridlyClient.DatabaseApi	callDelete	DELETE /v1/databases/{dbId}	delete
GridlyClient.DatabaseApi	create	POST /v1/databases	create
GridlyClient.DatabaseApi	duplicate	POST /v1/databases/{dbId}/duplicate	duplicate
GridlyClient.DatabaseApi	get	GET /v1/databases/{dbId}	get
GridlyClient.DatabaseApi	list	GET /v1/databases	list
GridlyClient.DatabaseApi	update	PUT /v1/databases/{dbId}	update
GridlyClient.GlossaryApi	callDelete	DELETE /v1/glossaries/{id}	Delete a glossary
GridlyClient.GlossaryApi	create	POST /v1/glossaries	Create a new glossary
GridlyClient.GlossaryApi	exportFile	GET /v1/glossaries/{id}/export	Export a glossary
GridlyClient.GlossaryApi	get	GET /v1/glossaries/{id}	Get glossary info
GridlyClient.GlossaryApi	getAll	GET /v1/glossaries	List all glossaries
GridlyClient.GlossaryApi	importFile	POST /v1/glossaries/{id}/import	Import a glossary from file
GridlyClient.GlossaryApi	update	PUT /v1/glossaries/{id}	Update glossary info
GridlyClient.GridApi	callDelete	DELETE /v1/grids/{gridId}	delete
GridlyClient.GridApi	create	POST /v1/grids	create
GridlyClient.GridApi	createCategory	POST /v1/grids/{gridId}/settings/categories	createCategory
GridlyClient.GridApi	deleteCategory	DELETE /v1/grids/{gridId}/settings/categories/{categoryId}	deleteCategory
GridlyClient.GridApi	deleteFile	DELETE /v1/grids/{gridId}/settings/categories/{categoryId}/files/{fileId}	deleteFile
GridlyClient.GridApi	get	GET /v1/grids/{gridId}	get
GridlyClient.GridApi	getSetting	GET /v1/grids/{gridId}/settings	getSetting
GridlyClient.GridApi	list	GET /v1/grids	list
GridlyClient.GridApi	listFiles	GET /v1/grids/{gridId}/settings/files	listFiles
GridlyClient.GridApi	listTemplateGrids	GET /v1/template-grids	listTemplateGrids
GridlyClient.GridApi	update	PATCH /v1/grids/{gridId}	update
GridlyClient.GridApi	updateCategory	PUT /v1/grids/{gridId}/settings/categories/{categoryId}	updateCategory
GridlyClient.GridApi	updateSetting	PATCH /v1/grids/{gridId}/settings	updateSetting
GridlyClient.GridApi	uploadSettingFile	POST /v1/grids/{gridId}/settings/categories/{categoryId}/files	uploadSettingFile
GridlyClient.LocaleApi	create	GET /v1/locales/all	create
GridlyClient.LqaModelApi	getLQAModel	GET /v1/lqa-models	Get default lqa model
GridlyClient.PathApi	callDelete	DELETE /v1/views/{viewId}/paths	delete
GridlyClient.PathApi	create	POST /v1/views/{viewId}/paths	create
GridlyClient.PathApi	list	GET /v1/views/{viewId}/paths/tree	list
GridlyClient.PathApi	move	POST /v1/views/{viewId}/paths/move	move
GridlyClient.PathApi	update	PUT /v1/views/{viewId}/paths/{path}	update
GridlyClient.PathApi	updatePathNode	PUT /v1/views/{viewId}/paths	updatePathNode
GridlyClient.ProjectApi	callDelete	DELETE /v1/projects/{projectId}	delete
GridlyClient.ProjectApi	create	POST /v1/projects	create
GridlyClient.ProjectApi	findOne	GET /v1/projects/{projectId}	findOne
GridlyClient.ProjectApi	list	GET /v1/projects	list
GridlyClient.ProjectApi	update	PUT /v1/projects/{projectId}	update
GridlyClient.RecordApi	callDelete	DELETE /v1/views/{viewId}/records	delete
GridlyClient.RecordApi	create	POST /v1/views/{viewId}/records	create
GridlyClient.RecordApi	downloadRecordHistories	GET /v1/views/{viewId}/record-histories/export/{taskId}	downloadRecordHistories
GridlyClient.RecordApi	exportRecordHistories	POST /v1/views/{viewId}/record-histories/export	exportRecordHistories
GridlyClient.RecordApi	fetch	GET /v1/views/{viewId}/records	fetch
GridlyClient.RecordApi	fetchHistories	GET /v1/views/{viewId}/records/{recordId}/histories	fetchHistories
GridlyClient.RecordApi	update	PATCH /v1/views/{viewId}/records	update
GridlyClient.RecordApi	updateRecord	PATCH /v1/views/{viewId}/records/{id}	updateRecord
GridlyClient.ShareViewApi	callDelete	DELETE /v1/views/{viewId}/shares	delete
GridlyClient.ShareViewApi	create	PUT /v1/views/{viewId}/shares	create
GridlyClient.ShareViewApi	get	GET /v1/views/{viewId}/shares	get
GridlyClient.TaskApi	get	GET /v1/tasks/{taskId}	get
GridlyClient.TransmemApi	callDelete	DELETE /v1/transmems/{tmId}	Delete a translation memory by id
GridlyClient.TransmemApi	callExport	GET /v1/transmems/{tmId}/export	Export translation memory tmx file
GridlyClient.TransmemApi	cleanup	PUT /v1/transmems/{tmId}/cleanup	Erases all the translation data of the provided tmId
GridlyClient.TransmemApi	create	POST /v1/transmems	Create a new translation memory
GridlyClient.TransmemApi	createWithFile	POST /v1/transmems/upload	Create a new translation memory by uploading tmx file
GridlyClient.TransmemApi	get	GET /v1/transmems/{tmId}	Get translation memory info by id
GridlyClient.TransmemApi	importTmx	POST /v1/transmems/{tmId}/import	Import a translation memory from tmx file
GridlyClient.TransmemApi	listTM	GET /v1/transmems	List all available translation memories or create default one if there is no translation memory
GridlyClient.TransmemApi	update	PUT /v1/transmems/{tmId}	Update a translation memory
GridlyClient.ViewApi	callDelete	DELETE /v1/views/{viewId}	delete
GridlyClient.ViewApi	callExport	GET /v1/views/{viewId}/export	export
GridlyClient.ViewApi	create	POST /v1/views	create
GridlyClient.ViewApi	get	GET /v1/views/{viewId}	get
GridlyClient.ViewApi	getStatistic	GET /v1/views/{viewId}/statistic	getStatistic
GridlyClient.ViewApi	importView	POST /v1/views/{viewId}/import	importView
GridlyClient.ViewApi	list	GET /v1/views	list
GridlyClient.ViewApi	merge	POST /v1/views/{viewId}/merge	merge
GridlyClient.ViewColumnApi	add	POST /v1/views/{viewId}/columns/{columnId}/add	add
GridlyClient.ViewColumnApi	bulkCreate	POST /v1/views/{viewId}/columns/bulk	bulkCreate
GridlyClient.ViewColumnApi	callDelete	DELETE /v1/views/{viewId}/columns/{columnId}	delete
GridlyClient.ViewColumnApi	create	POST /v1/views/{viewId}/columns	create
GridlyClient.ViewColumnApi	get	GET /v1/views/{viewId}/columns/{columnId}	get
GridlyClient.ViewColumnApi	remove	POST /v1/views/{viewId}/columns/{columnId}/remove	remove
GridlyClient.ViewColumnApi	update	PATCH /v1/views/{viewId}/columns/{columnId}	update
GridlyClient.ViewDependencyApi	callDelete	DELETE /v1/views/{viewId}/dependencies	delete
GridlyClient.ViewDependencyApi	create	POST /v1/views/{viewId}/dependencies	create
GridlyClient.ViewDependencyApi	deleteById	DELETE /v1/views/{viewId}/dependencies/{dependencyId}	deleteById
GridlyClient.ViewDependencyApi	get	GET /v1/views/{viewId}/dependencies/{dependencyId}	get
GridlyClient.ViewDependencyApi	list	GET /v1/views/{viewId}/dependencies	list
GridlyClient.ViewDependencyApi	update	PUT /v1/views/{viewId}/dependencies/{dependencyId}	update
GridlyClient.ViewFileApi	callDelete	DELETE /v1/views/{viewId}/files	delete
GridlyClient.ViewFileApi	download	GET /v1/views/{viewId}/files/{fileId}	download
GridlyClient.ViewFileApi	upload	POST /v1/views/{viewId}/files	upload
GridlyClient.ViewFileApi	uploadZip	POST /v1/views/{viewId}/files/zip	uploadZip

Documentation for Models

• GridlyClient.AddViewColumn
• GridlyClient.Automation
• GridlyClient.AutomationNode
• GridlyClient.AutomationTrigger
• GridlyClient.Branch
• GridlyClient.BranchDiffCell
• GridlyClient.BranchDiffRecord
• GridlyClient.BulkExecutionTriggerRequest
• GridlyClient.CDN
• GridlyClient.Cell
• GridlyClient.CellHistory
• GridlyClient.ColumnReference
• GridlyClient.ColumnStatistic
• GridlyClient.CreateBranch
• GridlyClient.CreateColumn
• GridlyClient.CreateDatabase
• GridlyClient.CreateDependency
• GridlyClient.CreateFileCategory
• GridlyClient.CreateGlossary
• GridlyClient.CreateGrid
• GridlyClient.CreatePath
• GridlyClient.CreateProject
• GridlyClient.CreateShareView
• GridlyClient.CreateTransMem
• GridlyClient.CreateView
• GridlyClient.Database
• GridlyClient.DateTimeFormat
• GridlyClient.DeleteDependency
• GridlyClient.DeleteFile
• GridlyClient.DeletePath
• GridlyClient.DeleteRecord
• GridlyClient.Dependency
• GridlyClient.ExecutionResponse
• GridlyClient.ExecutionTriggerRequest
• GridlyClient.ExportFileHeader
• GridlyClient.ExportGlossaryFormat
• GridlyClient.ExportRecordHistory
• GridlyClient.ExportTransMemFormat
• GridlyClient.FetchFileOption
• GridlyClient.FetchRecordHistoryRequest
• GridlyClient.FileCategory
• GridlyClient.FileInfoResponse
• GridlyClient.FileType
• GridlyClient.FilterField
• GridlyClient.Formula
• GridlyClient.Glossary
• GridlyClient.GlossaryProject
• GridlyClient.Grid
• GridlyClient.GridSetting
• GridlyClient.Group
• GridlyClient.ImportGlossaryOption
• GridlyClient.LQAModelCategoryResponse
• GridlyClient.LQAModelProjectResponse
• GridlyClient.LQAModelResponse
• GridlyClient.LQAModelSeverityResponse
• GridlyClient.LQAModelStatus
• GridlyClient.LQAModelSubCategoryResponse
• GridlyClient.LengthLimitSetting
• GridlyClient.MergeBranchRequest
• GridlyClient.MergeCellConflict
• GridlyClient.MergeRecordConflict
• GridlyClient.MergeRecordOption
• GridlyClient.MovePath
• GridlyClient.NumberFormat
• GridlyClient.PathList
• GridlyClient.PathNode
• GridlyClient.PathSingle
• GridlyClient.Project
• GridlyClient.ProjectDetail
• GridlyClient.Record
• GridlyClient.RecordHistory
• GridlyClient.RecordIdentifierWrapper
• GridlyClient.Reference
• GridlyClient.ReferencedColumn
• GridlyClient.ReferencedGrid
• GridlyClient.Selection
• GridlyClient.SelectionOption
• GridlyClient.SetCell
• GridlyClient.SetRecord
• GridlyClient.SettingFile
• GridlyClient.ShareView
• GridlyClient.SubCategorySeverityResponse
• GridlyClient.Task
• GridlyClient.TransMem
• GridlyClient.TranslationCount
• GridlyClient.TranslationStatus
• GridlyClient.UpdateCategory
• GridlyClient.UpdateColumn
• GridlyClient.UpdateDatabase
• GridlyClient.UpdateDependency
• GridlyClient.UpdateGlossary
• GridlyClient.UpdateGrid
• GridlyClient.UpdateGridSetting
• GridlyClient.UpdatePath
• GridlyClient.UpdateProject
• GridlyClient.UpdateTransMem
• GridlyClient.UploadSettingFileRequest
• GridlyClient.UploadedFile
• GridlyClient.View
• GridlyClient.ViewColumn
• GridlyClient.ViewStatistic

Documentation for Authorization

Authentication schemes defined for the API:

ApiKey

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