orb-billing 2.2.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,80 @@
 # Changelog
 
+## 2.4.0 (2024-05-02)
+
+Full Changelog: [v2.3.0...v2.4.0](https://github.com/orbcorp/orb-node/compare/v2.3.0...v2.4.0)
+
+### Features
+
+* **api:** add effective_date field ([#163](https://github.com/orbcorp/orb-node/issues/163)) ([7a5d9af](https://github.com/orbcorp/orb-node/commit/7a5d9afe4f578cfc7f1e8a03767f75bad3579751))
+* **api:** add param to backfill create ([#174](https://github.com/orbcorp/orb-node/issues/174)) ([9379644](https://github.com/orbcorp/orb-node/commit/93796449184a9b4823a83ead1fa88b3557459588))
+* **api:** add subscription update endpoint ([#168](https://github.com/orbcorp/orb-node/issues/168)) ([d7ee5ba](https://github.com/orbcorp/orb-node/commit/d7ee5bae793278692eb62159152dd5ad1f015bc9))
+* **api:** add the shared model PaginationMetadata ([#164](https://github.com/orbcorp/orb-node/issues/164)) ([85956fe](https://github.com/orbcorp/orb-node/commit/85956fea41477392b725778e7d8364616236cad9))
+* **api:** price evaluation endpoint generally available ([#169](https://github.com/orbcorp/orb-node/issues/169)) ([c1e2b83](https://github.com/orbcorp/orb-node/commit/c1e2b837cad4c1786ca553b0ea9fbabfc4623880))
+* **api:** updates ([#154](https://github.com/orbcorp/orb-node/issues/154)) ([0f7c989](https://github.com/orbcorp/orb-node/commit/0f7c989eac9d033b1c8a03420efed405d3af4b88))
+* **api:** updates ([#159](https://github.com/orbcorp/orb-node/issues/159)) ([ca602ea](https://github.com/orbcorp/orb-node/commit/ca602eaa69dcf615f4785c41a0c078b9a20af029))
+* **api:** updates ([#179](https://github.com/orbcorp/orb-node/issues/179)) ([86b9015](https://github.com/orbcorp/orb-node/commit/86b9015532a7c165a605f77938c4bbadee24d452))
+
+
+### Bug Fixes
+
+* **api:** add shared model BillingCycleRelativeDate ([#167](https://github.com/orbcorp/orb-node/issues/167)) ([bb6764e](https://github.com/orbcorp/orb-node/commit/bb6764e1eed1bce9f1629e853de6a08eef0166cd))
+* **api:** some path params were incorrectly typed as nullable ([#166](https://github.com/orbcorp/orb-node/issues/166)) ([bafd0a9](https://github.com/orbcorp/orb-node/commit/bafd0a9e007ad993fc129dd18836583074cd6b86))
+* use UTC timezone for verifying webhook signature ([5eb9d2c](https://github.com/orbcorp/orb-node/commit/5eb9d2c50f5312d4ef82bc18bb94f95d1120b906)), closes [#156](https://github.com/orbcorp/orb-node/issues/156)
+
+
+### Chores
+
+* **internal:** add link to openapi spec ([#176](https://github.com/orbcorp/orb-node/issues/176)) ([fd77e6a](https://github.com/orbcorp/orb-node/commit/fd77e6a266b2ba7a82821552afa227eb26d69443))
+* **internal:** add scripts/test and scripts/mock ([#173](https://github.com/orbcorp/orb-node/issues/173)) ([495558b](https://github.com/orbcorp/orb-node/commit/495558b5f58d1729e3cc059e1c0acdaa039640af))
+* **internal:** add scripts/test, scripts/mock and add ci job ([#177](https://github.com/orbcorp/orb-node/issues/177)) ([4440933](https://github.com/orbcorp/orb-node/commit/4440933b3f3d51740d8fcfd4ab188856b09967e9))
+* **internal:** formatting ([#161](https://github.com/orbcorp/orb-node/issues/161)) ([b4ae917](https://github.com/orbcorp/orb-node/commit/b4ae9171619c0a23f368c92cc3e4b415859ac6af))
+* **internal:** forward arguments in scripts/test ([#178](https://github.com/orbcorp/orb-node/issues/178)) ([0564bfe](https://github.com/orbcorp/orb-node/commit/0564bfe383da0efbe642ad5801c0ef9484f9f36c))
+* **internal:** move client class to separate file ([#180](https://github.com/orbcorp/orb-node/issues/180)) ([9f56e13](https://github.com/orbcorp/orb-node/commit/9f56e13cce2e88d6a4a95a73215bd348a2685a9e))
+* **internal:** refactor scripts ([#175](https://github.com/orbcorp/orb-node/issues/175)) ([76f4954](https://github.com/orbcorp/orb-node/commit/76f49549e07628aea9747f2190766c6e966c3d2e))
+* **internal:** update gitignore ([#160](https://github.com/orbcorp/orb-node/issues/160)) ([bbd39e8](https://github.com/orbcorp/orb-node/commit/bbd39e830f21ef19b95dc7cd3ff06450906c360e))
+* **internal:** use @swc/jest for running tests ([#165](https://github.com/orbcorp/orb-node/issues/165)) ([50ad2b0](https://github.com/orbcorp/orb-node/commit/50ad2b09e4d415050660adb28b4549c55a0730f1))
+* **internal:** use actions/checkout@v4 for codeflow ([#171](https://github.com/orbcorp/orb-node/issues/171)) ([dcf2157](https://github.com/orbcorp/orb-node/commit/dcf21575dda07240093966cb560585f3eb08643c))
+* use debug instead of console log for webhook signature logging ([590cbf1](https://github.com/orbcorp/orb-node/commit/590cbf17e37a7eb071d6d31295b3f9cc9bb46579))
+
+
+### Build System
+
+* configure UTF-8 locale in devcontainer ([#162](https://github.com/orbcorp/orb-node/issues/162)) ([b1b8a5a](https://github.com/orbcorp/orb-node/commit/b1b8a5a1a586305e71183cd0c02f24a70513f3b1))
+
+## 2.3.0 (2024-04-24)
+
+Full Changelog: [v2.2.0...v2.3.0](https://github.com/orbcorp/orb-node/compare/v2.2.0...v2.3.0)
+
+### Features
+
+* **api:** add effective_date field ([#163](https://github.com/orbcorp/orb-node/issues/163)) ([96a98bd](https://github.com/orbcorp/orb-node/commit/96a98bd315ceb6f2239dee6267bcf0b3a7e84a39))
+* **api:** add subscription update endpoint ([#168](https://github.com/orbcorp/orb-node/issues/168)) ([09b5798](https://github.com/orbcorp/orb-node/commit/09b5798769187bcb18c92210c8b336b169f72343))
+* **api:** add the shared model PaginationMetadata ([#164](https://github.com/orbcorp/orb-node/issues/164)) ([15f5af3](https://github.com/orbcorp/orb-node/commit/15f5af31b39a66ef8a626af50d09abf3202afc8f))
+* **api:** price evaluation endpoint generally available ([#169](https://github.com/orbcorp/orb-node/issues/169)) ([492a728](https://github.com/orbcorp/orb-node/commit/492a72833150267df706054e5d8c1ce998b27999))
+* **api:** updates ([#154](https://github.com/orbcorp/orb-node/issues/154)) ([01aef6d](https://github.com/orbcorp/orb-node/commit/01aef6d41d2fd0f6174eb6116ac2a670cfc96882))
+* **api:** updates ([#159](https://github.com/orbcorp/orb-node/issues/159)) ([5b6287c](https://github.com/orbcorp/orb-node/commit/5b6287c047ed1a5eab7e498690838062c233a1a7))
+
+
+### Bug Fixes
+
+* **api:** add shared model BillingCycleRelativeDate ([#167](https://github.com/orbcorp/orb-node/issues/167)) ([8677375](https://github.com/orbcorp/orb-node/commit/867737537ddecdfcaaf33bb0bd3fe29532f265c4))
+* **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))
+* 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)
+
+
+### Chores
+
+* **internal:** formatting ([#161](https://github.com/orbcorp/orb-node/issues/161)) ([db765d8](https://github.com/orbcorp/orb-node/commit/db765d86efc540e6301fc15912360ba66218c673))
+* **internal:** update gitignore ([#160](https://github.com/orbcorp/orb-node/issues/160)) ([7a2c39f](https://github.com/orbcorp/orb-node/commit/7a2c39f468ea6aba7133d6fdfd28c632c119e145))
+* **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))
+* use debug instead of console log for webhook signature logging ([590cbf1](https://github.com/orbcorp/orb-node/commit/590cbf17e37a7eb071d6d31295b3f9cc9bb46579))
+
+
+### Build System
+
+* configure UTF-8 locale in devcontainer ([#162](https://github.com/orbcorp/orb-node/issues/162)) ([aa09c7d](https://github.com/orbcorp/orb-node/commit/aa09c7dfc261b6e05e8e944f23a55463f80d13da))
+
 ## 2.2.0 (2024-04-08)
 
 Full Changelog: [v2.1.2...v2.2.0](https://github.com/orbcorp/orb-node/compare/v2.1.2...v2.2.0)

package/client.d.ts

@@ -0,0 +1,222 @@
+import * as Core from "./core.js";
+import * as Errors from "./error.js";
+import { type Agent } from "./_shims/index.js";
+import * as Uploads from "./uploads.js";
+import * as Pagination from 'orb-billing/pagination';
+import * as API from 'orb-billing/resources/index';
+export interface ClientOptions {
+    /**
+     * Defaults to process.env['ORB_API_KEY'].
+     */
+    apiKey?: string | undefined;
+    /**
+     * Defaults to process.env['ORB_WEBHOOK_SECRET'].
+     */
+    webhookSecret?: string | null | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+     *
+     * Defaults to process.env['ORB_BASE_URL'].
+     */
+    baseURL?: string | null | undefined;
+    /**
+     * The maximum amount of time (in milliseconds) that the client should wait for a response
+     * from the server before timing out a single request.
+     *
+     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+     * much longer than this timeout before the promise succeeds or fails.
+     */
+    timeout?: number;
+    /**
+     * An HTTP agent used to manage HTTP(S) connections.
+     *
+     * If not provided, an agent will be constructed by default in the Node.js environment,
+     * otherwise no agent is used.
+     */
+    httpAgent?: Agent;
+    /**
+     * Specify a custom `fetch` function implementation.
+     *
+     * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+     * defined globally.
+     */
+    fetch?: Core.Fetch | undefined;
+    /**
+     * The maximum number of times that the client will retry a request in case of a
+     * temporary failure, like a network error or a 5XX error from the server.
+     *
+     * @default 2
+     */
+    maxRetries?: number;
+    /**
+     * Default headers to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * header to `undefined` or `null` in request options.
+     */
+    defaultHeaders?: Core.Headers;
+    /**
+     * Default query parameters to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * param to `undefined` in request options.
+     */
+    defaultQuery?: Core.DefaultQuery;
+}
+/** API Client for interfacing with the Orb API. */
+export declare class Orb extends Core.APIClient {
+    apiKey: string;
+    webhookSecret: string | null;
+    private _options;
+    /**
+     * API Client for interfacing with the Orb API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
+     * @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
+     * @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL, apiKey, webhookSecret, ...opts }?: ClientOptions);
+    topLevel: API.TopLevel;
+    coupons: API.Coupons;
+    creditNotes: API.CreditNotes;
+    customers: API.Customers;
+    events: API.Events;
+    invoiceLineItems: API.InvoiceLineItems;
+    invoices: API.Invoices;
+    items: API.Items;
+    metrics: API.Metrics;
+    plans: API.Plans;
+    prices: API.Prices;
+    subscriptions: API.Subscriptions;
+    webhooks: API.Webhooks;
+    protected defaultQuery(): Core.DefaultQuery | undefined;
+    protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
+    protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
+    protected stringifyQuery(query: Record<string, unknown>): string;
+    static Orb: typeof Orb;
+    static OrbError: typeof Errors.OrbError;
+    static APIError: typeof Errors.APIError;
+    static APIConnectionError: typeof Errors.APIConnectionError;
+    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
+    static APIUserAbortError: typeof Errors.APIUserAbortError;
+    static URLNotFound: typeof Errors.URLNotFound;
+    static NotFoundError: typeof Errors.NotFoundError;
+    static ConflictError: typeof Errors.ConflictError;
+    static RateLimitError: typeof Errors.RateLimitError;
+    static BadRequestError: typeof Errors.BadRequestError;
+    static RequestTooLarge: typeof Errors.RequestTooLarge;
+    static TooManyRequests: typeof Errors.TooManyRequests;
+    static ResourceNotFound: typeof Errors.ResourceNotFound;
+    static ResourceConflict: typeof Errors.ResourceConflict;
+    static ResourceTooLarge: typeof Errors.ResourceTooLarge;
+    static AuthenticationError: typeof Errors.AuthenticationError;
+    static InternalServerError: typeof Errors.InternalServerError;
+    static ConstraintViolation: typeof Errors.ConstraintViolation;
+    static FeatureNotAvailable: typeof Errors.FeatureNotAvailable;
+    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
+    static RequestValidationError: typeof Errors.RequestValidationError;
+    static OrbAuthenticationError: typeof Errors.OrbAuthenticationError;
+    static OrbInternalServerError: typeof Errors.OrbInternalServerError;
+    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
+    static DuplicateResourceCreation: typeof Errors.DuplicateResourceCreation;
+    static toFile: typeof Uploads.toFile;
+    static fileFromPath: typeof Uploads.fileFromPath;
+}
+export declare namespace Orb {
+    export import RequestOptions = Core.RequestOptions;
+    export import Page = Pagination.Page;
+    export import PageParams = Pagination.PageParams;
+    export import PageResponse = Pagination.PageResponse;
+    export import TopLevel = API.TopLevel;
+    export import TopLevelPingResponse = API.TopLevelPingResponse;
+    export import Coupons = API.Coupons;
+    export import Coupon = API.Coupon;
+    export import CouponsPage = API.CouponsPage;
+    export import CouponCreateParams = API.CouponCreateParams;
+    export import CouponListParams = API.CouponListParams;
+    export import CreditNotes = API.CreditNotes;
+    export import CreditNote = API.CreditNote;
+    export import CreditNotesPage = API.CreditNotesPage;
+    export import CreditNoteListParams = API.CreditNoteListParams;
+    export import Customers = API.Customers;
+    export import Customer = API.Customer;
+    export import CustomersPage = API.CustomersPage;
+    export import CustomerCreateParams = API.CustomerCreateParams;
+    export import CustomerUpdateParams = API.CustomerUpdateParams;
+    export import CustomerListParams = API.CustomerListParams;
+    export import CustomerUpdateByExternalIDParams = API.CustomerUpdateByExternalIDParams;
+    export import Events = API.Events;
+    export import EventUpdateResponse = API.EventUpdateResponse;
+    export import EventDeprecateResponse = API.EventDeprecateResponse;
+    export import EventIngestResponse = API.EventIngestResponse;
+    export import EventSearchResponse = API.EventSearchResponse;
+    export import EventUpdateParams = API.EventUpdateParams;
+    export import EventIngestParams = API.EventIngestParams;
+    export import EventSearchParams = API.EventSearchParams;
+    export import InvoiceLineItems = API.InvoiceLineItems;
+    export import InvoiceLineItemCreateResponse = API.InvoiceLineItemCreateResponse;
+    export import InvoiceLineItemCreateParams = API.InvoiceLineItemCreateParams;
+    export import Invoices = API.Invoices;
+    export import Invoice = API.Invoice;
+    export import InvoiceFetchUpcomingResponse = API.InvoiceFetchUpcomingResponse;
+    export import InvoicesPage = API.InvoicesPage;
+    export import InvoiceCreateParams = API.InvoiceCreateParams;
+    export import InvoiceListParams = API.InvoiceListParams;
+    export import InvoiceFetchUpcomingParams = API.InvoiceFetchUpcomingParams;
+    export import InvoiceMarkPaidParams = API.InvoiceMarkPaidParams;
+    export import Items = API.Items;
+    export import Item = API.Item;
+    export import ItemsPage = API.ItemsPage;
+    export import ItemCreateParams = API.ItemCreateParams;
+    export import ItemListParams = API.ItemListParams;
+    export import Metrics = API.Metrics;
+    export import MetricCreateResponse = API.MetricCreateResponse;
+    export import MetricListResponse = API.MetricListResponse;
+    export import MetricFetchResponse = API.MetricFetchResponse;
+    export import MetricListResponsesPage = API.MetricListResponsesPage;
+    export import MetricCreateParams = API.MetricCreateParams;
+    export import MetricListParams = API.MetricListParams;
+    export import Plans = API.Plans;
+    export import Plan = API.Plan;
+    export import PlansPage = API.PlansPage;
+    export import PlanCreateParams = API.PlanCreateParams;
+    export import PlanUpdateParams = API.PlanUpdateParams;
+    export import PlanListParams = API.PlanListParams;
+    export import Prices = API.Prices;
+    export import EvaluatePriceGroup = API.EvaluatePriceGroup;
+    export import Price = API.Price;
+    export import PriceEvaluateResponse = API.PriceEvaluateResponse;
+    export import PricesPage = API.PricesPage;
+    export import PriceCreateParams = API.PriceCreateParams;
+    export import PriceListParams = API.PriceListParams;
+    export import PriceEvaluateParams = API.PriceEvaluateParams;
+    export import Subscriptions = API.Subscriptions;
+    export import Subscription = API.Subscription;
+    export import SubscriptionUsage = API.SubscriptionUsage;
+    export import SubscriptionFetchCostsResponse = API.SubscriptionFetchCostsResponse;
+    export import SubscriptionFetchScheduleResponse = API.SubscriptionFetchScheduleResponse;
+    export import SubscriptionsPage = API.SubscriptionsPage;
+    export import SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
+    export import SubscriptionCreateParams = API.SubscriptionCreateParams;
+    export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
+    export import SubscriptionListParams = API.SubscriptionListParams;
+    export import SubscriptionCancelParams = API.SubscriptionCancelParams;
+    export import SubscriptionFetchCostsParams = API.SubscriptionFetchCostsParams;
+    export import SubscriptionFetchScheduleParams = API.SubscriptionFetchScheduleParams;
+    export import SubscriptionFetchUsageParams = API.SubscriptionFetchUsageParams;
+    export import SubscriptionPriceIntervalsParams = API.SubscriptionPriceIntervalsParams;
+    export import SubscriptionSchedulePlanChangeParams = API.SubscriptionSchedulePlanChangeParams;
+    export import SubscriptionTriggerPhaseParams = API.SubscriptionTriggerPhaseParams;
+    export import SubscriptionUnscheduleFixedFeeQuantityUpdatesParams = API.SubscriptionUnscheduleFixedFeeQuantityUpdatesParams;
+    export import SubscriptionUpdateFixedFeeQuantityParams = API.SubscriptionUpdateFixedFeeQuantityParams;
+    export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
+    export import Discount = API.Discount;
+    export import PaginationMetadata = API.PaginationMetadata;
+}
+//# sourceMappingURL=client.d.ts.map

package/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.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,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"}

package/client.js

@@ -0,0 +1,156 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Orb = void 0;
+const Core = __importStar(require("./core.js"));
+const Errors = __importStar(require("./error.js"));
+const Uploads = __importStar(require("./uploads.js"));
+const qs = __importStar(require("qs"));
+const Pagination = __importStar(require("orb-billing/pagination"));
+const API = __importStar(require("orb-billing/resources/index"));
+/** API Client for interfacing with the Orb API. */
+class Orb extends Core.APIClient {
+    /**
+     * API Client for interfacing with the Orb API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
+     * @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
+     * @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), webhookSecret = Core.readEnv('ORB_WEBHOOK_SECRET') ?? null, ...opts } = {}) {
+        if (apiKey === undefined) {
+            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' }).");
+        }
+        const options = {
+            apiKey,
+            webhookSecret,
+            ...opts,
+            baseURL: baseURL || `https://api.withorb.com/v1`,
+        };
+        super({
+            baseURL: options.baseURL,
+            timeout: options.timeout ?? 60000 /* 1 minute */,
+            httpAgent: options.httpAgent,
+            maxRetries: options.maxRetries,
+            fetch: options.fetch,
+        });
+        this.topLevel = new API.TopLevel(this);
+        this.coupons = new API.Coupons(this);
+        this.creditNotes = new API.CreditNotes(this);
+        this.customers = new API.Customers(this);
+        this.events = new API.Events(this);
+        this.invoiceLineItems = new API.InvoiceLineItems(this);
+        this.invoices = new API.Invoices(this);
+        this.items = new API.Items(this);
+        this.metrics = new API.Metrics(this);
+        this.plans = new API.Plans(this);
+        this.prices = new API.Prices(this);
+        this.subscriptions = new API.Subscriptions(this);
+        this.webhooks = new API.Webhooks(this);
+        this._options = options;
+        this.idempotencyHeader = 'Idempotency-Key';
+        this.apiKey = apiKey;
+        this.webhookSecret = webhookSecret;
+    }
+    defaultQuery() {
+        return this._options.defaultQuery;
+    }
+    defaultHeaders(opts) {
+        return {
+            ...super.defaultHeaders(opts),
+            ...this._options.defaultHeaders,
+        };
+    }
+    authHeaders(opts) {
+        return { Authorization: `Bearer ${this.apiKey}` };
+    }
+    stringifyQuery(query) {
+        return qs.stringify(query, { arrayFormat: 'brackets' });
+    }
+}
+exports.Orb = Orb;
+_a = Orb;
+Orb.Orb = _a;
+Orb.OrbError = Errors.OrbError;
+Orb.APIError = Errors.APIError;
+Orb.APIConnectionError = Errors.APIConnectionError;
+Orb.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+Orb.APIUserAbortError = Errors.APIUserAbortError;
+Orb.URLNotFound = Errors.URLNotFound;
+Orb.NotFoundError = Errors.NotFoundError;
+Orb.ConflictError = Errors.ConflictError;
+Orb.RateLimitError = Errors.RateLimitError;
+Orb.BadRequestError = Errors.BadRequestError;
+Orb.RequestTooLarge = Errors.RequestTooLarge;
+Orb.TooManyRequests = Errors.TooManyRequests;
+Orb.ResourceNotFound = Errors.ResourceNotFound;
+Orb.ResourceConflict = Errors.ResourceConflict;
+Orb.ResourceTooLarge = Errors.ResourceTooLarge;
+Orb.AuthenticationError = Errors.AuthenticationError;
+Orb.InternalServerError = Errors.InternalServerError;
+Orb.ConstraintViolation = Errors.ConstraintViolation;
+Orb.FeatureNotAvailable = Errors.FeatureNotAvailable;
+Orb.PermissionDeniedError = Errors.PermissionDeniedError;
+Orb.RequestValidationError = Errors.RequestValidationError;
+Orb.OrbAuthenticationError = Errors.OrbAuthenticationError;
+Orb.OrbInternalServerError = Errors.OrbInternalServerError;
+Orb.UnprocessableEntityError = Errors.UnprocessableEntityError;
+Orb.DuplicateResourceCreation = Errors.DuplicateResourceCreation;
+Orb.toFile = Uploads.toFile;
+Orb.fileFromPath = Uploads.fileFromPath;
+(function (Orb) {
+    Orb.Page = Pagination.Page;
+    Orb.TopLevel = API.TopLevel;
+    Orb.Coupons = API.Coupons;
+    Orb.CouponsPage = API.CouponsPage;
+    Orb.CreditNotes = API.CreditNotes;
+    Orb.CreditNotesPage = API.CreditNotesPage;
+    Orb.Customers = API.Customers;
+    Orb.CustomersPage = API.CustomersPage;
+    Orb.Events = API.Events;
+    Orb.InvoiceLineItems = API.InvoiceLineItems;
+    Orb.Invoices = API.Invoices;
+    Orb.InvoicesPage = API.InvoicesPage;
+    Orb.Items = API.Items;
+    Orb.ItemsPage = API.ItemsPage;
+    Orb.Metrics = API.Metrics;
+    Orb.MetricListResponsesPage = API.MetricListResponsesPage;
+    Orb.Plans = API.Plans;
+    Orb.PlansPage = API.PlansPage;
+    Orb.Prices = API.Prices;
+    Orb.PricesPage = API.PricesPage;
+    Orb.Subscriptions = API.Subscriptions;
+    Orb.SubscriptionsPage = API.SubscriptionsPage;
+    Orb.SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
+})(Orb = exports.Orb || (exports.Orb = {}));
+//# sourceMappingURL=client.js.map

package/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["src/client.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;AAG7C,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"}

package/client.mjs

@@ -0,0 +1,129 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var _a;
+import * as Core from "./core.mjs";
+import * as Errors from "./error.mjs";
+import * as Uploads from "./uploads.mjs";
+import * as qs from 'qs';
+import * as Pagination from 'orb-billing/pagination';
+import * as API from 'orb-billing/resources/index';
+/** API Client for interfacing with the Orb API. */
+export class Orb extends Core.APIClient {
+    /**
+     * API Client for interfacing with the Orb API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['ORB_API_KEY'] ?? undefined]
+     * @param {string | null | undefined} [opts.webhookSecret=process.env['ORB_WEBHOOK_SECRET'] ?? null]
+     * @param {string} [opts.baseURL=process.env['ORB_BASE_URL'] ?? https://api.withorb.com/v1] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL = Core.readEnv('ORB_BASE_URL'), apiKey = Core.readEnv('ORB_API_KEY'), webhookSecret = Core.readEnv('ORB_WEBHOOK_SECRET') ?? null, ...opts } = {}) {
+        if (apiKey === undefined) {
+            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' }).");
+        }
+        const options = {
+            apiKey,
+            webhookSecret,
+            ...opts,
+            baseURL: baseURL || `https://api.withorb.com/v1`,
+        };
+        super({
+            baseURL: options.baseURL,
+            timeout: options.timeout ?? 60000 /* 1 minute */,
+            httpAgent: options.httpAgent,
+            maxRetries: options.maxRetries,
+            fetch: options.fetch,
+        });
+        this.topLevel = new API.TopLevel(this);
+        this.coupons = new API.Coupons(this);
+        this.creditNotes = new API.CreditNotes(this);
+        this.customers = new API.Customers(this);
+        this.events = new API.Events(this);
+        this.invoiceLineItems = new API.InvoiceLineItems(this);
+        this.invoices = new API.Invoices(this);
+        this.items = new API.Items(this);
+        this.metrics = new API.Metrics(this);
+        this.plans = new API.Plans(this);
+        this.prices = new API.Prices(this);
+        this.subscriptions = new API.Subscriptions(this);
+        this.webhooks = new API.Webhooks(this);
+        this._options = options;
+        this.idempotencyHeader = 'Idempotency-Key';
+        this.apiKey = apiKey;
+        this.webhookSecret = webhookSecret;
+    }
+    defaultQuery() {
+        return this._options.defaultQuery;
+    }
+    defaultHeaders(opts) {
+        return {
+            ...super.defaultHeaders(opts),
+            ...this._options.defaultHeaders,
+        };
+    }
+    authHeaders(opts) {
+        return { Authorization: `Bearer ${this.apiKey}` };
+    }
+    stringifyQuery(query) {
+        return qs.stringify(query, { arrayFormat: 'brackets' });
+    }
+}
+_a = Orb;
+Orb.Orb = _a;
+Orb.OrbError = Errors.OrbError;
+Orb.APIError = Errors.APIError;
+Orb.APIConnectionError = Errors.APIConnectionError;
+Orb.APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+Orb.APIUserAbortError = Errors.APIUserAbortError;
+Orb.URLNotFound = Errors.URLNotFound;
+Orb.NotFoundError = Errors.NotFoundError;
+Orb.ConflictError = Errors.ConflictError;
+Orb.RateLimitError = Errors.RateLimitError;
+Orb.BadRequestError = Errors.BadRequestError;
+Orb.RequestTooLarge = Errors.RequestTooLarge;
+Orb.TooManyRequests = Errors.TooManyRequests;
+Orb.ResourceNotFound = Errors.ResourceNotFound;
+Orb.ResourceConflict = Errors.ResourceConflict;
+Orb.ResourceTooLarge = Errors.ResourceTooLarge;
+Orb.AuthenticationError = Errors.AuthenticationError;
+Orb.InternalServerError = Errors.InternalServerError;
+Orb.ConstraintViolation = Errors.ConstraintViolation;
+Orb.FeatureNotAvailable = Errors.FeatureNotAvailable;
+Orb.PermissionDeniedError = Errors.PermissionDeniedError;
+Orb.RequestValidationError = Errors.RequestValidationError;
+Orb.OrbAuthenticationError = Errors.OrbAuthenticationError;
+Orb.OrbInternalServerError = Errors.OrbInternalServerError;
+Orb.UnprocessableEntityError = Errors.UnprocessableEntityError;
+Orb.DuplicateResourceCreation = Errors.DuplicateResourceCreation;
+Orb.toFile = Uploads.toFile;
+Orb.fileFromPath = Uploads.fileFromPath;
+(function (Orb) {
+    Orb.Page = Pagination.Page;
+    Orb.TopLevel = API.TopLevel;
+    Orb.Coupons = API.Coupons;
+    Orb.CouponsPage = API.CouponsPage;
+    Orb.CreditNotes = API.CreditNotes;
+    Orb.CreditNotesPage = API.CreditNotesPage;
+    Orb.Customers = API.Customers;
+    Orb.CustomersPage = API.CustomersPage;
+    Orb.Events = API.Events;
+    Orb.InvoiceLineItems = API.InvoiceLineItems;
+    Orb.Invoices = API.Invoices;
+    Orb.InvoicesPage = API.InvoicesPage;
+    Orb.Items = API.Items;
+    Orb.ItemsPage = API.ItemsPage;
+    Orb.Metrics = API.Metrics;
+    Orb.MetricListResponsesPage = API.MetricListResponsesPage;
+    Orb.Plans = API.Plans;
+    Orb.PlansPage = API.PlansPage;
+    Orb.Prices = API.Prices;
+    Orb.PricesPage = API.PricesPage;
+    Orb.Subscriptions = API.Subscriptions;
+    Orb.SubscriptionsPage = API.SubscriptionsPage;
+    Orb.SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
+})(Orb || (Orb = {}));
+//# sourceMappingURL=client.mjs.map

package/client.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.mjs","sourceRoot":"","sources":["src/client.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,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"}