@rasadov/lumoar-sdk 1.1.10 → 1.2.0

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.
@@ -12,8 +12,8 @@ docs/AuthApi.md
12
12
  docs/AuthenticationSuccess.md
13
13
  docs/CheckoutSessionResponse.md
14
14
  docs/CompanyApi.md
15
+ docs/CompanyComplianceInDB.md
15
16
  docs/CompanyCreate.md
16
- docs/CompanyInDBBase.md
17
17
  docs/CompanyUpdate.md
18
18
  docs/CompanyWithControls.md
19
19
  docs/CompanyWithRoles.md
@@ -69,6 +69,8 @@ docs/ResponseGetSubscriptionV1PaymentsSubscriptionGet.md
69
69
  docs/RolesApi.md
70
70
  docs/RolesWithUser.md
71
71
  docs/SchedulerRequest.md
72
+ docs/SrcDomainsOrganizationSchemasCompanyCompanyInDBBase.md
73
+ docs/SrcSharedSchemasCompanyCompanyInDBBase.md
72
74
  docs/SubscriptionResponse.md
73
75
  docs/TaskPriority.md
74
76
  docs/TaskRead.md
package/api.ts CHANGED
@@ -159,186 +159,126 @@ export interface CheckoutSessionResponse {
159
159
  /**
160
160
  *
161
161
  * @export
162
- * @interface CompanyCreate
162
+ * @interface CompanyComplianceInDB
163
163
  */
164
- export interface CompanyCreate {
164
+ export interface CompanyComplianceInDB {
165
165
  /**
166
166
  *
167
- * @type {string}
168
- * @memberof CompanyCreate
167
+ * @type {ComplianceGoal}
168
+ * @memberof CompanyComplianceInDB
169
169
  */
170
- 'name': string;
170
+ 'framework': ComplianceGoal;
171
171
  /**
172
172
  *
173
173
  * @type {string}
174
- * @memberof CompanyCreate
174
+ * @memberof CompanyComplianceInDB
175
175
  */
176
- 'industry': string;
176
+ 'target_audit_date'?: string | null;
177
177
  /**
178
178
  *
179
179
  * @type {number}
180
- * @memberof CompanyCreate
180
+ * @memberof CompanyComplianceInDB
181
181
  */
182
- 'employee_count': number;
182
+ 'total_controls'?: number;
183
183
  /**
184
184
  *
185
- * @type {string}
186
- * @memberof CompanyCreate
187
- */
188
- 'domain': string;
189
- /**
190
- *
191
- * @type {{ [key: string]: any; }}
192
- * @memberof CompanyCreate
185
+ * @type {number}
186
+ * @memberof CompanyComplianceInDB
193
187
  */
194
- 'tools_used'?: { [key: string]: any; } | null;
188
+ 'completed_controls'?: number;
195
189
  /**
196
190
  *
197
- * @type {string}
198
- * @memberof CompanyCreate
191
+ * @type {number}
192
+ * @memberof CompanyComplianceInDB
199
193
  */
200
- 'plan'?: string | null;
194
+ 'in_progress_controls'?: number;
201
195
  /**
202
196
  *
203
- * @type {string}
204
- * @memberof CompanyCreate
197
+ * @type {number}
198
+ * @memberof CompanyComplianceInDB
205
199
  */
206
- 'status'?: string | null;
200
+ 'not_started_controls'?: number;
207
201
  /**
208
202
  *
209
- * @type {ComplianceGoal}
210
- * @memberof CompanyCreate
203
+ * @type {number}
204
+ * @memberof CompanyComplianceInDB
211
205
  */
212
- 'compliance_goal'?: ComplianceGoal | null;
206
+ 'failed_controls'?: number;
213
207
  /**
214
208
  *
215
209
  * @type {number}
216
- * @memberof CompanyCreate
210
+ * @memberof CompanyComplianceInDB
217
211
  */
218
- 'readiness_score'?: number | null;
212
+ 'skipped_controls'?: number;
219
213
  /**
220
214
  *
221
- * @type {string}
222
- * @memberof CompanyCreate
215
+ * @type {number}
216
+ * @memberof CompanyComplianceInDB
223
217
  */
224
- 'audit_due_date'?: string | null;
218
+ 'pending_review_controls'?: number;
225
219
  /**
226
220
  *
227
- * @type {boolean}
228
- * @memberof CompanyCreate
221
+ * @type {number}
222
+ * @memberof CompanyComplianceInDB
229
223
  */
230
- 'is_audit_mode'?: boolean;
224
+ 'id': number;
231
225
  /**
232
226
  *
233
227
  * @type {string}
234
- * @memberof CompanyCreate
228
+ * @memberof CompanyComplianceInDB
235
229
  */
236
- 'timezone'?: string;
230
+ 'company_id': string;
237
231
  /**
238
232
  *
239
233
  * @type {string}
240
- * @memberof CompanyCreate
234
+ * @memberof CompanyComplianceInDB
241
235
  */
242
- 'logo_url'?: string | null;
236
+ 'updated_at': string;
243
237
  }
244
238
 
245
239
 
246
240
  /**
247
241
  *
248
242
  * @export
249
- * @interface CompanyInDBBase
243
+ * @interface CompanyCreate
250
244
  */
251
- export interface CompanyInDBBase {
245
+ export interface CompanyCreate {
252
246
  /**
253
247
  *
254
248
  * @type {string}
255
- * @memberof CompanyInDBBase
249
+ * @memberof CompanyCreate
256
250
  */
257
251
  'name': string;
258
252
  /**
259
253
  *
260
254
  * @type {string}
261
- * @memberof CompanyInDBBase
255
+ * @memberof CompanyCreate
262
256
  */
263
257
  'industry': string;
264
258
  /**
265
259
  *
266
260
  * @type {number}
267
- * @memberof CompanyInDBBase
261
+ * @memberof CompanyCreate
268
262
  */
269
263
  'employee_count': number;
270
264
  /**
271
265
  *
272
266
  * @type {string}
273
- * @memberof CompanyInDBBase
267
+ * @memberof CompanyCreate
274
268
  */
275
269
  'domain': string;
276
- /**
277
- *
278
- * @type {{ [key: string]: any; }}
279
- * @memberof CompanyInDBBase
280
- */
281
- 'tools_used'?: { [key: string]: any; } | null;
282
270
  /**
283
271
  *
284
272
  * @type {string}
285
- * @memberof CompanyInDBBase
286
- */
287
- 'plan'?: string | null;
288
- /**
289
- *
290
- * @type {string}
291
- * @memberof CompanyInDBBase
273
+ * @memberof CompanyCreate
292
274
  */
293
275
  'status'?: string | null;
294
276
  /**
295
277
  *
296
278
  * @type {ComplianceGoal}
297
- * @memberof CompanyInDBBase
298
- */
299
- 'compliance_goal'?: ComplianceGoal | null;
300
- /**
301
- *
302
- * @type {number}
303
- * @memberof CompanyInDBBase
304
- */
305
- 'readiness_score'?: number | null;
306
- /**
307
- *
308
- * @type {string}
309
- * @memberof CompanyInDBBase
310
- */
311
- 'audit_due_date'?: string | null;
312
- /**
313
- *
314
- * @type {boolean}
315
- * @memberof CompanyInDBBase
316
- */
317
- 'is_audit_mode'?: boolean;
318
- /**
319
- *
320
- * @type {string}
321
- * @memberof CompanyInDBBase
322
- */
323
- 'timezone'?: string;
324
- /**
325
- *
326
- * @type {string}
327
- * @memberof CompanyInDBBase
328
- */
329
- 'logo_url'?: string | null;
330
- /**
331
- *
332
- * @type {string}
333
- * @memberof CompanyInDBBase
334
- */
335
- 'id': string;
336
- /**
337
- *
338
- * @type {string}
339
- * @memberof CompanyInDBBase
279
+ * @memberof CompanyCreate
340
280
  */
341
- 'updated_at': string;
281
+ 'compliance_goal'?: ComplianceGoal;
342
282
  }
343
283
 
344
284
 
@@ -378,51 +318,7 @@ export interface CompanyUpdate {
378
318
  * @memberof CompanyUpdate
379
319
  */
380
320
  'domain'?: string | null;
381
- /**
382
- *
383
- * @type {{ [key: string]: any; }}
384
- * @memberof CompanyUpdate
385
- */
386
- 'tools_used'?: { [key: string]: any; } | null;
387
- /**
388
- *
389
- * @type {ComplianceGoal}
390
- * @memberof CompanyUpdate
391
- */
392
- 'compliance_goal'?: ComplianceGoal | null;
393
- /**
394
- *
395
- * @type {number}
396
- * @memberof CompanyUpdate
397
- */
398
- 'readiness_score'?: number | null;
399
- /**
400
- *
401
- * @type {string}
402
- * @memberof CompanyUpdate
403
- */
404
- 'audit_due_date'?: string | null;
405
- /**
406
- *
407
- * @type {boolean}
408
- * @memberof CompanyUpdate
409
- */
410
- 'is_audit_mode'?: boolean | null;
411
- /**
412
- *
413
- * @type {string}
414
- * @memberof CompanyUpdate
415
- */
416
- 'timezone'?: string | null;
417
- /**
418
- *
419
- * @type {string}
420
- * @memberof CompanyUpdate
421
- */
422
- 'logo_url'?: string | null;
423
321
  }
424
-
425
-
426
322
  /**
427
323
  *
428
324
  * @export
@@ -453,60 +349,12 @@ export interface CompanyWithControls {
453
349
  * @memberof CompanyWithControls
454
350
  */
455
351
  'domain': string;
456
- /**
457
- *
458
- * @type {{ [key: string]: any; }}
459
- * @memberof CompanyWithControls
460
- */
461
- 'tools_used'?: { [key: string]: any; } | null;
462
- /**
463
- *
464
- * @type {string}
465
- * @memberof CompanyWithControls
466
- */
467
- 'plan'?: string | null;
468
352
  /**
469
353
  *
470
354
  * @type {string}
471
355
  * @memberof CompanyWithControls
472
356
  */
473
357
  'status'?: string | null;
474
- /**
475
- *
476
- * @type {ComplianceGoal}
477
- * @memberof CompanyWithControls
478
- */
479
- 'compliance_goal'?: ComplianceGoal | null;
480
- /**
481
- *
482
- * @type {number}
483
- * @memberof CompanyWithControls
484
- */
485
- 'readiness_score'?: number | null;
486
- /**
487
- *
488
- * @type {string}
489
- * @memberof CompanyWithControls
490
- */
491
- 'audit_due_date'?: string | null;
492
- /**
493
- *
494
- * @type {boolean}
495
- * @memberof CompanyWithControls
496
- */
497
- 'is_audit_mode'?: boolean;
498
- /**
499
- *
500
- * @type {string}
501
- * @memberof CompanyWithControls
502
- */
503
- 'timezone'?: string;
504
- /**
505
- *
506
- * @type {string}
507
- * @memberof CompanyWithControls
508
- */
509
- 'logo_url'?: string | null;
510
358
  /**
511
359
  *
512
360
  * @type {string}
@@ -526,8 +374,6 @@ export interface CompanyWithControls {
526
374
  */
527
375
  'controls': Array<ControlWithEvidences>;
528
376
  }
529
-
530
-
531
377
  /**
532
378
  *
533
379
  * @export
@@ -558,60 +404,12 @@ export interface CompanyWithRoles {
558
404
  * @memberof CompanyWithRoles
559
405
  */
560
406
  'domain': string;
561
- /**
562
- *
563
- * @type {{ [key: string]: any; }}
564
- * @memberof CompanyWithRoles
565
- */
566
- 'tools_used'?: { [key: string]: any; } | null;
567
- /**
568
- *
569
- * @type {string}
570
- * @memberof CompanyWithRoles
571
- */
572
- 'plan'?: string | null;
573
407
  /**
574
408
  *
575
409
  * @type {string}
576
410
  * @memberof CompanyWithRoles
577
411
  */
578
412
  'status'?: string | null;
579
- /**
580
- *
581
- * @type {ComplianceGoal}
582
- * @memberof CompanyWithRoles
583
- */
584
- 'compliance_goal'?: ComplianceGoal | null;
585
- /**
586
- *
587
- * @type {number}
588
- * @memberof CompanyWithRoles
589
- */
590
- 'readiness_score'?: number | null;
591
- /**
592
- *
593
- * @type {string}
594
- * @memberof CompanyWithRoles
595
- */
596
- 'audit_due_date'?: string | null;
597
- /**
598
- *
599
- * @type {boolean}
600
- * @memberof CompanyWithRoles
601
- */
602
- 'is_audit_mode'?: boolean;
603
- /**
604
- *
605
- * @type {string}
606
- * @memberof CompanyWithRoles
607
- */
608
- 'timezone'?: string;
609
- /**
610
- *
611
- * @type {string}
612
- * @memberof CompanyWithRoles
613
- */
614
- 'logo_url'?: string | null;
615
413
  /**
616
414
  *
617
415
  * @type {string}
@@ -631,8 +429,6 @@ export interface CompanyWithRoles {
631
429
  */
632
430
  'permissions': Array<RolesWithUser>;
633
431
  }
634
-
635
-
636
432
  /**
637
433
  *
638
434
  * @export
@@ -813,10 +609,10 @@ export interface ControlWithRelationships {
813
609
  'data': FrameworkControlsBase;
814
610
  /**
815
611
  *
816
- * @type {CompanyInDBBase}
612
+ * @type {SrcSharedSchemasCompanyCompanyInDBBase}
817
613
  * @memberof ControlWithRelationships
818
614
  */
819
- 'company': CompanyInDBBase;
615
+ 'company': SrcSharedSchemasCompanyCompanyInDBBase;
820
616
  /**
821
617
  *
822
618
  * @type {Array<EvidenceBase>}
@@ -1368,10 +1164,10 @@ export interface PaginationResponseAuditLogSchema {
1368
1164
  export interface PaginationResponseCompanyInDBBase {
1369
1165
  /**
1370
1166
  *
1371
- * @type {Array<CompanyInDBBase>}
1167
+ * @type {Array<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase>}
1372
1168
  * @memberof PaginationResponseCompanyInDBBase
1373
1169
  */
1374
- 'items': Array<CompanyInDBBase>;
1170
+ 'items': Array<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase>;
1375
1171
  /**
1376
1172
  *
1377
1173
  * @type {number}
@@ -1889,6 +1685,110 @@ export interface SchedulerRequest {
1889
1685
  */
1890
1686
  'user_ids_to_assign'?: Array<string>;
1891
1687
  }
1688
+ /**
1689
+ *
1690
+ * @export
1691
+ * @interface SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1692
+ */
1693
+ export interface SrcDomainsOrganizationSchemasCompanyCompanyInDBBase {
1694
+ /**
1695
+ *
1696
+ * @type {string}
1697
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1698
+ */
1699
+ 'name': string;
1700
+ /**
1701
+ *
1702
+ * @type {string}
1703
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1704
+ */
1705
+ 'industry': string;
1706
+ /**
1707
+ *
1708
+ * @type {number}
1709
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1710
+ */
1711
+ 'employee_count': number;
1712
+ /**
1713
+ *
1714
+ * @type {string}
1715
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1716
+ */
1717
+ 'domain': string;
1718
+ /**
1719
+ *
1720
+ * @type {string}
1721
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1722
+ */
1723
+ 'status'?: string | null;
1724
+ /**
1725
+ *
1726
+ * @type {string}
1727
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1728
+ */
1729
+ 'id': string;
1730
+ /**
1731
+ *
1732
+ * @type {string}
1733
+ * @memberof SrcDomainsOrganizationSchemasCompanyCompanyInDBBase
1734
+ */
1735
+ 'updated_at': string;
1736
+ }
1737
+ /**
1738
+ *
1739
+ * @export
1740
+ * @interface SrcSharedSchemasCompanyCompanyInDBBase
1741
+ */
1742
+ export interface SrcSharedSchemasCompanyCompanyInDBBase {
1743
+ /**
1744
+ *
1745
+ * @type {string}
1746
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1747
+ */
1748
+ 'name': string;
1749
+ /**
1750
+ *
1751
+ * @type {string}
1752
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1753
+ */
1754
+ 'industry': string;
1755
+ /**
1756
+ *
1757
+ * @type {number}
1758
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1759
+ */
1760
+ 'employee_count': number;
1761
+ /**
1762
+ *
1763
+ * @type {string}
1764
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1765
+ */
1766
+ 'domain': string;
1767
+ /**
1768
+ *
1769
+ * @type {string}
1770
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1771
+ */
1772
+ 'status'?: string | null;
1773
+ /**
1774
+ *
1775
+ * @type {string}
1776
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1777
+ */
1778
+ 'id': string;
1779
+ /**
1780
+ *
1781
+ * @type {string}
1782
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1783
+ */
1784
+ 'updated_at': string;
1785
+ /**
1786
+ *
1787
+ * @type {CompanyComplianceInDB}
1788
+ * @memberof SrcSharedSchemasCompanyCompanyInDBBase
1789
+ */
1790
+ 'compliance'?: CompanyComplianceInDB | null;
1791
+ }
1892
1792
  /**
1893
1793
  *
1894
1794
  * @export
@@ -2004,6 +1904,12 @@ export interface TaskRead {
2004
1904
  * @memberof TaskRead
2005
1905
  */
2006
1906
  'status': TaskStatus;
1907
+ /**
1908
+ *
1909
+ * @type {string}
1910
+ * @memberof TaskRead
1911
+ */
1912
+ 'control_id': string | null;
2007
1913
  }
2008
1914
 
2009
1915
 
@@ -2085,6 +1991,12 @@ export interface TaskWithUser {
2085
1991
  * @memberof TaskWithUser
2086
1992
  */
2087
1993
  'status': TaskStatus;
1994
+ /**
1995
+ *
1996
+ * @type {string}
1997
+ * @memberof TaskWithUser
1998
+ */
1999
+ 'control_id': string | null;
2088
2000
  /**
2089
2001
  *
2090
2002
  * @type {UserWithId}
@@ -2280,10 +2192,10 @@ export interface UserPermissionsWithCompany {
2280
2192
  'role': string | null;
2281
2193
  /**
2282
2194
  *
2283
- * @type {CompanyInDBBase}
2195
+ * @type {SrcSharedSchemasCompanyCompanyInDBBase}
2284
2196
  * @memberof UserPermissionsWithCompany
2285
2197
  */
2286
- 'company': CompanyInDBBase | null;
2198
+ 'company': SrcSharedSchemasCompanyCompanyInDBBase | null;
2287
2199
  }
2288
2200
  /**
2289
2201
  *
@@ -3642,7 +3554,7 @@ export const CompanyApiFp = function(configuration?: Configuration) {
3642
3554
  * @param {*} [options] Override http request option.
3643
3555
  * @throws {RequiredError}
3644
3556
  */
3645
- async createCompanyV1CompanyCreatePost(companyCreate: CompanyCreate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompanyInDBBase>> {
3557
+ async createCompanyV1CompanyCreatePost(companyCreate: CompanyCreate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase>> {
3646
3558
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCompanyV1CompanyCreatePost(companyCreate, authorization, sessionId, options);
3647
3559
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3648
3560
  const localVarOperationServerBasePath = operationServerMap['CompanyApi.createCompanyV1CompanyCreatePost']?.[localVarOperationServerIndex]?.url;
@@ -3703,7 +3615,7 @@ export const CompanyApiFp = function(configuration?: Configuration) {
3703
3615
  * @param {*} [options] Override http request option.
3704
3616
  * @throws {RequiredError}
3705
3617
  */
3706
- async updateCompanyV1CompanyUpdatePatch(companyUpdate: CompanyUpdate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompanyInDBBase>> {
3618
+ async updateCompanyV1CompanyUpdatePatch(companyUpdate: CompanyUpdate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase>> {
3707
3619
  const localVarAxiosArgs = await localVarAxiosParamCreator.updateCompanyV1CompanyUpdatePatch(companyUpdate, authorization, sessionId, options);
3708
3620
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3709
3621
  const localVarOperationServerBasePath = operationServerMap['CompanyApi.updateCompanyV1CompanyUpdatePatch']?.[localVarOperationServerIndex]?.url;
@@ -3728,7 +3640,7 @@ export const CompanyApiFactory = function (configuration?: Configuration, basePa
3728
3640
  * @param {*} [options] Override http request option.
3729
3641
  * @throws {RequiredError}
3730
3642
  */
3731
- createCompanyV1CompanyCreatePost(companyCreate: CompanyCreate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompanyInDBBase> {
3643
+ createCompanyV1CompanyCreatePost(companyCreate: CompanyCreate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase> {
3732
3644
  return localVarFp.createCompanyV1CompanyCreatePost(companyCreate, authorization, sessionId, options).then((request) => request(axios, basePath));
3733
3645
  },
3734
3646
  /**
@@ -3777,7 +3689,7 @@ export const CompanyApiFactory = function (configuration?: Configuration, basePa
3777
3689
  * @param {*} [options] Override http request option.
3778
3690
  * @throws {RequiredError}
3779
3691
  */
3780
- updateCompanyV1CompanyUpdatePatch(companyUpdate: CompanyUpdate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<CompanyInDBBase> {
3692
+ updateCompanyV1CompanyUpdatePatch(companyUpdate: CompanyUpdate, authorization?: string, sessionId?: string, options?: RawAxiosRequestConfig): AxiosPromise<SrcDomainsOrganizationSchemasCompanyCompanyInDBBase> {
3781
3693
  return localVarFp.updateCompanyV1CompanyUpdatePatch(companyUpdate, authorization, sessionId, options).then((request) => request(axios, basePath));
3782
3694
  },
3783
3695
  };