@topoos/files

Files - JavaScript client for @topoos/files No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.2.1
• Package version: 1.0.1
• Build package: org.openapitools.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 @topoos/files --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 @topoos/files 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/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):

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 Files = require('@topoos/files');

// TOPOOS URL, or url where FilesServer is running.
// defaultClient.basePath = 'https://api.topoos.com/files/1.0.0'.replace(/\/+$/, '');

var defaultClient = Files.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearerToken
var bearerToken = defaultClient.authentications['bearerToken'];
bearerToken.accessToken = "YOUR ACCESS TOKEN";

// Configure API key authorization: customAuth
var customAuth = defaultClient.authentications['customAuth'];
customAuth.apiKey = "YOUR API KEY";

// Configure api key for authorization
var default = defaultClient.authentications['apiKey'];
default.accessToken = "YOUR API KEY";

var api = new Files.FicherosApi();
var id = "id_example"; // {String} Identificador único del archivo previamente registrado
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};



var id = "id_example"; // {String} Unique identifier of a previously registered file.
api.getFile(id, null, callback);	// GET Simple

let optsGET = {
    'width': 200, // Number | Width to which you want to resize the image.
    'height': 400, // Number | Height to which you want to resize the image.
    'dpi': 72, // Number | Dpi to which you want to resize the image.
    'mode': fit // String | Resize mode.
  };
api.getFile(id, optsGET, callback);	// GET with Resize



let optsPOST = {
  'file': "./exampleFiles/01.jpg" // File
};
let optsPUT = {
  'file': "./exampleFiles/02.jpg" // File
};

apiInstance.postFile(optsPOST, callback);
apiInstance.putFile(id, optsPUT, callback);

Documentation for API Endpoints

All URIs are relative to https://api.topoos.com/files/1.0.0

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Files.FicherosApi | deleteFile | DELETE /files/{_id} | Files.FicherosApi | getFile | GET /files/{_id} | Files.FicherosApi | postFile | POST /files | Files.FicherosApi | putFile | PUT /files/{_id} |

Documentation for Models

• Files.Error
• Files.ErrorError
• Files.ErrorErrorErrors
• Files.InlineObject
• Files.InlineObject1

Documentation for Authorization

apiKey

• Type: API key
• API key parameter name: apikey
• Location: URL query string

bearerToken

• Type: Bearer authentication (JWT)

customAuth

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

default

• Type: OAuth
• Flow: implicit
• Authorization URL: https://test.com
• Scopes: N/A