weflayr 0.22.2 → 0.23.0

package/dist/api/generated/facade.gen.d.ts

@@ -1,5 +1,30 @@
 import type { CamelCaseDeep } from '../caseConversion.js';
 import type * as generatedTypes from './types.gen.js';
+export declare const getMargin: (options: import("../makeEndpoint.js").ClientOption & {
+    query?: {
+        customerNames?: string[] | undefined;
+        cursor?: string | undefined;
+        limit?: number | undefined;
+        dateFrom?: string | undefined;
+        dateTo?: string | undefined;
+        applyCredits?: boolean | undefined;
+    } | undefined;
+    body?: undefined;
+    path?: undefined;
+}) => Promise<import("../makeEndpoint.js").CallResult<{
+    rows: {
+        customerName: string;
+        revenue: number;
+        cost: number;
+        margin: number;
+        marginPct: number | null;
+        profitabilityStatus: "healthy" | "watch" | "at_risk" | "unprofitable" | "unknown";
+    }[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}, {
+    error: string;
+}>>;
 export declare const deleteRevenue: (options: import("../makeEndpoint.js").ClientOption & {
     query: {
         customerNames: string[];

package/dist/api/generated/facade.gen.js

@@ -35,9 +35,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setCustomersTags = exports.getCustomersTags = exports.deleteCustomersTags = exports.setKeyMetrics = exports.getKeyMetrics = exports.deleteKeyMetrics = exports.setRevenue = exports.getRevenue = exports.deleteRevenue = void 0;
+exports.setCustomersTags = exports.getCustomersTags = exports.deleteCustomersTags = exports.setKeyMetrics = exports.getKeyMetrics = exports.deleteKeyMetrics = exports.setRevenue = exports.getRevenue = exports.deleteRevenue = exports.getMargin = void 0;
 const makeEndpoint_js_1 = require("../makeEndpoint.js");
 const generated = __importStar(require("./sdk.gen.js"));
+exports.getMargin = (0, makeEndpoint_js_1.makeEndpoint)(generated.getMargin);
 exports.deleteRevenue = (0, makeEndpoint_js_1.makeEndpoint)(generated.deleteRevenue);
 exports.getRevenue = (0, makeEndpoint_js_1.makeEndpoint)(generated.getRevenue);
 exports.setRevenue = (0, makeEndpoint_js_1.makeEndpoint)(generated.setRevenue);

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

@@ -1,2 +1,2 @@
-export { deleteCustomersTags, deleteKeyMetrics, deleteRevenue, getCustomersTags, getKeyMetrics, getRevenue, type Options, setCustomersTags, setKeyMetrics, setRevenue } from './sdk.gen.js';
-export type { AllCustomerTagsOutput, ApiErrorOutput, ClientOptions, CustomersUpdatedOutput, CustomerTags, CustomerTagsOutput, DeleteCustomersTagsData, DeleteCustomersTagsError, DeleteCustomersTagsErrors, DeleteCustomersTagsResponse, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsError, DeleteKeyMetricsErrors, DeleteKeyMetricsResponse, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueError, DeleteRevenueErrors, DeleteRevenueResponse, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsError, GetCustomersTagsErrors, GetCustomersTagsResponse, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsError, GetKeyMetricsErrors, GetKeyMetricsResponse, GetKeyMetricsResponses, GetRevenueData, GetRevenueError, GetRevenueErrors, GetRevenueResponse, GetRevenueResponses, InvalidFieldDetail, InvalidPayloadOutput, KeyMetricOutput, KeyMetricRow, KeyMetricRowOutput, RevenueOrKeyMetricDeletedRowOutput, RevenueOrKeyMetricImportedRowOutput, RevenueOutput, RevenueRow, RevenueRowOutput, SetCustomersTagsData, SetCustomersTagsError, SetCustomersTagsErrors, SetCustomersTagsResponse, SetCustomersTagsResponses, SetCustomerTagsInput, SetKeyMetricsData, SetKeyMetricsError, SetKeyMetricsErrors, SetKeyMetricsInput, SetKeyMetricsResponse, SetKeyMetricsResponses, SetRevenueData, SetRevenueError, SetRevenueErrors, SetRevenueInput, SetRevenueResponse, SetRevenueResponses, TagsDeletedOutput } from './types.gen.js';
+export { deleteCustomersTags, deleteKeyMetrics, deleteRevenue, getCustomersTags, getKeyMetrics, getMargin, getRevenue, type Options, setCustomersTags, setKeyMetrics, setRevenue } from './sdk.gen.js';
+export type { AllCustomerTagsOutput, ApiErrorOutput, ClientOptions, CustomerMarginRow, CustomersUpdatedOutput, CustomerTags, CustomerTagsOutput, DeleteCustomersTagsData, DeleteCustomersTagsError, DeleteCustomersTagsErrors, DeleteCustomersTagsResponse, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsError, DeleteKeyMetricsErrors, DeleteKeyMetricsResponse, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueError, DeleteRevenueErrors, DeleteRevenueResponse, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsError, GetCustomersTagsErrors, GetCustomersTagsResponse, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsError, GetKeyMetricsErrors, GetKeyMetricsResponse, GetKeyMetricsResponses, GetMarginData, GetMarginError, GetMarginErrors, GetMarginResponse, GetMarginResponses, GetRevenueData, GetRevenueError, GetRevenueErrors, GetRevenueResponse, GetRevenueResponses, InvalidFieldDetail, InvalidPayloadOutput, KeyMetricOutput, KeyMetricRow, KeyMetricRowOutput, MarginListOutput, RevenueOrKeyMetricDeletedRowOutput, RevenueOrKeyMetricImportedRowOutput, RevenueOutput, RevenueRow, RevenueRowOutput, SetCustomersTagsData, SetCustomersTagsError, SetCustomersTagsErrors, SetCustomersTagsResponse, SetCustomersTagsResponses, SetCustomerTagsInput, SetKeyMetricsData, SetKeyMetricsError, SetKeyMetricsErrors, SetKeyMetricsInput, SetKeyMetricsResponse, SetKeyMetricsResponses, SetRevenueData, SetRevenueError, SetRevenueErrors, SetRevenueInput, SetRevenueResponse, SetRevenueResponses, TagsDeletedOutput } from './types.gen.js';

package/dist/api/generated/index.js

@@ -1,13 +1,14 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setRevenue = exports.setKeyMetrics = exports.setCustomersTags = exports.getRevenue = exports.getKeyMetrics = exports.getCustomersTags = exports.deleteRevenue = exports.deleteKeyMetrics = exports.deleteCustomersTags = void 0;
+exports.setRevenue = exports.setKeyMetrics = exports.setCustomersTags = exports.getRevenue = exports.getMargin = exports.getKeyMetrics = exports.getCustomersTags = exports.deleteRevenue = exports.deleteKeyMetrics = exports.deleteCustomersTags = void 0;
 var sdk_gen_js_1 = require("./sdk.gen.js");
 Object.defineProperty(exports, "deleteCustomersTags", { enumerable: true, get: function () { return sdk_gen_js_1.deleteCustomersTags; } });
 Object.defineProperty(exports, "deleteKeyMetrics", { enumerable: true, get: function () { return sdk_gen_js_1.deleteKeyMetrics; } });
 Object.defineProperty(exports, "deleteRevenue", { enumerable: true, get: function () { return sdk_gen_js_1.deleteRevenue; } });
 Object.defineProperty(exports, "getCustomersTags", { enumerable: true, get: function () { return sdk_gen_js_1.getCustomersTags; } });
 Object.defineProperty(exports, "getKeyMetrics", { enumerable: true, get: function () { return sdk_gen_js_1.getKeyMetrics; } });
+Object.defineProperty(exports, "getMargin", { enumerable: true, get: function () { return sdk_gen_js_1.getMargin; } });
 Object.defineProperty(exports, "getRevenue", { enumerable: true, get: function () { return sdk_gen_js_1.getRevenue; } });
 Object.defineProperty(exports, "setCustomersTags", { enumerable: true, get: function () { return sdk_gen_js_1.setCustomersTags; } });
 Object.defineProperty(exports, "setKeyMetrics", { enumerable: true, get: function () { return sdk_gen_js_1.setKeyMetrics; } });

package/dist/api/generated/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
-import type { DeleteCustomersTagsData, DeleteCustomersTagsErrors, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsErrors, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueErrors, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsErrors, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsErrors, GetKeyMetricsResponses, GetRevenueData, GetRevenueErrors, GetRevenueResponses, SetCustomersTagsData, SetCustomersTagsErrors, SetCustomersTagsResponses, SetKeyMetricsData, SetKeyMetricsErrors, SetKeyMetricsResponses, SetRevenueData, SetRevenueErrors, SetRevenueResponses } from './types.gen.js';
+import type { DeleteCustomersTagsData, DeleteCustomersTagsErrors, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsErrors, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueErrors, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsErrors, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsErrors, GetKeyMetricsResponses, GetMarginData, GetMarginErrors, GetMarginResponses, GetRevenueData, GetRevenueErrors, GetRevenueResponses, SetCustomersTagsData, SetCustomersTagsErrors, SetCustomersTagsResponses, SetKeyMetricsData, SetKeyMetricsErrors, SetKeyMetricsResponses, SetRevenueData, SetRevenueErrors, SetRevenueResponses } from './types.gen.js';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -13,6 +13,10 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
      */
     meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
 };
+/**
+ * Per-customer gross margin, sorted by customer_name ascending; pass customer_names to narrow to specific customers, omit it for every customer's.
+ */
+export declare const getMargin: <ThrowOnError extends boolean = false>(options?: Options<GetMarginData, ThrowOnError>) => RequestResult<GetMarginResponses, GetMarginErrors, ThrowOnError>;
 /**
  * Delete the given customers' API-uploaded revenue values.
  */

package/dist/api/generated/sdk.gen.js

@@ -1,8 +1,17 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setCustomersTags = exports.getCustomersTags = exports.deleteCustomersTags = exports.setKeyMetrics = exports.getKeyMetrics = exports.deleteKeyMetrics = exports.setRevenue = exports.getRevenue = exports.deleteRevenue = void 0;
+exports.setCustomersTags = exports.getCustomersTags = exports.deleteCustomersTags = exports.setKeyMetrics = exports.getKeyMetrics = exports.deleteKeyMetrics = exports.setRevenue = exports.getRevenue = exports.deleteRevenue = exports.getMargin = void 0;
 const client_gen_js_1 = require("./client.gen.js");
+/**
+ * Per-customer gross margin, sorted by customer_name ascending; pass customer_names to narrow to specific customers, omit it for every customer's.
+ */
+const getMargin = (options) => (options?.client ?? client_gen_js_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/margin/',
+    ...options
+});
+exports.getMargin = getMargin;
 /**
  * Delete the given customers' API-uploaded revenue values.
  */

package/dist/api/generated/types.gen.d.ts

@@ -31,6 +31,37 @@ export type ApiErrorOutput = {
      */
     error: string;
 };
+/**
+ * CustomerMarginRow
+ *
+ * One customer's gross margin for a period.
+ */
+export type CustomerMarginRow = {
+    /**
+     * Customer Name
+     */
+    customer_name: string;
+    /**
+     * Revenue
+     */
+    revenue: number;
+    /**
+     * Cost
+     */
+    cost: number;
+    /**
+     * Margin
+     */
+    margin: number;
+    /**
+     * Margin Pct
+     */
+    margin_pct: number | null;
+    /**
+     * Profitability Status
+     */
+    profitability_status: 'healthy' | 'watch' | 'at_risk' | 'unprofitable' | 'unknown';
+};
 /**
  * CustomerTags
  *
@@ -199,6 +230,26 @@ export type KeyMetricRowOutput = {
      */
     user_name: string;
 };
+/**
+ * MarginListOutput
+ *
+ * Margin GET response: one row per customer with booked revenue, sorted by
+ * customer_name ascending.
+ */
+export type MarginListOutput = {
+    /**
+     * Rows
+     */
+    rows: Array<CustomerMarginRow>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+    /**
+     * Has More
+     */
+    has_more: boolean;
+};
 /**
  * RevenueOrKeyMetricDeletedRowOutput
  *
@@ -385,6 +436,52 @@ export type TagsDeletedOutput = {
      */
     tags_deleted: number;
 };
+export type GetMarginData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Return only these customers' margin. Omit to return every customer's.
+         */
+        customer_names?: Array<string>;
+        /**
+         * Opaque cursor from a previous page's next_cursor.
+         */
+        cursor?: string;
+        limit?: number;
+        /**
+         * Start of the period (inclusive), YYYY-MM-DD. Defaults to 30 days ago.
+         */
+        date_from?: string;
+        /**
+         * End of the period (inclusive), YYYY-MM-DD. Defaults to today.
+         */
+        date_to?: string;
+        /**
+         * Apply free-credit discounts to cost. Defaults to false.
+         */
+        apply_credits?: boolean;
+    };
+    url: '/margin/';
+};
+export type GetMarginErrors = {
+    /**
+     * Invalid request for this project type.
+     */
+    400: ApiErrorOutput;
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+};
+export type GetMarginError = GetMarginErrors[keyof GetMarginErrors];
+export type GetMarginResponses = {
+    /**
+     * Success.
+     */
+    200: MarginListOutput;
+};
+export type GetMarginResponse = GetMarginResponses[keyof GetMarginResponses];
 export type DeleteRevenueData = {
     body?: never;
     path?: never;
@@ -427,7 +524,7 @@ export type GetRevenueData = {
     path?: never;
     query?: {
         /**
-         * Return only these customers' revenue (repeat the param for several). Omit to return every customer's.
+         * Return only these customers' revenue. Omit to return every customer's.
          */
         customer_names?: Array<string>;
         /**
@@ -518,7 +615,7 @@ export type GetKeyMetricsData = {
     path?: never;
     query?: {
         /**
-         * Return only these users' key metrics (repeat the param for several). Omit to return every user's.
+         * Return only these users' key metrics. Omit to return every user's.
          */
         user_names?: Array<string>;
         /**
@@ -572,7 +669,7 @@ export type DeleteCustomersTagsData = {
     path?: never;
     query: {
         /**
-         * Delete every tag of these customers (repeat the param for several).
+         * Delete every tag of these customers.
          */
         customer_names: Array<string>;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "weflayr",
-  "version": "0.22.2",
+  "version": "0.23.0",
   "description": "Weflayr Node.js SDK — instrument any LLM client via JS Proxy",
   "main": "src/index.js",
   "types": "index.d.ts",

package/src/api/generated/facade.gen.ts

@@ -7,6 +7,12 @@ import * as generated from './sdk.gen.js';
 import type * as generatedTypes from './types.gen.js';
 
 
+export const getMargin = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.GetMarginData, 'url'>>,
+  CamelCaseDeep<generatedTypes.GetMarginResponse>,
+  CamelCaseDeep<generatedTypes.GetMarginError>
+>(generated.getMargin);
+
 export const deleteRevenue = makeEndpoint<
   CamelCaseDeep<Omit<generatedTypes.DeleteRevenueData, 'url'>>,
   CamelCaseDeep<generatedTypes.DeleteRevenueResponse>,

package/src/api/generated/index.ts

@@ -1,4 +1,4 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export { deleteCustomersTags, deleteKeyMetrics, deleteRevenue, getCustomersTags, getKeyMetrics, getRevenue, type Options, setCustomersTags, setKeyMetrics, setRevenue } from './sdk.gen.js';
-export type { AllCustomerTagsOutput, ApiErrorOutput, ClientOptions, CustomersUpdatedOutput, CustomerTags, CustomerTagsOutput, DeleteCustomersTagsData, DeleteCustomersTagsError, DeleteCustomersTagsErrors, DeleteCustomersTagsResponse, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsError, DeleteKeyMetricsErrors, DeleteKeyMetricsResponse, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueError, DeleteRevenueErrors, DeleteRevenueResponse, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsError, GetCustomersTagsErrors, GetCustomersTagsResponse, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsError, GetKeyMetricsErrors, GetKeyMetricsResponse, GetKeyMetricsResponses, GetRevenueData, GetRevenueError, GetRevenueErrors, GetRevenueResponse, GetRevenueResponses, InvalidFieldDetail, InvalidPayloadOutput, KeyMetricOutput, KeyMetricRow, KeyMetricRowOutput, RevenueOrKeyMetricDeletedRowOutput, RevenueOrKeyMetricImportedRowOutput, RevenueOutput, RevenueRow, RevenueRowOutput, SetCustomersTagsData, SetCustomersTagsError, SetCustomersTagsErrors, SetCustomersTagsResponse, SetCustomersTagsResponses, SetCustomerTagsInput, SetKeyMetricsData, SetKeyMetricsError, SetKeyMetricsErrors, SetKeyMetricsInput, SetKeyMetricsResponse, SetKeyMetricsResponses, SetRevenueData, SetRevenueError, SetRevenueErrors, SetRevenueInput, SetRevenueResponse, SetRevenueResponses, TagsDeletedOutput } from './types.gen.js';
+export { deleteCustomersTags, deleteKeyMetrics, deleteRevenue, getCustomersTags, getKeyMetrics, getMargin, getRevenue, type Options, setCustomersTags, setKeyMetrics, setRevenue } from './sdk.gen.js';
+export type { AllCustomerTagsOutput, ApiErrorOutput, ClientOptions, CustomerMarginRow, CustomersUpdatedOutput, CustomerTags, CustomerTagsOutput, DeleteCustomersTagsData, DeleteCustomersTagsError, DeleteCustomersTagsErrors, DeleteCustomersTagsResponse, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsError, DeleteKeyMetricsErrors, DeleteKeyMetricsResponse, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueError, DeleteRevenueErrors, DeleteRevenueResponse, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsError, GetCustomersTagsErrors, GetCustomersTagsResponse, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsError, GetKeyMetricsErrors, GetKeyMetricsResponse, GetKeyMetricsResponses, GetMarginData, GetMarginError, GetMarginErrors, GetMarginResponse, GetMarginResponses, GetRevenueData, GetRevenueError, GetRevenueErrors, GetRevenueResponse, GetRevenueResponses, InvalidFieldDetail, InvalidPayloadOutput, KeyMetricOutput, KeyMetricRow, KeyMetricRowOutput, MarginListOutput, RevenueOrKeyMetricDeletedRowOutput, RevenueOrKeyMetricImportedRowOutput, RevenueOutput, RevenueRow, RevenueRowOutput, SetCustomersTagsData, SetCustomersTagsError, SetCustomersTagsErrors, SetCustomersTagsResponse, SetCustomersTagsResponses, SetCustomerTagsInput, SetKeyMetricsData, SetKeyMetricsError, SetKeyMetricsErrors, SetKeyMetricsInput, SetKeyMetricsResponse, SetKeyMetricsResponses, SetRevenueData, SetRevenueError, SetRevenueErrors, SetRevenueInput, SetRevenueResponse, SetRevenueResponses, TagsDeletedOutput } from './types.gen.js';

package/src/api/generated/sdk.gen.ts

@@ -2,7 +2,7 @@
 
 import { client } from './client.gen.js';
 import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
-import type { DeleteCustomersTagsData, DeleteCustomersTagsErrors, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsErrors, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueErrors, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsErrors, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsErrors, GetKeyMetricsResponses, GetRevenueData, GetRevenueErrors, GetRevenueResponses, SetCustomersTagsData, SetCustomersTagsErrors, SetCustomersTagsResponses, SetKeyMetricsData, SetKeyMetricsErrors, SetKeyMetricsResponses, SetRevenueData, SetRevenueErrors, SetRevenueResponses } from './types.gen.js';
+import type { DeleteCustomersTagsData, DeleteCustomersTagsErrors, DeleteCustomersTagsResponses, DeleteKeyMetricsData, DeleteKeyMetricsErrors, DeleteKeyMetricsResponses, DeleteRevenueData, DeleteRevenueErrors, DeleteRevenueResponses, GetCustomersTagsData, GetCustomersTagsErrors, GetCustomersTagsResponses, GetKeyMetricsData, GetKeyMetricsErrors, GetKeyMetricsResponses, GetMarginData, GetMarginErrors, GetMarginResponses, GetRevenueData, GetRevenueErrors, GetRevenueResponses, SetCustomersTagsData, SetCustomersTagsErrors, SetCustomersTagsResponses, SetKeyMetricsData, SetKeyMetricsErrors, SetKeyMetricsResponses, SetRevenueData, SetRevenueErrors, SetRevenueResponses } from './types.gen.js';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
     /**
@@ -18,6 +18,15 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
     meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
 };
 
+/**
+ * Per-customer gross margin, sorted by customer_name ascending; pass customer_names to narrow to specific customers, omit it for every customer's.
+ */
+export const getMargin = <ThrowOnError extends boolean = false>(options?: Options<GetMarginData, ThrowOnError>): RequestResult<GetMarginResponses, GetMarginErrors, ThrowOnError> => (options?.client ?? client).get<GetMarginResponses, GetMarginErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/margin/',
+    ...options
+});
+
 /**
  * Delete the given customers' API-uploaded revenue values.
  */

package/src/api/generated/types.gen.ts

@@ -36,6 +36,38 @@ export type ApiErrorOutput = {
     error: string;
 };
 
+/**
+ * CustomerMarginRow
+ *
+ * One customer's gross margin for a period.
+ */
+export type CustomerMarginRow = {
+    /**
+     * Customer Name
+     */
+    customer_name: string;
+    /**
+     * Revenue
+     */
+    revenue: number;
+    /**
+     * Cost
+     */
+    cost: number;
+    /**
+     * Margin
+     */
+    margin: number;
+    /**
+     * Margin Pct
+     */
+    margin_pct: number | null;
+    /**
+     * Profitability Status
+     */
+    profitability_status: 'healthy' | 'watch' | 'at_risk' | 'unprofitable' | 'unknown';
+};
+
 /**
  * CustomerTags
  *
@@ -212,6 +244,27 @@ export type KeyMetricRowOutput = {
     user_name: string;
 };
 
+/**
+ * MarginListOutput
+ *
+ * Margin GET response: one row per customer with booked revenue, sorted by
+ * customer_name ascending.
+ */
+export type MarginListOutput = {
+    /**
+     * Rows
+     */
+    rows: Array<CustomerMarginRow>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+    /**
+     * Has More
+     */
+    has_more: boolean;
+};
+
 /**
  * RevenueOrKeyMetricDeletedRowOutput
  *
@@ -407,6 +460,57 @@ export type TagsDeletedOutput = {
     tags_deleted: number;
 };
 
+export type GetMarginData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Return only these customers' margin. Omit to return every customer's.
+         */
+        customer_names?: Array<string>;
+        /**
+         * Opaque cursor from a previous page's next_cursor.
+         */
+        cursor?: string;
+        limit?: number;
+        /**
+         * Start of the period (inclusive), YYYY-MM-DD. Defaults to 30 days ago.
+         */
+        date_from?: string;
+        /**
+         * End of the period (inclusive), YYYY-MM-DD. Defaults to today.
+         */
+        date_to?: string;
+        /**
+         * Apply free-credit discounts to cost. Defaults to false.
+         */
+        apply_credits?: boolean;
+    };
+    url: '/margin/';
+};
+
+export type GetMarginErrors = {
+    /**
+     * Invalid request for this project type.
+     */
+    400: ApiErrorOutput;
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+};
+
+export type GetMarginError = GetMarginErrors[keyof GetMarginErrors];
+
+export type GetMarginResponses = {
+    /**
+     * Success.
+     */
+    200: MarginListOutput;
+};
+
+export type GetMarginResponse = GetMarginResponses[keyof GetMarginResponses];
+
 export type DeleteRevenueData = {
     body?: never;
     path?: never;
@@ -454,7 +558,7 @@ export type GetRevenueData = {
     path?: never;
     query?: {
         /**
-         * Return only these customers' revenue (repeat the param for several). Omit to return every customer's.
+         * Return only these customers' revenue. Omit to return every customer's.
          */
         customer_names?: Array<string>;
         /**
@@ -560,7 +664,7 @@ export type GetKeyMetricsData = {
     path?: never;
     query?: {
         /**
-         * Return only these users' key metrics (repeat the param for several). Omit to return every user's.
+         * Return only these users' key metrics. Omit to return every user's.
          */
         user_names?: Array<string>;
         /**
@@ -624,7 +728,7 @@ export type DeleteCustomersTagsData = {
     path?: never;
     query: {
         /**
-         * Delete every tag of these customers (repeat the param for several).
+         * Delete every tag of these customers.
          */
         customer_names: Array<string>;
     };

package/tests/api/index.test.js

@@ -274,6 +274,82 @@ test('deleteKeyMetrics sends the userNames filter and parses the deleted count',
   });
 });
 
+// ── Margin ────────────────────────────────────────────────────────────────────
+
+test('getMargin parses the returned rows into camelCase', async () => {
+  const wireRow = {
+    customer_name: 'c_1',
+    revenue: 1000.0,
+    cost: 200.0,
+    margin: 800.0,
+    margin_pct: 80.0,
+    profitability_status: 'healthy',
+  };
+  await withClientReturning(
+    { rows: [wireRow], next_cursor: null, has_more: false },
+    200,
+    async (client) => {
+      const { data } = await api.getMargin({ client, throwOnError: true });
+      assert.deepEqual(data.rows, [
+        {
+          customerName: 'c_1',
+          revenue: 1000.0,
+          cost: 200.0,
+          margin: 800.0,
+          marginPct: 80.0,
+          profitabilityStatus: 'healthy',
+        },
+      ]);
+    }
+  );
+});
+
+test('getMargin sends the cursor and limit query params', async () => {
+  await withClientReturning(
+    { rows: [], next_cursor: 'Y19h', has_more: true },
+    200,
+    async (client, seenRequests) => {
+      const { data } = await api.getMargin({
+        client,
+        throwOnError: true,
+        query: { cursor: 'abc123', limit: 2 },
+      });
+      assert.equal(data.nextCursor, 'Y19h');
+      assert.equal(data.hasMore, true);
+      const query = new URL(seenRequests[0].url, 'http://x').searchParams;
+      assert.equal(query.get('cursor'), 'abc123');
+      assert.equal(query.get('limit'), '2');
+    }
+  );
+});
+
+test('getMargin sends the customerNames filter as repeated params', async () => {
+  await withClientReturning({ rows: [] }, 200, async (client, seenRequests) => {
+    const { data } = await api.getMargin({
+      client,
+      throwOnError: true,
+      query: { customerNames: ['c_1', 'c_2'] },
+    });
+    assert.deepEqual(data, { rows: [] });
+    const query = new URL(seenRequests[0].url, 'http://x').searchParams;
+    assert.deepEqual(query.getAll('customer_names'), ['c_1', 'c_2']);
+  });
+});
+
+test('getMargin sends the dateFrom/dateTo/applyCredits filters in snake_case', async () => {
+  await withClientReturning({ rows: [] }, 200, async (client, seenRequests) => {
+    await api.getMargin({
+      client,
+      throwOnError: true,
+      query: { dateFrom: '2026-06-01', dateTo: '2026-06-30', applyCredits: true },
+    });
+    const query = new URL(seenRequests[0].url, 'http://x').searchParams;
+    assert.equal(query.get('date_from'), '2026-06-01');
+    assert.equal(query.get('date_to'), '2026-06-30');
+    assert.equal(query.get('apply_credits'), 'true');
+  });
+});
+
 // ── Customer tags ─────────────────────────────────────────────────────────────
 
 test('setCustomersTags posts the customers in snake_case and parses the updated count', async () => {