lark-billing 0.6.0 → 0.8.0

package/src/resources/rate-catalogs.ts

@@ -0,0 +1,521 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as RateCatalogsAPI from './rate-catalogs';
+import * as InvoicesAPI from './invoices';
+import * as RateCardsAPI from './rate-cards';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class RateCatalogs extends APIResource {
+  /**
+   * Create Rate Catalog
+   *
+   * @example
+   * ```ts
+   * const rateCatalog = await client.rateCatalogs.create({
+   *   description: 'My Catalog Description',
+   *   name: 'My Catalog',
+   * });
+   * ```
+   */
+  create(body: RateCatalogCreateParams, options?: RequestOptions): APIPromise<RateCatalogCreateResponse> {
+    return this._client.post('/rate-catalogs', { body, ...options });
+  }
+
+  /**
+   * Get Rate Catalog
+   *
+   * @example
+   * ```ts
+   * const rateCatalog = await client.rateCatalogs.retrieve(
+   *   'rate_catalog_id',
+   * );
+   * ```
+   */
+  retrieve(rateCatalogID: string, options?: RequestOptions): APIPromise<RateCatalogRetrieveResponse> {
+    return this._client.get(path`/rate-catalogs/${rateCatalogID}`, options);
+  }
+
+  /**
+   * List Rate Catalogs
+   *
+   * @example
+   * ```ts
+   * const rateCatalogs = await client.rateCatalogs.list();
+   * ```
+   */
+  list(
+    query: RateCatalogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RateCatalogListResponse> {
+    return this._client.get('/rate-catalogs', { query, ...options });
+  }
+
+  /**
+   * Add Rates To Rate Catalog
+   *
+   * @example
+   * ```ts
+   * const response = await client.rateCatalogs.addRates(
+   *   'rate_catalog_id',
+   *   { billing_interval: 'monthly' },
+   * );
+   * ```
+   */
+  addRates(
+    rateCatalogID: string,
+    body: RateCatalogAddRatesParams,
+    options?: RequestOptions,
+  ): APIPromise<RateCatalogAddRatesResponse> {
+    return this._client.post(path`/rate-catalogs/${rateCatalogID}/add_rates`, { body, ...options });
+  }
+
+  /**
+   * List Rates In Catalog
+   *
+   * @example
+   * ```ts
+   * const response = await client.rateCatalogs.listRates(
+   *   'rate_catalog_id',
+   * );
+   * ```
+   */
+  listRates(
+    rateCatalogID: string,
+    query: RateCatalogListRatesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RateCatalogListRatesResponse> {
+    return this._client.get(path`/rate-catalogs/${rateCatalogID}/rates`, { query, ...options });
+  }
+}
+
+export interface AmountTypedDict {
+  currency_code: string;
+
+  value: string;
+}
+
+export interface FlatPriceTypedDict {
+  amount: AmountTypedDict;
+
+  price_type: 'flat';
+}
+
+export interface PackagePriceTypedDict {
+  amount: AmountTypedDict;
+
+  package_units: number;
+
+  price_type: 'package';
+
+  rounding_behavior: 'round_up' | 'round_down';
+}
+
+export interface RateCatalogCreateResponse {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  rate_count: number;
+}
+
+export interface RateCatalogRetrieveResponse {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  rate_count: number;
+}
+
+export interface RateCatalogListResponse {
+  has_more: boolean;
+
+  rate_catalogs: Array<RateCatalogListResponse.RateCatalog>;
+}
+
+export namespace RateCatalogListResponse {
+  export interface RateCatalog {
+    id: string;
+
+    description: string;
+
+    name: string;
+
+    rate_count: number;
+  }
+}
+
+export interface RateCatalogAddRatesResponse {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  rate_count: number;
+}
+
+export interface RateCatalogListRatesResponse {
+  has_more: boolean;
+
+  rates: Array<RateCatalogListRatesResponse.Rate>;
+}
+
+export namespace RateCatalogListRatesResponse {
+  export interface Rate {
+    id: string;
+
+    interval: 'monthly' | 'yearly';
+
+    rate_catalog_id: string;
+
+    type: 'fixed' | 'usage_based';
+
+    fixed?: Rate.Fixed | null;
+
+    usage_based?: Rate.SimpleUsageBasedRateTypedDict | Rate.DimensionalUsageBasedRateTypedDict | null;
+  }
+
+  export namespace Rate {
+    export interface Fixed {
+      id: string;
+
+      code: string | null;
+
+      credit_grants: Array<Fixed.CreditGrant>;
+
+      description: string | null;
+
+      name: string;
+
+      price: RateCatalogsAPI.FlatPriceTypedDict | RateCatalogsAPI.PackagePriceTypedDict;
+
+      quantity_code: string | null;
+    }
+
+    export namespace Fixed {
+      export interface CreditGrant {
+        amount: InvoicesAPI.AmountOutput;
+
+        expiration:
+          | CreditGrant.CreditGrantDurationExpirationModel
+          | CreditGrant.CreditGrantDateTimeExpirationModel
+          | null;
+
+        metadata: { [key: string]: string };
+
+        name: string;
+
+        schedule:
+          | CreditGrant.CreditGrantScheduleOneTimeModel
+          | CreditGrant.CreditGrantScheduleRateCycleStartModel
+          | null;
+
+        subject_granting_config: CreditGrant.SubjectGrantingConfig | null;
+      }
+
+      export namespace CreditGrant {
+        export interface CreditGrantDurationExpirationModel {
+          duration: number;
+
+          unit: 'hours' | 'days' | 'weeks' | 'months' | 'years';
+
+          expiration_type?: 'duration';
+        }
+
+        export interface CreditGrantDateTimeExpirationModel {
+          date: string;
+
+          expiration_type?: 'date';
+        }
+
+        export interface CreditGrantScheduleOneTimeModel {
+          scheduled_at: string;
+
+          schedule_type?: 'one_time';
+        }
+
+        export interface CreditGrantScheduleRateCycleStartModel {
+          rate_cycle_start_at: string;
+
+          schedule_type?: 'rate_cycle_start';
+        }
+
+        export interface SubjectGrantingConfig {
+          apply_to_children: boolean;
+
+          apply_to_self: boolean;
+        }
+      }
+    }
+
+    export interface SimpleUsageBasedRateTypedDict {
+      id: string;
+
+      code: string;
+
+      description: string | null;
+
+      included_units: number;
+
+      name: string;
+
+      price: RateCatalogsAPI.FlatPriceTypedDict | RateCatalogsAPI.PackagePriceTypedDict;
+
+      pricing_metric_id: string;
+
+      usage_based_rate_type: 'simple';
+    }
+
+    export interface DimensionalUsageBasedRateTypedDict {
+      id: string;
+
+      code: string;
+
+      description: string | null;
+
+      dimensions: Array<DimensionalUsageBasedRateTypedDict.Dimension>;
+
+      included_units: number;
+
+      name: string;
+
+      pricing_matrix: DimensionalUsageBasedRateTypedDict.PricingMatrix;
+
+      pricing_metric_id: string;
+
+      usage_based_rate_type: 'dimensional';
+    }
+
+    export namespace DimensionalUsageBasedRateTypedDict {
+      export interface Dimension {
+        description: string | null;
+
+        key: string;
+
+        values: Array<string>;
+      }
+
+      export interface PricingMatrix {
+        cells: Array<PricingMatrix.Cell>;
+      }
+
+      export namespace PricingMatrix {
+        export interface Cell {
+          dimension_coordinates: { [key: string]: string };
+
+          price: RateCatalogsAPI.FlatPriceTypedDict | RateCatalogsAPI.PackagePriceTypedDict;
+        }
+      }
+    }
+  }
+}
+
+export interface RateCatalogCreateParams {
+  /**
+   * The description of the catalog.
+   */
+  description: string;
+
+  /**
+   * The name of the catalog.
+   */
+  name: string;
+}
+
+export interface RateCatalogListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export interface RateCatalogAddRatesParams {
+  /**
+   * How often the customer will be billed for these rates.
+   */
+  billing_interval: 'monthly' | 'yearly';
+
+  /**
+   * The fixed rate to create in the catalog.
+   */
+  fixed_rates?: Array<RateCatalogAddRatesParams.FixedRate>;
+
+  /**
+   * The usage based rates to create in the catalog.
+   */
+  usage_based_rates?: Array<
+    | RateCatalogAddRatesParams.CreateSimpleUsageBasedRateRequest
+    | RateCatalogAddRatesParams.CreateDimensionalUsageBasedRateRequest
+  >;
+}
+
+export namespace RateCatalogAddRatesParams {
+  export interface FixedRate {
+    /**
+     * Code of this rate to be used for setting quantity and price multipliers. This
+     * code must be unique within the rate card.
+     */
+    code: string;
+
+    /**
+     * 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 CreateSimpleUsageBasedRateRequest {
+    /**
+     * Code of this rate to be used for price multipliers. This code must be unique
+     * within the rate card.
+     */
+    code: string;
+
+    /**
+     * 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 CreateDimensionalUsageBasedRateRequest {
+    /**
+     * Code of this rate to be used for price multipliers. This code must be unique
+     * within the rate card.
+     */
+    code: string;
+
+    /**
+     * The dimensions of the rate.
+     */
+    dimensions: Array<CreateDimensionalUsageBasedRateRequest.Dimension>;
+
+    /**
+     * The name of the rate displayed to the customer.
+     */
+    name: string;
+
+    /**
+     * The pricing matrix of the rate.
+     */
+    pricing_matrix: CreateDimensionalUsageBasedRateRequest.PricingMatrix;
+
+    /**
+     * The ID of the pricing metric to use for this rate.
+     */
+    pricing_metric_id: string;
+
+    usage_based_rate_type: 'dimensional';
+
+    /**
+     * 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 namespace CreateDimensionalUsageBasedRateRequest {
+    export interface Dimension {
+      /**
+       * The name of the dimension. This is used to identify the dimension in the pricing
+       * matrix.
+       */
+      key: string;
+
+      /**
+       * A list of possible values for the dimension.
+       */
+      values: Array<string>;
+
+      /**
+       * The description of the dimension.
+       */
+      description?: string | null;
+    }
+
+    /**
+     * The pricing matrix of the rate.
+     */
+    export interface PricingMatrix {
+      cells: Array<PricingMatrix.Cell>;
+    }
+
+    export namespace PricingMatrix {
+      export interface Cell {
+        /**
+         * A key-value mapping of dimension keys and values to identify the price for a
+         * given set of dimension values.
+         */
+        dimension_coordinates: { [key: string]: string };
+
+        /**
+         * The price for the cell.
+         */
+        price: RateCardsAPI.FlatPriceInput | RateCardsAPI.PackagePriceInput;
+      }
+    }
+  }
+}
+
+export interface RateCatalogListRatesParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export declare namespace RateCatalogs {
+  export {
+    type AmountTypedDict as AmountTypedDict,
+    type FlatPriceTypedDict as FlatPriceTypedDict,
+    type PackagePriceTypedDict as PackagePriceTypedDict,
+    type RateCatalogCreateResponse as RateCatalogCreateResponse,
+    type RateCatalogRetrieveResponse as RateCatalogRetrieveResponse,
+    type RateCatalogListResponse as RateCatalogListResponse,
+    type RateCatalogAddRatesResponse as RateCatalogAddRatesResponse,
+    type RateCatalogListRatesResponse as RateCatalogListRatesResponse,
+    type RateCatalogCreateParams as RateCatalogCreateParams,
+    type RateCatalogListParams as RateCatalogListParams,
+    type RateCatalogAddRatesParams as RateCatalogAddRatesParams,
+    type RateCatalogListRatesParams as RateCatalogListRatesParams,
+  };
+}

package/src/resources/subscription-timelines/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Items,
+  type ItemCreateResponse,
+  type ItemListResponse,
+  type ItemCreateParams,
+  type ItemListParams,
+} from './items';
+export {
+  SubscriptionTimelines,
+  type SubscriptionTimelineCreateResponse,
+  type SubscriptionTimelineRetrieveResponse,
+  type SubscriptionTimelineListResponse,
+  type SubscriptionTimelineStartResponse,
+  type SubscriptionTimelineCreateParams,
+  type SubscriptionTimelineListParams,
+  type SubscriptionTimelineStartParams,
+} from './subscription-timelines';

package/src/resources/subscription-timelines/items.ts

@@ -0,0 +1,187 @@
+// 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 Items extends APIResource {
+  /**
+   * Create Subscription Timeline Items
+   */
+  create(
+    subscriptionTimelineID: string,
+    body: ItemCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemCreateResponse> {
+    return this._client.post(path`/subscription-timelines/${subscriptionTimelineID}/items`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List Subscription Timeline Items
+   */
+  list(
+    subscriptionTimelineID: string,
+    query: ItemListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ItemListResponse> {
+    return this._client.get(path`/subscription-timelines/${subscriptionTimelineID}/items`, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type ItemCreateResponse = Array<ItemCreateResponse.ItemCreateResponseItem>;
+
+export namespace ItemCreateResponse {
+  export interface ItemCreateResponseItem {
+    id: string;
+
+    created_at: string;
+
+    period: ItemCreateResponseItem.Period;
+
+    subscription_input: ItemCreateResponseItem.SubscriptionInput;
+
+    subscription_timeline_id: string;
+
+    updated_at: string;
+  }
+
+  export namespace ItemCreateResponseItem {
+    export interface Period {
+      end: string | null;
+
+      start: string;
+
+      inclusive_end?: boolean;
+
+      inclusive_start?: boolean;
+    }
+
+    export interface SubscriptionInput {
+      fixed_rate_quantities: { [key: string]: string };
+
+      rate_card_id: string;
+
+      rate_price_multipliers: { [key: string]: string };
+    }
+  }
+}
+
+export interface ItemListResponse {
+  has_more: boolean;
+
+  items: Array<ItemListResponse.Item>;
+}
+
+export namespace ItemListResponse {
+  export interface Item {
+    id: string;
+
+    created_at: string;
+
+    period: Item.Period;
+
+    subscription_input: Item.SubscriptionInput;
+
+    subscription_timeline_id: string;
+
+    updated_at: string;
+  }
+
+  export namespace Item {
+    export interface Period {
+      end: string | null;
+
+      start: string;
+
+      inclusive_end?: boolean;
+
+      inclusive_start?: boolean;
+    }
+
+    export interface SubscriptionInput {
+      fixed_rate_quantities: { [key: string]: string };
+
+      rate_card_id: string;
+
+      rate_price_multipliers: { [key: string]: string };
+    }
+  }
+}
+
+export interface ItemCreateParams {
+  /**
+   * The items to create for the subscription timeline.
+   */
+  items: Array<ItemCreateParams.Item>;
+}
+
+export namespace ItemCreateParams {
+  export interface Item {
+    /**
+     * The period of the subscription timeline item.
+     */
+    period: Item.Period;
+
+    /**
+     * The subscription input for the subscription timeline item.
+     */
+    subscription_input: Item.SubscriptionInput;
+  }
+
+  export namespace Item {
+    /**
+     * The period of the subscription timeline item.
+     */
+    export interface Period {
+      end: string | null;
+
+      start: string;
+
+      inclusive_end?: boolean;
+
+      inclusive_start?: boolean;
+    }
+
+    /**
+     * The subscription input for the subscription timeline item.
+     */
+    export interface SubscriptionInput {
+      /**
+       * The quantities of the fixed rates to use for the subscription timeline item.
+       */
+      fixed_rate_quantities: { [key: string]: number | string };
+
+      /**
+       * The ID of the rate card to use for the subscription timeline item.
+       */
+      rate_card_id: string;
+
+      /**
+       * The price multipliers to use for the subscription timeline item.
+       */
+      rate_price_multipliers: { [key: string]: number | string };
+    }
+  }
+}
+
+export interface ItemListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export declare namespace Items {
+  export {
+    type ItemCreateResponse as ItemCreateResponse,
+    type ItemListResponse as ItemListResponse,
+    type ItemCreateParams as ItemCreateParams,
+    type ItemListParams as ItemListParams,
+  };
+}