@fill-easy/api 1.0.27 → 1.0.29

package/dist/openapi.d.ts

@@ -880,9 +880,11 @@ export interface paths {
          * Request
          * @description This endpoint may retrieve the company JSON and document via two methods:
          *
+         *     For a full list of Country Coverage, please check out /readme .
+         *
          *     #### Automated retrieval using Company ID for supported countries
          *
-         *     If the country supplied in `countryCode` is in the [AutomatedCountry](/models) Model,
+         *     If the country supplied in `countryCode` is automated according to Country Coverage table,
          *     and the supplied `companyId` is valid, the system will automatically fetch the document.
          *
          *     In order to ensure a valid `companyId`, please validate using `/cra/{countryCode}/search/companies`.
@@ -962,11 +964,11 @@ export interface paths {
          *
          *     The type of search is dependent on the country:
          *
-         *     *Substring search*: KY, TH
+         *     *Substring search*: KY, TH, PH
          *
          *     *Tokenized search (e.g. searching "PLE" will not result in "APPLE")*: AU, SG
          *
-         *     *Left partial search*: HK
+         *     *Left partial search*: HK, BM
          *
          *     *Partial name search*: US
          */
@@ -1038,6 +1040,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/cra/info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get CRA Country Information
+         * @description Returns metadata and a list of all countries supported by the CRA service,
+         *     including their automation status, available search capabilities, and report contents.
+         */
+        get: operations["craInfo"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/uaepass/request/auth": {
         parameters: {
             query?: never;
@@ -1195,11 +1218,49 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /**
-         * @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code for regions with fully automated support.
-         * @enum {string}
-         */
-        AutomatedCountry: "HK" | "AU" | "CN";
+        Country: {
+            /**
+             * @description Country name
+             * @example Hong Kong
+             */
+            name: string;
+            /**
+             * @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code.
+             * @example HK
+             */
+            code: string;
+            /**
+             * @description Geographic region
+             * @example Asia
+             */
+            region: string;
+            /**
+             * @description ISO 639-1 language code for the source language of documents
+             * @example en
+             */
+            sourceLanguage: string;
+            /**
+             * @description Whether the country is fully automated or requires manual processing
+             * @enum {string}
+             */
+            status: "automated" | "manual";
+            search: {
+                /** @description Whether document search is available */
+                documents: boolean;
+                /** @description Whether company name search is available */
+                companies: boolean;
+                /** @description Whether company ID lookup is available */
+                company: boolean;
+            };
+            contents: {
+                /** @description Whether registration information is available */
+                registration: boolean;
+                /** @description Whether shareholder information is available */
+                sharedholder: boolean;
+                /** @description Whether financial information is available */
+                financial: boolean;
+            };
+        };
         Error: {
             /**
              * @description Error message
@@ -3179,7 +3240,7 @@ export interface operations {
                     /** @description Company ID (e.g., BRN for Hong Kong, ACN for Australia) */
                     companyId?: string;
                     /** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code (case insensitive) */
-                    countryCode: components["schemas"]["AutomatedCountry"] | string;
+                    countryCode: string;
                     /**
                      * @description Type of document
                      * @default companySearch
@@ -3469,7 +3530,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" | "bm" | "kh";
+                countryCode: string;
             };
             cookie?: never;
         };
@@ -3518,7 +3579,7 @@ export interface operations {
             header?: never;
             path: {
                 /** @description [ISO 3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2) country code. */
-                countryCode: "hk";
+                countryCode: string;
             };
             cookie?: never;
         };
@@ -3528,12 +3589,14 @@ export interface operations {
                     /** @description Company ID (e.g., BRN for Hong Kong, ACN for Australia) */
                     companyId: string;
                     /**
-                     * @description Optional filter by document type
+                     * @description Optional filter by document type. (Country Specific)
+                     *     - HK: financialStatement, annualReturn
+                     *     - PH: GIS, AFS
                      * @enum {string}
                      */
-                    documentType?: "financialStatement" | "annualReturn";
+                    documentType?: "financialStatement" | "annualReturn" | "GIS" | "AFS";
                     /** @description Optional filter by year */
-                    documentYear?: number;
+                    documentYear?: string;
                 };
             };
         };
@@ -3569,7 +3632,7 @@ export interface operations {
                              */
                             filingDate?: string;
                             /** @description Unique document identifier */
-                            documentId: string;
+                            documentId?: string;
                             /** @description Company ID */
                             companyId: string;
                             /** @description Whether the document has linked files */
@@ -3600,7 +3663,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" | "kh";
+                countryCode: string;
             };
             cookie?: never;
         };
@@ -3646,6 +3709,52 @@ export interface operations {
             };
         };
     };
+    craInfo: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successfully retrieved CRA country information */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        meta: {
+                            /** @description Total number of countries */
+                            totalCountries: number;
+                            /** @description Number of automated countries */
+                            automated: number;
+                            /** @description Number of manual countries */
+                            manual: number;
+                            /** @description Number of countries with at least one search capability */
+                            searchable: number;
+                        };
+                        countries: components["schemas"]["Country"][];
+                    };
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     uaepassAuth: {
         parameters: {
             query?: never;

package/package.json

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