chargebee 3.25.0 → 3.27.0

package/types/resources/Content.d.ts

@@ -41,6 +41,7 @@ declare module 'chargebee' {
     filter_condition: FilterCondition;
     gateway_error_detail: GatewayErrorDetail;
     gift: Gift;
+    grant_block: GrantBlock;
     hierarchy: Hierarchy;
     hosted_page: HostedPage;
     impacted_customer: ImpactedCustomer;
@@ -54,6 +55,8 @@ declare module 'chargebee' {
     item_entitlement: ItemEntitlement;
     item_family: ItemFamily;
     item_price: ItemPrice;
+    ledger_account_balance: LedgerAccountBalance;
+    ledger_operation: LedgerOperation;
     metadata: Metadata;
     non_subscription: NonSubscription;
     offer_event: OfferEvent;
@@ -79,6 +82,7 @@ declare module 'chargebee' {
     price_variant: PriceVariant;
     pricing_page_session: PricingPageSession;
     promotional_credit: PromotionalCredit;
+    promotional_grant: PromotionalGrant;
     purchase: Purchase;
     quote: Quote;
     quote_line_group: QuoteLineGroup;

package/types/resources/CreditNote.d.ts

@@ -44,6 +44,7 @@ declare module 'chargebee' {
     local_currency_code?: string;
     round_off_amount?: number;
     fractional_correction?: number;
+    notes?: string[];
     line_items?: CreditNote.LineItem[];
     line_item_tiers?: CreditNote.LineItemTier[];
     line_item_discounts?: CreditNote.LineItemDiscount[];

package/types/resources/GrantBlock.d.ts

@@ -0,0 +1,59 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GrantBlock {
+    id: string;
+    granted_amount: string;
+    effective_from: number;
+    expires_at: number;
+    balance: string;
+    hold_amount: string;
+    used_amount: string;
+    expired_amount: string;
+    rolled_over_amount: string;
+    voided_amount: string;
+    origin_grant_block_id?: string;
+    status: StatusEnum;
+    metadata?: string;
+    grant_source:
+      | 'subscription_created'
+      | 'subscription_changed'
+      | 'top_up'
+      | 'promotional_grants'
+      | 'rollover';
+    created_at?: number;
+    account_type?: 'provisioned' | 'overdraft';
+    unit_id?: string;
+    unit_type?: 'credit_unit';
+  }
+
+  export namespace GrantBlock {
+    export class GrantBlockResource {
+      listGrantBlocks(
+        input: ListGrantBlocksInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListGrantBlocksResponse>>;
+    }
+
+    export interface ListGrantBlocksResponse {
+      list: { grant_block: GrantBlock }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListGrantBlocksInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+      effective_from?: filter.Timestamp;
+      expires_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/HostedPage.d.ts

@@ -7,7 +7,6 @@ declare module 'chargebee' {
     type?:
       | 'checkout_new'
       | 'checkout_existing'
-      | 'update_payment_method'
       | 'manage_payment_sources'
       | 'collect_now'
       | 'extend_subscription'
@@ -29,6 +28,7 @@ declare module 'chargebee' {
     embed: boolean;
     created_at?: number;
     expires_at?: number;
+    layout?: LayoutEnum;
     content: Content;
     updated_at?: number;
     resource_version?: number;
@@ -77,6 +77,10 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<UpdateCardResponse>>;
 
+      /**
+       * @deprecated This method is deprecated and will be removed in a future version.
+       */
+
       updatePaymentMethod(
         input: UpdatePaymentMethodInputParam,
         headers?: ChargebeeRequestHeader,

package/types/resources/LedgerAccountBalance.d.ts

@@ -0,0 +1,50 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface LedgerAccountBalance {
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
+    modified_at?: number;
+    provisioned_balance?: LedgerAccountBalance.ProvisionedBalance;
+    overdraft_balance?: LedgerAccountBalance.OverdraftBalance;
+  }
+
+  export namespace LedgerAccountBalance {
+    export class LedgerAccountBalanceResource {
+      listLedgerAccountBalances(
+        input: ListLedgerAccountBalancesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListLedgerAccountBalancesResponse>>;
+    }
+
+    export interface ListLedgerAccountBalancesResponse {
+      list: { ledger_account_balance: LedgerAccountBalance }[];
+      next_offset?: string;
+    }
+
+    export interface ProvisionedBalance {
+      total_balance: string;
+      usable_balance: string;
+      hold_amount: string;
+    }
+    export interface OverdraftBalance {
+      is_unlimited: boolean;
+      limit?: string;
+      total_balance?: string;
+      usable_balance?: string;
+      used_amount: string;
+      hold_amount: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListLedgerAccountBalancesInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+    }
+  }
+}

package/types/resources/LedgerOperation.d.ts

@@ -0,0 +1,141 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface LedgerOperation {
+    id: string;
+    type:
+      | 'allocation'
+      | 'capture'
+      | 'authorize'
+      | 'release_authorization'
+      | 'capture_authorization'
+      | 'expiry'
+      | 'void'
+      | 'rollover'
+      | 'adjustment';
+    amount: string;
+    start_balance: string;
+    end_balance: string;
+    provisioned_start_balance: string;
+    provisioned_end_balance: string;
+    overdraft_start_balance: string;
+    overdraft_end_balance: string;
+    parent_ledger_operation_id?: string;
+    ledger_operation_timestamp?: number;
+    auto_release_timestamp?: number;
+    metadata?: string;
+    created_at?: number;
+    modified_at?: number;
+    subscription_id?: string;
+    unit_id?: string;
+    unit_type?: 'credit_unit';
+  }
+
+  export namespace LedgerOperation {
+    export class LedgerOperationResource {
+      retrieveLedgerOperation(
+        ledger_operation_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveLedgerOperationResponse>>;
+
+      listLedgerOperations(
+        input: ListLedgerOperationsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListLedgerOperationsResponse>>;
+
+      capture(
+        input: CaptureInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CaptureResponse>>;
+
+      authorize(
+        input: AuthorizeInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AuthorizeResponse>>;
+
+      captureAuthorization(
+        input: CaptureAuthorizationInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CaptureAuthorizationResponse>>;
+
+      releaseAuthorization(
+        input: ReleaseAuthorizationInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReleaseAuthorizationResponse>>;
+    }
+
+    export interface RetrieveLedgerOperationResponse {
+      ledger_operation: LedgerOperation;
+    }
+
+    export interface ListLedgerOperationsResponse {
+      list: { ledger_operation: LedgerOperation }[];
+      next_offset?: string;
+    }
+
+    export interface CaptureResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    export interface AuthorizeResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    export interface CaptureAuthorizationResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    export interface ReleaseAuthorizationResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListLedgerOperationsInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+      created_at?: filter.Timestamp;
+      type?: filter.Enum;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface CaptureInputParam {
+      id?: string;
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      ledger_operation_timestamp: number;
+      metadata?: any;
+    }
+    export interface AuthorizeInputParam {
+      id?: string;
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      ledger_operation_timestamp: number;
+      auto_release_timestamp?: number;
+      metadata?: any;
+    }
+    export interface CaptureAuthorizationInputParam {
+      authorization_id: string;
+      id?: string;
+      amount: string;
+      ledger_operation_timestamp: number;
+      metadata?: any;
+    }
+    export interface ReleaseAuthorizationInputParam {
+      authorization_id: string;
+      id?: string;
+      ledger_operation_timestamp: number;
+      metadata?: any;
+    }
+  }
+}

package/types/resources/OmnichannelSubscription.d.ts

@@ -74,6 +74,8 @@ declare module 'chargebee' {
       id_at_source?: filter.String;
       updated_at?: filter.Timestamp;
       purchased_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
     }
     export interface OmnichannelTransactionsForOmnichannelSubscriptionInputParam {
       limit?: number;

package/types/resources/PromotionalGrant.d.ts

@@ -0,0 +1,37 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PromotionalGrant {
+    subscription_id: string;
+    unit_id: string;
+    amount: string;
+    expires_at: number;
+    metadata?: string;
+  }
+
+  export namespace PromotionalGrant {
+    export class PromotionalGrantResource {
+      promotionalGrants(
+        input: PromotionalGrantsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PromotionalGrantsResponse>>;
+    }
+
+    export interface PromotionalGrantsResponse {
+      ledger_operations: LedgerOperation[];
+      grant_blocks: GrantBlock[];
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface PromotionalGrantsInputParam {
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      expires_at: number;
+      metadata?: any;
+    }
+  }
+}