@fill-easy/api 1.0.35 → 1.0.37

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/dist/openapi.d.ts +156 -34
  2. package/package.json +1 -1
package/dist/openapi.d.ts CHANGED
@@ -967,7 +967,7 @@ export interface paths {
967
967
  *
968
968
  * The type of search is dependent on the country:
969
969
  *
970
- * *Substring search*: KY, TH, PH
970
+ * *Substring search*: KY, TH, PH, JP
971
971
  *
972
972
  * *Tokenized search (e.g. searching "PLE" will not result in "APPLE")*: AU, SG
973
973
  *
@@ -1396,7 +1396,7 @@ export interface components {
1396
1396
  * @example Private Company
1397
1397
  * @enum {string}
1398
1398
  */
1399
- registrationDetail: "Company Limited by Shares" | "Registered Non-Hong Kong Company" | "Company Limited by Guarantee" | "Limited Company" | "Unlimited Company" | "Registered Society/Organization" | "Open-ended Fund Company" | "Open-ended Investment Company" | "Limited Partnership Fund" | "Public Company" | "Private Company" | "Foreign Company" | "Foreign Company Branch" | "Registered Overseas Entity" | "Registered Australian Corporation under non-Corporations Law" | "Company Limited by Both Shares and Guarantees" | "No Liability Company" | "Sole Proprietorship/ Partnership" | "Sole Proprietorship" | "Limited Liability Partnership" | "Limited Partnership" | "Unlimited Partnership" | "Local Company" | "Juristic Ordinary Partnership" | "Foreign Juristic Person" | "Joint Venture" | "Chamber of Commerce" | "Private Limited by Guarantee (Section 60 Exemption)" | "Assurance Company" | "European Economic Interest Grouping" | "Royal Charter Body" | "United Kingdom Societas" | "United Kingdom Economic Interest Grouping" | "Charitable Incorporated Organisation" | "Educational Corporation" | "N/A";
1399
+ registrationDetail: "Company Limited by Shares" | "Registered Non-Hong Kong Company" | "Company Limited by Guarantee" | "Limited Company" | "Limited Liability Company" | "Unlimited Company" | "Registered Society/Organization" | "Open-ended Fund Company" | "Open-ended Investment Company" | "Limited Partnership Fund" | "Public Company" | "Private Company" | "Foreign Company" | "Foreign Company Branch" | "Registered Overseas Entity" | "Registered Australian Corporation under non-Corporations Law" | "Company Limited by Both Shares and Guarantees" | "No Liability Company" | "Sole Proprietorship/ Partnership" | "Sole Proprietorship" | "Limited Liability Partnership" | "Limited Partnership" | "Unlimited Partnership" | "Local Company" | "Juristic Ordinary Partnership" | "Foreign Juristic Person" | "Joint Venture" | "Chamber of Commerce" | "Private Limited by Guarantee (Section 60 Exemption)" | "Assurance Company" | "European Economic Interest Grouping" | "Royal Charter Body" | "United Kingdom Societas" | "United Kingdom Economic Interest Grouping" | "Charitable Incorporated Organisation" | "Educational Corporation" | "Government Body" | "General Partnership Company" | "Limited Partnership Company" | "Special Registered Corporation" | "Other" | "N/A";
1400
1400
  };
1401
1401
  responses: {
1402
1402
  /** @description Unauthorized - Token is missing, invalid, or expired */
@@ -1710,14 +1710,25 @@ export interface operations {
1710
1710
  path?: never;
1711
1711
  cookie?: never;
1712
1712
  };
1713
- requestBody?: never;
1713
+ requestBody: {
1714
+ content: {
1715
+ "application/json": {
1716
+ token: components["schemas"]["Token"];
1717
+ };
1718
+ };
1719
+ };
1714
1720
  responses: {
1715
1721
  /** @description Success */
1716
1722
  200: {
1717
1723
  headers: {
1718
1724
  [name: string]: unknown;
1719
1725
  };
1720
- content?: never;
1726
+ content: {
1727
+ "application/json": {
1728
+ message?: string;
1729
+ token?: string;
1730
+ };
1731
+ };
1721
1732
  };
1722
1733
  };
1723
1734
  };
@@ -1943,8 +1954,8 @@ export interface operations {
1943
1954
  };
1944
1955
  requestBody?: never;
1945
1956
  responses: {
1946
- /** @description Success */
1947
- 200: {
1957
+ /** @description Redirect to client application */
1958
+ 302: {
1948
1959
  headers: {
1949
1960
  [name: string]: unknown;
1950
1961
  };
@@ -2152,11 +2163,17 @@ export interface operations {
2152
2163
  };
2153
2164
  };
2154
2165
  responses: {
2166
+ /** @description Success */
2155
2167
  200: {
2156
2168
  headers: {
2157
2169
  [name: string]: unknown;
2158
2170
  };
2159
- content?: never;
2171
+ content: {
2172
+ "application/json": {
2173
+ url?: string;
2174
+ token?: string;
2175
+ };
2176
+ };
2160
2177
  };
2161
2178
  };
2162
2179
  };
@@ -2169,7 +2186,8 @@ export interface operations {
2169
2186
  };
2170
2187
  requestBody?: never;
2171
2188
  responses: {
2172
- 200: {
2189
+ /** @description Redirect to Singpass authorization */
2190
+ 302: {
2173
2191
  headers: {
2174
2192
  [name: string]: unknown;
2175
2193
  };
@@ -2186,7 +2204,8 @@ export interface operations {
2186
2204
  };
2187
2205
  requestBody?: never;
2188
2206
  responses: {
2189
- 200: {
2207
+ /** @description Redirect to client application */
2208
+ 302: {
2190
2209
  headers: {
2191
2210
  [name: string]: unknown;
2192
2211
  };
@@ -2203,7 +2222,8 @@ export interface operations {
2203
2222
  };
2204
2223
  requestBody?: never;
2205
2224
  responses: {
2206
- 200: {
2225
+ /** @description Redirect to client application */
2226
+ 302: {
2207
2227
  headers: {
2208
2228
  [name: string]: unknown;
2209
2229
  };
@@ -2220,7 +2240,8 @@ export interface operations {
2220
2240
  };
2221
2241
  requestBody?: never;
2222
2242
  responses: {
2223
- 200: {
2243
+ /** @description Redirect to client application */
2244
+ 302: {
2224
2245
  headers: {
2225
2246
  [name: string]: unknown;
2226
2247
  };
@@ -2237,11 +2258,18 @@ export interface operations {
2237
2258
  };
2238
2259
  requestBody?: never;
2239
2260
  responses: {
2261
+ /** @description JWK Set */
2240
2262
  200: {
2241
2263
  headers: {
2242
2264
  [name: string]: unknown;
2243
2265
  };
2244
- content?: never;
2266
+ content: {
2267
+ "application/json": {
2268
+ keys: {
2269
+ [key: string]: unknown;
2270
+ }[];
2271
+ };
2272
+ };
2245
2273
  };
2246
2274
  };
2247
2275
  };
@@ -2271,6 +2299,8 @@ export interface operations {
2271
2299
  };
2272
2300
  content: {
2273
2301
  "application/json": {
2302
+ /** @description Status message */
2303
+ message?: string;
2274
2304
  /** @description URL that should be shown to the user (usually as a QR code) */
2275
2305
  url?: string;
2276
2306
  /** @description Used to poll requested data */
@@ -2278,6 +2308,17 @@ export interface operations {
2278
2308
  };
2279
2309
  };
2280
2310
  };
2311
+ /** @description Pending - Data not yet available */
2312
+ 202: {
2313
+ headers: {
2314
+ [name: string]: unknown;
2315
+ };
2316
+ content: {
2317
+ "application/json": {
2318
+ message?: string;
2319
+ };
2320
+ };
2321
+ };
2281
2322
  /** @description Bad Request - Invalid request body. Ensure that your request body complies with the requirements. */
2282
2323
  400: {
2283
2324
  headers: {
@@ -2401,6 +2442,18 @@ export interface operations {
2401
2442
  content: {
2402
2443
  "application/json": {
2403
2444
  faceImage?: string;
2445
+ sceneImage?: string;
2446
+ message?: string;
2447
+ };
2448
+ };
2449
+ };
2450
+ /** @description Pending */
2451
+ 202: {
2452
+ headers: {
2453
+ [name: string]: unknown;
2454
+ };
2455
+ content: {
2456
+ "application/json": {
2404
2457
  message?: string;
2405
2458
  };
2406
2459
  };
@@ -2486,7 +2539,30 @@ export interface operations {
2486
2539
  content: {
2487
2540
  "application/json": {
2488
2541
  message?: string;
2489
- token?: components["schemas"]["Token"];
2542
+ /** @description Response data from UAE Pass */
2543
+ data?: unknown;
2544
+ };
2545
+ };
2546
+ };
2547
+ /** @description Pending - Authentication not yet complete */
2548
+ 202: {
2549
+ headers: {
2550
+ [name: string]: unknown;
2551
+ };
2552
+ content: {
2553
+ "application/json": {
2554
+ message?: string;
2555
+ };
2556
+ };
2557
+ };
2558
+ /** @description Bad Request */
2559
+ 400: {
2560
+ headers: {
2561
+ [name: string]: unknown;
2562
+ };
2563
+ content: {
2564
+ "application/json": {
2565
+ message?: string;
2490
2566
  };
2491
2567
  };
2492
2568
  };
@@ -2501,13 +2577,24 @@ export interface operations {
2501
2577
  };
2502
2578
  requestBody?: never;
2503
2579
  responses: {
2504
- /** @description Success */
2505
- 200: {
2580
+ /** @description Redirect to client application */
2581
+ 302: {
2506
2582
  headers: {
2507
2583
  [name: string]: unknown;
2508
2584
  };
2509
2585
  content?: never;
2510
2586
  };
2587
+ /** @description Bad Request */
2588
+ 400: {
2589
+ headers: {
2590
+ [name: string]: unknown;
2591
+ };
2592
+ content: {
2593
+ "application/json": {
2594
+ error?: string;
2595
+ };
2596
+ };
2597
+ };
2511
2598
  };
2512
2599
  };
2513
2600
  uaepassLogout: {
@@ -2923,13 +3010,7 @@ export interface operations {
2923
3010
  };
2924
3011
  };
2925
3012
  };
2926
- /** @description Invalid request parameters */
2927
- 400: {
2928
- headers: {
2929
- [name: string]: unknown;
2930
- };
2931
- content?: never;
2932
- };
3013
+ 400: components["responses"]["BadRequest"];
2933
3014
  /** @description Upstream verification service error */
2934
3015
  502: {
2935
3016
  headers: {
@@ -3335,13 +3416,7 @@ export interface operations {
3335
3416
  };
3336
3417
  };
3337
3418
  };
3338
- /** @description Invalid token */
3339
- 400: {
3340
- headers: {
3341
- [name: string]: unknown;
3342
- };
3343
- content?: never;
3344
- };
3419
+ 400: components["responses"]["BadRequest"];
3345
3420
  /** @description Internal server error */
3346
3421
  500: {
3347
3422
  headers: {
@@ -3398,7 +3473,12 @@ export interface operations {
3398
3473
  headers: {
3399
3474
  [name: string]: unknown;
3400
3475
  };
3401
- content?: never;
3476
+ content: {
3477
+ "application/json": {
3478
+ /** @enum {string} */
3479
+ message: "search error";
3480
+ };
3481
+ };
3402
3482
  };
3403
3483
  };
3404
3484
  };
@@ -3493,7 +3573,12 @@ export interface operations {
3493
3573
  headers: {
3494
3574
  [name: string]: unknown;
3495
3575
  };
3496
- content?: never;
3576
+ content: {
3577
+ "application/json": {
3578
+ /** @enum {string} */
3579
+ message: "search error";
3580
+ };
3581
+ };
3497
3582
  };
3498
3583
  };
3499
3584
  };
@@ -3547,7 +3632,12 @@ export interface operations {
3547
3632
  headers: {
3548
3633
  [name: string]: unknown;
3549
3634
  };
3550
- content?: never;
3635
+ content: {
3636
+ "application/json": {
3637
+ /** @enum {string} */
3638
+ message: "search error";
3639
+ };
3640
+ };
3551
3641
  };
3552
3642
  };
3553
3643
  };
@@ -3671,11 +3761,29 @@ export interface operations {
3671
3761
  };
3672
3762
  };
3673
3763
  responses: {
3764
+ /** @description Report ready */
3674
3765
  200: {
3675
3766
  headers: {
3676
3767
  [name: string]: unknown;
3677
3768
  };
3678
- content?: never;
3769
+ content: {
3770
+ "application/json": {
3771
+ message?: string;
3772
+ /** @description Presigned URL to download the report */
3773
+ data?: string;
3774
+ };
3775
+ };
3776
+ };
3777
+ /** @description Report is pending */
3778
+ 202: {
3779
+ headers: {
3780
+ [name: string]: unknown;
3781
+ };
3782
+ content: {
3783
+ "application/json": {
3784
+ message?: string;
3785
+ };
3786
+ };
3679
3787
  };
3680
3788
  };
3681
3789
  };
@@ -3701,11 +3809,25 @@ export interface operations {
3701
3809
  };
3702
3810
  };
3703
3811
  responses: {
3812
+ /** @description Search results */
3704
3813
  200: {
3705
3814
  headers: {
3706
3815
  [name: string]: unknown;
3707
3816
  };
3708
- content?: never;
3817
+ content: {
3818
+ "application/json": {
3819
+ /**
3820
+ * @description Property Reference Number
3821
+ * @example HK1234567
3822
+ */
3823
+ prn: string;
3824
+ /**
3825
+ * @description Free format address in English
3826
+ * @example FLAT A, 8/F, BLOCK B, KAI TAK COMMERCIAL BUILDING, 86 DES VOEUX ROAD
3827
+ */
3828
+ free_format_addr_eng: string;
3829
+ }[];
3830
+ };
3709
3831
  };
3710
3832
  };
3711
3833
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fill-easy/api",
3
- "version": "1.0.35",
3
+ "version": "1.0.37",
4
4
  "type": "module",
5
5
  "description": "Type-safe SDK for Fill Easy API",
6
6
  "main": "dist/index.js",