chargebee 3.35.0 → 3.36.0

package/types/resources/GatewayRequestLog.d.ts

@@ -0,0 +1,82 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GatewayRequestLog {
+    log_id?: string;
+    url?: string;
+    status_code?: string;
+    method?: string;
+    request_body?: string;
+    response_body?: string;
+    request_headers?: string;
+    response_headers?: string;
+    gateway?: string;
+    customer_handle?: string;
+    invoice_handle?: string;
+    transaction_handle?: string;
+    payment_method_handle?: string;
+    gateway_credential_handle?: string;
+    payment_attempt_handle?: string;
+    payment_intent_handle?: string;
+    payment_method_name?: string;
+    operation_name?: string;
+    operation_type?: string;
+    action_type?: string;
+    source?: string;
+    trace_id_hash?: string;
+    invocation_time?: number;
+    response_received_at?: number;
+    response_time?: number;
+  }
+
+  export namespace GatewayRequestLog {
+    export class GatewayRequestLogResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        gateway_request_log_log_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { gateway_request_log: GatewayRequestLog }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      gateway_request_log: GatewayRequestLog;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      log_id?: filter.String;
+      gateway?: filter.String;
+      status_code?: filter.String;
+      method?: filter.String;
+      url?: filter.String;
+      customer_handle?: filter.String;
+      invoice_handle?: filter.String;
+      transaction_handle?: filter.String;
+      payment_method_handle?: filter.String;
+      gateway_credential_handle?: filter.String;
+      payment_attempt_handle?: filter.String;
+      payment_intent_handle?: filter.String;
+      operation_name?: filter.String;
+      operation_type?: filter.String;
+      source?: filter.String;
+      invocation_time?: filter.Timestamp;
+      response_received_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/GatewayWebhookLog.d.ts

@@ -0,0 +1,74 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GatewayWebhookLog {
+    webhook_id?: string;
+    url?: string;
+    method?: string;
+    status_code?: string;
+    gateway?: string;
+    id_at_gateway?: string;
+    customer_handle?: string;
+    invoice_handle?: string;
+    transaction_handle?: string;
+    payment_method_handle?: string;
+    gateway_credential_handle?: string;
+    payment_attempt_handle?: string;
+    payment_intent_handle?: string;
+    payment_method_name?: string;
+    request_body?: string;
+    response_body?: string;
+    request_headers?: string;
+    response_headers?: string;
+    received_at?: number;
+    response_time?: number;
+  }
+
+  export namespace GatewayWebhookLog {
+    export class GatewayWebhookLogResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        gateway_webhook_log_webhook_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { gateway_webhook_log: GatewayWebhookLog }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      gateway_webhook_log: GatewayWebhookLog;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      webhook_id?: filter.String;
+      gateway?: filter.String;
+      status_code?: filter.String;
+      method?: filter.String;
+      url?: filter.String;
+      id_at_gateway?: filter.String;
+      customer_handle?: filter.String;
+      invoice_handle?: filter.String;
+      transaction_handle?: filter.String;
+      payment_method_handle?: filter.String;
+      gateway_credential_handle?: filter.String;
+      payment_attempt_handle?: filter.String;
+      payment_intent_handle?: filter.String;
+      received_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/GrantBlock.d.ts

@@ -32,6 +32,7 @@ declare module 'chargebee' {
     resource_version?: number;
     provisioned_block_balance?: GrantBlock.ProvisionedBlockBalance;
     overdraft_block_balance?: GrantBlock.OverdraftBlockBalance;
+    billing_metadata?: GrantBlock.BillingMetadata;
     metadata?: any;
   }
 
@@ -65,6 +66,10 @@ declare module 'chargebee' {
       usable_balance?: string;
       used_amount?: string;
     }
+    export interface BillingMetadata {
+      item_price_id?: string;
+      line_items?: BillingLineItem[];
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/HostedPage.d.ts

@@ -329,6 +329,7 @@ declare module 'chargebee' {
       redirect_url?: string;
       cancel_url?: string;
       pass_thru_content?: string;
+      show_billing_frequency_selector?: boolean;
       allow_offline_payment_methods?: boolean;
       subscription?: SubscriptionCheckoutNewForItemsInputParam;
       customer?: CustomerCheckoutNewForItemsInputParam;
@@ -340,6 +341,7 @@ declare module 'chargebee' {
       discounts?: DiscountsCheckoutNewForItemsInputParam[];
       item_tiers?: ItemTiersCheckoutNewForItemsInputParam[];
       entity_identifiers?: EntityIdentifiersCheckoutNewForItemsInputParam[];
+      allowed_billing_frequencies?: AllowedBillingFrequenciesCheckoutNewForItemsInputParam[];
     }
     export interface CheckoutExistingInputParam {
       replace_addon_list?: boolean;
@@ -386,6 +388,7 @@ declare module 'chargebee' {
       redirect_url?: string;
       cancel_url?: string;
       pass_thru_content?: string;
+      show_billing_frequency_selector?: boolean;
       allow_offline_payment_methods?: boolean;
       subscription?: SubscriptionCheckoutExistingForItemsInputParam;
       customer?: CustomerCheckoutExistingForItemsInputParam;
@@ -395,6 +398,7 @@ declare module 'chargebee' {
       discounts?: DiscountsCheckoutExistingForItemsInputParam[];
       item_tiers?: ItemTiersCheckoutExistingForItemsInputParam[];
       entity_identifiers?: EntityIdentifiersCheckoutExistingForItemsInputParam[];
+      allowed_billing_frequencies?: AllowedBillingFrequenciesCheckoutExistingForItemsInputParam[];
     }
     export interface UpdateCardInputParam {
       redirect_url?: string;
@@ -454,9 +458,11 @@ declare module 'chargebee' {
       brand_id?: string;
       redirect_url?: string;
       coupon_ids?: string[];
+      show_billing_frequency_selector?: boolean;
       gifter?: GifterCheckoutGiftForItemsInputParam;
       subscription_items?: SubscriptionItemsCheckoutGiftForItemsInputParam[];
       item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
+      allowed_billing_frequencies?: AllowedBillingFrequenciesCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
       brand_id?: string;
@@ -869,6 +875,10 @@ declare module 'chargebee' {
       item_type?: ItemTypeEnum;
       charge_on_option?: ChargeOnOptionEnum;
     }
+    export interface AllowedBillingFrequenciesCheckoutNewForItemsInputParam {
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+    }
     export interface DiscountsCheckoutNewForItemsInputParam {
       apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
@@ -1005,6 +1015,10 @@ declare module 'chargebee' {
        */
       item_type?: ItemTypeEnum;
     }
+    export interface AllowedBillingFrequenciesCheckoutExistingForItemsInputParam {
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+    }
     export interface DiscountsCheckoutExistingForItemsInputParam {
       apply_on?: ApplyOnEnum;
       duration_type: DurationTypeEnum;
@@ -1133,6 +1147,10 @@ declare module 'chargebee' {
       unit_price?: number;
       unit_price_in_decimal?: string;
     }
+    export interface AllowedBillingFrequenciesCheckoutGiftForItemsInputParam {
+      period?: number;
+      period_unit?: PeriodUnitEnum;
+    }
     export interface ItemTiersCheckoutGiftForItemsInputParam {
       item_price_id?: string;
       starting_unit?: number;

package/types/resources/Invoice.d.ts

@@ -47,6 +47,7 @@ declare module 'chargebee' {
     first_invoice?: boolean;
     new_sales_amount?: number;
     has_advance_charges?: boolean;
+    offline_payment_method?: OfflinePaymentMethodEnum;
     term_finalized: boolean;
     is_gifted: boolean;
     generated_at?: number;
@@ -956,6 +957,7 @@ declare module 'chargebee' {
       payment_source_id?: string;
       auto_collection?: AutoCollectionEnum;
       net_term_days?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       invoice_date?: number;
       create_pending_invoice?: boolean;
       token_id?: string;
@@ -1859,6 +1861,8 @@ declare module 'chargebee' {
     }
     export interface CreditNotesApplyCreditsInputParam {
       id?: string;
+      amount?: number;
+      applied_at?: number;
     }
     export interface EinvoiceInvoiceListInputParam {
       status?: filter.Enum;

package/types/resources/OrganizationDetail.d.ts

@@ -0,0 +1,84 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface OrganizationDetail {
+    id: string;
+    organization_name?: string;
+    email?: string;
+    address_line1?: string;
+    address_line2?: string;
+    address_line3?: string;
+    city?: string;
+    state_code?: string;
+    state?: string;
+    country_code?: string;
+    zip?: string;
+    phone?: string;
+    fax?: string;
+    website?: string;
+    is_vat_number_present?: boolean;
+    vat_number?: string;
+    resource_version?: number;
+    updated_at?: number;
+    business_entity_id?: string;
+  }
+
+  export namespace OrganizationDetail {
+    export class OrganizationDetailResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        organization_detail_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      organization_detail: OrganizationDetail;
+    }
+
+    export interface RetrieveResponse {
+      organization_detail: OrganizationDetail;
+    }
+
+    export interface ListResponse {
+      list: { organization_detail: OrganizationDetail }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      organization_name: string;
+      email?: string;
+      address_line1: string;
+      address_line2?: string;
+      address_line3?: string;
+      city: string;
+      state_code?: string;
+      state: string;
+      zip: string;
+      country_code?: string;
+      phone: string;
+      fax?: string;
+      website?: string;
+      is_vat_number_present?: boolean;
+      vat_number?: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      business_entity_id?: filter.String;
+    }
+  }
+}

package/types/resources/Subscription.d.ts

@@ -695,6 +695,7 @@ declare module 'chargebee' {
     export interface Discount {
       id: string;
       invoice_name?: string;
+      description?: string;
       type: 'fixed_amount' | 'percentage' | 'offer_quantity';
       percentage?: number;
       amount?: number;
@@ -1807,6 +1808,7 @@ declare module 'chargebee' {
       included_in_mrr?: boolean;
       item_price_id?: string;
       quantity?: number;
+      description?: string;
     }
     export interface CouponsCreateWithItemsInputParam {
       /**
@@ -2243,6 +2245,7 @@ declare module 'chargebee' {
       quantity?: number;
       operation_type: OperationTypeEnum;
       id?: string;
+      description?: string;
     }
     export interface CouponsUpdateForItemsInputParam {
       /**

package/types/resources/Usage.d.ts

@@ -114,6 +114,7 @@ declare module 'chargebee' {
     export interface GroupByPdfInputParam {
       feature_id?: string;
       attributes?: any;
+      window_size?: 'day' | 'none';
     }
   }
 }

package/types/resources/WebhookEvent.d.ts

@@ -199,6 +199,7 @@ declare module 'chargebee' {
     SalesOrderCreated = 'sales_order_created',
     CustomerChanged = 'customer_changed',
     SubscriptionStarted = 'subscription_started',
+    OrganizationDetailsUpdated = 'organization_details_updated',
     SubscriptionActivated = 'subscription_activated',
     PaymentSourceExpiring = 'payment_source_expiring',
     SubscriptionReactivated = 'subscription_reactivated',
@@ -240,6 +241,7 @@ declare module 'chargebee' {
     OmnichannelSubscriptionCreated = 'omnichannel_subscription_created',
     TaxWithheldRecorded = 'tax_withheld_recorded',
     PriceVariantCreated = 'price_variant_created',
+    OrganizationDetailsCreated = 'organization_details_created',
     DifferentialPriceDeleted = 'differential_price_deleted',
     BusinessRuleActivated = 'business_rule_activated',
     SubscriptionItemsRenewed = 'subscription_items_renewed',
@@ -471,6 +473,7 @@ declare module 'chargebee' {
     [WebhookEventType.SalesOrderCreated]: SalesOrderCreatedContent;
     [WebhookEventType.CustomerChanged]: CustomerChangedContent;
     [WebhookEventType.SubscriptionStarted]: SubscriptionStartedContent;
+    [WebhookEventType.OrganizationDetailsUpdated]: OrganizationDetailsUpdatedContent;
     [WebhookEventType.SubscriptionActivated]: SubscriptionActivatedContent;
     [WebhookEventType.PaymentSourceExpiring]: PaymentSourceExpiringContent;
     [WebhookEventType.SubscriptionReactivated]: SubscriptionReactivatedContent;
@@ -512,6 +515,7 @@ declare module 'chargebee' {
     [WebhookEventType.OmnichannelSubscriptionCreated]: OmnichannelSubscriptionCreatedContent;
     [WebhookEventType.TaxWithheldRecorded]: TaxWithheldRecordedContent;
     [WebhookEventType.PriceVariantCreated]: PriceVariantCreatedContent;
+    [WebhookEventType.OrganizationDetailsCreated]: OrganizationDetailsCreatedContent;
     [WebhookEventType.DifferentialPriceDeleted]: DifferentialPriceDeletedContent;
     [WebhookEventType.BusinessRuleActivated]: BusinessRuleActivatedContent;
     [WebhookEventType.SubscriptionItemsRenewed]: SubscriptionItemsRenewedContent;
@@ -1634,6 +1638,9 @@ declare module 'chargebee' {
 
     invoice: Invoice;
   };
+  export type OrganizationDetailsUpdatedContent = {
+    organization_detail: OrganizationDetail;
+  };
   export type SubscriptionActivatedContent = {
     subscription: Subscription;
 
@@ -1839,6 +1846,9 @@ declare module 'chargebee' {
 
     attribute: Attribute;
   };
+  export type OrganizationDetailsCreatedContent = {
+    organization_detail: OrganizationDetail;
+  };
   export type DifferentialPriceDeletedContent = {
     differential_price: DifferentialPrice;
   };