orb-billing 1.26.0 → 1.28.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 +29 -0
- package/README.md +1 -1
- package/core.d.ts +0 -10
- package/core.d.ts.map +1 -1
- package/core.js +1 -13
- package/core.js.map +1 -1
- package/core.mjs +0 -11
- package/core.mjs.map +1 -1
- package/package.json +1 -1
- package/resource.d.ts +1 -7
- package/resource.d.ts.map +1 -1
- package/resource.js +1 -7
- package/resource.js.map +1 -1
- package/resource.mjs +1 -7
- package/resource.mjs.map +1 -1
- package/resources/coupons/coupons.d.ts.map +1 -1
- package/resources/coupons/coupons.js +5 -5
- package/resources/coupons/coupons.js.map +1 -1
- package/resources/coupons/coupons.mjs +5 -5
- package/resources/coupons/coupons.mjs.map +1 -1
- package/resources/coupons/subscriptions.d.ts.map +1 -1
- package/resources/coupons/subscriptions.js +4 -1
- package/resources/coupons/subscriptions.js.map +1 -1
- package/resources/coupons/subscriptions.mjs +4 -1
- package/resources/coupons/subscriptions.mjs.map +1 -1
- package/resources/credit-notes.js +2 -2
- package/resources/credit-notes.js.map +1 -1
- package/resources/credit-notes.mjs +2 -2
- package/resources/credit-notes.mjs.map +1 -1
- package/resources/customers/balance-transactions.js +2 -2
- package/resources/customers/balance-transactions.js.map +1 -1
- package/resources/customers/balance-transactions.mjs +2 -2
- package/resources/customers/balance-transactions.mjs.map +1 -1
- package/resources/customers/costs.d.ts.map +1 -1
- package/resources/customers/costs.js +5 -2
- package/resources/customers/costs.js.map +1 -1
- package/resources/customers/costs.mjs +5 -2
- package/resources/customers/costs.mjs.map +1 -1
- package/resources/customers/credits/credits.d.ts.map +1 -1
- package/resources/customers/credits/credits.js +3 -3
- package/resources/customers/credits/credits.js.map +1 -1
- package/resources/customers/credits/credits.mjs +3 -3
- package/resources/customers/credits/credits.mjs.map +1 -1
- package/resources/customers/credits/ledger.d.ts +132 -20
- package/resources/customers/credits/ledger.d.ts.map +1 -1
- package/resources/customers/credits/ledger.js +4 -4
- package/resources/customers/credits/ledger.js.map +1 -1
- package/resources/customers/credits/ledger.mjs +4 -4
- package/resources/customers/credits/ledger.mjs.map +1 -1
- package/resources/customers/customers.d.ts +12 -23
- package/resources/customers/customers.d.ts.map +1 -1
- package/resources/customers/customers.js +12 -12
- package/resources/customers/customers.js.map +1 -1
- package/resources/customers/customers.mjs +12 -12
- package/resources/customers/customers.mjs.map +1 -1
- package/resources/customers/usage.js +2 -2
- package/resources/customers/usage.js.map +1 -1
- package/resources/customers/usage.mjs +2 -2
- package/resources/customers/usage.mjs.map +1 -1
- package/resources/events/backfills.js +5 -5
- package/resources/events/backfills.js.map +1 -1
- package/resources/events/backfills.mjs +5 -5
- package/resources/events/backfills.mjs.map +1 -1
- package/resources/events/events.d.ts.map +1 -1
- package/resources/events/events.js +5 -5
- package/resources/events/events.js.map +1 -1
- package/resources/events/events.mjs +5 -5
- package/resources/events/events.mjs.map +1 -1
- package/resources/invoice-line-items.js +1 -1
- package/resources/invoice-line-items.js.map +1 -1
- package/resources/invoice-line-items.mjs +1 -1
- package/resources/invoice-line-items.mjs.map +1 -1
- package/resources/invoices.d.ts +10 -2
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +7 -7
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +7 -7
- package/resources/invoices.mjs.map +1 -1
- package/resources/items.js +3 -3
- package/resources/items.js.map +1 -1
- package/resources/items.mjs +3 -3
- package/resources/items.mjs.map +1 -1
- package/resources/metrics.d.ts +14 -3
- package/resources/metrics.d.ts.map +1 -1
- package/resources/metrics.js +3 -3
- package/resources/metrics.js.map +1 -1
- package/resources/metrics.mjs +3 -3
- package/resources/metrics.mjs.map +1 -1
- package/resources/plans/external-plan-id.d.ts +4 -1
- package/resources/plans/external-plan-id.d.ts.map +1 -1
- package/resources/plans/external-plan-id.js +2 -2
- package/resources/plans/external-plan-id.js.map +1 -1
- package/resources/plans/external-plan-id.mjs +2 -2
- package/resources/plans/external-plan-id.mjs.map +1 -1
- package/resources/plans/plans.d.ts +13 -3
- package/resources/plans/plans.d.ts.map +1 -1
- package/resources/plans/plans.js +5 -5
- package/resources/plans/plans.js.map +1 -1
- package/resources/plans/plans.mjs +5 -5
- package/resources/plans/plans.mjs.map +1 -1
- package/resources/prices/external-price-id.js +1 -1
- package/resources/prices/external-price-id.js.map +1 -1
- package/resources/prices/external-price-id.mjs +1 -1
- package/resources/prices/external-price-id.mjs.map +1 -1
- package/resources/prices/prices.d.ts +135 -135
- package/resources/prices/prices.d.ts.map +1 -1
- package/resources/prices/prices.js +4 -4
- package/resources/prices/prices.js.map +1 -1
- package/resources/prices/prices.mjs +4 -4
- package/resources/prices/prices.mjs.map +1 -1
- package/resources/subscriptions.d.ts +7 -4
- package/resources/subscriptions.d.ts.map +1 -1
- package/resources/subscriptions.js +17 -14
- package/resources/subscriptions.js.map +1 -1
- package/resources/subscriptions.mjs +17 -14
- package/resources/subscriptions.mjs.map +1 -1
- package/resources/top-level.js +1 -1
- package/resources/top-level.js.map +1 -1
- package/resources/top-level.mjs +1 -1
- package/resources/top-level.mjs.map +1 -1
- package/src/core.ts +0 -21
- package/src/resource.ts +3 -16
- package/src/resources/coupons/coupons.ts +5 -5
- package/src/resources/coupons/subscriptions.ts +4 -1
- package/src/resources/credit-notes.ts +2 -2
- package/src/resources/customers/balance-transactions.ts +2 -2
- package/src/resources/customers/costs.ts +5 -2
- package/src/resources/customers/credits/credits.ts +3 -3
- package/src/resources/customers/credits/ledger.ts +136 -24
- package/src/resources/customers/customers.ts +23 -36
- package/src/resources/customers/usage.ts +2 -2
- package/src/resources/events/backfills.ts +5 -5
- package/src/resources/events/events.ts +5 -5
- package/src/resources/invoice-line-items.ts +1 -1
- package/src/resources/invoices.ts +17 -9
- package/src/resources/items.ts +3 -3
- package/src/resources/metrics.ts +17 -6
- package/src/resources/plans/external-plan-id.ts +6 -3
- package/src/resources/plans/plans.ts +18 -8
- package/src/resources/prices/external-price-id.ts +1 -1
- package/src/resources/prices/prices.ts +221 -221
- package/src/resources/subscriptions.ts +24 -18
- package/src/resources/top-level.ts +1 -1
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/top-level.js
CHANGED
|
@@ -13,7 +13,7 @@ class TopLevel extends resource_1.APIResource {
|
|
|
13
13
|
* This API does not have any side-effects or return any Orb resources.
|
|
14
14
|
*/
|
|
15
15
|
ping(options) {
|
|
16
|
-
return this.get('/ping', options);
|
|
16
|
+
return this._client.get('/ping', options);
|
|
17
17
|
}
|
|
18
18
|
}
|
|
19
19
|
exports.TopLevel = TopLevel;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"top-level.js","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,mDAAmD;AAGnD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"top-level.js","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,mDAAmD;AAGnD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAZD,4BAYC;AAMD,WAAiB,QAAQ;AAEzB,CAAC,EAFgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAExB"}
|
package/resources/top-level.mjs
CHANGED
|
@@ -10,7 +10,7 @@ export class TopLevel extends APIResource {
|
|
|
10
10
|
* This API does not have any side-effects or return any Orb resources.
|
|
11
11
|
*/
|
|
12
12
|
ping(options) {
|
|
13
|
-
return this.get('/ping', options);
|
|
13
|
+
return this._client.get('/ping', options);
|
|
14
14
|
}
|
|
15
15
|
}
|
|
16
16
|
(function (TopLevel) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"top-level.mjs","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,sBAAsB;AAGlD,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"top-level.mjs","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,sBAAsB;AAGlD,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAMD,WAAiB,QAAQ;AAEzB,CAAC,EAFgB,QAAQ,KAAR,QAAQ,QAExB"}
|
package/src/core.ts
CHANGED
|
@@ -555,27 +555,6 @@ export abstract class APIClient {
|
|
|
555
555
|
}
|
|
556
556
|
}
|
|
557
557
|
|
|
558
|
-
export class APIResource {
|
|
559
|
-
protected client: APIClient;
|
|
560
|
-
constructor(client: APIClient) {
|
|
561
|
-
this.client = client;
|
|
562
|
-
|
|
563
|
-
this.get = client.get.bind(client);
|
|
564
|
-
this.post = client.post.bind(client);
|
|
565
|
-
this.patch = client.patch.bind(client);
|
|
566
|
-
this.put = client.put.bind(client);
|
|
567
|
-
this.delete = client.delete.bind(client);
|
|
568
|
-
this.getAPIList = client.getAPIList.bind(client);
|
|
569
|
-
}
|
|
570
|
-
|
|
571
|
-
protected get: APIClient['get'];
|
|
572
|
-
protected post: APIClient['post'];
|
|
573
|
-
protected patch: APIClient['patch'];
|
|
574
|
-
protected put: APIClient['put'];
|
|
575
|
-
protected delete: APIClient['delete'];
|
|
576
|
-
protected getAPIList: APIClient['getAPIList'];
|
|
577
|
-
}
|
|
578
|
-
|
|
579
558
|
export type PageInfo = { url: URL } | { params: Record<string, unknown> | null };
|
|
580
559
|
|
|
581
560
|
export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
|
package/src/resource.ts
CHANGED
|
@@ -3,22 +3,9 @@
|
|
|
3
3
|
import type { Orb } from './index';
|
|
4
4
|
|
|
5
5
|
export class APIResource {
|
|
6
|
-
protected
|
|
7
|
-
constructor(client: Orb) {
|
|
8
|
-
this.client = client;
|
|
6
|
+
protected _client: Orb;
|
|
9
7
|
|
|
10
|
-
|
|
11
|
-
this.
|
|
12
|
-
this.patch = client.patch.bind(client);
|
|
13
|
-
this.put = client.put.bind(client);
|
|
14
|
-
this.delete = client.delete.bind(client);
|
|
15
|
-
this.getAPIList = client.getAPIList.bind(client);
|
|
8
|
+
constructor(client: Orb) {
|
|
9
|
+
this._client = client;
|
|
16
10
|
}
|
|
17
|
-
|
|
18
|
-
protected get: Orb['get'];
|
|
19
|
-
protected post: Orb['post'];
|
|
20
|
-
protected patch: Orb['patch'];
|
|
21
|
-
protected put: Orb['put'];
|
|
22
|
-
protected delete: Orb['delete'];
|
|
23
|
-
protected getAPIList: Orb['getAPIList'];
|
|
24
11
|
}
|
|
@@ -8,14 +8,14 @@ import * as SubscriptionsAPI from "./subscriptions";
|
|
|
8
8
|
import { Page, type PageParams } from "../../pagination";
|
|
9
9
|
|
|
10
10
|
export class Coupons extends APIResource {
|
|
11
|
-
subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this.
|
|
11
|
+
subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* This endpoint allows the creation of coupons, which can then be redeemed at
|
|
15
15
|
* subscription creation or plan change.
|
|
16
16
|
*/
|
|
17
17
|
create(body: CouponCreateParams, options?: Core.RequestOptions): Core.APIPromise<Coupon> {
|
|
18
|
-
return this.post('/coupons', { body, ...options });
|
|
18
|
+
return this._client.post('/coupons', { body, ...options });
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
/**
|
|
@@ -35,7 +35,7 @@ export class Coupons extends APIResource {
|
|
|
35
35
|
if (isRequestOptions(query)) {
|
|
36
36
|
return this.list({}, query);
|
|
37
37
|
}
|
|
38
|
-
return this.getAPIList('/coupons', CouponsPage, { query, ...options });
|
|
38
|
+
return this._client.getAPIList('/coupons', CouponsPage, { query, ...options });
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
/**
|
|
@@ -44,7 +44,7 @@ export class Coupons extends APIResource {
|
|
|
44
44
|
* coupon is archived, its redemption code can be reused for a different coupon.
|
|
45
45
|
*/
|
|
46
46
|
archive(couponId: string, options?: Core.RequestOptions): Core.APIPromise<Coupon> {
|
|
47
|
-
return this.post(`/coupons/${couponId}/archive`, options);
|
|
47
|
+
return this._client.post(`/coupons/${couponId}/archive`, options);
|
|
48
48
|
}
|
|
49
49
|
|
|
50
50
|
/**
|
|
@@ -53,7 +53,7 @@ export class Coupons extends APIResource {
|
|
|
53
53
|
* parameter.
|
|
54
54
|
*/
|
|
55
55
|
fetch(couponId: string, options?: Core.RequestOptions): Core.APIPromise<Coupon> {
|
|
56
|
-
return this.get(`/coupons/${couponId}`, options);
|
|
56
|
+
return this._client.get(`/coupons/${couponId}`, options);
|
|
57
57
|
}
|
|
58
58
|
}
|
|
59
59
|
|
|
@@ -32,7 +32,10 @@ export class Subscriptions extends APIResource {
|
|
|
32
32
|
if (isRequestOptions(query)) {
|
|
33
33
|
return this.list(couponId, {}, query);
|
|
34
34
|
}
|
|
35
|
-
return this.getAPIList(`/coupons/${couponId}/subscriptions`, SubscriptionsPage, {
|
|
35
|
+
return this._client.getAPIList(`/coupons/${couponId}/subscriptions`, SubscriptionsPage, {
|
|
36
|
+
query,
|
|
37
|
+
...options,
|
|
38
|
+
});
|
|
36
39
|
}
|
|
37
40
|
}
|
|
38
41
|
|
|
@@ -24,7 +24,7 @@ export class CreditNotes extends APIResource {
|
|
|
24
24
|
if (isRequestOptions(query)) {
|
|
25
25
|
return this.list({}, query);
|
|
26
26
|
}
|
|
27
|
-
return this.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
|
|
27
|
+
return this._client.getAPIList('/credit_notes', CreditNotesPage, { query, ...options });
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
/**
|
|
@@ -32,7 +32,7 @@ export class CreditNotes extends APIResource {
|
|
|
32
32
|
* [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
|
|
33
33
|
*/
|
|
34
34
|
fetch(creditNoteId: string, options?: Core.RequestOptions): Core.APIPromise<CreditNote> {
|
|
35
|
-
return this.get(`/credit_notes/${creditNoteId}`, options);
|
|
35
|
+
return this._client.get(`/credit_notes/${creditNoteId}`, options);
|
|
36
36
|
}
|
|
37
37
|
}
|
|
38
38
|
|
|
@@ -16,7 +16,7 @@ export class BalanceTransactions extends APIResource {
|
|
|
16
16
|
body: BalanceTransactionCreateParams,
|
|
17
17
|
options?: Core.RequestOptions,
|
|
18
18
|
): Core.APIPromise<BalanceTransactionCreateResponse> {
|
|
19
|
-
return this.post(`/customers/${customerId}/balance_transactions`, { body, ...options });
|
|
19
|
+
return this._client.post(`/customers/${customerId}/balance_transactions`, { body, ...options });
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
/**
|
|
@@ -66,7 +66,7 @@ export class BalanceTransactions extends APIResource {
|
|
|
66
66
|
if (isRequestOptions(query)) {
|
|
67
67
|
return this.list(customerId, {}, query);
|
|
68
68
|
}
|
|
69
|
-
return this.getAPIList(
|
|
69
|
+
return this._client.getAPIList(
|
|
70
70
|
`/customers/${customerId}/balance_transactions`,
|
|
71
71
|
BalanceTransactionListResponsesPage,
|
|
72
72
|
{ query, ...options },
|
|
@@ -157,7 +157,7 @@ export class Costs extends APIResource {
|
|
|
157
157
|
if (isRequestOptions(query)) {
|
|
158
158
|
return this.list(customerId, {}, query);
|
|
159
159
|
}
|
|
160
|
-
return this.get(`/customers/${customerId}/costs`, { query, ...options });
|
|
160
|
+
return this._client.get(`/customers/${customerId}/costs`, { query, ...options });
|
|
161
161
|
}
|
|
162
162
|
|
|
163
163
|
/**
|
|
@@ -313,7 +313,10 @@ export class Costs extends APIResource {
|
|
|
313
313
|
if (isRequestOptions(query)) {
|
|
314
314
|
return this.listByExternalId(externalCustomerId, {}, query);
|
|
315
315
|
}
|
|
316
|
-
return this.get(`/customers/external_customer_id/${externalCustomerId}/costs`, {
|
|
316
|
+
return this._client.get(`/customers/external_customer_id/${externalCustomerId}/costs`, {
|
|
317
|
+
query,
|
|
318
|
+
...options,
|
|
319
|
+
});
|
|
317
320
|
}
|
|
318
321
|
}
|
|
319
322
|
|
|
@@ -8,7 +8,7 @@ import * as LedgerAPI from "./ledger";
|
|
|
8
8
|
import { Page, type PageParams } from "../../../pagination";
|
|
9
9
|
|
|
10
10
|
export class Credits extends APIResource {
|
|
11
|
-
ledger: LedgerAPI.Ledger = new LedgerAPI.Ledger(this.
|
|
11
|
+
ledger: LedgerAPI.Ledger = new LedgerAPI.Ledger(this._client);
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* Returns a paginated list of unexpired, non-zero credit blocks for a customer.
|
|
@@ -30,7 +30,7 @@ export class Credits extends APIResource {
|
|
|
30
30
|
if (isRequestOptions(query)) {
|
|
31
31
|
return this.list(customerId, {}, query);
|
|
32
32
|
}
|
|
33
|
-
return this.getAPIList(`/customers/${customerId}/credits`, CreditListResponsesPage, {
|
|
33
|
+
return this._client.getAPIList(`/customers/${customerId}/credits`, CreditListResponsesPage, {
|
|
34
34
|
query,
|
|
35
35
|
...options,
|
|
36
36
|
});
|
|
@@ -56,7 +56,7 @@ export class Credits extends APIResource {
|
|
|
56
56
|
if (isRequestOptions(query)) {
|
|
57
57
|
return this.listByExternalId(externalCustomerId, {}, query);
|
|
58
58
|
}
|
|
59
|
-
return this.getAPIList(
|
|
59
|
+
return this._client.getAPIList(
|
|
60
60
|
`/customers/external_customer_id/${externalCustomerId}/credits`,
|
|
61
61
|
CreditListByExternalIDResponsesPage,
|
|
62
62
|
{ query, ...options },
|
|
@@ -107,7 +107,7 @@ export class Ledger extends APIResource {
|
|
|
107
107
|
if (isRequestOptions(query)) {
|
|
108
108
|
return this.list(customerId, {}, query);
|
|
109
109
|
}
|
|
110
|
-
return this.getAPIList(`/customers/${customerId}/credits/ledger`, LedgerListResponsesPage, {
|
|
110
|
+
return this._client.getAPIList(`/customers/${customerId}/credits/ledger`, LedgerListResponsesPage, {
|
|
111
111
|
query,
|
|
112
112
|
...options,
|
|
113
113
|
});
|
|
@@ -229,7 +229,7 @@ export class Ledger extends APIResource {
|
|
|
229
229
|
body: LedgerCreateEntryParams,
|
|
230
230
|
options?: Core.RequestOptions,
|
|
231
231
|
): Core.APIPromise<LedgerCreateEntryResponse> {
|
|
232
|
-
return this.post(`/customers/${customerId}/credits/ledger_entry`, { body, ...options });
|
|
232
|
+
return this._client.post(`/customers/${customerId}/credits/ledger_entry`, { body, ...options });
|
|
233
233
|
}
|
|
234
234
|
|
|
235
235
|
/**
|
|
@@ -348,7 +348,7 @@ export class Ledger extends APIResource {
|
|
|
348
348
|
body: LedgerCreateEntryByExternalIDParams,
|
|
349
349
|
options?: Core.RequestOptions,
|
|
350
350
|
): Core.APIPromise<LedgerCreateEntryByExternalIDResponse> {
|
|
351
|
-
return this.post(`/customers/external_customer_id/${externalCustomerId}/credits/ledger_entry`, {
|
|
351
|
+
return this._client.post(`/customers/external_customer_id/${externalCustomerId}/credits/ledger_entry`, {
|
|
352
352
|
body,
|
|
353
353
|
...options,
|
|
354
354
|
});
|
|
@@ -454,7 +454,7 @@ export class Ledger extends APIResource {
|
|
|
454
454
|
if (isRequestOptions(query)) {
|
|
455
455
|
return this.listByExternalId(externalCustomerId, {}, query);
|
|
456
456
|
}
|
|
457
|
-
return this.getAPIList(
|
|
457
|
+
return this._client.getAPIList(
|
|
458
458
|
`/customers/external_customer_id/${externalCustomerId}/credits/ledger`,
|
|
459
459
|
LedgerListByExternalIDResponsesPage,
|
|
460
460
|
{ query, ...options },
|
|
@@ -501,6 +501,10 @@ export namespace LedgerListResponse {
|
|
|
501
501
|
|
|
502
502
|
ledger_sequence_number: number;
|
|
503
503
|
|
|
504
|
+
/**
|
|
505
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
506
|
+
* dictionary.
|
|
507
|
+
*/
|
|
504
508
|
metadata: Record<string, string>;
|
|
505
509
|
|
|
506
510
|
starting_balance: number;
|
|
@@ -543,6 +547,10 @@ export namespace LedgerListResponse {
|
|
|
543
547
|
|
|
544
548
|
ledger_sequence_number: number;
|
|
545
549
|
|
|
550
|
+
/**
|
|
551
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
552
|
+
* dictionary.
|
|
553
|
+
*/
|
|
546
554
|
metadata: Record<string, string>;
|
|
547
555
|
|
|
548
556
|
starting_balance: number;
|
|
@@ -591,6 +599,10 @@ export namespace LedgerListResponse {
|
|
|
591
599
|
|
|
592
600
|
ledger_sequence_number: number;
|
|
593
601
|
|
|
602
|
+
/**
|
|
603
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
604
|
+
* dictionary.
|
|
605
|
+
*/
|
|
594
606
|
metadata: Record<string, string>;
|
|
595
607
|
|
|
596
608
|
new_block_expiry_date: string;
|
|
@@ -635,6 +647,10 @@ export namespace LedgerListResponse {
|
|
|
635
647
|
|
|
636
648
|
ledger_sequence_number: number;
|
|
637
649
|
|
|
650
|
+
/**
|
|
651
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
652
|
+
* dictionary.
|
|
653
|
+
*/
|
|
638
654
|
metadata: Record<string, string>;
|
|
639
655
|
|
|
640
656
|
starting_balance: number;
|
|
@@ -677,6 +693,10 @@ export namespace LedgerListResponse {
|
|
|
677
693
|
|
|
678
694
|
ledger_sequence_number: number;
|
|
679
695
|
|
|
696
|
+
/**
|
|
697
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
698
|
+
* dictionary.
|
|
699
|
+
*/
|
|
680
700
|
metadata: Record<string, string>;
|
|
681
701
|
|
|
682
702
|
starting_balance: number;
|
|
@@ -723,6 +743,10 @@ export namespace LedgerListResponse {
|
|
|
723
743
|
|
|
724
744
|
ledger_sequence_number: number;
|
|
725
745
|
|
|
746
|
+
/**
|
|
747
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
748
|
+
* dictionary.
|
|
749
|
+
*/
|
|
726
750
|
metadata: Record<string, string>;
|
|
727
751
|
|
|
728
752
|
new_block_expiry_date: string;
|
|
@@ -771,6 +795,10 @@ export namespace LedgerListResponse {
|
|
|
771
795
|
|
|
772
796
|
ledger_sequence_number: number;
|
|
773
797
|
|
|
798
|
+
/**
|
|
799
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
800
|
+
* dictionary.
|
|
801
|
+
*/
|
|
774
802
|
metadata: Record<string, string>;
|
|
775
803
|
|
|
776
804
|
starting_balance: number;
|
|
@@ -828,6 +856,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
828
856
|
|
|
829
857
|
ledger_sequence_number: number;
|
|
830
858
|
|
|
859
|
+
/**
|
|
860
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
861
|
+
* dictionary.
|
|
862
|
+
*/
|
|
831
863
|
metadata: Record<string, string>;
|
|
832
864
|
|
|
833
865
|
starting_balance: number;
|
|
@@ -870,6 +902,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
870
902
|
|
|
871
903
|
ledger_sequence_number: number;
|
|
872
904
|
|
|
905
|
+
/**
|
|
906
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
907
|
+
* dictionary.
|
|
908
|
+
*/
|
|
873
909
|
metadata: Record<string, string>;
|
|
874
910
|
|
|
875
911
|
starting_balance: number;
|
|
@@ -918,6 +954,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
918
954
|
|
|
919
955
|
ledger_sequence_number: number;
|
|
920
956
|
|
|
957
|
+
/**
|
|
958
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
959
|
+
* dictionary.
|
|
960
|
+
*/
|
|
921
961
|
metadata: Record<string, string>;
|
|
922
962
|
|
|
923
963
|
new_block_expiry_date: string;
|
|
@@ -962,6 +1002,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
962
1002
|
|
|
963
1003
|
ledger_sequence_number: number;
|
|
964
1004
|
|
|
1005
|
+
/**
|
|
1006
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1007
|
+
* dictionary.
|
|
1008
|
+
*/
|
|
965
1009
|
metadata: Record<string, string>;
|
|
966
1010
|
|
|
967
1011
|
starting_balance: number;
|
|
@@ -1004,6 +1048,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
1004
1048
|
|
|
1005
1049
|
ledger_sequence_number: number;
|
|
1006
1050
|
|
|
1051
|
+
/**
|
|
1052
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1053
|
+
* dictionary.
|
|
1054
|
+
*/
|
|
1007
1055
|
metadata: Record<string, string>;
|
|
1008
1056
|
|
|
1009
1057
|
starting_balance: number;
|
|
@@ -1050,6 +1098,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
1050
1098
|
|
|
1051
1099
|
ledger_sequence_number: number;
|
|
1052
1100
|
|
|
1101
|
+
/**
|
|
1102
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1103
|
+
* dictionary.
|
|
1104
|
+
*/
|
|
1053
1105
|
metadata: Record<string, string>;
|
|
1054
1106
|
|
|
1055
1107
|
new_block_expiry_date: string;
|
|
@@ -1098,6 +1150,10 @@ export namespace LedgerCreateEntryResponse {
|
|
|
1098
1150
|
|
|
1099
1151
|
ledger_sequence_number: number;
|
|
1100
1152
|
|
|
1153
|
+
/**
|
|
1154
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1155
|
+
* dictionary.
|
|
1156
|
+
*/
|
|
1101
1157
|
metadata: Record<string, string>;
|
|
1102
1158
|
|
|
1103
1159
|
starting_balance: number;
|
|
@@ -1155,6 +1211,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1155
1211
|
|
|
1156
1212
|
ledger_sequence_number: number;
|
|
1157
1213
|
|
|
1214
|
+
/**
|
|
1215
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1216
|
+
* dictionary.
|
|
1217
|
+
*/
|
|
1158
1218
|
metadata: Record<string, string>;
|
|
1159
1219
|
|
|
1160
1220
|
starting_balance: number;
|
|
@@ -1197,6 +1257,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1197
1257
|
|
|
1198
1258
|
ledger_sequence_number: number;
|
|
1199
1259
|
|
|
1260
|
+
/**
|
|
1261
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1262
|
+
* dictionary.
|
|
1263
|
+
*/
|
|
1200
1264
|
metadata: Record<string, string>;
|
|
1201
1265
|
|
|
1202
1266
|
starting_balance: number;
|
|
@@ -1245,6 +1309,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1245
1309
|
|
|
1246
1310
|
ledger_sequence_number: number;
|
|
1247
1311
|
|
|
1312
|
+
/**
|
|
1313
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1314
|
+
* dictionary.
|
|
1315
|
+
*/
|
|
1248
1316
|
metadata: Record<string, string>;
|
|
1249
1317
|
|
|
1250
1318
|
new_block_expiry_date: string;
|
|
@@ -1289,6 +1357,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1289
1357
|
|
|
1290
1358
|
ledger_sequence_number: number;
|
|
1291
1359
|
|
|
1360
|
+
/**
|
|
1361
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1362
|
+
* dictionary.
|
|
1363
|
+
*/
|
|
1292
1364
|
metadata: Record<string, string>;
|
|
1293
1365
|
|
|
1294
1366
|
starting_balance: number;
|
|
@@ -1331,6 +1403,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1331
1403
|
|
|
1332
1404
|
ledger_sequence_number: number;
|
|
1333
1405
|
|
|
1406
|
+
/**
|
|
1407
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1408
|
+
* dictionary.
|
|
1409
|
+
*/
|
|
1334
1410
|
metadata: Record<string, string>;
|
|
1335
1411
|
|
|
1336
1412
|
starting_balance: number;
|
|
@@ -1377,6 +1453,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1377
1453
|
|
|
1378
1454
|
ledger_sequence_number: number;
|
|
1379
1455
|
|
|
1456
|
+
/**
|
|
1457
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1458
|
+
* dictionary.
|
|
1459
|
+
*/
|
|
1380
1460
|
metadata: Record<string, string>;
|
|
1381
1461
|
|
|
1382
1462
|
new_block_expiry_date: string;
|
|
@@ -1425,6 +1505,10 @@ export namespace LedgerCreateEntryByExternalIDResponse {
|
|
|
1425
1505
|
|
|
1426
1506
|
ledger_sequence_number: number;
|
|
1427
1507
|
|
|
1508
|
+
/**
|
|
1509
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1510
|
+
* dictionary.
|
|
1511
|
+
*/
|
|
1428
1512
|
metadata: Record<string, string>;
|
|
1429
1513
|
|
|
1430
1514
|
starting_balance: number;
|
|
@@ -1482,6 +1566,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1482
1566
|
|
|
1483
1567
|
ledger_sequence_number: number;
|
|
1484
1568
|
|
|
1569
|
+
/**
|
|
1570
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1571
|
+
* dictionary.
|
|
1572
|
+
*/
|
|
1485
1573
|
metadata: Record<string, string>;
|
|
1486
1574
|
|
|
1487
1575
|
starting_balance: number;
|
|
@@ -1524,6 +1612,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1524
1612
|
|
|
1525
1613
|
ledger_sequence_number: number;
|
|
1526
1614
|
|
|
1615
|
+
/**
|
|
1616
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1617
|
+
* dictionary.
|
|
1618
|
+
*/
|
|
1527
1619
|
metadata: Record<string, string>;
|
|
1528
1620
|
|
|
1529
1621
|
starting_balance: number;
|
|
@@ -1572,6 +1664,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1572
1664
|
|
|
1573
1665
|
ledger_sequence_number: number;
|
|
1574
1666
|
|
|
1667
|
+
/**
|
|
1668
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1669
|
+
* dictionary.
|
|
1670
|
+
*/
|
|
1575
1671
|
metadata: Record<string, string>;
|
|
1576
1672
|
|
|
1577
1673
|
new_block_expiry_date: string;
|
|
@@ -1616,6 +1712,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1616
1712
|
|
|
1617
1713
|
ledger_sequence_number: number;
|
|
1618
1714
|
|
|
1715
|
+
/**
|
|
1716
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1717
|
+
* dictionary.
|
|
1718
|
+
*/
|
|
1619
1719
|
metadata: Record<string, string>;
|
|
1620
1720
|
|
|
1621
1721
|
starting_balance: number;
|
|
@@ -1658,6 +1758,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1658
1758
|
|
|
1659
1759
|
ledger_sequence_number: number;
|
|
1660
1760
|
|
|
1761
|
+
/**
|
|
1762
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1763
|
+
* dictionary.
|
|
1764
|
+
*/
|
|
1661
1765
|
metadata: Record<string, string>;
|
|
1662
1766
|
|
|
1663
1767
|
starting_balance: number;
|
|
@@ -1704,6 +1808,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1704
1808
|
|
|
1705
1809
|
ledger_sequence_number: number;
|
|
1706
1810
|
|
|
1811
|
+
/**
|
|
1812
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1813
|
+
* dictionary.
|
|
1814
|
+
*/
|
|
1707
1815
|
metadata: Record<string, string>;
|
|
1708
1816
|
|
|
1709
1817
|
new_block_expiry_date: string;
|
|
@@ -1752,6 +1860,10 @@ export namespace LedgerListByExternalIDResponse {
|
|
|
1752
1860
|
|
|
1753
1861
|
ledger_sequence_number: number;
|
|
1754
1862
|
|
|
1863
|
+
/**
|
|
1864
|
+
* User specified key-value pairs. If not provided, this defaults to an empty
|
|
1865
|
+
* dictionary.
|
|
1866
|
+
*/
|
|
1755
1867
|
metadata: Record<string, string>;
|
|
1756
1868
|
|
|
1757
1869
|
starting_balance: number;
|
|
@@ -1845,9 +1957,9 @@ export namespace LedgerCreateEntryParams {
|
|
|
1845
1957
|
invoice_settings?: LedgerCreateEntryParams.AddIncrementCreditLedgerEntryRequestParams.InvoiceSettings | null;
|
|
1846
1958
|
|
|
1847
1959
|
/**
|
|
1848
|
-
* User-specified key/value pairs for the
|
|
1960
|
+
* User-specified key/value pairs for the resource.
|
|
1849
1961
|
*/
|
|
1850
|
-
metadata?:
|
|
1962
|
+
metadata?: Record<string, string | null> | null;
|
|
1851
1963
|
|
|
1852
1964
|
/**
|
|
1853
1965
|
* Can only be specified when entry_type=increment. How much, in USD, a customer
|
|
@@ -1901,9 +2013,9 @@ export namespace LedgerCreateEntryParams {
|
|
|
1901
2013
|
description?: string | null;
|
|
1902
2014
|
|
|
1903
2015
|
/**
|
|
1904
|
-
* User-specified key/value pairs for the
|
|
2016
|
+
* User-specified key/value pairs for the resource.
|
|
1905
2017
|
*/
|
|
1906
|
-
metadata?:
|
|
2018
|
+
metadata?: Record<string, string | null> | null;
|
|
1907
2019
|
}
|
|
1908
2020
|
|
|
1909
2021
|
export interface AddExpirationChangeCreditLedgerEntryRequestParams {
|
|
@@ -1942,9 +2054,9 @@ export namespace LedgerCreateEntryParams {
|
|
|
1942
2054
|
description?: string | null;
|
|
1943
2055
|
|
|
1944
2056
|
/**
|
|
1945
|
-
* User-specified key/value pairs for the
|
|
2057
|
+
* User-specified key/value pairs for the resource.
|
|
1946
2058
|
*/
|
|
1947
|
-
metadata?:
|
|
2059
|
+
metadata?: Record<string, string | null> | null;
|
|
1948
2060
|
}
|
|
1949
2061
|
|
|
1950
2062
|
export interface AddVoidCreditLedgerEntryRequestParams {
|
|
@@ -1969,9 +2081,9 @@ export namespace LedgerCreateEntryParams {
|
|
|
1969
2081
|
description?: string | null;
|
|
1970
2082
|
|
|
1971
2083
|
/**
|
|
1972
|
-
* User-specified key/value pairs for the
|
|
2084
|
+
* User-specified key/value pairs for the resource.
|
|
1973
2085
|
*/
|
|
1974
|
-
metadata?:
|
|
2086
|
+
metadata?: Record<string, string | null> | null;
|
|
1975
2087
|
|
|
1976
2088
|
/**
|
|
1977
2089
|
* Can only be specified when `entry_type=void`. The reason for the void.
|
|
@@ -2001,9 +2113,9 @@ export namespace LedgerCreateEntryParams {
|
|
|
2001
2113
|
description?: string | null;
|
|
2002
2114
|
|
|
2003
2115
|
/**
|
|
2004
|
-
* User-specified key/value pairs for the
|
|
2116
|
+
* User-specified key/value pairs for the resource.
|
|
2005
2117
|
*/
|
|
2006
|
-
metadata?:
|
|
2118
|
+
metadata?: Record<string, string | null> | null;
|
|
2007
2119
|
}
|
|
2008
2120
|
}
|
|
2009
2121
|
|
|
@@ -2052,9 +2164,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
|
|
|
2052
2164
|
invoice_settings?: LedgerCreateEntryByExternalIDParams.AddIncrementCreditLedgerEntryRequestParams.InvoiceSettings | null;
|
|
2053
2165
|
|
|
2054
2166
|
/**
|
|
2055
|
-
* User-specified key/value pairs for the
|
|
2167
|
+
* User-specified key/value pairs for the resource.
|
|
2056
2168
|
*/
|
|
2057
|
-
metadata?:
|
|
2169
|
+
metadata?: Record<string, string | null> | null;
|
|
2058
2170
|
|
|
2059
2171
|
/**
|
|
2060
2172
|
* Can only be specified when entry_type=increment. How much, in USD, a customer
|
|
@@ -2108,9 +2220,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
|
|
|
2108
2220
|
description?: string | null;
|
|
2109
2221
|
|
|
2110
2222
|
/**
|
|
2111
|
-
* User-specified key/value pairs for the
|
|
2223
|
+
* User-specified key/value pairs for the resource.
|
|
2112
2224
|
*/
|
|
2113
|
-
metadata?:
|
|
2225
|
+
metadata?: Record<string, string | null> | null;
|
|
2114
2226
|
}
|
|
2115
2227
|
|
|
2116
2228
|
export interface AddExpirationChangeCreditLedgerEntryRequestParams {
|
|
@@ -2149,9 +2261,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
|
|
|
2149
2261
|
description?: string | null;
|
|
2150
2262
|
|
|
2151
2263
|
/**
|
|
2152
|
-
* User-specified key/value pairs for the
|
|
2264
|
+
* User-specified key/value pairs for the resource.
|
|
2153
2265
|
*/
|
|
2154
|
-
metadata?:
|
|
2266
|
+
metadata?: Record<string, string | null> | null;
|
|
2155
2267
|
}
|
|
2156
2268
|
|
|
2157
2269
|
export interface AddVoidCreditLedgerEntryRequestParams {
|
|
@@ -2176,9 +2288,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
|
|
|
2176
2288
|
description?: string | null;
|
|
2177
2289
|
|
|
2178
2290
|
/**
|
|
2179
|
-
* User-specified key/value pairs for the
|
|
2291
|
+
* User-specified key/value pairs for the resource.
|
|
2180
2292
|
*/
|
|
2181
|
-
metadata?:
|
|
2293
|
+
metadata?: Record<string, string | null> | null;
|
|
2182
2294
|
|
|
2183
2295
|
/**
|
|
2184
2296
|
* Can only be specified when `entry_type=void`. The reason for the void.
|
|
@@ -2208,9 +2320,9 @@ export namespace LedgerCreateEntryByExternalIDParams {
|
|
|
2208
2320
|
description?: string | null;
|
|
2209
2321
|
|
|
2210
2322
|
/**
|
|
2211
|
-
* User-specified key/value pairs for the
|
|
2323
|
+
* User-specified key/value pairs for the resource.
|
|
2212
2324
|
*/
|
|
2213
|
-
metadata?:
|
|
2325
|
+
metadata?: Record<string, string | null> | null;
|
|
2214
2326
|
}
|
|
2215
2327
|
}
|
|
2216
2328
|
|