Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.swagger-codegen
docs
node_modules
scripts
src
test
.swagger-codegen-ignore
.travis.yml
LICENCE
README.md
git_push.sh
mocha.opts
package-lock.json
package.json
sonar-project.properties

README.md

quatrix_api

QuatrixApi - JavaScript client for quatrix_api Download and upload files or folders, share them with predefined security options, manage your account and profile settings and a lot more functionalities can be easily integrated into your application using our Quatrix APIs. Learn more how to authenticate the Quatrix session, how to construct JSON formatted API calls and what responses to expect in our API Guide. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 quatrix_api --save
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

Finally, switch to the directory you want to use your quatrix_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('quatrix_api') in javascript files from the directory you ran the last command above from.

git

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

    npm install GIT_USER_ID/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, that's to say your javascript file where you actually use this library):

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 QuatrixApi = require('quatrix_api');

var defaultClient = QuatrixApi.ApiClient.instance;

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

var api = new QuatrixApi.AccountApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountInfoGet(callback);

Documentation for API Endpoints

All URIs are relative to https://api.quatrix.it/api/1.0

Class Method HTTP request Description
QuatrixApi.AccountApi accountInfoGet GET /account/info Get account usage info
QuatrixApi.AccountApi accountListGet GET /account/list List user accounts
QuatrixApi.AccountApi accountLogoGet GET /account/logo Get account logo
QuatrixApi.AccountApi accountMetadataGet GET /account/metadata Get account metadata
QuatrixApi.AccountApi accountRolesGet GET /account/roles Call users of the account
QuatrixApi.ActivityLogApi trackingActivityGet GET /tracking/activity Get activity log
QuatrixApi.ActivityLogApi trackingCsvGet GET /tracking/csv Download CSV file with activity log
QuatrixApi.ActivityLogApi trackingDownloadsIdGet GET /tracking/downloads/{id} Get shared file downloads
QuatrixApi.ActivityLogApi trackingFilesIdGet GET /tracking/files/{id} Get share action files
QuatrixApi.AuthApi sessionKeepaliveGet GET /session/keepalive Refresh session expiration time
QuatrixApi.AuthApi sessionLoginGet GET /session/login Log in and get session ID details
QuatrixApi.AuthApi sessionLoginPost POST /session/login Log in to the account using MFA
QuatrixApi.AuthApi sessionLogoutGet GET /session/logout Close the user's session
QuatrixApi.AuthApi sessionUnblockCaptchaPost POST /session/unblock-captcha Unblock the session using CAPTCHA
QuatrixApi.AutomationApi automationCreatePost POST /automation/create Create a new automation
QuatrixApi.AutomationApi automationDeletePost POST /automation/delete Delete automations
QuatrixApi.AutomationApi automationEditPost POST /automation/edit/ Edit an existing automation
QuatrixApi.AutomationApi automationGet GET /automation List all automations
QuatrixApi.AutomationApi automationMetadataIdGet GET /automation/metadata/{id} Get automation metadata
QuatrixApi.BillingApi billingUpgradePost POST /billing/upgrade Upgrade the user's account
QuatrixApi.ContactApi contactCreatePost POST /contact/create Create a new contact
QuatrixApi.ContactApi contactDeletePost POST /contact/delete Delete a contact
QuatrixApi.ContactApi contactEditIdPost POST /contact/edit/{id} Edit contact metadata
QuatrixApi.ContactApi contactGet GET /contact List user contacts
QuatrixApi.ContactApi contactGroupGet GET /contact/group List available contact groups.
QuatrixApi.ContactApi contactMetadataIdGet GET /contact/metadata/{id} Get contact metadata
QuatrixApi.ContactApi contactPgpKeyIdGet GET /contact/pgp-key/{id} Get contact's PGP key
QuatrixApi.ContactApi contactUpgradeIdGet GET /contact/upgrade/{id} Upgrade a contact
QuatrixApi.FileApi fileAddTagIdPost POST /file/add-tag/{id} Add a file tag
QuatrixApi.FileApi fileCopyPost POST /file/copy Copy files
QuatrixApi.FileApi fileCsvIdGet GET /file/csv/{id} Download CSV file with Folder Content
QuatrixApi.FileApi fileDeletePost POST /file/delete Delete files
QuatrixApi.FileApi fileDiffIdGet GET /file/diff/{id} Display changes of the file
QuatrixApi.FileApi fileDownloadIdGet GET /file/download/{id} Download file
QuatrixApi.FileApi fileDownloadLinkPost POST /file/download-link Get download link
QuatrixApi.FileApi fileInfoIdGet GET /file/info/{id} Get file info
QuatrixApi.FileApi fileMakedirPost POST /file/makedir Create a new folder
QuatrixApi.FileApi fileMetadataGet GET /file/metadata Get metadata of files
QuatrixApi.FileApi fileMetadataIdGet GET /file/metadata/{id} Get all file metadata
QuatrixApi.FileApi fileMetadataPost POST /file/metadata Modify file metadata
QuatrixApi.FileApi fileModifyPost POST /file/modify Get file modification link
QuatrixApi.FileApi fileMovePost POST /file/move Move files
QuatrixApi.FileApi filePreviewIdGet GET /file/preview/{id} Get a file preview
QuatrixApi.FileApi fileRenameIdPost POST /file/rename/{id} Rename a file
QuatrixApi.FileApi fileSearchPost POST /file/search Search files
QuatrixApi.FileApi fileSizeIdGet GET /file/size/{id} Get file size
QuatrixApi.FileApi fileTagsIdGet GET /file/tags/{id} Get a list of file tags
QuatrixApi.GroupApi contactGroupGet GET /contact/group List available contact groups.
QuatrixApi.GroupApi groupGet GET /group List available user groups
QuatrixApi.GroupApi groupMetadataIdGet GET /group/metadata/{id} Get group metadata
QuatrixApi.GroupApi userGroupGet GET /user/group List all user groups
QuatrixApi.InboxApi inboxGet GET /inbox Get contact's share tracking
QuatrixApi.LanguageApi languagesDefaultGet GET /languages/default Get default language
QuatrixApi.LanguageApi languagesGet GET /languages List available languages
QuatrixApi.MFAApi profileRemoveMfaPost POST /profile/remove-mfa Disable MFA for the logged-in user
QuatrixApi.MFAApi profileSetMfaPost POST /profile/set-mfa Enable MFA for the logged-in user
QuatrixApi.MFAApi sessionLoginPost POST /session/login Log in to the account using MFA
QuatrixApi.MFAApi userRemoveMfaPost POST /user/remove-mfa Disable MFA for users
QuatrixApi.MFAApi userResetMfaPost POST /user/reset-mfa Update existing MFA settings for users
QuatrixApi.MFAApi userSetMfaPost POST /user/set-mfa Enable MFA for users
QuatrixApi.PGPApi contactPgpKeyIdGet GET /contact/pgp-key/{id} Get contact's PGP key
QuatrixApi.PGPApi keyRequestMetadataIdGet GET /key-request/metadata/{id} Get PGP key request metadata
QuatrixApi.PGPApi keyRequestRespondIdPost POST /key-request/respond/{id} Respond to PGP key request
QuatrixApi.PGPApi pgpKeyCreatePost POST /pgp-key/create Create PGP key
QuatrixApi.PGPApi pgpKeyDeleteIdGet GET /pgp-key/delete/{id} Delete PGP key
QuatrixApi.PGPApi pgpKeyEditIdPost POST /pgp-key/edit/{id} Edit PGP key
QuatrixApi.PGPApi pgpKeyMetadataIdGet GET /pgp-key/metadata/{id} Get PGP key metadata
QuatrixApi.PGPApi pgpKeyRecipientsPost POST /pgp-key/recipients Get recipients' PGP keys
QuatrixApi.PGPApi pgpKeyRequestIdsGet GET /pgp-key/request/{ids[]} Request PGP key
QuatrixApi.PGPApi userPgpKeyIdGet GET /user/pgp-key/{id} Get user's PGP key
QuatrixApi.PasswordResetApi resetPasswordMetadataIdGet GET /reset-password/metadata/{id} Get password reset request metadata
QuatrixApi.PasswordResetApi resetPasswordRequestPost POST /reset-password/request Request password reset
QuatrixApi.PasswordResetApi resetPasswordResetIdPost POST /reset-password/reset/{id} Reset password
QuatrixApi.PreviewApi filePreviewIdGet GET /file/preview/{id} Get a file preview
QuatrixApi.PreviewApi previewIdGet GET /preview/{id} Get binary preview data
QuatrixApi.ProfileApi profile2faGenerateGet GET /profile/2fa/generate Generate a new 2FA code
QuatrixApi.ProfileApi profileGet GET /profile Get profile metadata
QuatrixApi.ProfileApi profileInfoGet GET /profile/info Retrieve additional profile info
QuatrixApi.ProfileApi profileRemoveMfaPost POST /profile/remove-mfa Disable MFA for the logged-in user
QuatrixApi.ProfileApi profileSetMfaPost POST /profile/set-mfa Enable MFA for the logged-in user
QuatrixApi.ProfileApi profileSetPasswordPost POST /profile/set-password Change profile password
QuatrixApi.ProfileApi profileSetPost POST /profile/set Update profile metadata
QuatrixApi.ProjectFolderApi projectFolderAddUsersIdPost POST /project-folder/add-users/{id} Add users to the project folder
QuatrixApi.ProjectFolderApi projectFolderCreatePost POST /project-folder/create Create a project folder
QuatrixApi.ProjectFolderApi projectFolderDeleteIdGet GET /project-folder/delete/{id} Convert a project folder to a folder
QuatrixApi.ProjectFolderApi projectFolderDeleteUsersPost POST /project-folder/delete-users/ Remove project folder users
QuatrixApi.ProjectFolderApi projectFolderEditUsersIdPost POST /project-folder/edit-users/{id} Update users’ permissions of the project folder
QuatrixApi.ProjectFolderApi projectFolderGet GET /project-folder List available project folders for a logged-in user
QuatrixApi.ProjectFolderApi projectFolderMetadataIdGet GET /project-folder/metadata/{id} Get project folder metadata
QuatrixApi.ProjectFolderApi projectFolderProjectUsersPost POST /project-folder/project-users List all project folders for given users
QuatrixApi.ProjectFolderApi projectFolderSetUsersPost POST /project-folder/set-users Add users to project folders.
QuatrixApi.ProjectFolderApi projectFolderUsersIdGet GET /project-folder/users/{id} List users of the project folder
QuatrixApi.SSHKeyApi sshKeyCreatePost POST /ssh-key/create Create a new SSH key
QuatrixApi.SSHKeyApi sshKeyDeletePost POST /ssh-key/delete Delete SSH key
QuatrixApi.SSHKeyApi sshKeyEditPost POST /ssh-key/edit Edit SSH key metadata
QuatrixApi.SSHKeyApi sshKeyGet GET /ssh-key List available SSH keys
QuatrixApi.SSHKeyApi sshKeyMetadataIdGet GET /ssh-key/metadata/{id} Get SSH key metadata
QuatrixApi.ServiceApi serviceGet GET /service List available services
QuatrixApi.ServiceApi serviceMetadataIdGet GET /service/metadata/{id} Get service metadata
QuatrixApi.ShareApi filesReturnMakedirIdPost POST /files-return/makedir/{id} Create a directory for returned files
QuatrixApi.ShareApi filesReturnMetadataIdGet GET /files-return/metadata/{id} Get return files metadata
QuatrixApi.ShareApi filesReturnSendPost POST /files-return/send Return files in the created share
QuatrixApi.ShareApi filesReturnUploadLinkIdPost POST /files-return/upload-link/{id} Get return files upload link
QuatrixApi.ShareApi quicklinkCreatePost POST /quicklink/create Create a quicklink
QuatrixApi.ShareApi quicklinkLoginPinPost POST /quicklink/login-pin Log in with PIN to access a quicklink
QuatrixApi.ShareApi quicklinkRevokeIdGet GET /quicklink/revoke/{id} Revoke a quicklink
QuatrixApi.ShareApi shareCreatePost POST /share/create Create a file share
QuatrixApi.ShareApi shareDownloadIdGet GET /share/download/{id} Download share files
QuatrixApi.ShareApi shareDownloadInfoIdGet GET /share/download-info/{id} Get share download info
QuatrixApi.ShareApi shareDownloadLinkIdGet GET /share/download-link/{id} Get download link for all files
QuatrixApi.ShareApi shareDownloadLinkIdPost POST /share/download-link/{id} Get download link for specified files
QuatrixApi.ShareApi shareFilesIdGet GET /share/files/{id} List shared files
QuatrixApi.ShareApi shareLoginPinPost POST /share/login-pin Log in with PIN to access a share
QuatrixApi.ShareApi sharePreviewIdGet GET /share/preview/{id} Preview a shared file
QuatrixApi.ShareApi shareRecipientsGet GET /share/recipients List all contacts for the share
QuatrixApi.ShareApi shareRequestPost POST /share/request Send a request to share files
QuatrixApi.ShareApi shareRevokeIdGet GET /share/revoke/{id} Revoke a share
QuatrixApi.ShareApi shareSendRequestIdPost POST /share/send-request/{id} Request files. Use /share/request API call instead.
QuatrixApi.ShareApi trackingGet GET /tracking/ List share actions metadata for all users
QuatrixApi.ShareApi trackingIdGet GET /tracking/{id} List share actions metadata for a user
QuatrixApi.SiteSettingsApi settingsAuthMethodsGet GET /settings/auth-methods Get available authentication methods
QuatrixApi.SiteSettingsApi settingsGet GET /settings Get site settings
QuatrixApi.SiteSettingsApi settingsSetPost POST /settings/set Set site settings
QuatrixApi.SiteSettingsApi settingsUploadLogoLinkGet GET /settings/upload-logo-link Get a new logo upload link
QuatrixApi.UploadApi fileModifyPost POST /file/modify Get file modification link
QuatrixApi.UploadApi settingsUploadLogoLinkGet GET /settings/upload-logo-link Get a new logo upload link
QuatrixApi.UploadApi uploadFinalizeIdGet GET /upload/finalize/{id} Finalize chunked file upload
QuatrixApi.UploadApi uploadLinkPost POST /upload/link Get file upload link
QuatrixApi.UserApi userCreatePost POST /user/create Create a user
QuatrixApi.UserApi userDeletePost POST /user/delete Delete users
QuatrixApi.UserApi userEditPost POST /user/edit Update metadata of users
QuatrixApi.UserApi userGet GET /user List users
QuatrixApi.UserApi userGroupGet GET /user/group List all user groups
QuatrixApi.UserApi userMetadataIdGet GET /user/metadata/{id} Get user metadata
QuatrixApi.UserApi userPgpKeyIdGet GET /user/pgp-key/{id} Get user's PGP key
QuatrixApi.UserApi userRemoveMfaPost POST /user/remove-mfa Disable MFA for users
QuatrixApi.UserApi userResetMfaPost POST /user/reset-mfa Update existing MFA settings for users
QuatrixApi.UserApi userSetMfaPost POST /user/set-mfa Enable MFA for users
QuatrixApi.UserApi userSignupPost POST /user/signup Register a new user
QuatrixApi.WidgetApi widgetFinalizeUploadIdGet GET /widget/finalize-upload/{id} Finalize chunked upload of the widget
QuatrixApi.WidgetApi widgetMetadataIdGet GET /widget/metadata/{id} Get all widget metadata
QuatrixApi.WidgetApi widgetUploadLinkIdPost POST /widget/upload-link/{id} Get widget upload link

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: X-Auth-Token
  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication
You can’t perform that action at this time.