Skip to content

JS-Reference-Updates-1683102475 #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

JS-Reference-Updates-1683102475 #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions guides/reference-guides/javascript-client-reference/accesscontrol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,3 +707,21 @@ accessControl.deleteAccessRequest("djjdshhsuuwewueueuiHYHYYW.......").then(resul
console.log(result)
})
```

## getUserInfo
##### accessControl.getUserInfo([orgName]) ⇒ <code>Promise</code>
-- TerminusX API --
Get the userinfo teams ownership and subscription

**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.

| Param | Type | Description |
| --- | --- | --- |
| [orgName] | <code>string</code> | The organization name. |

**Example**
```javascript
accessControl.getUserInfo().then(result=>{
console.log(result)
})
```
26 changes: 25 additions & 1 deletion guides/reference-guides/javascript-client-reference/typedef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ the PUT document interface query parameters
| Name | Type | Description |
| --- | --- | --- |
| [raw_json] | <code>boolean</code> | default is false, If true, the input documents are treated as raw JSON, inserted as type sys:JSONDocument and are not subject to schema restrictions. |
| [create] | <code>boolean</code> | If true, the function will create a new document if it doesn't exist. |
| [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph. |


Expand All @@ -60,7 +61,7 @@ the DELETE document interface query parameters
| --- | --- | --- |
| [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph. |
| id | <code>string</code> \| <code>array</code> | a single id or a list of ids to delete. |
| [nuke] | <code>booleam</code> | default is false, If true, delete everything at this resource location (dangerous!). |
| [nuke] | <code>boolean</code> | default is false, If true, delete everything at this resource location (dangerous!). |


## GraphRef
Expand Down Expand Up @@ -199,3 +200,26 @@ the manage capability command type
##### RolesActions: ` Array.<ACTIONS>`
[ACTIONS.CREATE_DATABASE | ACTIONS.DELETE_DATABASE]


## DocHistoryParams
##### DocHistoryParams: ` Object`
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| [start] | <code>number</code> | Index to start from, 0 is the default |
| [count] | <code>number</code> | Amount of commits to show, 10 is the default |
| [updated] | <code>boolean</code> | Last updated time (excludes history) false is the default |
| [created] | <code>boolean</code> | Created date of object (excludes history) false is the default |


## DiffObject
##### DiffObject: ` Object`
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| [Object] | <code>keep</code> | Index to start from, 0 is the default |
| [number] | <code>start</code> | Amount of commits to show, 10 is the default |
| [number] | <code>count</code> | Last updated time (excludes history) false is the default |

Loading