@erp-galoper/main-package 1.0.5 → 1.0.7

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 +146 -164
  2. package/package.json +1 -1
package/openapi.ts CHANGED
@@ -138,13 +138,12 @@ export interface paths {
138
138
  * New Default Warehouse
139
139
  * @description Endpoint for create warehouse.
140
140
  * Possible Responses:
141
- * - 400: "Bad Request"
142
- * - "Invalid parameters"
143
- *
144
- * - 201: "Created"
145
- * - "Warehouse Created Successfully"
146
- * - 403: "Forbidden"
147
- * - "You do not have permission to perform this action"
141
+ * - 400: invalidParameters
142
+ * - Invalid parameters
143
+ * - 201: warehouseCreated
144
+ * - Warehouse Created Successfully
145
+ * - 403: Forbidden
146
+ * - You do not have permission to perform this action
148
147
  */
149
148
  post: operations["inventory_warehouse_views_new_default_warehouse"];
150
149
  };
@@ -181,13 +180,14 @@ export interface paths {
181
180
  * New Branch
182
181
  * @description Endpoint for create branch.
183
182
  * Possible Responses:
184
- * - 400: "Bad Request"
185
- * - "Invalid parameters"
186
- *
187
- * - 201: "Created"
188
- * - "Branch Created Successfully"
189
- * - 403: "Forbidden"
190
- * - "You do not have permission to perform this action"
183
+ * - 400: invalidParameters
184
+ * - Invalid parameters
185
+ * - 201: branchCreated
186
+ * - Branch Created Successfully
187
+ * - 403: Forbidden
188
+ * - You do not have permission to perform this action
189
+ * - 404: companyNotFound
190
+ * - Company not found
191
191
  */
192
192
  post: operations["company_views_new_branch"];
193
193
  };
@@ -196,14 +196,14 @@ export interface paths {
196
196
  * New Company
197
197
  * @description Endpoint for create company.
198
198
  * Possible Responses:
199
- * - 400: "Bad Request"
200
- * - "Invalid parameters"
201
- * - 201: "Created"
202
- * - "Company Created Successfully"
203
- * - 403: "Forbidden"
204
- * - "You do not have permission to perform this action"
205
- * - 404: "Not Found"
206
- * - "Image Path Not Found"
199
+ * - 400: invalidParameters
200
+ * - Invalid parameters
201
+ * - 201: companyCreated
202
+ * - Company Created Successfully
203
+ * - 403: Forbidden
204
+ * - You do not have permission to perform this action
205
+ * - 404: ImageNotFound
206
+ * - Image Path Not Found
207
207
  */
208
208
  post: operations["company_views_new_company"];
209
209
  };
@@ -212,12 +212,12 @@ export interface paths {
212
212
  * Get Company
213
213
  * @description Endpoint for retrieve company.
214
214
  * Possible Responses:
215
- * - 200: "Success"
216
- * - "Success"
217
- * - 404: "Not found"
218
- * - "Company not found"
219
- * - 403: "Forbidden"
220
- * - "You do not have permission to perform this action"
215
+ * - 200: Success
216
+ * - Success
217
+ * - 404: companyNotFound
218
+ * - Company not found
219
+ * - 403: Forbidden
220
+ * - You do not have permission to perform this action
221
221
  */
222
222
  get: operations["company_views_get_company"];
223
223
  /**
@@ -240,12 +240,12 @@ export interface paths {
240
240
  * Get Branch
241
241
  * @description Endpoint for retrieve branch.
242
242
  * Possible Responses:
243
- * - 200: "Success"
244
- * - "Success"
245
- * - 404: "Not found"
246
- * - "Branch not found"
247
- * - 403: "Forbidden"
248
- * - "You do not have permission to perform this action"
243
+ * - 200: Success
244
+ * - Success
245
+ * - 404: branchNotFound
246
+ * - Branch not found
247
+ * - 403: Forbidden
248
+ * - You do not have permission to perform this action
249
249
  */
250
250
  get: operations["company_views_get_branch"];
251
251
  /**
@@ -268,10 +268,8 @@ export interface paths {
268
268
  * Company Setup Steps
269
269
  * @description Endpoint for get onboarding steps.
270
270
  * Possible Responses:
271
- * - 200: "Success"
272
- * - "Success"
273
- * - 405: "Method not allowed"
274
- * - "Method not allowed"
271
+ * - 200: Success
272
+ * - Success
275
273
  */
276
274
  get: operations["company_views_company_setup_steps"];
277
275
  };
@@ -290,10 +288,8 @@ export interface paths {
290
288
  * Get Fiscal Year End Date
291
289
  * @description Endpoint for fetching fiscal year month end and fiscal year end day.
292
290
  * Possible Responses:
293
- * - 200: "Success"
294
- * - "Success"
295
- * - 422: "Error"
296
- * - "Unprocessable Entity"
291
+ * - 200: Success
292
+ * - Success"
297
293
  */
298
294
  get: operations["common_views_get_fiscal_year_end_date"];
299
295
  };
@@ -314,10 +310,10 @@ export interface paths {
314
310
  * Get Currency Code
315
311
  * @description Endpoint for to get currency code.
316
312
  * Possible Responses:
317
- * - 200: "Success"
318
- * - "Success"
319
- * - 404: "Not Found"
320
- * - "Not Found"
313
+ * - 200: Success
314
+ * - Success
315
+ * - 404: countryNotFound
316
+ * - Not Found
321
317
  */
322
318
  get: operations["common_views_get_currency_code"];
323
319
  };
@@ -326,12 +322,12 @@ export interface paths {
326
322
  * Get Galoper Setting
327
323
  * @description Endpoint for retreive galoper setting.
328
324
  * Possible Responses:
329
- * - 200: "Success"
330
- * - "Success"
331
- * - 404: "Not found"
332
- * - "Not found"
333
- * - 403: "Forbidden"
334
- * - "You do not have permission to perform this action"
325
+ * - 200: Success
326
+ * - Success
327
+ * - 404: galoperSettingNotFound
328
+ * - Galoper Settings not found
329
+ * - 403: Forbidden
330
+ * - You do not have permission to perform this action
335
331
  */
336
332
  get: operations["admin_panel_views_get_galoper_setting"];
337
333
  };
@@ -356,17 +352,16 @@ export interface paths {
356
352
  * Load Chart Of Account
357
353
  * @description Endpoint for create Chart of Account.
358
354
  * Possible Responses:
359
- * - 400: "Bad Request"
360
- * - "Invalid parameters"
355
+ * - 400: invalidParameters
356
+ * - Invalid parameters
361
357
  * - 200: "Success"
362
- * - "Success"
363
- * - 201: "Created"
364
- * - "Chart of Account Created Successfully"
365
- * - 403: "Forbidden"
366
- * - "You do not have permission to perform this action"
367
- * - 404: "Not Found"
368
- * - "Company Not Found"
369
- * - "Galoper Settings Not Found"
358
+ * - Success
359
+ * - 201: chartOfAccountCreatedSuccessfully
360
+ * - Chart of Account Created Successfully
361
+ * - 403: Forbidden
362
+ * - You do not have permission to perform this action
363
+ * - 404: galoperSettingNotFound / companyNotFound
364
+ * - Galoper Setting not found / Company not found
370
365
  */
371
366
  post: operations["admin_panel_views_load_chart_of_account"];
372
367
  };
@@ -375,14 +370,14 @@ export interface paths {
375
370
  * Load Settings
376
371
  * @description Endpoint for load settings.
377
372
  * Possible Responses:
378
- * - 400: "Bad Request"
379
- * - "Invalid parameters"
380
- * - 201: "Created"
381
- * - "Settings Loaded Successfully"
382
- * - 403: "Forbidden"
383
- * - "You do not have permission to perform this action"
384
- * -404: "Not Found"
385
- * - "message" : "Incompatible Country""
373
+ * - 400: invalidParameters
374
+ * - Invalid parameters
375
+ * - 201: settingsCraeted
376
+ * - Settings Created Successfully
377
+ * - 403: Forbidden
378
+ * - You do not have permission to perform this action
379
+ * - 404: companyNotFound
380
+ * - Company not Found
386
381
  */
387
382
  post: operations["erp_settings_views_load_settings"];
388
383
  };
@@ -545,14 +540,8 @@ export interface components {
545
540
  MessageResponse: {
546
541
  /** Message */
547
542
  message: string;
548
- [key: string]: unknown;
549
- };
550
- /** ObjectResponse */
551
- ObjectResponse: {
552
- /** Message */
553
- message: string;
554
- /** Error */
555
- error: string;
543
+ /** Code */
544
+ code: unknown[];
556
545
  [key: string]: unknown;
557
546
  };
558
547
  /** WarehouseSchema */
@@ -618,8 +607,6 @@ export interface components {
618
607
  CompanySchema: {
619
608
  /** Name */
620
609
  name: string;
621
- /** Currency */
622
- currency: string;
623
610
  /** Vat */
624
611
  vat: boolean;
625
612
  /**
@@ -818,14 +805,6 @@ export interface components {
818
805
  type: string;
819
806
  [key: string]: unknown;
820
807
  };
821
- /** GeneralResponse */
822
- GeneralResponse: {
823
- /** Message */
824
- message: string;
825
- /** Code */
826
- code: unknown[];
827
- [key: string]: unknown;
828
- };
829
808
  /** currencyCodeOut */
830
809
  currencyCodeOut: {
831
810
  /** Currencycode */
@@ -1282,13 +1261,12 @@ export interface operations {
1282
1261
  * New Default Warehouse
1283
1262
  * @description Endpoint for create warehouse.
1284
1263
  * Possible Responses:
1285
- * - 400: "Bad Request"
1286
- * - "Invalid parameters"
1287
- *
1288
- * - 201: "Created"
1289
- * - "Warehouse Created Successfully"
1290
- * - 403: "Forbidden"
1291
- * - "You do not have permission to perform this action"
1264
+ * - 400: invalidParameters
1265
+ * - Invalid parameters
1266
+ * - 201: warehouseCreated
1267
+ * - Warehouse Created Successfully
1268
+ * - 403: Forbidden
1269
+ * - You do not have permission to perform this action
1292
1270
  */
1293
1271
  inventory_warehouse_views_new_default_warehouse: {
1294
1272
  requestBody: {
@@ -1306,7 +1284,7 @@ export interface operations {
1306
1284
  /** @description Bad Request */
1307
1285
  400: {
1308
1286
  content: {
1309
- "application/json": components["schemas"]["ObjectResponse"];
1287
+ "application/json": components["schemas"]["MessageResponse"];
1310
1288
  };
1311
1289
  };
1312
1290
  /** @description Forbidden */
@@ -1410,13 +1388,14 @@ export interface operations {
1410
1388
  * New Branch
1411
1389
  * @description Endpoint for create branch.
1412
1390
  * Possible Responses:
1413
- * - 400: "Bad Request"
1414
- * - "Invalid parameters"
1415
- *
1416
- * - 201: "Created"
1417
- * - "Branch Created Successfully"
1418
- * - 403: "Forbidden"
1419
- * - "You do not have permission to perform this action"
1391
+ * - 400: invalidParameters
1392
+ * - Invalid parameters
1393
+ * - 201: branchCreated
1394
+ * - Branch Created Successfully
1395
+ * - 403: Forbidden
1396
+ * - You do not have permission to perform this action
1397
+ * - 404: companyNotFound
1398
+ * - Company not found
1420
1399
  */
1421
1400
  company_views_new_branch: {
1422
1401
  requestBody: {
@@ -1434,7 +1413,7 @@ export interface operations {
1434
1413
  /** @description Bad Request */
1435
1414
  400: {
1436
1415
  content: {
1437
- "application/json": components["schemas"]["ObjectResponse"];
1416
+ "application/json": components["schemas"]["MessageResponse"];
1438
1417
  };
1439
1418
  };
1440
1419
  /** @description Forbidden */
@@ -1455,14 +1434,14 @@ export interface operations {
1455
1434
  * New Company
1456
1435
  * @description Endpoint for create company.
1457
1436
  * Possible Responses:
1458
- * - 400: "Bad Request"
1459
- * - "Invalid parameters"
1460
- * - 201: "Created"
1461
- * - "Company Created Successfully"
1462
- * - 403: "Forbidden"
1463
- * - "You do not have permission to perform this action"
1464
- * - 404: "Not Found"
1465
- * - "Image Path Not Found"
1437
+ * - 400: invalidParameters
1438
+ * - Invalid parameters
1439
+ * - 201: companyCreated
1440
+ * - Company Created Successfully
1441
+ * - 403: Forbidden
1442
+ * - You do not have permission to perform this action
1443
+ * - 404: ImageNotFound
1444
+ * - Image Path Not Found
1466
1445
  */
1467
1446
  company_views_new_company: {
1468
1447
  requestBody: {
@@ -1480,7 +1459,7 @@ export interface operations {
1480
1459
  /** @description Bad Request */
1481
1460
  400: {
1482
1461
  content: {
1483
- "application/json": components["schemas"]["ObjectResponse"];
1462
+ "application/json": components["schemas"]["MessageResponse"];
1484
1463
  };
1485
1464
  };
1486
1465
  /** @description Forbidden */
@@ -1501,12 +1480,12 @@ export interface operations {
1501
1480
  * Get Company
1502
1481
  * @description Endpoint for retrieve company.
1503
1482
  * Possible Responses:
1504
- * - 200: "Success"
1505
- * - "Success"
1506
- * - 404: "Not found"
1507
- * - "Company not found"
1508
- * - 403: "Forbidden"
1509
- * - "You do not have permission to perform this action"
1483
+ * - 200: Success
1484
+ * - Success
1485
+ * - 404: companyNotFound
1486
+ * - Company not found
1487
+ * - 403: Forbidden
1488
+ * - You do not have permission to perform this action
1510
1489
  */
1511
1490
  company_views_get_company: {
1512
1491
  parameters: {
@@ -1590,12 +1569,12 @@ export interface operations {
1590
1569
  * Get Branch
1591
1570
  * @description Endpoint for retrieve branch.
1592
1571
  * Possible Responses:
1593
- * - 200: "Success"
1594
- * - "Success"
1595
- * - 404: "Not found"
1596
- * - "Branch not found"
1597
- * - 403: "Forbidden"
1598
- * - "You do not have permission to perform this action"
1572
+ * - 200: Success
1573
+ * - Success
1574
+ * - 404: branchNotFound
1575
+ * - Branch not found
1576
+ * - 403: Forbidden
1577
+ * - You do not have permission to perform this action
1599
1578
  */
1600
1579
  company_views_get_branch: {
1601
1580
  parameters: {
@@ -1679,10 +1658,8 @@ export interface operations {
1679
1658
  * Company Setup Steps
1680
1659
  * @description Endpoint for get onboarding steps.
1681
1660
  * Possible Responses:
1682
- * - 200: "Success"
1683
- * - "Success"
1684
- * - 405: "Method not allowed"
1685
- * - "Method not allowed"
1661
+ * - 200: Success
1662
+ * - Success
1686
1663
  */
1687
1664
  company_views_company_setup_steps: {
1688
1665
  responses: {
@@ -1721,10 +1698,8 @@ export interface operations {
1721
1698
  * Get Fiscal Year End Date
1722
1699
  * @description Endpoint for fetching fiscal year month end and fiscal year end day.
1723
1700
  * Possible Responses:
1724
- * - 200: "Success"
1725
- * - "Success"
1726
- * - 422: "Error"
1727
- * - "Unprocessable Entity"
1701
+ * - 200: Success
1702
+ * - Success"
1728
1703
  */
1729
1704
  common_views_get_fiscal_year_end_date: {
1730
1705
  parameters: {
@@ -1784,10 +1759,10 @@ export interface operations {
1784
1759
  * Get Currency Code
1785
1760
  * @description Endpoint for to get currency code.
1786
1761
  * Possible Responses:
1787
- * - 200: "Success"
1788
- * - "Success"
1789
- * - 404: "Not Found"
1790
- * - "Not Found"
1762
+ * - 200: Success
1763
+ * - Success
1764
+ * - 404: countryNotFound
1765
+ * - Not Found
1791
1766
  */
1792
1767
  common_views_get_currency_code: {
1793
1768
  parameters: {
@@ -1805,7 +1780,7 @@ export interface operations {
1805
1780
  /** @description Not Found */
1806
1781
  404: {
1807
1782
  content: {
1808
- "application/json": components["schemas"]["GeneralResponse"];
1783
+ "application/json": components["schemas"]["MessageResponse"];
1809
1784
  };
1810
1785
  };
1811
1786
  };
@@ -1814,12 +1789,12 @@ export interface operations {
1814
1789
  * Get Galoper Setting
1815
1790
  * @description Endpoint for retreive galoper setting.
1816
1791
  * Possible Responses:
1817
- * - 200: "Success"
1818
- * - "Success"
1819
- * - 404: "Not found"
1820
- * - "Not found"
1821
- * - 403: "Forbidden"
1822
- * - "You do not have permission to perform this action"
1792
+ * - 200: Success
1793
+ * - Success
1794
+ * - 404: galoperSettingNotFound
1795
+ * - Galoper Settings not found
1796
+ * - 403: Forbidden
1797
+ * - You do not have permission to perform this action
1823
1798
  */
1824
1799
  admin_panel_views_get_galoper_setting: {
1825
1800
  responses: {
@@ -1898,17 +1873,16 @@ export interface operations {
1898
1873
  * Load Chart Of Account
1899
1874
  * @description Endpoint for create Chart of Account.
1900
1875
  * Possible Responses:
1901
- * - 400: "Bad Request"
1902
- * - "Invalid parameters"
1876
+ * - 400: invalidParameters
1877
+ * - Invalid parameters
1903
1878
  * - 200: "Success"
1904
- * - "Success"
1905
- * - 201: "Created"
1906
- * - "Chart of Account Created Successfully"
1907
- * - 403: "Forbidden"
1908
- * - "You do not have permission to perform this action"
1909
- * - 404: "Not Found"
1910
- * - "Company Not Found"
1911
- * - "Galoper Settings Not Found"
1879
+ * - Success
1880
+ * - 201: chartOfAccountCreatedSuccessfully
1881
+ * - Chart of Account Created Successfully
1882
+ * - 403: Forbidden
1883
+ * - You do not have permission to perform this action
1884
+ * - 404: galoperSettingNotFound / companyNotFound
1885
+ * - Galoper Setting not found / Company not found
1912
1886
  */
1913
1887
  admin_panel_views_load_chart_of_account: {
1914
1888
  requestBody: {
@@ -1953,14 +1927,14 @@ export interface operations {
1953
1927
  * Load Settings
1954
1928
  * @description Endpoint for load settings.
1955
1929
  * Possible Responses:
1956
- * - 400: "Bad Request"
1957
- * - "Invalid parameters"
1958
- * - 201: "Created"
1959
- * - "Settings Loaded Successfully"
1960
- * - 403: "Forbidden"
1961
- * - "You do not have permission to perform this action"
1962
- * -404: "Not Found"
1963
- * - "message" : "Incompatible Country""
1930
+ * - 400: invalidParameters
1931
+ * - Invalid parameters
1932
+ * - 201: settingsCraeted
1933
+ * - Settings Created Successfully
1934
+ * - 403: Forbidden
1935
+ * - You do not have permission to perform this action
1936
+ * - 404: companyNotFound
1937
+ * - Company not Found
1964
1938
  */
1965
1939
  erp_settings_views_load_settings: {
1966
1940
  requestBody: {
@@ -1978,7 +1952,7 @@ export interface operations {
1978
1952
  /** @description Bad Request */
1979
1953
  400: {
1980
1954
  content: {
1981
- "application/json": components["schemas"]["ObjectResponse"];
1955
+ "application/json": components["schemas"]["MessageResponse"];
1982
1956
  };
1983
1957
  };
1984
1958
  /** @description Forbidden */
@@ -2000,7 +1974,15 @@ export interface operations {
2000
1974
  responses: {
2001
1975
  /** @description OK */
2002
1976
  200: {
2003
- content: never;
1977
+ content: {
1978
+ "application/json": unknown[];
1979
+ };
1980
+ };
1981
+ /** @description Not Found */
1982
+ 404: {
1983
+ content: {
1984
+ "application/json": components["schemas"]["MessageResponse"];
1985
+ };
2004
1986
  };
2005
1987
  };
2006
1988
  };
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@erp-galoper/main-package",
3
- "version": "1.0.5",
3
+ "version": "1.0.7",
4
4
  "main": "openapi.ts"
5
5
  }