@fill-easy/api 1.0.30 → 1.0.32

package/dist/openapi.d.ts

@@ -1248,6 +1248,13 @@ export interface components {
                 financial: boolean;
             };
         };
+        CraInvalidCountryError: {
+            /**
+             * @description Error message indicating the country code is invalid or the service is not offered
+             * @example Invalid countryCode / Service not offered for countryCode: XX
+             */
+            message: string;
+        };
         Error: {
             /**
              * @description Error message
@@ -1422,7 +1429,7 @@ export interface components {
          * @example Private Company
          * @enum {string}
          */
-        registrationDetail: "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" | "Public Company" | "Private Company" | "Foreign Company" | "Foreign Company Branch" | "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" | "N/A";
+        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";
     };
     responses: {
         /** @description Unauthorized - Token is missing, invalid, or expired */
@@ -3393,12 +3400,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3681,12 +3690,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3716,9 +3727,8 @@ export interface operations {
                      * @description Optional filter by document type. (Country Specific)
                      *     - HK: financialStatement, annualReturn
                      *     - PH: GIS, AFS
-                     * @enum {string}
                      */
-                    documentType?: "financialStatement" | "annualReturn" | "GIS" | "AFS";
+                    documentType?: string;
                     /** @description Optional filter by year */
                     documentYear?: string;
                 };
@@ -3752,7 +3762,7 @@ export interface operations {
                             pages?: string;
                             /**
                              * Format: date
-                             * @description Filing date (YYYY-MM-DD format)
+                             * @description Filing date (YYYY-MM-DD format), can be date of processing or date filed depending on country
                              */
                             filingDate?: string;
                             /** @description Unique document identifier */
@@ -3761,16 +3771,28 @@ export interface operations {
                             companyId: string;
                             /** @description Whether the document has linked files */
                             hasLinked?: boolean;
+                            /**
+                             * @description Additional useful info regarding the document
+                             * @example {
+                             *       "made_up_date": "2025-08-26",
+                             *       "officer_name": "Bob Chan"
+                             *     }
+                             */
+                            description?: {
+                                [key: string]: string;
+                            };
                         }[];
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {
@@ -3817,12 +3839,14 @@ export interface operations {
                     };
                 };
             };
-            /** @description Bad Request - Invalid input parameters, or service not offered for this country */
+            /** @description Bad Request - Invalid or unsupported country code */
             400: {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CraInvalidCountryError"];
+                };
             };
             /** @description Internal server error */
             500: {

package/package.json

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