roicai 0.0.1 → 0.2.0

package/dist/generated/fundamentals/ratios/profitability/client.d.ts

@@ -0,0 +1,75 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../../../_/index.js";
+import { type V3ProfitabilityFinancialPeriodList } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List profitability ratios
+     *
+     * Returns profitability ratios by financial period.
+     */
+    list(request: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * A ticker ID, an exchange and symbol separated by a colon (e.g.
+     * `NASDAQ:AAPL`), or a FIGI.
+     */
+    identifier: string;
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+    periodType?: "annual" | "quarterly" | "ttm";
+    periodLabel?: "FY" | "Q1" | "Q2" | "Q3" | "Q4";
+    /**
+     * Return statements whose period end date is on or after this date.
+     */
+    dateGte?: string;
+    /**
+     * Return statements whose period end date is strictly after this date.
+     */
+    dateGt?: string;
+    /**
+     * Return statements whose period end date is on or before this date.
+     */
+    dateLte?: string;
+    /**
+     * Return statements whose period end date is strictly before this date.
+     */
+    dateLt?: string;
+    /**
+     * Return statements from this fiscal year onward.
+     */
+    fiscalYearGte?: string | number;
+    /**
+     * Return statements after this fiscal year.
+     */
+    fiscalYearGt?: string | number;
+    /**
+     * Return statements through this fiscal year.
+     */
+    fiscalYearLte?: string | number;
+    /**
+     * Return statements before this fiscal year.
+     */
+    fiscalYearLt?: string | number;
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of resources to return. Defaults to 50.
+     */
+    limit?: string | number;
+    /**
+     * Opaque page token from a previous response. Prefer following the returned
+     * page URLs directly.
+     */
+    page?: string;
+}
+export type ListResponse = V3ProfitabilityFinancialPeriodList;

package/dist/generated/fundamentals/ratios/profitability/client.js

@@ -0,0 +1,21 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, } from "../../../_/index.js";
+import { V3ErrorCodec } from "../../../models.js";
+import { V3ProfitabilityFinancialPeriodListCodec, } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v3.0.0/fundamental/ratios/profitability/{identifier}",
+    query: { apikey: "apikey", periodType: "period_type", periodLabel: "period_label", dateGte: "date.gte", dateGt: "date.gt", dateLte: "date.lte", dateLt: "date.lt", fiscalYearGte: "fiscal_year.gte", fiscalYearGt: "fiscal_year.gt", fiscalYearLte: "fiscal_year.lte", fiscalYearLt: "fiscal_year.lt", order: "order", limit: "limit", page: "page" },
+    response: V3ProfitabilityFinancialPeriodListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "402": V3ErrorCodec, "404": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+//# sourceMappingURL=client.js.map

package/dist/generated/fundamentals/ratios/profitability/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/profitability/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,uCAAuC,GACxC,MAAM,aAAa,CAAC;AAkBrB,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,SAAoB;IACvC,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;KAC5E,CAAC;AACJ,CAAC;AA6DD,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,uDAAuD;IAC9D,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACrV,QAAQ,EAAE,uCAAuC;IACjD,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}

package/dist/generated/fundamentals/ratios/profitability/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiError } from "../../../_/index.js";
+export type { RequestOptions } from "../../../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, ListRequest, ListResponse, } from "./client.js";
+export type { V3ProfitabilityFinancialPeriodList } from "./models.js";

package/dist/generated/fundamentals/ratios/profitability/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../../../_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/fundamentals/ratios/profitability/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/profitability/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/fundamentals/ratios/profitability/models.d.ts

@@ -0,0 +1,31 @@
+export interface V3ProfitabilityFinancialPeriodList {
+    data: {
+        currency: string;
+        dvdPayoutRatio: number | null;
+        ebitdaMargin: number | null;
+        effTaxRate: number | null;
+        fiscalYear: string | number | null;
+        fxApplied: boolean;
+        grossMargin: number | null;
+        id: string;
+        incrementalOperatingMargin: number | null;
+        netIncomeToCommonMargin: number | null;
+        object: "v3.fundamentals.profitability_ratio";
+        operMargin: number | null;
+        periodEndDate: string;
+        periodLabel: string | null;
+        periodType: "annual" | "quarterly" | "ttm";
+        pretaxIncToNetSales: number | null;
+        priceCurrency: string | null;
+        profitMargin: number | null;
+        returnComEqy: number | null;
+        returnOnAsset: number | null;
+        returnOnCap: number | null;
+        returnOnInvCapital: number | null;
+        sustainGrowthRt: number | null;
+        symbol: string;
+    }[];
+    nextPageUrl: string | null;
+    previousPageUrl: string | null;
+}
+export declare const V3ProfitabilityFinancialPeriodListCodec: import("../../../_/codec.js").Codec;

package/dist/generated/fundamentals/ratios/profitability/models.js

@@ -0,0 +1,9 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, object } from "../../../_/index.js";
+export const V3ProfitabilityFinancialPeriodListCodec = object([
+    ["data", null, array(object([["dvd_payout_ratio", "dvdPayoutRatio"], ["ebitda_margin", "ebitdaMargin"], ["eff_tax_rate", "effTaxRate"], ["fiscal_year", "fiscalYear"], ["fx_applied", "fxApplied"], ["gross_margin", "grossMargin"], ["incremental_operating_margin", "incrementalOperatingMargin"], ["net_income_to_common_margin", "netIncomeToCommonMargin"], ["oper_margin", "operMargin"], ["period_end_date", "periodEndDate"], ["period_label", "periodLabel"], ["period_type", "periodType"], ["pretax_inc_to_net_sales", "pretaxIncToNetSales"], ["price_currency", "priceCurrency"], ["profit_margin", "profitMargin"], ["return_com_eqy", "returnComEqy"], ["return_on_asset", "returnOnAsset"], ["return_on_cap", "returnOnCap"], ["return_on_inv_capital", "returnOnInvCapital"], ["sustain_growth_rt", "sustainGrowthRt"]]))],
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map

package/dist/generated/fundamentals/ratios/profitability/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/profitability/models.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAQpD,MAAM,CAAC,MAAM,uCAAuC,GAAG,MAAM,CAAC;IAC5D,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,CAAC,cAAc,EAAE,YAAY,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC,8BAA8B,EAAE,4BAA4B,CAAC,EAAE,CAAC,6BAA6B,EAAE,yBAAyB,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,yBAAyB,EAAE,qBAAqB,CAAC,EAAE,CAAC,gBAAgB,EAAE,eAAe,CAAC,EAAE,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC,EAAE,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,EAAE,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,EAAE,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3yB,CAAC,eAAe,EAAE,aAAa,CAAC;IAChC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;CACzC,CAAC,CAAC"}

package/dist/generated/fundamentals/ratios/workingCapital/client.d.ts

@@ -0,0 +1,79 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../../../_/index.js";
+import { type V3WorkingCapitalFinancialPeriodList } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List working-capital ratios
+     *
+     * Returns working-capital ratios by financial period.
+     */
+    list(request: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * A ticker ID, an exchange and symbol separated by a colon (e.g.
+     * `NASDAQ:AAPL`), or a FIGI.
+     */
+    identifier: string;
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+    periodType?: "annual" | "quarterly" | "ttm";
+    periodLabel?: "FY" | "Q1" | "Q2" | "Q3" | "Q4";
+    /**
+     * Return statements whose period end date is exactly this date.
+     */
+    date?: string;
+    /**
+     * Return statements whose period end date is on or after this date.
+     */
+    dateGte?: string;
+    /**
+     * Return statements whose period end date is strictly after this date.
+     */
+    dateGt?: string;
+    /**
+     * Return statements whose period end date is on or before this date.
+     */
+    dateLte?: string;
+    /**
+     * Return statements whose period end date is strictly before this date.
+     */
+    dateLt?: string;
+    /**
+     * Return statements from this fiscal year onward.
+     */
+    fiscalYearGte?: string | number;
+    /**
+     * Return statements after this fiscal year.
+     */
+    fiscalYearGt?: string | number;
+    /**
+     * Return statements through this fiscal year.
+     */
+    fiscalYearLte?: string | number;
+    /**
+     * Return statements before this fiscal year.
+     */
+    fiscalYearLt?: string | number;
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of resources to return. Defaults to 50.
+     */
+    limit?: string | number;
+    /**
+     * Opaque page token from a previous response. Prefer following the returned
+     * page URLs directly.
+     */
+    page?: string;
+}
+export type ListResponse = V3WorkingCapitalFinancialPeriodList;

package/dist/generated/fundamentals/ratios/workingCapital/client.js

@@ -0,0 +1,21 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, } from "../../../_/index.js";
+import { V3ErrorCodec } from "../../../models.js";
+import { V3WorkingCapitalFinancialPeriodListCodec, } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v3.0.0/fundamental/ratios/working-capital/{identifier}",
+    query: { apikey: "apikey", periodType: "period_type", periodLabel: "period_label", date: "date", dateGte: "date.gte", dateGt: "date.gt", dateLte: "date.lte", dateLt: "date.lt", fiscalYearGte: "fiscal_year.gte", fiscalYearGt: "fiscal_year.gt", fiscalYearLte: "fiscal_year.lte", fiscalYearLt: "fiscal_year.lt", order: "order", limit: "limit", page: "page" },
+    response: V3WorkingCapitalFinancialPeriodListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "402": V3ErrorCodec, "404": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+//# sourceMappingURL=client.js.map

package/dist/generated/fundamentals/ratios/workingCapital/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/workingCapital/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,wCAAwC,GACzC,MAAM,aAAa,CAAC;AAkBrB,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,SAAoB;IACvC,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;KAC5E,CAAC;AACJ,CAAC;AAiED,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,yDAAyD;IAChE,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACnW,QAAQ,EAAE,wCAAwC;IAClD,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}

package/dist/generated/fundamentals/ratios/workingCapital/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiError } from "../../../_/index.js";
+export type { RequestOptions } from "../../../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, ListRequest, ListResponse, } from "./client.js";
+export type { V3WorkingCapitalFinancialPeriodList } from "./models.js";

package/dist/generated/fundamentals/ratios/workingCapital/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../../../_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/fundamentals/ratios/workingCapital/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/workingCapital/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/fundamentals/ratios/workingCapital/models.d.ts

@@ -0,0 +1,30 @@
+export interface V3WorkingCapitalFinancialPeriodList {
+    data: {
+        accountsPayableTurnover: number | null;
+        accountsPayableTurnoverDays: number | null;
+        acctRcvDays: number | null;
+        acctRcvTurn: number | null;
+        bsInventories: number | null;
+        bsInvtryFinishedGoods: number | null;
+        bsInvtryInProgress: number | null;
+        bsInvtryRawMaterials: number | null;
+        bsOtherInv: number | null;
+        cashConversionCycle: number | null;
+        currency: string;
+        fiscalYear: string | number | null;
+        fxApplied: boolean;
+        id: string;
+        invToCashDays: number | null;
+        inventDays: number | null;
+        inventTurn: number | null;
+        object: "v3.fundamentals.working_capital_ratio";
+        periodEndDate: string;
+        periodLabel: string | null;
+        periodType: "annual" | "quarterly" | "ttm";
+        priceCurrency: string | null;
+        symbol: string;
+    }[];
+    nextPageUrl: string | null;
+    previousPageUrl: string | null;
+}
+export declare const V3WorkingCapitalFinancialPeriodListCodec: import("../../../_/codec.js").Codec;

package/dist/generated/fundamentals/ratios/workingCapital/models.js

@@ -0,0 +1,9 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, object } from "../../../_/index.js";
+export const V3WorkingCapitalFinancialPeriodListCodec = object([
+    ["data", null, array(object([["accounts_payable_turnover", "accountsPayableTurnover"], ["accounts_payable_turnover_days", "accountsPayableTurnoverDays"], ["acct_rcv_days", "acctRcvDays"], ["acct_rcv_turn", "acctRcvTurn"], ["bs_inventories", "bsInventories"], ["bs_invtry_finished_goods", "bsInvtryFinishedGoods"], ["bs_invtry_in_progress", "bsInvtryInProgress"], ["bs_invtry_raw_materials", "bsInvtryRawMaterials"], ["bs_other_inv", "bsOtherInv"], ["cash_conversion_cycle", "cashConversionCycle"], ["fiscal_year", "fiscalYear"], ["fx_applied", "fxApplied"], ["inv_to_cash_days", "invToCashDays"], ["invent_days", "inventDays"], ["invent_turn", "inventTurn"], ["period_end_date", "periodEndDate"], ["period_label", "periodLabel"], ["period_type", "periodType"], ["price_currency", "priceCurrency"]]))],
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map

package/dist/generated/fundamentals/ratios/workingCapital/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/workingCapital/models.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAQpD,MAAM,CAAC,MAAM,wCAAwC,GAAG,MAAM,CAAC;IAC7D,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,2BAA2B,EAAE,yBAAyB,CAAC,EAAE,CAAC,gCAAgC,EAAE,6BAA6B,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,EAAE,CAAC,gBAAgB,EAAE,eAAe,CAAC,EAAE,CAAC,0BAA0B,EAAE,uBAAuB,CAAC,EAAE,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,EAAE,CAAC,yBAAyB,EAAE,sBAAsB,CAAC,EAAE,CAAC,cAAc,EAAE,YAAY,CAAC,EAAE,CAAC,uBAAuB,EAAE,qBAAqB,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,kBAAkB,EAAE,eAAe,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IAChyB,CAAC,eAAe,EAAE,aAAa,CAAC;IAChC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;CACzC,CAAC,CAAC"}

package/dist/generated/fundamentals/ratios/yieldAnalysis/client.d.ts

@@ -0,0 +1,79 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../../../_/index.js";
+import { type V3YieldAnalysisFinancialPeriodList } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List yield-analysis ratios
+     *
+     * Returns yield-analysis ratios by financial period.
+     */
+    list(request: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * A ticker ID, an exchange and symbol separated by a colon (e.g.
+     * `NASDAQ:AAPL`), or a FIGI.
+     */
+    identifier: string;
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+    periodType?: "annual" | "quarterly" | "ttm";
+    periodLabel?: "FY" | "Q1" | "Q2" | "Q3" | "Q4";
+    /**
+     * Return statements whose period end date is exactly this date.
+     */
+    date?: string;
+    /**
+     * Return statements whose period end date is on or after this date.
+     */
+    dateGte?: string;
+    /**
+     * Return statements whose period end date is strictly after this date.
+     */
+    dateGt?: string;
+    /**
+     * Return statements whose period end date is on or before this date.
+     */
+    dateLte?: string;
+    /**
+     * Return statements whose period end date is strictly before this date.
+     */
+    dateLt?: string;
+    /**
+     * Return statements from this fiscal year onward.
+     */
+    fiscalYearGte?: string | number;
+    /**
+     * Return statements after this fiscal year.
+     */
+    fiscalYearGt?: string | number;
+    /**
+     * Return statements through this fiscal year.
+     */
+    fiscalYearLte?: string | number;
+    /**
+     * Return statements before this fiscal year.
+     */
+    fiscalYearLt?: string | number;
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of resources to return. Defaults to 50.
+     */
+    limit?: string | number;
+    /**
+     * Opaque page token from a previous response. Prefer following the returned
+     * page URLs directly.
+     */
+    page?: string;
+}
+export type ListResponse = V3YieldAnalysisFinancialPeriodList;

package/dist/generated/fundamentals/ratios/yieldAnalysis/client.js

@@ -0,0 +1,21 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, } from "../../../_/index.js";
+import { V3ErrorCodec } from "../../../models.js";
+import { V3YieldAnalysisFinancialPeriodListCodec, } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v3.0.0/fundamental/ratios/yield-analysis/{identifier}",
+    query: { apikey: "apikey", periodType: "period_type", periodLabel: "period_label", date: "date", dateGte: "date.gte", dateGt: "date.gt", dateLte: "date.lte", dateLt: "date.lt", fiscalYearGte: "fiscal_year.gte", fiscalYearGt: "fiscal_year.gt", fiscalYearLte: "fiscal_year.lte", fiscalYearLt: "fiscal_year.lt", order: "order", limit: "limit", page: "page" },
+    response: V3YieldAnalysisFinancialPeriodListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "402": V3ErrorCodec, "404": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+//# sourceMappingURL=client.js.map

package/dist/generated/fundamentals/ratios/yieldAnalysis/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/yieldAnalysis/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,uCAAuC,GACxC,MAAM,aAAa,CAAC;AAkBrB,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,SAAoB;IACvC,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;KAC5E,CAAC;AACJ,CAAC;AAiED,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,wDAAwD;IAC/D,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,aAAa,EAAE,iBAAiB,EAAE,YAAY,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;IACnW,QAAQ,EAAE,uCAAuC;IACjD,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CAC9J,CAAC"}

package/dist/generated/fundamentals/ratios/yieldAnalysis/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiError } from "../../../_/index.js";
+export type { RequestOptions } from "../../../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, ListRequest, ListResponse, } from "./client.js";
+export type { V3YieldAnalysisFinancialPeriodList } from "./models.js";

package/dist/generated/fundamentals/ratios/yieldAnalysis/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../../../_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/fundamentals/ratios/yieldAnalysis/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/yieldAnalysis/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/fundamentals/ratios/yieldAnalysis/models.d.ts

@@ -0,0 +1,36 @@
+export interface V3YieldAnalysisFinancialPeriodList {
+    data: {
+        capitalYield: number | null;
+        cfCapExpenditures: number | null;
+        cfCashFromOper: number | null;
+        cfDvdPaid: number | null;
+        cfFreeCashFlowFirm: number | null;
+        cfOtherFinancingActExclFx: number | null;
+        cfProcFrRepurchEqtyDetailed: number | null;
+        cfPymtDebtAndCapitalLease: number | null;
+        currency: string;
+        enterpriseValue: number | null;
+        fiscalYear: string | number | null;
+        freeCashFlowYield: number | null;
+        fxApplied: boolean;
+        id: string;
+        object: "v3.fundamentals.yield_analysis_ratio";
+        periodEndDate: string;
+        periodLabel: string | null;
+        periodType: "annual" | "quarterly" | "ttm";
+        priceCurrency: string | null;
+        returnedCapitalExDebt: number | null;
+        shareholderYieldCff: number | null;
+        shareholderYieldExDebt: number | null;
+        symbol: string;
+        ttmAfterTaxInterestExpense: number | null;
+        ttmCapExpend: number | null;
+        ttmCashFromOper: number | null;
+        ttmCff: number | null;
+        ttmFcfToFirmYield: number | null;
+        ttmFreeCashFlow: number | null;
+    }[];
+    nextPageUrl: string | null;
+    previousPageUrl: string | null;
+}
+export declare const V3YieldAnalysisFinancialPeriodListCodec: import("../../../_/codec.js").Codec;

package/dist/generated/fundamentals/ratios/yieldAnalysis/models.js

@@ -0,0 +1,9 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, object } from "../../../_/index.js";
+export const V3YieldAnalysisFinancialPeriodListCodec = object([
+    ["data", null, array(object([["capital_yield", "capitalYield"], ["cf_cap_expenditures", "cfCapExpenditures"], ["cf_cash_from_oper", "cfCashFromOper"], ["cf_dvd_paid", "cfDvdPaid"], ["cf_free_cash_flow_firm", "cfFreeCashFlowFirm"], ["cf_other_financing_act_excl_fx", "cfOtherFinancingActExclFx"], ["cf_proc_fr_repurch_eqty_detailed", "cfProcFrRepurchEqtyDetailed"], ["cf_pymt_debt_and_capital_lease", "cfPymtDebtAndCapitalLease"], ["enterprise_value", "enterpriseValue"], ["fiscal_year", "fiscalYear"], ["free_cash_flow_yield", "freeCashFlowYield"], ["fx_applied", "fxApplied"], ["period_end_date", "periodEndDate"], ["period_label", "periodLabel"], ["period_type", "periodType"], ["price_currency", "priceCurrency"], ["returned_capital_ex_debt", "returnedCapitalExDebt"], ["shareholder_yield_cff", "shareholderYieldCff"], ["shareholder_yield_ex_debt", "shareholderYieldExDebt"], ["ttm_after_tax_interest_expense", "ttmAfterTaxInterestExpense"], ["ttm_cap_expend", "ttmCapExpend"], ["ttm_cash_from_oper", "ttmCashFromOper"], ["ttm_cff", "ttmCff"], ["ttm_fcf_to_firm_yield", "ttmFcfToFirmYield"], ["ttm_free_cash_flow", "ttmFreeCashFlow"]]))],
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map

package/dist/generated/fundamentals/ratios/yieldAnalysis/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../../../../src/generated/fundamentals/ratios/yieldAnalysis/models.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAQpD,MAAM,CAAC,MAAM,uCAAuC,GAAG,MAAM,CAAC;IAC5D,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,EAAE,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,CAAC,wBAAwB,EAAE,oBAAoB,CAAC,EAAE,CAAC,gCAAgC,EAAE,2BAA2B,CAAC,EAAE,CAAC,kCAAkC,EAAE,6BAA6B,CAAC,EAAE,CAAC,gCAAgC,EAAE,2BAA2B,CAAC,EAAE,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,sBAAsB,EAAE,mBAAmB,CAAC,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAAE,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,EAAE,CAAC,gBAAgB,EAAE,eAAe,CAAC,EAAE,CAAC,0BAA0B,EAAE,uBAAuB,CAAC,EAAE,CAAC,uBAAuB,EAAE,qBAAqB,CAAC,EAAE,CAAC,2BAA2B,EAAE,wBAAwB,CAAC,EAAE,CAAC,gCAAgC,EAAE,4BAA4B,CAAC,EAAE,CAAC,gBAAgB,EAAE,cAAc,CAAC,EAAE,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,EAAE,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;IACpnC,CAAC,eAAe,EAAE,aAAa,CAAC;IAChC,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;CACzC,CAAC,CAAC"}

package/dist/generated/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiError } from "./_/index.js";
+export type { RequestOptions } from "./_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, } from "./client.js";
+export type { V3BulkFileList, V3Error, } from "./models.js";

package/dist/generated/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "./_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/industries/client.d.ts

@@ -0,0 +1,26 @@
+import { type BaseClientOptions, type RequestOptions, Transport } from "../_/index.js";
+import { type V3IndustryList } from "./models.js";
+export interface ClientOptions extends BaseClientOptions {
+    /**
+     * The URL the paths of the API are relative to.
+     */
+    baseUrl: string;
+}
+export interface Client {
+    /**
+     * List industries
+     *
+     * Returns every company industry in one response, with symbol counts.
+     */
+    list(request?: ListRequest, options?: RequestOptions): Promise<ListResponse>;
+}
+export declare function createClient(options: ClientOptions): Client;
+export declare function bind(transport: Transport): Client;
+export interface ListRequest {
+    /**
+     * Browser-friendly alternative to Bearer authentication. Use either this
+     * parameter or the Authorization header, never both.
+     */
+    apikey?: string;
+}
+export type ListResponse = V3IndustryList;

package/dist/generated/industries/client.js

@@ -0,0 +1,21 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { Transport, } from "../_/index.js";
+import { V3ErrorCodec } from "../models.js";
+import { V3IndustryListCodec } from "./models.js";
+export function createClient(options) {
+    return bind(new Transport(options));
+}
+export function bind(transport) {
+    return {
+        list: (request, options) => transport.send(ListOperation, request, options),
+    };
+}
+const ListOperation = {
+    method: "GET",
+    route: "/v3.0.0/industries",
+    query: { apikey: "apikey" },
+    response: V3IndustryListCodec,
+    errors: { "400": V3ErrorCodec, "401": V3ErrorCodec, "429": V3ErrorCodec, "500": V3ErrorCodec, "503": V3ErrorCodec },
+};
+//# sourceMappingURL=client.js.map

package/dist/generated/industries/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/generated/industries/client.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAIL,SAAS,GACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAuB,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAkBvE,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,IAAI,CAAC,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,SAAoB;IACvC,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;KAC5E,CAAC;AACJ,CAAC;AAYD,MAAM,aAAa,GAAc;IAC/B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,oBAAoB;IAC3B,KAAK,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;IAC3B,QAAQ,EAAE,mBAAmB;IAC7B,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;CACpH,CAAC"}

package/dist/generated/industries/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiError } from "../_/index.js";
+export type { RequestOptions } from "../_/index.js";
+export { createClient } from "./client.js";
+export type { Client, ClientOptions, ListRequest, ListResponse, } from "./client.js";
+export type { V3IndustryList } from "./models.js";

package/dist/generated/industries/index.js

@@ -0,0 +1,5 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+export { ApiError } from "../_/index.js";
+export { createClient } from "./client.js";
+//# sourceMappingURL=index.js.map

package/dist/generated/industries/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/generated/industries/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,oBAAoB;AAEpB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/generated/industries/models.d.ts

@@ -0,0 +1,11 @@
+export interface V3IndustryList {
+    data: {
+        id: string;
+        name: string;
+        object: "v3.reference.industry";
+        symbolCount: string | number;
+    }[];
+    nextPageUrl: string | null;
+    previousPageUrl: string | null;
+}
+export declare const V3IndustryListCodec: import("../_/codec.js").Codec;

package/dist/generated/industries/models.js

@@ -0,0 +1,9 @@
+// Code generated by forge. DO NOT EDIT.
+/* eslint-disable */
+import { array, object } from "../_/index.js";
+export const V3IndustryListCodec = object([
+    ["data", null, array(object([["symbol_count", "symbolCount"]]))],
+    ["next_page_url", "nextPageUrl"],
+    ["previous_page_url", "previousPageUrl"],
+]);
+//# sourceMappingURL=models.js.map