@livetronics/pipesurf-types 1.1.0 → 1.1.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.
@@ -1,4218 +0,0 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
- export interface paths {
6
- '/auth/otp/send': {
7
- parameters: {
8
- query?: never;
9
- header?: never;
10
- path?: never;
11
- cookie?: never;
12
- };
13
- get?: never;
14
- put?: never;
15
- /**
16
- * Send OTP to email
17
- * @description Sends a one-time password to the specified email address for login or password reset.
18
- */
19
- post: {
20
- parameters: {
21
- query?: never;
22
- header?: never;
23
- path?: never;
24
- cookie?: never;
25
- };
26
- requestBody?: {
27
- content: {
28
- 'application/json': components['schemas']['SendOTPRequest'];
29
- };
30
- };
31
- responses: {
32
- /** @description OTP sent successfully */
33
- 200: {
34
- headers: {
35
- [name: string]: unknown;
36
- };
37
- content: {
38
- 'application/json': {
39
- /**
40
- * @example SUCCESS
41
- * @enum {string}
42
- */
43
- status: 'SUCCESS' | 'FAILED';
44
- error: string | null;
45
- /** @example Operation successful */
46
- message: string | null;
47
- data: {
48
- sent: boolean;
49
- } | null;
50
- };
51
- };
52
- };
53
- /** @description Bad request */
54
- 400: {
55
- headers: {
56
- [name: string]: unknown;
57
- };
58
- content: {
59
- 'application/json': components['schemas']['ErrorResponse'];
60
- };
61
- };
62
- };
63
- };
64
- delete?: never;
65
- options?: never;
66
- head?: never;
67
- patch?: never;
68
- trace?: never;
69
- };
70
- '/auth/login/otp': {
71
- parameters: {
72
- query?: never;
73
- header?: never;
74
- path?: never;
75
- cookie?: never;
76
- };
77
- get?: never;
78
- put?: never;
79
- /**
80
- * Login via OTP
81
- * @description Verify OTP and receive authentication token.
82
- */
83
- post: {
84
- parameters: {
85
- query?: never;
86
- header?: never;
87
- path?: never;
88
- cookie?: never;
89
- };
90
- requestBody?: {
91
- content: {
92
- 'application/json': components['schemas']['LoginViaOTPRequest'];
93
- };
94
- };
95
- responses: {
96
- /** @description Login successful */
97
- 200: {
98
- headers: {
99
- [name: string]: unknown;
100
- };
101
- content: {
102
- 'application/json': {
103
- /**
104
- * @example SUCCESS
105
- * @enum {string}
106
- */
107
- status: 'SUCCESS' | 'FAILED';
108
- error: string | null;
109
- /** @example Operation successful */
110
- message: string | null;
111
- data: {
112
- token: string;
113
- user: components['schemas']['User'];
114
- } | null;
115
- };
116
- };
117
- };
118
- /** @description Invalid OTP */
119
- 401: {
120
- headers: {
121
- [name: string]: unknown;
122
- };
123
- content: {
124
- 'application/json': components['schemas']['ErrorResponse'];
125
- };
126
- };
127
- };
128
- };
129
- delete?: never;
130
- options?: never;
131
- head?: never;
132
- patch?: never;
133
- trace?: never;
134
- };
135
- '/users': {
136
- parameters: {
137
- query?: never;
138
- header?: never;
139
- path?: never;
140
- cookie?: never;
141
- };
142
- /**
143
- * List users
144
- * @description Get paginated list of users. PRODUCT_ADMIN sees all users, COMPANY_ADMIN sees company users.
145
- */
146
- get: {
147
- parameters: {
148
- query?: {
149
- page?: string;
150
- limit?: string;
151
- searchQuery?: string;
152
- status?: 'ACTIVE' | 'DISABLED' | 'REMOVED';
153
- idCompany?: string;
154
- };
155
- header?: never;
156
- path?: never;
157
- cookie?: never;
158
- };
159
- requestBody?: never;
160
- responses: {
161
- /** @description Users list */
162
- 200: {
163
- headers: {
164
- [name: string]: unknown;
165
- };
166
- content: {
167
- 'application/json': {
168
- /**
169
- * @example SUCCESS
170
- * @enum {string}
171
- */
172
- status: 'SUCCESS' | 'FAILED';
173
- error: string | null;
174
- /** @example Operation successful */
175
- message: string | null;
176
- data: components['schemas']['User'][] | null;
177
- /** @example 100 */
178
- count: number;
179
- /** @example 1 */
180
- page: number;
181
- /** @example 10 */
182
- limit: number;
183
- /** @example 10 */
184
- totalPages: number;
185
- };
186
- };
187
- };
188
- /** @description Unauthorized */
189
- 401: {
190
- headers: {
191
- [name: string]: unknown;
192
- };
193
- content: {
194
- 'application/json': components['schemas']['ErrorResponse'];
195
- };
196
- };
197
- };
198
- };
199
- put?: never;
200
- /**
201
- * Create user
202
- * @description Create a new user. PRODUCT_ADMIN can create COMPANY_ADMIN, COMPANY_ADMIN can create other roles.
203
- */
204
- post: {
205
- parameters: {
206
- query?: never;
207
- header?: never;
208
- path?: never;
209
- cookie?: never;
210
- };
211
- requestBody?: {
212
- content: {
213
- 'application/json': components['schemas']['CreateUserRequest'];
214
- };
215
- };
216
- responses: {
217
- /** @description User created */
218
- 201: {
219
- headers: {
220
- [name: string]: unknown;
221
- };
222
- content: {
223
- 'application/json': {
224
- /**
225
- * @example SUCCESS
226
- * @enum {string}
227
- */
228
- status: 'SUCCESS' | 'FAILED';
229
- error: string | null;
230
- /** @example Operation successful */
231
- message: string | null;
232
- data: components['schemas']['User'] & unknown;
233
- };
234
- };
235
- };
236
- /** @description Validation error */
237
- 400: {
238
- headers: {
239
- [name: string]: unknown;
240
- };
241
- content: {
242
- 'application/json': components['schemas']['ErrorResponse'];
243
- };
244
- };
245
- };
246
- };
247
- delete?: never;
248
- options?: never;
249
- head?: never;
250
- patch?: never;
251
- trace?: never;
252
- };
253
- '/users/{id}': {
254
- parameters: {
255
- query?: never;
256
- header?: never;
257
- path?: never;
258
- cookie?: never;
259
- };
260
- /**
261
- * Get user by ID
262
- * @description Get detailed information about a specific user.
263
- */
264
- get: {
265
- parameters: {
266
- query?: never;
267
- header?: never;
268
- path: {
269
- id: string;
270
- };
271
- cookie?: never;
272
- };
273
- requestBody?: never;
274
- responses: {
275
- /** @description User details */
276
- 200: {
277
- headers: {
278
- [name: string]: unknown;
279
- };
280
- content: {
281
- 'application/json': {
282
- /**
283
- * @example SUCCESS
284
- * @enum {string}
285
- */
286
- status: 'SUCCESS' | 'FAILED';
287
- error: string | null;
288
- /** @example Operation successful */
289
- message: string | null;
290
- data: components['schemas']['User'] & unknown;
291
- };
292
- };
293
- };
294
- /** @description User not found */
295
- 404: {
296
- headers: {
297
- [name: string]: unknown;
298
- };
299
- content: {
300
- 'application/json': components['schemas']['ErrorResponse'];
301
- };
302
- };
303
- };
304
- };
305
- put?: never;
306
- post?: never;
307
- /**
308
- * Delete user
309
- * @description Soft delete a user (marks as REMOVED).
310
- */
311
- delete: {
312
- parameters: {
313
- query?: never;
314
- header?: never;
315
- path: {
316
- id: string;
317
- };
318
- cookie?: never;
319
- };
320
- requestBody?: never;
321
- responses: {
322
- /** @description User deleted */
323
- 200: {
324
- headers: {
325
- [name: string]: unknown;
326
- };
327
- content: {
328
- 'application/json': {
329
- /**
330
- * @example SUCCESS
331
- * @enum {string}
332
- */
333
- status: 'SUCCESS' | 'FAILED';
334
- error: string | null;
335
- /** @example Operation successful */
336
- message: string | null;
337
- data: {
338
- deleted: boolean;
339
- } | null;
340
- };
341
- };
342
- };
343
- };
344
- };
345
- options?: never;
346
- head?: never;
347
- /**
348
- * Update user
349
- * @description Update user profile information.
350
- */
351
- patch: {
352
- parameters: {
353
- query?: never;
354
- header?: never;
355
- path: {
356
- id: string;
357
- };
358
- cookie?: never;
359
- };
360
- requestBody?: {
361
- content: {
362
- 'application/json': components['schemas']['UpdateUserRequest'];
363
- };
364
- };
365
- responses: {
366
- /** @description User updated */
367
- 200: {
368
- headers: {
369
- [name: string]: unknown;
370
- };
371
- content: {
372
- 'application/json': {
373
- /**
374
- * @example SUCCESS
375
- * @enum {string}
376
- */
377
- status: 'SUCCESS' | 'FAILED';
378
- error: string | null;
379
- /** @example Operation successful */
380
- message: string | null;
381
- data: components['schemas']['User'] & unknown;
382
- };
383
- };
384
- };
385
- };
386
- };
387
- trace?: never;
388
- };
389
- '/users/{id}/status': {
390
- parameters: {
391
- query?: never;
392
- header?: never;
393
- path?: never;
394
- cookie?: never;
395
- };
396
- get?: never;
397
- put?: never;
398
- post?: never;
399
- delete?: never;
400
- options?: never;
401
- head?: never;
402
- /**
403
- * Change user status
404
- * @description Block or unblock a user.
405
- */
406
- patch: {
407
- parameters: {
408
- query?: never;
409
- header?: never;
410
- path: {
411
- id: string;
412
- };
413
- cookie?: never;
414
- };
415
- requestBody?: {
416
- content: {
417
- 'application/json': components['schemas']['ChangeUserStatusRequest'];
418
- };
419
- };
420
- responses: {
421
- /** @description Status changed */
422
- 200: {
423
- headers: {
424
- [name: string]: unknown;
425
- };
426
- content: {
427
- 'application/json': {
428
- /**
429
- * @example SUCCESS
430
- * @enum {string}
431
- */
432
- status: 'SUCCESS' | 'FAILED';
433
- error: string | null;
434
- /** @example Operation successful */
435
- message: string | null;
436
- data: components['schemas']['User'] & unknown;
437
- };
438
- };
439
- };
440
- };
441
- };
442
- trace?: never;
443
- };
444
- '/companies': {
445
- parameters: {
446
- query?: never;
447
- header?: never;
448
- path?: never;
449
- cookie?: never;
450
- };
451
- /**
452
- * List companies
453
- * @description Get paginated list of companies. PRODUCT_ADMIN only.
454
- */
455
- get: {
456
- parameters: {
457
- query?: {
458
- page?: string;
459
- limit?: string;
460
- searchQuery?: string;
461
- };
462
- header?: never;
463
- path?: never;
464
- cookie?: never;
465
- };
466
- requestBody?: never;
467
- responses: {
468
- /** @description Companies list */
469
- 200: {
470
- headers: {
471
- [name: string]: unknown;
472
- };
473
- content: {
474
- 'application/json': {
475
- /**
476
- * @example SUCCESS
477
- * @enum {string}
478
- */
479
- status: 'SUCCESS' | 'FAILED';
480
- error: string | null;
481
- /** @example Operation successful */
482
- message: string | null;
483
- data: components['schemas']['Company'][] | null;
484
- /** @example 100 */
485
- count: number;
486
- /** @example 1 */
487
- page: number;
488
- /** @example 10 */
489
- limit: number;
490
- /** @example 10 */
491
- totalPages: number;
492
- };
493
- };
494
- };
495
- };
496
- };
497
- put?: never;
498
- /**
499
- * Create company
500
- * @description Create a new company with its admin user. PRODUCT_ADMIN only.
501
- */
502
- post: {
503
- parameters: {
504
- query?: never;
505
- header?: never;
506
- path?: never;
507
- cookie?: never;
508
- };
509
- requestBody?: {
510
- content: {
511
- 'application/json': components['schemas']['CreateCompanyRequest'];
512
- };
513
- };
514
- responses: {
515
- /** @description Company created */
516
- 201: {
517
- headers: {
518
- [name: string]: unknown;
519
- };
520
- content: {
521
- 'application/json': {
522
- /**
523
- * @example SUCCESS
524
- * @enum {string}
525
- */
526
- status: 'SUCCESS' | 'FAILED';
527
- error: string | null;
528
- /** @example Operation successful */
529
- message: string | null;
530
- data: components['schemas']['Company'] & unknown;
531
- };
532
- };
533
- };
534
- };
535
- };
536
- delete?: never;
537
- options?: never;
538
- head?: never;
539
- patch?: never;
540
- trace?: never;
541
- };
542
- '/companies/{idCompany}': {
543
- parameters: {
544
- query?: never;
545
- header?: never;
546
- path?: never;
547
- cookie?: never;
548
- };
549
- /** Get company details */
550
- get: {
551
- parameters: {
552
- query?: never;
553
- header?: never;
554
- path: {
555
- idCompany: string;
556
- };
557
- cookie?: never;
558
- };
559
- requestBody?: never;
560
- responses: {
561
- /** @description Company details */
562
- 200: {
563
- headers: {
564
- [name: string]: unknown;
565
- };
566
- content: {
567
- 'application/json': {
568
- /**
569
- * @example SUCCESS
570
- * @enum {string}
571
- */
572
- status: 'SUCCESS' | 'FAILED';
573
- error: string | null;
574
- /** @example Operation successful */
575
- message: string | null;
576
- data: components['schemas']['Company'] & unknown;
577
- };
578
- };
579
- };
580
- };
581
- };
582
- put?: never;
583
- post?: never;
584
- /** Delete company */
585
- delete: {
586
- parameters: {
587
- query?: never;
588
- header?: never;
589
- path: {
590
- idCompany: string;
591
- };
592
- cookie?: never;
593
- };
594
- requestBody?: never;
595
- responses: {
596
- /** @description Company deleted */
597
- 200: {
598
- headers: {
599
- [name: string]: unknown;
600
- };
601
- content: {
602
- 'application/json': {
603
- /**
604
- * @example SUCCESS
605
- * @enum {string}
606
- */
607
- status: 'SUCCESS' | 'FAILED';
608
- error: string | null;
609
- /** @example Operation successful */
610
- message: string | null;
611
- data: {
612
- deleted: boolean;
613
- } | null;
614
- };
615
- };
616
- };
617
- };
618
- };
619
- options?: never;
620
- head?: never;
621
- /** Update company */
622
- patch: {
623
- parameters: {
624
- query?: never;
625
- header?: never;
626
- path: {
627
- idCompany: string;
628
- };
629
- cookie?: never;
630
- };
631
- requestBody?: {
632
- content: {
633
- 'application/json': components['schemas']['UpdateCompanyRequest'];
634
- };
635
- };
636
- responses: {
637
- /** @description Company updated */
638
- 200: {
639
- headers: {
640
- [name: string]: unknown;
641
- };
642
- content: {
643
- 'application/json': {
644
- /**
645
- * @example SUCCESS
646
- * @enum {string}
647
- */
648
- status: 'SUCCESS' | 'FAILED';
649
- error: string | null;
650
- /** @example Operation successful */
651
- message: string | null;
652
- data: components['schemas']['Company'] & unknown;
653
- };
654
- };
655
- };
656
- };
657
- };
658
- trace?: never;
659
- };
660
- '/projects': {
661
- parameters: {
662
- query?: never;
663
- header?: never;
664
- path?: never;
665
- cookie?: never;
666
- };
667
- /**
668
- * List projects
669
- * @description Get paginated list of projects accessible to the user.
670
- */
671
- get: {
672
- parameters: {
673
- query?: {
674
- page?: string;
675
- limit?: string;
676
- searchQuery?: string;
677
- status?: 'ACTIVE' | 'ON_HOLD' | 'COMPLETED';
678
- idCompany?: string;
679
- };
680
- header?: never;
681
- path?: never;
682
- cookie?: never;
683
- };
684
- requestBody?: never;
685
- responses: {
686
- /** @description Projects list */
687
- 200: {
688
- headers: {
689
- [name: string]: unknown;
690
- };
691
- content: {
692
- 'application/json': {
693
- /**
694
- * @example SUCCESS
695
- * @enum {string}
696
- */
697
- status: 'SUCCESS' | 'FAILED';
698
- error: string | null;
699
- /** @example Operation successful */
700
- message: string | null;
701
- data: components['schemas']['Project'][] | null;
702
- /** @example 100 */
703
- count: number;
704
- /** @example 1 */
705
- page: number;
706
- /** @example 10 */
707
- limit: number;
708
- /** @example 10 */
709
- totalPages: number;
710
- };
711
- };
712
- };
713
- };
714
- };
715
- put?: never;
716
- /**
717
- * Create project
718
- * @description Create a new project with phases. COMPANY_ADMIN only.
719
- */
720
- post: {
721
- parameters: {
722
- query?: never;
723
- header?: never;
724
- path?: never;
725
- cookie?: never;
726
- };
727
- requestBody?: {
728
- content: {
729
- 'application/json': components['schemas']['CreateProjectRequest'];
730
- };
731
- };
732
- responses: {
733
- /** @description Project created */
734
- 201: {
735
- headers: {
736
- [name: string]: unknown;
737
- };
738
- content: {
739
- 'application/json': {
740
- /**
741
- * @example SUCCESS
742
- * @enum {string}
743
- */
744
- status: 'SUCCESS' | 'FAILED';
745
- error: string | null;
746
- /** @example Operation successful */
747
- message: string | null;
748
- data: components['schemas']['Project'] & unknown;
749
- };
750
- };
751
- };
752
- };
753
- };
754
- delete?: never;
755
- options?: never;
756
- head?: never;
757
- patch?: never;
758
- trace?: never;
759
- };
760
- '/projects/{idProject}': {
761
- parameters: {
762
- query?: never;
763
- header?: never;
764
- path?: never;
765
- cookie?: never;
766
- };
767
- /** Get project details */
768
- get: {
769
- parameters: {
770
- query?: never;
771
- header?: never;
772
- path: {
773
- idProject: string;
774
- };
775
- cookie?: never;
776
- };
777
- requestBody?: never;
778
- responses: {
779
- /** @description Project details with phases and roles */
780
- 200: {
781
- headers: {
782
- [name: string]: unknown;
783
- };
784
- content: {
785
- 'application/json': {
786
- /**
787
- * @example SUCCESS
788
- * @enum {string}
789
- */
790
- status: 'SUCCESS' | 'FAILED';
791
- error: string | null;
792
- /** @example Operation successful */
793
- message: string | null;
794
- data: components['schemas']['Project'] & unknown;
795
- };
796
- };
797
- };
798
- };
799
- };
800
- put?: never;
801
- post?: never;
802
- /** Delete project */
803
- delete: {
804
- parameters: {
805
- query?: never;
806
- header?: never;
807
- path: {
808
- idProject: string;
809
- };
810
- cookie?: never;
811
- };
812
- requestBody?: never;
813
- responses: {
814
- /** @description Project deleted */
815
- 200: {
816
- headers: {
817
- [name: string]: unknown;
818
- };
819
- content: {
820
- 'application/json': {
821
- /**
822
- * @example SUCCESS
823
- * @enum {string}
824
- */
825
- status: 'SUCCESS' | 'FAILED';
826
- error: string | null;
827
- /** @example Operation successful */
828
- message: string | null;
829
- data: {
830
- deleted: boolean;
831
- } | null;
832
- };
833
- };
834
- };
835
- };
836
- };
837
- options?: never;
838
- head?: never;
839
- /** Update project */
840
- patch: {
841
- parameters: {
842
- query?: never;
843
- header?: never;
844
- path: {
845
- idProject: string;
846
- };
847
- cookie?: never;
848
- };
849
- requestBody?: {
850
- content: {
851
- 'application/json': components['schemas']['UpdateProjectRequest'];
852
- };
853
- };
854
- responses: {
855
- /** @description Project updated */
856
- 200: {
857
- headers: {
858
- [name: string]: unknown;
859
- };
860
- content: {
861
- 'application/json': {
862
- /**
863
- * @example SUCCESS
864
- * @enum {string}
865
- */
866
- status: 'SUCCESS' | 'FAILED';
867
- error: string | null;
868
- /** @example Operation successful */
869
- message: string | null;
870
- data: components['schemas']['Project'] & unknown;
871
- };
872
- };
873
- };
874
- };
875
- };
876
- trace?: never;
877
- };
878
- '/projects/{idProject}/status': {
879
- parameters: {
880
- query?: never;
881
- header?: never;
882
- path?: never;
883
- cookie?: never;
884
- };
885
- get?: never;
886
- put?: never;
887
- post?: never;
888
- delete?: never;
889
- options?: never;
890
- head?: never;
891
- /**
892
- * Change project status
893
- * @description Put project on hold, resume, or mark as complete.
894
- */
895
- patch: {
896
- parameters: {
897
- query?: never;
898
- header?: never;
899
- path: {
900
- idProject: string;
901
- };
902
- cookie?: never;
903
- };
904
- requestBody?: {
905
- content: {
906
- 'application/json': components['schemas']['ChangeProjectStatusRequest'];
907
- };
908
- };
909
- responses: {
910
- /** @description Status changed */
911
- 200: {
912
- headers: {
913
- [name: string]: unknown;
914
- };
915
- content: {
916
- 'application/json': {
917
- /**
918
- * @example SUCCESS
919
- * @enum {string}
920
- */
921
- status: 'SUCCESS' | 'FAILED';
922
- error: string | null;
923
- /** @example Operation successful */
924
- message: string | null;
925
- data: components['schemas']['Project'] & unknown;
926
- };
927
- };
928
- };
929
- };
930
- };
931
- trace?: never;
932
- };
933
- '/projects/{idProject}/roles': {
934
- parameters: {
935
- query?: never;
936
- header?: never;
937
- path?: never;
938
- cookie?: never;
939
- };
940
- get?: never;
941
- put?: never;
942
- /** Add users to project with roles */
943
- post: {
944
- parameters: {
945
- query?: never;
946
- header?: never;
947
- path: {
948
- idProject: string;
949
- };
950
- cookie?: never;
951
- };
952
- requestBody?: {
953
- content: {
954
- 'application/json': components['schemas']['AddProjectRolesRequest'];
955
- };
956
- };
957
- responses: {
958
- /** @description Roles assigned */
959
- 200: {
960
- headers: {
961
- [name: string]: unknown;
962
- };
963
- content: {
964
- 'application/json': {
965
- /**
966
- * @example SUCCESS
967
- * @enum {string}
968
- */
969
- status: 'SUCCESS' | 'FAILED';
970
- error: string | null;
971
- /** @example Operation successful */
972
- message: string | null;
973
- data: {
974
- assigned: number;
975
- } | null;
976
- };
977
- };
978
- };
979
- };
980
- };
981
- delete?: never;
982
- options?: never;
983
- head?: never;
984
- patch?: never;
985
- trace?: never;
986
- };
987
- '/welders': {
988
- parameters: {
989
- query?: never;
990
- header?: never;
991
- path?: never;
992
- cookie?: never;
993
- };
994
- /** List welders */
995
- get: {
996
- parameters: {
997
- query?: {
998
- page?: string;
999
- limit?: string;
1000
- searchQuery?: string;
1001
- };
1002
- header?: never;
1003
- path?: never;
1004
- cookie?: never;
1005
- };
1006
- requestBody?: never;
1007
- responses: {
1008
- /** @description Welders list */
1009
- 200: {
1010
- headers: {
1011
- [name: string]: unknown;
1012
- };
1013
- content: {
1014
- 'application/json': {
1015
- /**
1016
- * @example SUCCESS
1017
- * @enum {string}
1018
- */
1019
- status: 'SUCCESS' | 'FAILED';
1020
- error: string | null;
1021
- /** @example Operation successful */
1022
- message: string | null;
1023
- data: components['schemas']['Welder'][] | null;
1024
- /** @example 100 */
1025
- count: number;
1026
- /** @example 1 */
1027
- page: number;
1028
- /** @example 10 */
1029
- limit: number;
1030
- /** @example 10 */
1031
- totalPages: number;
1032
- };
1033
- };
1034
- };
1035
- };
1036
- };
1037
- put?: never;
1038
- /** Create welder */
1039
- post: {
1040
- parameters: {
1041
- query?: never;
1042
- header?: never;
1043
- path?: never;
1044
- cookie?: never;
1045
- };
1046
- requestBody?: {
1047
- content: {
1048
- 'application/json': components['schemas']['CreateWelderRequest'];
1049
- };
1050
- };
1051
- responses: {
1052
- /** @description Welder created */
1053
- 201: {
1054
- headers: {
1055
- [name: string]: unknown;
1056
- };
1057
- content: {
1058
- 'application/json': {
1059
- /**
1060
- * @example SUCCESS
1061
- * @enum {string}
1062
- */
1063
- status: 'SUCCESS' | 'FAILED';
1064
- error: string | null;
1065
- /** @example Operation successful */
1066
- message: string | null;
1067
- data: components['schemas']['Welder'] & unknown;
1068
- };
1069
- };
1070
- };
1071
- };
1072
- };
1073
- delete?: never;
1074
- options?: never;
1075
- head?: never;
1076
- patch?: never;
1077
- trace?: never;
1078
- };
1079
- '/welders/{idWelder}': {
1080
- parameters: {
1081
- query?: never;
1082
- header?: never;
1083
- path?: never;
1084
- cookie?: never;
1085
- };
1086
- /** Get welder by ID */
1087
- get: {
1088
- parameters: {
1089
- query?: never;
1090
- header?: never;
1091
- path: {
1092
- idWelder: string;
1093
- };
1094
- cookie?: never;
1095
- };
1096
- requestBody?: never;
1097
- responses: {
1098
- /** @description Welder details */
1099
- 200: {
1100
- headers: {
1101
- [name: string]: unknown;
1102
- };
1103
- content: {
1104
- 'application/json': {
1105
- /**
1106
- * @example SUCCESS
1107
- * @enum {string}
1108
- */
1109
- status: 'SUCCESS' | 'FAILED';
1110
- error: string | null;
1111
- /** @example Operation successful */
1112
- message: string | null;
1113
- data: components['schemas']['Welder'] & unknown;
1114
- };
1115
- };
1116
- };
1117
- };
1118
- };
1119
- put?: never;
1120
- post?: never;
1121
- /** Delete welder */
1122
- delete: {
1123
- parameters: {
1124
- query?: never;
1125
- header?: never;
1126
- path: {
1127
- idWelder: string;
1128
- };
1129
- cookie?: never;
1130
- };
1131
- requestBody?: never;
1132
- responses: {
1133
- /** @description Welder deleted */
1134
- 200: {
1135
- headers: {
1136
- [name: string]: unknown;
1137
- };
1138
- content: {
1139
- 'application/json': {
1140
- /**
1141
- * @example SUCCESS
1142
- * @enum {string}
1143
- */
1144
- status: 'SUCCESS' | 'FAILED';
1145
- error: string | null;
1146
- /** @example Operation successful */
1147
- message: string | null;
1148
- data: {
1149
- deleted: boolean;
1150
- } | null;
1151
- };
1152
- };
1153
- };
1154
- };
1155
- };
1156
- options?: never;
1157
- head?: never;
1158
- /** Update welder */
1159
- patch: {
1160
- parameters: {
1161
- query?: never;
1162
- header?: never;
1163
- path: {
1164
- idWelder: string;
1165
- };
1166
- cookie?: never;
1167
- };
1168
- requestBody?: {
1169
- content: {
1170
- 'application/json': components['schemas']['UpdateWelderRequest'];
1171
- };
1172
- };
1173
- responses: {
1174
- /** @description Welder updated */
1175
- 200: {
1176
- headers: {
1177
- [name: string]: unknown;
1178
- };
1179
- content: {
1180
- 'application/json': {
1181
- /**
1182
- * @example SUCCESS
1183
- * @enum {string}
1184
- */
1185
- status: 'SUCCESS' | 'FAILED';
1186
- error: string | null;
1187
- /** @example Operation successful */
1188
- message: string | null;
1189
- data: components['schemas']['Welder'] & unknown;
1190
- };
1191
- };
1192
- };
1193
- };
1194
- };
1195
- trace?: never;
1196
- };
1197
- '/wps': {
1198
- parameters: {
1199
- query?: never;
1200
- header?: never;
1201
- path?: never;
1202
- cookie?: never;
1203
- };
1204
- /** List WPS documents */
1205
- get: {
1206
- parameters: {
1207
- query?: {
1208
- page?: string;
1209
- limit?: string;
1210
- searchQuery?: string;
1211
- };
1212
- header?: never;
1213
- path?: never;
1214
- cookie?: never;
1215
- };
1216
- requestBody?: never;
1217
- responses: {
1218
- /** @description WPS list */
1219
- 200: {
1220
- headers: {
1221
- [name: string]: unknown;
1222
- };
1223
- content: {
1224
- 'application/json': {
1225
- /**
1226
- * @example SUCCESS
1227
- * @enum {string}
1228
- */
1229
- status: 'SUCCESS' | 'FAILED';
1230
- error: string | null;
1231
- /** @example Operation successful */
1232
- message: string | null;
1233
- data: components['schemas']['WPS'][] | null;
1234
- /** @example 100 */
1235
- count: number;
1236
- /** @example 1 */
1237
- page: number;
1238
- /** @example 10 */
1239
- limit: number;
1240
- /** @example 10 */
1241
- totalPages: number;
1242
- };
1243
- };
1244
- };
1245
- };
1246
- };
1247
- put?: never;
1248
- /** Create WPS */
1249
- post: {
1250
- parameters: {
1251
- query?: never;
1252
- header?: never;
1253
- path?: never;
1254
- cookie?: never;
1255
- };
1256
- requestBody?: {
1257
- content: {
1258
- 'application/json': components['schemas']['CreateWPSRequest'];
1259
- };
1260
- };
1261
- responses: {
1262
- /** @description WPS created */
1263
- 201: {
1264
- headers: {
1265
- [name: string]: unknown;
1266
- };
1267
- content: {
1268
- 'application/json': {
1269
- /**
1270
- * @example SUCCESS
1271
- * @enum {string}
1272
- */
1273
- status: 'SUCCESS' | 'FAILED';
1274
- error: string | null;
1275
- /** @example Operation successful */
1276
- message: string | null;
1277
- data: components['schemas']['WPS'] & unknown;
1278
- };
1279
- };
1280
- };
1281
- };
1282
- };
1283
- delete?: never;
1284
- options?: never;
1285
- head?: never;
1286
- patch?: never;
1287
- trace?: never;
1288
- };
1289
- '/wps/{idWPS}': {
1290
- parameters: {
1291
- query?: never;
1292
- header?: never;
1293
- path?: never;
1294
- cookie?: never;
1295
- };
1296
- /** Get WPS by ID */
1297
- get: {
1298
- parameters: {
1299
- query?: never;
1300
- header?: never;
1301
- path: {
1302
- idWPS: string;
1303
- };
1304
- cookie?: never;
1305
- };
1306
- requestBody?: never;
1307
- responses: {
1308
- /** @description WPS details */
1309
- 200: {
1310
- headers: {
1311
- [name: string]: unknown;
1312
- };
1313
- content: {
1314
- 'application/json': {
1315
- /**
1316
- * @example SUCCESS
1317
- * @enum {string}
1318
- */
1319
- status: 'SUCCESS' | 'FAILED';
1320
- error: string | null;
1321
- /** @example Operation successful */
1322
- message: string | null;
1323
- data: components['schemas']['WPS'] & unknown;
1324
- };
1325
- };
1326
- };
1327
- };
1328
- };
1329
- put?: never;
1330
- post?: never;
1331
- /** Delete WPS */
1332
- delete: {
1333
- parameters: {
1334
- query?: never;
1335
- header?: never;
1336
- path: {
1337
- idWPS: string;
1338
- };
1339
- cookie?: never;
1340
- };
1341
- requestBody?: never;
1342
- responses: {
1343
- /** @description WPS deleted */
1344
- 200: {
1345
- headers: {
1346
- [name: string]: unknown;
1347
- };
1348
- content: {
1349
- 'application/json': {
1350
- /**
1351
- * @example SUCCESS
1352
- * @enum {string}
1353
- */
1354
- status: 'SUCCESS' | 'FAILED';
1355
- error: string | null;
1356
- /** @example Operation successful */
1357
- message: string | null;
1358
- data: {
1359
- deleted: boolean;
1360
- } | null;
1361
- };
1362
- };
1363
- };
1364
- };
1365
- };
1366
- options?: never;
1367
- head?: never;
1368
- patch?: never;
1369
- trace?: never;
1370
- };
1371
- '/wps/{idWPS}/entries': {
1372
- parameters: {
1373
- query?: never;
1374
- header?: never;
1375
- path?: never;
1376
- cookie?: never;
1377
- };
1378
- get?: never;
1379
- put?: never;
1380
- /**
1381
- * Add entries to WPS
1382
- * @description Add material grade and welding process combinations to a WPS.
1383
- */
1384
- post: {
1385
- parameters: {
1386
- query?: never;
1387
- header?: never;
1388
- path: {
1389
- idWPS: string;
1390
- };
1391
- cookie?: never;
1392
- };
1393
- requestBody?: {
1394
- content: {
1395
- 'application/json': components['schemas']['AddWPSEntriesRequest'];
1396
- };
1397
- };
1398
- responses: {
1399
- /** @description Entries added */
1400
- 200: {
1401
- headers: {
1402
- [name: string]: unknown;
1403
- };
1404
- content: {
1405
- 'application/json': {
1406
- /**
1407
- * @example SUCCESS
1408
- * @enum {string}
1409
- */
1410
- status: 'SUCCESS' | 'FAILED';
1411
- error: string | null;
1412
- /** @example Operation successful */
1413
- message: string | null;
1414
- data: {
1415
- added: number;
1416
- } | null;
1417
- };
1418
- };
1419
- };
1420
- };
1421
- };
1422
- delete?: never;
1423
- options?: never;
1424
- head?: never;
1425
- patch?: never;
1426
- trace?: never;
1427
- };
1428
- '/wps/{idWPS}/entries/{idWPSEntry}/welders': {
1429
- parameters: {
1430
- query?: never;
1431
- header?: never;
1432
- path?: never;
1433
- cookie?: never;
1434
- };
1435
- get?: never;
1436
- put?: never;
1437
- /** Add welders to WPS entry */
1438
- post: {
1439
- parameters: {
1440
- query?: never;
1441
- header?: never;
1442
- path: {
1443
- idWPS: string;
1444
- idWPSEntry: string;
1445
- };
1446
- cookie?: never;
1447
- };
1448
- requestBody?: {
1449
- content: {
1450
- 'application/json': components['schemas']['AddWeldersToWPSEntryRequest'];
1451
- };
1452
- };
1453
- responses: {
1454
- /** @description Welders added */
1455
- 200: {
1456
- headers: {
1457
- [name: string]: unknown;
1458
- };
1459
- content: {
1460
- 'application/json': {
1461
- /**
1462
- * @example SUCCESS
1463
- * @enum {string}
1464
- */
1465
- status: 'SUCCESS' | 'FAILED';
1466
- error: string | null;
1467
- /** @example Operation successful */
1468
- message: string | null;
1469
- data: {
1470
- added: number;
1471
- } | null;
1472
- };
1473
- };
1474
- };
1475
- };
1476
- };
1477
- delete?: never;
1478
- options?: never;
1479
- head?: never;
1480
- patch?: never;
1481
- trace?: never;
1482
- };
1483
- '/drafts': {
1484
- parameters: {
1485
- query?: never;
1486
- header?: never;
1487
- path?: never;
1488
- cookie?: never;
1489
- };
1490
- /**
1491
- * List drafts
1492
- * @description Get paginated list of drafts for a project.
1493
- */
1494
- get: {
1495
- parameters: {
1496
- query: {
1497
- idProject: string;
1498
- page?: string;
1499
- limit?: string;
1500
- status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELLED';
1501
- type?: 'ADD' | 'EDIT' | 'DELETE';
1502
- createdBy?: string;
1503
- dateFrom?: string;
1504
- dateTo?: string;
1505
- };
1506
- header?: never;
1507
- path?: never;
1508
- cookie?: never;
1509
- };
1510
- requestBody?: never;
1511
- responses: {
1512
- /** @description Drafts list */
1513
- 200: {
1514
- headers: {
1515
- [name: string]: unknown;
1516
- };
1517
- content: {
1518
- 'application/json': {
1519
- /**
1520
- * @example SUCCESS
1521
- * @enum {string}
1522
- */
1523
- status: 'SUCCESS' | 'FAILED';
1524
- error: string | null;
1525
- /** @example Operation successful */
1526
- message: string | null;
1527
- data: components['schemas']['Draft'][] | null;
1528
- /** @example 100 */
1529
- count: number;
1530
- /** @example 1 */
1531
- page: number;
1532
- /** @example 10 */
1533
- limit: number;
1534
- /** @example 10 */
1535
- totalPages: number;
1536
- };
1537
- };
1538
- };
1539
- };
1540
- };
1541
- put?: never;
1542
- post?: never;
1543
- delete?: never;
1544
- options?: never;
1545
- head?: never;
1546
- patch?: never;
1547
- trace?: never;
1548
- };
1549
- '/drafts/{idDraft}': {
1550
- parameters: {
1551
- query?: never;
1552
- header?: never;
1553
- path?: never;
1554
- cookie?: never;
1555
- };
1556
- /** Get draft details */
1557
- get: {
1558
- parameters: {
1559
- query?: never;
1560
- header?: never;
1561
- path: {
1562
- idDraft: string;
1563
- };
1564
- cookie?: never;
1565
- };
1566
- requestBody?: never;
1567
- responses: {
1568
- /** @description Draft details */
1569
- 200: {
1570
- headers: {
1571
- [name: string]: unknown;
1572
- };
1573
- content: {
1574
- 'application/json': {
1575
- /**
1576
- * @example SUCCESS
1577
- * @enum {string}
1578
- */
1579
- status: 'SUCCESS' | 'FAILED';
1580
- error: string | null;
1581
- /** @example Operation successful */
1582
- message: string | null;
1583
- data: components['schemas']['Draft'] & unknown;
1584
- };
1585
- };
1586
- };
1587
- };
1588
- };
1589
- put?: never;
1590
- post?: never;
1591
- delete?: never;
1592
- options?: never;
1593
- head?: never;
1594
- patch?: never;
1595
- trace?: never;
1596
- };
1597
- '/drafts/upload': {
1598
- parameters: {
1599
- query?: never;
1600
- header?: never;
1601
- path?: never;
1602
- cookie?: never;
1603
- };
1604
- get?: never;
1605
- put?: never;
1606
- /**
1607
- * Upload joint list (ADD draft)
1608
- * @description Upload an Excel file containing joint list to create an ADD draft.
1609
- */
1610
- post: {
1611
- parameters: {
1612
- query: {
1613
- idProject: string;
1614
- };
1615
- header?: never;
1616
- path?: never;
1617
- cookie?: never;
1618
- };
1619
- requestBody?: {
1620
- content: {
1621
- 'multipart/form-data': {
1622
- /** @description Excel file (.xlsx) */
1623
- file?: unknown;
1624
- remarks?: string;
1625
- };
1626
- };
1627
- };
1628
- responses: {
1629
- /** @description Draft created */
1630
- 201: {
1631
- headers: {
1632
- [name: string]: unknown;
1633
- };
1634
- content: {
1635
- 'application/json': {
1636
- /**
1637
- * @example SUCCESS
1638
- * @enum {string}
1639
- */
1640
- status: 'SUCCESS' | 'FAILED';
1641
- error: string | null;
1642
- /** @example Operation successful */
1643
- message: string | null;
1644
- data: components['schemas']['Draft'] & unknown;
1645
- };
1646
- };
1647
- };
1648
- };
1649
- };
1650
- delete?: never;
1651
- options?: never;
1652
- head?: never;
1653
- patch?: never;
1654
- trace?: never;
1655
- };
1656
- '/drafts/edit': {
1657
- parameters: {
1658
- query?: never;
1659
- header?: never;
1660
- path?: never;
1661
- cookie?: never;
1662
- };
1663
- get?: never;
1664
- put?: never;
1665
- /**
1666
- * Create edit draft
1667
- * @description Create a draft to edit existing joints.
1668
- */
1669
- post: {
1670
- parameters: {
1671
- query: {
1672
- idProject: string;
1673
- };
1674
- header?: never;
1675
- path?: never;
1676
- cookie?: never;
1677
- };
1678
- requestBody?: {
1679
- content: {
1680
- 'application/json': components['schemas']['CreateEditDraftRequest'];
1681
- };
1682
- };
1683
- responses: {
1684
- /** @description Edit draft created */
1685
- 201: {
1686
- headers: {
1687
- [name: string]: unknown;
1688
- };
1689
- content: {
1690
- 'application/json': {
1691
- /**
1692
- * @example SUCCESS
1693
- * @enum {string}
1694
- */
1695
- status: 'SUCCESS' | 'FAILED';
1696
- error: string | null;
1697
- /** @example Operation successful */
1698
- message: string | null;
1699
- data: components['schemas']['Draft'] & unknown;
1700
- };
1701
- };
1702
- };
1703
- };
1704
- };
1705
- delete?: never;
1706
- options?: never;
1707
- head?: never;
1708
- patch?: never;
1709
- trace?: never;
1710
- };
1711
- '/drafts/delete': {
1712
- parameters: {
1713
- query?: never;
1714
- header?: never;
1715
- path?: never;
1716
- cookie?: never;
1717
- };
1718
- get?: never;
1719
- put?: never;
1720
- /**
1721
- * Create delete draft
1722
- * @description Create a draft to delete existing joints.
1723
- */
1724
- post: {
1725
- parameters: {
1726
- query: {
1727
- idProject: string;
1728
- };
1729
- header?: never;
1730
- path?: never;
1731
- cookie?: never;
1732
- };
1733
- requestBody?: {
1734
- content: {
1735
- 'application/json': components['schemas']['CreateDeleteDraftRequest'];
1736
- };
1737
- };
1738
- responses: {
1739
- /** @description Delete draft created */
1740
- 201: {
1741
- headers: {
1742
- [name: string]: unknown;
1743
- };
1744
- content: {
1745
- 'application/json': {
1746
- /**
1747
- * @example SUCCESS
1748
- * @enum {string}
1749
- */
1750
- status: 'SUCCESS' | 'FAILED';
1751
- error: string | null;
1752
- /** @example Operation successful */
1753
- message: string | null;
1754
- data: components['schemas']['Draft'] & unknown;
1755
- };
1756
- };
1757
- };
1758
- };
1759
- };
1760
- delete?: never;
1761
- options?: never;
1762
- head?: never;
1763
- patch?: never;
1764
- trace?: never;
1765
- };
1766
- '/drafts/{idDraft}/status': {
1767
- parameters: {
1768
- query?: never;
1769
- header?: never;
1770
- path?: never;
1771
- cookie?: never;
1772
- };
1773
- get?: never;
1774
- put?: never;
1775
- post?: never;
1776
- delete?: never;
1777
- options?: never;
1778
- head?: never;
1779
- /** Approve or reject draft */
1780
- patch: {
1781
- parameters: {
1782
- query?: never;
1783
- header?: never;
1784
- path: {
1785
- idDraft: string;
1786
- };
1787
- cookie?: never;
1788
- };
1789
- requestBody?: {
1790
- content: {
1791
- 'application/json': components['schemas']['UpdateDraftStatusRequest'];
1792
- };
1793
- };
1794
- responses: {
1795
- /** @description Draft status updated */
1796
- 200: {
1797
- headers: {
1798
- [name: string]: unknown;
1799
- };
1800
- content: {
1801
- 'application/json': {
1802
- /**
1803
- * @example SUCCESS
1804
- * @enum {string}
1805
- */
1806
- status: 'SUCCESS' | 'FAILED';
1807
- error: string | null;
1808
- /** @example Operation successful */
1809
- message: string | null;
1810
- data: components['schemas']['Draft'] & unknown;
1811
- };
1812
- };
1813
- };
1814
- };
1815
- };
1816
- trace?: never;
1817
- };
1818
- '/material-grades': {
1819
- parameters: {
1820
- query?: never;
1821
- header?: never;
1822
- path?: never;
1823
- cookie?: never;
1824
- };
1825
- /** List material grades */
1826
- get: {
1827
- parameters: {
1828
- query?: never;
1829
- header?: never;
1830
- path?: never;
1831
- cookie?: never;
1832
- };
1833
- requestBody?: never;
1834
- responses: {
1835
- /** @description Material grades list */
1836
- 200: {
1837
- headers: {
1838
- [name: string]: unknown;
1839
- };
1840
- content: {
1841
- 'application/json': {
1842
- /**
1843
- * @example SUCCESS
1844
- * @enum {string}
1845
- */
1846
- status: 'SUCCESS' | 'FAILED';
1847
- error: string | null;
1848
- /** @example Operation successful */
1849
- message: string | null;
1850
- data: components['schemas']['MaterialGrade'][] | null;
1851
- };
1852
- };
1853
- };
1854
- };
1855
- };
1856
- put?: never;
1857
- post?: never;
1858
- delete?: never;
1859
- options?: never;
1860
- head?: never;
1861
- patch?: never;
1862
- trace?: never;
1863
- };
1864
- '/welding-processes': {
1865
- parameters: {
1866
- query?: never;
1867
- header?: never;
1868
- path?: never;
1869
- cookie?: never;
1870
- };
1871
- /** List welding processes */
1872
- get: {
1873
- parameters: {
1874
- query?: never;
1875
- header?: never;
1876
- path?: never;
1877
- cookie?: never;
1878
- };
1879
- requestBody?: never;
1880
- responses: {
1881
- /** @description Welding processes list */
1882
- 200: {
1883
- headers: {
1884
- [name: string]: unknown;
1885
- };
1886
- content: {
1887
- 'application/json': {
1888
- /**
1889
- * @example SUCCESS
1890
- * @enum {string}
1891
- */
1892
- status: 'SUCCESS' | 'FAILED';
1893
- error: string | null;
1894
- /** @example Operation successful */
1895
- message: string | null;
1896
- data: components['schemas']['WeldingProcess'][] | null;
1897
- };
1898
- };
1899
- };
1900
- };
1901
- };
1902
- put?: never;
1903
- post?: never;
1904
- delete?: never;
1905
- options?: never;
1906
- head?: never;
1907
- patch?: never;
1908
- trace?: never;
1909
- };
1910
- '/welding-codes': {
1911
- parameters: {
1912
- query?: never;
1913
- header?: never;
1914
- path?: never;
1915
- cookie?: never;
1916
- };
1917
- /** List welding codes */
1918
- get: {
1919
- parameters: {
1920
- query?: never;
1921
- header?: never;
1922
- path?: never;
1923
- cookie?: never;
1924
- };
1925
- requestBody?: never;
1926
- responses: {
1927
- /** @description Welding codes list */
1928
- 200: {
1929
- headers: {
1930
- [name: string]: unknown;
1931
- };
1932
- content: {
1933
- 'application/json': {
1934
- /**
1935
- * @example SUCCESS
1936
- * @enum {string}
1937
- */
1938
- status: 'SUCCESS' | 'FAILED';
1939
- error: string | null;
1940
- /** @example Operation successful */
1941
- message: string | null;
1942
- data: components['schemas']['WeldingCode'][] | null;
1943
- };
1944
- };
1945
- };
1946
- };
1947
- };
1948
- put?: never;
1949
- post?: never;
1950
- delete?: never;
1951
- options?: never;
1952
- head?: never;
1953
- patch?: never;
1954
- trace?: never;
1955
- };
1956
- '/schedules': {
1957
- parameters: {
1958
- query?: never;
1959
- header?: never;
1960
- path?: never;
1961
- cookie?: never;
1962
- };
1963
- /** List schedules */
1964
- get: {
1965
- parameters: {
1966
- query?: never;
1967
- header?: never;
1968
- path?: never;
1969
- cookie?: never;
1970
- };
1971
- requestBody?: never;
1972
- responses: {
1973
- /** @description Schedules list */
1974
- 200: {
1975
- headers: {
1976
- [name: string]: unknown;
1977
- };
1978
- content: {
1979
- 'application/json': {
1980
- /**
1981
- * @example SUCCESS
1982
- * @enum {string}
1983
- */
1984
- status: 'SUCCESS' | 'FAILED';
1985
- error: string | null;
1986
- /** @example Operation successful */
1987
- message: string | null;
1988
- data: components['schemas']['Schedule'][] | null;
1989
- };
1990
- };
1991
- };
1992
- };
1993
- };
1994
- put?: never;
1995
- post?: never;
1996
- delete?: never;
1997
- options?: never;
1998
- head?: never;
1999
- patch?: never;
2000
- trace?: never;
2001
- };
2002
- '/joints': {
2003
- parameters: {
2004
- query?: never;
2005
- header?: never;
2006
- path?: never;
2007
- cookie?: never;
2008
- };
2009
- /**
2010
- * List joints
2011
- * @description Get all joints for a project with optional filtering by phase, status, spool, or sheet.
2012
- */
2013
- get: {
2014
- parameters: {
2015
- query: {
2016
- idProject: string;
2017
- page?: string;
2018
- limit?: string;
2019
- phase?: 'FIT_UP' | 'WELDING' | 'NDT' | 'PAINTING' | 'HYDROTEST' | 'COMPLETE';
2020
- status?: string;
2021
- idSpool?: string;
2022
- idSheet?: string;
2023
- };
2024
- header?: never;
2025
- path?: never;
2026
- cookie?: never;
2027
- };
2028
- requestBody?: never;
2029
- responses: {
2030
- /** @description Paginated list of joints */
2031
- 200: {
2032
- headers: {
2033
- [name: string]: unknown;
2034
- };
2035
- content: {
2036
- 'application/json': {
2037
- /**
2038
- * @example SUCCESS
2039
- * @enum {string}
2040
- */
2041
- status: 'SUCCESS' | 'FAILED';
2042
- error: string | null;
2043
- /** @example Operation successful */
2044
- message: string | null;
2045
- data: components['schemas']['Joint'][] | null;
2046
- /** @example 100 */
2047
- count: number;
2048
- /** @example 1 */
2049
- page: number;
2050
- /** @example 10 */
2051
- limit: number;
2052
- /** @example 10 */
2053
- totalPages: number;
2054
- };
2055
- };
2056
- };
2057
- /** @description idProject is required */
2058
- 400: {
2059
- headers: {
2060
- [name: string]: unknown;
2061
- };
2062
- content: {
2063
- 'application/json': components['schemas']['ErrorResponse'];
2064
- };
2065
- };
2066
- };
2067
- };
2068
- put?: never;
2069
- post?: never;
2070
- delete?: never;
2071
- options?: never;
2072
- head?: never;
2073
- patch?: never;
2074
- trace?: never;
2075
- };
2076
- '/joints/queue': {
2077
- parameters: {
2078
- query?: never;
2079
- header?: never;
2080
- path?: never;
2081
- cookie?: never;
2082
- };
2083
- /**
2084
- * Get joints queue
2085
- * @description Get joints assigned to the current user's role queue for a project.
2086
- */
2087
- get: {
2088
- parameters: {
2089
- query: {
2090
- idProject: string;
2091
- page?: string;
2092
- limit?: string;
2093
- };
2094
- header?: never;
2095
- path?: never;
2096
- cookie?: never;
2097
- };
2098
- requestBody?: never;
2099
- responses: {
2100
- /** @description Paginated list of joints in queue */
2101
- 200: {
2102
- headers: {
2103
- [name: string]: unknown;
2104
- };
2105
- content: {
2106
- 'application/json': {
2107
- /**
2108
- * @example SUCCESS
2109
- * @enum {string}
2110
- */
2111
- status: 'SUCCESS' | 'FAILED';
2112
- error: string | null;
2113
- /** @example Operation successful */
2114
- message: string | null;
2115
- data: components['schemas']['Joint'][] | null;
2116
- /** @example 100 */
2117
- count: number;
2118
- /** @example 1 */
2119
- page: number;
2120
- /** @example 10 */
2121
- limit: number;
2122
- /** @example 10 */
2123
- totalPages: number;
2124
- };
2125
- };
2126
- };
2127
- /** @description idProject is required or role has no queue */
2128
- 400: {
2129
- headers: {
2130
- [name: string]: unknown;
2131
- };
2132
- content: {
2133
- 'application/json': components['schemas']['ErrorResponse'];
2134
- };
2135
- };
2136
- };
2137
- };
2138
- put?: never;
2139
- post?: never;
2140
- delete?: never;
2141
- options?: never;
2142
- head?: never;
2143
- patch?: never;
2144
- trace?: never;
2145
- };
2146
- '/joints/{idJoint}': {
2147
- parameters: {
2148
- query?: never;
2149
- header?: never;
2150
- path?: never;
2151
- cookie?: never;
2152
- };
2153
- /**
2154
- * Get joint details
2155
- * @description Get detailed information for a specific joint.
2156
- */
2157
- get: {
2158
- parameters: {
2159
- query?: never;
2160
- header?: never;
2161
- path: {
2162
- idJoint: string;
2163
- };
2164
- cookie?: never;
2165
- };
2166
- requestBody?: never;
2167
- responses: {
2168
- /** @description Joint details */
2169
- 200: {
2170
- headers: {
2171
- [name: string]: unknown;
2172
- };
2173
- content: {
2174
- 'application/json': {
2175
- /**
2176
- * @example SUCCESS
2177
- * @enum {string}
2178
- */
2179
- status: 'SUCCESS' | 'FAILED';
2180
- error: string | null;
2181
- /** @example Operation successful */
2182
- message: string | null;
2183
- data: components['schemas']['Joint'] & unknown;
2184
- };
2185
- };
2186
- };
2187
- /** @description Joint not found */
2188
- 404: {
2189
- headers: {
2190
- [name: string]: unknown;
2191
- };
2192
- content: {
2193
- 'application/json': components['schemas']['ErrorResponse'];
2194
- };
2195
- };
2196
- };
2197
- };
2198
- put?: never;
2199
- post?: never;
2200
- delete?: never;
2201
- options?: never;
2202
- head?: never;
2203
- patch?: never;
2204
- trace?: never;
2205
- };
2206
- '/joints/{idJoint}/logs': {
2207
- parameters: {
2208
- query?: never;
2209
- header?: never;
2210
- path?: never;
2211
- cookie?: never;
2212
- };
2213
- /**
2214
- * Get joint activity logs
2215
- * @description Get the activity/action log history for a specific joint.
2216
- */
2217
- get: {
2218
- parameters: {
2219
- query?: never;
2220
- header?: never;
2221
- path: {
2222
- idJoint: string;
2223
- };
2224
- cookie?: never;
2225
- };
2226
- requestBody?: never;
2227
- responses: {
2228
- /** @description Joint activity logs */
2229
- 200: {
2230
- headers: {
2231
- [name: string]: unknown;
2232
- };
2233
- content: {
2234
- 'application/json': {
2235
- /**
2236
- * @example SUCCESS
2237
- * @enum {string}
2238
- */
2239
- status: 'SUCCESS' | 'FAILED';
2240
- error: string | null;
2241
- /** @example Operation successful */
2242
- message: string | null;
2243
- data: components['schemas']['JointLog'][] | null;
2244
- };
2245
- };
2246
- };
2247
- /** @description Joint not found */
2248
- 404: {
2249
- headers: {
2250
- [name: string]: unknown;
2251
- };
2252
- content: {
2253
- 'application/json': components['schemas']['ErrorResponse'];
2254
- };
2255
- };
2256
- };
2257
- };
2258
- put?: never;
2259
- post?: never;
2260
- delete?: never;
2261
- options?: never;
2262
- head?: never;
2263
- patch?: never;
2264
- trace?: never;
2265
- };
2266
- '/joints/{idJoint}/action': {
2267
- parameters: {
2268
- query?: never;
2269
- header?: never;
2270
- path?: never;
2271
- cookie?: never;
2272
- };
2273
- get?: never;
2274
- put?: never;
2275
- /**
2276
- * Perform action on joint
2277
- * @description Perform a workflow action on a joint. Available actions depend on the joint's current phase and the user's role.
2278
- *
2279
- * **FIT_UP Phase Actions:**
2280
- * - COMPLETE (Fitup Foreman, PE)
2281
- * - APPROVE/REJECT (PE)
2282
- * - QC_APPROVE/QC_REJECT (QC Inspector)
2283
- * - VERIFY_REJECTION (PE)
2284
- *
2285
- * **WELDING Phase Actions:**
2286
- * - COMPLETE (Welding Foreman, PE)
2287
- * - APPROVE/REJECT (PE)
2288
- * - QC_APPROVE/QC_REJECT (QC Inspector)
2289
- * - VERIFY_REJECTION (PE)
2290
- *
2291
- * **NDT Phase Actions:**
2292
- * - PASS/FAIL (NDT Team)
2293
- * - QC_APPROVE (QC Inspector)
2294
- * - PE_APPROVE (PE)
2295
- */
2296
- post: {
2297
- parameters: {
2298
- query?: never;
2299
- header?: never;
2300
- path: {
2301
- idJoint: string;
2302
- };
2303
- cookie?: never;
2304
- };
2305
- requestBody?: {
2306
- content: {
2307
- 'application/json': components['schemas']['JointActionRequest'];
2308
- };
2309
- };
2310
- responses: {
2311
- /** @description Action performed successfully */
2312
- 200: {
2313
- headers: {
2314
- [name: string]: unknown;
2315
- };
2316
- content: {
2317
- 'application/json': {
2318
- /**
2319
- * @example SUCCESS
2320
- * @enum {string}
2321
- */
2322
- status: 'SUCCESS' | 'FAILED';
2323
- error: string | null;
2324
- /** @example Operation successful */
2325
- message: string | null;
2326
- data: components['schemas']['Joint'] & unknown;
2327
- };
2328
- };
2329
- };
2330
- /** @description Invalid action or phase */
2331
- 400: {
2332
- headers: {
2333
- [name: string]: unknown;
2334
- };
2335
- content: {
2336
- 'application/json': components['schemas']['ErrorResponse'];
2337
- };
2338
- };
2339
- /** @description User does not have permission for this action */
2340
- 403: {
2341
- headers: {
2342
- [name: string]: unknown;
2343
- };
2344
- content: {
2345
- 'application/json': components['schemas']['ErrorResponse'];
2346
- };
2347
- };
2348
- /** @description Joint not found */
2349
- 404: {
2350
- headers: {
2351
- [name: string]: unknown;
2352
- };
2353
- content: {
2354
- 'application/json': components['schemas']['ErrorResponse'];
2355
- };
2356
- };
2357
- };
2358
- };
2359
- delete?: never;
2360
- options?: never;
2361
- head?: never;
2362
- patch?: never;
2363
- trace?: never;
2364
- };
2365
- '/spools': {
2366
- parameters: {
2367
- query?: never;
2368
- header?: never;
2369
- path?: never;
2370
- cookie?: never;
2371
- };
2372
- /**
2373
- * List spools
2374
- * @description Get all spools for a project with optional filtering by phase, status, or sheet.
2375
- */
2376
- get: {
2377
- parameters: {
2378
- query: {
2379
- idProject: string;
2380
- page?: string;
2381
- limit?: string;
2382
- phase?: 'PENDING_JOINTS' | 'HYDROTEST' | 'PAINTING' | 'DISPATCH';
2383
- status?: string;
2384
- idSheet?: string;
2385
- };
2386
- header?: never;
2387
- path?: never;
2388
- cookie?: never;
2389
- };
2390
- requestBody?: never;
2391
- responses: {
2392
- /** @description Paginated list of spools */
2393
- 200: {
2394
- headers: {
2395
- [name: string]: unknown;
2396
- };
2397
- content: {
2398
- 'application/json': {
2399
- /**
2400
- * @example SUCCESS
2401
- * @enum {string}
2402
- */
2403
- status: 'SUCCESS' | 'FAILED';
2404
- error: string | null;
2405
- /** @example Operation successful */
2406
- message: string | null;
2407
- data: components['schemas']['Spool'][] | null;
2408
- /** @example 100 */
2409
- count: number;
2410
- /** @example 1 */
2411
- page: number;
2412
- /** @example 10 */
2413
- limit: number;
2414
- /** @example 10 */
2415
- totalPages: number;
2416
- };
2417
- };
2418
- };
2419
- /** @description idProject is required */
2420
- 400: {
2421
- headers: {
2422
- [name: string]: unknown;
2423
- };
2424
- content: {
2425
- 'application/json': components['schemas']['ErrorResponse'];
2426
- };
2427
- };
2428
- };
2429
- };
2430
- put?: never;
2431
- post?: never;
2432
- delete?: never;
2433
- options?: never;
2434
- head?: never;
2435
- patch?: never;
2436
- trace?: never;
2437
- };
2438
- '/spools/queue': {
2439
- parameters: {
2440
- query?: never;
2441
- header?: never;
2442
- path?: never;
2443
- cookie?: never;
2444
- };
2445
- /**
2446
- * Get spools queue
2447
- * @description Get spools assigned to the current user's role queue for a project.
2448
- */
2449
- get: {
2450
- parameters: {
2451
- query: {
2452
- idProject: string;
2453
- page?: string;
2454
- limit?: string;
2455
- };
2456
- header?: never;
2457
- path?: never;
2458
- cookie?: never;
2459
- };
2460
- requestBody?: never;
2461
- responses: {
2462
- /** @description Paginated list of spools in queue */
2463
- 200: {
2464
- headers: {
2465
- [name: string]: unknown;
2466
- };
2467
- content: {
2468
- 'application/json': {
2469
- /**
2470
- * @example SUCCESS
2471
- * @enum {string}
2472
- */
2473
- status: 'SUCCESS' | 'FAILED';
2474
- error: string | null;
2475
- /** @example Operation successful */
2476
- message: string | null;
2477
- data: components['schemas']['Spool'][] | null;
2478
- /** @example 100 */
2479
- count: number;
2480
- /** @example 1 */
2481
- page: number;
2482
- /** @example 10 */
2483
- limit: number;
2484
- /** @example 10 */
2485
- totalPages: number;
2486
- };
2487
- };
2488
- };
2489
- /** @description idProject is required or role has no queue */
2490
- 400: {
2491
- headers: {
2492
- [name: string]: unknown;
2493
- };
2494
- content: {
2495
- 'application/json': components['schemas']['ErrorResponse'];
2496
- };
2497
- };
2498
- };
2499
- };
2500
- put?: never;
2501
- post?: never;
2502
- delete?: never;
2503
- options?: never;
2504
- head?: never;
2505
- patch?: never;
2506
- trace?: never;
2507
- };
2508
- '/spools/{idSpool}': {
2509
- parameters: {
2510
- query?: never;
2511
- header?: never;
2512
- path?: never;
2513
- cookie?: never;
2514
- };
2515
- /**
2516
- * Get spool details
2517
- * @description Get detailed information for a specific spool including its joints.
2518
- */
2519
- get: {
2520
- parameters: {
2521
- query?: never;
2522
- header?: never;
2523
- path: {
2524
- idSpool: string;
2525
- };
2526
- cookie?: never;
2527
- };
2528
- requestBody?: never;
2529
- responses: {
2530
- /** @description Spool details with joints */
2531
- 200: {
2532
- headers: {
2533
- [name: string]: unknown;
2534
- };
2535
- content: {
2536
- 'application/json': {
2537
- /**
2538
- * @example SUCCESS
2539
- * @enum {string}
2540
- */
2541
- status: 'SUCCESS' | 'FAILED';
2542
- error: string | null;
2543
- /** @example Operation successful */
2544
- message: string | null;
2545
- data: {
2546
- spool: components['schemas']['Spool'];
2547
- joints: components['schemas']['Joint'][];
2548
- } | null;
2549
- };
2550
- };
2551
- };
2552
- /** @description Spool not found */
2553
- 404: {
2554
- headers: {
2555
- [name: string]: unknown;
2556
- };
2557
- content: {
2558
- 'application/json': components['schemas']['ErrorResponse'];
2559
- };
2560
- };
2561
- };
2562
- };
2563
- put?: never;
2564
- post?: never;
2565
- delete?: never;
2566
- options?: never;
2567
- head?: never;
2568
- patch?: never;
2569
- trace?: never;
2570
- };
2571
- '/spools/{idSpool}/joints': {
2572
- parameters: {
2573
- query?: never;
2574
- header?: never;
2575
- path?: never;
2576
- cookie?: never;
2577
- };
2578
- /**
2579
- * List joints in spool
2580
- * @description Get paginated list of joints belonging to a specific spool.
2581
- */
2582
- get: {
2583
- parameters: {
2584
- query?: {
2585
- page?: string;
2586
- limit?: string;
2587
- };
2588
- header?: never;
2589
- path: {
2590
- idSpool: string;
2591
- };
2592
- cookie?: never;
2593
- };
2594
- requestBody?: never;
2595
- responses: {
2596
- /** @description Paginated list of joints in spool */
2597
- 200: {
2598
- headers: {
2599
- [name: string]: unknown;
2600
- };
2601
- content: {
2602
- 'application/json': {
2603
- /**
2604
- * @example SUCCESS
2605
- * @enum {string}
2606
- */
2607
- status: 'SUCCESS' | 'FAILED';
2608
- error: string | null;
2609
- /** @example Operation successful */
2610
- message: string | null;
2611
- data: components['schemas']['Joint'][] | null;
2612
- /** @example 100 */
2613
- count: number;
2614
- /** @example 1 */
2615
- page: number;
2616
- /** @example 10 */
2617
- limit: number;
2618
- /** @example 10 */
2619
- totalPages: number;
2620
- };
2621
- };
2622
- };
2623
- /** @description Spool not found */
2624
- 404: {
2625
- headers: {
2626
- [name: string]: unknown;
2627
- };
2628
- content: {
2629
- 'application/json': components['schemas']['ErrorResponse'];
2630
- };
2631
- };
2632
- };
2633
- };
2634
- put?: never;
2635
- post?: never;
2636
- delete?: never;
2637
- options?: never;
2638
- head?: never;
2639
- patch?: never;
2640
- trace?: never;
2641
- };
2642
- '/spools/{idSpool}/logs': {
2643
- parameters: {
2644
- query?: never;
2645
- header?: never;
2646
- path?: never;
2647
- cookie?: never;
2648
- };
2649
- /**
2650
- * Get spool activity logs
2651
- * @description Get the activity/action log history for a specific spool.
2652
- */
2653
- get: {
2654
- parameters: {
2655
- query?: never;
2656
- header?: never;
2657
- path: {
2658
- idSpool: string;
2659
- };
2660
- cookie?: never;
2661
- };
2662
- requestBody?: never;
2663
- responses: {
2664
- /** @description Spool activity logs */
2665
- 200: {
2666
- headers: {
2667
- [name: string]: unknown;
2668
- };
2669
- content: {
2670
- 'application/json': {
2671
- /**
2672
- * @example SUCCESS
2673
- * @enum {string}
2674
- */
2675
- status: 'SUCCESS' | 'FAILED';
2676
- error: string | null;
2677
- /** @example Operation successful */
2678
- message: string | null;
2679
- data: components['schemas']['SpoolLog'][] | null;
2680
- };
2681
- };
2682
- };
2683
- /** @description Spool not found */
2684
- 404: {
2685
- headers: {
2686
- [name: string]: unknown;
2687
- };
2688
- content: {
2689
- 'application/json': components['schemas']['ErrorResponse'];
2690
- };
2691
- };
2692
- };
2693
- };
2694
- put?: never;
2695
- post?: never;
2696
- delete?: never;
2697
- options?: never;
2698
- head?: never;
2699
- patch?: never;
2700
- trace?: never;
2701
- };
2702
- '/spools/{idSpool}/action': {
2703
- parameters: {
2704
- query?: never;
2705
- header?: never;
2706
- path?: never;
2707
- cookie?: never;
2708
- };
2709
- get?: never;
2710
- put?: never;
2711
- /**
2712
- * Perform action on spool
2713
- * @description Perform a workflow action on a spool. Available actions depend on the spool's current phase and the user's role.
2714
- *
2715
- * **HYDROTEST Phase Actions:**
2716
- * - PASS/FAIL (Hydrotest Team)
2717
- * - VERIFY_FAILURE (PE)
2718
- *
2719
- * **PAINTING Phase Actions:**
2720
- * - RFI (Painting Foreman)
2721
- * - PQC_APPROVE/PQC_REJECT (Painting QC)
2722
- * - PM_APPROVE (Project Manager)
2723
- */
2724
- post: {
2725
- parameters: {
2726
- query?: never;
2727
- header?: never;
2728
- path: {
2729
- idSpool: string;
2730
- };
2731
- cookie?: never;
2732
- };
2733
- requestBody?: {
2734
- content: {
2735
- 'application/json': components['schemas']['SpoolActionRequest'];
2736
- };
2737
- };
2738
- responses: {
2739
- /** @description Action performed successfully */
2740
- 200: {
2741
- headers: {
2742
- [name: string]: unknown;
2743
- };
2744
- content: {
2745
- 'application/json': {
2746
- /**
2747
- * @example SUCCESS
2748
- * @enum {string}
2749
- */
2750
- status: 'SUCCESS' | 'FAILED';
2751
- error: string | null;
2752
- /** @example Operation successful */
2753
- message: string | null;
2754
- data: components['schemas']['Spool'] & unknown;
2755
- };
2756
- };
2757
- };
2758
- /** @description Invalid action or phase */
2759
- 400: {
2760
- headers: {
2761
- [name: string]: unknown;
2762
- };
2763
- content: {
2764
- 'application/json': components['schemas']['ErrorResponse'];
2765
- };
2766
- };
2767
- /** @description User does not have permission for this action */
2768
- 403: {
2769
- headers: {
2770
- [name: string]: unknown;
2771
- };
2772
- content: {
2773
- 'application/json': components['schemas']['ErrorResponse'];
2774
- };
2775
- };
2776
- /** @description Spool not found */
2777
- 404: {
2778
- headers: {
2779
- [name: string]: unknown;
2780
- };
2781
- content: {
2782
- 'application/json': components['schemas']['ErrorResponse'];
2783
- };
2784
- };
2785
- };
2786
- };
2787
- delete?: never;
2788
- options?: never;
2789
- head?: never;
2790
- patch?: never;
2791
- trace?: never;
2792
- };
2793
- '/profile': {
2794
- parameters: {
2795
- query?: never;
2796
- header?: never;
2797
- path?: never;
2798
- cookie?: never;
2799
- };
2800
- /**
2801
- * Get current user profile
2802
- * @description Get the authenticated user profile along with their company information.
2803
- */
2804
- get: {
2805
- parameters: {
2806
- query?: never;
2807
- header?: never;
2808
- path?: never;
2809
- cookie?: never;
2810
- };
2811
- requestBody?: never;
2812
- responses: {
2813
- /** @description User profile with company */
2814
- 200: {
2815
- headers: {
2816
- [name: string]: unknown;
2817
- };
2818
- content: {
2819
- 'application/json': {
2820
- /**
2821
- * @example SUCCESS
2822
- * @enum {string}
2823
- */
2824
- status: 'SUCCESS' | 'FAILED';
2825
- error: string | null;
2826
- /** @example Operation successful */
2827
- message: string | null;
2828
- data: components['schemas']['ProfileResponse'] & unknown;
2829
- };
2830
- };
2831
- };
2832
- /** @description User not authenticated */
2833
- 401: {
2834
- headers: {
2835
- [name: string]: unknown;
2836
- };
2837
- content: {
2838
- 'application/json': components['schemas']['ErrorResponse'];
2839
- };
2840
- };
2841
- };
2842
- };
2843
- put?: never;
2844
- post?: never;
2845
- delete?: never;
2846
- options?: never;
2847
- head?: never;
2848
- patch?: never;
2849
- trace?: never;
2850
- };
2851
- '/files/upload': {
2852
- parameters: {
2853
- query?: never;
2854
- header?: never;
2855
- path?: never;
2856
- cookie?: never;
2857
- };
2858
- get?: never;
2859
- put?: never;
2860
- /**
2861
- * Upload a file
2862
- * @description Upload a single file to S3 storage. Accepts multipart/form-data with a file field.
2863
- */
2864
- post: {
2865
- parameters: {
2866
- query?: never;
2867
- header?: never;
2868
- path?: never;
2869
- cookie?: never;
2870
- };
2871
- requestBody?: {
2872
- content: {
2873
- 'multipart/form-data': {
2874
- /** Format: binary */
2875
- file?: string;
2876
- };
2877
- };
2878
- };
2879
- responses: {
2880
- /** @description File uploaded successfully */
2881
- 200: {
2882
- headers: {
2883
- [name: string]: unknown;
2884
- };
2885
- content: {
2886
- 'application/json': {
2887
- /**
2888
- * @example SUCCESS
2889
- * @enum {string}
2890
- */
2891
- status: 'SUCCESS' | 'FAILED';
2892
- error: string | null;
2893
- /** @example Operation successful */
2894
- message: string | null;
2895
- data: components['schemas']['FileUploadResponse'] & unknown;
2896
- };
2897
- };
2898
- };
2899
- /** @description No file uploaded or invalid file */
2900
- 400: {
2901
- headers: {
2902
- [name: string]: unknown;
2903
- };
2904
- content: {
2905
- 'application/json': components['schemas']['ErrorResponse'];
2906
- };
2907
- };
2908
- };
2909
- };
2910
- delete?: never;
2911
- options?: never;
2912
- head?: never;
2913
- patch?: never;
2914
- trace?: never;
2915
- };
2916
- '/projects/{idProject}/phases': {
2917
- parameters: {
2918
- query?: never;
2919
- header?: never;
2920
- path?: never;
2921
- cookie?: never;
2922
- };
2923
- /**
2924
- * List project phases
2925
- * @description Get all phases configured for a specific project.
2926
- */
2927
- get: {
2928
- parameters: {
2929
- query?: never;
2930
- header?: never;
2931
- path: {
2932
- idProject: string;
2933
- };
2934
- cookie?: never;
2935
- };
2936
- requestBody?: never;
2937
- responses: {
2938
- /** @description List of project phases */
2939
- 200: {
2940
- headers: {
2941
- [name: string]: unknown;
2942
- };
2943
- content: {
2944
- 'application/json': {
2945
- /**
2946
- * @example SUCCESS
2947
- * @enum {string}
2948
- */
2949
- status: 'SUCCESS' | 'FAILED';
2950
- error: string | null;
2951
- /** @example Operation successful */
2952
- message: string | null;
2953
- data: components['schemas']['ProjectPhase'][] | null;
2954
- };
2955
- };
2956
- };
2957
- /** @description Project not found */
2958
- 404: {
2959
- headers: {
2960
- [name: string]: unknown;
2961
- };
2962
- content: {
2963
- 'application/json': components['schemas']['ErrorResponse'];
2964
- };
2965
- };
2966
- };
2967
- };
2968
- put?: never;
2969
- post?: never;
2970
- delete?: never;
2971
- options?: never;
2972
- head?: never;
2973
- patch?: never;
2974
- trace?: never;
2975
- };
2976
- '/projects/{idProject}/phases/enable': {
2977
- parameters: {
2978
- query?: never;
2979
- header?: never;
2980
- path?: never;
2981
- cookie?: never;
2982
- };
2983
- get?: never;
2984
- put?: never;
2985
- /**
2986
- * Enable project phases
2987
- * @description Enable one or more phases for a project. Only PM can enable phases.
2988
- */
2989
- post: {
2990
- parameters: {
2991
- query?: never;
2992
- header?: never;
2993
- path: {
2994
- idProject: string;
2995
- };
2996
- cookie?: never;
2997
- };
2998
- requestBody?: {
2999
- content: {
3000
- 'application/json': components['schemas']['EnablePhasesRequest'];
3001
- };
3002
- };
3003
- responses: {
3004
- /** @description Phases enabled successfully */
3005
- 200: {
3006
- headers: {
3007
- [name: string]: unknown;
3008
- };
3009
- content: {
3010
- 'application/json': {
3011
- /**
3012
- * @example SUCCESS
3013
- * @enum {string}
3014
- */
3015
- status: 'SUCCESS' | 'FAILED';
3016
- error: string | null;
3017
- /** @example Operation successful */
3018
- message: string | null;
3019
- data: components['schemas']['ProjectPhase'][] | null;
3020
- };
3021
- };
3022
- };
3023
- /** @description Invalid phases */
3024
- 400: {
3025
- headers: {
3026
- [name: string]: unknown;
3027
- };
3028
- content: {
3029
- 'application/json': components['schemas']['ErrorResponse'];
3030
- };
3031
- };
3032
- /** @description Only Project Manager can enable phases */
3033
- 403: {
3034
- headers: {
3035
- [name: string]: unknown;
3036
- };
3037
- content: {
3038
- 'application/json': components['schemas']['ErrorResponse'];
3039
- };
3040
- };
3041
- };
3042
- };
3043
- delete?: never;
3044
- options?: never;
3045
- head?: never;
3046
- patch?: never;
3047
- trace?: never;
3048
- };
3049
- '/projects/{idProject}/phases/disable': {
3050
- parameters: {
3051
- query?: never;
3052
- header?: never;
3053
- path?: never;
3054
- cookie?: never;
3055
- };
3056
- get?: never;
3057
- put?: never;
3058
- /**
3059
- * Disable project phases
3060
- * @description Disable one or more phases for a project. Only PM can disable phases.
3061
- */
3062
- post: {
3063
- parameters: {
3064
- query?: never;
3065
- header?: never;
3066
- path: {
3067
- idProject: string;
3068
- };
3069
- cookie?: never;
3070
- };
3071
- requestBody?: {
3072
- content: {
3073
- 'application/json': components['schemas']['DisablePhasesRequest'];
3074
- };
3075
- };
3076
- responses: {
3077
- /** @description Phases disabled successfully */
3078
- 200: {
3079
- headers: {
3080
- [name: string]: unknown;
3081
- };
3082
- content: {
3083
- 'application/json': {
3084
- /**
3085
- * @example SUCCESS
3086
- * @enum {string}
3087
- */
3088
- status: 'SUCCESS' | 'FAILED';
3089
- error: string | null;
3090
- /** @example Operation successful */
3091
- message: string | null;
3092
- data: components['schemas']['ProjectPhase'][] | null;
3093
- };
3094
- };
3095
- };
3096
- /** @description Invalid phases or phases in use */
3097
- 400: {
3098
- headers: {
3099
- [name: string]: unknown;
3100
- };
3101
- content: {
3102
- 'application/json': components['schemas']['ErrorResponse'];
3103
- };
3104
- };
3105
- /** @description Only Project Manager can disable phases */
3106
- 403: {
3107
- headers: {
3108
- [name: string]: unknown;
3109
- };
3110
- content: {
3111
- 'application/json': components['schemas']['ErrorResponse'];
3112
- };
3113
- };
3114
- };
3115
- };
3116
- delete?: never;
3117
- options?: never;
3118
- head?: never;
3119
- patch?: never;
3120
- trace?: never;
3121
- };
3122
- '/dashboard/overview': {
3123
- parameters: {
3124
- query?: never;
3125
- header?: never;
3126
- path?: never;
3127
- cookie?: never;
3128
- };
3129
- /**
3130
- * Get dashboard overview
3131
- * @description Get project-wide statistics including joint and spool phase stats. Only PM/PE can access.
3132
- */
3133
- get: {
3134
- parameters: {
3135
- query: {
3136
- idProject: string;
3137
- };
3138
- header?: never;
3139
- path?: never;
3140
- cookie?: never;
3141
- };
3142
- requestBody?: never;
3143
- responses: {
3144
- /** @description Dashboard overview statistics */
3145
- 200: {
3146
- headers: {
3147
- [name: string]: unknown;
3148
- };
3149
- content: {
3150
- 'application/json': {
3151
- /**
3152
- * @example SUCCESS
3153
- * @enum {string}
3154
- */
3155
- status: 'SUCCESS' | 'FAILED';
3156
- error: string | null;
3157
- /** @example Operation successful */
3158
- message: string | null;
3159
- data: components['schemas']['DashboardOverview'] & unknown;
3160
- };
3161
- };
3162
- };
3163
- /** @description idProject is required */
3164
- 400: {
3165
- headers: {
3166
- [name: string]: unknown;
3167
- };
3168
- content: {
3169
- 'application/json': components['schemas']['ErrorResponse'];
3170
- };
3171
- };
3172
- /** @description Only PM or PE can view dashboard overview */
3173
- 403: {
3174
- headers: {
3175
- [name: string]: unknown;
3176
- };
3177
- content: {
3178
- 'application/json': components['schemas']['ErrorResponse'];
3179
- };
3180
- };
3181
- };
3182
- };
3183
- put?: never;
3184
- post?: never;
3185
- delete?: never;
3186
- options?: never;
3187
- head?: never;
3188
- patch?: never;
3189
- trace?: never;
3190
- };
3191
- '/dashboard/queue-count': {
3192
- parameters: {
3193
- query?: never;
3194
- header?: never;
3195
- path?: never;
3196
- cookie?: never;
3197
- };
3198
- /**
3199
- * Get queue counts
3200
- * @description Get count of items in each role queue for a project.
3201
- */
3202
- get: {
3203
- parameters: {
3204
- query: {
3205
- idProject: string;
3206
- };
3207
- header?: never;
3208
- path?: never;
3209
- cookie?: never;
3210
- };
3211
- requestBody?: never;
3212
- responses: {
3213
- /** @description Queue counts by role */
3214
- 200: {
3215
- headers: {
3216
- [name: string]: unknown;
3217
- };
3218
- content: {
3219
- 'application/json': {
3220
- /**
3221
- * @example SUCCESS
3222
- * @enum {string}
3223
- */
3224
- status: 'SUCCESS' | 'FAILED';
3225
- error: string | null;
3226
- /** @example Operation successful */
3227
- message: string | null;
3228
- data: components['schemas']['QueueCount'][] | null;
3229
- };
3230
- };
3231
- };
3232
- /** @description idProject is required */
3233
- 400: {
3234
- headers: {
3235
- [name: string]: unknown;
3236
- };
3237
- content: {
3238
- 'application/json': components['schemas']['ErrorResponse'];
3239
- };
3240
- };
3241
- };
3242
- };
3243
- put?: never;
3244
- post?: never;
3245
- delete?: never;
3246
- options?: never;
3247
- head?: never;
3248
- patch?: never;
3249
- trace?: never;
3250
- };
3251
- '/dashboard/phase-breakdown': {
3252
- parameters: {
3253
- query?: never;
3254
- header?: never;
3255
- path?: never;
3256
- cookie?: never;
3257
- };
3258
- /**
3259
- * Get phase breakdown
3260
- * @description Get joints and spools count grouped by phase. Only PM/PE can access.
3261
- */
3262
- get: {
3263
- parameters: {
3264
- query: {
3265
- idProject: string;
3266
- };
3267
- header?: never;
3268
- path?: never;
3269
- cookie?: never;
3270
- };
3271
- requestBody?: never;
3272
- responses: {
3273
- /** @description Phase breakdown statistics */
3274
- 200: {
3275
- headers: {
3276
- [name: string]: unknown;
3277
- };
3278
- content: {
3279
- 'application/json': {
3280
- /**
3281
- * @example SUCCESS
3282
- * @enum {string}
3283
- */
3284
- status: 'SUCCESS' | 'FAILED';
3285
- error: string | null;
3286
- /** @example Operation successful */
3287
- message: string | null;
3288
- data: components['schemas']['PhaseBreakdown'] & unknown;
3289
- };
3290
- };
3291
- };
3292
- /** @description idProject is required */
3293
- 400: {
3294
- headers: {
3295
- [name: string]: unknown;
3296
- };
3297
- content: {
3298
- 'application/json': components['schemas']['ErrorResponse'];
3299
- };
3300
- };
3301
- /** @description Only PM or PE can view phase breakdown */
3302
- 403: {
3303
- headers: {
3304
- [name: string]: unknown;
3305
- };
3306
- content: {
3307
- 'application/json': components['schemas']['ErrorResponse'];
3308
- };
3309
- };
3310
- };
3311
- };
3312
- put?: never;
3313
- post?: never;
3314
- delete?: never;
3315
- options?: never;
3316
- head?: never;
3317
- patch?: never;
3318
- trace?: never;
3319
- };
3320
- '/dashboard/draftsman': {
3321
- parameters: {
3322
- query?: never;
3323
- header?: never;
3324
- path?: never;
3325
- cookie?: never;
3326
- };
3327
- /**
3328
- * Get draftsman dashboard
3329
- * @description Get dashboard metrics for draftsman including total joints, drafts, and pending approvals.
3330
- */
3331
- get: {
3332
- parameters: {
3333
- query: {
3334
- idProject: string;
3335
- };
3336
- header?: never;
3337
- path?: never;
3338
- cookie?: never;
3339
- };
3340
- requestBody?: never;
3341
- responses: {
3342
- /** @description Draftsman dashboard statistics */
3343
- 200: {
3344
- headers: {
3345
- [name: string]: unknown;
3346
- };
3347
- content: {
3348
- 'application/json': {
3349
- /**
3350
- * @example SUCCESS
3351
- * @enum {string}
3352
- */
3353
- status: 'SUCCESS' | 'FAILED';
3354
- error: string | null;
3355
- /** @example Operation successful */
3356
- message: string | null;
3357
- data: components['schemas']['DraftsmanDashboard'] & unknown;
3358
- };
3359
- };
3360
- };
3361
- /** @description idProject is required */
3362
- 400: {
3363
- headers: {
3364
- [name: string]: unknown;
3365
- };
3366
- content: {
3367
- 'application/json': components['schemas']['ErrorResponse'];
3368
- };
3369
- };
3370
- /** @description Only Draftsman can access this dashboard */
3371
- 403: {
3372
- headers: {
3373
- [name: string]: unknown;
3374
- };
3375
- content: {
3376
- 'application/json': components['schemas']['ErrorResponse'];
3377
- };
3378
- };
3379
- };
3380
- };
3381
- put?: never;
3382
- post?: never;
3383
- delete?: never;
3384
- options?: never;
3385
- head?: never;
3386
- patch?: never;
3387
- trace?: never;
3388
- };
3389
- }
3390
- export type webhooks = Record<string, never>;
3391
- export interface components {
3392
- schemas: {
3393
- PaginationQuery: {
3394
- /**
3395
- * @description Page number
3396
- * @default 1
3397
- * @example 1
3398
- */
3399
- page: string;
3400
- /**
3401
- * @description Items per page (max 100)
3402
- * @default 10
3403
- * @example 10
3404
- */
3405
- limit: string;
3406
- };
3407
- ErrorResponse: {
3408
- /**
3409
- * @example FAILED
3410
- * @enum {string}
3411
- */
3412
- status: 'FAILED';
3413
- /** @example UNAUTHORIZED */
3414
- error: string;
3415
- /** @example You are not authorized */
3416
- message: string;
3417
- data: unknown;
3418
- };
3419
- SendOTPRequest: {
3420
- /**
3421
- * Format: email
3422
- * @example user@example.com
3423
- */
3424
- emailId: string;
3425
- /**
3426
- * @example LOGIN
3427
- * @enum {string}
3428
- */
3429
- purpose: 'LOGIN' | 'PASSWORD_RESET';
3430
- };
3431
- LoginViaOTPRequest: {
3432
- /**
3433
- * Format: email
3434
- * @example user@example.com
3435
- */
3436
- emailId: string;
3437
- /** @example 123456 */
3438
- otp: string;
3439
- };
3440
- User: {
3441
- /** @example 1 */
3442
- idUser: number;
3443
- /**
3444
- * Format: email
3445
- * @example user@example.com
3446
- */
3447
- emailId?: string;
3448
- /**
3449
- * @example PROJECT_MANAGER
3450
- * @enum {string}
3451
- */
3452
- role?: 'PRODUCT_ADMIN' | 'COMPANY_ADMIN' | 'PROJECT_MANAGER' | 'DRAFTSMAN' | 'FITUP_FOREMAN' | 'PRODUCTION_ENGINEER' | 'WELDING_FOREMAN' | 'QC_INSPECTOR' | 'NDT_TEAM' | 'HYDROTEST_TEAM' | 'PAINTING_FOREMAN' | 'PAINTING_QC';
3453
- /** @example John */
3454
- firstName?: string;
3455
- /** @example Doe */
3456
- lastName?: string | null;
3457
- /**
3458
- * @example MALE
3459
- * @enum {string}
3460
- */
3461
- gender?: 'MALE' | 'FEMALE';
3462
- /** @example +1234567890 */
3463
- phoneNumber?: string | null;
3464
- /** @example 1 */
3465
- idCompany?: number | null;
3466
- /**
3467
- * @example ACTIVE
3468
- * @enum {string}
3469
- */
3470
- status?: 'ACTIVE' | 'REMOVED' | 'DISABLED';
3471
- /**
3472
- * Format: date-time
3473
- * @example 2024-01-01T00:00:00Z
3474
- */
3475
- createdAt?: string;
3476
- /** @example 5 */
3477
- projectsCount?: number;
3478
- };
3479
- CreateUserRequest: {
3480
- /**
3481
- * Format: email
3482
- * @example newuser@example.com
3483
- */
3484
- emailId: string;
3485
- /** @example securePassword123 */
3486
- password: string;
3487
- /** @example John */
3488
- firstName: string;
3489
- /** @example Doe */
3490
- lastName?: string | null;
3491
- /**
3492
- * @example MALE
3493
- * @enum {string}
3494
- */
3495
- gender: 'MALE' | 'FEMALE';
3496
- /**
3497
- * @example PROJECT_MANAGER
3498
- * @enum {string}
3499
- */
3500
- role: 'COMPANY_ADMIN' | 'PROJECT_MANAGER' | 'DRAFTSMAN' | 'FITUP_FOREMAN' | 'PRODUCTION_ENGINEER' | 'WELDING_FOREMAN' | 'QC_INSPECTOR' | 'NDT_TEAM' | 'HYDROTEST_TEAM' | 'PAINTING_FOREMAN' | 'PAINTING_QC';
3501
- /** @example +1234567890 */
3502
- phoneNumber?: string | null;
3503
- /** @example 1 */
3504
- idCompany?: number;
3505
- };
3506
- UpdateUserRequest: {
3507
- /** @example John */
3508
- firstName?: string;
3509
- /** @example Doe */
3510
- lastName?: string | null;
3511
- /**
3512
- * @example MALE
3513
- * @enum {string}
3514
- */
3515
- gender?: 'MALE' | 'FEMALE';
3516
- /** @example +1234567890 */
3517
- phoneNumber?: string | null;
3518
- };
3519
- ChangeUserStatusRequest: {
3520
- /**
3521
- * @example BLOCK
3522
- * @enum {string}
3523
- */
3524
- action: 'BLOCK' | 'UNBLOCK';
3525
- };
3526
- Company: {
3527
- /** @example 1 */
3528
- idCompany: number;
3529
- /** @example ABC Industries */
3530
- name?: string | null;
3531
- /** @example ABC-001 */
3532
- companyId?: string | null;
3533
- /** @example 123 Industrial Ave */
3534
- address?: string | null;
3535
- /**
3536
- * @example ACTIVE
3537
- * @enum {string}
3538
- */
3539
- status?: 'ACTIVE' | 'DISABLED' | 'REMOVED';
3540
- /**
3541
- * Format: date-time
3542
- * @example 2024-01-01T00:00:00Z
3543
- */
3544
- createdAt?: string | null;
3545
- /** @example 25 */
3546
- usersCount?: number;
3547
- /** @example 10 */
3548
- projectsCount?: number;
3549
- };
3550
- CreateCompanyRequest: {
3551
- /** @example ABC Industries */
3552
- name: string;
3553
- /** @example ABC-001 */
3554
- companyId: string;
3555
- /** @example 123 Industrial Ave */
3556
- address: string;
3557
- admin: {
3558
- /**
3559
- * Format: email
3560
- * @example admin@abcindustries.com
3561
- */
3562
- emailId: string;
3563
- /** @example securePassword123 */
3564
- password: string;
3565
- /** @example Admin */
3566
- firstName: string;
3567
- /** @example User */
3568
- lastName?: string | null;
3569
- /**
3570
- * @example MALE
3571
- * @enum {string}
3572
- */
3573
- gender: 'MALE' | 'FEMALE';
3574
- /** @example +1234567890 */
3575
- phoneNumber?: string | null;
3576
- };
3577
- };
3578
- UpdateCompanyRequest: {
3579
- /** @example ABC Industries Updated */
3580
- name?: string;
3581
- /** @example ABC-002 */
3582
- companyId?: string;
3583
- /** @example 456 Industrial Blvd */
3584
- address?: string;
3585
- };
3586
- Project: {
3587
- /** @example 1 */
3588
- idProject: number;
3589
- /** @example 1 */
3590
- idCompany?: number;
3591
- /** @example PRJ-001 */
3592
- code?: string;
3593
- /** @example Pipeline Installation Project */
3594
- name?: string;
3595
- /** @example Client Corp */
3596
- clientName?: string;
3597
- /** @example 2024-01-01 */
3598
- startDate?: string;
3599
- /** @example 2024-12-31 */
3600
- endDate?: string;
3601
- /**
3602
- * @example ACTIVE
3603
- * @enum {string}
3604
- */
3605
- status?: 'ACTIVE' | 'COMPLETED' | 'ON_HOLD' | 'REMOVED';
3606
- /** @example Houston, TX */
3607
- location?: string;
3608
- /**
3609
- * Format: date-time
3610
- * @example 2024-01-01T00:00:00Z
3611
- */
3612
- createdAt?: string;
3613
- };
3614
- CreateProjectRequest: {
3615
- /** @example PRJ-001 */
3616
- code: string;
3617
- /** @example Pipeline Installation Project */
3618
- name: string;
3619
- /** @example Client Corp */
3620
- clientName: string;
3621
- /**
3622
- * @description ISO date format
3623
- * @example 2024-01-01
3624
- */
3625
- startDate: string;
3626
- /**
3627
- * @description ISO date format
3628
- * @example 2024-12-31
3629
- */
3630
- endDate: string;
3631
- /** @example Houston, TX */
3632
- location: string;
3633
- /**
3634
- * @description Must include FIT_UP and WELDING
3635
- * @example [
3636
- * "FIT_UP",
3637
- * "WELDING",
3638
- * "NDT"
3639
- * ]
3640
- */
3641
- phases: ('FIT_UP' | 'WELDING' | 'NDT' | 'HYDROTEST' | 'PAINTING' | 'DISPATCH')[];
3642
- };
3643
- UpdateProjectRequest: {
3644
- /** @example PRJ-001-A */
3645
- code?: string;
3646
- /** @example Updated Project Name */
3647
- name?: string;
3648
- /** @example New Client Corp */
3649
- clientName?: string;
3650
- /** @example 2024-01-15 */
3651
- startDate?: string;
3652
- /** @example 2025-01-31 */
3653
- endDate?: string;
3654
- /** @example Dallas, TX */
3655
- location?: string;
3656
- };
3657
- ChangeProjectStatusRequest: {
3658
- /**
3659
- * @example HOLD
3660
- * @enum {string}
3661
- */
3662
- action: 'HOLD' | 'RESUME' | 'COMPLETE';
3663
- };
3664
- AddProjectRolesRequest: {
3665
- /**
3666
- * @example PROJECT_MANAGER
3667
- * @enum {string}
3668
- */
3669
- role: 'PROJECT_MANAGER' | 'DRAFTSMAN' | 'FITUP_FOREMAN' | 'PRODUCTION_ENGINEER' | 'WELDING_FOREMAN' | 'QC_INSPECTOR' | 'NDT_TEAM' | 'HYDROTEST_TEAM' | 'PAINTING_FOREMAN' | 'PAINTING_QC';
3670
- /**
3671
- * @example [
3672
- * 1,
3673
- * 2,
3674
- * 3
3675
- * ]
3676
- */
3677
- users: number[];
3678
- }[];
3679
- Welder: {
3680
- /** @example 1 */
3681
- idWelder?: number;
3682
- /** @example WLD-001 */
3683
- welderId?: string;
3684
- /** @example John */
3685
- firstName?: string;
3686
- /** @example Smith */
3687
- lastName?: string;
3688
- /**
3689
- * @example ACTIVE
3690
- * @enum {string}
3691
- */
3692
- status?: 'ACTIVE' | 'REMOVED';
3693
- /**
3694
- * Format: date-time
3695
- * @example 2024-01-01T00:00:00Z
3696
- */
3697
- createdAt?: string;
3698
- /** @example 5 */
3699
- wpsIdsCount?: number;
3700
- };
3701
- CreateWelderRequest: {
3702
- /** @example WLD-001 */
3703
- welderId: string;
3704
- /** @example John */
3705
- firstName: string;
3706
- /** @example Smith */
3707
- lastName: string;
3708
- /**
3709
- * @description Array of welding process-code set IDs
3710
- * @example [
3711
- * 1,
3712
- * 2
3713
- * ]
3714
- */
3715
- processSets: number[];
3716
- };
3717
- UpdateWelderRequest: {
3718
- /** @example WLD-001-A */
3719
- welderId?: string;
3720
- /** @example John */
3721
- firstName?: string;
3722
- /** @example Smith */
3723
- lastName?: string;
3724
- /**
3725
- * @example [
3726
- * 1,
3727
- * 2,
3728
- * 3
3729
- * ]
3730
- */
3731
- processSets?: number[];
3732
- };
3733
- WPS: {
3734
- /** @example 1 */
3735
- idWPS?: number;
3736
- /** @example WPS-001 */
3737
- WPSID?: string;
3738
- /**
3739
- * Format: uri
3740
- * @example https://example.com/wps.pdf
3741
- */
3742
- pdfUrl?: string;
3743
- /**
3744
- * Format: date-time
3745
- * @example 2024-01-01T00:00:00Z
3746
- */
3747
- createdAt?: string;
3748
- };
3749
- CreateWPSRequest: {
3750
- /** @example WPS-001 */
3751
- WPSID: string;
3752
- /**
3753
- * Format: uri
3754
- * @example https://example.com/wps.pdf
3755
- */
3756
- pdfUrl: string;
3757
- };
3758
- WPSEntry: {
3759
- /** @example 1 */
3760
- idMaterialGradePrimary: number;
3761
- /** @example 2 */
3762
- idMaterialGradeSecondary: number;
3763
- /** @example 5 */
3764
- thicknessMinimum: number;
3765
- /** @example 20 */
3766
- thicknessMaximum: number;
3767
- /** @example 1 */
3768
- idWeldingProcess: number;
3769
- };
3770
- AddWPSEntriesRequest: components['schemas']['WPSEntry'][];
3771
- /**
3772
- * @example [
3773
- * 1,
3774
- * 2,
3775
- * 3
3776
- * ]
3777
- */
3778
- AddWeldersToWPSEntryRequest: number[];
3779
- Draft: {
3780
- /** @example 1 */
3781
- idDraft: number;
3782
- /**
3783
- * @example ADD
3784
- * @enum {string}
3785
- */
3786
- type: 'ADD' | 'EDIT' | 'DELETE';
3787
- /**
3788
- * @example PENDING
3789
- * @enum {string}
3790
- */
3791
- status: 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELLED';
3792
- /** @example Initial upload */
3793
- remarks?: string | null;
3794
- /**
3795
- * Format: date-time
3796
- * @example 2024-01-01T00:00:00Z
3797
- */
3798
- createdAt: string;
3799
- /** @example 1 */
3800
- createdBy: number;
3801
- /** @example 50 */
3802
- jointCount?: number;
3803
- };
3804
- JointRow: {
3805
- /** @example DWG-001 */
3806
- drawingNo: string;
3807
- /** @example 1 */
3808
- sheet: string;
3809
- /** @example A */
3810
- rev: string;
3811
- /** @example SP-001 */
3812
- spoolNo: string;
3813
- /** @example 6 */
3814
- size: number;
3815
- /** @example 40 */
3816
- schThickness: string;
3817
- /** @example J-001 */
3818
- jointNo: string;
3819
- /** @example A1 */
3820
- pipeClass: string;
3821
- /** @example A106 Gr.B */
3822
- materialGrade1: string;
3823
- /** @example A106 Gr.B */
3824
- materialGrade2: string;
3825
- /** @example Field weld */
3826
- remarks?: string | null;
3827
- };
3828
- CreateEditDraftRequest: {
3829
- joints: {
3830
- /** @example 1 */
3831
- idJoint: number;
3832
- /** @example J-001-A */
3833
- number?: string;
3834
- /** @example Updated */
3835
- remarks?: string | null;
3836
- }[];
3837
- sheetRevisions?: {
3838
- /** @example 1 */
3839
- idSheet: number;
3840
- /** @example B */
3841
- revisionNumber: string;
3842
- }[];
3843
- /** @example Revision update */
3844
- remarks?: string | null;
3845
- };
3846
- CreateDeleteDraftRequest: {
3847
- /**
3848
- * @example [
3849
- * 1,
3850
- * 2,
3851
- * 3
3852
- * ]
3853
- */
3854
- jointIds: number[];
3855
- sheetRevisions?: {
3856
- /** @example 1 */
3857
- idSheet: number;
3858
- /** @example C */
3859
- revisionNumber: string;
3860
- }[];
3861
- /** @example Removing obsolete joints */
3862
- remarks?: string | null;
3863
- };
3864
- UpdateDraftStatusRequest: {
3865
- /**
3866
- * @example APPROVED
3867
- * @enum {string}
3868
- */
3869
- action: 'APPROVED' | 'REJECTED';
3870
- /** @example Looks good */
3871
- remarks?: string;
3872
- };
3873
- MaterialGrade: {
3874
- /** @example 1 */
3875
- idMaterialGrade: number;
3876
- /** @example A106 Gr.B */
3877
- name: string;
3878
- /** @example Carbon Steel */
3879
- description?: string | null;
3880
- };
3881
- WeldingProcess: {
3882
- /** @example 1 */
3883
- idWeldingProcess: number;
3884
- /** @example GTAW */
3885
- name: string;
3886
- /** @example Gas Tungsten Arc Welding */
3887
- description?: string | null;
3888
- };
3889
- WeldingCode: {
3890
- /** @example 1 */
3891
- idWeldingCode: number;
3892
- /** @example ASME B31.3 */
3893
- name: string;
3894
- /** @example Process Piping */
3895
- description?: string | null;
3896
- };
3897
- Schedule: {
3898
- /** @example 1 */
3899
- idSchedule: number;
3900
- /** @example 40 */
3901
- name: string;
3902
- /** @example 3.91 */
3903
- thickness?: number;
3904
- };
3905
- Joint: {
3906
- /** @example 1 */
3907
- idJoint: number;
3908
- /** @example 1 */
3909
- idProject: number;
3910
- /** @example 1 */
3911
- idSpool: number;
3912
- /** @example 1 */
3913
- idSheet: number;
3914
- /** @example J-001 */
3915
- number: string;
3916
- /** @example 6 */
3917
- size: number;
3918
- /** @example A1 */
3919
- pipeClass?: string | null;
3920
- /** @example 1 */
3921
- idMaterialGrade1?: number | null;
3922
- /** @example 1 */
3923
- idMaterialGrade2?: number | null;
3924
- /** @example 1 */
3925
- idSchedule?: number | null;
3926
- /**
3927
- * @example FIT_UP
3928
- * @enum {string}
3929
- */
3930
- phase: 'FIT_UP' | 'WELDING' | 'NDT' | 'PAINTING' | 'HYDROTEST' | 'COMPLETE';
3931
- /** @example PENDING */
3932
- phaseStatus: string;
3933
- /** @example FF */
3934
- assignedTo?: string | null;
3935
- /** @example 1 */
3936
- idWelder?: number | null;
3937
- /** @example 1 */
3938
- idWPS?: number | null;
3939
- /** @example Field weld */
3940
- remarks?: string | null;
3941
- /** @example true */
3942
- isLive: boolean;
3943
- /** @example 2024-01-15T10:30:00.000Z */
3944
- createdAt: string;
3945
- /** @example 2024-01-15T10:30:00.000Z */
3946
- updatedAt: string;
3947
- spool?: {
3948
- idSpool: number;
3949
- number: string;
3950
- pipeClass?: string | null;
3951
- };
3952
- sheet?: {
3953
- idSheet: number;
3954
- drawing: string;
3955
- sheet: string;
3956
- revisionNumber?: string | null;
3957
- };
3958
- materialGradePrimary?: {
3959
- idMaterialGrade: number;
3960
- name: string;
3961
- } | null;
3962
- materialGradeSecondary?: {
3963
- idMaterialGrade: number;
3964
- name: string;
3965
- } | null;
3966
- schedule?: {
3967
- idSchedule: number;
3968
- value: string;
3969
- } | null;
3970
- welder?: {
3971
- idWelder: number;
3972
- firstName: string;
3973
- lastName?: string | null;
3974
- welderId: string;
3975
- } | null;
3976
- wps?: {
3977
- idWPS: number;
3978
- WPSID: string;
3979
- } | null;
3980
- };
3981
- JointActionRequest: {
3982
- /**
3983
- * @example COMPLETE
3984
- * @enum {string}
3985
- */
3986
- action: 'COMPLETE' | 'APPROVE' | 'REJECT' | 'QC_APPROVE' | 'QC_REJECT' | 'VERIFY_REJECTION' | 'PASS' | 'FAIL' | 'PE_APPROVE';
3987
- /**
3988
- * @example FIT_UP
3989
- * @enum {string}
3990
- */
3991
- phase?: 'FIT_UP' | 'WELDING' | 'NDT';
3992
- data?: {
3993
- /** @example Work completed */
3994
- remarks?: string;
3995
- /** @enum {string} */
3996
- decision?: 'approve' | 'reject';
3997
- /** @example 1 */
3998
- idWelder?: number;
3999
- /** @example 1 */
4000
- idWPS?: number;
4001
- };
4002
- };
4003
- JointLog: {
4004
- /** @example 507f1f77bcf86cd799439011 */
4005
- idLog: string;
4006
- /** @example 1 */
4007
- idJoint: number;
4008
- /** @example COMPLETE */
4009
- action: string;
4010
- /** @example FIT_UP */
4011
- phase: string;
4012
- performedBy: {
4013
- idUser: number;
4014
- name: string;
4015
- role: string;
4016
- };
4017
- /** @example PENDING */
4018
- previousStatus?: string;
4019
- /** @example COMPLETED */
4020
- newStatus: string;
4021
- remarks?: string | null;
4022
- /** @example 2024-01-15T10:30:00.000Z */
4023
- createdAt: string;
4024
- };
4025
- Spool: {
4026
- /** @example 1 */
4027
- idSpool: number;
4028
- /** @example 1 */
4029
- idProject: number;
4030
- /** @example 1 */
4031
- idSheet: number;
4032
- /** @example SP-001 */
4033
- number: string;
4034
- /** @example A1 */
4035
- pipeClass?: string | null;
4036
- /**
4037
- * @example PENDING_JOINTS
4038
- * @enum {string}
4039
- */
4040
- phase: 'PENDING_JOINTS' | 'HYDROTEST' | 'PAINTING' | 'DISPATCH';
4041
- /** @example PENDING */
4042
- phaseStatus: string;
4043
- /** @example HYD */
4044
- assignedTo?: string | null;
4045
- remarks?: string | null;
4046
- /** @example true */
4047
- isLive: boolean;
4048
- /** @example 2024-01-15T10:30:00.000Z */
4049
- createdAt: string;
4050
- /** @example 2024-01-15T10:30:00.000Z */
4051
- updatedAt: string;
4052
- sheet?: {
4053
- idSheet: number;
4054
- drawing: string;
4055
- sheet: string;
4056
- revisionNumber?: string | null;
4057
- };
4058
- };
4059
- SpoolActionRequest: {
4060
- /**
4061
- * @example PASS
4062
- * @enum {string}
4063
- */
4064
- action: 'PASS' | 'FAIL' | 'VERIFY_FAILURE' | 'RFI' | 'PQC_APPROVE' | 'PQC_REJECT' | 'PM_APPROVE';
4065
- /**
4066
- * @example HYDROTEST
4067
- * @enum {string}
4068
- */
4069
- phase?: 'HYDROTEST' | 'PAINTING';
4070
- data?: {
4071
- /** @example Test passed */
4072
- remarks?: string;
4073
- /** @enum {string} */
4074
- decision?: 'approve' | 'reject';
4075
- };
4076
- };
4077
- SpoolLog: {
4078
- /** @example 507f1f77bcf86cd799439011 */
4079
- idLog: string;
4080
- /** @example 1 */
4081
- idSpool: number;
4082
- /** @example PASS */
4083
- action: string;
4084
- /** @example HYDROTEST */
4085
- phase: string;
4086
- performedBy: {
4087
- idUser: number;
4088
- name: string;
4089
- role: string;
4090
- };
4091
- /** @example PENDING */
4092
- previousStatus?: string;
4093
- /** @example PASSED */
4094
- newStatus: string;
4095
- remarks?: string | null;
4096
- /** @example 2024-01-15T10:30:00.000Z */
4097
- createdAt: string;
4098
- };
4099
- ProfileResponse: {
4100
- user: components['schemas']['User'] & unknown;
4101
- company: {
4102
- idCompany: number;
4103
- name: string;
4104
- companyId: string;
4105
- address: string;
4106
- status: string;
4107
- } | null;
4108
- };
4109
- FileUploadResponse: {
4110
- /** @example https://bucket.s3.region.amazonaws.com/uploads/file.pdf */
4111
- url: string;
4112
- /** @example uploads/1702665600000-file.pdf */
4113
- key: string;
4114
- /** @example application/pdf */
4115
- mimeType: string;
4116
- /** @example 102400 */
4117
- size: number;
4118
- };
4119
- ProjectPhase: {
4120
- /** @example 1 */
4121
- idProjectPhase: number;
4122
- /**
4123
- * @example FIT_UP
4124
- * @enum {string}
4125
- */
4126
- type: 'FIT_UP' | 'WELDING' | 'NDT' | 'HYDROTEST' | 'PAINTING' | 'DISPATCH';
4127
- /** @example true */
4128
- isEnabled: boolean;
4129
- };
4130
- EnablePhasesRequest: {
4131
- /**
4132
- * @example [
4133
- * "HYDROTEST",
4134
- * "PAINTING"
4135
- * ]
4136
- */
4137
- phases: ('FIT_UP' | 'WELDING' | 'NDT' | 'HYDROTEST' | 'PAINTING' | 'DISPATCH')[];
4138
- };
4139
- DisablePhasesRequest: {
4140
- /**
4141
- * @example [
4142
- * "PAINTING"
4143
- * ]
4144
- */
4145
- phases: ('FIT_UP' | 'WELDING' | 'NDT' | 'HYDROTEST' | 'PAINTING' | 'DISPATCH')[];
4146
- };
4147
- PhaseStats: {
4148
- /** @example FIT_UP */
4149
- phase: string;
4150
- /** @example 100 */
4151
- total: number;
4152
- /** @example 25 */
4153
- pending: number;
4154
- /** @example 30 */
4155
- inQueue: number;
4156
- /** @example 40 */
4157
- approved: number;
4158
- /** @example 5 */
4159
- rejected: number;
4160
- };
4161
- DashboardOverview: {
4162
- /** @example 500 */
4163
- totalJoints: number;
4164
- /** @example 50 */
4165
- totalSpools: number;
4166
- jointPhaseStats: components['schemas']['PhaseStats'][];
4167
- spoolPhaseStats: components['schemas']['PhaseStats'][];
4168
- };
4169
- QueueCount: {
4170
- /** @example FF */
4171
- role: string;
4172
- /** @example 15 */
4173
- joints: number;
4174
- /** @example 3 */
4175
- spools: number;
4176
- };
4177
- PhaseBreakdown: {
4178
- joints: {
4179
- /** @example FIT_UP */
4180
- phase: string;
4181
- /** @example 100 */
4182
- count: number;
4183
- }[];
4184
- spools: {
4185
- /** @example HYDROTEST */
4186
- phase: string;
4187
- /** @example 25 */
4188
- count: number;
4189
- }[];
4190
- };
4191
- DraftsmanDashboard: {
4192
- /** @example 500 */
4193
- totalJoints: number;
4194
- /** @example 10 */
4195
- totalDrafts: number;
4196
- /** @example 3 */
4197
- draftsPendingApproval: number;
4198
- firstDraft: {
4199
- idDraft: number;
4200
- draftNumber: string;
4201
- type: string;
4202
- status: string;
4203
- createdAt: string;
4204
- createdBy: number;
4205
- creatorName: string;
4206
- jointsCount: number;
4207
- } | null;
4208
- };
4209
- };
4210
- responses: never;
4211
- parameters: never;
4212
- requestBodies: never;
4213
- headers: never;
4214
- pathItems: never;
4215
- }
4216
- export type $defs = Record<string, never>;
4217
- export type operations = Record<string, never>;
4218
- //# sourceMappingURL=api.d.ts.map