orb-billing 1.30.0 → 1.31.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 +13 -0
- package/README.md +2 -2
- package/index.d.mts +6 -4
- package/index.d.ts +6 -4
- package/index.d.ts.map +1 -1
- package/index.js +4 -4
- package/index.js.map +1 -1
- package/index.mjs +4 -4
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +11 -5
- 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,18 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.31.0 (2023-12-04)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.30.0...v1.31.0](https://github.com/orbcorp/orb-node/compare/v1.30.0...v1.31.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **client:** support reading the base url from an env variable ([#48](https://github.com/orbcorp/orb-node/issues/48)) ([e147a4a](https://github.com/orbcorp/orb-node/commit/e147a4a96b0f798ba98a7f12eabe2f8bb40b3021))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Documentation
|
|
13
|
+
|
|
14
|
+
* **readme:** update example snippets ([#46](https://github.com/orbcorp/orb-node/issues/46)) ([3ec5d0b](https://github.com/orbcorp/orb-node/commit/3ec5d0bc95b7522153ff57836aa7c234e363089c))
|
|
15
|
+
|
|
3
16
|
## 1.30.0 (2023-11-28)
|
|
4
17
|
|
|
5
18
|
Full Changelog: [v1.29.0...v1.30.0](https://github.com/orbcorp/orb-node/compare/v1.29.0...v1.30.0)
|
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ The full API of this library can be found in [api.md](https://www.github.com/orb
|
|
|
22
22
|
import Orb from 'orb-billing';
|
|
23
23
|
|
|
24
24
|
const orb = new Orb({
|
|
25
|
-
apiKey: '
|
|
25
|
+
apiKey: process.env['ORB_API_KEY'], // This is the default and can be omitted
|
|
26
26
|
});
|
|
27
27
|
|
|
28
28
|
async function main() {
|
|
@@ -42,7 +42,7 @@ This library includes TypeScript definitions for all request params and response
|
|
|
42
42
|
import Orb from 'orb-billing';
|
|
43
43
|
|
|
44
44
|
const orb = new Orb({
|
|
45
|
-
apiKey: '
|
|
45
|
+
apiKey: process.env['ORB_API_KEY'], // This is the default and can be omitted
|
|
46
46
|
});
|
|
47
47
|
|
|
48
48
|
async function main() {
|
package/index.d.mts
CHANGED
|
@@ -11,8 +11,10 @@ export interface ClientOptions {
|
|
|
11
11
|
apiKey?: string;
|
|
12
12
|
/**
|
|
13
13
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
14
|
+
*
|
|
15
|
+
* Defaults to process.env['ORB_BASE_URL'].
|
|
14
16
|
*/
|
|
15
|
-
baseURL?: string;
|
|
17
|
+
baseURL?: string | null | undefined;
|
|
16
18
|
/**
|
|
17
19
|
* The maximum amount of time (in milliseconds) that the client should wait for a response
|
|
18
20
|
* from the server before timing out a single request.
|
|
@@ -64,8 +66,8 @@ export declare class Orb extends Core.APIClient {
|
|
|
64
66
|
/**
|
|
65
67
|
* API Client for interfacing with the Orb API.
|
|
66
68
|
*
|
|
67
|
-
* @param {string} [opts.apiKey
|
|
68
|
-
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
69
|
+
* @param {string} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
70
|
+
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
69
71
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
70
72
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
71
73
|
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -73,7 +75,7 @@ export declare class Orb extends Core.APIClient {
|
|
|
73
75
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
74
76
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
75
77
|
*/
|
|
76
|
-
constructor({ apiKey, ...opts }?: ClientOptions);
|
|
78
|
+
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
|
77
79
|
topLevel: API.TopLevel;
|
|
78
80
|
coupons: API.Coupons;
|
|
79
81
|
creditNotes: API.CreditNotes;
|
package/index.d.ts
CHANGED
|
@@ -11,8 +11,10 @@ export interface ClientOptions {
|
|
|
11
11
|
apiKey?: string;
|
|
12
12
|
/**
|
|
13
13
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
14
|
+
*
|
|
15
|
+
* Defaults to process.env['ORB_BASE_URL'].
|
|
14
16
|
*/
|
|
15
|
-
baseURL?: string;
|
|
17
|
+
baseURL?: string | null | undefined;
|
|
16
18
|
/**
|
|
17
19
|
* The maximum amount of time (in milliseconds) that the client should wait for a response
|
|
18
20
|
* from the server before timing out a single request.
|
|
@@ -64,8 +66,8 @@ export declare class Orb extends Core.APIClient {
|
|
|
64
66
|
/**
|
|
65
67
|
* API Client for interfacing with the Orb API.
|
|
66
68
|
*
|
|
67
|
-
* @param {string} [opts.apiKey
|
|
68
|
-
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
69
|
+
* @param {string} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
70
|
+
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
69
71
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
70
72
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
71
73
|
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -73,7 +75,7 @@ export declare class Orb extends Core.APIClient {
|
|
|
73
75
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
74
76
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
75
77
|
*/
|
|
76
|
-
constructor({ apiKey, ...opts }?: ClientOptions);
|
|
78
|
+
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
|
77
79
|
topLevel: API.TopLevel;
|
|
78
80
|
coupons: API.Coupons;
|
|
79
81
|
creditNotes: API.CreditNotes;
|
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,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,GAAG,MAAM,6BAA6B,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB
|
|
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,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,OAAO,KAAK,GAAG,MAAM,6BAA6B,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;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,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAsC,EACtC,MAAoC,EACpC,GAAG,IAAI,EACR,GAAE,aAAkB;IA0BrB,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,WAAW,EAAE,GAAG,CAAC,WAAW,CAA6B;IACzD,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,gBAAgB,EAAE,GAAG,CAAC,gBAAgB,CAAkC;IACxE,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,KAAK,EAAE,GAAG,CAAC,KAAK,CAAuB;IACvC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,aAAa,EAAE,GAAG,CAAC,aAAa,CAA+B;cAE5C,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;cAIzD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,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,WAAW,4BAAsB;IACxC,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,gBAAgB,iCAA2B;IAClD,MAAM,CAAC,gBAAgB,iCAA2B;IAClD,MAAM,CAAC,gBAAgB,iCAA2B;IAClD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,sBAAsB,uCAAiC;IAC9D,MAAM,CAAC,sBAAsB,uCAAiC;IAC9D,MAAM,CAAC,sBAAsB,uCAAiC;IAC9D,MAAM,CAAC,wBAAwB,yCAAmC;IAClE,MAAM,CAAC,yBAAyB,0CAAoC;CACrE;AAED,eAAO,MACL,QAAQ,0BACR,QAAQ,0BACR,kBAAkB,oCAClB,yBAAyB,2CACzB,iBAAiB,mCACjB,WAAW,6BACX,aAAa,+BACb,aAAa,+BACb,cAAc,gCACd,eAAe,iCACf,eAAe,iCACf,eAAe,iCACf,gBAAgB,kCAChB,gBAAgB,kCAChB,gBAAgB,kCAChB,mBAAmB,qCACnB,mBAAmB,qCACnB,mBAAmB,qCACnB,mBAAmB,qCACnB,qBAAqB,uCACrB,sBAAsB,wCACtB,sBAAsB,wCACtB,sBAAsB,wCACtB,wBAAwB,0CACxB,yBAAyB,yCACjB,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,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IACrC,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,MAAM,QAAQ,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;IAErD,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAE9D,MAAM,QAAQ,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAClC,MAAM,QAAQ,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC5C,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAEtD,MAAM,QAAQ,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAC5C,MAAM,QAAQ,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IAC1C,MAAM,QAAQ,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;IACpD,MAAM,QAAQ,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAE9D,MAAM,QAAQ,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACxC,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAChD,MAAM,QAAQ,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC9D,MAAM,QAAQ,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC9D,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,gCAAgC,GAAG,GAAG,CAAC,gCAAgC,CAAC;IAEtF,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAClC,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAC5D,MAAM,QAAQ,sBAAsB,GAAG,GAAG,CAAC,sBAAsB,CAAC;IAClE,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAC5D,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAC5D,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IAExD,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,6BAA6B,GAAG,GAAG,CAAC,6BAA6B,CAAC;IAChF,MAAM,QAAQ,2BAA2B,GAAG,GAAG,CAAC,2BAA2B,CAAC;IAE5E,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,4BAA4B,GAAG,GAAG,CAAC,4BAA4B,CAAC;IAC9E,MAAM,QAAQ,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC9C,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAC5D,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,0BAA0B,GAAG,GAAG,CAAC,0BAA0B,CAAC;IAC1E,MAAM,QAAQ,qBAAqB,GAAG,GAAG,CAAC,qBAAqB,CAAC;IAEhE,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACxC,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACtD,MAAM,QAAQ,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;IAElD,MAAM,QAAQ,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC9D,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAC5D,MAAM,QAAQ,uBAAuB,GAAG,GAAG,CAAC,uBAAuB,CAAC;IACpE,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAEtD,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACxC,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;IAElD,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAClC,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IAC1C,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;IAEpD,MAAM,QAAQ,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAChD,MAAM,QAAQ,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAC9C,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,8BAA8B,GAAG,GAAG,CAAC,8BAA8B,CAAC;IAClF,MAAM,QAAQ,iCAAiC,GAAG,GAAG,CAAC,iCAAiC,CAAC;IACxF,MAAM,QAAQ,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IACxD,MAAM,QAAQ,sCAAsC,GAAG,GAAG,CAAC,sCAAsC,CAAC;IAClG,MAAM,QAAQ,wBAAwB,GAAG,GAAG,CAAC,wBAAwB,CAAC;IACtE,MAAM,QAAQ,sBAAsB,GAAG,GAAG,CAAC,sBAAsB,CAAC;IAClE,MAAM,QAAQ,wBAAwB,GAAG,GAAG,CAAC,wBAAwB,CAAC;IACtE,MAAM,QAAQ,4BAA4B,GAAG,GAAG,CAAC,4BAA4B,CAAC;IAC9E,MAAM,QAAQ,+BAA+B,GAAG,GAAG,CAAC,+BAA+B,CAAC;IACpF,MAAM,QAAQ,4BAA4B,GAAG,GAAG,CAAC,4BAA4B,CAAC;IAC9E,MAAM,QAAQ,gCAAgC,GAAG,GAAG,CAAC,gCAAgC,CAAC;IACtF,MAAM,QAAQ,oCAAoC,GAAG,GAAG,CAAC,oCAAoC,CAAC;IAC9F,MAAM,QAAQ,8BAA8B,GAAG,GAAG,CAAC,8BAA8B,CAAC;IAClF,MAAM,QAAQ,mDAAmD,GAAG,GAAG,CAAC,mDAAmD,CAAC;IAC5H,MAAM,QAAQ,wCAAwC,GAAG,GAAG,CAAC,wCAAwC,CAAC;IAEtG,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;CACvC;AAED,eAAe,GAAG,CAAC"}
|
package/index.js
CHANGED
|
@@ -37,8 +37,8 @@ class Orb extends Core.APIClient {
|
|
|
37
37
|
/**
|
|
38
38
|
* API Client for interfacing with the Orb API.
|
|
39
39
|
*
|
|
40
|
-
* @param {string} [opts.apiKey
|
|
41
|
-
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
40
|
+
* @param {string} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
41
|
+
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
42
42
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
43
43
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
44
44
|
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -46,14 +46,14 @@ class Orb extends Core.APIClient {
|
|
|
46
46
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
47
47
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
48
48
|
*/
|
|
49
|
-
constructor({ apiKey = Core.readEnv('ORB_API_KEY'), ...opts } = {}) {
|
|
49
|
+
constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), ...opts } = {}) {
|
|
50
50
|
if (apiKey === undefined) {
|
|
51
51
|
throw new Errors.OrbError("The ORB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Orb client with an apiKey option, like new Orb({ apiKey: 'My API Key' }).");
|
|
52
52
|
}
|
|
53
53
|
const options = {
|
|
54
54
|
apiKey,
|
|
55
55
|
...opts,
|
|
56
|
-
baseURL:
|
|
56
|
+
baseURL: baseURL ?? `https://api.withorb.com/v1`,
|
|
57
57
|
};
|
|
58
58
|
super({
|
|
59
59
|
baseURL: options.baseURL,
|
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,4DAA2C;AAC3C,mDAAkC;AAElC,sDAAqC;AACrC,uCAAyB;AACzB,iEAAmD;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;;AAErD,gDAA+B;AAC/B,4DAA2C;AAC3C,mDAAkC;AAElC,sDAAqC;AACrC,uCAAyB;AACzB,iEAAmD;AAiEnD,mDAAmD;AACnD,MAAa,GAAI,SAAQ,IAAI,CAAC,SAAS;IAKrC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EACtC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EACpC,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,QAAQ,CACvB,2KAA2K,CAC5K,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,4BAA4B;SACjD,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,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,gBAAW,GAAoB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzD,cAAS,GAAkB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnD,WAAM,GAAe,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,qBAAgB,GAAyB,IAAI,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACxE,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,WAAM,GAAe,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,kBAAa,GAAsB,IAAI,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAjB7D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAekB,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,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;;AA7EH,kBA0GC;;AA3BQ,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,eAAW,GAAG,MAAM,CAAC,WAAW,CAAC;AACjC,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,mBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,mBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,oBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,oBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,oBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,0BAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,0BAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,0BAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,4BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAC3D,6BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAIpE,gBAAQ,GAyBN,MAAM,WAxBR,gBAAQ,GAwBN,MAAM,WAvBR,0BAAkB,GAuBhB,MAAM,qBAtBR,iCAAyB,GAsBvB,MAAM,4BArBR,yBAAiB,GAqBf,MAAM,oBApBR,mBAAW,GAoBT,MAAM,cAnBR,qBAAa,GAmBX,MAAM,gBAlBR,qBAAa,GAkBX,MAAM,gBAjBR,sBAAc,GAiBZ,MAAM,iBAhBR,uBAAe,GAgBb,MAAM,kBAfR,uBAAe,GAeb,MAAM,kBAdR,uBAAe,GAcb,MAAM,kBAbR,wBAAgB,GAad,MAAM,mBAZR,wBAAgB,GAYd,MAAM,mBAXR,wBAAgB,GAWd,MAAM,mBAVR,2BAAmB,GAUjB,MAAM,sBATR,2BAAmB,GASjB,MAAM,sBARR,2BAAmB,GAQjB,MAAM,sBAPR,2BAAmB,GAOjB,MAAM,sBANR,6BAAqB,GAMnB,MAAM,wBALR,8BAAsB,GAKpB,MAAM,yBAJR,8BAAsB,GAIpB,MAAM,yBAHR,8BAAsB,GAGpB,MAAM,yBAFR,gCAAwB,GAEtB,MAAM,2BADR,iCAAyB,GACvB,MAAM,2BAAC;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,QAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IAIvB,YAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAGxB,WAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAEtB,eAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAI9B,eAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAE9B,mBAAe,GAAG,GAAG,CAAC,eAAe,CAAC;IAGtC,aAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAE1B,iBAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAMlC,UAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IASpB,oBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAIxC,YAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAGxB,gBAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAMhC,SAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAElB,aAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAI1B,WAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAItB,2BAAuB,GAAG,GAAG,CAAC,uBAAuB,CAAC;IAItD,SAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAElB,aAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAK1B,UAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAEpB,cAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IAI5B,iBAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAKlC,qBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IAC1C,0CAAsC,GAAG,GAAG,CAAC,sCAAsC,CAAC;AAcpG,CAAC,EAtGgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAsGnB;AAED,kBAAe,GAAG,CAAC"}
|
package/index.mjs
CHANGED
|
@@ -11,8 +11,8 @@ export class Orb extends Core.APIClient {
|
|
|
11
11
|
/**
|
|
12
12
|
* API Client for interfacing with the Orb API.
|
|
13
13
|
*
|
|
14
|
-
* @param {string} [opts.apiKey
|
|
15
|
-
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
14
|
+
* @param {string} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
15
|
+
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
16
16
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
17
17
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
18
18
|
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -20,14 +20,14 @@ export class Orb extends Core.APIClient {
|
|
|
20
20
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
21
21
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
22
22
|
*/
|
|
23
|
-
constructor({ apiKey = Core.readEnv('ORB_API_KEY'), ...opts } = {}) {
|
|
23
|
+
constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), ...opts } = {}) {
|
|
24
24
|
if (apiKey === undefined) {
|
|
25
25
|
throw new Errors.OrbError("The ORB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Orb client with an apiKey option, like new Orb({ apiKey: 'My API Key' }).");
|
|
26
26
|
}
|
|
27
27
|
const options = {
|
|
28
28
|
apiKey,
|
|
29
29
|
...opts,
|
|
30
|
-
baseURL:
|
|
30
|
+
baseURL: baseURL ?? `https://api.withorb.com/v1`,
|
|
31
31
|
};
|
|
32
32
|
super({
|
|
33
33
|
baseURL: options.baseURL,
|
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,UAAU;OACf,KAAK,MAAM;OAEX,KAAK,OAAO;OACZ,KAAK,EAAE,MAAM,IAAI;OACjB,KAAK,GAAG,MAAM,6BAA6B;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;;OAE9C,KAAK,IAAI;OACT,KAAK,UAAU;OACf,KAAK,MAAM;OAEX,KAAK,OAAO;OACZ,KAAK,EAAE,MAAM,IAAI;OACjB,KAAK,GAAG,MAAM,6BAA6B;AAiElD,mDAAmD;AACnD,MAAM,OAAO,GAAI,SAAQ,IAAI,CAAC,SAAS;IAKrC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EACtC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EACpC,GAAG,IAAI,KACU,EAAE;QACnB,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,MAAM,CAAC,QAAQ,CACvB,2KAA2K,CAC5K,CAAC;SACH;QAED,MAAM,OAAO,GAAkB;YAC7B,MAAM;YACN,GAAG,IAAI;YACP,OAAO,EAAE,OAAO,IAAI,4BAA4B;SACjD,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,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,gBAAW,GAAoB,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzD,cAAS,GAAkB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnD,WAAM,GAAe,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,qBAAgB,GAAyB,IAAI,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACxE,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,YAAO,GAAgB,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,UAAK,GAAc,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,WAAM,GAAe,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC1C,kBAAa,GAAsB,IAAI,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAjB7D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAekB,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,MAAM,EAAE,EAAE,CAAC;IACpD,CAAC;IAEkB,cAAc,CAAC,KAA8B;QAC9D,OAAO,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACvD,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,eAAW,GAAG,MAAM,CAAC,WAAW,CAAC;AACjC,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,mBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,mBAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,oBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,oBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,oBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,uBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,yBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC;AACrD,0BAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,0BAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,0BAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,4BAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAC3D,6BAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAGtE,MAAM,CAAC,MAAM,EACX,QAAQ,EACR,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,GAC1B,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,QAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IAIvB,YAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAGxB,WAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAEtB,eAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAI9B,eAAW,GAAG,GAAG,CAAC,WAAW,CAAC;IAE9B,mBAAe,GAAG,GAAG,CAAC,eAAe,CAAC;IAGtC,aAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAE1B,iBAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAMlC,UAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IASpB,oBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IAIxC,YAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAGxB,gBAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAMhC,SAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAElB,aAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAI1B,WAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAItB,2BAAuB,GAAG,GAAG,CAAC,uBAAuB,CAAC;IAItD,SAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAElB,aAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IAK1B,UAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAEpB,cAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IAI5B,iBAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAKlC,qBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IAC1C,0CAAsC,GAAG,GAAG,CAAC,sCAAsC,CAAC;AAcpG,CAAC,EAtGgB,GAAG,KAAH,GAAG,QAsGnB;AAED,eAAe,GAAG,CAAC"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -16,8 +16,10 @@ export interface ClientOptions {
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
19
|
+
*
|
|
20
|
+
* Defaults to process.env['ORB_BASE_URL'].
|
|
19
21
|
*/
|
|
20
|
-
baseURL?: string;
|
|
22
|
+
baseURL?: string | null | undefined;
|
|
21
23
|
|
|
22
24
|
/**
|
|
23
25
|
* The maximum amount of time (in milliseconds) that the client should wait for a response
|
|
@@ -78,8 +80,8 @@ export class Orb extends Core.APIClient {
|
|
|
78
80
|
/**
|
|
79
81
|
* API Client for interfacing with the Orb API.
|
|
80
82
|
*
|
|
81
|
-
* @param {string} [opts.apiKey
|
|
82
|
-
* @param {string} [opts.baseURL] - Override the default base URL for the API.
|
|
83
|
+
* @param {string} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
84
|
+
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
83
85
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
84
86
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
85
87
|
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -87,7 +89,11 @@ export class Orb extends Core.APIClient {
|
|
|
87
89
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
88
90
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
89
91
|
*/
|
|
90
|
-
constructor({
|
|
92
|
+
constructor({
|
|
93
|
+
baseURL = Core.readEnv('ORB_BASE_URL'),
|
|
94
|
+
apiKey = Core.readEnv('ORB_API_KEY'),
|
|
95
|
+
...opts
|
|
96
|
+
}: ClientOptions = {}) {
|
|
91
97
|
if (apiKey === undefined) {
|
|
92
98
|
throw new Errors.OrbError(
|
|
93
99
|
"The ORB_API_KEY environment variable is missing or empty; either provide it, or instantiate the Orb client with an apiKey option, like new Orb({ apiKey: 'My API Key' }).",
|
|
@@ -97,7 +103,7 @@ export class Orb extends Core.APIClient {
|
|
|
97
103
|
const options: ClientOptions = {
|
|
98
104
|
apiKey,
|
|
99
105
|
...opts,
|
|
100
|
-
baseURL:
|
|
106
|
+
baseURL: baseURL ?? `https://api.withorb.com/v1`,
|
|
101
107
|
};
|
|
102
108
|
|
|
103
109
|
super({
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '1.
|
|
1
|
+
export const VERSION = '1.31.0'; // x-release-please-version
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "1.
|
|
1
|
+
export declare const VERSION = "1.31.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '1.
|
|
1
|
+
export const VERSION = '1.31.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|