chargebee 3.33.0 → 3.35.0

package/types/resources/BusinessEntity.d.ts

@@ -14,6 +14,27 @@ declare module 'chargebee' {
 
   export namespace BusinessEntity {
     export class BusinessEntityResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        business_entity_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        business_entity_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
       createTransfers(
         input: CreateTransfersInputParam,
         headers?: ChargebeeRequestHeader,
@@ -25,6 +46,23 @@ declare module 'chargebee' {
       ): Promise<ChargebeeResponse<GetTransfersResponse>>;
     }
 
+    export interface CreateResponse {
+      business_entity: BusinessEntity;
+    }
+
+    export interface ListResponse {
+      list: { business_entity: BusinessEntity }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      business_entity: BusinessEntity;
+    }
+
+    export interface UpdateResponse {
+      business_entity: BusinessEntity;
+    }
+
     export interface CreateTransfersResponse {
       business_entity_transfer: BusinessEntityTransfer;
     }
@@ -37,6 +75,20 @@ declare module 'chargebee' {
     // REQUEST PARAMS
     //---------------
 
+    export interface CreateInputParam {
+      name: string;
+      status: 'active' | 'inactive';
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      include_deleted?: boolean;
+      name?: filter.String;
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      status?: 'active' | 'inactive';
+    }
     export interface CreateTransfersInputParam {
       active_resource_ids: string[];
       destination_business_entity_ids: string[] /**

package/types/resources/BusinessRule.d.ts

@@ -0,0 +1,161 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface BusinessRule {
+    id: string;
+    name: string;
+    description?: string;
+    latest_version?: number;
+    active: boolean;
+    released_at?: number;
+    released_by?: string;
+    updated_at: number;
+    updated_by?: string;
+    created_by: string;
+    created_at: number;
+    tags?: any;
+    structured_expression?: any;
+    actions_on_success?: any;
+    resource_version?: number;
+  }
+
+  export namespace BusinessRule {
+    export class BusinessRuleResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      delete(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      updateDraft(
+        business_rule_id: string,
+        input: UpdateDraftInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateDraftResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      retrieveDraft(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveDraftResponse>>;
+
+      deleteDraft(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteDraftResponse>>;
+
+      activateRule(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateRuleResponse>>;
+
+      deactivateRule(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeactivateRuleResponse>>;
+
+      releaseRule(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReleaseRuleResponse>>;
+
+      applyRules(
+        input?: ApplyRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ApplyRulesResponse>>;
+    }
+
+    export interface CreateResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface DeleteResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface UpdateDraftResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ListResponse {
+      list: { business_rule: BusinessRule }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface RetrieveDraftResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface DeleteDraftResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ActivateRuleResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface DeactivateRuleResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ReleaseRuleResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ApplyRulesResponse {
+      apply_rule: ApplyRule;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id?: string;
+      name: string;
+      description?: string;
+      tags?: any;
+      structured_expression: any;
+      actions_on_success?: any;
+    }
+    export interface UpdateDraftInputParam {
+      name: string;
+      description?: string;
+      tags?: any;
+      structured_expression: any;
+      actions_on_success?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      draft?: filter.Boolean;
+      active?: filter.Boolean;
+    }
+    export interface ApplyRulesInputParam {
+      evaluate?: boolean;
+      rule_id?: string;
+      ruleset_id?: string;
+      skip_failed_rules?: boolean;
+      structured_expression?: any;
+      context?: any;
+    }
+  }
+}

package/types/resources/BusinessRuleset.d.ts

@@ -0,0 +1,165 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface BusinessRuleset {
+    id: string;
+    name: string;
+    description?: string;
+    active: boolean;
+    execute_mode:
+      | 'stop_on_first_true'
+      | 'stop_on_first_false'
+      | 'execute_all'
+      | 'execute_all_true';
+    updated_at: number;
+    updated_by?: string;
+    created_by: string;
+    created_at: number;
+    rules?: any;
+    resource_version?: number;
+  }
+
+  export namespace BusinessRuleset {
+    export class BusinessRulesetResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        business_ruleset_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      activate(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateResponse>>;
+
+      deactivate(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeactivateResponse>>;
+
+      addRules(
+        business_ruleset_id: string,
+        input?: AddRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddRulesResponse>>;
+
+      removeRules(
+        business_ruleset_id: string,
+        input?: RemoveRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RemoveRulesResponse>>;
+
+      listRules(
+        business_ruleset_id: string,
+        input?: ListRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListRulesResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface CreateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface UpdateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface DeleteResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface ActivateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface DeactivateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface AddRulesResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface RemoveRulesResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface ListRulesResponse {
+      business_ruleset_rule: BusinessRulesetRule;
+    }
+
+    export interface ListResponse {
+      list: { business_ruleset: BusinessRuleset }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id?: string;
+      name: string;
+      description?: string;
+      execute_mode?:
+        | 'stop_on_first_true'
+        | 'stop_on_first_false'
+        | 'execute_all'
+        | 'execute_all_true';
+      rules?: any;
+    }
+    export interface UpdateInputParam {
+      name: string;
+      description?: string;
+      execute_mode?:
+        | 'stop_on_first_true'
+        | 'stop_on_first_false'
+        | 'execute_all'
+        | 'execute_all_true';
+      rules?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface AddRulesInputParam {
+      rules?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface RemoveRulesInputParam {
+      rules?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface ListRulesInputParam {
+      limit?: number;
+      offset?: string;
+      active?: filter.Boolean;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      active?: filter.Boolean;
+    }
+  }
+}

package/types/resources/BusinessRulesetRule.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface BusinessRulesetRule {
+    rule_id: string;
+    priority: number;
+  }
+}

package/types/resources/Card.d.ts

@@ -139,7 +139,7 @@ declare module 'chargebee' {
       expiry_month: number;
       expiry_year: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;

package/types/resources/Citation.d.ts

@@ -0,0 +1,13 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Citation {
+    id: string;
+    param_name?: string;
+    author_name: string;
+    confidence_level?: 'low' | 'medium' | 'high' | 'not_provided';
+    created_at: number;
+    content: any;
+  }
+}

package/types/resources/CollectionsDispute.d.ts

@@ -0,0 +1,24 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface CollectionsDispute {
+    id: string;
+    customer_id: string;
+    invoice_id: string;
+    line_item_id?: string;
+    currency_code: string;
+    billed_amount: number;
+    claimed_deduction: number;
+    status: 'open' | 'resolved' | 'withdrawn';
+    dispute_reason_code: string;
+    resolved_reason_code?: string;
+    reason?: string;
+    opened_at: number;
+    resolved_at?: number;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+    undisputed_amount?: number;
+  }
+}

package/types/resources/CollectionsPaymentPromise.d.ts

@@ -0,0 +1,93 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface CollectionsPaymentPromise {
+    id: string;
+    customer_id: string;
+    invoice_id: string;
+    status: 'active' | 'fulfilled' | 'broken' | 'cancelled';
+    reason?: string;
+    promised_by?: string;
+    promised_on: number;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+  }
+
+  export namespace CollectionsPaymentPromise {
+    export class CollectionsPaymentPromiseResource {
+      retrieve(
+        collections_payment_promise_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      listCollectionsPaymentPromises(
+        input?: ListCollectionsPaymentPromisesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListCollectionsPaymentPromisesResponse>>;
+
+      createCollectionsPaymentPromise(
+        input: CreateCollectionsPaymentPromiseInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateCollectionsPaymentPromiseResponse>>;
+
+      updateCollectionsPaymentPromise(
+        collections_payment_promise_id: string,
+        input?: UpdateCollectionsPaymentPromiseInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateCollectionsPaymentPromiseResponse>>;
+
+      cancel(
+        collections_payment_promise_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CancelResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      collections_payment_promise: CollectionsPaymentPromise;
+    }
+
+    export interface ListCollectionsPaymentPromisesResponse {
+      list: { collections_payment_promise: CollectionsPaymentPromise }[];
+      next_offset?: string;
+    }
+
+    export interface CreateCollectionsPaymentPromiseResponse {
+      collections_payment_promises: CollectionsPaymentPromise[];
+    }
+
+    export interface UpdateCollectionsPaymentPromiseResponse {
+      collections_payment_promise: CollectionsPaymentPromise;
+    }
+
+    export interface CancelResponse {
+      collections_payment_promise: CollectionsPaymentPromise;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListCollectionsPaymentPromisesInputParam {
+      limit?: number;
+      offset?: string;
+      customer_id?: filter.String;
+      invoice_id?: filter.String;
+      status?: filter.Enum;
+    }
+    export interface CreateCollectionsPaymentPromiseInputParam {
+      customer_id: string;
+      invoice_id?: string;
+      amount: number;
+      currency_code?: string;
+      promised_on: number;
+      reason?: string;
+      promised_by?: string;
+    }
+    export interface UpdateCollectionsPaymentPromiseInputParam {
+      promised_on?: number;
+      reason?: string;
+      promised_by?: string;
+    }
+  }
+}

package/types/resources/CollectionsReminderSequence.d.ts

@@ -0,0 +1,35 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface CollectionsReminderSequence {
+    id: string;
+    invoice_id: string;
+    customer_id: string;
+    status: 'active' | 'completed' | 'paused' | 'failed';
+    paused_until?: number;
+    pause_note?: string;
+    started_at?: number;
+    completed_at?: number;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+    action_logs?: CollectionsReminderSequence.ActionLog[];
+  }
+
+  export namespace CollectionsReminderSequence {
+    export interface ActionLog {
+      action_type: 'send_email';
+      status: 'completed' | 'scheduled' | 'skipped';
+      reason_code?:
+        | 'date_already_passed'
+        | 'before_invoice_date'
+        | 'trigger_event_not_received'
+        | 'sequence_paused';
+      executed_at?: number;
+      scheduled_at?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/Comment.d.ts

@@ -80,7 +80,8 @@ declare module 'chargebee' {
         | 'item_family'
         | 'item'
         | 'item_price'
-        | 'price_variant';
+        | 'price_variant'
+        | 'task';
       entity_id?: string;
       created_at?: filter.Timestamp;
       'sort_by[asc]'?: string;

package/types/resources/Content.d.ts

@@ -8,6 +8,8 @@ declare module 'chargebee' {
     advance_invoice_schedule: AdvanceInvoiceSchedule;
     alert: Alert;
     alert_status: AlertStatus;
+    applied_rule: AppliedRule;
+    apply_rule: ApplyRule;
     async_response: AsyncResponse;
     async_response_list: AsyncResponseList;
     attached_item: AttachedItem;
@@ -16,7 +18,14 @@ declare module 'chargebee' {
     brand: Brand;
     business_entity: BusinessEntity;
     business_entity_transfer: BusinessEntityTransfer;
+    business_rule: BusinessRule;
+    business_ruleset: BusinessRuleset;
+    business_ruleset_rule: BusinessRulesetRule;
     card: Card;
+    citation: Citation;
+    collections_dispute: CollectionsDispute;
+    collections_payment_promise: CollectionsPaymentPromise;
+    collections_reminder_sequence: CollectionsReminderSequence;
     column_definition: ColumnDefinition;
     comment: Comment;
     configuration: Configuration;
@@ -30,16 +39,26 @@ declare module 'chargebee' {
     credit_note_estimate: CreditNoteEstimate;
     credit_unit: CreditUnit;
     currency: Currency;
+    custom_data: CustomData;
+    custom_data_schema: CustomDataSchema;
     customer: Customer;
     customer_entitlement: CustomerEntitlement;
     differential_price: DifferentialPrice;
     discount: Discount;
+    dispute: Dispute;
     download: Download;
+    draft_estimate: DraftEstimate;
+    draft_request: DraftRequest;
     einvoice: Einvoice;
+    email_attachment: EmailAttachment;
+    email_conversation: EmailConversation;
+    email_log: EmailLog;
+    email_message: EmailMessage;
     entitlement: Entitlement;
     entitlement_override: EntitlementOverride;
     estimate: Estimate;
     event: Event;
+    execution: Execution;
     export: Export;
     feature: Feature;
     filter_condition: FilterCondition;
@@ -47,6 +66,8 @@ declare module 'chargebee' {
     gateway_payment_method_token: GatewayPaymentMethodToken;
     gift: Gift;
     grant_block: GrantBlock;
+    group_by_attribute: GroupByAttribute;
+    group_by_recommendation: GroupByRecommendation;
     hierarchy: Hierarchy;
     hosted_page: HostedPage;
     impacted_customer: ImpactedCustomer;
@@ -88,8 +109,11 @@ declare module 'chargebee' {
     personalized_offer: PersonalizedOffer;
     plan: Plan;
     portal_session: PortalSession;
+    preference_variant: PreferenceVariant;
+    price_ramp: PriceRamp;
     price_variant: PriceVariant;
     pricing_page_session: PricingPageSession;
+    private_note: PrivateNote;
     promotional_credit: PromotionalCredit;
     promotional_grant: PromotionalGrant;
     purchase: Purchase;
@@ -101,8 +125,10 @@ declare module 'chargebee' {
     quoted_ramp: QuotedRamp;
     quoted_subscription: QuotedSubscription;
     ramp: Ramp;
+    ramp_interval: RampInterval;
     recorded_purchase: RecordedPurchase;
     resource_migration: ResourceMigration;
+    retry_segment: RetrySegment;
     rule: Rule;
     site_migration_detail: SiteMigrationDetail;
     subscription: Subscription;