lark-billing 0.7.0 → 0.8.0

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

@@ -0,0 +1,240 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as SubscriptionsAPI from '../subscriptions';
+import * as ItemsAPI from './items';
+import { ItemCreateParams, ItemCreateResponse, ItemListParams, ItemListResponse, Items } from './items';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class SubscriptionTimelines extends APIResource {
+  items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
+
+  /**
+   * Create Subscription Timeline
+   */
+  create(
+    body: SubscriptionTimelineCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionTimelineCreateResponse> {
+    return this._client.post('/subscription-timelines', { body, ...options });
+  }
+
+  /**
+   * Get Subscription Timeline
+   */
+  retrieve(
+    subscriptionTimelineID: string,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionTimelineRetrieveResponse> {
+    return this._client.get(path`/subscription-timelines/${subscriptionTimelineID}`, options);
+  }
+
+  /**
+   * List Subscription Timelines
+   */
+  list(
+    query: SubscriptionTimelineListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionTimelineListResponse> {
+    return this._client.get('/subscription-timelines', { query, ...options });
+  }
+
+  /**
+   * Start Subscription Timeline
+   */
+  start(
+    subscriptionTimelineID: string,
+    body: SubscriptionTimelineStartParams,
+    options?: RequestOptions,
+  ): APIPromise<SubscriptionTimelineStartResponse> {
+    return this._client.post(path`/subscription-timelines/${subscriptionTimelineID}/start`, {
+      body,
+      ...options,
+    });
+  }
+}
+
+export interface SubscriptionTimelineCreateResponse {
+  id: string;
+
+  created_at: string;
+
+  rate_card_id: string;
+
+  status: 'draft' | 'pending' | 'active' | 'completed';
+
+  subject_id: string;
+
+  subscription_id: string | null;
+
+  updated_at: string;
+}
+
+export interface SubscriptionTimelineRetrieveResponse {
+  id: string;
+
+  created_at: string;
+
+  rate_card_id: string;
+
+  status: 'draft' | 'pending' | 'active' | 'completed';
+
+  subject_id: string;
+
+  subscription_id: string | null;
+
+  updated_at: string;
+}
+
+export interface SubscriptionTimelineListResponse {
+  has_more: boolean;
+
+  subscription_timelines: Array<SubscriptionTimelineListResponse.SubscriptionTimeline>;
+}
+
+export namespace SubscriptionTimelineListResponse {
+  export interface SubscriptionTimeline {
+    id: string;
+
+    created_at: string;
+
+    rate_card_id: string;
+
+    status: 'draft' | 'pending' | 'active' | 'completed';
+
+    subject_id: string;
+
+    subscription_id: string | null;
+
+    updated_at: string;
+  }
+}
+
+export interface SubscriptionTimelineStartResponse {
+  /**
+   * The result of the request. If the request is successful, the subscription
+   * timeline resource will be returned. If the request is requires action, the
+   * action to take to complete the request will be returned.
+   */
+  result:
+    | SubscriptionTimelineStartResponse.StartSubscriptionTimelineRequiresActionResponse
+    | SubscriptionTimelineStartResponse.StartSubscriptionTimelineSuccessResponse;
+}
+
+export namespace SubscriptionTimelineStartResponse {
+  export interface StartSubscriptionTimelineRequiresActionResponse {
+    /**
+     * The action to take to complete the request.
+     */
+    action: StartSubscriptionTimelineRequiresActionResponse.Action;
+
+    result_type: 'requires_action';
+  }
+
+  export namespace StartSubscriptionTimelineRequiresActionResponse {
+    /**
+     * 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 StartSubscriptionTimelineSuccessResponse {
+    result_type: 'success';
+
+    /**
+     * The subscription timeline resource.
+     */
+    subscription_timeline: StartSubscriptionTimelineSuccessResponse.SubscriptionTimeline;
+  }
+
+  export namespace StartSubscriptionTimelineSuccessResponse {
+    /**
+     * The subscription timeline resource.
+     */
+    export interface SubscriptionTimeline {
+      id: string;
+
+      created_at: string;
+
+      rate_card_id: string;
+
+      status: 'draft' | 'pending' | 'active' | 'completed';
+
+      subject_id: string;
+
+      subscription_id: string | null;
+
+      updated_at: string;
+    }
+  }
+}
+
+export interface SubscriptionTimelineCreateParams {
+  /**
+   * The ID of the rate card to create the subscription timeline for.
+   */
+  rate_card_id: string;
+
+  /**
+   * The ID of the subject to create the subscription timeline for.
+   */
+  subject_id: string;
+}
+
+export interface SubscriptionTimelineListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export interface SubscriptionTimelineStartParams {
+  /**
+   * The URLs to redirect to after the checkout is completed or cancelled, if a
+   * checkout is required.
+   */
+  checkout_callback_urls: SubscriptionsAPI.CheckoutCallback;
+
+  /**
+   * 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, the subscription will be created and billed for immediately.
+   */
+  create_checkout_session: 'when_required' | 'always';
+
+  /**
+   * When the subscription should become active. If not provided, the current date
+   * and time will be used.
+   */
+  effective_at?: string;
+}
+
+SubscriptionTimelines.Items = Items;
+
+export declare namespace SubscriptionTimelines {
+  export {
+    type SubscriptionTimelineCreateResponse as SubscriptionTimelineCreateResponse,
+    type SubscriptionTimelineRetrieveResponse as SubscriptionTimelineRetrieveResponse,
+    type SubscriptionTimelineListResponse as SubscriptionTimelineListResponse,
+    type SubscriptionTimelineStartResponse as SubscriptionTimelineStartResponse,
+    type SubscriptionTimelineCreateParams as SubscriptionTimelineCreateParams,
+    type SubscriptionTimelineListParams as SubscriptionTimelineListParams,
+    type SubscriptionTimelineStartParams as SubscriptionTimelineStartParams,
+  };
+
+  export {
+    Items as Items,
+    type ItemCreateResponse as ItemCreateResponse,
+    type ItemListResponse as ItemListResponse,
+    type ItemCreateParams as ItemCreateParams,
+    type ItemListParams as ItemListParams,
+  };
+}

package/src/resources/subscription-timelines.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './subscription-timelines/index';

package/src/resources/subscriptions.ts

@@ -328,6 +328,11 @@ export interface SubscriptionCreateParams {
    * per seat.
    */
   rate_price_multipliers?: { [key: string]: number | string };
+
+  /**
+   * The ID of the subscription timeline to use for the subscription.
+   */
+  subscription_timeline_id?: string | null;
 }
 
 export interface SubscriptionListParams {

package/src/resources/usage-events.ts

@@ -17,9 +17,9 @@ export class UsageEvents extends APIResource {
    *     region: 'us-east-1',
    *   },
    *   event_name: 'job_completed',
-   *   idempotency_key: '5ee29f5a-ff4d-4265-8029-bf29e465f5dc',
+   *   idempotency_key: 'baf940b3-330f-4fc5-8f58-91a8e6c35acd',
    *   subject_id: 'subj_VyX6Q96h5avMho8O7QWlKeXE',
-   *   timestamp: '2026-01-13T22:50:12.390246+00:00',
+   *   timestamp: '2026-01-16T22:48:04.214059+00:00',
    * });
    * ```
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.7.0'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.js

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

package/version.mjs

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