@fill-easy/api 1.0.16 → 1.0.18

package/dist/openapi.d.ts

@@ -1215,29 +1215,51 @@ export interface components {
              */
             nameType?: "current" | "old";
             /**
-             * @description Type of incorporation/registration. Values vary by jurisdiction.
-             *     Hong Kong examples:
-             *     - "I" - Private company limited by shares incorporated in Hong Kong
-             *     - "O" - Overseas company registered in Hong Kong
-             *     - "G" - Company limited by guarantee
-             *     - "U" - Unlimited company
-             *
-             * @example I
+             * @description Type of incorporation/registration based on Companies Ordinance (Cap. 622)
+             * @example Company Limited by Shares
+             * @enum {string}
              */
-            incorporationType?: string;
+            incorporationType?: "Company Limited by Shares" | "Registered Non-Hong Kong Company" | "Company Limited by Guarantee" | "Unlimited Company" | "Registered Society/Organization" | "Open-ended Fund Company" | "Limited Partnership Fund" | "N/A";
             /**
-             * @description Category classification of the entity. Values vary by jurisdiction.
-             *     Hong Kong examples:
-             *     - "B" - Local private company
-             *     - "P" - Public company
-             *     - "N" - Non-Hong Kong company
-             *
-             * @example B
+             * @description Private vs Public company classification based on Companies Ordinance (Cap. 622)
+             * @example Private Company
+             * @enum {string}
              */
-            entityCategory?: string;
+            entityCategory?: "Public Company" | "Private Company" | "N/A";
             /** @description Registered address of the company (when available) */
             address?: string;
         };
+        CompanyBaseData: components["schemas"]["Company"] & {
+            /**
+             * Format: date
+             * @description Date of dissolution (YYYY-MM-DD format, empty string if not dissolved)
+             * @example
+             */
+            dissolutionDate?: string;
+            /**
+             * Format: date
+             * @description Date of incorporation/registration (YYYY-MM-DD format)
+             * @example 2021-01-21
+             */
+            incorporationDate?: string;
+            /**
+             * @description Any remarks or notes about the company
+             * @example
+             */
+            remarks?: string;
+            /** @description Historical company names (previous names the company has used) */
+            nameHistory?: {
+                /** @description English company name */
+                companyName?: string;
+                /** @description Chinese company name (if available) */
+                localName?: string;
+                /**
+                 * Format: date
+                 * @description Date when this name became effective (YYYY-MM-DD format)
+                 */
+                effectiveDate?: string;
+            }[];
+        };
     };
     responses: {
         /** @description Unauthorized - Token is missing, invalid, or expired */
@@ -2817,7 +2839,7 @@ export interface operations {
             header?: never;
             path: {
                 /** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code in lowercase. */
-                countryCode: "hk" | "cn" | "au" | "sg" | "ky" | "th" | "us";
+                countryCode: "hk" | "cn" | "au" | "sg" | "ky" | "th" | "us" | "bm" | "kh";
             };
             cookie?: never;
         };
@@ -2908,10 +2930,10 @@ export interface operations {
                         /** @description array of documents filed by the company. */
                         result?: {
                             /**
-                             * @description Document category (e.g., Annual Return, Director / Secretary Changes)
+                             * @description Document category (e.g., Annual Return & Accounts, Directors & Company Secretaries)
                              * @enum {string}
                              */
-                            category: "Annual Return" | "Director / Secretary Changes" | "Charges Filed" | "Incorporation & Name Change" | "Liquidation & Deregistration" | "Registered Office / Address" | "Share Capital" | "Other";
+                            category: "Incorporation & Registration" | "Annual Return & Accounts" | "Directors & Company Secretaries" | "Registered Office & Name Changes" | "Share Capital" | "Charges" | "Articles of Association" | "Deregistration & Liquidation" | "Amalgamation" | "Open-Ended Fund Companies" | "Limited Partnership Funds" | "Rectification & Administration" | "Other";
                             /** @description Accounting year (for annual returns) */
                             documentYear?: string;
                             /** @description English name of the document */
@@ -2962,7 +2984,7 @@ export interface operations {
             header?: never;
             path: {
                 /** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code. */
-                countryCode: "hk" | "au" | "sg" | "th" | "us";
+                countryCode: "hk" | "au" | "sg" | "th" | "us" | "kh";
             };
             cookie?: never;
         };
@@ -2987,40 +3009,8 @@ export interface operations {
                          * @enum {string}
                          */
                         message: "success" | "search error";
-                        /** @description Company object (Other Countries) or Company base information object (HK) */
-                        result?: components["schemas"]["Company"][] | {
-                            /** @description Business Registration Number / Company ID */
-                            brn?: string;
-                            /** @description English company name */
-                            enName?: string;
-                            /** @description Chinese company name */
-                            cnName?: string;
-                            /**
-                             * @description Current status of the company
-                             * @enum {string}
-                             */
-                            status?: "Live" | "Dissolved";
-                            /** @description Type of company */
-                            type?: string;
-                            /** @description Category of entity */
-                            category?: string;
-                            /**
-                             * Format: date
-                             * @description Date of dissolution (YYYY-MM-DD format, empty if not dissolved)
-                             */
-                            dissolutionDate?: string;
-                            /**
-                             * Format: date
-                             * @description Date of incorporation/registration (YYYY-MM-DD format)
-                             */
-                            incorporationDate?: string;
-                            /** @description English remarks */
-                            enRemarks?: string;
-                            /** @description Simplified Chinese remarks */
-                            scRemarks?: string;
-                            /** @description Traditional Chinese remarks */
-                            tcRemarks?: string;
-                        };
+                        /** @description Company base information object */
+                        result?: components["schemas"]["CompanyBaseData"];
                     };
                 };
             };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fill-easy/api",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "type": "module",
   "description": "Type-safe SDK for Fill Easy API",
   "main": "dist/index.js",