lark-billing 0.1.4 → 0.2.0

package/src/resources/rate-cards.ts

@@ -0,0 +1,274 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as RateCardsAPI from './rate-cards';
+import * as InvoicesAPI from './invoices';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class RateCards extends APIResource {
+  /**
+   * Create Rate Card
+   */
+  create(body: RateCardCreateParams, options?: RequestOptions): APIPromise<RateCardResource> {
+    return this._client.post('/rate-cards', { body, ...options });
+  }
+
+  /**
+   * Get Rate Card
+   */
+  retrieve(rateCardID: string, options?: RequestOptions): APIPromise<RateCardResource> {
+    return this._client.get(path`/rate-cards/${rateCardID}`, options);
+  }
+
+  /**
+   * List Rate Cards
+   */
+  list(
+    query: RateCardListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RateCardListResponse> {
+    return this._client.get('/rate-cards', { query, ...options });
+  }
+}
+
+export interface AmountInput {
+  /**
+   * The currency code of the amount.
+   */
+  currency_code: string;
+
+  /**
+   * The value of the amount in the smallest unit of the currency.
+   */
+  value: number | string;
+}
+
+/**
+ * Flat price is a price that linearly scales with the quantity.
+ */
+export interface FlatPriceInput {
+  amount: AmountInput;
+
+  price_type?: 'flat';
+}
+
+/**
+ * Flat price is a price that linearly scales with the quantity.
+ */
+export interface FlatPriceOutput {
+  amount: InvoicesAPI.AmountOutput;
+
+  price_type?: 'flat';
+}
+
+/**
+ * Package price is a price that is charged for a fixed number of units. For
+ * example, $10 per 1000 units. If the quantity is not a multiple of the package
+ * units, the rounding behavior will be applied.
+ */
+export interface PackagePriceInput {
+  amount: AmountInput;
+
+  package_units: number;
+
+  rounding_behavior: 'round_up' | 'round_down';
+
+  price_type?: 'package';
+}
+
+/**
+ * Package price is a price that is charged for a fixed number of units. For
+ * example, $10 per 1000 units. If the quantity is not a multiple of the package
+ * units, the rounding behavior will be applied.
+ */
+export interface PackagePriceOutput {
+  amount: InvoicesAPI.AmountOutput;
+
+  package_units: number;
+
+  rounding_behavior: 'round_up' | 'round_down';
+
+  price_type?: 'package';
+}
+
+export interface RateCardResource {
+  /**
+   * The ID of the rate card.
+   */
+  id: string;
+
+  billing_interval: 'monthly' | 'yearly';
+
+  /**
+   * The date and time the rate card was created.
+   */
+  created_at: string;
+
+  /**
+   * The fixed rates of the rate card.
+   */
+  fixed_rates: Array<RateCardResource.FixedRate>;
+
+  metadata: { [key: string]: string };
+
+  /**
+   * The name of the rate card.
+   */
+  name: string;
+
+  /**
+   * The date and time the rate card was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * The usage based rates of the rate card.
+   */
+  usage_based_rates: Array<RateCardResource.UsageBasedRate>;
+
+  /**
+   * The description of the rate card.
+   */
+  description?: string | null;
+}
+
+export namespace RateCardResource {
+  export interface FixedRate {
+    id: string;
+
+    description: string | null;
+
+    name: string;
+
+    /**
+     * Flat price is a price that linearly scales with the quantity.
+     */
+    price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
+  }
+
+  export interface UsageBasedRate {
+    id: string;
+
+    description: string | null;
+
+    included_units: number;
+
+    name: string;
+
+    /**
+     * Flat price is a price that linearly scales with the quantity.
+     */
+    price: RateCardsAPI.FlatPriceOutput | RateCardsAPI.PackagePriceOutput;
+
+    pricing_metric_id: string;
+
+    usage_based_rate_type?: 'simple';
+  }
+}
+
+export interface RateCardListResponse {
+  has_more: boolean;
+
+  rate_cards: Array<RateCardResource>;
+}
+
+export interface RateCardCreateParams {
+  /**
+   * How often the customer will be billed for this rate card.
+   */
+  billing_interval: 'monthly' | 'yearly';
+
+  /**
+   * The name of the rate card displayed to the customer.
+   */
+  name: string;
+
+  /**
+   * The description of the rate card displayed to the customer.
+   */
+  description?: string | null;
+
+  /**
+   * The fixed rates of the rate card. These are billed at the start of each billing
+   * cycle.
+   */
+  fixed_rates?: Array<RateCardCreateParams.FixedRate>;
+
+  metadata?: { [key: string]: string };
+
+  /**
+   * The usage based rates of the rate card. These are billed at the end of each
+   * billing cycle.
+   */
+  usage_based_rates?: Array<RateCardCreateParams.UsageBasedRate>;
+}
+
+export namespace RateCardCreateParams {
+  export interface FixedRate {
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * Flat price is a price that linearly scales with the quantity.
+     */
+    price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+
+    /**
+     * The description of the rate displayed to the customer.
+     */
+    description?: string | null;
+  }
+
+  export interface UsageBasedRate {
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * Flat price is a price that linearly scales with the quantity.
+     */
+    price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+
+    /**
+     * The ID of the pricing metric to use for this rate.
+     */
+    pricing_metric_id: string;
+
+    usage_based_rate_type: 'simple';
+
+    /**
+     * The description of the rate displayed to the customer.
+     */
+    description?: string | null;
+
+    /**
+     * The number of units included in the rate before the price is applied.
+     */
+    included_units?: number;
+  }
+}
+
+export interface RateCardListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export declare namespace RateCards {
+  export {
+    type AmountInput as AmountInput,
+    type FlatPriceInput as FlatPriceInput,
+    type FlatPriceOutput as FlatPriceOutput,
+    type PackagePriceInput as PackagePriceInput,
+    type PackagePriceOutput as PackagePriceOutput,
+    type RateCardResource as RateCardResource,
+    type RateCardListResponse as RateCardListResponse,
+    type RateCardCreateParams as RateCardCreateParams,
+    type RateCardListParams as RateCardListParams,
+  };
+}

package/src/resources/subjects.ts

@@ -0,0 +1,220 @@
+// 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';
+import { path } from '../internal/utils/path';
+
+export class Subjects extends APIResource {
+  /**
+   * Create Subject
+   *
+   * @example
+   * ```ts
+   * const subject = await client.subjects.create();
+   * ```
+   */
+  create(body: SubjectCreateParams, options?: RequestOptions): APIPromise<SubjectCreateResponse> {
+    return this._client.post('/subjects', { body, ...options });
+  }
+
+  /**
+   * Get Subject
+   *
+   * @example
+   * ```ts
+   * const subjectResource = await client.subjects.retrieve(
+   *   'subject_id',
+   * );
+   * ```
+   */
+  retrieve(subjectID: string, options?: RequestOptions): APIPromise<SubjectResource> {
+    return this._client.get(path`/subjects/${subjectID}`, options);
+  }
+
+  /**
+   * Update Subject
+   *
+   * @example
+   * ```ts
+   * const subjectResource = await client.subjects.update(
+   *   'subject_id',
+   *   {
+   *     email: 'john.doe@example.com',
+   *     metadata: { foo: 'string' },
+   *     name: 'John Doe',
+   *   },
+   * );
+   * ```
+   */
+  update(
+    subjectID: string,
+    body: SubjectUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<SubjectResource> {
+    return this._client.put(path`/subjects/${subjectID}`, { body, ...options });
+  }
+
+  /**
+   * List Subjects
+   *
+   * @example
+   * ```ts
+   * const subjects = await client.subjects.list();
+   * ```
+   */
+  list(
+    query: SubjectListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubjectListResponse> {
+    return this._client.get('/subjects', { query, ...options });
+  }
+
+  /**
+   * Delete Subject
+   *
+   * @example
+   * ```ts
+   * const subject = await client.subjects.delete('subject_id');
+   * ```
+   */
+  delete(subjectID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/subjects/${subjectID}`, options);
+  }
+}
+
+export interface SubjectResource {
+  /**
+   * The ID of the subject.
+   */
+  id: string;
+
+  /**
+   * The date and time the subject was created.
+   */
+  created_at: string;
+
+  /**
+   * The email of the subject.
+   */
+  email: string | null;
+
+  /**
+   * The ID of the subject in your system. You may pass it to the API in place of the
+   * subject ID.
+   */
+  external_id: string | null;
+
+  /**
+   * Additional metadata about the subject. You may use this to store any custom data
+   * about the subject.
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * The name of the subject. Used for display in the dashboard.
+   */
+  name: string | null;
+}
+
+export interface SubjectCreateResponse {
+  /**
+   * The ID of the subject.
+   */
+  id: string;
+
+  /**
+   * The date and time the subject was created.
+   */
+  created_at: string;
+
+  /**
+   * The email of the subject.
+   */
+  email: string | null;
+
+  /**
+   * The ID of the subject in your system. You may pass it to the API in place of the
+   * subject ID.
+   */
+  external_id: string | null;
+
+  /**
+   * Additional metadata about the subject. You may use this to store any custom data
+   * about the subject.
+   */
+  metadata: { [key: string]: string };
+
+  /**
+   * The name of the subject. Used for display in the dashboard.
+   */
+  name: string | null;
+}
+
+export interface SubjectListResponse {
+  has_more: boolean;
+
+  subjects: Array<SubjectResource>;
+}
+
+export type SubjectDeleteResponse = unknown;
+
+export interface SubjectCreateParams {
+  /**
+   * The email of the subject. Must be a valid email address.
+   */
+  email?: string | null;
+
+  /**
+   * The ID of the subject in your system. If provided, you may use pass it to the
+   * API in place of the subject ID. Must be unique.
+   */
+  external_id?: string | null;
+
+  /**
+   * Additional metadata about the subject. You may use this to store any custom data
+   * about the subject.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * The name of the subject. Used for display in the dashboard.
+   */
+  name?: string | null;
+}
+
+export interface SubjectUpdateParams {
+  /**
+   * The email of the subject. Must be a valid email address.
+   */
+  email: string | null;
+
+  /**
+   * Additional metadata about the subject. You may use this to store any custom data
+   * about the subject.
+   */
+  metadata: { [key: string]: string } | null;
+
+  /**
+   * The name of the subject. Used for display in the dashboard.
+   */
+  name: string | null;
+}
+
+export interface SubjectListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export declare namespace Subjects {
+  export {
+    type SubjectResource as SubjectResource,
+    type SubjectCreateResponse as SubjectCreateResponse,
+    type SubjectListResponse as SubjectListResponse,
+    type SubjectDeleteResponse as SubjectDeleteResponse,
+    type SubjectCreateParams as SubjectCreateParams,
+    type SubjectUpdateParams as SubjectUpdateParams,
+    type SubjectListParams as SubjectListParams,
+  };
+}