chargebee 3.11.0 → 3.12.0

package/types/resources/OmnichannelOneTimeOrderItem.d.ts

@@ -0,0 +1,20 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelOneTimeOrderItem {
+    id: string;
+    item_id_at_source: string;
+    item_type_at_source?: string;
+    quantity?: number;
+    cancelled_at?: number;
+    cancellation_reason?:
+      | 'customer_cancelled'
+      | 'customer_did_not_consent_to_price_increase'
+      | 'refunded_due_to_app_issue'
+      | 'refunded_for_other_reason'
+      | 'merchant_revoked';
+    created_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts

@@ -6,7 +6,7 @@ declare module 'chargebee' {
     id?: string;
     omnichannel_subscription_item_id?: string;
     scheduled_at: number;
-    change_type: 'downgrade';
+    change_type: 'downgrade' | 'pause';
     created_at: number;
     modified_at: number;
     resource_version?: number;

package/types/resources/PricingPageSession.d.ts

@@ -106,6 +106,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       label?: string;
     }
     export interface PricingPageCreateForExistingSubscriptionInputParam {
@@ -124,6 +125,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       label?: string;
     }
   }

package/types/resources/PromotionalCredit.d.ts

@@ -15,6 +15,7 @@ declare module 'chargebee' {
     closing_balance: number;
     done_by?: string;
     created_at: number;
+    business_entity_id?: string;
   }
 
   export namespace PromotionalCredit {

package/types/resources/Purchase.d.ts

@@ -126,6 +126,7 @@ declare module 'chargebee' {
       index?: number;
       coupon_id?: string;
       percentage?: number;
+      quantity?: number;
       amount?: number;
       included_in_mrr?: boolean;
     }
@@ -199,6 +200,7 @@ declare module 'chargebee' {
       index?: number;
       coupon_id?: string;
       percentage?: number;
+      quantity?: number;
       amount?: number;
       included_in_mrr?: boolean;
     }

package/types/resources/Quote.d.ts

@@ -1150,6 +1150,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       start_date?: number;
       end_date?: number;
     }
@@ -1247,6 +1248,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       start_date?: number;
       end_date?: number;
     }
@@ -1354,6 +1356,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
       start_date?: number;
@@ -1462,6 +1465,7 @@ declare module 'chargebee' {
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
       item_price_id?: string;
+      quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
       start_date?: number;
@@ -1528,6 +1532,7 @@ declare module 'chargebee' {
     }
     export interface DiscountsCreateForChargeItemsAndChargesInputParam {
       percentage?: number;
+      quantity?: number;
       amount?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;
@@ -1600,6 +1605,7 @@ declare module 'chargebee' {
     }
     export interface DiscountsEditForChargeItemsAndChargesInputParam {
       percentage?: number;
+      quantity?: number;
       amount?: number;
       apply_on: ApplyOnEnum;
       item_price_id?: string;

package/types/resources/QuotedCharge.d.ts

@@ -8,6 +8,7 @@ declare module 'chargebee' {
     invoice_items?: QuotedCharge.InvoiceItem[];
     item_tiers?: QuotedCharge.ItemTier[];
     coupons?: QuotedCharge.Coupon[];
+    coupon_applicability_mappings?: QuotedCharge.CouponApplicabilityMapping[];
   }
 
   export namespace QuotedCharge {
@@ -52,6 +53,10 @@ declare module 'chargebee' {
     export interface Coupon {
       coupon_id: string;
     }
+    export interface CouponApplicabilityMapping {
+      coupon_id?: string;
+      applicable_item_price_ids?: string[];
+    }
     // REQUEST PARAMS
     //---------------
   }

package/types/resources/RecordedPurchase.d.ts

@@ -12,6 +12,7 @@ declare module 'chargebee' {
     created_at: number;
     resource_version?: number;
     linked_omnichannel_subscriptions?: RecordedPurchase.LinkedOmnichannelSubscription[];
+    linked_omnichannel_one_time_orders?: RecordedPurchase.LinkedOmnichannelOneTimeOrder[];
     error_detail?: RecordedPurchase.ErrorDetail;
   }
 
@@ -40,6 +41,9 @@ declare module 'chargebee' {
     export interface LinkedOmnichannelSubscription {
       omnichannel_subscription_id?: string;
     }
+    export interface LinkedOmnichannelOneTimeOrder {
+      omnichannel_one_time_order_id?: string;
+    }
     export interface ErrorDetail {
       error_message?: string;
     }
@@ -58,6 +62,8 @@ declare module 'chargebee' {
     }
     export interface GooglePlayStoreCreateInputParam {
       purchase_token?: string;
+      product_id?: string;
+      order_id?: string;
     }
     export interface AppleAppStoreCreateInputParam {
       transaction_id?: string;

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/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;
+    }
+  }
+}