@fill-easy/api 1.0.14 → 1.0.15

package/dist/openapi.d.ts

@@ -1167,30 +1167,74 @@ export interface components {
             /** @description Request express processing */
             express?: boolean;
         };
+        /** @description Company information returned from the Companies Registry search */
         Company: {
-            /** @description Company ID (use this value in other endpoints) */
+            /**
+             * @description Unique company identifier used in subsequent API calls.
+             *     For Hong Kong: Business Registration Number (BRN) - an 8-digit number.
+             *     For Australia: Australian Company Number (ACN).
+             *     For Singapore: Unique Entity Number (UEN).
+             *
+             * @example 72599839
+             */
             companyId: string;
-            /** @description Type of company identifier (e.g., "BRN" for Hong Kong, "ACN" for Australia) */
+            /**
+             * @description Type of company identifier returned.
+             *     - "BRN" - Business Registration Number (Hong Kong)
+             *     - "ACN" - Australian Company Number (Australia)
+             *     - "UEN" - Unique Entity Number (Singapore)
+             *     - "Unavailable" - When the country does not provide a company ID
+             *
+             * @example BRN
+             */
             idType: string;
-            /** @description Official company name */
+            /**
+             * @description Official registered company name (in English or Chinese depending on the search)
+             * @example FILL EASY LIMITED
+             */
             companyName: string;
-            /** @description Name of the company in local language (if applicable) */
+            /** @description Name of the company in local language (if applicable and different from companyName) */
             localName?: string;
             /**
-             * @description Active status of the company
+             * @description Current active status of the company.
+             *     - "Live" - Company is currently active and in good standing
+             *     - "Dissolved" - Company has been dissolved/deregistered
+             *
+             * @example Live
              * @enum {string}
              */
             status?: "Live" | "Dissolved";
             /**
-             * @description Name status/type
+             * @description Indicates whether the returned name is the current or a previous name.
+             *     - "current" - This is the company's current registered name
+             *     - "old" - This is a previous/historical name of the company
+             *
+             * @example current
              * @enum {string}
              */
             nameType?: "current" | "old";
-            /** @description Type of incorporation */
+            /**
+             * @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
+             */
             incorporationType?: string;
-            /** @description Category of the entity */
+            /**
+             * @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
+             */
             entityCategory?: string;
-            /** @description Registered address of the company */
+            /** @description Registered address of the company (when available) */
             address?: string;
         };
     };

package/package.json

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