ModumMoDsenseApi - JavaScript client for modum_mo_dsense_api Allows you to interact with the modum system This SDK is automatically generated by the OpenAPI Generator project:
- API version: 4.3.2
- Package version: 4.3.2
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://support.modum.io/
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install modum_mo_dsense_api --save
Finally, you need to build the module:
npm run build
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 modum_mo_dsense_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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
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.
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
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var ModumMoDsenseApi = require('modum_mo_dsense_api');
var api = new ModumMoDsenseApi.AccountApi()
var activateAccountRequest = new ModumMoDsenseApi.ActivateAccountRequest(); // {ActivateAccountRequest}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.activateAccount(activateAccountRequest, callback);
All URIs are relative to https://api.trial.modum.io
Class | Method | HTTP request | Description |
---|---|---|---|
ModumMoDsenseApi.AccountApi | activateAccount | POST /auth/activate | Activate new user account |
ModumMoDsenseApi.AccountApi | initializeReset | PUT /auth/reset | Initialize password reset |
ModumMoDsenseApi.AccountApi | login | POST /auth/login | Log in |
ModumMoDsenseApi.AccountApi | refresh | POST /auth/refresh | Refresh authentication token |
ModumMoDsenseApi.AccountApi | resetPassword | POST /auth/reset | Reset password |
ModumMoDsenseApi.CompanyAdminApi | createField | POST /fields | Create a custom field |
ModumMoDsenseApi.CompanyAdminApi | gatewaysGet | GET /gateways | Get list of gateway installation in company |
ModumMoDsenseApi.CompanyAdminApi | listFields | GET /fields | List custom fields |
ModumMoDsenseApi.CompanyAdminApi | updateField | PUT /fields/{fieldId} | Update a custom field |
ModumMoDsenseApi.ComplianceReasonsApi | complianceReasonsGet | GET /compliance-reasons | List of company defined compliance reasons |
ModumMoDsenseApi.ComplianceReasonsApi | complianceReasonsIdGet | GET /compliance-reasons/{id} | Get a single compliance reason |
ModumMoDsenseApi.ComplianceReasonsApi | complianceReasonsIdPut | PUT /compliance-reasons/{id} | Update a compliance reason |
ModumMoDsenseApi.ComplianceReasonsApi | complianceReasonsPost | POST /compliance-reasons | Add compliance reason |
ModumMoDsenseApi.GatewayApi | getGatewayShipmentStatus | POST /gateway/shipments/status | Get status of shipments |
ModumMoDsenseApi.NotificationApi | createEmailNotification | POST /notifications/email | Create an email notification setting |
ModumMoDsenseApi.NotificationApi | createSMSNotification | POST /notifications/sms | Create an SMS notification setting |
ModumMoDsenseApi.NotificationApi | deleteEmailNotification | DELETE /notifications/email | Delete an email notification setting |
ModumMoDsenseApi.NotificationApi | deleteSMSNotification | DELETE /notifications/sms | Delete an SMS notification setting |
ModumMoDsenseApi.NotificationApi | getNotifications | GET /notifications | Get notification settings |
ModumMoDsenseApi.RoleApi | createRole | POST /roles | Create role |
ModumMoDsenseApi.RoleApi | deleteRole | DELETE /roles/{roleId} | Delete role |
ModumMoDsenseApi.RoleApi | listRoles | GET /roles | List existing roles |
ModumMoDsenseApi.RoleApi | updateRole | PUT /roles/{roleId} | Add permissions to a role |
ModumMoDsenseApi.ShipmentApi | acknowledgeError | POST /shipments/{shipmentId}/acknowledge-error | Acknowledge an erroneous shipment |
ModumMoDsenseApi.ShipmentApi | acknowledgeMissing | POST /shipments/{shipmentId}/acknowledge-missing | Acknowledge a missing shipment |
ModumMoDsenseApi.ShipmentApi | addComment | POST /shipments/{shipmentId}/comment | Add a comment |
ModumMoDsenseApi.ShipmentApi | addFields | POST /shipments/{shipmentId}/fields | Add values for custom fields |
ModumMoDsenseApi.ShipmentApi | createProfile | POST /profiles | Create a shipment profile |
ModumMoDsenseApi.ShipmentApi | deleteProfile | DELETE /profiles/{group_id} | Delete a shipment profile |
ModumMoDsenseApi.ShipmentApi | generateCSV | POST /shipments/csv | Generate shipment report(s) in csv format |
ModumMoDsenseApi.ShipmentApi | generatePDF | POST /shipments/pdf | Generate shipment report(s) in pdf format |
ModumMoDsenseApi.ShipmentApi | generateXLSX | POST /shipments/xlsx | Generate shipment report(s) in xlsx format |
ModumMoDsenseApi.ShipmentApi | getAlarms | GET /alarms | Get a list of alarms triggered for the user |
ModumMoDsenseApi.ShipmentApi | getEvents | GET /shipments/{shipmentId}/events | Get shipment change & comments log |
ModumMoDsenseApi.ShipmentApi | getGatewaySessions | GET /shipments/{shipmentId}/gw-sessions | Get time intervals where a shipment was close to a gateway. |
ModumMoDsenseApi.ShipmentApi | getLoggerDataByNonce | GET /logger/{shipmentNonceHex} | Get logger data (temperature data) for shipment |
ModumMoDsenseApi.ShipmentApi | getProfiles | GET /profiles | Get shipment profiles |
ModumMoDsenseApi.ShipmentApi | getShipmentByID | GET /shipments/{shipmentId} | Get shipment by ID |
ModumMoDsenseApi.ShipmentApi | getShipmentStatus | POST /shipments/status | Get status of shipments |
ModumMoDsenseApi.ShipmentApi | getShipments | GET /shipments | Get shipments |
ModumMoDsenseApi.ShipmentApi | getShipmentsOverview | GET /shipments/overview | Get a shipment overview |
ModumMoDsenseApi.ShipmentApi | putShipments | PUT /shipments | Stop a shipment |
ModumMoDsenseApi.ShipmentApi | setCompliant | POST /shipments/{shipmentId}/compliant | Set state to compliant |
ModumMoDsenseApi.ShipmentApi | setNonCompliant | POST /shipments/{shipmentId}/noncompliant | Set state to non-compliant |
ModumMoDsenseApi.ShipmentApi | startShipment | POST /shipments | Start a shipment |
ModumMoDsenseApi.ShipmentApi | updateProfile | PUT /profiles/{group_id} | Create new version of shipment profile |
ModumMoDsenseApi.SystemApi | version | GET /version | Version |
ModumMoDsenseApi.UserApi | changeRoleOfUser | PUT /users/{userId} | Change role of user |
ModumMoDsenseApi.UserApi | getOwnUser | GET /user | Get own user |
ModumMoDsenseApi.UserApi | inviteUser | POST /users | Invite user |
ModumMoDsenseApi.UserApi | listUsers | GET /users | List users |
ModumMoDsenseApi.UserApi | reactivateUser | POST /users/{userId}/reactivate | Reactivate a user |
ModumMoDsenseApi.UserApi | removeUser | DELETE /users/{userId} | Deactivate user account |
ModumMoDsenseApi.UserApi | requestPinChange | POST /users/verification | Request Verification PIN Change |
ModumMoDsenseApi.UserApi | setVerificationPin | PUT /users/verification | Set Verification PIN |
ModumMoDsenseApi.UserApi | updateOwnUser | PUT /users | Update own user account |
- ModumMoDsenseApi.AcknowledgeErrorRequest
- ModumMoDsenseApi.AcknowledgeMissingRequest
- ModumMoDsenseApi.ActivateAccountRequest
- ModumMoDsenseApi.AddCommentRequest
- ModumMoDsenseApi.AddFieldsRequest
- ModumMoDsenseApi.Auth
- ModumMoDsenseApi.ChangePasswordRequest
- ModumMoDsenseApi.ChangeRoleOfUserRequest
- ModumMoDsenseApi.ComplianceReason
- ModumMoDsenseApi.CreateFieldRequest
- ModumMoDsenseApi.Error
- ModumMoDsenseApi.GatewayInstallation
- ModumMoDsenseApi.InitializeResetRequest
- ModumMoDsenseApi.InlineObject
- ModumMoDsenseApi.InlineObject1
- ModumMoDsenseApi.InlineObject2
- ModumMoDsenseApi.InlineResponse200
- ModumMoDsenseApi.InlineResponse2001
- ModumMoDsenseApi.InlineResponse2002
- ModumMoDsenseApi.InlineResponse2003
- ModumMoDsenseApi.InlineResponse400
- ModumMoDsenseApi.InlineResponse403
- ModumMoDsenseApi.InlineResponse404
- ModumMoDsenseApi.InviteUserRequest
- ModumMoDsenseApi.Language
- ModumMoDsenseApi.NotificationRequest
- ModumMoDsenseApi.Permission
- ModumMoDsenseApi.Profile
- ModumMoDsenseApi.PutShipmentsRequest
- ModumMoDsenseApi.ReadoutRequest
- ModumMoDsenseApi.ResetPasswordRequest
- ModumMoDsenseApi.Role
- ModumMoDsenseApi.SetCompliantRequest
- ModumMoDsenseApi.SetNonCompliantRequest
- ModumMoDsenseApi.ShipmentsShipmentIdEventsNotifications
- ModumMoDsenseApi.StartShipmentRequest
- ModumMoDsenseApi.State
- ModumMoDsenseApi.UpdateFieldRequest
- ModumMoDsenseApi.UpdateownUserRequest
- ModumMoDsenseApi.User
- Type: Bearer authentication (JWT)