chargebee 3.12.0-beta.1 → 3.13.0

package/types/resources/SalesOrder.d.ts

@@ -0,0 +1,143 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface SalesOrder {
+    id: string;
+    version: number;
+    renewed_from_order_id?: string;
+    updated_at?: number;
+    created_at: number;
+    po_number?: string;
+    meta_data?: string;
+    quote_id?: string;
+    effective_date: number;
+    end_date?: number;
+    business_entity_id?: string;
+    customer_id: string;
+    currency_code: string;
+    line_items?: SalesOrder.LineItem[];
+    billing_addresses?: SalesOrder.BillingAddress[];
+    discounts?: SalesOrder.Discount[];
+    shipping_addresses?: SalesOrder.ShippingAddress[];
+    subscription_ids?: string[];
+    line_item_tiers?: SalesOrder.LineItemTier[];
+    payment_configuration?: SalesOrder.PaymentConfiguration;
+    billing_configuration?: SalesOrder.BillingConfiguration;
+    renewal_term?: SalesOrder.RenewalTerm;
+    status: 'active' | 'completed';
+  }
+
+  export namespace SalesOrder {
+    export interface LineItem {
+      id: string;
+      association_id?: string;
+      item_price_id: string;
+      name?: string;
+      quantity: string;
+      unit_price: string;
+      billing_period?: number;
+      billing_period_unit?: 'day' | 'week' | 'month' | 'year';
+      service_period_days?: number;
+      charge_on_event?:
+        | 'subscription_creation'
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
+      charge_once?: boolean;
+      billing_cycles?: number;
+      billing_type: 'recurring' | 'one_time' | 'event_based';
+      start_date: number;
+      end_date?: number;
+      trial_end?: number;
+    }
+    export interface BillingAddress {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
+    export interface Discount {
+      id: string;
+      invoice_name?: string;
+      type: 'fixed_amount' | 'percentage';
+      apply_on: 'invoice_amount' | 'specific_item_price';
+      duration_type: 'one_time' | 'forever' | 'limited_period';
+      percentage?: number;
+      amount?: string;
+      coupon_id?: string;
+      period?: number;
+      period_unit?: 'day' | 'week' | 'month' | 'year';
+      item_price_id?: string;
+      start_date: number;
+      end_date?: number;
+    }
+    export interface ShippingAddress {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+      index: number;
+    }
+    export interface LineItemTier {
+      starting_unit: string;
+      ending_unit?: string;
+      price: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
+      line_item_association_id?: string;
+    }
+    export interface PaymentConfiguration {
+      auto_collection?: AutoCollectionEnum;
+      payment_source_id?: string;
+      payment_intent_id?: string;
+      offline_payment_method?: OfflinePaymentMethodEnum;
+    }
+    export interface BillingConfiguration {
+      create_pending_invoices?: boolean;
+      invoice_immediately?: boolean;
+      first_invoice_pending?: boolean;
+      invoice_usages?: boolean;
+      net_term_days?: number;
+      invoice_date?: number;
+      billing_cycles_to_invoice?: number;
+      billing_alignment_mode?: BillingAlignmentModeEnum;
+    }
+    export interface RenewalTerm {
+      end_of_term_action: 'renew' | 'cancel' | 'evergreen';
+      cancellation_cutoff_period?: number;
+      renewal_billing_cycles?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/Subscription.d.ts

@@ -689,9 +689,10 @@ declare module 'chargebee' {
     export interface Discount {
       id: string;
       invoice_name?: string;
-      type: 'fixed_amount' | 'percentage';
+      type: 'fixed_amount' | 'percentage' | 'offer_quantity';
       percentage?: number;
       amount?: number;
+      quantity?: number;
       currency_code?: string;
       duration_type: 'one_time' | 'forever' | 'limited_period';
       period?: number;
@@ -1659,6 +1660,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface CouponsCreateWithItemsInputParam {
       /**
@@ -2003,6 +2005,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
     }
@@ -2341,7 +2344,10 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan_setup'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
       description?: string;
       unit_amount?: number;
@@ -2412,6 +2418,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
     }
     export interface CouponsImportForItemsInputParam {
       /**

package/types/resources/SubscriptionEntitlementsCreatedDetail.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface SubscriptionEntitlementsCreatedDetail {
+    subscription_id?: string;
+    has_next: boolean;
+  }
+}

package/types/resources/SubscriptionEntitlementsUpdatedDetail.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface SubscriptionEntitlementsUpdatedDetail {
+    subscription_id?: string;
+    has_next: boolean;
+  }
+}

package/types/resources/UsageFile.d.ts

@@ -22,22 +22,22 @@ declare module 'chargebee' {
 
   export namespace UsageFile {
     export class UsageFileResource {
-      upload(
-        input: UploadInputParam,
+      uploadUrl(
+        input: UploadUrlInputParam,
         headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<UploadResponse>>;
+      ): Promise<ChargebeeResponse<UploadUrlResponse>>;
 
-      status(
+      processingStatus(
         usage_file_id: string,
         headers?: ChargebeeRequestHeader,
-      ): Promise<ChargebeeResponse<StatusResponse>>;
+      ): Promise<ChargebeeResponse<ProcessingStatusResponse>>;
     }
 
-    export interface UploadResponse {
+    export interface UploadUrlResponse {
       usage_file: UsageFile;
     }
 
-    export interface StatusResponse {
+    export interface ProcessingStatusResponse {
       usage_file: UsageFile;
     }
 
@@ -48,7 +48,7 @@ declare module 'chargebee' {
     // REQUEST PARAMS
     //---------------
 
-    export interface UploadInputParam {
+    export interface UploadUrlInputParam {
       file_name: string;
       mime_type: string;
     }

package/types/resources/UsageReminderInfo.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface UsageReminderInfo {
+    usage_date_start?: number;
+    usage_date_end?: number;
+  }
+}

package/types/resources/Variant.d.ts

@@ -0,0 +1,116 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Variant {
+    id?: string;
+    name: string;
+    external_name?: string;
+    description?: string;
+    sku?: string;
+    deleted: boolean;
+    product_id: string;
+    status?: 'active' | 'inactive';
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    option_values?: Variant.OptionValue[];
+    metadata?: any;
+  }
+
+  export namespace Variant {
+    export class VariantResource {
+      createProductVariant(
+        product_id: string,
+        input: CreateProductVariantInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateProductVariantResponse>>;
+
+      retrieve(
+        product_variant_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        product_variant_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        product_variant_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      listProductVariants(
+        product_id: string,
+        input?: ListProductVariantsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListProductVariantsResponse>>;
+    }
+
+    export interface CreateProductVariantResponse {
+      variant: Variant;
+    }
+
+    export interface RetrieveResponse {
+      variant: Variant;
+    }
+
+    export interface UpdateResponse {
+      variant: Variant;
+    }
+
+    export interface DeleteResponse {
+      variant: Variant;
+    }
+
+    export interface ListProductVariantsResponse {
+      list: { variant: Variant }[];
+      next_offset?: string;
+    }
+
+    export interface OptionValue {
+      name?: string;
+      value?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateProductVariantInputParam {
+      id?: string;
+      name: string;
+      external_name?: string;
+      description?: string;
+      sku?: string;
+      metadata?: any;
+      status?: 'active' | 'inactive';
+      option_values?: OptionValuesCreateProductVariantInputParam[];
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      description?: string;
+      status?: 'active' | 'inactive';
+      external_name?: string;
+      sku?: string;
+      metadata?: any;
+    }
+    export interface ListProductVariantsInputParam {
+      limit?: number;
+      offset?: string;
+      include_deleted?: boolean;
+      id?: filter.String;
+      name?: filter.String;
+      sku?: filter.String;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface OptionValuesCreateProductVariantInputParam {
+      name: string;
+      value: string;
+    }
+  }
+}

package/types/resources/WebhookEndpoint.d.ts

@@ -0,0 +1,98 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface WebhookEndpoint {
+    id: string;
+    name: string;
+    url: string;
+    send_card_resource?: boolean;
+    disabled: boolean;
+    primary_url: boolean;
+    api_version: 'v1' | 'v2';
+    chargebee_response_schema_type?: ChargebeeResponseSchemaTypeEnum;
+    enabled_events?: EventTypeEnum[];
+  }
+
+  export namespace WebhookEndpoint {
+    export class WebhookEndpointResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        webhook_endpoint_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      retrieve(
+        webhook_endpoint_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        webhook_endpoint_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      webhook_endpoint: WebhookEndpoint;
+    }
+
+    export interface UpdateResponse {
+      webhook_endpoint: WebhookEndpoint;
+    }
+
+    export interface RetrieveResponse {
+      webhook_endpoint: WebhookEndpoint;
+    }
+
+    export interface DeleteResponse {
+      webhook_endpoint: WebhookEndpoint;
+    }
+
+    export interface ListResponse {
+      list: { webhook_endpoint: WebhookEndpoint }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      name: string;
+      api_version?: 'v1' | 'v2';
+      url: string;
+      primary_url?: boolean;
+      disabled?: boolean;
+      basic_auth_password?: string;
+      basic_auth_username?: string;
+      send_card_resource?: boolean;
+      chargebee_response_schema_type?: ChargebeeResponseSchemaTypeEnum;
+      enabled_events?: EventTypeEnum[];
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      api_version?: 'v1' | 'v2';
+      url?: string;
+      primary_url?: boolean;
+      send_card_resource?: boolean;
+      basic_auth_password?: string;
+      basic_auth_username?: string;
+      disabled?: boolean;
+      enabled_events?: EventTypeEnum[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+    }
+  }
+}