@erp-galoper/types 1.0.422 → 1.0.423

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 (2) hide show
  1. package/openapi.ts +545 -1
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -341,6 +341,8 @@ export interface paths {
341
341
  * - defaultGeneralAccountsObjectDoesNotExist
342
342
  * - defaultGeneralPaymentsAccountsDoesNotExist
343
343
  * - pinCodeDoesNotMeetTheCriteria
344
+ * - posRoleDoesNotExist
345
+ * - posRoleIsRequired
344
346
  * -201:
345
347
  * - userCreated
346
348
  * -403:
@@ -418,6 +420,8 @@ export interface paths {
418
420
  * - usernameConflict
419
421
  * - emailConflict
420
422
  * - pinCodeDoesNotMeetTheCriteria
423
+ * - posRoleDoesNotExist
424
+ * - posRoleIsRequired
421
425
  * - 500:
422
426
  * - internalServerError
423
427
  */
@@ -18208,6 +18212,120 @@ export interface paths {
18208
18212
  patch?: never;
18209
18213
  trace?: never;
18210
18214
  };
18215
+ "/api/v1/pos/roles/": {
18216
+ parameters: {
18217
+ query?: never;
18218
+ header?: never;
18219
+ path?: never;
18220
+ cookie?: never;
18221
+ };
18222
+ /**
18223
+ * List Pos Roles
18224
+ * @description Endpoint for listing roles.
18225
+ *
18226
+ * Responses:
18227
+ * - 200:
18228
+ * -RoleListSchema
18229
+ * - 400:
18230
+ * -paginationError
18231
+ * - 403:
18232
+ * -permissionDenied
18233
+ * - 500:
18234
+ * -internalServerError
18235
+ *
18236
+ * Permission Keys: posrole:[view]
18237
+ */
18238
+ get: operations["pos_role_views_list_pos_roles"];
18239
+ put?: never;
18240
+ /**
18241
+ * Create Pos Role
18242
+ * @description Endpoint for creating a new pos role.
18243
+ * Responses:
18244
+ * - 201:
18245
+ * -RoleSchema
18246
+ * - 400:
18247
+ * -roleAlreadyExists
18248
+ * - 403:
18249
+ * -permissionDenied
18250
+ * - 500:
18251
+ * -internalServerError
18252
+ *
18253
+ * Permission Keys: posrole:[add]
18254
+ */
18255
+ post: operations["pos_role_views_create_pos_role"];
18256
+ delete?: never;
18257
+ options?: never;
18258
+ head?: never;
18259
+ patch?: never;
18260
+ trace?: never;
18261
+ };
18262
+ "/api/v1/pos/roles/{id}/": {
18263
+ parameters: {
18264
+ query?: never;
18265
+ header?: never;
18266
+ path?: never;
18267
+ cookie?: never;
18268
+ };
18269
+ /**
18270
+ * Get Pos Role
18271
+ * @description Endpoint to retrieve a single role.
18272
+ *
18273
+ * Responses:
18274
+ * - 200:
18275
+ * -RoleSchema
18276
+ * - 403:
18277
+ * -permissionDenied
18278
+ * - 404:
18279
+ * -roleDoesNotExist
18280
+ * - 500:
18281
+ * -internalServerError
18282
+ *
18283
+ * Permission Keys: posrole:[view]
18284
+ */
18285
+ get: operations["pos_role_views_get_pos_role"];
18286
+ /**
18287
+ * Update Pos Role
18288
+ * @description Endpoint to update a role.
18289
+ *
18290
+ * Responses:
18291
+ * - 200:
18292
+ * -RoleSchema
18293
+ * - 400:
18294
+ * -roleAlreadyExists
18295
+ * - 403:
18296
+ * -permissionDenied
18297
+ * - 404:
18298
+ * -roleDoesNotExist
18299
+ * - 500:
18300
+ * -internalServerError
18301
+ *
18302
+ * Permission Keys: posrole:[change]
18303
+ */
18304
+ put: operations["pos_role_views_update_pos_role"];
18305
+ post?: never;
18306
+ /**
18307
+ * Delete Pos Role
18308
+ * @description Endpoint to delete a role.
18309
+ *
18310
+ * Responses:
18311
+ * - 204:
18312
+ * -None
18313
+ * - 403:
18314
+ * -permissionDenied
18315
+ * -cannotDeletePosRoleReferencedByAnotherObjects
18316
+ * - 404:
18317
+ * -roleDoesNotExist
18318
+ * - 500:
18319
+ * -internalServerError
18320
+ *
18321
+ * Permission Keys: posrole:[delete]
18322
+ */
18323
+ delete: operations["pos_role_views_delete_pos_role"];
18324
+ options?: never;
18325
+ head?: never;
18326
+ patch?: never;
18327
+ trace?: never;
18328
+ };
18211
18329
  }
18212
18330
  export type webhooks = Record<string, never>;
18213
18331
  export interface components {
@@ -20211,6 +20329,11 @@ export interface components {
20211
20329
  * @default []
20212
20330
  */
20213
20331
  departments: string[];
20332
+ /**
20333
+ * Posrole
20334
+ * @description pos role id, visible and required when user is cashier, get pos role using api/v1/pos/roles/
20335
+ */
20336
+ posRole?: number;
20214
20337
  };
20215
20338
  /** BranchSummaryInfo */
20216
20339
  BranchSummaryInfo: {
@@ -20223,12 +20346,118 @@ export interface components {
20223
20346
  /** Number */
20224
20347
  number: number;
20225
20348
  };
20349
+ /**
20350
+ * FullPermissionAction
20351
+ * @enum {string}
20352
+ */
20353
+ FullPermissionAction: "view" | "add" | "change" | "delete";
20354
+ /**
20355
+ * InvoicePermissionAction
20356
+ * @enum {string}
20357
+ */
20358
+ InvoicePermissionAction: "view" | "add" | "delete" | "hold" | "void" | "return" | "exchange" | "discount";
20226
20359
  /** ListUser */
20227
20360
  ListUser: {
20228
20361
  info: components["schemas"]["PageInfoSchema"];
20229
20362
  /** Results */
20230
20363
  results: components["schemas"]["RetrieveUserForList"][];
20231
20364
  };
20365
+ /** ModulePermissions */
20366
+ ModulePermissions: {
20367
+ /**
20368
+ * Category
20369
+ * @default []
20370
+ */
20371
+ category: components["schemas"]["FullPermissionAction"][];
20372
+ /**
20373
+ * Company
20374
+ * @default []
20375
+ */
20376
+ company: components["schemas"]["FullPermissionAction"][];
20377
+ /**
20378
+ * Currency
20379
+ * @default []
20380
+ */
20381
+ currency: components["schemas"]["FullPermissionAction"][];
20382
+ /**
20383
+ * Customer
20384
+ * @default []
20385
+ */
20386
+ customer: components["schemas"]["FullPermissionAction"][];
20387
+ /**
20388
+ * Invoice
20389
+ * @default []
20390
+ */
20391
+ invoice: components["schemas"]["InvoicePermissionAction"][];
20392
+ /**
20393
+ * Item
20394
+ * @default []
20395
+ */
20396
+ item: components["schemas"]["FullPermissionAction"][];
20397
+ /**
20398
+ * Tax
20399
+ * @default []
20400
+ */
20401
+ tax: components["schemas"]["FullPermissionAction"][];
20402
+ /**
20403
+ * User
20404
+ * @default []
20405
+ */
20406
+ user: components["schemas"]["FullPermissionAction"][];
20407
+ /**
20408
+ * Branch
20409
+ * @default []
20410
+ */
20411
+ branch: components["schemas"]["FullPermissionAction"][];
20412
+ /**
20413
+ * Role
20414
+ * @default []
20415
+ */
20416
+ role: components["schemas"]["FullPermissionAction"][];
20417
+ /**
20418
+ * Paymentmethod
20419
+ * @default []
20420
+ */
20421
+ paymentMethod: components["schemas"]["ViewOnlyPermissionAction"][];
20422
+ /**
20423
+ * Pos Settings
20424
+ * @default []
20425
+ */
20426
+ pos_settings: components["schemas"]["FullPermissionAction"][];
20427
+ /**
20428
+ * Financial Period
20429
+ * @default []
20430
+ */
20431
+ financial_period: components["schemas"]["FullPermissionAction"][];
20432
+ /**
20433
+ * System Settings
20434
+ * @default []
20435
+ */
20436
+ system_settings: components["schemas"]["FullPermissionAction"][];
20437
+ /**
20438
+ * Z Report
20439
+ * @default []
20440
+ */
20441
+ z_report: components["schemas"]["ViewOnlyPermissionAction"][];
20442
+ /**
20443
+ * X Report
20444
+ * @default []
20445
+ */
20446
+ x_report: components["schemas"]["ViewOnlyPermissionAction"][];
20447
+ };
20448
+ /** PosRoleSchema */
20449
+ PosRoleSchema: {
20450
+ /** Id */
20451
+ id: number;
20452
+ /** Name */
20453
+ name: string;
20454
+ permissions: components["schemas"]["ModulePermissions"];
20455
+ /**
20456
+ * Can Delete
20457
+ * @default false
20458
+ */
20459
+ can_delete: boolean;
20460
+ };
20232
20461
  /** RetrieveUserForList */
20233
20462
  RetrieveUserForList: {
20234
20463
  /**
@@ -20286,7 +20515,14 @@ export interface components {
20286
20515
  isOwner: boolean;
20287
20516
  /** Isactive */
20288
20517
  isActive: boolean;
20518
+ /** @description visible when user is cashier */
20519
+ posRole: components["schemas"]["PosRoleSchema"] | null;
20289
20520
  };
20521
+ /**
20522
+ * ViewOnlyPermissionAction
20523
+ * @constant
20524
+ */
20525
+ ViewOnlyPermissionAction: "view";
20290
20526
  /** RetrieveUser */
20291
20527
  RetrieveUser: {
20292
20528
  /**
@@ -20349,6 +20585,8 @@ export interface components {
20349
20585
  isOwner: boolean;
20350
20586
  /** Isactive */
20351
20587
  isActive: boolean;
20588
+ /** @description visible when user is cashier */
20589
+ posRole: components["schemas"]["PosRoleSchema"] | null;
20352
20590
  };
20353
20591
  /** UpdateUser */
20354
20592
  UpdateUser: {
@@ -20395,6 +20633,11 @@ export interface components {
20395
20633
  departments: string[];
20396
20634
  /** Isactive */
20397
20635
  isActive?: boolean;
20636
+ /**
20637
+ * Posrole
20638
+ * @description pos role id, visible and required when user is cashier
20639
+ */
20640
+ posRole?: number;
20398
20641
  };
20399
20642
  /** GenerateUserPinCodeResponseSchema */
20400
20643
  GenerateUserPinCodeResponseSchema: {
@@ -26607,7 +26850,7 @@ export interface components {
26607
26850
  /**
26608
26851
  * Id
26609
26852
  * Format: uuid
26610
- * @example 1009d14c-9f88-4dff-8c95-3d9042298e48
26853
+ * @example cb217cec-8d03-429c-b164-29b492aa137d
26611
26854
  */
26612
26855
  id: string;
26613
26856
  /**
@@ -44926,6 +45169,48 @@ export interface components {
44926
45169
  /** Items */
44927
45170
  items: components["schemas"]["ReturnReturnablePackageItemUpdateSchema"][];
44928
45171
  };
45172
+ /** CreateUpdateModulePermissions */
45173
+ CreateUpdateModulePermissions: {
45174
+ /** Category */
45175
+ category: components["schemas"]["FullPermissionAction"][];
45176
+ /** Company */
45177
+ company: components["schemas"]["FullPermissionAction"][];
45178
+ /** Currency */
45179
+ currency: components["schemas"]["FullPermissionAction"][];
45180
+ /** Customer */
45181
+ customer: components["schemas"]["FullPermissionAction"][];
45182
+ /** Invoice */
45183
+ invoice: components["schemas"]["FullPermissionAction"][];
45184
+ /** Returninvoice */
45185
+ returnInvoice: components["schemas"]["FullPermissionAction"][];
45186
+ /** Exchangeinvoice */
45187
+ exchangeInvoice: components["schemas"]["FullPermissionAction"][];
45188
+ /** Item */
45189
+ item: components["schemas"]["FullPermissionAction"][];
45190
+ /** Tax */
45191
+ tax: components["schemas"]["FullPermissionAction"][];
45192
+ /** User */
45193
+ user: components["schemas"]["FullPermissionAction"][];
45194
+ /** Branch */
45195
+ branch: components["schemas"]["FullPermissionAction"][];
45196
+ /** Role */
45197
+ role: components["schemas"]["FullPermissionAction"][];
45198
+ /** Paymentmethod */
45199
+ paymentMethod: components["schemas"]["ViewOnlyPermissionAction"][];
45200
+ };
45201
+ /** CreateUpdatePosRoleSchema */
45202
+ CreateUpdatePosRoleSchema: {
45203
+ /** Name */
45204
+ name: string;
45205
+ permissions: components["schemas"]["CreateUpdateModulePermissions"];
45206
+ };
45207
+ /** PosRoleListSchema */
45208
+ PosRoleListSchema: {
45209
+ /** Info */
45210
+ info: Record<string, never>;
45211
+ /** Results */
45212
+ results: components["schemas"]["PosRoleSchema"][];
45213
+ };
44929
45214
  };
44930
45215
  responses: never;
44931
45216
  parameters: never;
@@ -81788,4 +82073,263 @@ export interface operations {
81788
82073
  };
81789
82074
  };
81790
82075
  };
82076
+ pos_role_views_list_pos_roles: {
82077
+ parameters: {
82078
+ query?: {
82079
+ /** @description Search by role name */
82080
+ search?: string | null;
82081
+ };
82082
+ header?: never;
82083
+ path?: never;
82084
+ cookie?: never;
82085
+ };
82086
+ requestBody?: never;
82087
+ responses: {
82088
+ /** @description OK */
82089
+ 200: {
82090
+ headers: {
82091
+ [name: string]: unknown;
82092
+ };
82093
+ content: {
82094
+ "application/json": components["schemas"]["PosRoleListSchema"];
82095
+ };
82096
+ };
82097
+ /** @description Bad Request */
82098
+ 400: {
82099
+ headers: {
82100
+ [name: string]: unknown;
82101
+ };
82102
+ content: {
82103
+ "application/json": components["schemas"]["ErrorMessages"];
82104
+ };
82105
+ };
82106
+ /** @description Forbidden */
82107
+ 403: {
82108
+ headers: {
82109
+ [name: string]: unknown;
82110
+ };
82111
+ content: {
82112
+ "application/json": components["schemas"]["MessageResponse"];
82113
+ };
82114
+ };
82115
+ /** @description Internal Server Error */
82116
+ 500: {
82117
+ headers: {
82118
+ [name: string]: unknown;
82119
+ };
82120
+ content: {
82121
+ "application/json": components["schemas"]["MessageResponse"];
82122
+ };
82123
+ };
82124
+ };
82125
+ };
82126
+ pos_role_views_create_pos_role: {
82127
+ parameters: {
82128
+ query?: never;
82129
+ header?: never;
82130
+ path?: never;
82131
+ cookie?: never;
82132
+ };
82133
+ requestBody: {
82134
+ content: {
82135
+ "application/json": components["schemas"]["CreateUpdatePosRoleSchema"];
82136
+ };
82137
+ };
82138
+ responses: {
82139
+ /** @description Created */
82140
+ 201: {
82141
+ headers: {
82142
+ [name: string]: unknown;
82143
+ };
82144
+ content: {
82145
+ "application/json": components["schemas"]["PosRoleSchema"];
82146
+ };
82147
+ };
82148
+ /** @description Bad Request */
82149
+ 400: {
82150
+ headers: {
82151
+ [name: string]: unknown;
82152
+ };
82153
+ content: {
82154
+ "application/json": components["schemas"]["ErrorMessages"];
82155
+ };
82156
+ };
82157
+ /** @description Forbidden */
82158
+ 403: {
82159
+ headers: {
82160
+ [name: string]: unknown;
82161
+ };
82162
+ content: {
82163
+ "application/json": components["schemas"]["MessageResponse"];
82164
+ };
82165
+ };
82166
+ /** @description Internal Server Error */
82167
+ 500: {
82168
+ headers: {
82169
+ [name: string]: unknown;
82170
+ };
82171
+ content: {
82172
+ "application/json": components["schemas"]["MessageResponse"];
82173
+ };
82174
+ };
82175
+ };
82176
+ };
82177
+ pos_role_views_get_pos_role: {
82178
+ parameters: {
82179
+ query?: never;
82180
+ header?: never;
82181
+ path: {
82182
+ id: number;
82183
+ };
82184
+ cookie?: never;
82185
+ };
82186
+ requestBody?: never;
82187
+ responses: {
82188
+ /** @description OK */
82189
+ 200: {
82190
+ headers: {
82191
+ [name: string]: unknown;
82192
+ };
82193
+ content: {
82194
+ "application/json": components["schemas"]["PosRoleSchema"];
82195
+ };
82196
+ };
82197
+ /** @description Forbidden */
82198
+ 403: {
82199
+ headers: {
82200
+ [name: string]: unknown;
82201
+ };
82202
+ content: {
82203
+ "application/json": components["schemas"]["MessageResponse"];
82204
+ };
82205
+ };
82206
+ /** @description Not Found */
82207
+ 404: {
82208
+ headers: {
82209
+ [name: string]: unknown;
82210
+ };
82211
+ content: {
82212
+ "application/json": components["schemas"]["MessageResponse"];
82213
+ };
82214
+ };
82215
+ /** @description Internal Server Error */
82216
+ 500: {
82217
+ headers: {
82218
+ [name: string]: unknown;
82219
+ };
82220
+ content: {
82221
+ "application/json": components["schemas"]["MessageResponse"];
82222
+ };
82223
+ };
82224
+ };
82225
+ };
82226
+ pos_role_views_update_pos_role: {
82227
+ parameters: {
82228
+ query?: never;
82229
+ header?: never;
82230
+ path: {
82231
+ id: number;
82232
+ };
82233
+ cookie?: never;
82234
+ };
82235
+ requestBody: {
82236
+ content: {
82237
+ "application/json": components["schemas"]["CreateUpdatePosRoleSchema"];
82238
+ };
82239
+ };
82240
+ responses: {
82241
+ /** @description OK */
82242
+ 200: {
82243
+ headers: {
82244
+ [name: string]: unknown;
82245
+ };
82246
+ content: {
82247
+ "application/json": components["schemas"]["PosRoleSchema"];
82248
+ };
82249
+ };
82250
+ /** @description Bad Request */
82251
+ 400: {
82252
+ headers: {
82253
+ [name: string]: unknown;
82254
+ };
82255
+ content: {
82256
+ "application/json": components["schemas"]["ErrorMessages"];
82257
+ };
82258
+ };
82259
+ /** @description Forbidden */
82260
+ 403: {
82261
+ headers: {
82262
+ [name: string]: unknown;
82263
+ };
82264
+ content: {
82265
+ "application/json": components["schemas"]["MessageResponse"];
82266
+ };
82267
+ };
82268
+ /** @description Not Found */
82269
+ 404: {
82270
+ headers: {
82271
+ [name: string]: unknown;
82272
+ };
82273
+ content: {
82274
+ "application/json": components["schemas"]["MessageResponse"];
82275
+ };
82276
+ };
82277
+ /** @description Internal Server Error */
82278
+ 500: {
82279
+ headers: {
82280
+ [name: string]: unknown;
82281
+ };
82282
+ content: {
82283
+ "application/json": components["schemas"]["MessageResponse"];
82284
+ };
82285
+ };
82286
+ };
82287
+ };
82288
+ pos_role_views_delete_pos_role: {
82289
+ parameters: {
82290
+ query?: never;
82291
+ header?: never;
82292
+ path: {
82293
+ id: number;
82294
+ };
82295
+ cookie?: never;
82296
+ };
82297
+ requestBody?: never;
82298
+ responses: {
82299
+ /** @description No Content */
82300
+ 204: {
82301
+ headers: {
82302
+ [name: string]: unknown;
82303
+ };
82304
+ content?: never;
82305
+ };
82306
+ /** @description Forbidden */
82307
+ 403: {
82308
+ headers: {
82309
+ [name: string]: unknown;
82310
+ };
82311
+ content: {
82312
+ "application/json": components["schemas"]["MessageResponse"];
82313
+ };
82314
+ };
82315
+ /** @description Not Found */
82316
+ 404: {
82317
+ headers: {
82318
+ [name: string]: unknown;
82319
+ };
82320
+ content: {
82321
+ "application/json": components["schemas"]["MessageResponse"];
82322
+ };
82323
+ };
82324
+ /** @description Internal Server Error */
82325
+ 500: {
82326
+ headers: {
82327
+ [name: string]: unknown;
82328
+ };
82329
+ content: {
82330
+ "application/json": components["schemas"]["MessageResponse"];
82331
+ };
82332
+ };
82333
+ };
82334
+ };
81791
82335
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@erp-galoper/types",
3
- "version": "1.0.422",
3
+ "version": "1.0.423",
4
4
  "main": "openapi.ts",
5
5
  "types": "openapi.ts",
6
6
  "files": ["openapi.ts"],