@teemill/dashboard-user
v1.14.0
Published
OpenAPI client for @teemill/dashboard-user
Readme
@teemill/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @teemill/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- UsersApi | bulkUpdateNotifications | PATCH /omnis/v3/dashboard/user/notifications/bulk-update | Bulk update notifications UsersApi | changePassword | PATCH /omnis/v3/dashboard/user/change-password | Change the password UsersApi | confirmPassword | POST /omnis/v3/dashboard/user/confirm-password | Confirm the users password UsersApi | createSetPasswordToken | POST /omnis/v3/dashboard/user/set-password-token | Create a set password token UsersApi | createUser | POST /omnis/v3/dashboard/user | Create a user UsersApi | deleteNotification | DELETE /omnis/v3/dashboard/user/notifications/{notificationId} | Delete notification UsersApi | forgotPassword | POST /omnis/v3/dashboard/user/forgot-password | initiates reset password flow UsersApi | get2FASecret | GET /omnis/v3/dashboard/user/2fa/secret | Get 2FA secret UsersApi | getNotifications | GET /omnis/v3/dashboard/user/notifications | Get notifications UsersApi | getPasswordReset | GET /omnis/v3/dashboard/user/reset-password/{resetPasswordToken} | gets the password reset token and sets in session UsersApi | getToken | POST /omnis/v3/dashboard/user/token | Get the user token UsersApi | getUser | GET /omnis/v3/dashboard/user | Get the user UsersApi | inviteAccepted | GET /omnis/v3/dashboard/user/accept-invite/{token} | Accepts an invite to an entity UsersApi | login | POST /omnis/v3/dashboard/user/login | Login user UsersApi | logout | POST /omnis/v3/dashboard/user/logout | Log a user out UsersApi | readAllNotifications | PUT /omnis/v3/dashboard/user/notifications/read-all | Read all notifications UsersApi | readNotification | PUT /omnis/v3/dashboard/user/notifications/{notificationId}/read | Read notification UsersApi | resetPassword | POST /omnis/v3/dashboard/user/reset-password | resets password UsersApi | sendVerificationEmail | POST /omnis/v3/dashboard/user/send-verification-email | Send verification email UsersApi | setPassword | POST /omnis/v3/dashboard/user/set-password | sets password UsersApi | setup2FA | POST /omnis/v3/dashboard/user/2fa/setup | Setup 2FA UsersApi | subscribeToPushNotifications | POST /omnis/v3/dashboard/user/push/subscription | Subscribe to push notifications UsersApi | updateUser | PATCH /omnis/v3/dashboard/user | Update the user
Documentation For Models
- ApiError
- Avatar
- BulkUpdateNotificationsRequest
- BulkUpdateNotificationsRequestNotificationsInner
- ChangePassword
- ChangePassword422Response
- ChangePassword422ResponseErrors
- ConfirmPassword422Response
- ConfirmPassword422ResponseErrors
- ConfirmPasswordRequest
- CreateSetPasswordToken422Response
- CreateSetPasswordToken422ResponseErrors
- CreateUser
- CreateUser422Response
- CreateUser422ResponseErrors
- ForgotPassword422Response
- ForgotPassword422ResponseErrors
- ForgotPasswordRequest
- Get2FASecret200Response
- GetNotifications200Response
- GetToken200Response
- Login
- Login422Response
- Login422ResponseErrors
- Notification
- ResetPassword
- ResetPassword422Response
- ResetPassword422ResponseErrors
- SetPassword
- SetPassword422Response
- SetPassword422ResponseErrors
- Setup2FA
- Setup2FA201Response
- Setup2FA422Response
- Setup2FA422ResponseErrors
- SetupMethod
- SubscribeToPushNotificationsRequest
- SubscribeToPushNotificationsRequestSubscription
- SubscribeToPushNotificationsRequestSubscriptionKeys
- TwoFactorAuthentication
- UpdateUser
- UpdateUser422Response
- UpdateUser422ResponseErrors
- User
- UserSignedPlatformTermsLogsInner
Documentation For Authorization
Endpoints do not require authorization.
