dub 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/README.md +14 -8
- package/index.d.mts +13 -1
- package/index.d.ts +13 -1
- package/index.d.ts.map +1 -1
- package/index.js +13 -1
- package/index.js.map +1 -1
- package/index.mjs +13 -1
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/links/bulk.d.ts +10 -9
- package/resources/links/bulk.d.ts.map +1 -1
- package/resources/links/bulk.js +1 -1
- package/resources/links/bulk.js.map +1 -1
- package/resources/links/bulk.mjs +1 -1
- package/resources/links/bulk.mjs.map +1 -1
- package/resources/links/info.d.ts +7 -7
- package/resources/links/info.d.ts.map +1 -1
- package/resources/links/info.js +3 -2
- package/resources/links/info.js.map +1 -1
- package/resources/links/info.mjs +3 -2
- package/resources/links/info.mjs.map +1 -1
- package/resources/links/links.d.ts +55 -40
- package/resources/links/links.d.ts.map +1 -1
- package/resources/links/links.js +6 -5
- package/resources/links/links.js.map +1 -1
- package/resources/links/links.mjs +6 -5
- package/resources/links/links.mjs.map +1 -1
- package/resources/projects/index.d.ts +2 -2
- package/resources/projects/index.d.ts.map +1 -1
- package/resources/projects/index.js.map +1 -1
- package/resources/projects/index.mjs.map +1 -1
- package/resources/projects/projects.d.ts +10 -1
- package/resources/projects/projects.d.ts.map +1 -1
- package/resources/projects/projects.js +2 -1
- package/resources/projects/projects.js.map +1 -1
- package/resources/projects/projects.mjs +2 -1
- package/resources/projects/projects.mjs.map +1 -1
- package/resources/projects/tags.d.ts +16 -3
- package/resources/projects/tags.d.ts.map +1 -1
- package/resources/projects/tags.js +4 -2
- package/resources/projects/tags.js.map +1 -1
- package/resources/projects/tags.mjs +4 -2
- package/resources/projects/tags.mjs.map +1 -1
- package/resources/qr.d.ts +40 -0
- package/resources/qr.d.ts.map +1 -1
- package/resources/qr.js +8 -0
- package/resources/qr.js.map +1 -1
- package/resources/qr.mjs +8 -0
- package/resources/qr.mjs.map +1 -1
- package/src/index.ts +35 -1
- package/src/resources/index.ts +8 -2
- package/src/resources/links/bulk.ts +11 -10
- package/src/resources/links/info.ts +9 -8
- package/src/resources/links/links.ts +63 -45
- package/src/resources/projects/index.ts +2 -2
- package/src/resources/projects/projects.ts +12 -1
- package/src/resources/projects/tags.ts +20 -3
- package/src/resources/qr.ts +51 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.6.0 (2024-02-02)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.5.0...v0.6.0](https://github.com/dubinc/dub-node/compare/v0.5.0...v0.6.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* OpenAPI spec update ([#34](https://github.com/dubinc/dub-node/issues/34)) ([b8b6277](https://github.com/dubinc/dub-node/commit/b8b62773c984d924b93083186164ee2929ec8a55))
|
|
10
|
+
|
|
11
|
+
## 0.5.0 (2024-02-02)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.4.0...v0.5.0](https://github.com/dubinc/dub-node/compare/v0.4.0...v0.5.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** OpenAPI spec update ([#32](https://github.com/dubinc/dub-node/issues/32)) ([d7de0a9](https://github.com/dubinc/dub-node/commit/d7de0a91966e7946b102ef601f328db375b368cc))
|
|
18
|
+
|
|
3
19
|
## 0.4.0 (2024-02-02)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v0.3.0...v0.4.0](https://github.com/dubinc/dub-node/compare/v0.3.0...v0.4.0)
|
package/README.md
CHANGED
|
@@ -25,7 +25,7 @@ import Dub from 'dub';
|
|
|
25
25
|
const dub = new Dub();
|
|
26
26
|
|
|
27
27
|
async function main() {
|
|
28
|
-
const projectDetails = await dub.projects.retrieve('REPLACE_ME');
|
|
28
|
+
const projectDetails = await dub.projects.retrieve({ projectSlug: 'REPLACE_ME' });
|
|
29
29
|
}
|
|
30
30
|
|
|
31
31
|
main();
|
|
@@ -42,7 +42,8 @@ import Dub from 'dub';
|
|
|
42
42
|
const dub = new Dub();
|
|
43
43
|
|
|
44
44
|
async function main() {
|
|
45
|
-
const
|
|
45
|
+
const params: Dub.ProjectRetrieveParams = { projectSlug: 'REPLACE_ME' };
|
|
46
|
+
const projectDetails: Dub.ProjectDetails = await dub.projects.retrieve(params);
|
|
46
47
|
}
|
|
47
48
|
|
|
48
49
|
main();
|
|
@@ -59,7 +60,7 @@ a subclass of `APIError` will be thrown:
|
|
|
59
60
|
<!-- prettier-ignore -->
|
|
60
61
|
```ts
|
|
61
62
|
async function main() {
|
|
62
|
-
const project = await dub.projects.retrieve('REPLACE_ME').catch((err) => {
|
|
63
|
+
const project = await dub.projects.retrieve({ projectSlug: 'REPLACE_ME' }).catch((err) => {
|
|
63
64
|
if (err instanceof Dub.APIError) {
|
|
64
65
|
console.log(err.status); // 400
|
|
65
66
|
console.log(err.name); // BadRequestError
|
|
@@ -99,10 +100,11 @@ You can use the `maxRetries` option to configure or disable this:
|
|
|
99
100
|
// Configure the default for all requests:
|
|
100
101
|
const dub = new Dub({
|
|
101
102
|
maxRetries: 0, // default is 2
|
|
103
|
+
projectSlug: 'dub_project_slug',
|
|
102
104
|
});
|
|
103
105
|
|
|
104
106
|
// Or, configure per-request:
|
|
105
|
-
await dub.projects.retrieve('REPLACE_ME', {
|
|
107
|
+
await dub.projects.retrieve({ projectSlug: 'REPLACE_ME' }, {
|
|
106
108
|
maxRetries: 5,
|
|
107
109
|
});
|
|
108
110
|
```
|
|
@@ -116,10 +118,11 @@ Requests time out after 1 minute by default. You can configure this with a `time
|
|
|
116
118
|
// Configure the default for all requests:
|
|
117
119
|
const dub = new Dub({
|
|
118
120
|
timeout: 20 * 1000, // 20 seconds (default is 1 minute)
|
|
121
|
+
projectSlug: 'dub_project_slug',
|
|
119
122
|
});
|
|
120
123
|
|
|
121
124
|
// Override per-request:
|
|
122
|
-
await dub.projects.retrieve('REPLACE_ME', {
|
|
125
|
+
await dub.projects.retrieve({ projectSlug: 'REPLACE_ME' }, {
|
|
123
126
|
timeout: 5 * 1000,
|
|
124
127
|
});
|
|
125
128
|
```
|
|
@@ -140,11 +143,13 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
|
|
|
140
143
|
```ts
|
|
141
144
|
const dub = new Dub();
|
|
142
145
|
|
|
143
|
-
const response = await dub.projects.retrieve('REPLACE_ME').asResponse();
|
|
146
|
+
const response = await dub.projects.retrieve({ projectSlug: 'REPLACE_ME' }).asResponse();
|
|
144
147
|
console.log(response.headers.get('X-My-Header'));
|
|
145
148
|
console.log(response.statusText); // access the underlying Response object
|
|
146
149
|
|
|
147
|
-
const { data: projectDetails, response: raw } = await dub.projects
|
|
150
|
+
const { data: projectDetails, response: raw } = await dub.projects
|
|
151
|
+
.retrieve({ projectSlug: 'REPLACE_ME' })
|
|
152
|
+
.withResponse();
|
|
148
153
|
console.log(raw.headers.get('X-My-Header'));
|
|
149
154
|
console.log(projectDetails);
|
|
150
155
|
```
|
|
@@ -201,10 +206,11 @@ import HttpsProxyAgent from 'https-proxy-agent';
|
|
|
201
206
|
// Configure the default for all requests:
|
|
202
207
|
const dub = new Dub({
|
|
203
208
|
httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
|
|
209
|
+
projectSlug: 'dub_project_slug',
|
|
204
210
|
});
|
|
205
211
|
|
|
206
212
|
// Override per-request:
|
|
207
|
-
await dub.projects.retrieve('REPLACE_ME', {
|
|
213
|
+
await dub.projects.retrieve({ projectSlug: 'REPLACE_ME' }, {
|
|
208
214
|
baseURL: 'http://localhost:8080/test-api',
|
|
209
215
|
httpAgent: new http.Agent({ keepAlive: false }),
|
|
210
216
|
})
|
package/index.d.mts
CHANGED
|
@@ -4,6 +4,11 @@ import { type Agent } from "./_shims/index.js";
|
|
|
4
4
|
import * as Uploads from "./uploads.js";
|
|
5
5
|
import * as API from 'dub/resources/index';
|
|
6
6
|
export interface ClientOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Defaults to process.env['DUB_API_KEY'].
|
|
9
|
+
*/
|
|
10
|
+
token?: string | undefined;
|
|
11
|
+
projectSlug?: string | null | undefined;
|
|
7
12
|
/**
|
|
8
13
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
9
14
|
*
|
|
@@ -56,10 +61,14 @@ export interface ClientOptions {
|
|
|
56
61
|
}
|
|
57
62
|
/** API Client for interfacing with the Dub API. */
|
|
58
63
|
export declare class Dub extends Core.APIClient {
|
|
64
|
+
token: string;
|
|
65
|
+
projectSlug: string | null;
|
|
59
66
|
private _options;
|
|
60
67
|
/**
|
|
61
68
|
* API Client for interfacing with the Dub API.
|
|
62
69
|
*
|
|
70
|
+
* @param {string | undefined} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
|
|
71
|
+
* @param {string | null | undefined} [opts.projectSlug]
|
|
63
72
|
* @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
|
|
64
73
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
65
74
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -68,12 +77,13 @@ export declare class Dub extends Core.APIClient {
|
|
|
68
77
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
69
78
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
70
79
|
*/
|
|
71
|
-
constructor({ baseURL, ...opts }?: ClientOptions);
|
|
80
|
+
constructor({ baseURL, token, projectSlug, ...opts }?: ClientOptions);
|
|
72
81
|
links: API.Links;
|
|
73
82
|
qr: API.Qr;
|
|
74
83
|
projects: API.Projects;
|
|
75
84
|
protected defaultQuery(): Core.DefaultQuery | undefined;
|
|
76
85
|
protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
86
|
+
protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
77
87
|
static Dub: typeof Dub;
|
|
78
88
|
static DubError: typeof Errors.DubError;
|
|
79
89
|
static APIError: typeof Errors.APIError;
|
|
@@ -104,10 +114,12 @@ export declare namespace Dub {
|
|
|
104
114
|
export import LinkListParams = API.LinkListParams;
|
|
105
115
|
export import LinkDeleteLinkParams = API.LinkDeleteLinkParams;
|
|
106
116
|
export import Qr = API.Qr;
|
|
117
|
+
export import QrRetrieveParams = API.QrRetrieveParams;
|
|
107
118
|
export import Projects = API.Projects;
|
|
108
119
|
export import Project = API.Project;
|
|
109
120
|
export import ProjectDetails = API.ProjectDetails;
|
|
110
121
|
export import ProjectListResponse = API.ProjectListResponse;
|
|
122
|
+
export import ProjectRetrieveParams = API.ProjectRetrieveParams;
|
|
111
123
|
}
|
|
112
124
|
export default Dub;
|
|
113
125
|
//# sourceMappingURL=index.d.ts.map
|
package/index.d.ts
CHANGED
|
@@ -4,6 +4,11 @@ import { type Agent } from "./_shims/index.js";
|
|
|
4
4
|
import * as Uploads from "./uploads.js";
|
|
5
5
|
import * as API from 'dub/resources/index';
|
|
6
6
|
export interface ClientOptions {
|
|
7
|
+
/**
|
|
8
|
+
* Defaults to process.env['DUB_API_KEY'].
|
|
9
|
+
*/
|
|
10
|
+
token?: string | undefined;
|
|
11
|
+
projectSlug?: string | null | undefined;
|
|
7
12
|
/**
|
|
8
13
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
9
14
|
*
|
|
@@ -56,10 +61,14 @@ export interface ClientOptions {
|
|
|
56
61
|
}
|
|
57
62
|
/** API Client for interfacing with the Dub API. */
|
|
58
63
|
export declare class Dub extends Core.APIClient {
|
|
64
|
+
token: string;
|
|
65
|
+
projectSlug: string | null;
|
|
59
66
|
private _options;
|
|
60
67
|
/**
|
|
61
68
|
* API Client for interfacing with the Dub API.
|
|
62
69
|
*
|
|
70
|
+
* @param {string | undefined} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
|
|
71
|
+
* @param {string | null | undefined} [opts.projectSlug]
|
|
63
72
|
* @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
|
|
64
73
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
65
74
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -68,12 +77,13 @@ export declare class Dub extends Core.APIClient {
|
|
|
68
77
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
69
78
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
70
79
|
*/
|
|
71
|
-
constructor({ baseURL, ...opts }?: ClientOptions);
|
|
80
|
+
constructor({ baseURL, token, projectSlug, ...opts }?: ClientOptions);
|
|
72
81
|
links: API.Links;
|
|
73
82
|
qr: API.Qr;
|
|
74
83
|
projects: API.Projects;
|
|
75
84
|
protected defaultQuery(): Core.DefaultQuery | undefined;
|
|
76
85
|
protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
86
|
+
protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
77
87
|
static Dub: typeof Dub;
|
|
78
88
|
static DubError: typeof Errors.DubError;
|
|
79
89
|
static APIError: typeof Errors.APIError;
|
|
@@ -104,10 +114,12 @@ export declare namespace Dub {
|
|
|
104
114
|
export import LinkListParams = API.LinkListParams;
|
|
105
115
|
export import LinkDeleteLinkParams = API.LinkDeleteLinkParams;
|
|
106
116
|
export import Qr = API.Qr;
|
|
117
|
+
export import QrRetrieveParams = API.QrRetrieveParams;
|
|
107
118
|
export import Projects = API.Projects;
|
|
108
119
|
export import Project = API.Project;
|
|
109
120
|
export import ProjectDetails = API.ProjectDetails;
|
|
110
121
|
export import ProjectListResponse = API.ProjectListResponse;
|
|
122
|
+
export import ProjectRetrieveParams = API.ProjectRetrieveParams;
|
|
111
123
|
}
|
|
112
124
|
export default Dub;
|
|
113
125
|
//# sourceMappingURL=index.d.ts.map
|
package/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAE3C,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CAClC;AAED,mDAAmD;AACnD,qBAAa,GAAI,SAAQ,IAAI,CAAC,SAAS;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAE3C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;CAClC;AAED,mDAAmD;AACnD,qBAAa,GAAI,SAAQ,IAAI,CAAC,SAAS;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAAsC,EACtC,KAAmC,EACnC,WAAkB,EAClB,GAAG,IAAI,EACR,GAAE,aAAkB;IA2BrB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAoB;IAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;cAE7B,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAI5E,MAAM,CAAC,GAAG,aAAQ;IAElB,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;CACnE;AAED,eAAO,MACL,QAAQ,0BACR,QAAQ,0BACR,kBAAkB,oCAClB,yBAAyB,2CACzB,iBAAiB,mCACjB,aAAa,+BACb,aAAa,+BACb,cAAc,gCACd,eAAe,iCACf,mBAAmB,qCACnB,mBAAmB,qCACnB,qBAAqB,uCACrB,wBAAwB,wCAChB,CAAC;AAEX,MAAM,QAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,MAAM,QAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAElD,yBAAiB,GAAG,CAAC;IAEnB,MAAM,QAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACtC,MAAM,QAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAElD,MAAM,QAAQ,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEnD,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;IAClD,MAAM,QAAQ,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAE9D,MAAM,QAAQ,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;IAC1B,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAEtD,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;IAClD,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAC5D,MAAM,QAAQ,qBAAqB,GAAG,GAAG,CAAC,qBAAqB,CAAC;CACjE;AAED,eAAe,GAAG,CAAC"}
|
package/index.js
CHANGED
|
@@ -35,6 +35,8 @@ class Dub extends Core.APIClient {
|
|
|
35
35
|
/**
|
|
36
36
|
* API Client for interfacing with the Dub API.
|
|
37
37
|
*
|
|
38
|
+
* @param {string | undefined} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
|
|
39
|
+
* @param {string | null | undefined} [opts.projectSlug]
|
|
38
40
|
* @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
|
|
39
41
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
40
42
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -43,8 +45,13 @@ class Dub extends Core.APIClient {
|
|
|
43
45
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
44
46
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
45
47
|
*/
|
|
46
|
-
constructor({ baseURL = Core.readEnv('DUB_BASE_URL'), ...opts } = {}) {
|
|
48
|
+
constructor({ baseURL = Core.readEnv('DUB_BASE_URL'), token = Core.readEnv('DUB_API_KEY'), projectSlug = null, ...opts } = {}) {
|
|
49
|
+
if (token === undefined) {
|
|
50
|
+
throw new Errors.DubError("The DUB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Dub client with an token option, like new Dub({ token: 'My Token' }).");
|
|
51
|
+
}
|
|
47
52
|
const options = {
|
|
53
|
+
token,
|
|
54
|
+
projectSlug,
|
|
48
55
|
...opts,
|
|
49
56
|
baseURL: baseURL || `https://api.dub.co`,
|
|
50
57
|
};
|
|
@@ -59,6 +66,8 @@ class Dub extends Core.APIClient {
|
|
|
59
66
|
this.qr = new API.Qr(this);
|
|
60
67
|
this.projects = new API.Projects(this);
|
|
61
68
|
this._options = options;
|
|
69
|
+
this.token = token;
|
|
70
|
+
this.projectSlug = projectSlug;
|
|
62
71
|
}
|
|
63
72
|
defaultQuery() {
|
|
64
73
|
return this._options.defaultQuery;
|
|
@@ -69,6 +78,9 @@ class Dub extends Core.APIClient {
|
|
|
69
78
|
...this._options.defaultHeaders,
|
|
70
79
|
};
|
|
71
80
|
}
|
|
81
|
+
authHeaders(opts) {
|
|
82
|
+
return { Authorization: `Bearer ${this.token}` };
|
|
83
|
+
}
|
|
72
84
|
}
|
|
73
85
|
exports.Dub = Dub;
|
|
74
86
|
_a = Dub;
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;;AAErD,gDAA+B;AAC/B,mDAAkC;AAElC,sDAAqC;AACrC,yDAA2C;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;;AAErD,gDAA+B;AAC/B,mDAAkC;AAElC,sDAAqC;AACrC,yDAA2C;AAmE3C,mDAAmD;AACnD,MAAa,GAAI,SAAQ,IAAI,CAAC,SAAS;IAMrC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EACtC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EACnC,WAAW,GAAG,IAAI,EAClB,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,IAAI,MAAM,CAAC,QAAQ,CACvB,uKAAuK,CACxK,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,KAAK;YACL,WAAW;YACX,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,oBAAoB;SACzC,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,OAAE,GAAW,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9B,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAR9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAMkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;IACnD,CAAC;;AApEH,kBAqFC;;AAfQ,OAAG,GAAG,EAAI,CAAC;AAEX,YAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,YAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,sBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,6BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,qBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,iBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,iBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,kBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,mBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,4BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAIlE,gBAAQ,GAaN,MAAM,WAZR,gBAAQ,GAYN,MAAM,WAXR,0BAAkB,GAWhB,MAAM,qBAVR,iCAAyB,GAUvB,MAAM,4BATR,yBAAiB,GASf,MAAM,oBARR,qBAAa,GAQX,MAAM,gBAPR,qBAAa,GAOX,MAAM,gBANR,sBAAc,GAMZ,MAAM,iBALR,uBAAe,GAKb,MAAM,kBAJR,2BAAmB,GAIjB,MAAM,sBAHR,2BAAmB,GAGjB,MAAM,sBAFR,6BAAqB,GAEnB,MAAM,wBADR,gCAAwB,GACtB,MAAM,0BAAC;AAEG,QAAA,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,QAAA,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAElD,WAAiB,GAAG;IAClB,mBAAmB;IACL,UAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACxB,gBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAIpC,SAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAQlB,MAAE,GAAG,GAAG,CAAC,EAAE,CAAC;IAGZ,YAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;AAKxC,CAAC,EAvBgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAuBnB;AAED,kBAAe,GAAG,CAAC"}
|
package/index.mjs
CHANGED
|
@@ -9,6 +9,8 @@ export class Dub extends Core.APIClient {
|
|
|
9
9
|
/**
|
|
10
10
|
* API Client for interfacing with the Dub API.
|
|
11
11
|
*
|
|
12
|
+
* @param {string | undefined} [opts.token=process.env['DUB_API_KEY'] ?? undefined]
|
|
13
|
+
* @param {string | null | undefined} [opts.projectSlug]
|
|
12
14
|
* @param {string} [opts.baseURL=process.env['DUB_BASE_URL'] ?? https://api.dub.co] - Override the default base URL for the API.
|
|
13
15
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
14
16
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -17,8 +19,13 @@ export class Dub extends Core.APIClient {
|
|
|
17
19
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
18
20
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
19
21
|
*/
|
|
20
|
-
constructor({ baseURL = Core.readEnv('DUB_BASE_URL'), ...opts } = {}) {
|
|
22
|
+
constructor({ baseURL = Core.readEnv('DUB_BASE_URL'), token = Core.readEnv('DUB_API_KEY'), projectSlug = null, ...opts } = {}) {
|
|
23
|
+
if (token === undefined) {
|
|
24
|
+
throw new Errors.DubError("The DUB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Dub client with an token option, like new Dub({ token: 'My Token' }).");
|
|
25
|
+
}
|
|
21
26
|
const options = {
|
|
27
|
+
token,
|
|
28
|
+
projectSlug,
|
|
22
29
|
...opts,
|
|
23
30
|
baseURL: baseURL || `https://api.dub.co`,
|
|
24
31
|
};
|
|
@@ -33,6 +40,8 @@ export class Dub extends Core.APIClient {
|
|
|
33
40
|
this.qr = new API.Qr(this);
|
|
34
41
|
this.projects = new API.Projects(this);
|
|
35
42
|
this._options = options;
|
|
43
|
+
this.token = token;
|
|
44
|
+
this.projectSlug = projectSlug;
|
|
36
45
|
}
|
|
37
46
|
defaultQuery() {
|
|
38
47
|
return this._options.defaultQuery;
|
|
@@ -43,6 +52,9 @@ export class Dub extends Core.APIClient {
|
|
|
43
52
|
...this._options.defaultHeaders,
|
|
44
53
|
};
|
|
45
54
|
}
|
|
55
|
+
authHeaders(opts) {
|
|
56
|
+
return { Authorization: `Bearer ${this.token}` };
|
|
57
|
+
}
|
|
46
58
|
}
|
|
47
59
|
_a = Dub;
|
|
48
60
|
Dub.Dub = _a;
|
package/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;;OAE9C,KAAK,IAAI;OACT,KAAK,MAAM;OAEX,KAAK,OAAO;OACZ,KAAK,GAAG,MAAM,qBAAqB;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;;OAE9C,KAAK,IAAI;OACT,KAAK,MAAM;OAEX,KAAK,OAAO;OACZ,KAAK,GAAG,MAAM,qBAAqB;AAmE1C,mDAAmD;AACnD,MAAM,OAAO,GAAI,SAAQ,IAAI,CAAC,SAAS;IAMrC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EACtC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EACnC,WAAW,GAAG,IAAI,EAClB,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,MAAM,IAAI,MAAM,CAAC,QAAQ,CACvB,uKAAuK,CACxK,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,KAAK;YACL,WAAW;YACX,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,oBAAoB;SACzC,CAAC;QAEF,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO,CAAC,OAAQ;YACzB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,cAAc;YAChD,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QAOL,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,OAAE,GAAW,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9B,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAR9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAMkB,YAAY;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;IACpC,CAAC;IAEkB,cAAc,CAAC,IAA8B;QAC9D,OAAO;YACL,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;YAC7B,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc;SAChC,CAAC;IACJ,CAAC;IAEkB,WAAW,CAAC,IAA8B;QAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;IACnD,CAAC;;;AAEM,OAAG,GAAG,EAAI,CAAC;AAEX,YAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,YAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,sBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAC/C,6BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,qBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC;AAC7C,iBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,iBAAa,GAAG,MAAM,CAAC,aAAa,CAAC;AACrC,kBAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,mBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,4BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAGpE,MAAM,CAAC,MAAM,EACX,QAAQ,EACR,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,GAAG,MAAM,CAAC;AAEX,MAAM,KAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,MAAM,KAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAElD,WAAiB,GAAG;IAClB,mBAAmB;IACL,UAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACxB,gBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAIpC,SAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAQlB,MAAE,GAAG,GAAG,CAAC,EAAE,CAAC;IAGZ,YAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;AAKxC,CAAC,EAvBgB,GAAG,KAAH,GAAG,QAuBnB;AAED,eAAe,GAAG,CAAC"}
|
package/package.json
CHANGED
package/resources/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { Link, LinkListResponse, LinkCreateParams, LinkUpdateParams, LinkListParams, LinkDeleteLinkParams, Links, } from "./links/links.js";
|
|
2
|
-
export { Project, ProjectDetails, ProjectListResponse, Projects } from "./projects/projects.js";
|
|
3
|
-
export { Qr } from "./qr.js";
|
|
2
|
+
export { Project, ProjectDetails, ProjectListResponse, ProjectRetrieveParams, Projects, } from "./projects/projects.js";
|
|
3
|
+
export { QrRetrieveParams, Qr } from "./qr.js";
|
|
4
4
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,IAAI,EACJ,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,KAAK,GACN,MAAM,eAAe,CAAC;AACvB,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,IAAI,EACJ,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,KAAK,GACN,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,OAAO,EACP,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,GACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC"}
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,0CAQuB;AADrB,8FAAA,KAAK,OAAA;AAEP,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,0CAQuB;AADrB,8FAAA,KAAK,OAAA;AAEP,mDAM6B;AAD3B,oGAAA,QAAQ,OAAA;AAEV,8BAA4C;AAAjB,wFAAA,EAAE,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless.
|
|
2
2
|
export { Links, } from "./links/links.mjs";
|
|
3
|
-
export { Projects } from "./projects/projects.mjs";
|
|
3
|
+
export { Projects, } from "./projects/projects.mjs";
|
|
4
4
|
export { Qr } from "./qr.mjs";
|
|
5
5
|
//# sourceMappingURL=index.mjs.map
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAOL,KAAK,GACN;OACM,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAOL,KAAK,GACN;OACM,EAKL,QAAQ,GACT;OACM,EAAoB,EAAE,EAAE"}
|
|
@@ -12,9 +12,9 @@ export type BulkCreateResponse = Array<LinksAPI.Link>;
|
|
|
12
12
|
export interface BulkCreateParams {
|
|
13
13
|
/**
|
|
14
14
|
* Query param: The slug for the project to create links for. E.g. for
|
|
15
|
-
* app.dub.co/acme
|
|
15
|
+
* `app.dub.co/acme`, the projectSlug is `acme`.
|
|
16
16
|
*/
|
|
17
|
-
projectSlug
|
|
17
|
+
projectSlug?: string;
|
|
18
18
|
}
|
|
19
19
|
export declare namespace BulkCreateParams {
|
|
20
20
|
interface Body {
|
|
@@ -31,12 +31,13 @@ export declare namespace BulkCreateParams {
|
|
|
31
31
|
*/
|
|
32
32
|
comments?: string | null;
|
|
33
33
|
/**
|
|
34
|
-
* The description of the short link generated via api.dub.co/metatags
|
|
34
|
+
* The description of the short link generated via `api.dub.co/metatags`. Will be
|
|
35
35
|
* used for Custom Social Media Cards if `proxy` is true.
|
|
36
36
|
*/
|
|
37
37
|
description?: string | null;
|
|
38
38
|
/**
|
|
39
|
-
* The domain of the short link.
|
|
39
|
+
* The domain of the short link. If not provided, the primary domain for the
|
|
40
|
+
* project will be used (or `dub.sh` if the project has no domains).
|
|
40
41
|
*/
|
|
41
42
|
domain?: string;
|
|
42
43
|
/**
|
|
@@ -46,12 +47,12 @@ export declare namespace BulkCreateParams {
|
|
|
46
47
|
expiresAt?: string | null;
|
|
47
48
|
/**
|
|
48
49
|
* Geo targeting information for the short link in JSON format {[COUNTRY]:
|
|
49
|
-
*
|
|
50
|
+
* `https://example.com` }. Learn more: `https://dub.sh/geo`
|
|
50
51
|
*/
|
|
51
52
|
geo?: Record<string, string> | null;
|
|
52
53
|
/**
|
|
53
|
-
* The image of the short link generated via api.dub.co/metatags
|
|
54
|
-
* Custom Social Media Cards if `proxy` is true.
|
|
54
|
+
* The image of the short link generated via `api.dub.co/metatags`. Will be used
|
|
55
|
+
* for Custom Social Media Cards if `proxy` is true.
|
|
55
56
|
*/
|
|
56
57
|
image?: string | null;
|
|
57
58
|
/**
|
|
@@ -84,8 +85,8 @@ export declare namespace BulkCreateParams {
|
|
|
84
85
|
*/
|
|
85
86
|
tagId?: string | null;
|
|
86
87
|
/**
|
|
87
|
-
* The title of the short link generated via api.dub.co/metatags
|
|
88
|
-
* Custom Social Media Cards if `proxy` is true.
|
|
88
|
+
* The title of the short link generated via `api.dub.co/metatags`. Will be used
|
|
89
|
+
* for Custom Social Media Cards if `proxy` is true.
|
|
89
90
|
*/
|
|
90
91
|
title?: string | null;
|
|
91
92
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/links/bulk.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,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAIrG;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEtD,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/links/bulk.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,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;CAIrG;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEtD,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,yBAAiB,IAAI,CAAC;IACpB,MAAM,QAAQ,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAC9D,MAAM,QAAQ,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAC3D"}
|
package/resources/links/bulk.js
CHANGED
|
@@ -8,7 +8,7 @@ class Bulk extends resource_1.APIResource {
|
|
|
8
8
|
* Bulk create up to 100 links for the authenticated project.
|
|
9
9
|
*/
|
|
10
10
|
create(params, options) {
|
|
11
|
-
const { projectSlug, ...body } = params;
|
|
11
|
+
const { projectSlug = this._client.projectSlug, ...body } = params;
|
|
12
12
|
return this._client.post('/links/bulk', { query: { projectSlug }, body, ...options });
|
|
13
13
|
}
|
|
14
14
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/links/bulk.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2CAA2C;AAI3C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAwB,EAAE,OAA6B;QAC5D,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"bulk.js","sourceRoot":"","sources":["../../src/resources/links/bulk.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2CAA2C;AAI3C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAwB,EAAE,OAA6B;QAC5D,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AARD,oBAQC;AA4GD,WAAiB,IAAI;AAGrB,CAAC,EAHgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAGpB"}
|
package/resources/links/bulk.mjs
CHANGED
|
@@ -5,7 +5,7 @@ export class Bulk extends APIResource {
|
|
|
5
5
|
* Bulk create up to 100 links for the authenticated project.
|
|
6
6
|
*/
|
|
7
7
|
create(params, options) {
|
|
8
|
-
const { projectSlug, ...body } = params;
|
|
8
|
+
const { projectSlug = this._client.projectSlug, ...body } = params;
|
|
9
9
|
return this._client.post('/links/bulk', { query: { projectSlug }, body, ...options });
|
|
10
10
|
}
|
|
11
11
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/links/bulk.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAI1C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAwB,EAAE,OAA6B;QAC5D,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"bulk.mjs","sourceRoot":"","sources":["../../src/resources/links/bulk.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,cAAc;AAI1C,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CAAC,MAAwB,EAAE,OAA6B;QAC5D,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AA4GD,WAAiB,IAAI;AAGrB,CAAC,EAHgB,IAAI,KAAJ,IAAI,QAGpB"}
|
|
@@ -6,23 +6,23 @@ export declare class Info extends APIResource {
|
|
|
6
6
|
/**
|
|
7
7
|
* Retrieve the info for a link from their domain and key.
|
|
8
8
|
*/
|
|
9
|
-
retrieve(
|
|
9
|
+
retrieve(params: InfoRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<LinksAPI.Link>;
|
|
10
10
|
}
|
|
11
11
|
export interface InfoRetrieveParams {
|
|
12
12
|
/**
|
|
13
|
-
* The domain of the link to retrieve. E.g. for dub.sh/github
|
|
14
|
-
*
|
|
13
|
+
* The domain of the link to retrieve. E.g. for `dub.sh/github`, the domain is
|
|
14
|
+
* `dub.sh`.
|
|
15
15
|
*/
|
|
16
16
|
domain: string;
|
|
17
17
|
/**
|
|
18
|
-
* The key of the link to retrieve. E.g. for dub.sh/github
|
|
18
|
+
* The key of the link to retrieve. E.g. for `dub.sh/github`, the key is `github`.
|
|
19
19
|
*/
|
|
20
20
|
key: string;
|
|
21
21
|
/**
|
|
22
|
-
* The slug for the project that the link belongs to. E.g. for app.dub.co/acme
|
|
23
|
-
* projectSlug is
|
|
22
|
+
* The slug for the project that the link belongs to. E.g. for `app.dub.co/acme`,
|
|
23
|
+
* the projectSlug is `acme`.
|
|
24
24
|
*/
|
|
25
|
-
projectSlug
|
|
25
|
+
projectSlug?: string;
|
|
26
26
|
}
|
|
27
27
|
export declare namespace Info {
|
|
28
28
|
export import InfoRetrieveParams = InfoAPI.InfoRetrieveParams;
|
|
@@ -1 +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,
|
|
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"}
|
package/resources/links/info.js
CHANGED
|
@@ -7,8 +7,9 @@ class Info extends resource_1.APIResource {
|
|
|
7
7
|
/**
|
|
8
8
|
* Retrieve the info for a link from their domain and key.
|
|
9
9
|
*/
|
|
10
|
-
retrieve(
|
|
11
|
-
|
|
10
|
+
retrieve(params, options) {
|
|
11
|
+
const { projectSlug = this._client.projectSlug, ...query } = params;
|
|
12
|
+
return this._client.get('/links/info', { query: { projectSlug, ...query }, ...options });
|
|
12
13
|
}
|
|
13
14
|
}
|
|
14
15
|
exports.Info = Info;
|
|
@@ -1 +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,
|
|
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"}
|
package/resources/links/info.mjs
CHANGED
|
@@ -4,8 +4,9 @@ export class Info extends APIResource {
|
|
|
4
4
|
/**
|
|
5
5
|
* Retrieve the info for a link from their domain and key.
|
|
6
6
|
*/
|
|
7
|
-
retrieve(
|
|
8
|
-
|
|
7
|
+
retrieve(params, options) {
|
|
8
|
+
const { projectSlug = this._client.projectSlug, ...query } = params;
|
|
9
|
+
return this._client.get('/links/info', { query: { projectSlug, ...query }, ...options });
|
|
9
10
|
}
|
|
10
11
|
}
|
|
11
12
|
(function (Info) {
|
|
@@ -1 +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,
|
|
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"}
|