orb-billing 2.1.2 → 2.3.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 +55 -0
- package/README.md +29 -0
- package/index.d.mts +16 -5
- package/index.d.ts +16 -5
- package/index.d.ts.map +1 -1
- package/index.js +7 -6
- package/index.js.map +1 -1
- package/index.mjs +7 -6
- package/index.mjs.map +1 -1
- package/package.json +2 -3
- package/resources/coupons/coupons.d.ts +3 -22
- package/resources/coupons/coupons.d.ts.map +1 -1
- package/resources/coupons/coupons.js.map +1 -1
- package/resources/coupons/coupons.mjs.map +1 -1
- package/resources/customers/costs.d.ts +4 -4
- package/resources/customers/costs.d.ts.map +1 -1
- package/resources/customers/costs.js.map +1 -1
- package/resources/customers/costs.mjs.map +1 -1
- package/resources/customers/credits/credits.d.ts +6 -4
- package/resources/customers/credits/credits.d.ts.map +1 -1
- package/resources/customers/credits/credits.js.map +1 -1
- package/resources/customers/credits/credits.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +20 -10
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/credits/top-ups.d.ts +38 -8
- package/resources/customers/credits/top-ups.d.ts.map +1 -1
- package/resources/customers/credits/top-ups.js.map +1 -1
- package/resources/customers/credits/top-ups.mjs.map +1 -1
- package/resources/customers/usage.d.ts +2 -2
- package/resources/customers/usage.d.ts.map +1 -1
- package/resources/customers/usage.js.map +1 -1
- package/resources/customers/usage.mjs.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +6 -6
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.ts +2 -0
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs.map +1 -1
- package/resources/plans/plans.d.ts +65 -0
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/index.d.ts +1 -1
- package/resources/prices/index.d.ts.map +1 -1
- package/resources/prices/index.js +3 -3
- package/resources/prices/index.js.map +1 -1
- package/resources/prices/index.mjs +1 -1
- package/resources/prices/index.mjs.map +1 -1
- package/resources/prices/prices.d.ts +301 -2
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js +26 -0
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs +26 -0
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/shared.d.ts +5 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/subscriptions.d.ts +91 -17
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +6 -0
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +6 -0
- package/resources/subscriptions.mjs.map +1 -1
- package/resources/webhooks.d.ts +24 -0
- package/resources/webhooks.d.ts.map +1 -0
- package/resources/webhooks.js +110 -0
- package/resources/webhooks.js.map +1 -0
- package/resources/webhooks.mjs +106 -0
- package/resources/webhooks.mjs.map +1 -0
- package/src/index.ts +20 -7
- package/src/resources/coupons/coupons.ts +3 -26
- package/src/resources/customers/costs.ts +6 -6
- package/src/resources/customers/credits/credits.ts +10 -6
- package/src/resources/customers/credits/ledger.ts +24 -12
- package/src/resources/customers/credits/top-ups.ts +46 -10
- package/src/resources/customers/usage.ts +2 -2
- package/src/resources/index.ts +12 -2
- package/src/resources/invoices.ts +4 -0
- package/src/resources/plans/plans.ts +78 -0
- package/src/resources/prices/index.ts +10 -1
- package/src/resources/prices/prices.ts +428 -0
- package/src/resources/shared.ts +8 -0
- package/src/resources/subscriptions.ts +122 -20
- package/src/resources/webhooks.ts +142 -0
- 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,60 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2.3.0 (2024-04-24)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v2.2.0...v2.3.0](https://github.com/orbcorp/orb-node/compare/v2.2.0...v2.3.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add effective_date field ([#163](https://github.com/orbcorp/orb-node/issues/163)) ([96a98bd](https://github.com/orbcorp/orb-node/commit/96a98bd315ceb6f2239dee6267bcf0b3a7e84a39))
|
|
10
|
+
* **api:** add subscription update endpoint ([#168](https://github.com/orbcorp/orb-node/issues/168)) ([09b5798](https://github.com/orbcorp/orb-node/commit/09b5798769187bcb18c92210c8b336b169f72343))
|
|
11
|
+
* **api:** add the shared model PaginationMetadata ([#164](https://github.com/orbcorp/orb-node/issues/164)) ([15f5af3](https://github.com/orbcorp/orb-node/commit/15f5af31b39a66ef8a626af50d09abf3202afc8f))
|
|
12
|
+
* **api:** price evaluation endpoint generally available ([#169](https://github.com/orbcorp/orb-node/issues/169)) ([492a728](https://github.com/orbcorp/orb-node/commit/492a72833150267df706054e5d8c1ce998b27999))
|
|
13
|
+
* **api:** updates ([#154](https://github.com/orbcorp/orb-node/issues/154)) ([01aef6d](https://github.com/orbcorp/orb-node/commit/01aef6d41d2fd0f6174eb6116ac2a670cfc96882))
|
|
14
|
+
* **api:** updates ([#159](https://github.com/orbcorp/orb-node/issues/159)) ([5b6287c](https://github.com/orbcorp/orb-node/commit/5b6287c047ed1a5eab7e498690838062c233a1a7))
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Bug Fixes
|
|
18
|
+
|
|
19
|
+
* **api:** add shared model BillingCycleRelativeDate ([#167](https://github.com/orbcorp/orb-node/issues/167)) ([8677375](https://github.com/orbcorp/orb-node/commit/867737537ddecdfcaaf33bb0bd3fe29532f265c4))
|
|
20
|
+
* **api:** some path params were incorrectly typed as nullable ([#166](https://github.com/orbcorp/orb-node/issues/166)) ([eeb81d4](https://github.com/orbcorp/orb-node/commit/eeb81d4ade556528cf564b850b0d1b932fbfd999))
|
|
21
|
+
* use UTC timezone for verifying webhook signature ([9a0b87a](https://github.com/orbcorp/orb-node/commit/9a0b87a704a84608383c66cb5acb73f55aa97b3c)), closes [#156](https://github.com/orbcorp/orb-node/issues/156)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Chores
|
|
25
|
+
|
|
26
|
+
* **internal:** formatting ([#161](https://github.com/orbcorp/orb-node/issues/161)) ([db765d8](https://github.com/orbcorp/orb-node/commit/db765d86efc540e6301fc15912360ba66218c673))
|
|
27
|
+
* **internal:** update gitignore ([#160](https://github.com/orbcorp/orb-node/issues/160)) ([7a2c39f](https://github.com/orbcorp/orb-node/commit/7a2c39f468ea6aba7133d6fdfd28c632c119e145))
|
|
28
|
+
* **internal:** use @swc/jest for running tests ([#165](https://github.com/orbcorp/orb-node/issues/165)) ([c744e70](https://github.com/orbcorp/orb-node/commit/c744e70bf74385171fea39d73c9611f792661a3c))
|
|
29
|
+
* use debug instead of console log for webhook signature logging ([590cbf1](https://github.com/orbcorp/orb-node/commit/590cbf17e37a7eb071d6d31295b3f9cc9bb46579))
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Build System
|
|
33
|
+
|
|
34
|
+
* configure UTF-8 locale in devcontainer ([#162](https://github.com/orbcorp/orb-node/issues/162)) ([aa09c7d](https://github.com/orbcorp/orb-node/commit/aa09c7dfc261b6e05e8e944f23a55463f80d13da))
|
|
35
|
+
|
|
36
|
+
## 2.2.0 (2024-04-08)
|
|
37
|
+
|
|
38
|
+
Full Changelog: [v2.1.2...v2.2.0](https://github.com/orbcorp/orb-node/compare/v2.1.2...v2.2.0)
|
|
39
|
+
|
|
40
|
+
### Features
|
|
41
|
+
|
|
42
|
+
* add webhooks verification helpers ([2beaa01](https://github.com/orbcorp/orb-node/commit/2beaa019f1f4e58ee6fde3cab29f500964dc3bc1))
|
|
43
|
+
* **api:** add `invoice_source` to invoice ([#153](https://github.com/orbcorp/orb-node/issues/153)) ([8a9b15e](https://github.com/orbcorp/orb-node/commit/8a9b15e6560c1f82888bf4f7b09536ac8d3fee01))
|
|
44
|
+
* **api:** add tiered package with minimum price ([#150](https://github.com/orbcorp/orb-node/issues/150)) ([6c53952](https://github.com/orbcorp/orb-node/commit/6c53952ea49a49b1565df1133f132cb0fef30215))
|
|
45
|
+
* **api:** remove accidental null ([#146](https://github.com/orbcorp/orb-node/issues/146)) ([e66a755](https://github.com/orbcorp/orb-node/commit/e66a7556055d4f3638245f338769a8565cdddddc))
|
|
46
|
+
* **api:** timeframe_end and timeframe_start accept null ([#148](https://github.com/orbcorp/orb-node/issues/148)) ([bab2d25](https://github.com/orbcorp/orb-node/commit/bab2d25a0e37deb6058ed9890560f5bcc6dc53cb))
|
|
47
|
+
* **api:** updates ([#141](https://github.com/orbcorp/orb-node/issues/141)) ([c14e608](https://github.com/orbcorp/orb-node/commit/c14e60853f9ec7a3954c83ee8bb9275ee97e5797))
|
|
48
|
+
* **client:** add webhook secret argument ([#143](https://github.com/orbcorp/orb-node/issues/143)) ([46c215a](https://github.com/orbcorp/orb-node/commit/46c215aac68387a5c43c2bc0fb620486369dcbf5))
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Chores
|
|
52
|
+
|
|
53
|
+
* **deps:** bump yarn to v1.22.22 ([#151](https://github.com/orbcorp/orb-node/issues/151)) ([4ab1e0e](https://github.com/orbcorp/orb-node/commit/4ab1e0e4e2b5e9e62c2d27c99aedc35bc8e3c00f))
|
|
54
|
+
* **deps:** remove unused dependency digest-fetch ([#149](https://github.com/orbcorp/orb-node/issues/149)) ([567dbb4](https://github.com/orbcorp/orb-node/commit/567dbb4edd942bb04eb952c8dd19e8a8af8ff24e))
|
|
55
|
+
* **docs:** revise currency description ([#152](https://github.com/orbcorp/orb-node/issues/152)) ([1508146](https://github.com/orbcorp/orb-node/commit/15081469303ea1b6327b2c5b3ea38650c76b8ee8))
|
|
56
|
+
* **internal:** bump dependencies ([#145](https://github.com/orbcorp/orb-node/issues/145)) ([94acc13](https://github.com/orbcorp/orb-node/commit/94acc135e32597d32cce614aa4c25758600838ca))
|
|
57
|
+
|
|
3
58
|
## 2.1.2 (2024-03-25)
|
|
4
59
|
|
|
5
60
|
Full Changelog: [v2.1.1...v2.1.2](https://github.com/orbcorp/orb-node/compare/v2.1.1...v2.1.2)
|
package/README.md
CHANGED
|
@@ -166,6 +166,35 @@ while (page.hasNextPage()) {
|
|
|
166
166
|
}
|
|
167
167
|
```
|
|
168
168
|
|
|
169
|
+
## Webhook Verification
|
|
170
|
+
|
|
171
|
+
We provide helper methods for verifying that a webhook request came from Orb, and not a malicious third party.
|
|
172
|
+
|
|
173
|
+
You can use `orb.webhooks.verifySignature(body: string, headers, secret?) -> void` or `orb.webhooks.unwrap(body: string, headers, secret?) -> Payload`,
|
|
174
|
+
both of which will raise an error if the signature is invalid.
|
|
175
|
+
|
|
176
|
+
Note that the "body" parameter must be the raw JSON string sent from the server (do not parse and re-stringify it).
|
|
177
|
+
The `.unwrap()` method will automatically parse this JSON for you into a typed `Payload`.
|
|
178
|
+
|
|
179
|
+
For example:
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
// with Express:
|
|
183
|
+
app.use('/webhooks/orb', bodyParser.text({ type: '*/*' }), function (req, res) {
|
|
184
|
+
const payload = orb.webhooks.unwrap(req.body, req.headers, process.env['ORB_WEBHOOK_SECRET']); // env var or client arg used by default; explicit here.
|
|
185
|
+
console.log(payload);
|
|
186
|
+
res.json({ ok: true });
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
// with Next.js (app router):
|
|
190
|
+
export default async function POST(req) {
|
|
191
|
+
const body = await req.text(); // if you're using the pages router, you will need this trick: https://vancelucas.com/blog/how-to-access-raw-body-data-with-next-js/
|
|
192
|
+
const payload = orb.webhooks.unwrap(body, req.headers, process.env['ORB_WEBHOOK_SECRET']); // env var or client arg used by default; explicit here.
|
|
193
|
+
console.log(payload);
|
|
194
|
+
return NextResponse.json({ ok: true });
|
|
195
|
+
}
|
|
196
|
+
```
|
|
197
|
+
|
|
169
198
|
## Advanced Usage
|
|
170
199
|
|
|
171
200
|
### Accessing raw Response data (e.g., headers)
|
package/index.d.mts
CHANGED
|
@@ -9,6 +9,10 @@ export interface ClientOptions {
|
|
|
9
9
|
* Defaults to process.env['ORB_API_KEY'].
|
|
10
10
|
*/
|
|
11
11
|
apiKey?: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* Defaults to process.env['ORB_WEBHOOK_SECRET'].
|
|
14
|
+
*/
|
|
15
|
+
webhookSecret?: string | null | undefined;
|
|
12
16
|
/**
|
|
13
17
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
14
18
|
*
|
|
@@ -62,11 +66,13 @@ export interface ClientOptions {
|
|
|
62
66
|
/** API Client for interfacing with the Orb API. */
|
|
63
67
|
export declare class Orb extends Core.APIClient {
|
|
64
68
|
apiKey: string;
|
|
69
|
+
webhookSecret: string | null;
|
|
65
70
|
private _options;
|
|
66
71
|
/**
|
|
67
72
|
* API Client for interfacing with the Orb API.
|
|
68
73
|
*
|
|
69
74
|
* @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
75
|
+
* @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
|
|
70
76
|
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
71
77
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
72
78
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -75,7 +81,7 @@ export declare class Orb extends Core.APIClient {
|
|
|
75
81
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
76
82
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
77
83
|
*/
|
|
78
|
-
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
|
84
|
+
constructor({ baseURL, apiKey, webhookSecret, ...opts }?: ClientOptions);
|
|
79
85
|
topLevel: API.TopLevel;
|
|
80
86
|
coupons: API.Coupons;
|
|
81
87
|
creditNotes: API.CreditNotes;
|
|
@@ -88,7 +94,7 @@ export declare class Orb extends Core.APIClient {
|
|
|
88
94
|
plans: API.Plans;
|
|
89
95
|
prices: API.Prices;
|
|
90
96
|
subscriptions: API.Subscriptions;
|
|
91
|
-
|
|
97
|
+
webhooks: API.Webhooks;
|
|
92
98
|
protected defaultQuery(): Core.DefaultQuery | undefined;
|
|
93
99
|
protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
94
100
|
protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
@@ -119,13 +125,13 @@ export declare class Orb extends Core.APIClient {
|
|
|
119
125
|
static OrbInternalServerError: typeof Errors.OrbInternalServerError;
|
|
120
126
|
static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
121
127
|
static DuplicateResourceCreation: typeof Errors.DuplicateResourceCreation;
|
|
128
|
+
static toFile: typeof Uploads.toFile;
|
|
129
|
+
static fileFromPath: typeof Uploads.fileFromPath;
|
|
122
130
|
}
|
|
123
131
|
export declare const OrbError: typeof Errors.OrbError, APIError: typeof Errors.APIError, APIConnectionError: typeof Errors.APIConnectionError, APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError, APIUserAbortError: typeof Errors.APIUserAbortError, URLNotFound: typeof Errors.URLNotFound, NotFoundError: typeof Errors.NotFoundError, ConflictError: typeof Errors.ConflictError, RateLimitError: typeof Errors.RateLimitError, BadRequestError: typeof Errors.BadRequestError, RequestTooLarge: typeof Errors.RequestTooLarge, TooManyRequests: typeof Errors.TooManyRequests, ResourceNotFound: typeof Errors.ResourceNotFound, ResourceConflict: typeof Errors.ResourceConflict, ResourceTooLarge: typeof Errors.ResourceTooLarge, AuthenticationError: typeof Errors.AuthenticationError, InternalServerError: typeof Errors.InternalServerError, ConstraintViolation: typeof Errors.ConstraintViolation, FeatureNotAvailable: typeof Errors.FeatureNotAvailable, PermissionDeniedError: typeof Errors.PermissionDeniedError, RequestValidationError: typeof Errors.RequestValidationError, OrbAuthenticationError: typeof Errors.OrbAuthenticationError, OrbInternalServerError: typeof Errors.OrbInternalServerError, UnprocessableEntityError: typeof Errors.UnprocessableEntityError, DuplicateResourceCreation: typeof Errors.DuplicateResourceCreation;
|
|
124
132
|
export import toFile = Uploads.toFile;
|
|
125
133
|
export import fileFromPath = Uploads.fileFromPath;
|
|
126
134
|
export declare namespace Orb {
|
|
127
|
-
export import toFile = Uploads.toFile;
|
|
128
|
-
export import fileFromPath = Uploads.fileFromPath;
|
|
129
135
|
export import RequestOptions = Core.RequestOptions;
|
|
130
136
|
export import Page = Pagination.Page;
|
|
131
137
|
export import PageParams = Pagination.PageParams;
|
|
@@ -186,10 +192,13 @@ export declare namespace Orb {
|
|
|
186
192
|
export import PlanUpdateParams = API.PlanUpdateParams;
|
|
187
193
|
export import PlanListParams = API.PlanListParams;
|
|
188
194
|
export import Prices = API.Prices;
|
|
195
|
+
export import EvaluatePriceGroup = API.EvaluatePriceGroup;
|
|
189
196
|
export import Price = API.Price;
|
|
197
|
+
export import PriceEvaluateResponse = API.PriceEvaluateResponse;
|
|
190
198
|
export import PricesPage = API.PricesPage;
|
|
191
199
|
export import PriceCreateParams = API.PriceCreateParams;
|
|
192
200
|
export import PriceListParams = API.PriceListParams;
|
|
201
|
+
export import PriceEvaluateParams = API.PriceEvaluateParams;
|
|
193
202
|
export import Subscriptions = API.Subscriptions;
|
|
194
203
|
export import Subscription = API.Subscription;
|
|
195
204
|
export import SubscriptionUsage = API.SubscriptionUsage;
|
|
@@ -198,6 +207,7 @@ export declare namespace Orb {
|
|
|
198
207
|
export import SubscriptionsPage = API.SubscriptionsPage;
|
|
199
208
|
export import SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
|
|
200
209
|
export import SubscriptionCreateParams = API.SubscriptionCreateParams;
|
|
210
|
+
export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
|
|
201
211
|
export import SubscriptionListParams = API.SubscriptionListParams;
|
|
202
212
|
export import SubscriptionCancelParams = API.SubscriptionCancelParams;
|
|
203
213
|
export import SubscriptionFetchCostsParams = API.SubscriptionFetchCostsParams;
|
|
@@ -208,8 +218,9 @@ export declare namespace Orb {
|
|
|
208
218
|
export import SubscriptionTriggerPhaseParams = API.SubscriptionTriggerPhaseParams;
|
|
209
219
|
export import SubscriptionUnscheduleFixedFeeQuantityUpdatesParams = API.SubscriptionUnscheduleFixedFeeQuantityUpdatesParams;
|
|
210
220
|
export import SubscriptionUpdateFixedFeeQuantityParams = API.SubscriptionUpdateFixedFeeQuantityParams;
|
|
211
|
-
export import
|
|
221
|
+
export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
|
|
212
222
|
export import Discount = API.Discount;
|
|
223
|
+
export import PaginationMetadata = API.PaginationMetadata;
|
|
213
224
|
}
|
|
214
225
|
export default Orb;
|
|
215
226
|
//# sourceMappingURL=index.d.ts.map
|
package/index.d.ts
CHANGED
|
@@ -9,6 +9,10 @@ export interface ClientOptions {
|
|
|
9
9
|
* Defaults to process.env['ORB_API_KEY'].
|
|
10
10
|
*/
|
|
11
11
|
apiKey?: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* Defaults to process.env['ORB_WEBHOOK_SECRET'].
|
|
14
|
+
*/
|
|
15
|
+
webhookSecret?: string | null | undefined;
|
|
12
16
|
/**
|
|
13
17
|
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
|
|
14
18
|
*
|
|
@@ -62,11 +66,13 @@ export interface ClientOptions {
|
|
|
62
66
|
/** API Client for interfacing with the Orb API. */
|
|
63
67
|
export declare class Orb extends Core.APIClient {
|
|
64
68
|
apiKey: string;
|
|
69
|
+
webhookSecret: string | null;
|
|
65
70
|
private _options;
|
|
66
71
|
/**
|
|
67
72
|
* API Client for interfacing with the Orb API.
|
|
68
73
|
*
|
|
69
74
|
* @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
75
|
+
* @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
|
|
70
76
|
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
71
77
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
72
78
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -75,7 +81,7 @@ export declare class Orb extends Core.APIClient {
|
|
|
75
81
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
76
82
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
77
83
|
*/
|
|
78
|
-
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
|
84
|
+
constructor({ baseURL, apiKey, webhookSecret, ...opts }?: ClientOptions);
|
|
79
85
|
topLevel: API.TopLevel;
|
|
80
86
|
coupons: API.Coupons;
|
|
81
87
|
creditNotes: API.CreditNotes;
|
|
@@ -88,7 +94,7 @@ export declare class Orb extends Core.APIClient {
|
|
|
88
94
|
plans: API.Plans;
|
|
89
95
|
prices: API.Prices;
|
|
90
96
|
subscriptions: API.Subscriptions;
|
|
91
|
-
|
|
97
|
+
webhooks: API.Webhooks;
|
|
92
98
|
protected defaultQuery(): Core.DefaultQuery | undefined;
|
|
93
99
|
protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
94
100
|
protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
|
|
@@ -119,13 +125,13 @@ export declare class Orb extends Core.APIClient {
|
|
|
119
125
|
static OrbInternalServerError: typeof Errors.OrbInternalServerError;
|
|
120
126
|
static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
|
|
121
127
|
static DuplicateResourceCreation: typeof Errors.DuplicateResourceCreation;
|
|
128
|
+
static toFile: typeof Uploads.toFile;
|
|
129
|
+
static fileFromPath: typeof Uploads.fileFromPath;
|
|
122
130
|
}
|
|
123
131
|
export declare const OrbError: typeof Errors.OrbError, APIError: typeof Errors.APIError, APIConnectionError: typeof Errors.APIConnectionError, APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError, APIUserAbortError: typeof Errors.APIUserAbortError, URLNotFound: typeof Errors.URLNotFound, NotFoundError: typeof Errors.NotFoundError, ConflictError: typeof Errors.ConflictError, RateLimitError: typeof Errors.RateLimitError, BadRequestError: typeof Errors.BadRequestError, RequestTooLarge: typeof Errors.RequestTooLarge, TooManyRequests: typeof Errors.TooManyRequests, ResourceNotFound: typeof Errors.ResourceNotFound, ResourceConflict: typeof Errors.ResourceConflict, ResourceTooLarge: typeof Errors.ResourceTooLarge, AuthenticationError: typeof Errors.AuthenticationError, InternalServerError: typeof Errors.InternalServerError, ConstraintViolation: typeof Errors.ConstraintViolation, FeatureNotAvailable: typeof Errors.FeatureNotAvailable, PermissionDeniedError: typeof Errors.PermissionDeniedError, RequestValidationError: typeof Errors.RequestValidationError, OrbAuthenticationError: typeof Errors.OrbAuthenticationError, OrbInternalServerError: typeof Errors.OrbInternalServerError, UnprocessableEntityError: typeof Errors.UnprocessableEntityError, DuplicateResourceCreation: typeof Errors.DuplicateResourceCreation;
|
|
124
132
|
export import toFile = Uploads.toFile;
|
|
125
133
|
export import fileFromPath = Uploads.fileFromPath;
|
|
126
134
|
export declare namespace Orb {
|
|
127
|
-
export import toFile = Uploads.toFile;
|
|
128
|
-
export import fileFromPath = Uploads.fileFromPath;
|
|
129
135
|
export import RequestOptions = Core.RequestOptions;
|
|
130
136
|
export import Page = Pagination.Page;
|
|
131
137
|
export import PageParams = Pagination.PageParams;
|
|
@@ -186,10 +192,13 @@ export declare namespace Orb {
|
|
|
186
192
|
export import PlanUpdateParams = API.PlanUpdateParams;
|
|
187
193
|
export import PlanListParams = API.PlanListParams;
|
|
188
194
|
export import Prices = API.Prices;
|
|
195
|
+
export import EvaluatePriceGroup = API.EvaluatePriceGroup;
|
|
189
196
|
export import Price = API.Price;
|
|
197
|
+
export import PriceEvaluateResponse = API.PriceEvaluateResponse;
|
|
190
198
|
export import PricesPage = API.PricesPage;
|
|
191
199
|
export import PriceCreateParams = API.PriceCreateParams;
|
|
192
200
|
export import PriceListParams = API.PriceListParams;
|
|
201
|
+
export import PriceEvaluateParams = API.PriceEvaluateParams;
|
|
193
202
|
export import Subscriptions = API.Subscriptions;
|
|
194
203
|
export import Subscription = API.Subscription;
|
|
195
204
|
export import SubscriptionUsage = API.SubscriptionUsage;
|
|
@@ -198,6 +207,7 @@ export declare namespace Orb {
|
|
|
198
207
|
export import SubscriptionsPage = API.SubscriptionsPage;
|
|
199
208
|
export import SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
|
|
200
209
|
export import SubscriptionCreateParams = API.SubscriptionCreateParams;
|
|
210
|
+
export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
|
|
201
211
|
export import SubscriptionListParams = API.SubscriptionListParams;
|
|
202
212
|
export import SubscriptionCancelParams = API.SubscriptionCancelParams;
|
|
203
213
|
export import SubscriptionFetchCostsParams = API.SubscriptionFetchCostsParams;
|
|
@@ -208,8 +218,9 @@ export declare namespace Orb {
|
|
|
208
218
|
export import SubscriptionTriggerPhaseParams = API.SubscriptionTriggerPhaseParams;
|
|
209
219
|
export import SubscriptionUnscheduleFixedFeeQuantityUpdatesParams = API.SubscriptionUnscheduleFixedFeeQuantityUpdatesParams;
|
|
210
220
|
export import SubscriptionUpdateFixedFeeQuantityParams = API.SubscriptionUpdateFixedFeeQuantityParams;
|
|
211
|
-
export import
|
|
221
|
+
export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
|
|
212
222
|
export import Discount = API.Discount;
|
|
223
|
+
export import PaginationMetadata = API.PaginationMetadata;
|
|
213
224
|
}
|
|
214
225
|
export default Orb;
|
|
215
226
|
//# 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;AAErC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,GAAG,MAAM,6BAA6B,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;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;
|
|
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;AAErC,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,GAAG,MAAM,6BAA6B,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1C;;;;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;IACf,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAAsC,EACtC,MAAoC,EACpC,aAA0D,EAC1D,GAAG,IAAI,EACR,GAAE,aAAkB;IA4BrB,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;IAC/D,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;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;IAEpE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;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;IACnB,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,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,qBAAqB,GAAG,GAAG,CAAC,qBAAqB,CAAC;IAChE,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;IACpD,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAE5D,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,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,wBAAwB,GAAG,GAAG,CAAC,wBAAwB,CAAC;IACtE,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;CAC3D;AAED,eAAe,GAAG,CAAC"}
|
package/index.js
CHANGED
|
@@ -38,6 +38,7 @@ class Orb extends Core.APIClient {
|
|
|
38
38
|
* API Client for interfacing with the Orb API.
|
|
39
39
|
*
|
|
40
40
|
* @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
41
|
+
* @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
|
|
41
42
|
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
42
43
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
43
44
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -46,12 +47,13 @@ class Orb extends Core.APIClient {
|
|
|
46
47
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
47
48
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
48
49
|
*/
|
|
49
|
-
constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), ...opts } = {}) {
|
|
50
|
+
constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), webhookSecret = Core.readEnv('ORB_WEBHOOK_SECRET') ?? null, ...opts } = {}) {
|
|
50
51
|
if (apiKey === undefined) {
|
|
51
52
|
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
53
|
}
|
|
53
54
|
const options = {
|
|
54
55
|
apiKey,
|
|
56
|
+
webhookSecret,
|
|
55
57
|
...opts,
|
|
56
58
|
baseURL: baseURL || `https://api.withorb.com/v1`,
|
|
57
59
|
};
|
|
@@ -74,10 +76,11 @@ class Orb extends Core.APIClient {
|
|
|
74
76
|
this.plans = new API.Plans(this);
|
|
75
77
|
this.prices = new API.Prices(this);
|
|
76
78
|
this.subscriptions = new API.Subscriptions(this);
|
|
77
|
-
this.
|
|
79
|
+
this.webhooks = new API.Webhooks(this);
|
|
78
80
|
this._options = options;
|
|
79
81
|
this.idempotencyHeader = 'Idempotency-Key';
|
|
80
82
|
this.apiKey = apiKey;
|
|
83
|
+
this.webhookSecret = webhookSecret;
|
|
81
84
|
}
|
|
82
85
|
defaultQuery() {
|
|
83
86
|
return this._options.defaultQuery;
|
|
@@ -123,13 +126,12 @@ Orb.OrbAuthenticationError = Errors.OrbAuthenticationError;
|
|
|
123
126
|
Orb.OrbInternalServerError = Errors.OrbInternalServerError;
|
|
124
127
|
Orb.UnprocessableEntityError = Errors.UnprocessableEntityError;
|
|
125
128
|
Orb.DuplicateResourceCreation = Errors.DuplicateResourceCreation;
|
|
129
|
+
Orb.toFile = Uploads.toFile;
|
|
130
|
+
Orb.fileFromPath = Uploads.fileFromPath;
|
|
126
131
|
exports.OrbError = Errors.OrbError, exports.APIError = Errors.APIError, exports.APIConnectionError = Errors.APIConnectionError, exports.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError, exports.APIUserAbortError = Errors.APIUserAbortError, exports.URLNotFound = Errors.URLNotFound, exports.NotFoundError = Errors.NotFoundError, exports.ConflictError = Errors.ConflictError, exports.RateLimitError = Errors.RateLimitError, exports.BadRequestError = Errors.BadRequestError, exports.RequestTooLarge = Errors.RequestTooLarge, exports.TooManyRequests = Errors.TooManyRequests, exports.ResourceNotFound = Errors.ResourceNotFound, exports.ResourceConflict = Errors.ResourceConflict, exports.ResourceTooLarge = Errors.ResourceTooLarge, exports.AuthenticationError = Errors.AuthenticationError, exports.InternalServerError = Errors.InternalServerError, exports.ConstraintViolation = Errors.ConstraintViolation, exports.FeatureNotAvailable = Errors.FeatureNotAvailable, exports.PermissionDeniedError = Errors.PermissionDeniedError, exports.RequestValidationError = Errors.RequestValidationError, exports.OrbAuthenticationError = Errors.OrbAuthenticationError, exports.OrbInternalServerError = Errors.OrbInternalServerError, exports.UnprocessableEntityError = Errors.UnprocessableEntityError, exports.DuplicateResourceCreation = Errors.DuplicateResourceCreation;
|
|
127
132
|
exports.toFile = Uploads.toFile;
|
|
128
133
|
exports.fileFromPath = Uploads.fileFromPath;
|
|
129
134
|
(function (Orb) {
|
|
130
|
-
// Helper functions
|
|
131
|
-
Orb.toFile = Uploads.toFile;
|
|
132
|
-
Orb.fileFromPath = Uploads.fileFromPath;
|
|
133
135
|
Orb.Page = Pagination.Page;
|
|
134
136
|
Orb.TopLevel = API.TopLevel;
|
|
135
137
|
Orb.Coupons = API.Coupons;
|
|
@@ -153,7 +155,6 @@ exports.fileFromPath = Uploads.fileFromPath;
|
|
|
153
155
|
Orb.Subscriptions = API.Subscriptions;
|
|
154
156
|
Orb.SubscriptionsPage = API.SubscriptionsPage;
|
|
155
157
|
Orb.SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
|
|
156
|
-
Orb.Beta = API.Beta;
|
|
157
158
|
})(Orb = exports.Orb || (exports.Orb = {}));
|
|
158
159
|
exports = module.exports = Orb;
|
|
159
160
|
exports.default = Orb;
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA+B;AAC/B,mDAAkC;AAElC,sDAAqC;AACrC,uCAAyB;AACzB,mEAAqD;AACrD,iEAAmD;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA+B;AAC/B,mDAAkC;AAElC,sDAAqC;AACrC,uCAAyB;AACzB,mEAAqD;AACrD,iEAAmD;AAsEnD,mDAAmD;AACnD,MAAa,GAAI,SAAQ,IAAI,CAAC,SAAS;IAMrC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EACtC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EACpC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,IAAI,EAC1D,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,aAAa;YACb,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;QAQL,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;QAC/D,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAnB9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAgBkB,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,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;;AAnFH,kBAmHC;;AA9BQ,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;AAE7D,UAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,gBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAI3C,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;IAGJ,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;IAIpB,cAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IAK5B,iBAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAKlC,qBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IAC1C,0CAAsC,GAAG,GAAG,CAAC,sCAAsC,CAAC;AAiBpG,CAAC,EAxGgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAwGnB;AAED,kBAAe,GAAG,CAAC"}
|
package/index.mjs
CHANGED
|
@@ -12,6 +12,7 @@ export class Orb extends Core.APIClient {
|
|
|
12
12
|
* API Client for interfacing with the Orb API.
|
|
13
13
|
*
|
|
14
14
|
* @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
|
|
15
|
+
* @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
|
|
15
16
|
* @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
|
|
16
17
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
17
18
|
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
|
|
@@ -20,12 +21,13 @@ export class Orb extends Core.APIClient {
|
|
|
20
21
|
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
21
22
|
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
22
23
|
*/
|
|
23
|
-
constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), ...opts } = {}) {
|
|
24
|
+
constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), webhookSecret = Core.readEnv('ORB_WEBHOOK_SECRET') ?? null, ...opts } = {}) {
|
|
24
25
|
if (apiKey === undefined) {
|
|
25
26
|
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
27
|
}
|
|
27
28
|
const options = {
|
|
28
29
|
apiKey,
|
|
30
|
+
webhookSecret,
|
|
29
31
|
...opts,
|
|
30
32
|
baseURL: baseURL || `https://api.withorb.com/v1`,
|
|
31
33
|
};
|
|
@@ -48,10 +50,11 @@ export class Orb extends Core.APIClient {
|
|
|
48
50
|
this.plans = new API.Plans(this);
|
|
49
51
|
this.prices = new API.Prices(this);
|
|
50
52
|
this.subscriptions = new API.Subscriptions(this);
|
|
51
|
-
this.
|
|
53
|
+
this.webhooks = new API.Webhooks(this);
|
|
52
54
|
this._options = options;
|
|
53
55
|
this.idempotencyHeader = 'Idempotency-Key';
|
|
54
56
|
this.apiKey = apiKey;
|
|
57
|
+
this.webhookSecret = webhookSecret;
|
|
55
58
|
}
|
|
56
59
|
defaultQuery() {
|
|
57
60
|
return this._options.defaultQuery;
|
|
@@ -96,13 +99,12 @@ Orb.OrbAuthenticationError = Errors.OrbAuthenticationError;
|
|
|
96
99
|
Orb.OrbInternalServerError = Errors.OrbInternalServerError;
|
|
97
100
|
Orb.UnprocessableEntityError = Errors.UnprocessableEntityError;
|
|
98
101
|
Orb.DuplicateResourceCreation = Errors.DuplicateResourceCreation;
|
|
102
|
+
Orb.toFile = Uploads.toFile;
|
|
103
|
+
Orb.fileFromPath = Uploads.fileFromPath;
|
|
99
104
|
export const { OrbError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, URLNotFound, NotFoundError, ConflictError, RateLimitError, BadRequestError, RequestTooLarge, TooManyRequests, ResourceNotFound, ResourceConflict, ResourceTooLarge, AuthenticationError, InternalServerError, ConstraintViolation, FeatureNotAvailable, PermissionDeniedError, RequestValidationError, OrbAuthenticationError, OrbInternalServerError, UnprocessableEntityError, DuplicateResourceCreation, } = Errors;
|
|
100
105
|
export var toFile = Uploads.toFile;
|
|
101
106
|
export var fileFromPath = Uploads.fileFromPath;
|
|
102
107
|
(function (Orb) {
|
|
103
|
-
// Helper functions
|
|
104
|
-
Orb.toFile = Uploads.toFile;
|
|
105
|
-
Orb.fileFromPath = Uploads.fileFromPath;
|
|
106
108
|
Orb.Page = Pagination.Page;
|
|
107
109
|
Orb.TopLevel = API.TopLevel;
|
|
108
110
|
Orb.Coupons = API.Coupons;
|
|
@@ -126,7 +128,6 @@ export var fileFromPath = Uploads.fileFromPath;
|
|
|
126
128
|
Orb.Subscriptions = API.Subscriptions;
|
|
127
129
|
Orb.SubscriptionsPage = API.SubscriptionsPage;
|
|
128
130
|
Orb.SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
|
|
129
|
-
Orb.Beta = API.Beta;
|
|
130
131
|
})(Orb || (Orb = {}));
|
|
131
132
|
export default Orb;
|
|
132
133
|
//# sourceMappingURL=index.mjs.map
|
package/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAE/E,KAAK,IAAI;OACT,KAAK,MAAM;OAEX,KAAK,OAAO;OACZ,KAAK,EAAE,MAAM,IAAI;OACjB,KAAK,UAAU,MAAM,wBAAwB;OAC7C,KAAK,GAAG,MAAM,6BAA6B;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAE/E,KAAK,IAAI;OACT,KAAK,MAAM;OAEX,KAAK,OAAO;OACZ,KAAK,EAAE,MAAM,IAAI;OACjB,KAAK,UAAU,MAAM,wBAAwB;OAC7C,KAAK,GAAG,MAAM,6BAA6B;AAsElD,mDAAmD;AACnD,MAAM,OAAO,GAAI,SAAQ,IAAI,CAAC,SAAS;IAMrC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EACtC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EACpC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,IAAI,EAC1D,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,aAAa;YACb,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;QAQL,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;QAC/D,aAAQ,GAAiB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAnB9C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;IAgBkB,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,UAAU,EAAE,CAAC,CAAC;IAC1D,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;AAE7D,UAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACxB,gBAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAG7C,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;IAGJ,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;IAIpB,cAAU,GAAG,GAAG,CAAC,UAAU,CAAC;IAK5B,iBAAa,GAAG,GAAG,CAAC,aAAa,CAAC;IAKlC,qBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;IAC1C,0CAAsC,GAAG,GAAG,CAAC,sCAAsC,CAAC;AAiBpG,CAAC,EAxGgB,GAAG,KAAH,GAAG,QAwGnB;AAED,eAAe,GAAG,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "orb-billing",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.0",
|
|
4
4
|
"description": "The official TypeScript library for the Orb API",
|
|
5
5
|
"author": "Orb <team@withorb.com>",
|
|
6
6
|
"types": "./index.d.ts",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"type": "commonjs",
|
|
9
9
|
"repository": "github:orbcorp/orb-node",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
|
-
"packageManager": "yarn@1.22.
|
|
11
|
+
"packageManager": "yarn@1.22.22",
|
|
12
12
|
"files": [
|
|
13
13
|
"*"
|
|
14
14
|
],
|
|
@@ -27,7 +27,6 @@
|
|
|
27
27
|
"@types/qs": "^6.9.7",
|
|
28
28
|
"abort-controller": "^3.0.0",
|
|
29
29
|
"agentkeepalive": "^4.2.1",
|
|
30
|
-
"digest-fetch": "^1.3.0",
|
|
31
30
|
"form-data-encoder": "1.7.2",
|
|
32
31
|
"formdata-node": "^4.3.2",
|
|
33
32
|
"node-fetch": "^2.6.7",
|
|
@@ -105,7 +105,7 @@ export declare namespace Coupon {
|
|
|
105
105
|
}
|
|
106
106
|
}
|
|
107
107
|
export interface CouponCreateParams {
|
|
108
|
-
discount: CouponCreateParams.
|
|
108
|
+
discount: CouponCreateParams.NewCouponPercentageDiscount | CouponCreateParams.NewCouponAmountDiscount;
|
|
109
109
|
/**
|
|
110
110
|
* This string can be used to redeem this coupon for a given subscription.
|
|
111
111
|
*/
|
|
@@ -122,32 +122,13 @@ export interface CouponCreateParams {
|
|
|
122
122
|
max_redemptions?: number | null;
|
|
123
123
|
}
|
|
124
124
|
export declare namespace CouponCreateParams {
|
|
125
|
-
interface
|
|
126
|
-
/**
|
|
127
|
-
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
128
|
-
* this can be a subset of prices.
|
|
129
|
-
*/
|
|
130
|
-
applies_to_price_ids: Array<string>;
|
|
125
|
+
interface NewCouponPercentageDiscount {
|
|
131
126
|
discount_type: 'percentage';
|
|
132
|
-
/**
|
|
133
|
-
* Only available if discount_type is `percentage`. This is a number between 0
|
|
134
|
-
* and 1.
|
|
135
|
-
*/
|
|
136
127
|
percentage_discount: number;
|
|
137
|
-
reason?: string | null;
|
|
138
128
|
}
|
|
139
|
-
interface
|
|
140
|
-
/**
|
|
141
|
-
* Only available if discount_type is `amount`.
|
|
142
|
-
*/
|
|
129
|
+
interface NewCouponAmountDiscount {
|
|
143
130
|
amount_discount: string;
|
|
144
|
-
/**
|
|
145
|
-
* List of price_ids that this discount applies to. For plan/plan phase discounts,
|
|
146
|
-
* this can be a subset of prices.
|
|
147
|
-
*/
|
|
148
|
-
applies_to_price_ids: Array<string>;
|
|
149
131
|
discount_type: 'amount';
|
|
150
|
-
reason?: string | null;
|
|
151
132
|
}
|
|
152
133
|
}
|
|
153
134
|
export interface CouponListParams extends PageParams {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coupons.d.ts","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAC;AACpE,OAAO,KAAK,gBAAgB,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE/D,qBAAa,OAAQ,SAAQ,WAAW;IACtC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IAW1E;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIjF;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAGhF;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD;;;;;;;;;GASG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,EAAE,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,cAAc,CAAC;IAE5D;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,MAAM,CAAC;IACtB,UAAiB,kBAAkB;QACjC;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,aAAa,EAAE,YAAY,CAAC;QAE5B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,aAAa,EAAE,QAAQ,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,kBAAkB,CAAC,
|
|
1
|
+
{"version":3,"file":"coupons.d.ts","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAC;AACpE,OAAO,KAAK,gBAAgB,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAE/D,qBAAa,OAAQ,SAAQ,WAAW;IACtC,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IAEjG;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIxF;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IACpG,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC;IAW1E;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAIjF;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAGhF;AAED,qBAAa,WAAY,SAAQ,IAAI,CAAC,MAAM,CAAC;CAAG;AAEhD;;;;;;;;;GASG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,EAAE,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,cAAc,CAAC;IAE5D;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,MAAM,CAAC;IACtB,UAAiB,kBAAkB;QACjC;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,aAAa,EAAE,YAAY,CAAC;QAE5B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;IAED,UAAiB,cAAc;QAC7B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpC,aAAa,EAAE,QAAQ,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,kBAAkB,CAAC,2BAA2B,GAAG,kBAAkB,CAAC,uBAAuB,CAAC;IAEtG;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,2BAA2B;QAC1C,aAAa,EAAE,YAAY,CAAC;QAE5B,mBAAmB,EAAE,MAAM,CAAC;KAC7B;IAED,UAAiB,uBAAuB;QACtC,eAAe,EAAE,MAAM,CAAC;QAExB,aAAa,EAAE,QAAQ,CAAC;KACzB;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,yBAAiB,OAAO,CAAC;IACvB,MAAM,QAAQ,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;IACzC,MAAM,QAAQ,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IACnD,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IACjE,MAAM,QAAQ,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAC7D,MAAM,QAAQ,aAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC;IAC7D,MAAM,QAAQ,sBAAsB,GAAG,gBAAgB,CAAC,sBAAsB,CAAC;CAChF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coupons.js","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,mDAAmD;AACnD,2CAAoD;AACpD,kFAAoE;AACpE,8FAAgF;AAChF,uDAA+D;AAE/D,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAhDD,0BAgDC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;
|
|
1
|
+
{"version":3,"file":"coupons.js","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtF,mDAAmD;AACnD,2CAAoD;AACpD,kFAAoE;AACpE,8FAAgF;AAChF,uDAA+D;AAE/D,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAhDD,0BAgDC;AAED,MAAa,WAAY,SAAQ,iBAAY;CAAG;AAAhD,kCAAgD;AAsIhD,WAAiB,OAAO;IAER,mBAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAGrC,qBAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC;AAE/D,CAAC,EAPgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAOvB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"coupons.mjs","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,sBAAsB;OAC3C,EAAE,gBAAgB,EAAE,MAAM,kBAAkB;OAC5C,KAAK,UAAU,MAAM,uCAAuC;OAC5D,KAAK,gBAAgB,MAAM,6CAA6C;OACxE,EAAE,IAAI,EAAmB,MAAM,wBAAwB;AAE9D,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;
|
|
1
|
+
{"version":3,"file":"coupons.mjs","sourceRoot":"","sources":["../../src/resources/coupons/coupons.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,sBAAsB;OAC3C,EAAE,gBAAgB,EAAE,MAAM,kBAAkB;OAC5C,KAAK,UAAU,MAAM,uCAAuC;OAC5D,KAAK,gBAAgB,MAAM,6CAA6C;OACxE,EAAE,IAAI,EAAmB,MAAM,wBAAwB;AAE9D,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,kBAAa,GAAmC,IAAI,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA+CnG,CAAC;IA7CC;;;OAGG;IACH,MAAM,CAAC,IAAwB,EAAE,OAA6B;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAYD,IAAI,CACF,QAAgD,EAAE,EAClD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,QAAgB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAgB,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,IAAY;CAAG;AAsIhD,WAAiB,OAAO;IAER,mBAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAGrC,qBAAa,GAAG,gBAAgB,CAAC,aAAa,CAAC;AAE/D,CAAC,EAPgB,OAAO,KAAP,OAAO,QAOvB"}
|
|
@@ -139,8 +139,8 @@ export declare class Costs extends APIResource {
|
|
|
139
139
|
* `secondary_grouping_key` based on the matrix price definition, for each
|
|
140
140
|
* `grouping_value` and `secondary_grouping_value` available.
|
|
141
141
|
*/
|
|
142
|
-
list(customerId: string
|
|
143
|
-
list(customerId: string
|
|
142
|
+
list(customerId: string, query?: CostListParams, options?: Core.RequestOptions): Core.APIPromise<CostListResponse>;
|
|
143
|
+
list(customerId: string, options?: Core.RequestOptions): Core.APIPromise<CostListResponse>;
|
|
144
144
|
/**
|
|
145
145
|
* This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
|
|
146
146
|
* Orb, calculated by applying pricing information to the underlying usage (see the
|
|
@@ -277,8 +277,8 @@ export declare class Costs extends APIResource {
|
|
|
277
277
|
* `secondary_grouping_key` based on the matrix price definition, for each
|
|
278
278
|
* `grouping_value` and `secondary_grouping_value` available.
|
|
279
279
|
*/
|
|
280
|
-
listByExternalId(externalCustomerId: string
|
|
281
|
-
listByExternalId(externalCustomerId: string
|
|
280
|
+
listByExternalId(externalCustomerId: string, query?: CostListByExternalIDParams, options?: Core.RequestOptions): Core.APIPromise<CostListByExternalIDResponse>;
|
|
281
|
+
listByExternalId(externalCustomerId: string, options?: Core.RequestOptions): Core.APIPromise<CostListByExternalIDResponse>;
|
|
282
282
|
}
|
|
283
283
|
export interface CostListResponse {
|
|
284
284
|
data: Array<CostListResponse.Data>;
|