weflayr 0.22.1 → 0.23.0

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

@@ -7,11 +7,23 @@ import * as generated from './sdk.gen.js';
 import type * as generatedTypes from './types.gen.js';
 
 
-export const getAllRevenue = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.GetAllRevenueData, 'url'>>,
-  CamelCaseDeep<generatedTypes.GetAllRevenueResponse>,
-  CamelCaseDeep<generatedTypes.GetAllRevenueError>
->(generated.getAllRevenue);
+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>,
+  CamelCaseDeep<generatedTypes.DeleteRevenueError>
+>(generated.deleteRevenue);
+
+export const getRevenue = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.GetRevenueData, 'url'>>,
+  CamelCaseDeep<generatedTypes.GetRevenueResponse>,
+  CamelCaseDeep<generatedTypes.GetRevenueError>
+>(generated.getRevenue);
 
 export const setRevenue = makeEndpoint<
   CamelCaseDeep<Omit<generatedTypes.SetRevenueData, 'url'>>,
@@ -19,23 +31,17 @@ export const setRevenue = makeEndpoint<
   CamelCaseDeep<generatedTypes.SetRevenueError>
 >(generated.setRevenue);
 
-export const deleteCustomerRevenue = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.DeleteCustomerRevenueData, 'url'>>,
-  CamelCaseDeep<generatedTypes.DeleteCustomerRevenueResponse>,
-  CamelCaseDeep<generatedTypes.DeleteCustomerRevenueError>
->(generated.deleteCustomerRevenue);
-
-export const getCustomerRevenue = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.GetCustomerRevenueData, 'url'>>,
-  CamelCaseDeep<generatedTypes.GetCustomerRevenueResponse>,
-  CamelCaseDeep<generatedTypes.GetCustomerRevenueError>
->(generated.getCustomerRevenue);
+export const deleteKeyMetrics = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.DeleteKeyMetricsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.DeleteKeyMetricsResponse>,
+  CamelCaseDeep<generatedTypes.DeleteKeyMetricsError>
+>(generated.deleteKeyMetrics);
 
-export const getAllKeyMetrics = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.GetAllKeyMetricsData, 'url'>>,
-  CamelCaseDeep<generatedTypes.GetAllKeyMetricsResponse>,
-  CamelCaseDeep<generatedTypes.GetAllKeyMetricsError>
->(generated.getAllKeyMetrics);
+export const getKeyMetrics = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.GetKeyMetricsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.GetKeyMetricsResponse>,
+  CamelCaseDeep<generatedTypes.GetKeyMetricsError>
+>(generated.getKeyMetrics);
 
 export const setKeyMetrics = makeEndpoint<
   CamelCaseDeep<Omit<generatedTypes.SetKeyMetricsData, 'url'>>,
@@ -43,38 +49,20 @@ export const setKeyMetrics = makeEndpoint<
   CamelCaseDeep<generatedTypes.SetKeyMetricsError>
 >(generated.setKeyMetrics);
 
-export const deleteUserKeyMetrics = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.DeleteUserKeyMetricsData, 'url'>>,
-  CamelCaseDeep<generatedTypes.DeleteUserKeyMetricsResponse>,
-  CamelCaseDeep<generatedTypes.DeleteUserKeyMetricsError>
->(generated.deleteUserKeyMetrics);
+export const deleteCustomersTags = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.DeleteCustomersTagsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.DeleteCustomersTagsResponse>,
+  CamelCaseDeep<generatedTypes.DeleteCustomersTagsError>
+>(generated.deleteCustomersTags);
 
-export const getUserKeyMetrics = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.GetUserKeyMetricsData, 'url'>>,
-  CamelCaseDeep<generatedTypes.GetUserKeyMetricsResponse>,
-  CamelCaseDeep<generatedTypes.GetUserKeyMetricsError>
->(generated.getUserKeyMetrics);
-
-export const getAllCustomersTags = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.GetAllCustomersTagsData, 'url'>>,
-  CamelCaseDeep<generatedTypes.GetAllCustomersTagsResponse>,
-  CamelCaseDeep<generatedTypes.GetAllCustomersTagsError>
->(generated.getAllCustomersTags);
+export const getCustomersTags = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.GetCustomersTagsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.GetCustomersTagsResponse>,
+  CamelCaseDeep<generatedTypes.GetCustomersTagsError>
+>(generated.getCustomersTags);
 
 export const setCustomersTags = makeEndpoint<
   CamelCaseDeep<Omit<generatedTypes.SetCustomersTagsData, 'url'>>,
   CamelCaseDeep<generatedTypes.SetCustomersTagsResponse>,
   CamelCaseDeep<generatedTypes.SetCustomersTagsError>
 >(generated.setCustomersTags);
-
-export const deleteCustomerTags = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.DeleteCustomerTagsData, 'url'>>,
-  CamelCaseDeep<generatedTypes.DeleteCustomerTagsResponse>,
-  CamelCaseDeep<generatedTypes.DeleteCustomerTagsError>
->(generated.deleteCustomerTags);
-
-export const getCustomerTags = makeEndpoint<
-  CamelCaseDeep<Omit<generatedTypes.GetCustomerTagsData, 'url'>>,
-  CamelCaseDeep<generatedTypes.GetCustomerTagsResponse>,
-  CamelCaseDeep<generatedTypes.GetCustomerTagsError>
->(generated.getCustomerTags);

package/src/api/generated/index.ts

@@ -1,4 +1,4 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export { deleteCustomerRevenue, deleteCustomerTags, deleteUserKeyMetrics, getAllCustomersTags, getAllKeyMetrics, getAllRevenue, getCustomerRevenue, getCustomerTags, getUserKeyMetrics, type Options, setCustomersTags, setKeyMetrics, setRevenue } from './sdk.gen.js';
-export type { AllCustomerTagsOutput, ApiErrorOutput, ClientOptions, CustomersUpdatedOutput, CustomerTags, CustomerTagsOutput, DeleteCustomerRevenueData, DeleteCustomerRevenueError, DeleteCustomerRevenueErrors, DeleteCustomerRevenueResponse, DeleteCustomerRevenueResponses, DeleteCustomerTagsData, DeleteCustomerTagsError, DeleteCustomerTagsErrors, DeleteCustomerTagsResponse, DeleteCustomerTagsResponses, DeleteUserKeyMetricsData, DeleteUserKeyMetricsError, DeleteUserKeyMetricsErrors, DeleteUserKeyMetricsResponse, DeleteUserKeyMetricsResponses, GetAllCustomersTagsData, GetAllCustomersTagsError, GetAllCustomersTagsErrors, GetAllCustomersTagsResponse, GetAllCustomersTagsResponses, GetAllKeyMetricsData, GetAllKeyMetricsError, GetAllKeyMetricsErrors, GetAllKeyMetricsResponse, GetAllKeyMetricsResponses, GetAllRevenueData, GetAllRevenueError, GetAllRevenueErrors, GetAllRevenueResponse, GetAllRevenueResponses, GetCustomerRevenueData, GetCustomerRevenueError, GetCustomerRevenueErrors, GetCustomerRevenueResponse, GetCustomerRevenueResponses, GetCustomerTagsData, GetCustomerTagsError, GetCustomerTagsErrors, GetCustomerTagsResponse, GetCustomerTagsResponses, GetUserKeyMetricsData, GetUserKeyMetricsError, GetUserKeyMetricsErrors, GetUserKeyMetricsResponse, GetUserKeyMetricsResponses, 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 { DeleteCustomerRevenueData, DeleteCustomerRevenueErrors, DeleteCustomerRevenueResponses, DeleteCustomerTagsData, DeleteCustomerTagsErrors, DeleteCustomerTagsResponses, DeleteUserKeyMetricsData, DeleteUserKeyMetricsErrors, DeleteUserKeyMetricsResponses, GetAllCustomersTagsData, GetAllCustomersTagsErrors, GetAllCustomersTagsResponses, GetAllKeyMetricsData, GetAllKeyMetricsErrors, GetAllKeyMetricsResponses, GetAllRevenueData, GetAllRevenueErrors, GetAllRevenueResponses, GetCustomerRevenueData, GetCustomerRevenueErrors, GetCustomerRevenueResponses, GetCustomerTagsData, GetCustomerTagsErrors, GetCustomerTagsResponses, GetUserKeyMetricsData, GetUserKeyMetricsErrors, GetUserKeyMetricsResponses, 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> & {
     /**
@@ -19,9 +19,27 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
 };
 
 /**
- * Every revenue value of the project, one row per booked value.
+ * 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 getAllRevenue = <ThrowOnError extends boolean = false>(options?: Options<GetAllRevenueData, ThrowOnError>): RequestResult<GetAllRevenueResponses, GetAllRevenueErrors, ThrowOnError> => (options?.client ?? client).get<GetAllRevenueResponses, GetAllRevenueErrors, ThrowOnError>({
+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.
+ */
+export const deleteRevenue = <ThrowOnError extends boolean = false>(options: Options<DeleteRevenueData, ThrowOnError>): RequestResult<DeleteRevenueResponses, DeleteRevenueErrors, ThrowOnError> => (options.client ?? client).delete<DeleteRevenueResponses, DeleteRevenueErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/revenue/',
+    ...options
+});
+
+/**
+ * The project's revenue values, one row per booked value; pass customer_names to narrow to specific customers, omit it for every customer's.
+ */
+export const getRevenue = <ThrowOnError extends boolean = false>(options?: Options<GetRevenueData, ThrowOnError>): RequestResult<GetRevenueResponses, GetRevenueErrors, ThrowOnError> => (options?.client ?? client).get<GetRevenueResponses, GetRevenueErrors, ThrowOnError>({
     security: [{ scheme: 'bearer', type: 'http' }],
     url: '/revenue/',
     ...options
@@ -41,27 +59,18 @@ export const setRevenue = <ThrowOnError extends boolean = false>(options: Option
 });
 
 /**
- * Delete one customer's API-uploaded revenue values.
- */
-export const deleteCustomerRevenue = <ThrowOnError extends boolean = false>(options: Options<DeleteCustomerRevenueData, ThrowOnError>): RequestResult<DeleteCustomerRevenueResponses, DeleteCustomerRevenueErrors, ThrowOnError> => (options.client ?? client).delete<DeleteCustomerRevenueResponses, DeleteCustomerRevenueErrors, ThrowOnError>({
-    security: [{ scheme: 'bearer', type: 'http' }],
-    url: '/revenue/{customer_name}/',
-    ...options
-});
-
-/**
- * One customer's revenue values; 404 when none are booked.
+ * Delete the given users' API-uploaded key-metric values.
  */
-export const getCustomerRevenue = <ThrowOnError extends boolean = false>(options: Options<GetCustomerRevenueData, ThrowOnError>): RequestResult<GetCustomerRevenueResponses, GetCustomerRevenueErrors, ThrowOnError> => (options.client ?? client).get<GetCustomerRevenueResponses, GetCustomerRevenueErrors, ThrowOnError>({
+export const deleteKeyMetrics = <ThrowOnError extends boolean = false>(options: Options<DeleteKeyMetricsData, ThrowOnError>): RequestResult<DeleteKeyMetricsResponses, DeleteKeyMetricsErrors, ThrowOnError> => (options.client ?? client).delete<DeleteKeyMetricsResponses, DeleteKeyMetricsErrors, ThrowOnError>({
     security: [{ scheme: 'bearer', type: 'http' }],
-    url: '/revenue/{customer_name}/',
+    url: '/key-metrics/',
     ...options
 });
 
 /**
- * Every key-metric value of the project, one row per booked value.
+ * The project's key-metric values, one row per booked value; pass user_names to narrow to specific users, omit it for every user's.
  */
-export const getAllKeyMetrics = <ThrowOnError extends boolean = false>(options?: Options<GetAllKeyMetricsData, ThrowOnError>): RequestResult<GetAllKeyMetricsResponses, GetAllKeyMetricsErrors, ThrowOnError> => (options?.client ?? client).get<GetAllKeyMetricsResponses, GetAllKeyMetricsErrors, ThrowOnError>({
+export const getKeyMetrics = <ThrowOnError extends boolean = false>(options?: Options<GetKeyMetricsData, ThrowOnError>): RequestResult<GetKeyMetricsResponses, GetKeyMetricsErrors, ThrowOnError> => (options?.client ?? client).get<GetKeyMetricsResponses, GetKeyMetricsErrors, ThrowOnError>({
     security: [{ scheme: 'bearer', type: 'http' }],
     url: '/key-metrics/',
     ...options
@@ -81,27 +90,18 @@ export const setKeyMetrics = <ThrowOnError extends boolean = false>(options: Opt
 });
 
 /**
- * Delete one user's API-uploaded key-metric values.
+ * Delete every tag of the given customers.
  */
-export const deleteUserKeyMetrics = <ThrowOnError extends boolean = false>(options: Options<DeleteUserKeyMetricsData, ThrowOnError>): RequestResult<DeleteUserKeyMetricsResponses, DeleteUserKeyMetricsErrors, ThrowOnError> => (options.client ?? client).delete<DeleteUserKeyMetricsResponses, DeleteUserKeyMetricsErrors, ThrowOnError>({
+export const deleteCustomersTags = <ThrowOnError extends boolean = false>(options: Options<DeleteCustomersTagsData, ThrowOnError>): RequestResult<DeleteCustomersTagsResponses, DeleteCustomersTagsErrors, ThrowOnError> => (options.client ?? client).delete<DeleteCustomersTagsResponses, DeleteCustomersTagsErrors, ThrowOnError>({
     security: [{ scheme: 'bearer', type: 'http' }],
-    url: '/key-metrics/{user_name}/',
-    ...options
-});
-
-/**
- * One user's key-metric values; 404 when none are booked.
- */
-export const getUserKeyMetrics = <ThrowOnError extends boolean = false>(options: Options<GetUserKeyMetricsData, ThrowOnError>): RequestResult<GetUserKeyMetricsResponses, GetUserKeyMetricsErrors, ThrowOnError> => (options.client ?? client).get<GetUserKeyMetricsResponses, GetUserKeyMetricsErrors, ThrowOnError>({
-    security: [{ scheme: 'bearer', type: 'http' }],
-    url: '/key-metrics/{user_name}/',
+    url: '/customer-tags/',
     ...options
 });
 
 /**
- * Every known customer of the project with its tags (possibly empty).
+ * Every known customer of the project with its tags (possibly empty); pass customer_names to narrow to specific customers, omit it for every customer's.
  */
-export const getAllCustomersTags = <ThrowOnError extends boolean = false>(options?: Options<GetAllCustomersTagsData, ThrowOnError>): RequestResult<GetAllCustomersTagsResponses, GetAllCustomersTagsErrors, ThrowOnError> => (options?.client ?? client).get<GetAllCustomersTagsResponses, GetAllCustomersTagsErrors, ThrowOnError>({
+export const getCustomersTags = <ThrowOnError extends boolean = false>(options?: Options<GetCustomersTagsData, ThrowOnError>): RequestResult<GetCustomersTagsResponses, GetCustomersTagsErrors, ThrowOnError> => (options?.client ?? client).get<GetCustomersTagsResponses, GetCustomersTagsErrors, ThrowOnError>({
     security: [{ scheme: 'bearer', type: 'http' }],
     url: '/customer-tags/',
     ...options
@@ -119,21 +119,3 @@ export const setCustomersTags = <ThrowOnError extends boolean = false>(options:
         ...options.headers
     }
 });
-
-/**
- * Delete every tag of one customer; 404 for a customer Weflayr has never seen.
- */
-export const deleteCustomerTags = <ThrowOnError extends boolean = false>(options: Options<DeleteCustomerTagsData, ThrowOnError>): RequestResult<DeleteCustomerTagsResponses, DeleteCustomerTagsErrors, ThrowOnError> => (options.client ?? client).delete<DeleteCustomerTagsResponses, DeleteCustomerTagsErrors, ThrowOnError>({
-    security: [{ scheme: 'bearer', type: 'http' }],
-    url: '/customer-tags/{customer_name}/',
-    ...options
-});
-
-/**
- * One customer's tags; 404 for a customer Weflayr has never seen.
- */
-export const getCustomerTags = <ThrowOnError extends boolean = false>(options: Options<GetCustomerTagsData, ThrowOnError>): RequestResult<GetCustomerTagsResponses, GetCustomerTagsErrors, ThrowOnError> => (options.client ?? client).get<GetCustomerTagsResponses, GetCustomerTagsErrors, ThrowOnError>({
-    security: [{ scheme: 'bearer', type: 'http' }],
-    url: '/customer-tags/{customer_name}/',
-    ...options
-});