@rasadov/lumoar-sdk 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +60 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/api.ts +5133 -0
- package/base.ts +86 -0
- package/common.ts +150 -0
- package/configuration.ts +228 -0
- package/dist/api.d.ts +3329 -0
- package/dist/api.js +3498 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +60 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +149 -0
- package/dist/configuration.d.ts +125 -0
- package/dist/configuration.js +124 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +15 -0
- package/docs/AuthApi.md +560 -0
- package/docs/AuthenticationSuccess.md +25 -0
- package/docs/CheckoutSessionResponse.md +22 -0
- package/docs/CompanyApi.md +363 -0
- package/docs/CompanyCreate.md +44 -0
- package/docs/CompanyInDBBase.md +48 -0
- package/docs/CompanyUpdate.md +42 -0
- package/docs/CompanyWithControls.md +50 -0
- package/docs/CompanyWithRoles.md +50 -0
- package/docs/ComplianceGoal.md +8 -0
- package/docs/ControlStatus.md +18 -0
- package/docs/ControlWithEvidences.md +30 -0
- package/docs/ControlWithRelationships.md +32 -0
- package/docs/ControlsApi.md +124 -0
- package/docs/CustomerDoesNotExist.md +20 -0
- package/docs/CustomerPortalSession.md +20 -0
- package/docs/DefaultApi.md +183 -0
- package/docs/Details.md +20 -0
- package/docs/EvidenceApi.md +309 -0
- package/docs/EvidenceBase.md +40 -0
- package/docs/EvidenceFileSchema.md +32 -0
- package/docs/EvidenceTextSchema.md +24 -0
- package/docs/FileDownload.md +26 -0
- package/docs/FrameworkControlsBase.md +26 -0
- package/docs/GetControl.md +22 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/InviteToCompany.md +24 -0
- package/docs/LoginSchema.md +25 -0
- package/docs/PaymentsApi.md +164 -0
- package/docs/PermissionType.md +14 -0
- package/docs/PoliciesApi.md +302 -0
- package/docs/PolicyCreate.md +26 -0
- package/docs/PolicyRead.md +32 -0
- package/docs/PolicyUpdate.md +24 -0
- package/docs/RegisterSchema.md +31 -0
- package/docs/RemoveFromCompany.md +22 -0
- package/docs/ResponseGetCheckoutSessionPaymentsCheckoutGet.md +24 -0
- package/docs/ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet.md +22 -0
- package/docs/RolesApi.md +127 -0
- package/docs/RolesWithUser.md +22 -0
- package/docs/UpdateControlSchema.md +24 -0
- package/docs/UpdatePassword.md +22 -0
- package/docs/UserApi.md +280 -0
- package/docs/UserBase.md +24 -0
- package/docs/UserInDBBase.md +30 -0
- package/docs/UserPermissionsWithCompany.md +22 -0
- package/docs/UserRole.md +20 -0
- package/docs/UserUpdate.md +24 -0
- package/docs/UserWithRelations.md +28 -0
- package/docs/ValidationError.md +24 -0
- package/docs/ValidationErrorLocInner.md +18 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/openapitools.json +7 -0
- package/package.json +33 -0
- package/tsconfig.json +14 -0
|
@@ -0,0 +1,302 @@
|
|
|
1
|
+
# PoliciesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createPolicyV1PoliciesCreatePost**](#createpolicyv1policiescreatepost) | **POST** /v1/policies/create | Create Policy|
|
|
8
|
+
|[**deletePolicyV1PoliciesPolicyIdDelete**](#deletepolicyv1policiespolicyiddelete) | **DELETE** /v1/policies/{policy_id} | Delete Policy|
|
|
9
|
+
|[**getCompanyPoliciesV1PoliciesCompanyCompanyIdGet**](#getcompanypoliciesv1policiescompanycompanyidget) | **GET** /v1/policies/company/{company_id} | Get Company Policies|
|
|
10
|
+
|[**getPolicyV1PoliciesPolicyIdGet**](#getpolicyv1policiespolicyidget) | **GET** /v1/policies/{policy_id} | Get Policy|
|
|
11
|
+
|[**updatePolicyV1PoliciesPolicyIdPut**](#updatepolicyv1policiespolicyidput) | **PUT** /v1/policies/{policy_id} | Update Policy|
|
|
12
|
+
|
|
13
|
+
# **createPolicyV1PoliciesCreatePost**
|
|
14
|
+
> PolicyRead createPolicyV1PoliciesCreatePost(policyCreate)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
PoliciesApi,
|
|
22
|
+
Configuration,
|
|
23
|
+
PolicyCreate
|
|
24
|
+
} from './api';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new PoliciesApi(configuration);
|
|
28
|
+
|
|
29
|
+
let policyCreate: PolicyCreate; //
|
|
30
|
+
let authorization: string; // (optional) (default to undefined)
|
|
31
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.createPolicyV1PoliciesCreatePost(
|
|
34
|
+
policyCreate,
|
|
35
|
+
authorization,
|
|
36
|
+
sessionId
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **policyCreate** | **PolicyCreate**| | |
|
|
45
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
46
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
**PolicyRead**
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
No authorization required
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: application/json
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**201** | Successful Response | - |
|
|
67
|
+
|**422** | Validation Error | - |
|
|
68
|
+
|
|
69
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
70
|
+
|
|
71
|
+
# **deletePolicyV1PoliciesPolicyIdDelete**
|
|
72
|
+
> deletePolicyV1PoliciesPolicyIdDelete()
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
PoliciesApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from './api';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new PoliciesApi(configuration);
|
|
85
|
+
|
|
86
|
+
let policyId: string; // (default to undefined)
|
|
87
|
+
let authorization: string; // (optional) (default to undefined)
|
|
88
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.deletePolicyV1PoliciesPolicyIdDelete(
|
|
91
|
+
policyId,
|
|
92
|
+
authorization,
|
|
93
|
+
sessionId
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **policyId** | [**string**] | | defaults to undefined|
|
|
102
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
103
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
void (empty response body)
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
No authorization required
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: Not defined
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### HTTP response details
|
|
121
|
+
| Status code | Description | Response headers |
|
|
122
|
+
|-------------|-------------|------------------|
|
|
123
|
+
|**204** | Successful Response | - |
|
|
124
|
+
|**422** | Validation Error | - |
|
|
125
|
+
|
|
126
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
127
|
+
|
|
128
|
+
# **getCompanyPoliciesV1PoliciesCompanyCompanyIdGet**
|
|
129
|
+
> Array<PolicyRead> getCompanyPoliciesV1PoliciesCompanyCompanyIdGet()
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### Example
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
import {
|
|
136
|
+
PoliciesApi,
|
|
137
|
+
Configuration
|
|
138
|
+
} from './api';
|
|
139
|
+
|
|
140
|
+
const configuration = new Configuration();
|
|
141
|
+
const apiInstance = new PoliciesApi(configuration);
|
|
142
|
+
|
|
143
|
+
let companyId: string; // (default to undefined)
|
|
144
|
+
let skip: number; //Number of records to skip for pagination (optional) (default to 0)
|
|
145
|
+
let limit: number; //Maximum number of records to return (optional) (default to 100)
|
|
146
|
+
let authorization: string; // (optional) (default to undefined)
|
|
147
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
148
|
+
|
|
149
|
+
const { status, data } = await apiInstance.getCompanyPoliciesV1PoliciesCompanyCompanyIdGet(
|
|
150
|
+
companyId,
|
|
151
|
+
skip,
|
|
152
|
+
limit,
|
|
153
|
+
authorization,
|
|
154
|
+
sessionId
|
|
155
|
+
);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **companyId** | [**string**] | | defaults to undefined|
|
|
163
|
+
| **skip** | [**number**] | Number of records to skip for pagination | (optional) defaults to 0|
|
|
164
|
+
| **limit** | [**number**] | Maximum number of records to return | (optional) defaults to 100|
|
|
165
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
166
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### Return type
|
|
170
|
+
|
|
171
|
+
**Array<PolicyRead>**
|
|
172
|
+
|
|
173
|
+
### Authorization
|
|
174
|
+
|
|
175
|
+
No authorization required
|
|
176
|
+
|
|
177
|
+
### HTTP request headers
|
|
178
|
+
|
|
179
|
+
- **Content-Type**: Not defined
|
|
180
|
+
- **Accept**: application/json
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
### HTTP response details
|
|
184
|
+
| Status code | Description | Response headers |
|
|
185
|
+
|-------------|-------------|------------------|
|
|
186
|
+
|**200** | Successful Response | - |
|
|
187
|
+
|**422** | Validation Error | - |
|
|
188
|
+
|
|
189
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
190
|
+
|
|
191
|
+
# **getPolicyV1PoliciesPolicyIdGet**
|
|
192
|
+
> PolicyRead getPolicyV1PoliciesPolicyIdGet()
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
### Example
|
|
196
|
+
|
|
197
|
+
```typescript
|
|
198
|
+
import {
|
|
199
|
+
PoliciesApi,
|
|
200
|
+
Configuration
|
|
201
|
+
} from './api';
|
|
202
|
+
|
|
203
|
+
const configuration = new Configuration();
|
|
204
|
+
const apiInstance = new PoliciesApi(configuration);
|
|
205
|
+
|
|
206
|
+
let policyId: string; // (default to undefined)
|
|
207
|
+
|
|
208
|
+
const { status, data } = await apiInstance.getPolicyV1PoliciesPolicyIdGet(
|
|
209
|
+
policyId
|
|
210
|
+
);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Parameters
|
|
214
|
+
|
|
215
|
+
|Name | Type | Description | Notes|
|
|
216
|
+
|------------- | ------------- | ------------- | -------------|
|
|
217
|
+
| **policyId** | [**string**] | | defaults to undefined|
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
**PolicyRead**
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
No authorization required
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: Not defined
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### HTTP response details
|
|
235
|
+
| Status code | Description | Response headers |
|
|
236
|
+
|-------------|-------------|------------------|
|
|
237
|
+
|**200** | Successful Response | - |
|
|
238
|
+
|**422** | Validation Error | - |
|
|
239
|
+
|
|
240
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
241
|
+
|
|
242
|
+
# **updatePolicyV1PoliciesPolicyIdPut**
|
|
243
|
+
> PolicyRead updatePolicyV1PoliciesPolicyIdPut(policyUpdate)
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
### Example
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
import {
|
|
250
|
+
PoliciesApi,
|
|
251
|
+
Configuration,
|
|
252
|
+
PolicyUpdate
|
|
253
|
+
} from './api';
|
|
254
|
+
|
|
255
|
+
const configuration = new Configuration();
|
|
256
|
+
const apiInstance = new PoliciesApi(configuration);
|
|
257
|
+
|
|
258
|
+
let policyId: string; // (default to undefined)
|
|
259
|
+
let policyUpdate: PolicyUpdate; //
|
|
260
|
+
let authorization: string; // (optional) (default to undefined)
|
|
261
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
262
|
+
|
|
263
|
+
const { status, data } = await apiInstance.updatePolicyV1PoliciesPolicyIdPut(
|
|
264
|
+
policyId,
|
|
265
|
+
policyUpdate,
|
|
266
|
+
authorization,
|
|
267
|
+
sessionId
|
|
268
|
+
);
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
|
|
273
|
+
|Name | Type | Description | Notes|
|
|
274
|
+
|------------- | ------------- | ------------- | -------------|
|
|
275
|
+
| **policyUpdate** | **PolicyUpdate**| | |
|
|
276
|
+
| **policyId** | [**string**] | | defaults to undefined|
|
|
277
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
278
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
**PolicyRead**
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
No authorization required
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: application/json
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
### HTTP response details
|
|
296
|
+
| Status code | Description | Response headers |
|
|
297
|
+
|-------------|-------------|------------------|
|
|
298
|
+
|**200** | Successful Response | - |
|
|
299
|
+
|**422** | Validation Error | - |
|
|
300
|
+
|
|
301
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
302
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PolicyCreate
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Name of the policy | [default to undefined]
|
|
9
|
+
**type** | **string** | Type of policy (e.g., \'security\', \'privacy\') | [default to undefined]
|
|
10
|
+
**content** | **{ [key: string]: any; }** | Policy content as a JSON object | [default to undefined]
|
|
11
|
+
**company_id** | **string** | UUID of the company this policy belongs to | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PolicyCreate } from './api';
|
|
17
|
+
|
|
18
|
+
const instance: PolicyCreate = {
|
|
19
|
+
name,
|
|
20
|
+
type,
|
|
21
|
+
content,
|
|
22
|
+
company_id,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# PolicyRead
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique identifier for the policy | [default to undefined]
|
|
9
|
+
**name** | **string** | Name of the policy | [default to undefined]
|
|
10
|
+
**type** | **string** | Type of policy | [default to undefined]
|
|
11
|
+
**content** | **{ [key: string]: any; }** | Policy content | [default to undefined]
|
|
12
|
+
**company_id** | **string** | UUID of the associated company | [default to undefined]
|
|
13
|
+
**created_by** | **string** | UUID of the user who created the policy | [default to undefined]
|
|
14
|
+
**created_at** | **string** | Timestamp when the policy was created | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { PolicyRead } from './api';
|
|
20
|
+
|
|
21
|
+
const instance: PolicyRead = {
|
|
22
|
+
id,
|
|
23
|
+
name,
|
|
24
|
+
type,
|
|
25
|
+
content,
|
|
26
|
+
company_id,
|
|
27
|
+
created_by,
|
|
28
|
+
created_at,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PolicyUpdate
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**content** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PolicyUpdate } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: PolicyUpdate = {
|
|
18
|
+
name,
|
|
19
|
+
type,
|
|
20
|
+
content,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# RegisterSchema
|
|
2
|
+
|
|
3
|
+
Register schema for user registration. Attributes: - email: EmailStr - password: SecretStr - password_repeat: SecretStr - name: str | None - phone: str | None - turnstile_token: str
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
|
+
**password** | **string** | | [default to undefined]
|
|
11
|
+
**turnstile_token** | **string** | | [default to undefined]
|
|
12
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**password_repeat** | **string** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { RegisterSchema } from './api';
|
|
20
|
+
|
|
21
|
+
const instance: RegisterSchema = {
|
|
22
|
+
email,
|
|
23
|
+
password,
|
|
24
|
+
turnstile_token,
|
|
25
|
+
name,
|
|
26
|
+
phone,
|
|
27
|
+
password_repeat,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RemoveFromCompany
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**user_email** | **string** | | [default to undefined]
|
|
9
|
+
**company_id** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RemoveFromCompany } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: RemoveFromCompany = {
|
|
17
|
+
user_email,
|
|
18
|
+
company_id,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ResponseGetCheckoutSessionPaymentsCheckoutGet
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**checkout_url** | **string** | | [default to undefined]
|
|
9
|
+
**session_id** | **string** | | [default to undefined]
|
|
10
|
+
**message** | **string** | | [optional] [default to 'You don\'t have any active subscriptions']
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ResponseGetCheckoutSessionPaymentsCheckoutGet } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: ResponseGetCheckoutSessionPaymentsCheckoutGet = {
|
|
18
|
+
checkout_url,
|
|
19
|
+
session_id,
|
|
20
|
+
message,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**link** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [optional] [default to 'You don\'t have any active subscriptions']
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: ResponseGetCustomerManagementSessionPaymentsCustomerManagementGet = {
|
|
17
|
+
link,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/RolesApi.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# RolesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**inviteV1RolesInvitesPost**](#invitev1rolesinvitespost) | **POST** /v1/roles/invites | Invite|
|
|
8
|
+
|[**removePeopleV1RolesInvitesDelete**](#removepeoplev1rolesinvitesdelete) | **DELETE** /v1/roles/invites | Remove People|
|
|
9
|
+
|
|
10
|
+
# **inviteV1RolesInvitesPost**
|
|
11
|
+
> Details inviteV1RolesInvitesPost(inviteToCompany)
|
|
12
|
+
|
|
13
|
+
Add people to company
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
RolesApi,
|
|
20
|
+
Configuration,
|
|
21
|
+
InviteToCompany
|
|
22
|
+
} from './api';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new RolesApi(configuration);
|
|
26
|
+
|
|
27
|
+
let inviteToCompany: InviteToCompany; //
|
|
28
|
+
let authorization: string; // (optional) (default to undefined)
|
|
29
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.inviteV1RolesInvitesPost(
|
|
32
|
+
inviteToCompany,
|
|
33
|
+
authorization,
|
|
34
|
+
sessionId
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **inviteToCompany** | **InviteToCompany**| | |
|
|
43
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
44
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
**Details**
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
No authorization required
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: application/json
|
|
58
|
+
- **Accept**: application/json
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | Successful Response | - |
|
|
65
|
+
|**422** | Validation Error | - |
|
|
66
|
+
|
|
67
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
68
|
+
|
|
69
|
+
# **removePeopleV1RolesInvitesDelete**
|
|
70
|
+
> Details removePeopleV1RolesInvitesDelete(removeFromCompany)
|
|
71
|
+
|
|
72
|
+
Remove people from company
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
RolesApi,
|
|
79
|
+
Configuration,
|
|
80
|
+
RemoveFromCompany
|
|
81
|
+
} from './api';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new RolesApi(configuration);
|
|
85
|
+
|
|
86
|
+
let removeFromCompany: RemoveFromCompany; //
|
|
87
|
+
let authorization: string; // (optional) (default to undefined)
|
|
88
|
+
let sessionId: string; // (optional) (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.removePeopleV1RolesInvitesDelete(
|
|
91
|
+
removeFromCompany,
|
|
92
|
+
authorization,
|
|
93
|
+
sessionId
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **removeFromCompany** | **RemoveFromCompany**| | |
|
|
102
|
+
| **authorization** | [**string**] | | (optional) defaults to undefined|
|
|
103
|
+
| **sessionId** | [**string**] | | (optional) defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
**Details**
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
No authorization required
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: application/json
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### HTTP response details
|
|
121
|
+
| Status code | Description | Response headers |
|
|
122
|
+
|-------------|-------------|------------------|
|
|
123
|
+
|**200** | Successful Response | - |
|
|
124
|
+
|**422** | Validation Error | - |
|
|
125
|
+
|
|
126
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
127
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RolesWithUser
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**role** | **string** | | [default to undefined]
|
|
9
|
+
**user** | [**UserBase**](UserBase.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { RolesWithUser } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: RolesWithUser = {
|
|
17
|
+
role,
|
|
18
|
+
user,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateControlSchema
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**status** | [**ControlStatus**](ControlStatus.md) | | [optional] [default to undefined]
|
|
10
|
+
**note** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateControlSchema } from './api';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateControlSchema = {
|
|
18
|
+
id,
|
|
19
|
+
status,
|
|
20
|
+
note,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpdatePassword
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**old_password** | **string** | | [default to undefined]
|
|
9
|
+
**new_password** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdatePassword } from './api';
|
|
15
|
+
|
|
16
|
+
const instance: UpdatePassword = {
|
|
17
|
+
old_password,
|
|
18
|
+
new_password,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|