@chadwin/sdk 0.8.0 → 0.9.0

package/dist/index.d.cts

@@ -1872,482 +1872,6 @@ interface operations {
             };
         };
     };
-    getCompanyReport: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                ticker: string;
-                fiscal_year: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Annual report filing family */
-            200: {
-                headers: {
-                    "Cache-Control"?: string;
-                    ETag?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    /**
-                     * @example {
-                     *       "filings": [
-                     *         {
-                     *           "accepted_at": "2024-11-01T10:00:00.000Z",
-                     *           "accession_number": "0000320193-24-000123",
-                     *           "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
-                     *           "form": "10-K",
-                     *           "period_end_date": "2024-09-28",
-                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
-                     *         }
-                     *       ],
-                     *       "fiscal_period": "FY",
-                     *       "fiscal_year": 2024,
-                     *       "issuer": {
-                     *         "cik": "0000320193",
-                     *         "name": "Apple Inc.",
-                     *         "ticker": "AAPL"
-                     *       }
-                     *     }
-                     */
-                    "application/json": components["schemas"]["CompanyReportFamilyResponse"];
-                };
-            };
-            /** @description The ticker or fiscal year is invalid */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request is missing a valid Chadwin API key. */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The subscription does not include this dataset. */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
-                };
-            };
-            /** @description The company or eligible annual report was not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description More than one original annual report matches the fiscal year */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request exceeded a rate limit. */
-            429: {
-                headers: {
-                    "RateLimit-Limit"?: string;
-                    "RateLimit-Reset"?: string;
-                    "Retry-After"?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The filing catalog is unavailable */
-            503: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
-    getCompanyReportForFiscalPeriod: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                ticker: string;
-                fiscal_year: string;
-                fiscal_period: "Q1" | "Q2" | "Q3";
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Quarterly report filing family */
-            200: {
-                headers: {
-                    "Cache-Control"?: string;
-                    ETag?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    /**
-                     * @example {
-                     *       "filings": [
-                     *         {
-                     *           "accepted_at": "2025-08-01T10:00:42.000Z",
-                     *           "accession_number": "0000320193-25-000073",
-                     *           "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
-                     *           "form": "10-Q",
-                     *           "period_end_date": "2025-06-28",
-                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
-                     *         }
-                     *       ],
-                     *       "fiscal_period": "Q3",
-                     *       "fiscal_year": 2025,
-                     *       "issuer": {
-                     *         "cik": "0000320193",
-                     *         "name": "Apple Inc.",
-                     *         "ticker": "AAPL"
-                     *       }
-                     *     }
-                     */
-                    "application/json": components["schemas"]["CompanyReportFamilyResponse"];
-                };
-            };
-            /** @description The ticker, fiscal year, or fiscal period is invalid */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request is missing a valid Chadwin API key. */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The subscription does not include this dataset. */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
-                };
-            };
-            /** @description The company or eligible quarterly report was not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description More than one original quarterly report matches the fiscal period */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request exceeded a rate limit. */
-            429: {
-                headers: {
-                    "RateLimit-Limit"?: string;
-                    "RateLimit-Reset"?: string;
-                    "Retry-After"?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The filing catalog is unavailable */
-            503: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
-    getCompanyReportByCik: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                fiscal_year: string;
-                /** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
-                cik: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Annual report filing family */
-            200: {
-                headers: {
-                    "Cache-Control"?: string;
-                    ETag?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    /**
-                     * @example {
-                     *       "filings": [
-                     *         {
-                     *           "accepted_at": "2024-11-01T10:00:00.000Z",
-                     *           "accession_number": "0000320193-24-000123",
-                     *           "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
-                     *           "form": "10-K",
-                     *           "period_end_date": "2024-09-28",
-                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
-                     *         }
-                     *       ],
-                     *       "fiscal_period": "FY",
-                     *       "fiscal_year": 2024,
-                     *       "issuer": {
-                     *         "cik": "0000320193",
-                     *         "name": "Apple Inc.",
-                     *         "ticker": "AAPL"
-                     *       }
-                     *     }
-                     */
-                    "application/json": components["schemas"]["CompanyReportFamilyResponse"];
-                };
-            };
-            /** @description The cik or fiscal year is invalid */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request is missing a valid Chadwin API key. */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The subscription does not include this dataset. */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
-                };
-            };
-            /** @description The company or eligible annual report was not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description More than one original annual report matches the fiscal year */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request exceeded a rate limit. */
-            429: {
-                headers: {
-                    "RateLimit-Limit"?: string;
-                    "RateLimit-Reset"?: string;
-                    "Retry-After"?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The filing catalog is unavailable */
-            503: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
-    getCompanyReportByCikForFiscalPeriod: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                fiscal_year: string;
-                /** @description Positive SEC CIK as one to ten decimal digits; leading zeros are optional. */
-                cik: string;
-                fiscal_period: "Q1" | "Q2" | "Q3";
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Quarterly report filing family */
-            200: {
-                headers: {
-                    "Cache-Control"?: string;
-                    ETag?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    /**
-                     * @example {
-                     *       "filings": [
-                     *         {
-                     *           "accepted_at": "2025-08-01T10:00:42.000Z",
-                     *           "accession_number": "0000320193-25-000073",
-                     *           "content_url": "/v1/sec/company-reports/0000320193-25-000073/content.html",
-                     *           "form": "10-Q",
-                     *           "period_end_date": "2025-06-28",
-                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000073/0000320193-25-000073-index.htm"
-                     *         }
-                     *       ],
-                     *       "fiscal_period": "Q3",
-                     *       "fiscal_year": 2025,
-                     *       "issuer": {
-                     *         "cik": "0000320193",
-                     *         "name": "Apple Inc.",
-                     *         "ticker": "AAPL"
-                     *       }
-                     *     }
-                     */
-                    "application/json": components["schemas"]["CompanyReportFamilyResponse"];
-                };
-            };
-            /** @description The cik, fiscal year, or fiscal period is invalid */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request is missing a valid Chadwin API key. */
-            401: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The subscription does not include this dataset. */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
-                };
-            };
-            /** @description The company or eligible quarterly report was not found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description More than one original quarterly report matches the fiscal period */
-            409: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The request exceeded a rate limit. */
-            429: {
-                headers: {
-                    "RateLimit-Limit"?: string;
-                    "RateLimit-Reset"?: string;
-                    "Retry-After"?: string;
-                    "X-Billing-Period-Quota-Limit"?: string;
-                    "X-Billing-Period-Quota-Remaining"?: string;
-                    "X-Billing-Period-Quota-Reset"?: string;
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-            /** @description The filing catalog is unavailable */
-            503: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["ErrorResponse"];
-                };
-            };
-        };
-    };
     getCompanyFinancialStatements: {
         parameters: {
             query?: {
@@ -2541,6 +2065,139 @@ interface operations {
             };
         };
     };
+    getCompanyReportsForPeriod: {
+        parameters: {
+            query: {
+                /** @description Ticker from the accepted SEC snapshot. Supply exactly one ticker or CIK; letters normalize to uppercase. */
+                ticker?: string;
+                /** @description Positive SEC CIK, one to ten decimal digits. Supply exactly one ticker or CIK; CIKs normalize to ten digits. */
+                cik?: string;
+                /** @description Required four-digit fiscal year, from 1900 through 9999. */
+                fiscal_year: string;
+                /** @description Required FY for annual reports, or Q1, Q2 or Q3 for quarterly reports. FY is not Q4. */
+                fiscal_period: "FY" | "Q1" | "Q2" | "Q3";
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Original report and subsequent amendments */
+            200: {
+                headers: {
+                    "Cache-Control"?: string;
+                    ETag?: string;
+                    "X-Billing-Period-Quota-Limit"?: string;
+                    "X-Billing-Period-Quota-Remaining"?: string;
+                    "X-Billing-Period-Quota-Reset"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "filings": [
+                     *         {
+                     *           "accepted_at": "2024-11-01T10:00:00.000Z",
+                     *           "accession_number": "0000320193-24-000123",
+                     *           "content_url": "/v1/sec/company-reports/0000320193-24-000123/content.html",
+                     *           "form": "10-K",
+                     *           "period_end_date": "2024-09-28",
+                     *           "sec_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/0000320193-24-000123-index.htm"
+                     *         }
+                     *       ],
+                     *       "fiscal_period": "FY",
+                     *       "fiscal_year": 2024,
+                     *       "issuer": {
+                     *         "cik": "0000320193",
+                     *         "name": "Apple Inc.",
+                     *         "ticker": "AAPL"
+                     *       }
+                     *     }
+                     */
+                    "application/json": components["schemas"]["CompanyReportFamilyResponse"];
+                };
+            };
+            /** @description Supply one identifier, a valid fiscal year and FY, Q1, Q2 or Q3; no extra or repeated keys. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        error: "invalid_query_parameters";
+                    };
+                };
+            };
+            /** @description The request is missing a valid Chadwin API key. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The subscription does not include this dataset. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DatasetNotEntitledErrorResponse"];
+                };
+            };
+            /** @description The ticker is unresolved or no eligible report family exists. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        error: "company_not_found" | "company_report_not_found";
+                    };
+                };
+            };
+            /** @description The ticker matches multiple CIKs or multiple original reports match the selected period. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        error: "company_ambiguous" | "company_report_ambiguous";
+                    };
+                };
+            };
+            /** @description The request exceeded a rate limit. */
+            429: {
+                headers: {
+                    "RateLimit-Limit"?: string;
+                    "RateLimit-Reset"?: string;
+                    "Retry-After"?: string;
+                    "X-Billing-Period-Quota-Limit"?: string;
+                    "X-Billing-Period-Quota-Remaining"?: string;
+                    "X-Billing-Period-Quota-Reset"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description The filing catalog is unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     searchCompanies: {
         parameters: {
             query: {
@@ -4900,7 +4557,7 @@ interface operations {
 }
 
 type CompanyReportForm = "10-K" | "10-Q" | "20-F" | "40-F";
-type CompanyReportFiscalPeriod = "Q1" | "Q2" | "Q3";
+type CompanyReportFiscalPeriod = "FY" | "Q1" | "Q2" | "Q3";
 type CompanySelector = {
     ticker: string;
     cik?: never;
@@ -5043,15 +4700,10 @@ declare class CompanyReports {
     get({ accessionNumber, }: {
         accessionNumber: string;
     }): PromiseWithResponse<JsonResponse<"getSecCompanyReport">>;
-    getByFiscalYear({ ticker, fiscalYear, }: {
-        ticker: string;
-        fiscalYear: number;
-    }): PromiseWithResponse<JsonResponse<"getCompanyReport">>;
-    getByFiscalPeriod({ ticker, fiscalYear, fiscalPeriod, }: {
-        ticker: string;
+    getForPeriod({ ticker, cik, fiscalYear, fiscalPeriod }: CompanySelector & {
         fiscalYear: number;
         fiscalPeriod: CompanyReportFiscalPeriod;
-    }): PromiseWithResponse<JsonResponse<"getCompanyReportForFiscalPeriod">>;
+    }): PromiseWithResponse<JsonResponse<"getCompanyReportsForPeriod">>;
     getHtml({ accessionNumber, }: {
         accessionNumber: string;
     }): PromiseWithResponse<TextResponse<"getSecCompanyReportContent">>;