lark-billing 0.1.4 → 0.2.0

package/src/resources/subscriptions.ts

@@ -0,0 +1,361 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as SubscriptionsAPI from './subscriptions';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Subscriptions extends APIResource {
+  /**
+   * Create Subscription
+   *
+   * @example
+   * ```ts
+   * const subscription = await client.subscriptions.create({
+   *   checkout_callback_urls: {
+   *     cancelled_url: 'https://example.com/callback',
+   *     success_url: 'https://example.com/callback',
+   *   },
+   *   rate_card_id: 'rc_AJWMxR81jxoRlli6p13uf3JB',
+   *   subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+   * });
+   * ```
+   */
+  create(body: SubscriptionCreateParams, options?: RequestOptions): APIPromise<SubscriptionCreateResponse> {
+    return this._client.post('/subscriptions', { body, ...options });
+  }
+
+  /**
+   * Get Subscription
+   *
+   * @example
+   * ```ts
+   * const subscriptionResource =
+   *   await client.subscriptions.retrieve('subscription_id');
+   * ```
+   */
+  retrieve(subscriptionID: string, options?: RequestOptions): APIPromise<SubscriptionResource> {
+    return this._client.get(path`/subscriptions/${subscriptionID}`, options);
+  }
+
+  /**
+   * List Subscriptions
+   *
+   * @example
+   * ```ts
+   * const subscriptions = await client.subscriptions.list();
+   * ```
+   */
+  list(
+    query: SubscriptionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionListResponse> {
+    return this._client.get('/subscriptions', { query, ...options });
+  }
+
+  /**
+   * Cancel Subscription
+   *
+   * @example
+   * ```ts
+   * const subscriptionResource =
+   *   await client.subscriptions.cancel('subscription_id');
+   * ```
+   */
+  cancel(
+    subscriptionID: string,
+    body: SubscriptionCancelParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionResource> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/cancel`, { body, ...options });
+  }
+
+  /**
+   * Change Subscription Rate Card
+   *
+   * @example
+   * ```ts
+   * const response = await client.subscriptions.changeRateCard(
+   *   'subscription_id',
+   *   {
+   *     checkout_callback_urls: {
+   *       cancelled_url: 'https://example.com/callback',
+   *       success_url: 'https://example.com/callback',
+   *     },
+   *     rate_card_id: 'rc_jQK2n0wutCj6bBcAIrL6o07g',
+   *   },
+   * );
+   * ```
+   */
+  changeRateCard(
+    subscriptionID: string,
+    body: SubscriptionChangeRateCardParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionChangeRateCardResponse> {
+    return this._client.post(path`/subscriptions/${subscriptionID}/change-rate-card`, { body, ...options });
+  }
+}
+
+export interface CheckoutCallback {
+  /**
+   * The URL to redirect to after the checkout is cancelled.
+   */
+  cancelled_url: string;
+
+  /**
+   * The URL to redirect to after the checkout is successful.
+   */
+  success_url: string;
+}
+
+export interface SubscriptionResource {
+  /**
+   * The ID of the subscription.
+   */
+  id: string;
+
+  /**
+   * Whether the subscription will be cancelled at the end of the current cycle.
+   */
+  cancels_at_end_of_cycle: boolean;
+
+  /**
+   * The current period of the subscription if it is active.
+   */
+  current_period: SubscriptionResource.CurrentPeriod | null;
+
+  /**
+   * The date and time the next cycle of the subscription will start.
+   */
+  cycles_next_at: string | null;
+
+  /**
+   * The date and time the subscription became effective.
+   */
+  effective_at: string;
+
+  metadata: { [key: string]: string };
+
+  /**
+   * The ID of the rate card of the subscription.
+   */
+  rate_card_id: string;
+
+  /**
+   * The status of the subscription.
+   */
+  status: 'active' | 'cancelled' | 'paused';
+
+  /**
+   * The ID of the subject that the subscription is for.
+   */
+  subject_id: string;
+}
+
+export namespace SubscriptionResource {
+  /**
+   * The current period of the subscription if it is active.
+   */
+  export interface CurrentPeriod {
+    end: string;
+
+    start: string;
+
+    inclusive_end?: boolean;
+
+    inclusive_start?: boolean;
+  }
+}
+
+export interface SubscriptionCreateResponse {
+  /**
+   * The result of the request. If the request is successful, the subscription
+   * resource will be returned. If the request is requires action, the action to take
+   * to complete the request will be returned.
+   */
+  result:
+    | SubscriptionCreateResponse.CreateSubscriptionRequiresActionResponse
+    | SubscriptionCreateResponse.CreateSubscriptionSuccessResponse;
+}
+
+export namespace SubscriptionCreateResponse {
+  export interface CreateSubscriptionRequiresActionResponse {
+    /**
+     * The action to take to complete the request.
+     */
+    action: CreateSubscriptionRequiresActionResponse.Action;
+
+    result_type: 'requires_action';
+  }
+
+  export namespace CreateSubscriptionRequiresActionResponse {
+    /**
+     * The action to take to complete the request.
+     */
+    export interface Action {
+      /**
+       * The URL of the checkout page to redirect to in order to complete the request.
+       */
+      checkout_url: string;
+
+      requires_action_type: 'checkout';
+    }
+  }
+
+  export interface CreateSubscriptionSuccessResponse {
+    result_type: 'success';
+
+    /**
+     * The created subscription resource.
+     */
+    subscription: SubscriptionsAPI.SubscriptionResource;
+  }
+}
+
+export interface SubscriptionListResponse {
+  has_more: boolean;
+
+  subscriptions: Array<SubscriptionResource>;
+}
+
+export interface SubscriptionChangeRateCardResponse {
+  /**
+   * The result of the request. If the request is successful, the subscription
+   * resource will be returned. If the request is requires action, the action to take
+   * to complete the request will be returned.
+   */
+  result:
+    | SubscriptionChangeRateCardResponse.ChangeSubscriptionRateCardRequiresActionResponse
+    | SubscriptionChangeRateCardResponse.ChangeSubscriptionRateCardSuccessResponse;
+}
+
+export namespace SubscriptionChangeRateCardResponse {
+  export interface ChangeSubscriptionRateCardRequiresActionResponse {
+    /**
+     * The action to take to complete the request.
+     */
+    action: ChangeSubscriptionRateCardRequiresActionResponse.Action;
+
+    type: 'requires_action';
+  }
+
+  export namespace ChangeSubscriptionRateCardRequiresActionResponse {
+    /**
+     * The action to take to complete the request.
+     */
+    export interface Action {
+      /**
+       * The URL of the checkout page to redirect to in order to complete the request.
+       */
+      checkout_url: string;
+
+      type: 'checkout';
+    }
+  }
+
+  export interface ChangeSubscriptionRateCardSuccessResponse {
+    /**
+     * The updated subscription resource.
+     */
+    subscription: SubscriptionsAPI.SubscriptionResource;
+
+    type: 'success';
+  }
+}
+
+export interface SubscriptionCreateParams {
+  /**
+   * The URLs to redirect to after the checkout is completed or cancelled, if a
+   * checkout is required.
+   */
+  checkout_callback_urls: CheckoutCallback;
+
+  /**
+   * The ID of the rate card to use for the subscription.
+   */
+  rate_card_id: string;
+
+  /**
+   * The ID or external ID of the subject to create the subscription for.
+   */
+  subject_id: string;
+
+  /**
+   * Determines whether a checkout session is always required even if the subject has
+   * a payment method on file. By default, if the subject has a payment method on
+   * file or the subscription is for a free plan, the subscription will be created
+   * and billed for immediately (if for a paid plan).
+   */
+  create_checkout_session?: 'when_required' | 'always';
+
+  /**
+   * Additional metadata about the subscription. You may use this to store any custom
+   * data about the subscription.
+   */
+  metadata?: { [key: string]: string };
+}
+
+export interface SubscriptionListParams {
+  limit?: number;
+
+  offset?: number;
+
+  /**
+   * The ID of the rate card to list subscriptions for. Cannot be used with
+   * subject_id.
+   */
+  rate_card_id?: string | null;
+
+  /**
+   * The ID or external ID of the subject to list subscriptions for. Cannot be used
+   * with rate_card_id.
+   */
+  subject_id?: string | null;
+}
+
+export interface SubscriptionCancelParams {
+  /**
+   * Whether to cancel the subscription at end of cycle.
+   */
+  cancel_at_end_of_cycle?: true;
+
+  /**
+   * The reason for cancelling the subscription.
+   */
+  reason?: string | null;
+}
+
+export interface SubscriptionChangeRateCardParams {
+  /**
+   * The URLs to redirect to after the checkout is completed or cancelled, if a
+   * checkout is required.
+   */
+  checkout_callback_urls: CheckoutCallback;
+
+  /**
+   * The ID of the rate card to change the subscription to.
+   */
+  rate_card_id: string;
+
+  /**
+   * The behavior to use when upgrading the subscription. If 'prorate', the customer
+   * will be charged for the prorated difference. If 'rate_difference', the customer
+   * will be charged for the difference in the rate cards without respect to time.
+   */
+  upgrade_behavior?: 'prorate' | 'rate_difference';
+}
+
+export declare namespace Subscriptions {
+  export {
+    type CheckoutCallback as CheckoutCallback,
+    type SubscriptionResource as SubscriptionResource,
+    type SubscriptionCreateResponse as SubscriptionCreateResponse,
+    type SubscriptionListResponse as SubscriptionListResponse,
+    type SubscriptionChangeRateCardResponse as SubscriptionChangeRateCardResponse,
+    type SubscriptionCreateParams as SubscriptionCreateParams,
+    type SubscriptionListParams as SubscriptionListParams,
+    type SubscriptionCancelParams as SubscriptionCancelParams,
+    type SubscriptionChangeRateCardParams as SubscriptionChangeRateCardParams,
+  };
+}

package/src/resources/usage-events.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class UsageEvents extends APIResource {
+  /**
+   * Create Usage Event
+   *
+   * @example
+   * ```ts
+   * const usageEvent = await client.usageEvents.create({
+   *   data: {
+   *     compute_hours: 100,
+   *     instance_type: 't2.micro',
+   *     region: 'us-east-1',
+   *   },
+   *   event_name: 'compute_hours',
+   *   idempotency_key: 'dd187757-47af-4a69-8a89-6285b9fe1cb6',
+   *   subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
+   * });
+   * ```
+   */
+  create(body: UsageEventCreateParams, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.post('/usage-events', { body, ...options });
+  }
+}
+
+export type UsageEventCreateResponse = unknown;
+
+export interface UsageEventCreateParams {
+  /**
+   * The data of the usage event. This should contain any data that is needed to
+   * aggregate the usage event.
+   */
+  data: { [key: string]: string | number };
+
+  /**
+   * The name of the event. This is used by pricing metrics to aggregate usage
+   * events.
+   */
+  event_name: string;
+
+  /**
+   * The idempotency key for the usage event. This ensures that the same event is not
+   * processed multiple times.
+   */
+  idempotency_key: string;
+
+  /**
+   * The ID or external ID of the subject that the usage event is for.
+   */
+  subject_id: string;
+
+  /**
+   * The timestamp of the usage event. It is highly recommended to provide a
+   * timestamp. If not provided, the current timestamp will be used.
+   */
+  timestamp?: string | null;
+}
+
+export declare namespace UsageEvents {
+  export {
+    type UsageEventCreateResponse as UsageEventCreateResponse,
+    type UsageEventCreateParams as UsageEventCreateParams,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.2.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.2.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.2.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.2.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.2.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/dist/cjs/Client.d.ts

@@ -1,58 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "./environments.js";
-import * as core from "./core/index.js";
-import { Checkout } from "./api/resources/checkout/client/Client.js";
-import { CustomerPortal } from "./api/resources/customerPortal/client/Client.js";
-import { RateCards } from "./api/resources/rateCards/client/Client.js";
-import { UsageEvents } from "./api/resources/usageEvents/client/Client.js";
-import { Subscriptions } from "./api/resources/subscriptions/client/Client.js";
-import { Subjects } from "./api/resources/subjects/client/Client.js";
-import { PricingMetrics } from "./api/resources/pricingMetrics/client/Client.js";
-import { CustomerAccess } from "./api/resources/customerAccess/client/Client.js";
-import { Invoices } from "./api/resources/invoices/client/Client.js";
-export declare namespace LarkClient {
-    interface Options {
-        environment?: core.Supplier<environments.LarkEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional query string parameters to include in the request. */
-        queryParams?: Record<string, unknown>;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
-    }
-}
-export declare class LarkClient {
-    protected readonly _options: LarkClient.Options;
-    protected _checkout: Checkout | undefined;
-    protected _customerPortal: CustomerPortal | undefined;
-    protected _rateCards: RateCards | undefined;
-    protected _usageEvents: UsageEvents | undefined;
-    protected _subscriptions: Subscriptions | undefined;
-    protected _subjects: Subjects | undefined;
-    protected _pricingMetrics: PricingMetrics | undefined;
-    protected _customerAccess: CustomerAccess | undefined;
-    protected _invoices: Invoices | undefined;
-    constructor(_options: LarkClient.Options);
-    get checkout(): Checkout;
-    get customerPortal(): CustomerPortal;
-    get rateCards(): RateCards;
-    get usageEvents(): UsageEvents;
-    get subscriptions(): Subscriptions;
-    get subjects(): Subjects;
-    get pricingMetrics(): PricingMetrics;
-    get customerAccess(): CustomerAccess;
-    get invoices(): Invoices;
-}

package/dist/cjs/Client.js

@@ -1,99 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LarkClient = void 0;
-const core = __importStar(require("./core/index.js"));
-const headers_js_1 = require("./core/headers.js");
-const Client_js_1 = require("./api/resources/checkout/client/Client.js");
-const Client_js_2 = require("./api/resources/customerPortal/client/Client.js");
-const Client_js_3 = require("./api/resources/rateCards/client/Client.js");
-const Client_js_4 = require("./api/resources/usageEvents/client/Client.js");
-const Client_js_5 = require("./api/resources/subscriptions/client/Client.js");
-const Client_js_6 = require("./api/resources/subjects/client/Client.js");
-const Client_js_7 = require("./api/resources/pricingMetrics/client/Client.js");
-const Client_js_8 = require("./api/resources/customerAccess/client/Client.js");
-const Client_js_9 = require("./api/resources/invoices/client/Client.js");
-class LarkClient {
-    constructor(_options) {
-        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
-                "X-Fern-Language": "JavaScript",
-                "X-Fern-SDK-Name": "lark-billing",
-                "X-Fern-SDK-Version": "0.1.4",
-                "User-Agent": "lark-billing/0.1.4",
-                "X-Fern-Runtime": core.RUNTIME.type,
-                "X-Fern-Runtime-Version": core.RUNTIME.version,
-            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
-    }
-    get checkout() {
-        var _a;
-        return ((_a = this._checkout) !== null && _a !== void 0 ? _a : (this._checkout = new Client_js_1.Checkout(this._options)));
-    }
-    get customerPortal() {
-        var _a;
-        return ((_a = this._customerPortal) !== null && _a !== void 0 ? _a : (this._customerPortal = new Client_js_2.CustomerPortal(this._options)));
-    }
-    get rateCards() {
-        var _a;
-        return ((_a = this._rateCards) !== null && _a !== void 0 ? _a : (this._rateCards = new Client_js_3.RateCards(this._options)));
-    }
-    get usageEvents() {
-        var _a;
-        return ((_a = this._usageEvents) !== null && _a !== void 0 ? _a : (this._usageEvents = new Client_js_4.UsageEvents(this._options)));
-    }
-    get subscriptions() {
-        var _a;
-        return ((_a = this._subscriptions) !== null && _a !== void 0 ? _a : (this._subscriptions = new Client_js_5.Subscriptions(this._options)));
-    }
-    get subjects() {
-        var _a;
-        return ((_a = this._subjects) !== null && _a !== void 0 ? _a : (this._subjects = new Client_js_6.Subjects(this._options)));
-    }
-    get pricingMetrics() {
-        var _a;
-        return ((_a = this._pricingMetrics) !== null && _a !== void 0 ? _a : (this._pricingMetrics = new Client_js_7.PricingMetrics(this._options)));
-    }
-    get customerAccess() {
-        var _a;
-        return ((_a = this._customerAccess) !== null && _a !== void 0 ? _a : (this._customerAccess = new Client_js_8.CustomerAccess(this._options)));
-    }
-    get invoices() {
-        var _a;
-        return ((_a = this._invoices) !== null && _a !== void 0 ? _a : (this._invoices = new Client_js_9.Invoices(this._options)));
-    }
-}
-exports.LarkClient = LarkClient;