0.1.2-rc.1 • Published 5 years ago
gofreta-client v0.1.2-rc.1
Gofreta JS API client
The project is still in very early stage of development and is not recommended to be used in production environment, unless you really know what you are doing!
Simple and compact (~5kb gzip) Gofreta JS API client for the browser and node.js (based on axios HTTP client).
Install
Using npm
npm install gofreta-client --saveES6-style import supported:
import Client from 'gofreta-client'Manual
<script src="/path/to/dist/client.min.js"></script>Example
var clientInst = new Client('my_api_url')
clientInst.Auth.Login("username", "password").then(function (data) {
// success...
// (see axios response schema - https://github.com/axios/axios#response-schema)
}).catch(function (e) {
// error...
})Development
# build and minify for production
npm run build
# run unit tests
npm testUsage
| Name | Return | Description |
|---|---|---|
var client = new Client(baseUrl = '', token = '', httpConfig = {}) | Client | Initializes new Client instance. |
client.setToken(token = '') | Client | Sets or remove authorization token header. |
List with available resources (each returns a Promise object):
| Name | Description | Authentication |
|---|---|---|
| Auth | ||
client.Auth.login(username, password, bodyParams = {}, queryParams = {}) | Authenticates an user and generates new Auth token. | N/A |
client.Auth.sendResetPasswordEmail(username, bodyParams = {}, queryParams = {}) | Sends a reset user password email. | N/A |
client.Auth.resetPassword(resetPasswordHash, password, passwordConfirm, bodyParams = {}, queryParams = {}) | Resets a forgotten user password. | N/A |
| Language | ||
client.Language.getList(page = 1, limit = 20, queryParams = {}) | Gets a paginated Language models list. | User or Key token |
client.Language.getOne(id, queryParams = {}) | Gets a single Language model. | User or Key token |
client.Language.create(bodyParams = {}, queryParams = {}) | Creates a new Language model. | User or Key token |
client.Language.update(id, bodyParams = {}, queryParams = {}) | Updates an existing Language model. | User or Key token |
client.Language.delete(id, bodyParams = {}, queryParams = {}) | Deletes an existing Language model. | User or Key token |
| Media | ||
client.Media.getList(page = 1, limit = 20, queryParams = {}) | Gets a paginated Media models list. | User or Key token |
client.Media.getOne(id, queryParams = {}) | Gets a single Media model. | User or Key token |
client.Media.update(id, title, description, bodyParams = {}, queryParams = {}) | Updates an existing Media model meta properties. | User or Key token |
client.Media.delete(id, bodyParams = {}, queryParams = {}) | Deletes an existing Media model. | User or Key token |
| User | ||
client.User.getList(page = 1, limit = 20, queryParams = {}) | Gets a paginated User models list. | User token |
client.User.getOne(id, queryParams = {}) | Gets a single User model. | User token |
client.User.create(bodyParams = {}, queryParams = {}) | Creates a new User model. | User token |
client.User.update(id, bodyParams = {}, queryParams = {}) | Updates an existing User model. | User token |
client.User.delete(id, bodyParams = {}, queryParams = {}) | Deletes an existing User model. | User token |
| Key | ||
client.Key.getList(page = 1, limit = 20, queryParams = {}) | Gets a paginated Key models list. | User token |
client.Key.getOne(id, queryParams = {}) | Gets a single Key model. | User token |
client.Key.create(bodyParams = {}, queryParams = {}) | Creates a new Key model. | User token |
client.Key.update(id, bodyParams = {}, queryParams = {}) | Updates an existing Key model. | User token |
client.Key.delete(id, bodyParams = {}, queryParams = {}) | Deletes an existing Key model. | User token |
| Collection | ||
client.Collection.getList(page = 1, limit = 20, queryParams = {}) | Gets a paginated Collection models list. | User token |
client.Collection.getOne(identifier, queryParams = {}) | Gets a single Collection model. | User token |
client.Collection.create(bodyParams = {}, queryParams = {}) | Creates a new Collection model. | User token |
client.Collection.update(identifier, bodyParams = {}, queryParams = {}) | Updates an existing Collection model. | User token |
client.Collection.delete(identifier, bodyParams = {}, queryParams = {}) | Deletes an existing Collection model and all its related entities. | User token |
| Entity | ||
client.Entity.getList(collectionIdentifier, page = 1, limit = 20, queryParams = {}) | Gets a paginated Entity models list. | User or Key token |
client.Entity.getOne(collectionIdentifier, id, queryParams = {}) | Gets a single Entity model. | User or Key token |
client.Entity.create(collectionIdentifier, bodyParams = {}, queryParams = {}) | Creates a new Entity model. | User or Key token |
client.Entity.update(collectionIdentifier, id, bodyParams = {}, queryParams = {}) | Updates an existing Entity model. | User or Key token |
client.Entity.delete(collectionIdentifier, id, bodyParams = {}, queryParams = {}) | Deletes an existing Entity model. | User or Key token |
Credits
Gofreta JS API client is part of Gofreta - an Open Source project licensed under the BSD3-License.
Help us improve and continue the project development - https://gofreta.com/support-us