weflayr 0.22.0 → 0.22.2

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

@@ -0,0 +1,652 @@
+export type ClientOptions = {
+    baseUrl: 'https://app.weflayr.com/api' | (string & {});
+};
+/**
+ * AllCustomerTagsOutput
+ *
+ * The customer-tags GET response: every known customer of the project.
+ */
+export type AllCustomerTagsOutput = {
+    /**
+     * Customers
+     */
+    customers: Array<CustomerTagsOutput>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+    /**
+     * Has More
+     */
+    has_more: boolean;
+};
+/**
+ * ApiErrorOutput
+ *
+ * A refusal with a single human-readable message (401 and 404 bodies).
+ */
+export type ApiErrorOutput = {
+    /**
+     * Error
+     */
+    error: string;
+};
+/**
+ * CustomerTags
+ *
+ * One customer's tag updates: a string value sets the tag, null deletes it.
+ */
+export type CustomerTags = {
+    /**
+     * Customer Name
+     */
+    customer_name: string;
+    /**
+     * Tags
+     */
+    tags: {
+        [key: string]: string | null;
+    };
+};
+/**
+ * CustomerTagsOutput
+ *
+ * One customer with its tags (possibly empty).
+ */
+export type CustomerTagsOutput = {
+    /**
+     * Customer Name
+     */
+    customer_name: string;
+    /**
+     * Tags
+     */
+    tags: {
+        [key: string]: string;
+    };
+};
+/**
+ * CustomersUpdatedOutput
+ *
+ * A successful tags upsert: how many customers were touched.
+ */
+export type CustomersUpdatedOutput = {
+    /**
+     * Ok
+     */
+    ok: boolean;
+    /**
+     * Customers Updated
+     */
+    customers_updated: number;
+};
+/**
+ * InvalidFieldDetail
+ *
+ * One offending field of a rejected payload.
+ */
+export type InvalidFieldDetail = {
+    /**
+     * Field
+     */
+    field: string;
+    /**
+     * Error
+     */
+    error: string;
+};
+/**
+ * InvalidPayloadOutput
+ *
+ * The all-or-nothing 422 body: every offending field, nothing written.
+ */
+export type InvalidPayloadOutput = {
+    /**
+     * Error
+     */
+    error: string;
+    /**
+     * Detail
+     */
+    detail: Array<InvalidFieldDetail>;
+};
+/**
+ * KeyMetricOutput
+ *
+ * A key-metric GET response: one row per booked value.
+ */
+export type KeyMetricOutput = {
+    /**
+     * Rows
+     */
+    rows: Array<KeyMetricRowOutput>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+    /**
+     * Has More
+     */
+    has_more: boolean;
+};
+/**
+ * KeyMetricRow
+ *
+ * One booked key-metric value: the user, the metric, the amount, and
+ * either its month or the month_start/month_end period it should be split
+ * across.
+ */
+export type KeyMetricRow = {
+    /**
+     * Metric Id
+     *
+     * Your own id for this value. Omit it to book a new value; reuse a previous one to update it (needs "upsert": true, see the "upsert" field).
+     */
+    metric_id?: string | null;
+    /**
+     * User Name
+     */
+    user_name: string;
+    /**
+     * Metric Name
+     */
+    metric_name: string;
+    /**
+     * Amount
+     */
+    amount: number;
+    /**
+     * Month
+     */
+    month?: string | null;
+    /**
+     * Month Start
+     */
+    month_start?: string | null;
+    /**
+     * Month End
+     */
+    month_end?: string | null;
+};
+/**
+ * KeyMetricRowOutput
+ *
+ * One booked key-metric value.
+ */
+export type KeyMetricRowOutput = {
+    /**
+     * Metric Name
+     */
+    metric_name: string;
+    /**
+     * Month
+     */
+    month: string;
+    /**
+     * Amount
+     */
+    amount: number;
+    /**
+     * Source
+     */
+    source: string;
+    /**
+     * Metric Id
+     */
+    metric_id: string;
+    /**
+     * User Name
+     */
+    user_name: string;
+};
+/**
+ * RevenueOrKeyMetricDeletedRowOutput
+ *
+ * A successful values deletion: how many rows were removed.
+ */
+export type RevenueOrKeyMetricDeletedRowOutput = {
+    /**
+     * Ok
+     */
+    ok: boolean;
+    /**
+     * Rows Deleted
+     */
+    rows_deleted: number;
+};
+/**
+ * RevenueOrKeyMetricImportedRowOutput
+ *
+ * A successful values upsert: how many rows were imported.
+ */
+export type RevenueOrKeyMetricImportedRowOutput = {
+    /**
+     * Ok
+     */
+    ok: boolean;
+    /**
+     * Rows Inserted
+     */
+    rows_inserted: number;
+};
+/**
+ * RevenueOutput
+ *
+ * A revenue GET response: one row per booked value.
+ */
+export type RevenueOutput = {
+    /**
+     * Rows
+     */
+    rows: Array<RevenueRowOutput>;
+    /**
+     * Next Cursor
+     */
+    next_cursor: string | null;
+    /**
+     * Has More
+     */
+    has_more: boolean;
+};
+/**
+ * RevenueRow
+ *
+ * One booked revenue value: the customer, the amount, and either its
+ * month or the month_start/month_end period it should be split across.
+ */
+export type RevenueRow = {
+    /**
+     * Revenue Id
+     *
+     * Your own id for this value. Omit it to book a new value; reuse a previous one to update it (needs "upsert": true, see the "upsert" field).
+     */
+    revenue_id?: string | null;
+    /**
+     * Customer Name
+     */
+    customer_name: string;
+    /**
+     * Amount
+     */
+    amount: number;
+    /**
+     * Month
+     */
+    month?: string | null;
+    /**
+     * Month Start
+     */
+    month_start?: string | null;
+    /**
+     * Month End
+     */
+    month_end?: string | null;
+};
+/**
+ * RevenueRowOutput
+ *
+ * One booked revenue value.
+ */
+export type RevenueRowOutput = {
+    /**
+     * Metric Name
+     */
+    metric_name: string;
+    /**
+     * Month
+     */
+    month: string;
+    /**
+     * Amount
+     */
+    amount: number;
+    /**
+     * Source
+     */
+    source: string;
+    /**
+     * Revenue Id
+     */
+    revenue_id: string;
+    /**
+     * Customer Name
+     */
+    customer_name: string;
+};
+/**
+ * SetCustomerTagsInput
+ *
+ * The tag updates posted to the public API, one entry per customer.
+ */
+export type SetCustomerTagsInput = {
+    /**
+     * Customers
+     */
+    customers: Array<CustomerTags>;
+    /**
+     * Upsert
+     *
+     * If a customer's tag key already exists, overwrite it instead of rejecting the request.
+     */
+    upsert?: boolean;
+};
+/**
+ * SetKeyMetricsInput
+ *
+ * The key-metric values posted to the public API. A user may have
+ * several lines of the same metric in the same month; rows are only ever
+ * matched against each other by metric_id, never by (user, metric,
+ * month).
+ */
+export type SetKeyMetricsInput = {
+    /**
+     * Rows
+     */
+    rows: Array<KeyMetricRow>;
+    /**
+     * Upsert
+     *
+     * If a row's metric_id already exists, overwrite it instead of rejecting the request.
+     */
+    upsert?: boolean;
+};
+/**
+ * SetRevenueInput
+ *
+ * The revenue values posted to the public API. A customer may have several
+ * revenue lines in the same month (e.g. one per product or contract); rows
+ * are only ever matched against each other by revenue_id, never by
+ * (customer, month).
+ */
+export type SetRevenueInput = {
+    /**
+     * Rows
+     */
+    rows: Array<RevenueRow>;
+    /**
+     * Upsert
+     *
+     * If a row's revenue_id already exists, overwrite it instead of rejecting the request.
+     */
+    upsert?: boolean;
+};
+/**
+ * TagsDeletedOutput
+ *
+ * A successful tags deletion: how many tags were removed.
+ */
+export type TagsDeletedOutput = {
+    /**
+     * Ok
+     */
+    ok: boolean;
+    /**
+     * Tags Deleted
+     */
+    tags_deleted: number;
+};
+export type DeleteRevenueData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Delete these customers' API-booked revenue (repeat the param for several).
+         */
+        customer_names: Array<string>;
+        /**
+         * First month to delete (inclusive). Omit both bounds to delete every matching API-booked value.
+         */
+        month_start?: string;
+        /**
+         * Last month to delete (inclusive).
+         */
+        month_end?: string;
+    };
+    url: '/revenue/';
+};
+export type DeleteRevenueErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+    /**
+     * Invalid payload: every offending field is listed and nothing was written.
+     */
+    422: InvalidPayloadOutput;
+};
+export type DeleteRevenueError = DeleteRevenueErrors[keyof DeleteRevenueErrors];
+export type DeleteRevenueResponses = {
+    /**
+     * Success.
+     */
+    200: RevenueOrKeyMetricDeletedRowOutput;
+};
+export type DeleteRevenueResponse = DeleteRevenueResponses[keyof DeleteRevenueResponses];
+export type GetRevenueData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Return only these customers' revenue (repeat the param for several). Omit to return every customer's.
+         */
+        customer_names?: Array<string>;
+        /**
+         * Opaque cursor from a previous page's next_cursor.
+         */
+        cursor?: string;
+        limit?: number;
+    };
+    url: '/revenue/';
+};
+export type GetRevenueErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+};
+export type GetRevenueError = GetRevenueErrors[keyof GetRevenueErrors];
+export type GetRevenueResponses = {
+    /**
+     * Success.
+     */
+    200: RevenueOutput;
+};
+export type GetRevenueResponse = GetRevenueResponses[keyof GetRevenueResponses];
+export type SetRevenueData = {
+    body: SetRevenueInput;
+    path?: never;
+    query?: never;
+    url: '/revenue/';
+};
+export type SetRevenueErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+    /**
+     * Invalid payload: every offending field is listed and nothing was written.
+     */
+    422: InvalidPayloadOutput;
+};
+export type SetRevenueError = SetRevenueErrors[keyof SetRevenueErrors];
+export type SetRevenueResponses = {
+    /**
+     * Success.
+     */
+    200: RevenueOrKeyMetricImportedRowOutput;
+};
+export type SetRevenueResponse = SetRevenueResponses[keyof SetRevenueResponses];
+export type DeleteKeyMetricsData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Delete these users' API-booked key metrics (repeat the param for several).
+         */
+        user_names: Array<string>;
+        /**
+         * First month to delete (inclusive). Omit both bounds to delete every matching API-booked value.
+         */
+        month_start?: string;
+        /**
+         * Last month to delete (inclusive).
+         */
+        month_end?: string;
+    };
+    url: '/key-metrics/';
+};
+export type DeleteKeyMetricsErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+    /**
+     * Invalid payload: every offending field is listed and nothing was written.
+     */
+    422: InvalidPayloadOutput;
+};
+export type DeleteKeyMetricsError = DeleteKeyMetricsErrors[keyof DeleteKeyMetricsErrors];
+export type DeleteKeyMetricsResponses = {
+    /**
+     * Success.
+     */
+    200: RevenueOrKeyMetricDeletedRowOutput;
+};
+export type DeleteKeyMetricsResponse = DeleteKeyMetricsResponses[keyof DeleteKeyMetricsResponses];
+export type GetKeyMetricsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Return only these users' key metrics (repeat the param for several). Omit to return every user's.
+         */
+        user_names?: Array<string>;
+        /**
+         * Opaque cursor from a previous page's next_cursor.
+         */
+        cursor?: string;
+        limit?: number;
+    };
+    url: '/key-metrics/';
+};
+export type GetKeyMetricsErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+};
+export type GetKeyMetricsError = GetKeyMetricsErrors[keyof GetKeyMetricsErrors];
+export type GetKeyMetricsResponses = {
+    /**
+     * Success.
+     */
+    200: KeyMetricOutput;
+};
+export type GetKeyMetricsResponse = GetKeyMetricsResponses[keyof GetKeyMetricsResponses];
+export type SetKeyMetricsData = {
+    body: SetKeyMetricsInput;
+    path?: never;
+    query?: never;
+    url: '/key-metrics/';
+};
+export type SetKeyMetricsErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+    /**
+     * Invalid payload: every offending field is listed and nothing was written.
+     */
+    422: InvalidPayloadOutput;
+};
+export type SetKeyMetricsError = SetKeyMetricsErrors[keyof SetKeyMetricsErrors];
+export type SetKeyMetricsResponses = {
+    /**
+     * Success.
+     */
+    200: RevenueOrKeyMetricImportedRowOutput;
+};
+export type SetKeyMetricsResponse = SetKeyMetricsResponses[keyof SetKeyMetricsResponses];
+export type DeleteCustomersTagsData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Delete every tag of these customers (repeat the param for several).
+         */
+        customer_names: Array<string>;
+    };
+    url: '/customer-tags/';
+};
+export type DeleteCustomersTagsErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+    /**
+     * Invalid payload: every offending field is listed and nothing was written.
+     */
+    422: InvalidPayloadOutput;
+};
+export type DeleteCustomersTagsError = DeleteCustomersTagsErrors[keyof DeleteCustomersTagsErrors];
+export type DeleteCustomersTagsResponses = {
+    /**
+     * Success.
+     */
+    200: TagsDeletedOutput;
+};
+export type DeleteCustomersTagsResponse = DeleteCustomersTagsResponses[keyof DeleteCustomersTagsResponses];
+export type GetCustomersTagsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Return only these customers' tags. Omit to return every customer's.
+         */
+        customer_names?: Array<string>;
+        /**
+         * Opaque cursor from a previous page's next_cursor.
+         */
+        cursor?: string;
+        limit?: number;
+    };
+    url: '/customer-tags/';
+};
+export type GetCustomersTagsErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+};
+export type GetCustomersTagsError = GetCustomersTagsErrors[keyof GetCustomersTagsErrors];
+export type GetCustomersTagsResponses = {
+    /**
+     * Success.
+     */
+    200: AllCustomerTagsOutput;
+};
+export type GetCustomersTagsResponse = GetCustomersTagsResponses[keyof GetCustomersTagsResponses];
+export type SetCustomersTagsData = {
+    body: SetCustomerTagsInput;
+    path?: never;
+    query?: never;
+    url: '/customer-tags/';
+};
+export type SetCustomersTagsErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ApiErrorOutput;
+    /**
+     * Invalid payload: every offending field is listed and nothing was written.
+     */
+    422: InvalidPayloadOutput;
+};
+export type SetCustomersTagsError = SetCustomersTagsErrors[keyof SetCustomersTagsErrors];
+export type SetCustomersTagsResponses = {
+    /**
+     * Success.
+     */
+    200: CustomersUpdatedOutput;
+};
+export type SetCustomersTagsResponse = SetCustomersTagsResponses[keyof SetCustomersTagsResponses];

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

@@ -0,0 +1,3 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Entry point for the Weflayr public API (revenue, key metrics, customer tags).
+ *
+ * The endpoint functions and types under ./generated are produced from the
+ * platform's OpenAPI spec (`make generate-sdk-api-clients`) and speak the
+ * wire's snake_case, same as the Python SDK. generated/facade.gen.ts (also
+ * produced by that command, via scripts/generate_facade.mjs) wraps every
+ * endpoint so JS callers use camelCase instead - see ./caseConversion and
+ * ./makeEndpoint. This module is the handwritten front door that configures
+ * their client:
+ *
+ *     const weflayr = require('weflayr');
+ *
+ *     const apiClient = weflayr.client({ apiKey: 'wf-...' });
+ *     const { data } = await weflayr.api.getRevenue({ client: apiClient, throwOnError: true });
+ */
+import { type Client } from './generated/client';
+export declare const DEFAULT_BASE_URL = "https://app.weflayr.com/api";
+export interface ApiClientOptions {
+    /** A project API key, created in the Weflayr dashboard. Defaults to the `WEFLAYR_API_KEY` environment variable. */
+    apiKey?: string;
+    /** Where the API lives — override for local or self-hosted deployments. */
+    baseUrl?: string;
+}
+/** A client for the public API, authenticated with a project API key. */
+export declare function client(options?: ApiClientOptions): Client;
+export * from './generated/facade.gen';