weflayr 0.22.0 → 0.22.1

package/src/api/generated/core/utils.gen.ts

@@ -0,0 +1,140 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js';
+import {
+  type ArraySeparatorStyle,
+  serializeArrayParam,
+  serializeObjectParam,
+  serializePrimitiveParam,
+} from './pathSerializer.gen.js';
+
+export interface PathSerializer {
+  path: Record<string, unknown>;
+  url: string;
+}
+
+export const PATH_PARAM_RE: RegExp = /\{[^{}]+\}/g;
+
+export const defaultPathSerializer = ({ path, url: _url }: PathSerializer): string => {
+  let url = _url;
+  const matches = _url.match(PATH_PARAM_RE);
+  if (matches) {
+    for (const match of matches) {
+      let explode = false;
+      let name = match.substring(1, match.length - 1);
+      let style: ArraySeparatorStyle = 'simple';
+
+      if (name.endsWith('*')) {
+        explode = true;
+        name = name.substring(0, name.length - 1);
+      }
+
+      if (name.startsWith('.')) {
+        name = name.substring(1);
+        style = 'label';
+      } else if (name.startsWith(';')) {
+        name = name.substring(1);
+        style = 'matrix';
+      }
+
+      const value = path[name];
+
+      if (value === undefined || value === null) {
+        continue;
+      }
+
+      if (Array.isArray(value)) {
+        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
+        continue;
+      }
+
+      if (typeof value === 'object') {
+        url = url.replace(
+          match,
+          serializeObjectParam({
+            explode,
+            name,
+            style,
+            value: value as Record<string, unknown>,
+            valueOnly: true,
+          }),
+        );
+        continue;
+      }
+
+      if (style === 'matrix') {
+        url = url.replace(
+          match,
+          `;${serializePrimitiveParam({
+            name,
+            value: value as string,
+          })}`,
+        );
+        continue;
+      }
+
+      const replaceValue = encodeURIComponent(
+        style === 'label' ? `.${value as string}` : (value as string),
+      );
+      url = url.replace(match, replaceValue);
+    }
+  }
+  return url;
+};
+
+export const getUrl = ({
+  baseUrl,
+  path,
+  query,
+  querySerializer,
+  url: _url,
+}: {
+  baseUrl?: string;
+  path?: Record<string, unknown>;
+  query?: Record<string, unknown>;
+  querySerializer: QuerySerializer;
+  url: string;
+}): string => {
+  const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
+  let url = (baseUrl ?? '') + pathUrl;
+  if (path) {
+    url = defaultPathSerializer({ path, url });
+  }
+  let search = query ? querySerializer(query) : '';
+  if (search.startsWith('?')) {
+    search = search.substring(1);
+  }
+  if (search) {
+    url += `?${search}`;
+  }
+  return url;
+};
+
+export function getValidRequestBody(options: {
+  body?: unknown;
+  bodySerializer?: BodySerializer | null;
+  serializedBody?: unknown;
+}): unknown {
+  const hasBody = options.body !== undefined;
+  const isSerializedBody = hasBody && options.bodySerializer;
+
+  if (isSerializedBody) {
+    if ('serializedBody' in options) {
+      const hasSerializedBody =
+        options.serializedBody !== undefined && options.serializedBody !== '';
+
+      return hasSerializedBody ? options.serializedBody : null;
+    }
+
+    // not all clients implement a serializedBody property (i.e., client-axios)
+    return options.body !== '' ? options.body : null;
+  }
+
+  // plain/text body
+  if (hasBody) {
+    return options.body;
+  }
+
+  // no body was provided
+  return undefined;
+}

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

@@ -0,0 +1,80 @@
+// Generated by services/sdk_node_js/scripts/generate_facade.mjs from
+// sdk.gen.ts. Do not edit by hand.
+
+import { makeEndpoint } from '../makeEndpoint.js';
+import type { CamelCaseDeep } from '../caseConversion.js';
+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 setRevenue = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.SetRevenueData, 'url'>>,
+  CamelCaseDeep<generatedTypes.SetRevenueResponse>,
+  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 getAllKeyMetrics = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.GetAllKeyMetricsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.GetAllKeyMetricsResponse>,
+  CamelCaseDeep<generatedTypes.GetAllKeyMetricsError>
+>(generated.getAllKeyMetrics);
+
+export const setKeyMetrics = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.SetKeyMetricsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.SetKeyMetricsResponse>,
+  CamelCaseDeep<generatedTypes.SetKeyMetricsError>
+>(generated.setKeyMetrics);
+
+export const deleteUserKeyMetrics = makeEndpoint<
+  CamelCaseDeep<Omit<generatedTypes.DeleteUserKeyMetricsData, 'url'>>,
+  CamelCaseDeep<generatedTypes.DeleteUserKeyMetricsResponse>,
+  CamelCaseDeep<generatedTypes.DeleteUserKeyMetricsError>
+>(generated.deleteUserKeyMetrics);
+
+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 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

@@ -0,0 +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';

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

@@ -0,0 +1,139 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+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';
+
+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
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+
+/**
+ * Every revenue value of the project, one row per booked value.
+ */
+export const getAllRevenue = <ThrowOnError extends boolean = false>(options?: Options<GetAllRevenueData, ThrowOnError>): RequestResult<GetAllRevenueResponses, GetAllRevenueErrors, ThrowOnError> => (options?.client ?? client).get<GetAllRevenueResponses, GetAllRevenueErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/revenue/',
+    ...options
+});
+
+/**
+ * Book revenue values; set upsert=true to overwrite rows whose id already exists.
+ */
+export const setRevenue = <ThrowOnError extends boolean = false>(options: Options<SetRevenueData, ThrowOnError>): RequestResult<SetRevenueResponses, SetRevenueErrors, ThrowOnError> => (options.client ?? client).post<SetRevenueResponses, SetRevenueErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/revenue/',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * 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.
+ */
+export const getCustomerRevenue = <ThrowOnError extends boolean = false>(options: Options<GetCustomerRevenueData, ThrowOnError>): RequestResult<GetCustomerRevenueResponses, GetCustomerRevenueErrors, ThrowOnError> => (options.client ?? client).get<GetCustomerRevenueResponses, GetCustomerRevenueErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/revenue/{customer_name}/',
+    ...options
+});
+
+/**
+ * Every key-metric value of the project, one row per booked value.
+ */
+export const getAllKeyMetrics = <ThrowOnError extends boolean = false>(options?: Options<GetAllKeyMetricsData, ThrowOnError>): RequestResult<GetAllKeyMetricsResponses, GetAllKeyMetricsErrors, ThrowOnError> => (options?.client ?? client).get<GetAllKeyMetricsResponses, GetAllKeyMetricsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/key-metrics/',
+    ...options
+});
+
+/**
+ * Book key-metric values; set upsert=true to overwrite rows whose id already exists.
+ */
+export const setKeyMetrics = <ThrowOnError extends boolean = false>(options: Options<SetKeyMetricsData, ThrowOnError>): RequestResult<SetKeyMetricsResponses, SetKeyMetricsErrors, ThrowOnError> => (options.client ?? client).post<SetKeyMetricsResponses, SetKeyMetricsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/key-metrics/',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+
+/**
+ * Delete one user's API-uploaded key-metric values.
+ */
+export const deleteUserKeyMetrics = <ThrowOnError extends boolean = false>(options: Options<DeleteUserKeyMetricsData, ThrowOnError>): RequestResult<DeleteUserKeyMetricsResponses, DeleteUserKeyMetricsErrors, ThrowOnError> => (options.client ?? client).delete<DeleteUserKeyMetricsResponses, DeleteUserKeyMetricsErrors, 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}/',
+    ...options
+});
+
+/**
+ * Every known customer of the project with its tags (possibly empty).
+ */
+export const getAllCustomersTags = <ThrowOnError extends boolean = false>(options?: Options<GetAllCustomersTagsData, ThrowOnError>): RequestResult<GetAllCustomersTagsResponses, GetAllCustomersTagsErrors, ThrowOnError> => (options?.client ?? client).get<GetAllCustomersTagsResponses, GetAllCustomersTagsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/customer-tags/',
+    ...options
+});
+
+/**
+ * Merge-set customer tags; set upsert=true to overwrite tags that already exist.
+ */
+export const setCustomersTags = <ThrowOnError extends boolean = false>(options: Options<SetCustomersTagsData, ThrowOnError>): RequestResult<SetCustomersTagsResponses, SetCustomersTagsErrors, ThrowOnError> => (options.client ?? client).post<SetCustomersTagsResponses, SetCustomersTagsErrors, ThrowOnError>({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/customer-tags/',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...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
+});