dub 0.0.0 → 0.1.0

package/src/resources/links/links.ts

@@ -0,0 +1,325 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as LinksAPI from "./links";
+import * as Shared from "../shared";
+import * as BulkAPI from "./bulk";
+import * as InfoAPI from "./info";
+
+export class Links extends APIResource {
+  info: InfoAPI.Info = new InfoAPI.Info(this._client);
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+
+  /**
+   * Create a new link for the authenticated project.
+   */
+  create(params: LinkCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Link> {
+    const { projectSlug, ...body } = params;
+    return this._client.post('/links', { query: { projectSlug }, body, ...options });
+  }
+
+  /**
+   * Edit a link for the authenticated project.
+   */
+  update(
+    linkId: string,
+    params: LinkUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Link> {
+    const { projectSlug, ...body } = params;
+    return this._client.put(`/links/${linkId}`, { query: { projectSlug }, body, ...options });
+  }
+
+  /**
+   * Retrieve a list of links for the authenticated project. The list will be
+   * paginated and the provided query parameters allow filtering the returned links.
+   */
+  list(query: LinkListParams, options?: Core.RequestOptions): Core.APIPromise<LinkListResponse> {
+    return this._client.get('/links', { query, ...options });
+  }
+
+  /**
+   * Delete a link for the authenticated project.
+   */
+  delete(
+    linkId: string,
+    params: LinkDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.Link> {
+    const { projectSlug } = params;
+    return this._client.delete(`/links/${linkId}`, { query: { projectSlug }, ...options });
+  }
+}
+
+export type LinkListResponse = Array<Shared.Link>;
+
+export interface LinkCreateParams {
+  /**
+   * Query param: The slug for the project to create links for. E.g. for
+   * app.dub.co/acme, the projectSlug is 'acme'.
+   */
+  projectSlug: string;
+
+  /**
+   * Body param: The domain of the short link.
+   */
+  domain: string;
+
+  /**
+   * Body param: The destination URL of the short link.
+   */
+  url: string;
+
+  /**
+   * Body param: The Android destination URL for the short link for Android device
+   * targeting.
+   */
+  android?: string | null;
+
+  /**
+   * Body param: Whether the short link is archived.
+   */
+  archived?: boolean;
+
+  /**
+   * Body param: The comments for the short link.
+   */
+  comments?: string | null;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: The date and time when the short link will expire in ISO-8601
+   * format. Must be in the future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: The iOS destination URL for the short link for iOS device targeting.
+   */
+  ios?: string | null;
+
+  /**
+   * Body param: The short link slug. If not provided, a random 7-character slug will
+   * be generated.
+   */
+  key?: string;
+
+  /**
+   * Body param: The password required to access the destination URL of the short
+   * link.
+   */
+  password?: string | null;
+
+  /**
+   * Body param: Whether the short link uses Custom Social Media Cards feature.
+   */
+  proxy?: boolean;
+
+  /**
+   * Body param: Whether the short link's stats are publicly accessible.
+   */
+  publicStats?: boolean;
+
+  /**
+   * Body param: Whether the short link uses link cloaking.
+   */
+  rewrite?: boolean;
+
+  /**
+   * Body param: The unique id of the tag assigned to the short link.
+   */
+  tagId?: string | null;
+
+  /**
+   * Body param: 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;
+}
+
+export interface LinkUpdateParams {
+  /**
+   * Query param: The slug for the project that the link belongs to. E.g. for
+   * app.dub.co/acme, the projectSlug is 'acme'.
+   */
+  projectSlug: string;
+
+  /**
+   * Body param: The Android destination URL for the short link for Android device
+   * targeting.
+   */
+  android?: string | null;
+
+  /**
+   * Body param: Whether the short link is archived.
+   */
+  archived?: boolean;
+
+  /**
+   * Body param: The comments for the short link.
+   */
+  comments?: string | null;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: The domain of the short link.
+   */
+  domain?: string;
+
+  /**
+   * Body param: The date and time when the short link will expire in ISO-8601
+   * format. Must be in the future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: The iOS destination URL for the short link for iOS device targeting.
+   */
+  ios?: string | null;
+
+  /**
+   * Body param: The short link slug. If not provided, a random 7-character slug will
+   * be generated.
+   */
+  key?: string;
+
+  /**
+   * Body param: The password required to access the destination URL of the short
+   * link.
+   */
+  password?: string | null;
+
+  /**
+   * Body param: Whether the short link uses Custom Social Media Cards feature.
+   */
+  proxy?: boolean;
+
+  /**
+   * Body param: Whether the short link's stats are publicly accessible.
+   */
+  publicStats?: boolean;
+
+  /**
+   * Body param: Whether the short link uses link cloaking.
+   */
+  rewrite?: boolean;
+
+  /**
+   * Body param: The unique id of the tag assigned to the short link.
+   */
+  tagId?: string | null;
+
+  /**
+   * Body param: 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;
+
+  /**
+   * Body param: The destination URL of the short link.
+   */
+  url?: string;
+}
+
+export interface LinkListParams {
+  /**
+   * The slug for the project to retrieve links for. E.g. for app.dub.co/acme, the
+   * projectSlug is 'acme'.
+   */
+  projectSlug: string;
+
+  /**
+   * The domain to filter the links by. E.g. 'ac.me'. If not provided, all links for
+   * the project will be returned.
+   */
+  domain?: string;
+
+  /**
+   * The page number for pagination (each page contains 100 links).
+   */
+  page?: number;
+
+  /**
+   * The search term to filter the links by. The search term will be matched against
+   * the short link slug and the destination url.
+   */
+  search?: string;
+
+  /**
+   * Whether to include archived links in the response. Defaults to false if not
+   * provided.
+   */
+  showArchived?: true | false;
+
+  /**
+   * The field to sort the links by. The default is 'createdAt', and sort order is
+   * always descending.
+   */
+  sort?: 'createdAt' | 'clicks' | 'lastClicked';
+
+  /**
+   * The tag ID to filter the links by.
+   */
+  tagId?: string;
+
+  /**
+   * The user ID to filter the links by.
+   */
+  userId?: string;
+}
+
+export interface LinkDeleteParams {
+  /**
+   * 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 Links {
+  export import LinkListResponse = LinksAPI.LinkListResponse;
+  export import LinkCreateParams = LinksAPI.LinkCreateParams;
+  export import LinkUpdateParams = LinksAPI.LinkUpdateParams;
+  export import LinkListParams = LinksAPI.LinkListParams;
+  export import LinkDeleteParams = LinksAPI.LinkDeleteParams;
+  export import Info = InfoAPI.Info;
+  export import InfoRetrieveParams = InfoAPI.InfoRetrieveParams;
+  export import Bulk = BulkAPI.Bulk;
+  export import BulkCreateResponse = BulkAPI.BulkCreateResponse;
+  export import BulkCreateParams = BulkAPI.BulkCreateParams;
+}

package/src/resources/projects/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { Project, ProjectDetails, ProjectListResponse, Projects } from './projects';
+export { Tag, TagListResponse, TagCreateParams, Tags } from './tags';

package/src/resources/projects/projects.ts

@@ -0,0 +1,122 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as ProjectsAPI from "./projects";
+import * as TagsAPI from "./tags";
+
+export class Projects extends APIResource {
+  tags: TagsAPI.Tags = new TagsAPI.Tags(this._client);
+
+  /**
+   * Retrieve a project for the authenticated user.
+   */
+  retrieve(projectSlug: string, options?: Core.RequestOptions): Core.APIPromise<ProjectDetails> {
+    return this._client.get(`/projects/${projectSlug}`, options);
+  }
+
+  /**
+   * Retrieve a list of projects for the authenticated user.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<ProjectListResponse> {
+    return this._client.get('/projects', options);
+  }
+}
+
+export interface Project {
+  /**
+   * The unique ID of the project.
+   */
+  id?: string;
+
+  /**
+   * The date and time when the billing cycle starts for the project.
+   */
+  billingCycleStart?: number | null;
+
+  /**
+   * The date and time when the project was created.
+   */
+  createdAt?: string;
+
+  /**
+   * The logo of the project.
+   */
+  logo?: string | null;
+
+  /**
+   * The name of the project.
+   */
+  name?: string;
+
+  /**
+   * The plan of the project.
+   */
+  plan?: string;
+
+  /**
+   * The slug of the project.
+   */
+  slug?: string;
+
+  /**
+   * The Stripe ID of the project.
+   */
+  stripeId?: string | null;
+
+  /**
+   * The usage of the project.
+   */
+  usage?: number;
+
+  /**
+   * The usage limit of the project.
+   */
+  usageLimit?: number;
+}
+
+export interface ProjectDetails extends Project {
+  /**
+   * The domains of the project.
+   */
+  domains?: Array<ProjectDetails.Domain>;
+
+  /**
+   * The role of the authenticated user in the project.
+   */
+  users?: Array<ProjectDetails.User>;
+}
+
+export namespace ProjectDetails {
+  /**
+   * The domains of the project.
+   */
+  export interface Domain {
+    /**
+     * The domain of the project.
+     */
+    slug?: string;
+  }
+
+  /**
+   * The role of the authenticated user in the project.
+   */
+  export interface User {
+    /**
+     * The role of the authenticated user in the project.
+     */
+    role?: string;
+  }
+}
+
+export type ProjectListResponse = Array<Project>;
+
+export namespace Projects {
+  export import Project = ProjectsAPI.Project;
+  export import ProjectDetails = ProjectsAPI.ProjectDetails;
+  export import ProjectListResponse = ProjectsAPI.ProjectListResponse;
+  export import Tags = TagsAPI.Tags;
+  export import Tag = TagsAPI.Tag;
+  export import TagListResponse = TagsAPI.TagListResponse;
+  export import TagCreateParams = TagsAPI.TagCreateParams;
+}

package/src/resources/projects/tags.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as TagsAPI from "./tags";
+
+export class Tags extends APIResource {
+  /**
+   * Create a new tag for the authenticated project.
+   */
+  create(projectSlug: string, body: TagCreateParams, options?: Core.RequestOptions): Core.APIPromise<Tag> {
+    return this._client.post(`/projects/${projectSlug}/tags`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a list of tags for the authenticated project.
+   */
+  list(projectSlug: string, options?: Core.RequestOptions): Core.APIPromise<TagListResponse> {
+    return this._client.get(`/projects/${projectSlug}/tags`, options);
+  }
+}
+
+export interface Tag {
+  /**
+   * The unique ID of the tag.
+   */
+  id?: string;
+
+  /**
+   * The color of the tag.
+   */
+  color?: string;
+
+  /**
+   * The name of the tag.
+   */
+  name?: string;
+}
+
+export type TagListResponse = Array<Tag>;
+
+export interface TagCreateParams {
+  /**
+   * The name of the tag to create.
+   */
+  tag?: string;
+}
+
+export namespace Tags {
+  export import Tag = TagsAPI.Tag;
+  export import TagListResponse = TagsAPI.TagListResponse;
+  export import TagCreateParams = TagsAPI.TagCreateParams;
+}

package/src/resources/shared.ts

@@ -0,0 +1,154 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export interface Link {
+  /**
+   * The unique ID of the short link.
+   */
+  id?: string;
+
+  /**
+   * The Android destination URL for the short link for Android device targeting.
+   */
+  android?: string | null;
+
+  /**
+   * Whether the short link is archived.
+   */
+  archived?: boolean;
+
+  /**
+   * The number of clicks on the short link.
+   */
+  clicks?: number;
+
+  /**
+   * The comments for the short link.
+   */
+  comments?: string | null;
+
+  /**
+   * The date and time when the short link was created.
+   */
+  createdAt?: string;
+
+  /**
+   * 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 date and time when the short link was last clicked.
+   */
+  lastClicked?: string | null;
+
+  /**
+   * The password required to access the destination URL of the short link.
+   */
+  password?: string | null;
+
+  /**
+   * The project ID of the short link.
+   */
+  projectId?: string;
+
+  /**
+   * 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 date and time when the short link was last updated.
+   */
+  updatedAt?: string;
+
+  /**
+   * The destination URL of the short link.
+   */
+  url?: string;
+
+  /**
+   * The user ID of the creator of the short link.
+   */
+  userId?: string;
+
+  /**
+   * The UTM campaign of the short link.
+   */
+  utm_campaign?: string | null;
+
+  /**
+   * The UTM content of the short link.
+   */
+  utm_content?: string | null;
+
+  /**
+   * The UTM medium of the short link.
+   */
+  utm_medium?: string | null;
+
+  /**
+   * The UTM source of the short link.
+   */
+  utm_source?: string | null;
+
+  /**
+   * The UTM term of the short link.
+   */
+  utm_term?: string | null;
+}

package/src/shims/node.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/node-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/node-runtime';
+setShims(getRuntime());
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}