chargebee 3.34.0 → 3.35.0

package/types/index.d.ts

@@ -3,7 +3,6 @@
 ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
 ///<reference path='./resources/Alert.d.ts' />
 ///<reference path='./resources/AlertStatus.d.ts' />
-///<reference path='./resources/AppliedBusinessRule.d.ts' />
 ///<reference path='./resources/AppliedRule.d.ts' />
 ///<reference path='./resources/ApplyRule.d.ts' />
 ///<reference path='./resources/AsyncResponse.d.ts' />
@@ -18,6 +17,10 @@
 ///<reference path='./resources/BusinessRuleset.d.ts' />
 ///<reference path='./resources/BusinessRulesetRule.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
+///<reference path='./resources/Citation.d.ts' />
+///<reference path='./resources/CollectionsDispute.d.ts' />
+///<reference path='./resources/CollectionsPaymentPromise.d.ts' />
+///<reference path='./resources/CollectionsReminderSequence.d.ts' />
 ///<reference path='./resources/ColumnDefinition.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
 ///<reference path='./resources/Configuration.d.ts' />
@@ -31,6 +34,7 @@
 ///<reference path='./resources/CreditNoteEstimate.d.ts' />
 ///<reference path='./resources/CreditUnit.d.ts' />
 ///<reference path='./resources/Currency.d.ts' />
+///<reference path='./resources/CustomData.d.ts' />
 ///<reference path='./resources/CustomDataSchema.d.ts' />
 ///<reference path='./resources/Customer.d.ts' />
 ///<reference path='./resources/CustomerEntitlement.d.ts' />
@@ -38,12 +42,18 @@
 ///<reference path='./resources/Discount.d.ts' />
 ///<reference path='./resources/Dispute.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
+///<reference path='./resources/DraftEstimate.d.ts' />
+///<reference path='./resources/DraftRequest.d.ts' />
 ///<reference path='./resources/Einvoice.d.ts' />
+///<reference path='./resources/EmailAttachment.d.ts' />
+///<reference path='./resources/EmailConversation.d.ts' />
 ///<reference path='./resources/EmailLog.d.ts' />
+///<reference path='./resources/EmailMessage.d.ts' />
 ///<reference path='./resources/Entitlement.d.ts' />
 ///<reference path='./resources/EntitlementOverride.d.ts' />
 ///<reference path='./resources/Estimate.d.ts' />
 ///<reference path='./resources/Event.d.ts' />
+///<reference path='./resources/Execution.d.ts' />
 ///<reference path='./resources/Export.d.ts' />
 ///<reference path='./resources/Feature.d.ts' />
 ///<reference path='./resources/FilterCondition.d.ts' />
@@ -51,6 +61,8 @@
 ///<reference path='./resources/GatewayPaymentMethodToken.d.ts' />
 ///<reference path='./resources/Gift.d.ts' />
 ///<reference path='./resources/GrantBlock.d.ts' />
+///<reference path='./resources/GroupByAttribute.d.ts' />
+///<reference path='./resources/GroupByRecommendation.d.ts' />
 ///<reference path='./resources/Hierarchy.d.ts' />
 ///<reference path='./resources/HostedPage.d.ts' />
 ///<reference path='./resources/ImpactedCustomer.d.ts' />
@@ -92,8 +104,11 @@
 ///<reference path='./resources/PersonalizedOffer.d.ts' />
 ///<reference path='./resources/Plan.d.ts' />
 ///<reference path='./resources/PortalSession.d.ts' />
+///<reference path='./resources/PreferenceVariant.d.ts' />
+///<reference path='./resources/PriceRamp.d.ts' />
 ///<reference path='./resources/PriceVariant.d.ts' />
 ///<reference path='./resources/PricingPageSession.d.ts' />
+///<reference path='./resources/PrivateNote.d.ts' />
 ///<reference path='./resources/PromotionalCredit.d.ts' />
 ///<reference path='./resources/PromotionalGrant.d.ts' />
 ///<reference path='./resources/Purchase.d.ts' />
@@ -105,8 +120,10 @@
 ///<reference path='./resources/QuotedRamp.d.ts' />
 ///<reference path='./resources/QuotedSubscription.d.ts' />
 ///<reference path='./resources/Ramp.d.ts' />
+///<reference path='./resources/RampInterval.d.ts' />
 ///<reference path='./resources/RecordedPurchase.d.ts' />
 ///<reference path='./resources/ResourceMigration.d.ts' />
+///<reference path='./resources/RetrySegment.d.ts' />
 ///<reference path='./resources/Rule.d.ts' />
 ///<reference path='./resources/SiteMigrationDetail.d.ts' />
 ///<reference path='./resources/Subscription.d.ts' />
@@ -296,6 +313,7 @@ declare module 'chargebee' {
     businessRule: BusinessRule.BusinessRuleResource;
     businessRuleset: BusinessRuleset.BusinessRulesetResource;
     card: Card.CardResource;
+    collectionsPaymentPromise: CollectionsPaymentPromise.CollectionsPaymentPromiseResource;
     comment: Comment.CommentResource;
     configuration: Configuration.ConfigurationResource;
     coupon: Coupon.CouponResource;
@@ -308,6 +326,7 @@ declare module 'chargebee' {
     customerEntitlement: CustomerEntitlement.CustomerEntitlementResource;
     differentialPrice: DifferentialPrice.DifferentialPriceResource;
     dispute: Dispute.DisputeResource;
+    draftRequest: DraftRequest.DraftRequestResource;
     einvoice: Einvoice.EinvoiceResource;
     emailLog: EmailLog.EmailLogResource;
     entitlement: Entitlement.EntitlementResource;
@@ -344,6 +363,7 @@ declare module 'chargebee' {
     personalizedOffer: PersonalizedOffer.PersonalizedOfferResource;
     plan: Plan.PlanResource;
     portalSession: PortalSession.PortalSessionResource;
+    priceRamp: PriceRamp.PriceRampResource;
     priceVariant: PriceVariant.PriceVariantResource;
     pricingPageSession: PricingPageSession.PricingPageSessionResource;
     promotionalCredit: PromotionalCredit.PromotionalCreditResource;
@@ -354,6 +374,7 @@ declare module 'chargebee' {
     ramp: Ramp.RampResource;
     recordedPurchase: RecordedPurchase.RecordedPurchaseResource;
     resourceMigration: ResourceMigration.ResourceMigrationResource;
+    retrySegment: RetrySegment.RetrySegmentResource;
     rule: Rule.RuleResource;
     siteMigrationDetail: SiteMigrationDetail.SiteMigrationDetailResource;
     subscription: Subscription.SubscriptionResource;

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/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,7 +8,6 @@ declare module 'chargebee' {
     advance_invoice_schedule: AdvanceInvoiceSchedule;
     alert: Alert;
     alert_status: AlertStatus;
-    applied_business_rule: AppliedBusinessRule;
     applied_rule: AppliedRule;
     apply_rule: ApplyRule;
     async_response: AsyncResponse;
@@ -23,6 +22,10 @@ declare module 'chargebee' {
     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;
@@ -36,6 +39,7 @@ declare module 'chargebee' {
     credit_note_estimate: CreditNoteEstimate;
     credit_unit: CreditUnit;
     currency: Currency;
+    custom_data: CustomData;
     custom_data_schema: CustomDataSchema;
     customer: Customer;
     customer_entitlement: CustomerEntitlement;
@@ -43,12 +47,18 @@ declare module 'chargebee' {
     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;
@@ -56,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;
@@ -97,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;
@@ -110,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;

package/types/resources/CreditNote.d.ts

@@ -567,6 +567,7 @@ declare module 'chargebee' {
       currency_code?: string;
       create_reason_code: string;
       date: number;
+      customer_notes?: string;
       status?: 'adjusted' | 'refunded' | 'refund_due' | 'voided';
       total?: number;
       refunded_at?: number;

package/types/resources/CustomData.d.ts

@@ -0,0 +1,14 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface CustomData {
+    entity_type: EntityTypeEnum;
+    id: string;
+    schema_id: string;
+    schema_values: string;
+    created_at: number;
+    modified_at: number;
+    updated_at?: number;
+  }
+}

package/types/resources/DraftEstimate.d.ts

@@ -0,0 +1,13 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface DraftEstimate {
+    status: 'success' | 'failed';
+    http_status?: number;
+    created_at: number;
+    result?: any;
+    error_detail?: any;
+    revision_version?: number;
+  }
+}

package/types/resources/DraftRequest.d.ts

@@ -0,0 +1,45 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface DraftRequest {
+    id: string;
+    path_param?: string;
+    request_uri?: string;
+    operation_id: string;
+    status: 'open' | 'executed';
+    executed_at?: number;
+    created_at: number;
+    resource_version?: number;
+    updated_at: number;
+    current_revision?: DraftRequest.DraftRevision;
+    validations?: DraftRequest.Validation[];
+    has_comments?: boolean;
+    has_citations?: boolean;
+    executions?: DraftRequest.Execution[];
+  }
+
+  export namespace DraftRequest {
+    export interface DraftRevision {
+      version: number;
+      created_at: number;
+      payload?: object;
+    }
+    export interface Validation {
+      category?: string;
+      level?: string;
+      message?: string;
+      param_name?: string;
+      type?: string;
+    }
+    export interface Execution {
+      status: 'success' | 'failed';
+      created_at: number;
+      result?: object;
+      error_detail?: object;
+      revision_version?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/EmailAttachment.d.ts

@@ -0,0 +1,16 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface EmailAttachment {
+    id: string;
+    email_message_id?: string;
+    file_name?: string;
+    content_type?: string;
+    size_bytes?: number;
+    content_disposition?: string;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/EmailConversation.d.ts

@@ -0,0 +1,18 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface EmailConversation {
+    id: string;
+    customer_id?: string;
+    mailbox_id?: string;
+    subject?: string;
+    last_message_preview?: string;
+    message_count: number;
+    status?: string;
+    last_message_at?: number;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+  }
+}

package/types/resources/EmailLog.d.ts

@@ -11,6 +11,7 @@ declare module 'chargebee' {
     status: StatusEnum;
     sent_on?: number;
     customer_id?: string;
+    email_conversation_id?: string;
     site_id?: string;
     business_entity_id?: string;
     brand_id?: string;

package/types/resources/EmailMessage.d.ts

@@ -0,0 +1,40 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface EmailMessage {
+    id: string;
+    email_conversation_id?: string;
+    message_type?: string;
+    author_type?: 'contact' | 'site_user' | 'agent' | 'other';
+    send_status?: 'pending' | 'sent' | 'failed';
+    content_html?: string;
+    content_text?: string;
+    created_at: number;
+    updated_at: number;
+    resource_version?: number;
+    mailbox_id?: string;
+    author_id?: string;
+    author_name?: string;
+    from_email?: string;
+    to_emails?: string[];
+    cc_emails?: string[];
+    attachments?: EmailMessage.Attachment[];
+  }
+
+  export namespace EmailMessage {
+    export interface Attachment {
+      id: string;
+      email_message_id?: string;
+      file_name?: string;
+      content_type?: string;
+      size_bytes?: number;
+      content_disposition?: string;
+      created_at: number;
+      updated_at: number;
+      resource_version?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}