@fill-easy/api 1.0.14 → 1.0.16

package/README.md

@@ -1,4 +1,5 @@
 # Fill Easy API SDK
+
 Fill Easy Services API using https://openapi-ts.dev/
 
 Read full docs here: https://docs.fill-easy.com

package/dist/openapi.d.ts

@@ -834,9 +834,10 @@ export interface paths {
          *     characters and adjust the search parameters accordingly.
          *
          *     The type of search is dependent on the country:
-         *     Substring search: KY
+         *     Substring search: KY, TH
          *     Tokenized search (e.g. searching "PLE" will not result in "APPLE"): AU, SG
-         *     Left partial search: HK,
+         *     Left partial search: HK
+         *     Partial name search: US
          *
          */
         post: operations["searchCompanies"];
@@ -1167,30 +1168,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;
         };
     };
@@ -2772,7 +2817,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";
+                countryCode: "hk" | "cn" | "au" | "sg" | "ky" | "th" | "us";
             };
             cookie?: never;
         };
@@ -2917,7 +2962,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";
+                countryCode: "hk" | "au" | "sg" | "th" | "us";
             };
             cookie?: never;
         };

package/package.json

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