chargebee 3.0.0 → 3.0.2

package/types/index.d.ts

@@ -0,0 +1,167 @@
+///<reference path='./resources/Address.d.ts' />
+///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
+///<reference path='./resources/AttachedItem.d.ts' />
+///<reference path='./resources/Attribute.d.ts' />
+///<reference path='./resources/BusinessEntity.d.ts' />
+///<reference path='./resources/BusinessEntityTransfer.d.ts' />
+///<reference path='./resources/Card.d.ts' />
+///<reference path='./resources/Comment.d.ts' />
+///<reference path='./resources/Contact.d.ts' />
+///<reference path='./resources/ContractTerm.d.ts' />
+///<reference path='./resources/Coupon.d.ts' />
+///<reference path='./resources/CouponCode.d.ts' />
+///<reference path='./resources/CouponSet.d.ts' />
+///<reference path='./resources/CreditNote.d.ts' />
+///<reference path='./resources/CreditNoteEstimate.d.ts' />
+///<reference path='./resources/Currency.d.ts' />
+///<reference path='./resources/Customer.d.ts' />
+///<reference path='./resources/CustomerEntitlement.d.ts' />
+///<reference path='./resources/DifferentialPrice.d.ts' />
+///<reference path='./resources/Discount.d.ts' />
+///<reference path='./resources/Download.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/Export.d.ts' />
+///<reference path='./resources/Feature.d.ts' />
+///<reference path='./resources/GatewayErrorDetail.d.ts' />
+///<reference path='./resources/Gift.d.ts' />
+///<reference path='./resources/Hierarchy.d.ts' />
+///<reference path='./resources/HostedPage.d.ts' />
+///<reference path='./resources/ImpactedItem.d.ts' />
+///<reference path='./resources/ImpactedItemPrice.d.ts' />
+///<reference path='./resources/ImpactedSubscription.d.ts' />
+///<reference path='./resources/InAppSubscription.d.ts' />
+///<reference path='./resources/Invoice.d.ts' />
+///<reference path='./resources/InvoiceEstimate.d.ts' />
+///<reference path='./resources/Item.d.ts' />
+///<reference path='./resources/ItemEntitlement.d.ts' />
+///<reference path='./resources/ItemFamily.d.ts' />
+///<reference path='./resources/ItemPrice.d.ts' />
+///<reference path='./resources/Metadata.d.ts' />
+///<reference path='./resources/NonSubscription.d.ts' />
+///<reference path='./resources/Order.d.ts' />
+///<reference path='./resources/PaymentIntent.d.ts' />
+///<reference path='./resources/PaymentReferenceNumber.d.ts' />
+///<reference path='./resources/PaymentSchedule.d.ts' />
+///<reference path='./resources/PaymentScheduleEstimate.d.ts' />
+///<reference path='./resources/PaymentScheduleScheme.d.ts' />
+///<reference path='./resources/PaymentSource.d.ts' />
+///<reference path='./resources/PaymentVoucher.d.ts' />
+///<reference path='./resources/PortalSession.d.ts' />
+///<reference path='./resources/PriceVariant.d.ts' />
+///<reference path='./resources/PricingPageSession.d.ts' />
+///<reference path='./resources/PromotionalCredit.d.ts' />
+///<reference path='./resources/Purchase.d.ts' />
+///<reference path='./resources/Quote.d.ts' />
+///<reference path='./resources/QuoteLineGroup.d.ts' />
+///<reference path='./resources/QuotedCharge.d.ts' />
+///<reference path='./resources/QuotedSubscription.d.ts' />
+///<reference path='./resources/Ramp.d.ts' />
+///<reference path='./resources/ResourceMigration.d.ts' />
+///<reference path='./resources/SiteMigrationDetail.d.ts' />
+///<reference path='./resources/Subscription.d.ts' />
+///<reference path='./resources/SubscriptionEntitlement.d.ts' />
+///<reference path='./resources/SubscriptionEstimate.d.ts' />
+///<reference path='./resources/TaxWithheld.d.ts' />
+///<reference path='./resources/ThirdPartyPaymentMethod.d.ts' />
+///<reference path='./resources/TimeMachine.d.ts' />
+///<reference path='./resources/Token.d.ts' />
+///<reference path='./resources/Transaction.d.ts' />
+///<reference path='./resources/UnbilledCharge.d.ts' />
+///<reference path='./resources/Usage.d.ts' />
+///<reference path='./resources/VirtualBankAccount.d.ts' />
+
+export type Config = {
+  /**
+   * @apiKey api key for the site.
+   */
+  apiKey: string;
+  /**
+   * @site api site name.
+   */
+  site: string;
+  /**
+   * @apiPath this value indicates the api version, default value is /api/v2.
+   */
+  apiPath?: '/api/v2' | '/api/v1';
+  /**
+   * @timeout client side request timeout in milliseconds, default value is 80000ms.
+   */
+  timeout?: number;
+  /**
+   * @port url port
+   */
+  port?: number;
+  /**
+   * @timemachineWaitInMillis time interval at which two subsequent retrieve timemachine call in milliseconds, default value is 3000ms.
+   */
+  timemachineWaitInMillis?: number;
+  /**
+   * @exportWaitInMillis time interval at which two subsequent retrieve export call in milliseconds, default value is 3000ms.
+   */
+  exportWaitInMillis?: number;
+  /**
+   * @protocol http protocol, default value is https
+   */
+  protocol?: 'https' | 'http';
+  /**
+   * @hostSuffix url host suffix, default value is .chargebee.com
+   */
+  hostSuffix?: string;
+};
+declare module 'chargebee' {
+  export default class Chargebee {
+    constructor(config: Config);
+    address: Address.AddressResource;
+    attachedItem: AttachedItem.AttachedItemResource;
+    businessEntity: BusinessEntity.BusinessEntityResource;
+    card: Card.CardResource;
+    comment: Comment.CommentResource;
+    coupon: Coupon.CouponResource;
+    couponCode: CouponCode.CouponCodeResource;
+    couponSet: CouponSet.CouponSetResource;
+    creditNote: CreditNote.CreditNoteResource;
+    currency: Currency.CurrencyResource;
+    customer: Customer.CustomerResource;
+    customerEntitlement: CustomerEntitlement.CustomerEntitlementResource;
+    differentialPrice: DifferentialPrice.DifferentialPriceResource;
+    entitlement: Entitlement.EntitlementResource;
+    entitlementOverride: EntitlementOverride.EntitlementOverrideResource;
+    estimate: Estimate.EstimateResource;
+    event: Event.EventResource;
+    export: Export.ExportResource;
+    feature: Feature.FeatureResource;
+    gift: Gift.GiftResource;
+    hostedPage: HostedPage.HostedPageResource;
+    inAppSubscription: InAppSubscription.InAppSubscriptionResource;
+    invoice: Invoice.InvoiceResource;
+    item: Item.ItemResource;
+    itemEntitlement: ItemEntitlement.ItemEntitlementResource;
+    itemFamily: ItemFamily.ItemFamilyResource;
+    itemPrice: ItemPrice.ItemPriceResource;
+    nonSubscription: NonSubscription.NonSubscriptionResource;
+    order: Order.OrderResource;
+    paymentIntent: PaymentIntent.PaymentIntentResource;
+    paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
+    paymentSource: PaymentSource.PaymentSourceResource;
+    paymentVoucher: PaymentVoucher.PaymentVoucherResource;
+    portalSession: PortalSession.PortalSessionResource;
+    priceVariant: PriceVariant.PriceVariantResource;
+    pricingPageSession: PricingPageSession.PricingPageSessionResource;
+    promotionalCredit: PromotionalCredit.PromotionalCreditResource;
+    purchase: Purchase.PurchaseResource;
+    quote: Quote.QuoteResource;
+    ramp: Ramp.RampResource;
+    resourceMigration: ResourceMigration.ResourceMigrationResource;
+    siteMigrationDetail: SiteMigrationDetail.SiteMigrationDetailResource;
+    subscription: Subscription.SubscriptionResource;
+    subscriptionEntitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;
+    timeMachine: TimeMachine.TimeMachineResource;
+    transaction: Transaction.TransactionResource;
+    unbilledCharge: UnbilledCharge.UnbilledChargeResource;
+    usage: Usage.UsageResource;
+    virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
+  }
+}

package/types/resources/Address.d.ts

@@ -0,0 +1,71 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Address {
+    label: string;
+    first_name?: string;
+    last_name?: string;
+    email?: string;
+    company?: string;
+    phone?: string;
+    addr?: string;
+    extended_addr?: string;
+    extended_addr2?: string;
+    city?: string;
+    state_code?: string;
+    state?: string;
+    country?: string;
+    zip?: string;
+    validation_status?: ValidationStatusEnum;
+    subscription_id: string;
+  }
+
+  export namespace Address {
+    export class AddressResource {
+      retrieve(
+        input: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      address: Address;
+    }
+
+    export interface UpdateResponse {
+      address: Address;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface RetrieveInputParam {
+      subscription_id: string;
+      label: string;
+    }
+    export interface UpdateInputParam {
+      subscription_id: string;
+      label: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      addr?: string;
+      extended_addr?: string;
+      extended_addr2?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+  }
+}

package/types/resources/AdvanceInvoiceSchedule.d.ts

@@ -0,0 +1,29 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface AdvanceInvoiceSchedule {
+    id: string;
+    schedule_type?: 'fixed_intervals' | 'specific_dates';
+    fixed_interval_schedule?: AdvanceInvoiceSchedule.FixedIntervalSchedule;
+    specific_dates_schedule?: AdvanceInvoiceSchedule.SpecificDatesSchedule;
+  }
+
+  export namespace AdvanceInvoiceSchedule {
+    export interface FixedIntervalSchedule {
+      end_schedule_on?: EndScheduleOnEnum;
+      number_of_occurrences?: number;
+      days_before_renewal?: number;
+      end_date?: number;
+      created_at: number;
+      terms_to_charge?: number;
+    }
+    export interface SpecificDatesSchedule {
+      terms_to_charge?: number;
+      date?: number;
+      created_at: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/AttachedItem.d.ts

@@ -0,0 +1,114 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface AttachedItem {
+    id: string;
+    parent_item_id: string;
+    item_id: string;
+    type: 'recommended' | 'mandatory' | 'optional';
+    status?: 'active' | 'archived' | 'deleted';
+    quantity?: number;
+    quantity_in_decimal?: string;
+    billing_cycles?: number;
+    charge_on_event: ChargeOnEventEnum;
+    charge_once: boolean;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    channel?: ChannelEnum;
+  }
+
+  export namespace AttachedItem {
+    export class AttachedItemResource {
+      create(
+        item_id: string,
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        attached_item_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      retrieve(
+        attached_item_id: string,
+        input: RetrieveInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        attached_item_id: string,
+        input: DeleteInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        item_id: string,
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      attached_item: AttachedItem;
+    }
+
+    export interface UpdateResponse {
+      attached_item: AttachedItem;
+    }
+
+    export interface RetrieveResponse {
+      attached_item: AttachedItem;
+    }
+
+    export interface DeleteResponse {
+      attached_item: AttachedItem;
+    }
+
+    export interface ListResponse {
+      list: { attached_item: AttachedItem }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      item_id: string;
+      type?: 'recommended' | 'mandatory' | 'optional';
+      billing_cycles?: number;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+    }
+    export interface UpdateInputParam {
+      parent_item_id: string;
+      type?: 'recommended' | 'mandatory' | 'optional';
+      billing_cycles?: number;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      charge_on_event?: ChargeOnEventEnum;
+      charge_once?: boolean;
+    }
+    export interface RetrieveInputParam {
+      parent_item_id: string;
+    }
+    export interface DeleteInputParam {
+      parent_item_id: string;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      item_id?: filter.String;
+      type?: filter.Enum;
+      item_type?: filter.Enum;
+      charge_on_event?: filter.Enum;
+      updated_at?: filter.Timestamp;
+    }
+  }
+}

package/types/resources/Attribute.d.ts

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

package/types/resources/BusinessEntity.d.ts

@@ -0,0 +1,64 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface BusinessEntity {
+    id: string;
+    name: string;
+    status: 'active' | 'inactive';
+    deleted: boolean;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+  }
+
+  export namespace BusinessEntity {
+    export class BusinessEntityResource {
+      createTransfers(
+        input: CreateTransfersInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateTransfersResponse>>;
+
+      getTransfers(
+        input?: GetTransfersInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<GetTransfersResponse>>;
+    }
+
+    export interface CreateTransfersResponse {
+      business_entity_transfer: BusinessEntityTransfer;
+    }
+
+    export interface GetTransfersResponse {
+      list: { business_entity_transfer: BusinessEntityTransfer }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateTransfersInputParam {
+      active_resource_ids: string[];
+      destination_business_entity_ids: string[] /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      source_business_entity_ids?: string[] /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      resource_types: string[];
+      reason_codes: string[];
+    }
+    export interface GetTransfersInputParam {
+      limit?: number;
+      offset?: string;
+      resource_type?: filter.String;
+      resource_id?: filter.String;
+      active_resource_id?: filter.String;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/BusinessEntityTransfer.d.ts

@@ -0,0 +1,15 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface BusinessEntityTransfer {
+    id: string;
+    resource_type: 'customer' | 'subscription';
+    resource_id: string;
+    active_resource_id: string;
+    destination_business_entity_id: string;
+    source_business_entity_id: string;
+    reason_code: 'correction';
+    created_at: number;
+  }
+}

package/types/resources/Card.d.ts

@@ -0,0 +1,171 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Card {
+    payment_source_id: string;
+    status: 'valid' | 'expiring' | 'expired';
+    gateway: GatewayEnum;
+    gateway_account_id?: string;
+    ref_tx_id?: string;
+    first_name?: string;
+    last_name?: string;
+    iin: string;
+    last4: string;
+    card_type?:
+      | 'visa'
+      | 'mastercard'
+      | 'american_express'
+      | 'discover'
+      | 'jcb'
+      | 'diners_club'
+      | 'bancontact'
+      | 'cmr_falabella'
+      | 'tarjeta_naranja'
+      | 'nativa'
+      | 'cencosud'
+      | 'cabal'
+      | 'argencard'
+      | 'elo'
+      | 'hipercard'
+      | 'carnet'
+      | 'rupay'
+      | 'maestro'
+      | 'dankort'
+      | 'cartes_bancaires'
+      | 'other'
+      | 'not_applicable';
+    funding_type:
+      | 'credit'
+      | 'debit'
+      | 'prepaid'
+      | 'not_known'
+      | 'not_applicable';
+    expiry_month: number;
+    expiry_year: number;
+    issuing_country?: string;
+    billing_addr1?: string;
+    billing_addr2?: string;
+    billing_city?: string;
+    billing_state_code?: string;
+    billing_state?: string;
+    billing_country?: string;
+    billing_zip?: string;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    ip_address?: string;
+    powered_by?:
+      | 'ideal'
+      | 'sofort'
+      | 'bancontact'
+      | 'giropay'
+      | 'card'
+      | 'latam_local_card'
+      | 'not_applicable';
+    customer_id: string;
+    masked_number?: string;
+  }
+
+  export namespace Card {
+    export class CardResource {
+      retrieve(
+        customer_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      updateCardForCustomer(
+        customer_id: string,
+        input: UpdateCardForCustomerInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateCardForCustomerResponse>>;
+
+      switchGatewayForCustomer(
+        customer_id: string,
+        input: SwitchGatewayForCustomerInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<SwitchGatewayForCustomerResponse>>;
+
+      copyCardForCustomer(
+        customer_id: string,
+        input: CopyCardForCustomerInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CopyCardForCustomerResponse>>;
+
+      deleteCardForCustomer(
+        customer_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteCardForCustomerResponse>>;
+    }
+
+    export interface RetrieveResponse {
+      card: Card;
+    }
+
+    export interface UpdateCardForCustomerResponse {
+      customer: Customer;
+      card: Card;
+    }
+
+    export interface SwitchGatewayForCustomerResponse {
+      customer: Customer;
+      card: Card;
+    }
+
+    export interface CopyCardForCustomerResponse {
+      third_party_payment_method: ThirdPartyPaymentMethod;
+    }
+
+    export interface DeleteCardForCustomerResponse {
+      customer: Customer;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface UpdateCardForCustomerInputParam {
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+
+      gateway?: GatewayEnum;
+      gateway_account_id?: string;
+      tmp_token?: string;
+      first_name?: string;
+      last_name?: string;
+      number: string;
+      expiry_month: number;
+      expiry_year: number;
+      cvv?: string;
+      billing_addr1?: string;
+      billing_addr2?: string;
+      billing_city?: string;
+      billing_state_code?: string;
+      billing_state?: string;
+      billing_zip?: string;
+      billing_country?: string /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      ip_address?: string;
+      customer?: CustomerUpdateCardForCustomerInputParam;
+    }
+    export interface SwitchGatewayForCustomerInputParam {
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+
+      gateway?: GatewayEnum;
+      gateway_account_id: string;
+    }
+    export interface CopyCardForCustomerInputParam {
+      gateway_account_id: string;
+    }
+    export interface CustomerUpdateCardForCustomerInputParam {
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      vat_number?: string;
+    }
+  }
+}