dub 0.7.0 → 0.9.0

package/resources/links/info.d.ts

@@ -1,21 +1,171 @@
 import * as Core from 'dub/core';
 import { APIResource } from 'dub/resource';
 import * as InfoAPI from 'dub/resources/links/info';
-import * as LinksAPI from 'dub/resources/links/links';
 export declare 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>;
+}
+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 declare namespace InfoRetrieveResponse {
+    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;
     /**
@@ -25,6 +175,7 @@ export interface InfoRetrieveParams {
     projectSlug?: string;
 }
 export declare namespace Info {
+    export import InfoRetrieveResponse = InfoAPI.InfoRetrieveResponse;
     export import InfoRetrieveParams = InfoAPI.InfoRetrieveParams;
 }
 //# sourceMappingURL=info.d.ts.map

package/resources/links/info.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"info.d.ts","sourceRoot":"","sources":["../../src/resources/links/info.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,2BAA2B,CAAC;AAEtD,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;CAIpG;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,IAAI,CAAC;IACpB,MAAM,QAAQ,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAC/D"}
+{"version":3,"file":"info.d.ts","sourceRoot":"","sources":["../../src/resources/links/info.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAC;AAEpD,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAI3G;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;QAEzE;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,IAAI,CAAC;IACpB,MAAM,QAAQ,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAClE,MAAM,QAAQ,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAC/D"}

package/resources/links/info.js.map

@@ -1 +1 @@
-{"version":3,"file":"info.js","sourceRoot":"","sources":["../../src/resources/links/info.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2CAA2C;AAI3C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,MAA0B,EAAE,OAA6B;QAChE,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AARD,oBAQC;AAqBD,WAAiB,IAAI;AAErB,CAAC,EAFgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAEpB"}
+{"version":3,"file":"info.js","sourceRoot":"","sources":["../../src/resources/links/info.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2CAA2C;AAG3C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,MAA0B,EAAE,OAA6B;QAChE,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AARD,oBAQC;AA8MD,WAAiB,IAAI;AAGrB,CAAC,EAHgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAGpB"}

package/resources/links/info.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"info.mjs","sourceRoot":"","sources":["../../src/resources/links/info.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAI1C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,MAA0B,EAAE,OAA6B;QAChE,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AAqBD,WAAiB,IAAI;AAErB,CAAC,EAFgB,IAAI,KAAJ,IAAI,QAEpB"}
+{"version":3,"file":"info.mjs","sourceRoot":"","sources":["../../src/resources/links/info.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAG1C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,QAAQ,CAAC,MAA0B,EAAE,OAA6B;QAChE,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF;AA8MD,WAAiB,IAAI;AAGrB,CAAC,EAHgB,IAAI,KAAJ,IAAI,QAGpB"}