@chadwin/sdk 0.14.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.cts +38 -38
  2. package/dist/index.d.ts +38 -38
  3. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -26,35 +26,11 @@ interface components {
26
26
  periods: components["schemas"]["CompanyFinancialStatementPeriod"][];
27
27
  };
28
28
  CompanyKpi: {
29
- /** @description Stable issuer-specific ID: stored owner’s ten-digit CIK, dot, lowercase underscore slug. Approved CIK history lookup retains predecessor IDs while issuer metadata identifies the latest successor. Scope or measurement-basis changes create new IDs; a renamed display label alone does not. */
30
29
  kpi_id: string;
31
- /** @description Display label for grouping related series. Not a fixed taxonomy or a promise of comparability across issuers. */
32
30
  group: string;
33
31
  name: string;
34
- /** @description Issuer-specific scope, measurement basis and qualifications, including rolling windows where applicable. */
35
32
  definition: string;
36
33
  unit: string;
37
- values: components["schemas"]["CompanyKpiValue"][];
38
- };
39
- CompanyKpiSource: {
40
- /** @enum {string} */
41
- type: "sec_filing";
42
- /** @enum {string} */
43
- form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A" | "8-K" | "8-K/A" | "6-K" | "6-K/A";
44
- accession_number: string;
45
- /** @description Exact filename in the original SEC filing package, including substantive exhibits. Independent of Chadwin report rendering. */
46
- document: string;
47
- /** @description Human-readable section, table or passage in the original SEC document. */
48
- location: string;
49
- xbrl_concept: string | null;
50
- };
51
- CompanyKpiValue: {
52
- fiscal_year: number;
53
- /**
54
- * @description Reported fiscal coordinate. FY, H1/H2 and Q1–Q4 are distinct. H2 and Q4 must be directly reported, not calculated by subtraction. A fiscal coordinate does not change the measurement basis in the KPI definition.
55
- * @enum {string}
56
- */
57
- fiscal_period: "FY" | "H1" | "H2" | "Q1" | "Q2" | "Q3" | "Q4";
58
34
  /**
59
35
  * Format: date
60
36
  * @description Reported fiscal-period end date, or null if unavailable. Independent of source filing dates.
@@ -69,6 +45,24 @@ interface components {
69
45
  value_operator: "eq" | "gt" | "gte" | "lt" | "lte" | "approx";
70
46
  source: components["schemas"]["CompanyKpiSource"];
71
47
  };
48
+ CompanyKpiPeriod: {
49
+ fiscal_year: number;
50
+ /** @enum {string} */
51
+ fiscal_period: "FY" | "H1" | "H2" | "Q1" | "Q2" | "Q3" | "Q4";
52
+ kpis: components["schemas"]["CompanyKpi"][];
53
+ };
54
+ CompanyKpiSource: {
55
+ /** @enum {string} */
56
+ type: "sec_filing";
57
+ /** @enum {string} */
58
+ form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A" | "8-K" | "8-K/A" | "6-K" | "6-K/A";
59
+ accession_number: string;
60
+ /** @description Exact filename in the original SEC filing package, including substantive exhibits. Independent of Chadwin report rendering. */
61
+ document: string;
62
+ /** @description Human-readable section, table or passage in the original SEC document. */
63
+ location: string;
64
+ xbrl_concept: string | null;
65
+ };
72
66
  CompanyKpisBadRequest: {
73
67
  /** @enum {string} */
74
68
  error: "invalid_query_parameters";
@@ -91,7 +85,8 @@ interface components {
91
85
  name: string | null;
92
86
  ticker: string | null;
93
87
  };
94
- kpis: components["schemas"]["CompanyKpi"][];
88
+ /** @description Completed reviews only. An empty kpis array means the period was reviewed and no eligible values were found. An omitted period has not completed review. */
89
+ periods: components["schemas"]["CompanyKpiPeriod"][];
95
90
  };
96
91
  CompanyKpisTickerAmbiguous: {
97
92
  /** @enum {string} */
@@ -1962,7 +1957,7 @@ interface operations {
1962
1957
  fiscal_year?: number;
1963
1958
  /** @description Reporting period type. Defaults to annual. */
1964
1959
  period?: "annual" | "half_year" | "quarterly";
1965
- /** @description Consecutive reporting periods to return, ending at the latest stored period of the selected type. Missing periods remain missing. Defaults to 1. */
1960
+ /** @description Consecutive reporting periods to return, ending at the latest reported period of the selected type. Unreviewed periods are omitted without extending the window. Defaults to 1. */
1966
1961
  limit?: number;
1967
1962
  };
1968
1963
  header?: never;
@@ -1988,24 +1983,29 @@ interface operations {
1988
1983
  * "name": "Synthetic KPI Test Company",
1989
1984
  * "ticker": null
1990
1985
  * },
1991
- * "kpis": [
1986
+ * "periods": [
1992
1987
  * {
1993
- * "kpi_id": "0009999996.customers",
1994
- * "group": "Customer Scale",
1995
- * "name": "Customers",
1996
- * "definition": "Synthetic fixture: distinct customers served during the stated six-month fiscal half.",
1997
- * "unit": "customers",
1998
- * "values": [
1988
+ * "fiscal_year": 2025,
1989
+ * "fiscal_period": "H2",
1990
+ * "kpis": []
1991
+ * },
1992
+ * {
1993
+ * "fiscal_year": 2025,
1994
+ * "fiscal_period": "H1",
1995
+ * "kpis": [
1999
1996
  * {
2000
- * "fiscal_year": 2025,
2001
- * "fiscal_period": "H2",
2002
- * "period_end_date": "2025-12-31",
1997
+ * "kpi_id": "0009999996.customers",
1998
+ * "group": "Customer Scale",
1999
+ * "name": "Customers",
2000
+ * "definition": "Distinct customers served during the stated six-month fiscal half.",
2001
+ * "unit": "customers",
2002
+ * "period_end_date": "2025-06-30",
2003
2003
  * "value": "1200",
2004
2004
  * "value_operator": "eq",
2005
2005
  * "source": {
2006
2006
  * "type": "sec_filing",
2007
2007
  * "form": "6-K",
2008
- * "accession_number": "0009999996-26-000001",
2008
+ * "accession_number": "0009999996-25-000001",
2009
2009
  * "document": "ex99-1.htm",
2010
2010
  * "location": "Operating review — Customers",
2011
2011
  * "xbrl_concept": null
@@ -5149,7 +5149,7 @@ type FinancialStatementsGetParams = CompanySelector & ({
5149
5149
  period?: "annual";
5150
5150
  };
5151
5151
  type CompanyKpisResponse = components["schemas"]["CompanyKpisResponse"];
5152
- type CompanyKpiFiscalPeriod = components["schemas"]["CompanyKpiValue"]["fiscal_period"];
5152
+ type CompanyKpiFiscalPeriod = components["schemas"]["CompanyKpiPeriod"]["fiscal_period"];
5153
5153
  type CompanyKpisGetParams = CompanySelector & ({
5154
5154
  fiscalYear: number;
5155
5155
  limit?: never;
package/dist/index.d.ts CHANGED
@@ -26,35 +26,11 @@ interface components {
26
26
  periods: components["schemas"]["CompanyFinancialStatementPeriod"][];
27
27
  };
28
28
  CompanyKpi: {
29
- /** @description Stable issuer-specific ID: stored owner’s ten-digit CIK, dot, lowercase underscore slug. Approved CIK history lookup retains predecessor IDs while issuer metadata identifies the latest successor. Scope or measurement-basis changes create new IDs; a renamed display label alone does not. */
30
29
  kpi_id: string;
31
- /** @description Display label for grouping related series. Not a fixed taxonomy or a promise of comparability across issuers. */
32
30
  group: string;
33
31
  name: string;
34
- /** @description Issuer-specific scope, measurement basis and qualifications, including rolling windows where applicable. */
35
32
  definition: string;
36
33
  unit: string;
37
- values: components["schemas"]["CompanyKpiValue"][];
38
- };
39
- CompanyKpiSource: {
40
- /** @enum {string} */
41
- type: "sec_filing";
42
- /** @enum {string} */
43
- form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A" | "8-K" | "8-K/A" | "6-K" | "6-K/A";
44
- accession_number: string;
45
- /** @description Exact filename in the original SEC filing package, including substantive exhibits. Independent of Chadwin report rendering. */
46
- document: string;
47
- /** @description Human-readable section, table or passage in the original SEC document. */
48
- location: string;
49
- xbrl_concept: string | null;
50
- };
51
- CompanyKpiValue: {
52
- fiscal_year: number;
53
- /**
54
- * @description Reported fiscal coordinate. FY, H1/H2 and Q1–Q4 are distinct. H2 and Q4 must be directly reported, not calculated by subtraction. A fiscal coordinate does not change the measurement basis in the KPI definition.
55
- * @enum {string}
56
- */
57
- fiscal_period: "FY" | "H1" | "H2" | "Q1" | "Q2" | "Q3" | "Q4";
58
34
  /**
59
35
  * Format: date
60
36
  * @description Reported fiscal-period end date, or null if unavailable. Independent of source filing dates.
@@ -69,6 +45,24 @@ interface components {
69
45
  value_operator: "eq" | "gt" | "gte" | "lt" | "lte" | "approx";
70
46
  source: components["schemas"]["CompanyKpiSource"];
71
47
  };
48
+ CompanyKpiPeriod: {
49
+ fiscal_year: number;
50
+ /** @enum {string} */
51
+ fiscal_period: "FY" | "H1" | "H2" | "Q1" | "Q2" | "Q3" | "Q4";
52
+ kpis: components["schemas"]["CompanyKpi"][];
53
+ };
54
+ CompanyKpiSource: {
55
+ /** @enum {string} */
56
+ type: "sec_filing";
57
+ /** @enum {string} */
58
+ form: "10-K" | "10-K/A" | "10-Q" | "10-Q/A" | "20-F" | "20-F/A" | "40-F" | "40-F/A" | "8-K" | "8-K/A" | "6-K" | "6-K/A";
59
+ accession_number: string;
60
+ /** @description Exact filename in the original SEC filing package, including substantive exhibits. Independent of Chadwin report rendering. */
61
+ document: string;
62
+ /** @description Human-readable section, table or passage in the original SEC document. */
63
+ location: string;
64
+ xbrl_concept: string | null;
65
+ };
72
66
  CompanyKpisBadRequest: {
73
67
  /** @enum {string} */
74
68
  error: "invalid_query_parameters";
@@ -91,7 +85,8 @@ interface components {
91
85
  name: string | null;
92
86
  ticker: string | null;
93
87
  };
94
- kpis: components["schemas"]["CompanyKpi"][];
88
+ /** @description Completed reviews only. An empty kpis array means the period was reviewed and no eligible values were found. An omitted period has not completed review. */
89
+ periods: components["schemas"]["CompanyKpiPeriod"][];
95
90
  };
96
91
  CompanyKpisTickerAmbiguous: {
97
92
  /** @enum {string} */
@@ -1962,7 +1957,7 @@ interface operations {
1962
1957
  fiscal_year?: number;
1963
1958
  /** @description Reporting period type. Defaults to annual. */
1964
1959
  period?: "annual" | "half_year" | "quarterly";
1965
- /** @description Consecutive reporting periods to return, ending at the latest stored period of the selected type. Missing periods remain missing. Defaults to 1. */
1960
+ /** @description Consecutive reporting periods to return, ending at the latest reported period of the selected type. Unreviewed periods are omitted without extending the window. Defaults to 1. */
1966
1961
  limit?: number;
1967
1962
  };
1968
1963
  header?: never;
@@ -1988,24 +1983,29 @@ interface operations {
1988
1983
  * "name": "Synthetic KPI Test Company",
1989
1984
  * "ticker": null
1990
1985
  * },
1991
- * "kpis": [
1986
+ * "periods": [
1992
1987
  * {
1993
- * "kpi_id": "0009999996.customers",
1994
- * "group": "Customer Scale",
1995
- * "name": "Customers",
1996
- * "definition": "Synthetic fixture: distinct customers served during the stated six-month fiscal half.",
1997
- * "unit": "customers",
1998
- * "values": [
1988
+ * "fiscal_year": 2025,
1989
+ * "fiscal_period": "H2",
1990
+ * "kpis": []
1991
+ * },
1992
+ * {
1993
+ * "fiscal_year": 2025,
1994
+ * "fiscal_period": "H1",
1995
+ * "kpis": [
1999
1996
  * {
2000
- * "fiscal_year": 2025,
2001
- * "fiscal_period": "H2",
2002
- * "period_end_date": "2025-12-31",
1997
+ * "kpi_id": "0009999996.customers",
1998
+ * "group": "Customer Scale",
1999
+ * "name": "Customers",
2000
+ * "definition": "Distinct customers served during the stated six-month fiscal half.",
2001
+ * "unit": "customers",
2002
+ * "period_end_date": "2025-06-30",
2003
2003
  * "value": "1200",
2004
2004
  * "value_operator": "eq",
2005
2005
  * "source": {
2006
2006
  * "type": "sec_filing",
2007
2007
  * "form": "6-K",
2008
- * "accession_number": "0009999996-26-000001",
2008
+ * "accession_number": "0009999996-25-000001",
2009
2009
  * "document": "ex99-1.htm",
2010
2010
  * "location": "Operating review — Customers",
2011
2011
  * "xbrl_concept": null
@@ -5149,7 +5149,7 @@ type FinancialStatementsGetParams = CompanySelector & ({
5149
5149
  period?: "annual";
5150
5150
  };
5151
5151
  type CompanyKpisResponse = components["schemas"]["CompanyKpisResponse"];
5152
- type CompanyKpiFiscalPeriod = components["schemas"]["CompanyKpiValue"]["fiscal_period"];
5152
+ type CompanyKpiFiscalPeriod = components["schemas"]["CompanyKpiPeriod"]["fiscal_period"];
5153
5153
  type CompanyKpisGetParams = CompanySelector & ({
5154
5154
  fiscalYear: number;
5155
5155
  limit?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chadwin/sdk",
3
- "version": "0.14.0",
3
+ "version": "0.15.0",
4
4
  "description": "Official Node.js SDK for the Chadwin API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://www.chadwin.co/docs/nodejs-sdk",