dub 0.0.0 → 0.0.1

package/src/error.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import { castToError, Headers } from './core';
+
+export class DubError extends Error {}
+
+export class APIError extends DubError {
+  readonly status: number | undefined;
+  readonly headers: Headers | undefined;
+  readonly error: Object | undefined;
+
+  constructor(
+    status: number | undefined,
+    error: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    super(`${APIError.makeMessage(status, error, message)}`);
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+
+  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
+    const msg =
+      error?.message ?
+        typeof error.message === 'string' ?
+          error.message
+        : JSON.stringify(error.message)
+      : error ? JSON.stringify(error)
+      : message;
+
+    if (status && msg) {
+      return `${status} ${msg}`;
+    }
+    if (status) {
+      return `${status} status code (no body)`;
+    }
+    if (msg) {
+      return msg;
+    }
+    return '(no status code or body)';
+  }
+
+  static generate(
+    status: number | undefined,
+    errorResponse: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    if (!status) {
+      return new APIConnectionError({ cause: castToError(errorResponse) });
+    }
+
+    const error = errorResponse as Record<string, any>;
+
+    if (status === 400) {
+      return new BadRequestError(status, error, message, headers);
+    }
+
+    if (status === 401) {
+      return new AuthenticationError(status, error, message, headers);
+    }
+
+    if (status === 403) {
+      return new PermissionDeniedError(status, error, message, headers);
+    }
+
+    if (status === 404) {
+      return new NotFoundError(status, error, message, headers);
+    }
+
+    if (status === 409) {
+      return new ConflictError(status, error, message, headers);
+    }
+
+    if (status === 422) {
+      return new UnprocessableEntityError(status, error, message, headers);
+    }
+
+    if (status === 429) {
+      return new RateLimitError(status, error, message, headers);
+    }
+
+    if (status >= 500) {
+      return new InternalServerError(status, error, message, headers);
+    }
+
+    return new APIError(status, error, message, headers);
+  }
+}
+
+export class APIUserAbortError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message }: { message?: string } = {}) {
+    super(undefined, undefined, message || 'Request was aborted.', undefined);
+  }
+}
+
+export class APIConnectionError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message, cause }: { message?: string; cause?: Error | undefined }) {
+    super(undefined, undefined, message || 'Connection error.', undefined);
+    // in some environments the 'cause' property is already declared
+    // @ts-ignore
+    if (cause) this.cause = cause;
+  }
+}
+
+export class APIConnectionTimeoutError extends APIConnectionError {
+  constructor({ message }: { message?: string } = {}) {
+    super({ message: message ?? 'Request timed out.' });
+  }
+}
+
+export class BadRequestError extends APIError {
+  override readonly status: 400 = 400;
+}
+
+export class AuthenticationError extends APIError {
+  override readonly status: 401 = 401;
+}
+
+export class PermissionDeniedError extends APIError {
+  override readonly status: 403 = 403;
+}
+
+export class NotFoundError extends APIError {
+  override readonly status: 404 = 404;
+}
+
+export class ConflictError extends APIError {
+  override readonly status: 409 = 409;
+}
+
+export class UnprocessableEntityError extends APIError {
+  override readonly status: 422 = 422;
+}
+
+export class RateLimitError extends APIError {
+  override readonly status: 429 = 429;
+}
+
+export class InternalServerError extends APIError {}

package/src/index.ts

@@ -0,0 +1,195 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from './core';
+import * as Errors from './error';
+import { type Agent } from './_shims/index';
+import * as Uploads from './uploads';
+import * as API from "./resources/index";
+
+export interface ClientOptions {
+  /**
+   * Defaults to process.env['DUB_BEARER_TOKEN'].
+   */
+  bearerToken?: string;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['DUB_BASE_URL'].
+   */
+  baseURL?: string | null | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+   * much longer than this timeout before the promise succeeds or fails.
+   */
+  timeout?: number;
+
+  /**
+   * An HTTP agent used to manage HTTP(S) connections.
+   *
+   * If not provided, an agent will be constructed by default in the Node.js environment,
+   * otherwise no agent is used.
+   */
+  httpAgent?: Agent;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * defined globally.
+   */
+  fetch?: Core.Fetch | undefined;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
+  maxRetries?: number;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `undefined` or `null` in request options.
+   */
+  defaultHeaders?: Core.Headers;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Core.DefaultQuery;
+}
+
+/** API Client for interfacing with the Dub API. */
+export class Dub extends Core.APIClient {
+  bearerToken: string;
+
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the Dub API.
+   *
+   * @param {string} [opts.bearerToken=process.env['DUB_BEARER_TOKEN'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+   */
+  constructor({
+    baseURL = Core.readEnv('DUB_BASE_URL'),
+    bearerToken = Core.readEnv('DUB_BEARER_TOKEN'),
+    ...opts
+  }: ClientOptions = {}) {
+    if (bearerToken === undefined) {
+      throw new Errors.DubError(
+        "The DUB_BEARER_TOKEN environment variable is missing or empty; either provide it, or instantiate the Dub client with an bearerToken option, like new Dub({ bearerToken: 'My Bearer Token' }).",
+      );
+    }
+
+    const options: ClientOptions = {
+      bearerToken,
+      ...opts,
+      baseURL: baseURL ?? `https://api.dub.co`,
+    };
+
+    super({
+      baseURL: options.baseURL!,
+      timeout: options.timeout ?? 60000 /* 1 minute */,
+      httpAgent: options.httpAgent,
+      maxRetries: options.maxRetries,
+      fetch: options.fetch,
+    });
+    this._options = options;
+
+    this.bearerToken = bearerToken;
+  }
+
+  links: API.Links = new API.Links(this);
+  projects: API.Projects = new API.Projects(this);
+
+  protected override defaultQuery(): Core.DefaultQuery | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return {
+      ...super.defaultHeaders(opts),
+      ...this._options.defaultHeaders,
+    };
+  }
+
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return { Authorization: `Bearer ${this.bearerToken}` };
+  }
+
+  static Dub = this;
+
+  static DubError = Errors.DubError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+}
+
+export const {
+  DubError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+  NotFoundError,
+  ConflictError,
+  RateLimitError,
+  BadRequestError,
+  AuthenticationError,
+  InternalServerError,
+  PermissionDeniedError,
+  UnprocessableEntityError,
+} = Errors;
+
+export import toFile = Uploads.toFile;
+export import fileFromPath = Uploads.fileFromPath;
+
+export namespace Dub {
+  // Helper functions
+  export import toFile = Uploads.toFile;
+  export import fileFromPath = Uploads.fileFromPath;
+
+  export import RequestOptions = Core.RequestOptions;
+
+  export import Links = API.Links;
+  export import LinkListResponse = API.LinkListResponse;
+  export import LinkCreateParams = API.LinkCreateParams;
+  export import LinkUpdateParams = API.LinkUpdateParams;
+  export import LinkListParams = API.LinkListParams;
+  export import LinkDeleteParams = API.LinkDeleteParams;
+
+  export import Projects = API.Projects;
+  export import Project = API.Project;
+  export import ProjectDetails = API.ProjectDetails;
+  export import ProjectListResponse = API.ProjectListResponse;
+
+  export import Link = API.Link;
+}
+
+export default Dub;

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/resource.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import type { Dub } from './index';
+
+export class APIResource {
+  protected _client: Dub;
+
+  constructor(client: Dub) {
+    this._client = client;
+  }
+}

package/src/resources/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export * from './shared';
+export {
+  LinkListResponse,
+  LinkCreateParams,
+  LinkUpdateParams,
+  LinkListParams,
+  LinkDeleteParams,
+  Links,
+} from './links/links';
+export { Project, ProjectDetails, ProjectListResponse, Projects } from './projects/projects';

package/src/resources/links/bulk.ts

@@ -0,0 +1,126 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as BulkAPI from "./bulk";
+import * as Shared from "../shared";
+
+export class Bulk extends APIResource {
+  /**
+   * Bulk create up to 100 links for the authenticated project.
+   */
+  create(params: BulkCreateParams, options?: Core.RequestOptions): Core.APIPromise<BulkCreateResponse> {
+    const { projectSlug, ...body } = params;
+    return this._client.post('/links/bulk', { query: { projectSlug }, body, ...options });
+  }
+}
+
+export type BulkCreateResponse = Array<Shared.Link>;
+
+export interface BulkCreateParams {
+  /**
+   * Query param: The slug for the project to create links for. E.g. for
+   * app.dub.co/acme, the projectSlug is 'acme'.
+   */
+  projectSlug: string;
+}
+
+export namespace BulkCreateParams {
+  export interface Body {
+    /**
+     * The Android destination URL for the short link for Android device targeting.
+     */
+    android?: string | null;
+
+    /**
+     * Whether the short link is archived.
+     */
+    archived?: boolean;
+
+    /**
+     * The comments for the short link.
+     */
+    comments?: string | null;
+
+    /**
+     * The description of the short link generated via api.dub.co/metatags. Will be
+     * used for Custom Social Media Cards if `proxy` is true.
+     */
+    description?: string | null;
+
+    /**
+     * The domain of the short link.
+     */
+    domain?: string;
+
+    /**
+     * The date and time when the short link will expire in ISO-8601 format. Must be in
+     * the future.
+     */
+    expiresAt?: string | null;
+
+    /**
+     * Geo targeting information for the short link in JSON format {[COUNTRY]:
+     * "https://example.com" }. Learn more: https://dub.sh/geo
+     */
+    geo?: Record<string, string> | null;
+
+    /**
+     * The image of the short link generated via api.dub.co/metatags. Will be used for
+     * Custom Social Media Cards if `proxy` is true.
+     */
+    image?: string | null;
+
+    /**
+     * The iOS destination URL for the short link for iOS device targeting.
+     */
+    ios?: string | null;
+
+    /**
+     * The short link slug. If not provided, a random 7-character slug will be
+     * generated.
+     */
+    key?: string;
+
+    /**
+     * The password required to access the destination URL of the short link.
+     */
+    password?: string | null;
+
+    /**
+     * Whether the short link uses Custom Social Media Cards feature.
+     */
+    proxy?: boolean;
+
+    /**
+     * Whether the short link's stats are publicly accessible.
+     */
+    publicStats?: boolean;
+
+    /**
+     * Whether the short link uses link cloaking.
+     */
+    rewrite?: boolean;
+
+    /**
+     * The unique id of the tag assigned to the short link.
+     */
+    tagId?: string | null;
+
+    /**
+     * The title of the short link generated via api.dub.co/metatags. Will be used for
+     * Custom Social Media Cards if `proxy` is true.
+     */
+    title?: string | null;
+
+    /**
+     * The destination URL of the short link.
+     */
+    url?: string;
+  }
+}
+
+export namespace Bulk {
+  export import BulkCreateResponse = BulkAPI.BulkCreateResponse;
+  export import BulkCreateParams = BulkAPI.BulkCreateParams;
+}

package/src/resources/links/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { BulkCreateResponse, BulkCreateParams, Bulk } from './bulk';
+export { InfoRetrieveParams, Info } from './info';
+export {
+  LinkListResponse,
+  LinkCreateParams,
+  LinkUpdateParams,
+  LinkListParams,
+  LinkDeleteParams,
+  Links,
+} from './links';

package/src/resources/links/info.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as InfoAPI from "./info";
+import * as Shared from "../shared";
+
+export class Info extends APIResource {
+  /**
+   * Retrieve the info for a link from their domain and key.
+   */
+  retrieve(query: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Link> {
+    return this._client.get('/links/info', { query, ...options });
+  }
+}
+
+export interface InfoRetrieveParams {
+  /**
+   * The domain of the link to retrieve. E.g. for dub.sh/github, the domain is
+   * 'dub.sh'.
+   */
+  domain: string;
+
+  /**
+   * The key of the link to retrieve. E.g. for dub.sh/github, the key is 'github'.
+   */
+  key: string;
+
+  /**
+   * The slug for the project that the link belongs to. E.g. for app.dub.co/acme, the
+   * projectSlug is 'acme'.
+   */
+  projectSlug: string;
+}
+
+export namespace Info {
+  export import InfoRetrieveParams = InfoAPI.InfoRetrieveParams;
+}