@blezgo/api-sdk 0.1.2 → 0.1.4

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.
Files changed (138) hide show
  1. package/dist/account/generated.d.ts +183 -183
  2. package/dist/account/generated.d.ts.map +1 -1
  3. package/dist/activity/generated.d.ts +82 -82
  4. package/dist/activity/generated.d.ts.map +1 -1
  5. package/dist/addon/generated.d.ts +88 -88
  6. package/dist/addon/generated.d.ts.map +1 -1
  7. package/dist/admin/generated.d.ts +42 -42
  8. package/dist/admin/generated.d.ts.map +1 -1
  9. package/dist/affiliate/generated.d.ts +97 -98
  10. package/dist/affiliate/generated.d.ts.map +1 -1
  11. package/dist/analytics/generated.d.ts +27 -27
  12. package/dist/analytics/generated.d.ts.map +1 -1
  13. package/dist/announcements/generated.d.ts +118 -118
  14. package/dist/announcements/generated.d.ts.map +1 -1
  15. package/dist/apikeys/generated.d.ts +46 -46
  16. package/dist/apikeys/generated.d.ts.map +1 -1
  17. package/dist/assistance/generated.d.ts +24 -24
  18. package/dist/assistance/generated.d.ts.map +1 -1
  19. package/dist/authentication/generated.d.ts +73 -73
  20. package/dist/authentication/generated.d.ts.map +1 -1
  21. package/dist/blog/generated.d.ts +142 -142
  22. package/dist/blog/generated.d.ts.map +1 -1
  23. package/dist/bundle/generated.d.ts +124 -124
  24. package/dist/bundle/generated.d.ts.map +1 -1
  25. package/dist/cache/generated.d.ts +32 -32
  26. package/dist/cache/generated.d.ts.map +1 -1
  27. package/dist/calendar/generated.d.ts +59 -59
  28. package/dist/calendar/generated.d.ts.map +1 -1
  29. package/dist/campaigns/generated.d.ts +151 -151
  30. package/dist/campaigns/generated.d.ts.map +1 -1
  31. package/dist/cart/generated.d.ts +41 -41
  32. package/dist/cart/generated.d.ts.map +1 -1
  33. package/dist/changelog/generated.d.ts +90 -90
  34. package/dist/changelog/generated.d.ts.map +1 -1
  35. package/dist/channel/generated.d.ts +256 -256
  36. package/dist/channel/generated.d.ts.map +1 -1
  37. package/dist/company/generated.d.ts +73 -73
  38. package/dist/company/generated.d.ts.map +1 -1
  39. package/dist/conference/generated.d.ts +160 -160
  40. package/dist/conference/generated.d.ts.map +1 -1
  41. package/dist/config/generated.d.ts +57 -57
  42. package/dist/config/generated.d.ts.map +1 -1
  43. package/dist/content/generated.d.ts +620 -620
  44. package/dist/content/generated.d.ts.map +1 -1
  45. package/dist/cookies/generated.d.ts +85 -85
  46. package/dist/cookies/generated.d.ts.map +1 -1
  47. package/dist/courses/generated.d.ts +381 -381
  48. package/dist/courses/generated.d.ts.map +1 -1
  49. package/dist/custom/generated.d.ts +103 -103
  50. package/dist/custom/generated.d.ts.map +1 -1
  51. package/dist/dashboard/generated.d.ts +148 -148
  52. package/dist/dashboard/generated.d.ts.map +1 -1
  53. package/dist/elasticsearch/generated.d.ts +37 -37
  54. package/dist/elasticsearch/generated.d.ts.map +1 -1
  55. package/dist/enrollments/generated.d.ts +21 -21
  56. package/dist/enrollments/generated.d.ts.map +1 -1
  57. package/dist/errors/generated.d.ts +21 -21
  58. package/dist/errors/generated.d.ts.map +1 -1
  59. package/dist/eventconfig/generated.d.ts +88 -88
  60. package/dist/eventconfig/generated.d.ts.map +1 -1
  61. package/dist/funnels/generated.d.ts +124 -125
  62. package/dist/funnels/generated.d.ts.map +1 -1
  63. package/dist/gamification/generated.d.ts +151 -151
  64. package/dist/gamification/generated.d.ts.map +1 -1
  65. package/dist/impersonation/generated.d.ts +33 -33
  66. package/dist/impersonation/generated.d.ts.map +1 -1
  67. package/dist/inbox/generated.d.ts +154 -154
  68. package/dist/inbox/generated.d.ts.map +1 -1
  69. package/dist/internal/generated.d.ts +21 -21
  70. package/dist/internal/generated.d.ts.map +1 -1
  71. package/dist/internationalization/generated.d.ts +23 -23
  72. package/dist/internationalization/generated.d.ts.map +1 -1
  73. package/dist/invitations/generated.d.ts +107 -107
  74. package/dist/invitations/generated.d.ts.map +1 -1
  75. package/dist/meetings/generated.d.ts +332 -332
  76. package/dist/meetings/generated.d.ts.map +1 -1
  77. package/dist/metas/generated.d.ts +200 -200
  78. package/dist/metas/generated.d.ts.map +1 -1
  79. package/dist/notification/generated.d.ts +279 -279
  80. package/dist/notification/generated.d.ts.map +1 -1
  81. package/dist/notifications/generated.d.ts +21 -21
  82. package/dist/notifications/generated.d.ts.map +1 -1
  83. package/dist/onboarding/generated.d.ts +95 -95
  84. package/dist/onboarding/generated.d.ts.map +1 -1
  85. package/dist/packages/generated.d.ts +77 -77
  86. package/dist/packages/generated.d.ts.map +1 -1
  87. package/dist/payments/generated.d.ts +628 -631
  88. package/dist/payments/generated.d.ts.map +1 -1
  89. package/dist/payouts/generated.d.ts +21 -21
  90. package/dist/payouts/generated.d.ts.map +1 -1
  91. package/dist/plans/generated.d.ts +405 -405
  92. package/dist/plans/generated.d.ts.map +1 -1
  93. package/dist/pricing/generated.d.ts +75 -75
  94. package/dist/pricing/generated.d.ts.map +1 -1
  95. package/dist/products/generated.d.ts +420 -420
  96. package/dist/products/generated.d.ts.map +1 -1
  97. package/dist/profile/generated.d.ts +310 -310
  98. package/dist/profile/generated.d.ts.map +1 -1
  99. package/dist/reasons/generated.d.ts +64 -64
  100. package/dist/reasons/generated.d.ts.map +1 -1
  101. package/dist/registration/generated.d.ts +163 -163
  102. package/dist/registration/generated.d.ts.map +1 -1
  103. package/dist/reviews/generated.d.ts +47 -47
  104. package/dist/reviews/generated.d.ts.map +1 -1
  105. package/dist/role/generated.d.ts +944 -446
  106. package/dist/role/generated.d.ts.map +1 -1
  107. package/dist/scheduling/generated.d.ts +76 -76
  108. package/dist/scheduling/generated.d.ts.map +1 -1
  109. package/dist/services/generated.d.ts +1119 -1119
  110. package/dist/services/generated.d.ts.map +1 -1
  111. package/dist/sessions/generated.d.ts +313 -313
  112. package/dist/sessions/generated.d.ts.map +1 -1
  113. package/dist/spaces/generated.d.ts +340 -340
  114. package/dist/spaces/generated.d.ts.map +1 -1
  115. package/dist/storefront/generated.d.ts +21 -21
  116. package/dist/storefront/generated.d.ts.map +1 -1
  117. package/dist/support/generated.d.ts +1624 -1624
  118. package/dist/support/generated.d.ts.map +1 -1
  119. package/dist/sync/generated.d.ts +176 -176
  120. package/dist/sync/generated.d.ts.map +1 -1
  121. package/dist/tenant/generated.d.ts +487 -487
  122. package/dist/tenant/generated.d.ts.map +1 -1
  123. package/dist/testimonials/generated.d.ts +86 -86
  124. package/dist/testimonials/generated.d.ts.map +1 -1
  125. package/dist/tests/generated.d.ts +456 -456
  126. package/dist/tests/generated.d.ts.map +1 -1
  127. package/dist/tokens/generated.d.ts +54 -54
  128. package/dist/tokens/generated.d.ts.map +1 -1
  129. package/dist/uploads/generated.d.ts +65 -65
  130. package/dist/uploads/generated.d.ts.map +1 -1
  131. package/dist/upsell/generated.d.ts +105 -105
  132. package/dist/upsell/generated.d.ts.map +1 -1
  133. package/dist/user/generated.d.ts +272 -527
  134. package/dist/user/generated.d.ts.map +1 -1
  135. package/dist/webinars/generated.d.ts +260 -260
  136. package/dist/webinars/generated.d.ts.map +1 -1
  137. package/package.json +1 -1
  138. package/test-commit.txt +1 -0
@@ -17,8 +17,8 @@ export interface paths {
17
17
  * **For**: Admin users managing organization users
18
18
  * **Purpose**: Lists all users in the organization with filtering options
19
19
  *
20
- * **Authentication**: Required (JWT token with api_access permission)
21
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
20
+ * **Authentication**: Required (JWT token with user.view.all permission)
21
+ * **Headers**: Authorization (admin JWT)
22
22
  */
23
23
  get: operations["listUsers"];
24
24
  put?: never;
@@ -29,8 +29,8 @@ export interface paths {
29
29
  * **For**: Admin users adding new users to the organization
30
30
  * **Purpose**: Creates a new user with specified role and permissions
31
31
  *
32
- * **Authentication**: Required (JWT token with api_access permission)
33
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
32
+ * **Authentication**: Required (JWT token with user.create.all permission)
33
+ * **Headers**: Authorization (admin JWT)
34
34
  */
35
35
  post: operations["createUser"];
36
36
  delete?: never;
@@ -39,6 +39,32 @@ export interface paths {
39
39
  patch?: never;
40
40
  trace?: never;
41
41
  };
42
+ "/v1/users/admin/stats": {
43
+ parameters: {
44
+ query?: never;
45
+ header?: never;
46
+ path?: never;
47
+ cookie?: never;
48
+ };
49
+ /**
50
+ * Get User Stats
51
+ * @description Get user statistics for the organization.
52
+ *
53
+ * **For**: Admin users viewing dashboard metrics
54
+ * **Purpose**: Provides overview statistics of users in the organization
55
+ *
56
+ * **Authentication**: Required (JWT token with user.view.all permission)
57
+ * **Headers**: Authorization (admin JWT)
58
+ */
59
+ get: operations["getUserStats"];
60
+ put?: never;
61
+ post?: never;
62
+ delete?: never;
63
+ options?: never;
64
+ head?: never;
65
+ patch?: never;
66
+ trace?: never;
67
+ };
42
68
  "/v1/users/admin/{user_id}": {
43
69
  parameters: {
44
70
  query?: never;
@@ -53,8 +79,8 @@ export interface paths {
53
79
  * **For**: Admin users viewing detailed user information
54
80
  * **Purpose**: Retrieves complete user profile and settings
55
81
  *
56
- * **Authentication**: Required (JWT token with api_access permission)
57
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
82
+ * **Authentication**: Required (JWT token with user.view.all permission)
83
+ * **Headers**: Authorization (admin JWT)
58
84
  */
59
85
  get: operations["getUser"];
60
86
  put?: never;
@@ -66,8 +92,8 @@ export interface paths {
66
92
  * **For**: Admin users removing users from the organization
67
93
  * **Purpose**: Soft deletes (default) or permanently removes a user
68
94
  *
69
- * **Authentication**: Required (JWT token with api_access permission)
70
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
95
+ * **Authentication**: Required (JWT token with user.delete.all permission)
96
+ * **Headers**: Authorization (admin JWT)
71
97
  */
72
98
  delete: operations["deleteUser"];
73
99
  options?: never;
@@ -79,8 +105,8 @@ export interface paths {
79
105
  * **For**: Admin users updating user profiles
80
106
  * **Purpose**: Updates user profile information (not including password or role)
81
107
  *
82
- * **Authentication**: Required (JWT token with api_access permission)
83
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
108
+ * **Authentication**: Required (JWT token with user.edit.all permission)
109
+ * **Headers**: Authorization (admin JWT)
84
110
  */
85
111
  patch: operations["updateUser"];
86
112
  trace?: never;
@@ -101,8 +127,8 @@ export interface paths {
101
127
  * **For**: Admin users blocking problematic users
102
128
  * **Purpose**: Disables user access and optionally notifies them
103
129
  *
104
- * **Authentication**: Required (JWT token with api_access permission)
105
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
130
+ * **Authentication**: Required (JWT token with user.manage.all permission)
131
+ * **Headers**: Authorization (admin JWT)
106
132
  */
107
133
  post: operations["blockUser"];
108
134
  /**
@@ -112,8 +138,8 @@ export interface paths {
112
138
  * **For**: Admin users restoring blocked user access
113
139
  * **Purpose**: Re-enables user access and resets login attempts
114
140
  *
115
- * **Authentication**: Required (JWT token with api_access permission)
116
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
141
+ * **Authentication**: Required (JWT token with user.manage.all permission)
142
+ * **Headers**: Authorization (admin JWT)
117
143
  */
118
144
  delete: operations["unblockUser"];
119
145
  options?: never;
@@ -137,8 +163,8 @@ export interface paths {
137
163
  * **For**: Admin users manually verifying user emails
138
164
  * **Purpose**: Marks user email as verified without requiring verification link
139
165
  *
140
- * **Authentication**: Required (JWT token with api_access permission)
141
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
166
+ * **Authentication**: Required (JWT token with user.manage.all permission)
167
+ * **Headers**: Authorization (admin JWT)
142
168
  */
143
169
  post: operations["verifyUserEmail"];
144
170
  delete?: never;
@@ -163,8 +189,8 @@ export interface paths {
163
189
  * **For**: Admin users manually verifying user mobile numbers
164
190
  * **Purpose**: Marks user mobile as verified without requiring OTP
165
191
  *
166
- * **Authentication**: Required (JWT token with api_access permission)
167
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
192
+ * **Authentication**: Required (JWT token with user.manage.all permission)
193
+ * **Headers**: Authorization (admin JWT)
168
194
  */
169
195
  post: operations["verifyUserMobile"];
170
196
  delete?: never;
@@ -193,8 +219,8 @@ export interface paths {
193
219
  * **For**: Admin users managing user roles and permissions
194
220
  * **Purpose**: Updates user role and associated permissions in org_users_tbl, roles_tbl, access_layer_tbl, and user_access_layer_tbl
195
221
  *
196
- * **Authentication**: Required (JWT token with api_access permission)
197
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
222
+ * **Authentication**: Required (JWT token with user.manage.all permission)
223
+ * **Headers**: Authorization (admin JWT)
198
224
  */
199
225
  patch: operations["updateUserRole"];
200
226
  trace?: never;
@@ -216,7 +242,8 @@ export interface paths {
216
242
  * **Purpose**: Administratively sets a new password for a user
217
243
  *
218
244
  * **Authentication**: Required (JWT token with user.manage.all permission)
219
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
245
+ * **Headers**: Authorization (admin JWT)
246
+ * **Permissions**: user.manage.all
220
247
  */
221
248
  post: operations["resetUserPassword"];
222
249
  delete?: never;
@@ -272,7 +299,7 @@ export interface paths {
272
299
  * - Support: Help user understand their access level
273
300
  *
274
301
  * **Authentication**: Required (JWT token with user_permission.view.all permission)
275
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
302
+ * **Headers**: Authorization (admin JWT)
276
303
  * **Permissions**: user_permission.view.all
277
304
  */
278
305
  get: operations["listUserPermissions"];
@@ -309,7 +336,7 @@ export interface paths {
309
336
  * 4. Deny
310
337
  *
311
338
  * **Authentication**: Required (JWT token with user_permission.grant.all permission)
312
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
339
+ * **Headers**: Authorization (admin JWT)
313
340
  * **Permissions**: user_permission.grant.all
314
341
  */
315
342
  post: operations["createUserPermission"];
@@ -337,7 +364,7 @@ export interface paths {
337
364
  * **Purpose**: Remove user-specific permission override, user reverts to role permissions
338
365
  *
339
366
  * **Path Parameters**:
340
- * - user_id: Target user's internal ID
367
+ * - user_id: Target user's external ID (usr_xxx)
341
368
  * - override_id: Override external ID (uacl_xxx)
342
369
  *
343
370
  * **Query Parameters**:
@@ -351,7 +378,7 @@ export interface paths {
351
378
  * **Note**: Soft delete for recoverability, audit log entry created
352
379
  *
353
380
  * **Authentication**: Required (JWT token with user_permission.revoke.all permission)
354
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
381
+ * **Headers**: Authorization (admin JWT)
355
382
  * **Permissions**: user_permission.revoke.all
356
383
  */
357
384
  delete: operations["deleteUserPermission"];
@@ -360,32 +387,6 @@ export interface paths {
360
387
  patch?: never;
361
388
  trace?: never;
362
389
  };
363
- "/v1/users/admin/bulk-registrations": {
364
- parameters: {
365
- query?: never;
366
- header?: never;
367
- path?: never;
368
- cookie?: never;
369
- };
370
- get?: never;
371
- put?: never;
372
- /**
373
- * Bulk Register Users
374
- * @description Register multiple users at once.
375
- *
376
- * **For**: Admin users creating multiple user accounts in bulk
377
- * **Purpose**: Creates multiple user accounts with passwords
378
- *
379
- * **Authentication**: Required (JWT token with api_access permission)
380
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
381
- */
382
- post: operations["bulkRegisterUsers"];
383
- delete?: never;
384
- options?: never;
385
- head?: never;
386
- patch?: never;
387
- trace?: never;
388
- };
389
390
  "/v1/users/admin/bulk-updates": {
390
391
  parameters: {
391
392
  query?: never;
@@ -402,8 +403,8 @@ export interface paths {
402
403
  * **For**: Admin users updating multiple users with same data
403
404
  * **Purpose**: Applies same updates to multiple users
404
405
  *
405
- * **Authentication**: Required (JWT token with api_access permission)
406
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
406
+ * **Authentication**: Required (JWT token with user.edit.all permission)
407
+ * **Headers**: Authorization (admin JWT)
407
408
  */
408
409
  post: operations["bulkUpdateUsers"];
409
410
  delete?: never;
@@ -428,8 +429,8 @@ export interface paths {
428
429
  * **For**: Admin users removing multiple users
429
430
  * **Purpose**: Deletes multiple users (soft or hard delete)
430
431
  *
431
- * **Authentication**: Required (JWT token with api_access permission)
432
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
432
+ * **Authentication**: Required (JWT token with user.delete.all permission)
433
+ * **Headers**: Authorization (admin JWT)
433
434
  */
434
435
  post: operations["bulkDeleteUsers"];
435
436
  delete?: never;
@@ -438,95 +439,10 @@ export interface paths {
438
439
  patch?: never;
439
440
  trace?: never;
440
441
  };
441
- "/v1/users/admin/stats": {
442
- parameters: {
443
- query?: never;
444
- header?: never;
445
- path?: never;
446
- cookie?: never;
447
- };
448
- /**
449
- * Get User Stats
450
- * @description Get user statistics for the organization.
451
- *
452
- * **For**: Admin users viewing dashboard metrics
453
- * **Purpose**: Provides overview statistics of users in the organization
454
- *
455
- * **Authentication**: Required (JWT token with api_access permission)
456
- * **Headers**: X-Api-Key (org_id), Authorization (admin user)
457
- */
458
- get: operations["getUserStats"];
459
- put?: never;
460
- post?: never;
461
- delete?: never;
462
- options?: never;
463
- head?: never;
464
- patch?: never;
465
- trace?: never;
466
- };
467
442
  }
468
443
  export type webhooks = Record<string, never>;
469
444
  export interface components {
470
445
  schemas: {
471
- /** BlockUserRequest */
472
- BlockUserRequest: {
473
- /** Reason */
474
- reason?: string | null;
475
- /**
476
- * Notify User
477
- * @default false
478
- */
479
- notify_user: boolean | null;
480
- };
481
- /** BulkRegisterUser */
482
- BulkRegisterUser: {
483
- /**
484
- * Email
485
- * Format: email
486
- */
487
- email: string;
488
- /** Password */
489
- password: string;
490
- /** First Name */
491
- first_name: string;
492
- /** Last Name */
493
- last_name?: string | null;
494
- /**
495
- * Role Id
496
- * @description Role ID for the user
497
- */
498
- role_id: number;
499
- /** Mobile Isd Code */
500
- mobile_isd_code?: string | null;
501
- /** Mobile No */
502
- mobile_no?: string | null;
503
- };
504
- /** BulkUpdateRequest */
505
- BulkUpdateRequest: {
506
- /** User Ids */
507
- user_ids: number[];
508
- updates: components["schemas"]["UpdateUserRequest"];
509
- };
510
- /** BulkDeleteRequest */
511
- BulkDeleteRequest: {
512
- /** User Ids */
513
- user_ids: number[];
514
- /**
515
- * Soft Delete
516
- * @default true
517
- */
518
- soft_delete: boolean | null;
519
- };
520
- /** BulkRegisterRequest */
521
- BulkRegisterRequest: {
522
- /** Users */
523
- users: components["schemas"]["BulkRegisterUser"][];
524
- /**
525
- * Send Welcome Email
526
- * @default true
527
- */
528
- send_welcome_email: boolean | null;
529
- };
530
446
  /** AddUserRequest */
531
447
  AddUserRequest: {
532
448
  /**
@@ -569,14 +485,19 @@ export interface components {
569
485
  */
570
486
  send_welcome_email: boolean | null;
571
487
  };
572
- Extensions: {
573
- /** @example GENERIC_ERROR */
574
- message_code?: string;
575
- /** @example [] */
576
- invalid_params?: components["schemas"]["InvalidParam"][];
577
- extra_data?: Record<string, never> | null;
578
- /** @example Detailed debug information */
579
- debug?: string | null;
488
+ InvalidParam: {
489
+ /** @example items[0].quantity */
490
+ field?: string;
491
+ /** @example Input should be greater than or equal to 1 */
492
+ error?: string;
493
+ };
494
+ /** ChangeUserRoleRequest */
495
+ ChangeUserRoleRequest: {
496
+ /**
497
+ * Role Id
498
+ * @description New role ID for the user
499
+ */
500
+ role_id: number;
580
501
  };
581
502
  /**
582
503
  * @example {
@@ -605,315 +526,139 @@ export interface components {
605
526
  metadata?: Record<string, never> | null;
606
527
  error?: components["schemas"]["ErrorResponse"];
607
528
  };
608
- /** UpdateUserRequest */
609
- UpdateUserRequest: {
610
- /** First Name */
611
- first_name?: string | null;
612
- /** Last Name */
613
- last_name?: string | null;
614
- /** Username */
615
- username?: string | null;
616
- /** Mobile Isd Code */
617
- mobile_isd_code?: string | null;
618
- /** Mobile No */
619
- mobile_no?: string | null;
620
- /** Timezone */
621
- timezone?: string | null;
622
- /** Preferred Language */
623
- preferred_language?: string | null;
624
- /** Address1 */
625
- address1?: string | null;
626
- /** Address2 */
627
- address2?: string | null;
628
- /** City */
629
- city?: string | null;
630
- /** State */
631
- state?: string | null;
632
- /** Country */
633
- country?: string | null;
634
- /** Zip */
635
- zip?: string | null;
636
- };
637
- /** ChangeUserRoleRequest */
638
- ChangeUserRoleRequest: {
529
+ /** BulkDeleteRequest */
530
+ BulkDeleteRequest: {
639
531
  /**
640
- * Role Id
641
- * @description New role ID for the user
532
+ * User Ids
533
+ * @description List of user external IDs (usr_xxx)
642
534
  */
643
- role_id: number;
644
- };
645
- ErrorResponse: {
646
- /** @example about:blank */
647
- type?: string;
648
- /** @example GENERIC_ERROR */
649
- code?: string;
650
- /** @example Client Error */
651
- title?: string;
652
- /** @example 400 */
653
- status?: number;
654
- /** @example An error occurred */
655
- detail?: string;
656
- /** @example /v1/cart/items */
657
- instance?: string;
658
- extensions?: components["schemas"]["Extensions"];
659
- };
660
- /** ResetPasswordRequest */
661
- ResetPasswordRequest: {
662
- /** New Password */
663
- new_password: string;
535
+ user_ids: string[];
664
536
  /**
665
- * Send Email
537
+ * Soft Delete
666
538
  * @default true
667
539
  */
668
- send_email: boolean | null;
669
- };
670
- InvalidParam: {
671
- /** @example items[0].quantity */
672
- field?: string;
673
- /** @example Input should be greater than or equal to 1 */
674
- error?: string;
675
- };
676
- };
677
- responses: never;
678
- parameters: never;
679
- requestBodies: never;
680
- headers: never;
681
- pathItems: never;
682
- }
683
- export type $defs = Record<string, never>;
684
- export interface operations {
685
- listUsers: {
686
- parameters: {
687
- query?: {
688
- /** @description Search by name, email, username */
689
- query?: string | null;
690
- /** @description Filter by role ID */
691
- role_id?: number | null;
692
- /** @description Filter by status: active, blocked, inactive */
693
- status?: string | null;
694
- /** @description Filter by email verification status */
695
- email_verified?: boolean | null;
696
- /** @description Filter by mobile verification status */
697
- mobile_verified?: boolean | null;
698
- /** @description Sort field: created, name, email */
699
- sort_by?: string | null;
700
- /** @description Sort order: asc, desc */
701
- order?: string | null;
702
- /** @description Page number (1-based) */
703
- page?: number;
704
- /** @description Items per page (1–100, default 20) */
705
- limit?: number;
706
- };
707
- header?: {
708
- authorization?: string | null;
709
- };
710
- path?: never;
711
- cookie?: never;
712
- };
713
- requestBody?: never;
714
- responses: {
715
- /** @description Successful Response */
716
- 200: {
717
- headers: {
718
- [name: string]: unknown;
719
- };
720
- content: {
721
- "application/json": unknown;
722
- };
723
- };
724
- /** @description Bad Request */
725
- 400: {
726
- headers: {
727
- [name: string]: unknown;
728
- };
729
- content: {
730
- /**
731
- * @example {
732
- * "status": "error",
733
- * "message": "An error occurred",
734
- * "message_code": "GENERIC_ERROR",
735
- * "metadata": {
736
- * "timestamp": "2025-08-05T18:38:57Z",
737
- * "requestId": "uuid",
738
- * "traceId": "uuid",
739
- * "version": "v1",
740
- * "executionTime": 0,
741
- * "language": "en-US",
742
- * "links": [
743
- * {
744
- * "rel": "self",
745
- * "href": "/v1/cart/items",
746
- * "method": "POST"
747
- * }
748
- * ]
749
- * },
750
- * "error": {
751
- * "type": "https://{your-domain}/errors/client-error",
752
- * "code": "GENERIC_ERROR",
753
- * "title": "Client Error",
754
- * "status": 400,
755
- * "detail": "An error occurred",
756
- * "instance": "/v1/cart/items",
757
- * "extensions": {
758
- * "message_code": "GENERIC_ERROR",
759
- * "invalid_params": []
760
- * }
761
- * }
762
- * }
763
- */
764
- "application/json": components["schemas"]["StandardResponse"];
765
- };
766
- };
767
- /** @description Unprocessable Entity */
768
- 422: {
769
- headers: {
770
- [name: string]: unknown;
771
- };
772
- content: {
773
- /**
774
- * @example {
775
- * "status": "error",
776
- * "message": "One or more input fields are invalid",
777
- * "message_code": "INVALID_INPUT",
778
- * "metadata": {
779
- * "timestamp": "2025-08-05T18:38:57Z",
780
- * "requestId": "uuid",
781
- * "traceId": "uuid",
782
- * "version": "v1",
783
- * "executionTime": 0,
784
- * "language": "en-US",
785
- * "links": [
786
- * {
787
- * "rel": "self",
788
- * "href": "/v1/cart/items",
789
- * "method": "POST"
790
- * }
791
- * ]
792
- * },
793
- * "error": {
794
- * "type": "https://{your-domain}/errors/invalid-input",
795
- * "code": "INVALID_INPUT",
796
- * "title": "Invalid Input",
797
- * "status": 422,
798
- * "detail": "One or more input fields are invalid",
799
- * "instance": "/v1/cart/items",
800
- * "extensions": {
801
- * "message_code": "INVALID_INPUT",
802
- * "invalid_params": [
803
- * {
804
- * "field": "items[0].quantity",
805
- * "error": "Input should be greater than or equal to 1"
806
- * }
807
- * ]
808
- * }
809
- * }
810
- * }
811
- */
812
- "application/json": components["schemas"]["StandardResponse"];
813
- };
814
- };
815
- /** @description Too Many Requests */
816
- 429: {
817
- headers: {
818
- [name: string]: unknown;
819
- };
820
- content: {
821
- /**
822
- * @example {
823
- * "status": "error",
824
- * "message": "Too many requests",
825
- * "message_code": "RATE_LIMIT_EXCEEDED",
826
- * "metadata": {
827
- * "timestamp": "2025-08-05T18:38:57Z",
828
- * "requestId": "uuid",
829
- * "traceId": "uuid",
830
- * "version": "v1",
831
- * "executionTime": 0,
832
- * "language": "en-US",
833
- * "links": [
834
- * {
835
- * "rel": "self",
836
- * "href": "/v1/cart/items",
837
- * "method": "POST"
838
- * }
839
- * ]
840
- * },
841
- * "error": {
842
- * "type": "https://{your-domain}/errors/rate-limit-exceeded",
843
- * "code": "RATE_LIMIT_EXCEEDED",
844
- * "title": "Rate Limit Exceeded",
845
- * "status": 429,
846
- * "detail": "Too many requests",
847
- * "instance": "/v1/cart/items",
848
- * "extensions": {
849
- * "message_code": "RATE_LIMIT_EXCEEDED",
850
- * "invalid_params": []
851
- * }
852
- * }
853
- * }
854
- */
855
- "application/json": components["schemas"]["StandardResponse"];
856
- };
857
- };
858
- /** @description Internal Server Error */
859
- 500: {
860
- headers: {
861
- [name: string]: unknown;
862
- };
863
- content: {
864
- /**
865
- * @example {
866
- * "status": "error",
867
- * "message": "An unexpected error occurred",
868
- * "message_code": "SERVER_ERROR",
869
- * "metadata": {
870
- * "timestamp": "2025-08-05T18:38:57Z",
871
- * "requestId": "uuid",
872
- * "traceId": "uuid",
873
- * "version": "v1",
874
- * "executionTime": 0,
875
- * "language": "en-US",
876
- * "links": [
877
- * {
878
- * "rel": "self",
879
- * "href": "/v1/cart/items",
880
- * "method": "POST"
881
- * }
882
- * ]
883
- * },
884
- * "error": {
885
- * "type": "https://{your-domain}/errors/server-error",
886
- * "code": "SERVER_ERROR",
887
- * "title": "Server Error",
888
- * "status": 500,
889
- * "detail": "An unexpected error occurred",
890
- * "instance": "/v1/cart/items",
891
- * "extensions": {
892
- * "message_code": "SERVER_ERROR",
893
- * "invalid_params": []
894
- * }
895
- * }
896
- * }
897
- */
898
- "application/json": components["schemas"]["StandardResponse"];
899
- };
900
- };
540
+ soft_delete: boolean | null;
541
+ };
542
+ /** ResetPasswordRequest */
543
+ ResetPasswordRequest: {
544
+ /** New Password */
545
+ new_password: string;
546
+ /**
547
+ * Send Email
548
+ * @default true
549
+ */
550
+ send_email: boolean | null;
551
+ };
552
+ /** BulkUpdateRequest */
553
+ BulkUpdateRequest: {
554
+ /**
555
+ * User Ids
556
+ * @description List of user external IDs (usr_xxx)
557
+ */
558
+ user_ids: string[];
559
+ updates: components["schemas"]["UpdateUserRequest"];
560
+ };
561
+ /** BlockUserRequest */
562
+ BlockUserRequest: {
563
+ /** Reason */
564
+ reason?: string | null;
565
+ /**
566
+ * Notify User
567
+ * @default false
568
+ */
569
+ notify_user: boolean | null;
570
+ };
571
+ ErrorResponse: {
572
+ /** @example about:blank */
573
+ type?: string;
574
+ /** @example GENERIC_ERROR */
575
+ code?: string;
576
+ /** @example Client Error */
577
+ title?: string;
578
+ /** @example 400 */
579
+ status?: number;
580
+ /** @example An error occurred */
581
+ detail?: string;
582
+ /** @example /v1/cart/items */
583
+ instance?: string;
584
+ extensions?: components["schemas"]["Extensions"];
585
+ };
586
+ Extensions: {
587
+ /** @example GENERIC_ERROR */
588
+ message_code?: string;
589
+ /** @example [] */
590
+ invalid_params?: components["schemas"]["InvalidParam"][];
591
+ extra_data?: Record<string, never> | null;
592
+ /** @example Detailed debug information */
593
+ debug?: string | null;
594
+ };
595
+ /** UpdateUserRequest */
596
+ UpdateUserRequest: {
597
+ /** First Name */
598
+ first_name?: string | null;
599
+ /** Last Name */
600
+ last_name?: string | null;
601
+ /** Username */
602
+ username?: string | null;
603
+ /** Mobile Isd Code */
604
+ mobile_isd_code?: string | null;
605
+ /** Mobile No */
606
+ mobile_no?: string | null;
607
+ /** Timezone */
608
+ timezone?: string | null;
609
+ /** Preferred Language */
610
+ preferred_language?: string | null;
611
+ /** Address1 */
612
+ address1?: string | null;
613
+ /** Address2 */
614
+ address2?: string | null;
615
+ /** City */
616
+ city?: string | null;
617
+ /** State */
618
+ state?: string | null;
619
+ /** Country */
620
+ country?: string | null;
621
+ /** Zip */
622
+ zip?: string | null;
901
623
  };
902
624
  };
903
- createUser: {
625
+ responses: never;
626
+ parameters: never;
627
+ requestBodies: never;
628
+ headers: never;
629
+ pathItems: never;
630
+ }
631
+ export type $defs = Record<string, never>;
632
+ export interface operations {
633
+ listUsers: {
904
634
  parameters: {
905
- query?: never;
635
+ query?: {
636
+ /** @description Search by email, username, or name */
637
+ query?: string | null;
638
+ /** @description Filter by role external ID (e.g. role_xxx) */
639
+ role_id?: string | null;
640
+ /** @description Filter by status: active, blocked, inactive */
641
+ status?: string | null;
642
+ /** @description Filter by email verification status */
643
+ email_verified?: boolean | null;
644
+ /** @description Filter by mobile verification status */
645
+ mobile_verified?: boolean | null;
646
+ /** @description Sort field: created, name, email */
647
+ sort_by?: string | null;
648
+ /** @description Sort order: asc, desc */
649
+ order?: string | null;
650
+ /** @description Page number (1-based) */
651
+ page?: number;
652
+ /** @description Items per page (1–100, default 20) */
653
+ limit?: number;
654
+ };
906
655
  header?: {
907
656
  authorization?: string | null;
908
657
  };
909
658
  path?: never;
910
659
  cookie?: never;
911
660
  };
912
- requestBody: {
913
- content: {
914
- "application/json": components["schemas"]["AddUserRequest"];
915
- };
916
- };
661
+ requestBody?: never;
917
662
  responses: {
918
663
  /** @description Successful Response */
919
664
  200: {
@@ -1103,18 +848,20 @@ export interface operations {
1103
848
  };
1104
849
  };
1105
850
  };
1106
- getUser: {
851
+ createUser: {
1107
852
  parameters: {
1108
853
  query?: never;
1109
854
  header?: {
1110
855
  authorization?: string | null;
1111
856
  };
1112
- path: {
1113
- user_id: number;
1114
- };
857
+ path?: never;
1115
858
  cookie?: never;
1116
859
  };
1117
- requestBody?: never;
860
+ requestBody: {
861
+ content: {
862
+ "application/json": components["schemas"]["AddUserRequest"];
863
+ };
864
+ };
1118
865
  responses: {
1119
866
  /** @description Successful Response */
1120
867
  200: {
@@ -1304,18 +1051,13 @@ export interface operations {
1304
1051
  };
1305
1052
  };
1306
1053
  };
1307
- deleteUser: {
1054
+ getUserStats: {
1308
1055
  parameters: {
1309
- query?: {
1310
- /** @description Soft delete (default) or hard delete */
1311
- soft_delete?: boolean;
1312
- };
1056
+ query?: never;
1313
1057
  header?: {
1314
1058
  authorization?: string | null;
1315
1059
  };
1316
- path: {
1317
- user_id: number;
1318
- };
1060
+ path?: never;
1319
1061
  cookie?: never;
1320
1062
  };
1321
1063
  requestBody?: never;
@@ -1508,22 +1250,18 @@ export interface operations {
1508
1250
  };
1509
1251
  };
1510
1252
  };
1511
- updateUser: {
1253
+ getUser: {
1512
1254
  parameters: {
1513
1255
  query?: never;
1514
1256
  header?: {
1515
1257
  authorization?: string | null;
1516
1258
  };
1517
1259
  path: {
1518
- user_id: number;
1260
+ user_id: string;
1519
1261
  };
1520
1262
  cookie?: never;
1521
1263
  };
1522
- requestBody: {
1523
- content: {
1524
- "application/json": components["schemas"]["UpdateUserRequest"];
1525
- };
1526
- };
1264
+ requestBody?: never;
1527
1265
  responses: {
1528
1266
  /** @description Successful Response */
1529
1267
  200: {
@@ -1713,22 +1451,21 @@ export interface operations {
1713
1451
  };
1714
1452
  };
1715
1453
  };
1716
- blockUser: {
1454
+ deleteUser: {
1717
1455
  parameters: {
1718
- query?: never;
1456
+ query?: {
1457
+ /** @description Soft delete (default) or hard delete */
1458
+ soft_delete?: boolean;
1459
+ };
1719
1460
  header?: {
1720
1461
  authorization?: string | null;
1721
1462
  };
1722
1463
  path: {
1723
- user_id: number;
1464
+ user_id: string;
1724
1465
  };
1725
1466
  cookie?: never;
1726
1467
  };
1727
- requestBody: {
1728
- content: {
1729
- "application/json": components["schemas"]["BlockUserRequest"];
1730
- };
1731
- };
1468
+ requestBody?: never;
1732
1469
  responses: {
1733
1470
  /** @description Successful Response */
1734
1471
  200: {
@@ -1918,18 +1655,22 @@ export interface operations {
1918
1655
  };
1919
1656
  };
1920
1657
  };
1921
- unblockUser: {
1658
+ updateUser: {
1922
1659
  parameters: {
1923
1660
  query?: never;
1924
1661
  header?: {
1925
1662
  authorization?: string | null;
1926
1663
  };
1927
1664
  path: {
1928
- user_id: number;
1665
+ user_id: string;
1929
1666
  };
1930
1667
  cookie?: never;
1931
1668
  };
1932
- requestBody?: never;
1669
+ requestBody: {
1670
+ content: {
1671
+ "application/json": components["schemas"]["UpdateUserRequest"];
1672
+ };
1673
+ };
1933
1674
  responses: {
1934
1675
  /** @description Successful Response */
1935
1676
  200: {
@@ -2119,18 +1860,22 @@ export interface operations {
2119
1860
  };
2120
1861
  };
2121
1862
  };
2122
- verifyUserEmail: {
1863
+ blockUser: {
2123
1864
  parameters: {
2124
1865
  query?: never;
2125
1866
  header?: {
2126
1867
  authorization?: string | null;
2127
1868
  };
2128
1869
  path: {
2129
- user_id: number;
1870
+ user_id: string;
2130
1871
  };
2131
1872
  cookie?: never;
2132
1873
  };
2133
- requestBody?: never;
1874
+ requestBody: {
1875
+ content: {
1876
+ "application/json": components["schemas"]["BlockUserRequest"];
1877
+ };
1878
+ };
2134
1879
  responses: {
2135
1880
  /** @description Successful Response */
2136
1881
  200: {
@@ -2320,14 +2065,14 @@ export interface operations {
2320
2065
  };
2321
2066
  };
2322
2067
  };
2323
- verifyUserMobile: {
2068
+ unblockUser: {
2324
2069
  parameters: {
2325
2070
  query?: never;
2326
2071
  header?: {
2327
2072
  authorization?: string | null;
2328
2073
  };
2329
2074
  path: {
2330
- user_id: number;
2075
+ user_id: string;
2331
2076
  };
2332
2077
  cookie?: never;
2333
2078
  };
@@ -2521,22 +2266,18 @@ export interface operations {
2521
2266
  };
2522
2267
  };
2523
2268
  };
2524
- updateUserRole: {
2269
+ verifyUserEmail: {
2525
2270
  parameters: {
2526
2271
  query?: never;
2527
2272
  header?: {
2528
2273
  authorization?: string | null;
2529
2274
  };
2530
2275
  path: {
2531
- user_id: number;
2276
+ user_id: string;
2532
2277
  };
2533
2278
  cookie?: never;
2534
2279
  };
2535
- requestBody: {
2536
- content: {
2537
- "application/json": components["schemas"]["ChangeUserRoleRequest"];
2538
- };
2539
- };
2280
+ requestBody?: never;
2540
2281
  responses: {
2541
2282
  /** @description Successful Response */
2542
2283
  200: {
@@ -2726,22 +2467,18 @@ export interface operations {
2726
2467
  };
2727
2468
  };
2728
2469
  };
2729
- resetUserPassword: {
2470
+ verifyUserMobile: {
2730
2471
  parameters: {
2731
2472
  query?: never;
2732
2473
  header?: {
2733
2474
  authorization?: string | null;
2734
2475
  };
2735
2476
  path: {
2736
- user_id: number;
2477
+ user_id: string;
2737
2478
  };
2738
2479
  cookie?: never;
2739
2480
  };
2740
- requestBody: {
2741
- content: {
2742
- "application/json": components["schemas"]["ResetPasswordRequest"];
2743
- };
2744
- };
2481
+ requestBody?: never;
2745
2482
  responses: {
2746
2483
  /** @description Successful Response */
2747
2484
  200: {
@@ -2931,18 +2668,22 @@ export interface operations {
2931
2668
  };
2932
2669
  };
2933
2670
  };
2934
- listUserPermissions: {
2671
+ updateUserRole: {
2935
2672
  parameters: {
2936
2673
  query?: never;
2937
2674
  header?: {
2938
2675
  authorization?: string | null;
2939
2676
  };
2940
2677
  path: {
2941
- user_id: number;
2678
+ user_id: string;
2942
2679
  };
2943
2680
  cookie?: never;
2944
2681
  };
2945
- requestBody?: never;
2682
+ requestBody: {
2683
+ content: {
2684
+ "application/json": components["schemas"]["ChangeUserRoleRequest"];
2685
+ };
2686
+ };
2946
2687
  responses: {
2947
2688
  /** @description Successful Response */
2948
2689
  200: {
@@ -3132,21 +2873,25 @@ export interface operations {
3132
2873
  };
3133
2874
  };
3134
2875
  };
3135
- createUserPermission: {
2876
+ resetUserPassword: {
3136
2877
  parameters: {
3137
2878
  query?: never;
3138
2879
  header?: {
3139
2880
  authorization?: string | null;
3140
2881
  };
3141
2882
  path: {
3142
- user_id: number;
2883
+ user_id: string;
3143
2884
  };
3144
2885
  cookie?: never;
3145
2886
  };
3146
- requestBody?: never;
2887
+ requestBody: {
2888
+ content: {
2889
+ "application/json": components["schemas"]["ResetPasswordRequest"];
2890
+ };
2891
+ };
3147
2892
  responses: {
3148
2893
  /** @description Successful Response */
3149
- 201: {
2894
+ 200: {
3150
2895
  headers: {
3151
2896
  [name: string]: unknown;
3152
2897
  };
@@ -3333,18 +3078,14 @@ export interface operations {
3333
3078
  };
3334
3079
  };
3335
3080
  };
3336
- deleteUserPermission: {
3081
+ listUserPermissions: {
3337
3082
  parameters: {
3338
- query?: {
3339
- /** @description Reason for revocation */
3340
- reason?: string | null;
3341
- };
3083
+ query?: never;
3342
3084
  header?: {
3343
3085
  authorization?: string | null;
3344
3086
  };
3345
3087
  path: {
3346
- user_id: number;
3347
- override_id: string;
3088
+ user_id: string;
3348
3089
  };
3349
3090
  cookie?: never;
3350
3091
  };
@@ -3538,23 +3279,21 @@ export interface operations {
3538
3279
  };
3539
3280
  };
3540
3281
  };
3541
- bulkRegisterUsers: {
3282
+ createUserPermission: {
3542
3283
  parameters: {
3543
3284
  query?: never;
3544
3285
  header?: {
3545
3286
  authorization?: string | null;
3546
3287
  };
3547
- path?: never;
3548
- cookie?: never;
3549
- };
3550
- requestBody: {
3551
- content: {
3552
- "application/json": components["schemas"]["BulkRegisterRequest"];
3288
+ path: {
3289
+ user_id: string;
3553
3290
  };
3291
+ cookie?: never;
3554
3292
  };
3293
+ requestBody?: never;
3555
3294
  responses: {
3556
3295
  /** @description Successful Response */
3557
- 200: {
3296
+ 201: {
3558
3297
  headers: {
3559
3298
  [name: string]: unknown;
3560
3299
  };
@@ -3741,20 +3480,22 @@ export interface operations {
3741
3480
  };
3742
3481
  };
3743
3482
  };
3744
- bulkUpdateUsers: {
3483
+ deleteUserPermission: {
3745
3484
  parameters: {
3746
- query?: never;
3485
+ query?: {
3486
+ /** @description Reason for revocation */
3487
+ reason?: string | null;
3488
+ };
3747
3489
  header?: {
3748
3490
  authorization?: string | null;
3749
3491
  };
3750
- path?: never;
3751
- cookie?: never;
3752
- };
3753
- requestBody: {
3754
- content: {
3755
- "application/json": components["schemas"]["BulkUpdateRequest"];
3492
+ path: {
3493
+ user_id: string;
3494
+ override_id: string;
3756
3495
  };
3496
+ cookie?: never;
3757
3497
  };
3498
+ requestBody?: never;
3758
3499
  responses: {
3759
3500
  /** @description Successful Response */
3760
3501
  200: {
@@ -3944,7 +3685,7 @@ export interface operations {
3944
3685
  };
3945
3686
  };
3946
3687
  };
3947
- bulkDeleteUsers: {
3688
+ bulkUpdateUsers: {
3948
3689
  parameters: {
3949
3690
  query?: never;
3950
3691
  header?: {
@@ -3955,7 +3696,7 @@ export interface operations {
3955
3696
  };
3956
3697
  requestBody: {
3957
3698
  content: {
3958
- "application/json": components["schemas"]["BulkDeleteRequest"];
3699
+ "application/json": components["schemas"]["BulkUpdateRequest"];
3959
3700
  };
3960
3701
  };
3961
3702
  responses: {
@@ -4147,7 +3888,7 @@ export interface operations {
4147
3888
  };
4148
3889
  };
4149
3890
  };
4150
- getUserStats: {
3891
+ bulkDeleteUsers: {
4151
3892
  parameters: {
4152
3893
  query?: never;
4153
3894
  header?: {
@@ -4156,7 +3897,11 @@ export interface operations {
4156
3897
  path?: never;
4157
3898
  cookie?: never;
4158
3899
  };
4159
- requestBody?: never;
3900
+ requestBody: {
3901
+ content: {
3902
+ "application/json": components["schemas"]["BulkDeleteRequest"];
3903
+ };
3904
+ };
4160
3905
  responses: {
4161
3906
  /** @description Successful Response */
4162
3907
  200: {