Skip to content

Commit 73ddffc

Browse files
Add model docs
1 parent ba4de79 commit 73ddffc

File tree

2,755 files changed

+83767
-3767
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,755 files changed

+83767
-3767
lines changed

ce/docs/AccountTwoFaSettings.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
# AccountTwoFaSettings
3+
4+
`org.thingsboard.client.model.AccountTwoFaSettings`
5+
6+
Account Two-Factor Authentication Settings
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
| **configs** | **Map\<String, TwoFaAccountConfig\>** | | [optional] |
13+
14+
15+
16+
---
17+
18+
### Conventions
19+
20+
- **Package:** `org.thingsboard.client.model`
21+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
22+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
23+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
24+

ce/docs/Action.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# Action
3+
4+
`org.thingsboard.client.model.Action`
5+
6+
## Enum Values
7+
8+
9+
* `ASSIGNED` (value: `"ASSIGNED"`)
10+
11+
* `UNASSIGNED` (value: `"UNASSIGNED"`)
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

ce/docs/ActionStatus.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# ActionStatus
3+
4+
`org.thingsboard.client.model.ActionStatus`
5+
6+
## Enum Values
7+
8+
9+
* `SUCCESS` (value: `"SUCCESS"`)
10+
11+
* `FAILURE` (value: `"FAILURE"`)
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

ce/docs/ActionType.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
2+
# ActionType
3+
4+
`org.thingsboard.client.model.ActionType`
5+
6+
## Enum Values
7+
8+
9+
* `ADDED` (value: `"ADDED"`)
10+
11+
* `DELETED` (value: `"DELETED"`)
12+
13+
* `UPDATED` (value: `"UPDATED"`)
14+
15+
* `ATTRIBUTES_UPDATED` (value: `"ATTRIBUTES_UPDATED"`)
16+
17+
* `ATTRIBUTES_DELETED` (value: `"ATTRIBUTES_DELETED"`)
18+
19+
* `TIMESERIES_UPDATED` (value: `"TIMESERIES_UPDATED"`)
20+
21+
* `TIMESERIES_DELETED` (value: `"TIMESERIES_DELETED"`)
22+
23+
* `RPC_CALL` (value: `"RPC_CALL"`)
24+
25+
* `CREDENTIALS_UPDATED` (value: `"CREDENTIALS_UPDATED"`)
26+
27+
* `ASSIGNED_TO_CUSTOMER` (value: `"ASSIGNED_TO_CUSTOMER"`)
28+
29+
* `UNASSIGNED_FROM_CUSTOMER` (value: `"UNASSIGNED_FROM_CUSTOMER"`)
30+
31+
* `ACTIVATED` (value: `"ACTIVATED"`)
32+
33+
* `SUSPENDED` (value: `"SUSPENDED"`)
34+
35+
* `CREDENTIALS_READ` (value: `"CREDENTIALS_READ"`)
36+
37+
* `ATTRIBUTES_READ` (value: `"ATTRIBUTES_READ"`)
38+
39+
* `RELATION_ADD_OR_UPDATE` (value: `"RELATION_ADD_OR_UPDATE"`)
40+
41+
* `RELATION_DELETED` (value: `"RELATION_DELETED"`)
42+
43+
* `RELATIONS_DELETED` (value: `"RELATIONS_DELETED"`)
44+
45+
* `REST_API_RULE_ENGINE_CALL` (value: `"REST_API_RULE_ENGINE_CALL"`)
46+
47+
* `ALARM_ACK` (value: `"ALARM_ACK"`)
48+
49+
* `ALARM_CLEAR` (value: `"ALARM_CLEAR"`)
50+
51+
* `ALARM_DELETE` (value: `"ALARM_DELETE"`)
52+
53+
* `ALARM_ASSIGNED` (value: `"ALARM_ASSIGNED"`)
54+
55+
* `ALARM_UNASSIGNED` (value: `"ALARM_UNASSIGNED"`)
56+
57+
* `LOGIN` (value: `"LOGIN"`)
58+
59+
* `LOGOUT` (value: `"LOGOUT"`)
60+
61+
* `LOCKOUT` (value: `"LOCKOUT"`)
62+
63+
* `ASSIGNED_FROM_TENANT` (value: `"ASSIGNED_FROM_TENANT"`)
64+
65+
* `ASSIGNED_TO_TENANT` (value: `"ASSIGNED_TO_TENANT"`)
66+
67+
* `PROVISION_SUCCESS` (value: `"PROVISION_SUCCESS"`)
68+
69+
* `PROVISION_FAILURE` (value: `"PROVISION_FAILURE"`)
70+
71+
* `ASSIGNED_TO_EDGE` (value: `"ASSIGNED_TO_EDGE"`)
72+
73+
* `UNASSIGNED_FROM_EDGE` (value: `"UNASSIGNED_FROM_EDGE"`)
74+
75+
* `ADDED_COMMENT` (value: `"ADDED_COMMENT"`)
76+
77+
* `UPDATED_COMMENT` (value: `"UPDATED_COMMENT"`)
78+
79+
* `DELETED_COMMENT` (value: `"DELETED_COMMENT"`)
80+
81+
* `SMS_SENT` (value: `"SMS_SENT"`)
82+
83+
84+
85+
---
86+
87+
### Conventions
88+
89+
- **Package:** `org.thingsboard.client.model`
90+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
91+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
92+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
93+

ce/docs/ActivateUserRequest.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
# ActivateUserRequest
3+
4+
`org.thingsboard.client.model.ActivateUserRequest`
5+
6+
Activate user request.
7+
8+
## Properties
9+
10+
| Name | Type | Description | Notes |
11+
|------------ | ------------- | ------------- | -------------|
12+
| **activateToken** | **String** | The activate token to verify | [optional] |
13+
| **password** | **String** | The new password to set | [optional] |
14+
15+
16+
17+
---
18+
19+
### Conventions
20+
21+
- **Package:** `org.thingsboard.client.model`
22+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
23+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
24+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
25+

0 commit comments

Comments
 (0)