weflayr 0.22.1 → 0.23.0

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
  *
@@ -149,11 +181,11 @@ export type KeyMetricOutput = {
  */
 export type KeyMetricRow = {
     /**
-     * User Defined Id
+     * 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).
      */
-    user_defined_id?: string | null;
+    metric_id?: string | null;
     /**
      * User Name
      */
@@ -165,7 +197,7 @@ export type KeyMetricRow = {
     /**
      * Amount
      */
-    amount: number | string;
+    amount: number;
     /**
      * Month
      */
@@ -186,10 +218,6 @@ export type KeyMetricRow = {
  * One booked key-metric value.
  */
 export type KeyMetricRowOutput = {
-    /**
-     * User Defined Id
-     */
-    user_defined_id: string;
     /**
      * Metric Name
      */
@@ -201,17 +229,42 @@ export type KeyMetricRowOutput = {
     /**
      * Amount
      */
-    amount: string;
+    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;
+};
+
 /**
  * RevenueOrKeyMetricDeletedRowOutput
  *
@@ -272,11 +325,11 @@ export type RevenueOutput = {
  */
 export type RevenueRow = {
     /**
-     * User Defined Id
+     * 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).
      */
-    user_defined_id?: string | null;
+    revenue_id?: string | null;
     /**
      * Customer Name
      */
@@ -284,7 +337,7 @@ export type RevenueRow = {
     /**
      * Amount
      */
-    amount: number | string;
+    amount: number;
     /**
      * Month
      */
@@ -305,10 +358,6 @@ export type RevenueRow = {
  * One booked revenue value.
  */
 export type RevenueRowOutput = {
-    /**
-     * User Defined Id
-     */
-    user_defined_id: string;
     /**
      * Metric Name
      */
@@ -320,11 +369,15 @@ export type RevenueRowOutput = {
     /**
      * Amount
      */
-    amount: string;
+    amount: number;
     /**
      * Source
      */
     source: string;
+    /**
+     * Revenue Id
+     */
+    revenue_id: string;
     /**
      * Customer Name
      */
@@ -354,7 +407,7 @@ export type SetCustomerTagsInput = {
  *
  * 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 user_defined_id, never by (user, metric,
+ * matched against each other by metric_id, never by (user, metric,
  * month).
  */
 export type SetKeyMetricsInput = {
@@ -365,7 +418,7 @@ export type SetKeyMetricsInput = {
     /**
      * Upsert
      *
-     * If a row's user_defined_id already exists, overwrite it instead of rejecting the request.
+     * If a row's metric_id already exists, overwrite it instead of rejecting the request.
      */
     upsert?: boolean;
 };
@@ -375,7 +428,7 @@ export type SetKeyMetricsInput = {
  *
  * 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 user_defined_id, never by
+ * are only ever matched against each other by revenue_id, never by
  * (customer, month).
  */
 export type SetRevenueInput = {
@@ -386,7 +439,7 @@ export type SetRevenueInput = {
     /**
      * Upsert
      *
-     * If a row's user_defined_id already exists, overwrite it instead of rejecting the request.
+     * If a row's revenue_id already exists, overwrite it instead of rejecting the request.
      */
     upsert?: boolean;
 };
@@ -407,45 +460,78 @@ export type TagsDeletedOutput = {
     tags_deleted: number;
 };
 
-export type GetAllRevenueData = {
+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: '/revenue/';
+    url: '/margin/';
 };
 
-export type GetAllRevenueErrors = {
+export type GetMarginErrors = {
+    /**
+     * Invalid request for this project type.
+     */
+    400: ApiErrorOutput;
     /**
      * Missing or invalid API key.
      */
     401: ApiErrorOutput;
 };
 
-export type GetAllRevenueError = GetAllRevenueErrors[keyof GetAllRevenueErrors];
+export type GetMarginError = GetMarginErrors[keyof GetMarginErrors];
 
-export type GetAllRevenueResponses = {
+export type GetMarginResponses = {
     /**
      * Success.
      */
-    200: RevenueOutput;
+    200: MarginListOutput;
 };
 
-export type GetAllRevenueResponse = GetAllRevenueResponses[keyof GetAllRevenueResponses];
+export type GetMarginResponse = GetMarginResponses[keyof GetMarginResponses];
 
-export type SetRevenueData = {
-    body: SetRevenueInput;
+export type DeleteRevenueData = {
+    body?: never;
     path?: never;
-    query?: 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 SetRevenueErrors = {
+export type DeleteRevenueErrors = {
     /**
      * Missing or invalid API key.
      */
@@ -456,36 +542,60 @@ export type SetRevenueErrors = {
     422: InvalidPayloadOutput;
 };
 
-export type SetRevenueError = SetRevenueErrors[keyof SetRevenueErrors];
+export type DeleteRevenueError = DeleteRevenueErrors[keyof DeleteRevenueErrors];
 
-export type SetRevenueResponses = {
+export type DeleteRevenueResponses = {
     /**
      * Success.
      */
-    200: RevenueOrKeyMetricImportedRowOutput;
+    200: RevenueOrKeyMetricDeletedRowOutput;
 };
 
-export type SetRevenueResponse = SetRevenueResponses[keyof SetRevenueResponses];
+export type DeleteRevenueResponse = DeleteRevenueResponses[keyof DeleteRevenueResponses];
 
-export type DeleteCustomerRevenueData = {
+export type GetRevenueData = {
     body?: never;
-    path: {
-        customer_name: string;
-    };
+    path?: never;
     query?: {
         /**
-         * First month to delete (inclusive). Omit both bounds to delete every matching API-booked value.
+         * Return only these customers' revenue. Omit to return every customer's.
          */
-        month_start?: string;
+        customer_names?: Array<string>;
         /**
-         * Last month to delete (inclusive).
+         * Opaque cursor from a previous page's next_cursor.
          */
-        month_end?: string;
+        cursor?: string;
+        limit?: number;
     };
-    url: '/revenue/{customer_name}/';
+    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 DeleteCustomerRevenueErrors = {
+export type SetRevenueErrors = {
     /**
      * Missing or invalid API key.
      */
@@ -496,52 +606,67 @@ export type DeleteCustomerRevenueErrors = {
     422: InvalidPayloadOutput;
 };
 
-export type DeleteCustomerRevenueError = DeleteCustomerRevenueErrors[keyof DeleteCustomerRevenueErrors];
+export type SetRevenueError = SetRevenueErrors[keyof SetRevenueErrors];
 
-export type DeleteCustomerRevenueResponses = {
+export type SetRevenueResponses = {
     /**
      * Success.
      */
-    200: RevenueOrKeyMetricDeletedRowOutput;
+    200: RevenueOrKeyMetricImportedRowOutput;
 };
 
-export type DeleteCustomerRevenueResponse = DeleteCustomerRevenueResponses[keyof DeleteCustomerRevenueResponses];
+export type SetRevenueResponse = SetRevenueResponses[keyof SetRevenueResponses];
 
-export type GetCustomerRevenueData = {
+export type DeleteKeyMetricsData = {
     body?: never;
-    path: {
-        customer_name: string;
+    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;
     };
-    query?: never;
-    url: '/revenue/{customer_name}/';
+    url: '/key-metrics/';
 };
 
-export type GetCustomerRevenueErrors = {
+export type DeleteKeyMetricsErrors = {
     /**
      * Missing or invalid API key.
      */
     401: ApiErrorOutput;
     /**
-     * Nothing exists for this customer.
+     * Invalid payload: every offending field is listed and nothing was written.
      */
-    404: ApiErrorOutput;
+    422: InvalidPayloadOutput;
 };
 
-export type GetCustomerRevenueError = GetCustomerRevenueErrors[keyof GetCustomerRevenueErrors];
+export type DeleteKeyMetricsError = DeleteKeyMetricsErrors[keyof DeleteKeyMetricsErrors];
 
-export type GetCustomerRevenueResponses = {
+export type DeleteKeyMetricsResponses = {
     /**
      * Success.
      */
-    200: RevenueOutput;
+    200: RevenueOrKeyMetricDeletedRowOutput;
 };
 
-export type GetCustomerRevenueResponse = GetCustomerRevenueResponses[keyof GetCustomerRevenueResponses];
+export type DeleteKeyMetricsResponse = DeleteKeyMetricsResponses[keyof DeleteKeyMetricsResponses];
 
-export type GetAllKeyMetricsData = {
+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.
          */
@@ -551,23 +676,23 @@ export type GetAllKeyMetricsData = {
     url: '/key-metrics/';
 };
 
-export type GetAllKeyMetricsErrors = {
+export type GetKeyMetricsErrors = {
     /**
      * Missing or invalid API key.
      */
     401: ApiErrorOutput;
 };
 
-export type GetAllKeyMetricsError = GetAllKeyMetricsErrors[keyof GetAllKeyMetricsErrors];
+export type GetKeyMetricsError = GetKeyMetricsErrors[keyof GetKeyMetricsErrors];
 
-export type GetAllKeyMetricsResponses = {
+export type GetKeyMetricsResponses = {
     /**
      * Success.
      */
     200: KeyMetricOutput;
 };
 
-export type GetAllKeyMetricsResponse = GetAllKeyMetricsResponses[keyof GetAllKeyMetricsResponses];
+export type GetKeyMetricsResponse = GetKeyMetricsResponses[keyof GetKeyMetricsResponses];
 
 export type SetKeyMetricsData = {
     body: SetKeyMetricsInput;
@@ -598,25 +723,19 @@ export type SetKeyMetricsResponses = {
 
 export type SetKeyMetricsResponse = SetKeyMetricsResponses[keyof SetKeyMetricsResponses];
 
-export type DeleteUserKeyMetricsData = {
+export type DeleteCustomersTagsData = {
     body?: never;
-    path: {
-        user_name: string;
-    };
-    query?: {
-        /**
-         * First month to delete (inclusive). Omit both bounds to delete every matching API-booked value.
-         */
-        month_start?: string;
+    path?: never;
+    query: {
         /**
-         * Last month to delete (inclusive).
+         * Delete every tag of these customers.
          */
-        month_end?: string;
+        customer_names: Array<string>;
     };
-    url: '/key-metrics/{user_name}/';
+    url: '/customer-tags/';
 };
 
-export type DeleteUserKeyMetricsErrors = {
+export type DeleteCustomersTagsErrors = {
     /**
      * Missing or invalid API key.
      */
@@ -627,52 +746,25 @@ export type DeleteUserKeyMetricsErrors = {
     422: InvalidPayloadOutput;
 };
 
-export type DeleteUserKeyMetricsError = DeleteUserKeyMetricsErrors[keyof DeleteUserKeyMetricsErrors];
-
-export type DeleteUserKeyMetricsResponses = {
-    /**
-     * Success.
-     */
-    200: RevenueOrKeyMetricDeletedRowOutput;
-};
-
-export type DeleteUserKeyMetricsResponse = DeleteUserKeyMetricsResponses[keyof DeleteUserKeyMetricsResponses];
-
-export type GetUserKeyMetricsData = {
-    body?: never;
-    path: {
-        user_name: string;
-    };
-    query?: never;
-    url: '/key-metrics/{user_name}/';
-};
-
-export type GetUserKeyMetricsErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-    /**
-     * Nothing exists for this customer.
-     */
-    404: ApiErrorOutput;
-};
-
-export type GetUserKeyMetricsError = GetUserKeyMetricsErrors[keyof GetUserKeyMetricsErrors];
+export type DeleteCustomersTagsError = DeleteCustomersTagsErrors[keyof DeleteCustomersTagsErrors];
 
-export type GetUserKeyMetricsResponses = {
+export type DeleteCustomersTagsResponses = {
     /**
      * Success.
      */
-    200: KeyMetricOutput;
+    200: TagsDeletedOutput;
 };
 
-export type GetUserKeyMetricsResponse = GetUserKeyMetricsResponses[keyof GetUserKeyMetricsResponses];
+export type DeleteCustomersTagsResponse = DeleteCustomersTagsResponses[keyof DeleteCustomersTagsResponses];
 
-export type GetAllCustomersTagsData = {
+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.
          */
@@ -682,23 +774,23 @@ export type GetAllCustomersTagsData = {
     url: '/customer-tags/';
 };
 
-export type GetAllCustomersTagsErrors = {
+export type GetCustomersTagsErrors = {
     /**
      * Missing or invalid API key.
      */
     401: ApiErrorOutput;
 };
 
-export type GetAllCustomersTagsError = GetAllCustomersTagsErrors[keyof GetAllCustomersTagsErrors];
+export type GetCustomersTagsError = GetCustomersTagsErrors[keyof GetCustomersTagsErrors];
 
-export type GetAllCustomersTagsResponses = {
+export type GetCustomersTagsResponses = {
     /**
      * Success.
      */
     200: AllCustomerTagsOutput;
 };
 
-export type GetAllCustomersTagsResponse = GetAllCustomersTagsResponses[keyof GetAllCustomersTagsResponses];
+export type GetCustomersTagsResponse = GetCustomersTagsResponses[keyof GetCustomersTagsResponses];
 
 export type SetCustomersTagsData = {
     body: SetCustomerTagsInput;
@@ -728,65 +820,3 @@ export type SetCustomersTagsResponses = {
 };
 
 export type SetCustomersTagsResponse = SetCustomersTagsResponses[keyof SetCustomersTagsResponses];
-
-export type DeleteCustomerTagsData = {
-    body?: never;
-    path: {
-        customer_name: string;
-    };
-    query?: never;
-    url: '/customer-tags/{customer_name}/';
-};
-
-export type DeleteCustomerTagsErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-    /**
-     * Nothing exists for this customer.
-     */
-    404: ApiErrorOutput;
-};
-
-export type DeleteCustomerTagsError = DeleteCustomerTagsErrors[keyof DeleteCustomerTagsErrors];
-
-export type DeleteCustomerTagsResponses = {
-    /**
-     * Success.
-     */
-    200: TagsDeletedOutput;
-};
-
-export type DeleteCustomerTagsResponse = DeleteCustomerTagsResponses[keyof DeleteCustomerTagsResponses];
-
-export type GetCustomerTagsData = {
-    body?: never;
-    path: {
-        customer_name: string;
-    };
-    query?: never;
-    url: '/customer-tags/{customer_name}/';
-};
-
-export type GetCustomerTagsErrors = {
-    /**
-     * Missing or invalid API key.
-     */
-    401: ApiErrorOutput;
-    /**
-     * Nothing exists for this customer.
-     */
-    404: ApiErrorOutput;
-};
-
-export type GetCustomerTagsError = GetCustomerTagsErrors[keyof GetCustomerTagsErrors];
-
-export type GetCustomerTagsResponses = {
-    /**
-     * Success.
-     */
-    200: CustomerTagsOutput;
-};
-
-export type GetCustomerTagsResponse = GetCustomerTagsResponses[keyof GetCustomerTagsResponses];

package/src/api/index.ts

@@ -12,7 +12,7 @@
  *     const weflayr = require('weflayr');
  *
  *     const apiClient = weflayr.client({ apiKey: 'wf-...' });
- *     const { data } = await weflayr.api.getAllRevenue({ client: apiClient, throwOnError: true });
+ *     const { data } = await weflayr.api.getRevenue({ client: apiClient, throwOnError: true });
  */
 
 import { type Client, createClient, createConfig } from './generated/client';