@@ -648,141 +648,6 @@ update the database details
648
648
| dbDoc | <code>object</code> | an object that describe the database details |
649
649
650
650
651
- ### createUser
652
- #### woqlClient.createUser(userId, userDoc) ⇒ <code>Promise</code>
653
- For creating an user
654
-
655
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
656
-
657
- | Param | Type | Description |
658
- | --- | --- | --- |
659
- | userId | <code>string</code> | the userId |
660
- | userDoc | <code>object</code> | the user's object description |
661
-
662
-
663
- ### getUser
664
- #### woqlClient.getUser(userId) ⇒ <code>Promise</code>
665
- Get the logged user details.
666
-
667
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
668
-
669
- | Param | Type |
670
- | --- | --- |
671
- | userId | <code>string</code> |
672
-
673
-
674
- ### updateUser
675
- #### woqlClient.updateUser(userId, userDoc) ⇒ <code>Promise</code>
676
- Update an user from the database.
677
-
678
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
679
-
680
- | Param | Type | Description |
681
- | --- | --- | --- |
682
- | userId | <code>string</code> | |
683
- | userDoc | <code>object</code> | User Object details |
684
-
685
-
686
- ### deleteUser
687
- #### woqlClient.deleteUser(userId) ⇒ <code>Promise</code>
688
- Delete an user from the database Only a user with DBA authority can delete a user.
689
-
690
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
691
-
692
- | Param | Type |
693
- | --- | --- |
694
- | userId | <code>string</code> |
695
-
696
-
697
- ### createOrganization
698
- #### woqlClient.createOrganization(orgId, orgDoc) ⇒ <code>Promise</code>
699
- Create a new organization for the registered user
700
-
701
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
702
-
703
- | Param | Type | Description |
704
- | --- | --- | --- |
705
- | orgId | <code>string</code> | the organization id |
706
- | orgDoc | <code>object</code> | An object that describe the organization's details |
707
-
708
-
709
- ### setOrganizationRoles
710
- #### woqlClient.setOrganizationRoles(orgId, orgDoc) ⇒ <code>Promise</code>
711
- Create a new organization for the registered user
712
-
713
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
714
-
715
- | Param | Type | Description |
716
- | --- | --- | --- |
717
- | orgId | <code>string</code> | the organization id |
718
- | orgDoc | <code>object</code> | An object that describe the organization's details |
719
-
720
-
721
- ### getOrganization
722
- #### woqlClient.getOrganization(orgId, [action]) ⇒ <code>Promise</code>
723
- Gets all the information about the given organization
724
-
725
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
726
-
727
- | Param | Type | Description |
728
- | --- | --- | --- |
729
- | orgId | <code>string</code> | the organization id |
730
- | [action] | <code>string</code> | set an action like recommendations | invitations | collaborators |
731
-
732
-
733
- ### updateOrganization
734
- #### woqlClient.updateOrganization(orgId, orgDoc) ⇒ <code>Promise</code>
735
- only if you have the permission you can delete an organization
736
- Before you can delete the organization, you must first remove all accounts and databases
737
- from the organization
738
-
739
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
740
-
741
- | Param | Type | Description |
742
- | --- | --- | --- |
743
- | orgId | <code>string</code> | the organization id |
744
- | orgDoc | <code>object</code> | the organization details description |
745
-
746
-
747
- ### deleteOrganization
748
- #### woqlClient.deleteOrganization(orgId) ⇒ <code>Promise</code>
749
- only if you have the permission you can delete an organization
750
- Before you can delete the organization, you must first remove all accounts and databases
751
- from the organization
752
-
753
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
754
-
755
- | Param | Type | Description |
756
- | --- | --- | --- |
757
- | orgId | <code>string</code> | the organization id |
758
-
759
-
760
- ### getRoles
761
- #### woqlClient.getRoles([userId], [orgId], [dbId]) ⇒ <code>Promise</code>
762
- get all the user roles (for the current logged user)
763
- or the user roles for a specific database and user
764
- (the logged used need to have the permission to see the roles info for another user)
765
-
766
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
767
-
768
- | Param | Type | Description |
769
- | --- | --- | --- |
770
- | [userId] | <code>string</code> | the user id |
771
- | [orgId] | <code>string</code> | the organization id |
772
- | [dbId] | <code>string</code> | the dbId |
773
-
774
-
775
- ### updateRoles
776
- #### woqlClient.updateRoles(newRolesObj) ⇒ <code>Promise</code>
777
- Change the user role for existing users in your organization, including your own
778
-
779
- **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.
780
-
781
- | Param | Type |
782
- | --- | --- |
783
- | newRolesObj | <code>typedef.RolesObj</code> |
784
-
785
-
786
651
### addDocument
787
652
#### woqlClient.addDocument(json, [params], [dbId], [string]) ⇒ <code>Promise</code>
788
653
to add a new document or a list of new documents into the instance or the schema graph.
0 commit comments