dub 0.44.0 → 0.45.1

package/src/models/operations/updatecustomer.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type UpdateCustomerRequestBody = {
+  /**
+   * Email of the customer in the client's app.
+   */
+  email?: string | null | undefined;
+  /**
+   * Name of the customer in the client's app. If not provided, a random name will be generated.
+   */
+  name?: string | null | undefined;
+  /**
+   * Avatar URL of the customer in the client's app.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId?: string | undefined;
+};
+
+export type UpdateCustomerRequest = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+  requestBody?: UpdateCustomerRequestBody | undefined;
+};
+
+/**
+ * The customer was updated.
+ */
+export type UpdateCustomerResponseBody = {
+  /**
+   * The unique identifier of the customer in Dub.
+   */
+  id: string;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId: string;
+  /**
+   * Name of the customer.
+   */
+  name: string;
+  /**
+   * Email of the customer.
+   */
+  email?: string | null | undefined;
+  /**
+   * Avatar URL of the customer.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The date the customer was created.
+   */
+  createdAt: string;
+};
+
+/** @internal */
+export const UpdateCustomerRequestBody$inboundSchema: z.ZodType<
+  UpdateCustomerRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+});
+
+/** @internal */
+export type UpdateCustomerRequestBody$Outbound = {
+  email?: string | null | undefined;
+  name?: string | null | undefined;
+  avatar?: string | null | undefined;
+  externalId?: string | undefined;
+};
+
+/** @internal */
+export const UpdateCustomerRequestBody$outboundSchema: z.ZodType<
+  UpdateCustomerRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateCustomerRequestBody
+> = z.object({
+  email: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  externalId: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCustomerRequestBody$ {
+  /** @deprecated use `UpdateCustomerRequestBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateCustomerRequestBody$inboundSchema;
+  /** @deprecated use `UpdateCustomerRequestBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateCustomerRequestBody$outboundSchema;
+  /** @deprecated use `UpdateCustomerRequestBody$Outbound` instead. */
+  export type Outbound = UpdateCustomerRequestBody$Outbound;
+}
+
+/** @internal */
+export const UpdateCustomerRequest$inboundSchema: z.ZodType<
+  UpdateCustomerRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  RequestBody: z.lazy(() => UpdateCustomerRequestBody$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type UpdateCustomerRequest$Outbound = {
+  id: string;
+  RequestBody?: UpdateCustomerRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateCustomerRequest$outboundSchema: z.ZodType<
+  UpdateCustomerRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateCustomerRequest
+> = z.object({
+  id: z.string(),
+  requestBody: z.lazy(() => UpdateCustomerRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCustomerRequest$ {
+  /** @deprecated use `UpdateCustomerRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateCustomerRequest$inboundSchema;
+  /** @deprecated use `UpdateCustomerRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateCustomerRequest$outboundSchema;
+  /** @deprecated use `UpdateCustomerRequest$Outbound` instead. */
+  export type Outbound = UpdateCustomerRequest$Outbound;
+}
+
+/** @internal */
+export const UpdateCustomerResponseBody$inboundSchema: z.ZodType<
+  UpdateCustomerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/** @internal */
+export type UpdateCustomerResponseBody$Outbound = {
+  id: string;
+  externalId: string;
+  name: string;
+  email?: string | null | undefined;
+  avatar?: string | null | undefined;
+  createdAt: string;
+};
+
+/** @internal */
+export const UpdateCustomerResponseBody$outboundSchema: z.ZodType<
+  UpdateCustomerResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdateCustomerResponseBody
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCustomerResponseBody$ {
+  /** @deprecated use `UpdateCustomerResponseBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateCustomerResponseBody$inboundSchema;
+  /** @deprecated use `UpdateCustomerResponseBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateCustomerResponseBody$outboundSchema;
+  /** @deprecated use `UpdateCustomerResponseBody$Outbound` instead. */
+  export type Outbound = UpdateCustomerResponseBody$Outbound;
+}

package/src/sdk/customers.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { customersCreate } from "../funcs/customersCreate.js";
+import { customersDelete } from "../funcs/customersDelete.js";
+import { customersGet } from "../funcs/customersGet.js";
+import { customersList } from "../funcs/customersList.js";
+import { customersUpdate } from "../funcs/customersUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Customers extends ClientSDK {
+  /**
+   * Get a list of customers
+   *
+   * @remarks
+   * Get a list of customers for the authenticated workspace.
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<Array<operations.ResponseBody>> {
+    return unwrapAsync(customersList(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Create a customer
+   *
+   * @remarks
+   * Create a customer for the authenticated workspace.
+   */
+  async create(
+    request?: operations.CreateCustomerRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.CreateCustomerResponseBody> {
+    return unwrapAsync(customersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a customer
+   *
+   * @remarks
+   * Get a customer by ID for the authenticated workspace.
+   */
+  async get(
+    request: operations.GetCustomerRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCustomerResponseBody> {
+    return unwrapAsync(customersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a customer
+   *
+   * @remarks
+   * Update a customer for the authenticated workspace.
+   */
+  async update(
+    id: string,
+    requestBody?: operations.UpdateCustomerRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateCustomerResponseBody> {
+    return unwrapAsync(customersUpdate(
+      this,
+      id,
+      requestBody,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a customer
+   *
+   * @remarks
+   * Delete a customer from a workspace.
+   */
+  async delete(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteCustomerResponseBody> {
+    return unwrapAsync(customersDelete(
+      this,
+      id,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Analytics } from "./analytics.js";
+import { Customers } from "./customers.js";
 import { Domains } from "./domains.js";
 import { Events } from "./events.js";
 import { Links } from "./links.js";
@@ -19,11 +20,6 @@ export class Dub extends ClientSDK {
     return (this._links ??= new Links(this._options));
   }
 
-  private _qrCodes?: QRCodes;
-  get qrCodes(): QRCodes {
-    return (this._qrCodes ??= new QRCodes(this._options));
-  }
-
   private _analytics?: Analytics;
   get analytics(): Analytics {
     return (this._analytics ??= new Analytics(this._options));
@@ -34,11 +30,6 @@ export class Dub extends ClientSDK {
     return (this._events ??= new Events(this._options));
   }
 
-  private _workspaces?: Workspaces;
-  get workspaces(): Workspaces {
-    return (this._workspaces ??= new Workspaces(this._options));
-  }
-
   private _tags?: Tags;
   get tags(): Tags {
     return (this._tags ??= new Tags(this._options));
@@ -54,6 +45,21 @@ export class Dub extends ClientSDK {
     return (this._track ??= new Track(this._options));
   }
 
+  private _customers?: Customers;
+  get customers(): Customers {
+    return (this._customers ??= new Customers(this._options));
+  }
+
+  private _workspaces?: Workspaces;
+  get workspaces(): Workspaces {
+    return (this._workspaces ??= new Workspaces(this._options));
+  }
+
+  private _qrCodes?: QRCodes;
+  get qrCodes(): QRCodes {
+    return (this._qrCodes ??= new QRCodes(this._options));
+  }
+
   private _metatags?: Metatags;
   get metatags(): Metatags {
     return (this._metatags ??= new Metatags(this._options));

package/src/sdk/track.ts

@@ -49,6 +49,8 @@ export class Track extends ClientSDK {
    *
    * @remarks
    * Track a customer for an authenticated workspace.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async customer(
     request?: operations.TrackCustomerRequestBody | undefined,