weflayr 0.24.0 → 0.26.1

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

@@ -1,1005 +0,0 @@
-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;
-};
-/**
- * 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';
-};
-/**
- * CustomerOutput
- *
- * One customer, with its tags when requested (an empty dict otherwise).
- */
-export type CustomerOutput = {
-    /**
-     * Customer Name
-     */
-    customer_name: string;
-    /**
-     * Customer Tags
-     */
-    customer_tags: {
-        [key: string]: 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;
-    };
-};
-/**
- * CustomersOutput
- *
- * The customers GET response: every known customer of the project.
- */
-export type CustomersOutput = {
-    /**
-     * Customers
-     */
-    customers: Array<CustomerOutput>;
-    /**
-     * Next Cursor
-     */
-    next_cursor: string | null;
-    /**
-     * Has More
-     */
-    has_more: boolean;
-};
-/**
- * CustomersUpdatedOutput
- *
- * A successful tags upsert: how many customers were touched.
- */
-export type CustomersUpdatedOutput = {
-    /**
-     * Ok
-     */
-    ok: boolean;
-    /**
-     * Customers Updated
-     */
-    customers_updated: number;
-};
-/**
- * FeaturesOutput
- *
- * A features GET response: every distinct feature tag seen for the project.
- */
-export type FeaturesOutput = {
-    /**
-     * Features
-     */
-    features: Array<string>;
-};
-/**
- * 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;
-};
-/**
- * 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;
-};
-/**
- * ModelsOutput
- *
- * A models GET response: every distinct model name seen for the project.
- */
-export type ModelsOutput = {
-    /**
-     * Models
-     */
-    models: Array<string>;
-};
-/**
- * ProjectOutput
- *
- * A project GET response: static identity of the project.
- */
-export type ProjectOutput = {
-    /**
-     * Name
-     */
-    name: string;
-    /**
-     * Project Type
-     */
-    project_type: 'revenue' | 'internal';
-    /**
-     * Key Metric Names
-     */
-    key_metric_names: Array<string>;
-    /**
-     * Environment
-     */
-    environment: 'dev' | 'pre-prod' | 'staging' | 'prod';
-    /**
-     * Created At
-     */
-    created_at: string;
-};
-/**
- * ProvidersOutput
- *
- * A providers GET response: every distinct provider name seen for the project.
- */
-export type ProvidersOutput = {
-    /**
-     * Providers
-     */
-    providers: Array<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;
-};
-/**
- * TagsOutput
- *
- * A tags GET response: facets of every tag dimension seen on the project.
- *
- * Either field is an empty dict when its include_* flag was false.
- */
-export type TagsOutput = {
-    /**
-     * Run Tags
-     */
-    run_tags: {
-        [key: string]: Array<string>;
-    };
-    /**
-     * Customer Tags
-     */
-    customer_tags: {
-        [key: string]: Array<string>;
-    };
-};
-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;
-    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. 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. 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.
-         */
-        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];
-export type GetProjectData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/project/';
-};
-export type GetProjectErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-};
-export type GetProjectError = GetProjectErrors[keyof GetProjectErrors];
-export type GetProjectResponses = {
-    /**
-     * Success.
-     */
-    200: ProjectOutput;
-};
-export type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
-export type GetTagsData = {
-    body?: never;
-    path?: never;
-    query?: {
-        /**
-         * Include run-tag facets. Defaults to true.
-         */
-        include_run_tags?: boolean;
-        /**
-         * Include customer-tag facets. Defaults to true.
-         */
-        include_customer_tags?: boolean;
-    };
-    url: '/tags/';
-};
-export type GetTagsErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-};
-export type GetTagsError = GetTagsErrors[keyof GetTagsErrors];
-export type GetTagsResponses = {
-    /**
-     * Success.
-     */
-    200: TagsOutput;
-};
-export type GetTagsResponse = GetTagsResponses[keyof GetTagsResponses];
-export type GetModelsData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/models/';
-};
-export type GetModelsErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-};
-export type GetModelsError = GetModelsErrors[keyof GetModelsErrors];
-export type GetModelsResponses = {
-    /**
-     * Success.
-     */
-    200: ModelsOutput;
-};
-export type GetModelsResponse = GetModelsResponses[keyof GetModelsResponses];
-export type GetProvidersData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/providers/';
-};
-export type GetProvidersErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-};
-export type GetProvidersError = GetProvidersErrors[keyof GetProvidersErrors];
-export type GetProvidersResponses = {
-    /**
-     * Success.
-     */
-    200: ProvidersOutput;
-};
-export type GetProvidersResponse = GetProvidersResponses[keyof GetProvidersResponses];
-export type GetCustomersData = {
-    body?: never;
-    path?: never;
-    query?: {
-        /**
-         * Opaque cursor from a previous page's next_cursor.
-         */
-        cursor?: string;
-        limit?: number;
-        /**
-         * Include each customer's tags. Defaults to true.
-         */
-        include_customer_tags?: boolean;
-    };
-    url: '/customers/';
-};
-export type GetCustomersErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-};
-export type GetCustomersError = GetCustomersErrors[keyof GetCustomersErrors];
-export type GetCustomersResponses = {
-    /**
-     * Success.
-     */
-    200: CustomersOutput;
-};
-export type GetCustomersResponse = GetCustomersResponses[keyof GetCustomersResponses];
-export type GetFeaturesData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/features/';
-};
-export type GetFeaturesErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-};
-export type GetFeaturesError = GetFeaturesErrors[keyof GetFeaturesErrors];
-export type GetFeaturesResponses = {
-    /**
-     * Success.
-     */
-    200: FeaturesOutput;
-};
-export type GetFeaturesResponse = GetFeaturesResponses[keyof GetFeaturesResponses];