dub 0.8.0 → 0.9.0

package/src/resources/links/bulk.ts

@@ -3,7 +3,6 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as BulkAPI from "./bulk";
-import * as LinksAPI from "./links";
 
 export class Bulk extends APIResource {
   /**
@@ -15,11 +14,198 @@ export class Bulk extends APIResource {
   }
 }
 
-export type BulkCreateResponse = Array<LinksAPI.Link>;
+export type BulkCreateResponse = Array<BulkCreateResponse.BulkCreateResponseItem>;
+
+export namespace BulkCreateResponse {
+  export interface BulkCreateResponseItem {
+    /**
+     * 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. If not provided, the primary domain for the
+     * project will be used (or `dub.sh` if the project has no domains).
+     */
+    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://d.to/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;
+
+    /**
+     * The full URL of the QR code for the short link (e.g.
+     * `https://api.dub.co/qr?url=https://dub.sh/try`).
+     */
+    qrCode: string;
+
+    /**
+     * Whether the short link uses link cloaking.
+     */
+    rewrite: boolean;
+
+    /**
+     * The full URL of the short link, including the https protocol (e.g.
+     * `https://dub.sh/try`).
+     */
+    shortLink: string;
+
+    /**
+     * The tags assigned to the short link.
+     */
+    tags: Array<BulkCreateResponseItem.Tag> | 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;
+  }
+
+  export namespace BulkCreateResponseItem {
+    export interface Tag {
+      /**
+       * The unique ID of the tag.
+       */
+      id: string;
+
+      /**
+       * The color of the tag.
+       */
+      color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
+
+      /**
+       * The name of the tag.
+       */
+      name: string;
+    }
+  }
+}
 
 export interface BulkCreateParams {
   /**
-   * Query param: The slug for the project to create links for. E.g. for
+   * 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;
@@ -32,6 +218,11 @@ export interface BulkCreateParams {
 
 export namespace BulkCreateParams {
   export interface Body {
+    /**
+     * The destination URL of the short link.
+     */
+    url: string;
+
     /**
      * The Android destination URL for the short link for Android device targeting.
      */
@@ -66,8 +257,8 @@ export namespace BulkCreateParams {
     expiresAt?: string | null;
 
     /**
-     * Geo targeting information for the short link in JSON format {[COUNTRY]:
-     * `https://example.com` }. Learn more: `https://dub.sh/geo`
+     * Geo targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.com }`.
      */
     geo?: Record<string, string> | null;
 
@@ -118,23 +309,18 @@ export namespace BulkCreateParams {
     /**
      * The unique ID of the tag assigned to the short link.
      */
-    tagId?: string;
+    tagId?: string | null;
 
     /**
      * The unique IDs of the tags assigned to the short link.
      */
-    tagIds?: Array<string>;
+    tagIds?: Array<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;
   }
 }
 

package/src/resources/links/index.ts

@@ -1,10 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export { BulkCreateResponse, BulkCreateParams, Bulk } from './bulk';
-export { InfoRetrieveParams, Info } from './info';
+export { InfoRetrieveResponse, InfoRetrieveParams, Info } from './info';
 export {
-  Link,
+  LinkCreateResponse,
+  LinkUpdateResponse,
   LinkListResponse,
+  LinkDeleteLinkResponse,
   LinkCreateParams,
   LinkUpdateParams,
   LinkListParams,

package/src/resources/links/info.ts

@@ -3,27 +3,211 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as InfoAPI from "./info";
-import * as LinksAPI from "./links";
 
 export class Info extends APIResource {
   /**
    * Retrieve the info for a link from their domain and key.
    */
-  retrieve(params: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<LinksAPI.Link> {
+  retrieve(params: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<InfoRetrieveResponse> {
     const { projectSlug = this._client.projectSlug, ...query } = params;
     return this._client.get('/links/info', { query: { projectSlug, ...query }, ...options });
   }
 }
 
+export interface InfoRetrieveResponse {
+  /**
+   * 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. If not provided, the primary domain for the
+   * project will be used (or `dub.sh` if the project has no domains).
+   */
+  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://d.to/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;
+
+  /**
+   * The full URL of the QR code for the short link (e.g.
+   * `https://api.dub.co/qr?url=https://dub.sh/try`).
+   */
+  qrCode: string;
+
+  /**
+   * Whether the short link uses link cloaking.
+   */
+  rewrite: boolean;
+
+  /**
+   * The full URL of the short link, including the https protocol (e.g.
+   * `https://dub.sh/try`).
+   */
+  shortLink: string;
+
+  /**
+   * The tags assigned to the short link.
+   */
+  tags: Array<InfoRetrieveResponse.Tag> | 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;
+}
+
+export namespace InfoRetrieveResponse {
+  export interface Tag {
+    /**
+     * The unique ID of the tag.
+     */
+    id: string;
+
+    /**
+     * The color of the tag.
+     */
+    color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
+
+    /**
+     * The name of the tag.
+     */
+    name: string;
+  }
+}
+
 export interface InfoRetrieveParams {
   /**
-   * The domain of the link to retrieve. E.g. for `dub.sh/github`, the domain is
-   * `dub.sh`.
+   * The domain of the link to retrieve. E.g. for `d.to/github`, the domain is
+   * `d.to`.
    */
   domain: string;
 
   /**
-   * The key of the link to retrieve. E.g. for `dub.sh/github`, the key is `github`.
+   * The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`.
    */
   key: string;
 
@@ -35,5 +219,6 @@ export interface InfoRetrieveParams {
 }
 
 export namespace Info {
+  export import InfoRetrieveResponse = InfoAPI.InfoRetrieveResponse;
   export import InfoRetrieveParams = InfoAPI.InfoRetrieveParams;
 }