chargebee 3.0.0 → 3.0.2

package/types/resources/PaymentIntent.d.ts

@@ -0,0 +1,178 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentIntent {
+    id: string;
+    status: 'inited' | 'in_progress' | 'authorized' | 'consumed' | 'expired';
+    currency_code?: string;
+    amount: number;
+    gateway_account_id: string;
+    expires_at: number;
+    reference_id?: string;
+    payment_method_type?:
+      | 'card'
+      | 'ideal'
+      | 'sofort'
+      | 'bancontact'
+      | 'google_pay'
+      | 'dotpay'
+      | 'giropay'
+      | 'apple_pay'
+      | 'upi'
+      | 'netbanking_emandates'
+      | 'paypal_express_checkout'
+      | 'direct_debit'
+      | 'boleto'
+      | 'venmo'
+      | 'amazon_payments'
+      | 'pay_to'
+      | 'faster_payments'
+      | 'sepa_instant_transfer'
+      | 'klarna_pay_now'
+      | 'online_banking_poland';
+    success_url?: string;
+    failure_url?: string;
+    created_at: number;
+    modified_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    customer_id: string;
+    gateway?: string;
+    active_payment_attempt?: PaymentIntent.PaymentAttempt;
+    business_entity_id?: string;
+  }
+
+  export namespace PaymentIntent {
+    export class PaymentIntentResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        payment_intent_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      retrieve(
+        payment_intent_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface CreateResponse {
+      payment_intent: PaymentIntent;
+    }
+
+    export interface UpdateResponse {
+      payment_intent: PaymentIntent;
+    }
+
+    export interface RetrieveResponse {
+      payment_intent: PaymentIntent;
+    }
+
+    export interface PaymentAttempt {
+      id?: string;
+      status:
+        | 'inited'
+        | 'requires_identification'
+        | 'requires_challenge'
+        | 'requires_redirection'
+        | 'authorized'
+        | 'refused'
+        | 'pending_authorization';
+      payment_method_type?:
+        | 'card'
+        | 'ideal'
+        | 'sofort'
+        | 'bancontact'
+        | 'google_pay'
+        | 'dotpay'
+        | 'giropay'
+        | 'apple_pay'
+        | 'upi'
+        | 'netbanking_emandates'
+        | 'paypal_express_checkout'
+        | 'direct_debit'
+        | 'boleto'
+        | 'venmo'
+        | 'amazon_payments'
+        | 'pay_to'
+        | 'faster_payments'
+        | 'sepa_instant_transfer'
+        | 'klarna_pay_now'
+        | 'online_banking_poland';
+      id_at_gateway?: string;
+      error_code?: string;
+      error_text?: string;
+      created_at: number;
+      modified_at: number;
+      error_detail?: GatewayErrorDetail;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      business_entity_id?: string;
+      customer_id?: string;
+      amount: number;
+      currency_code: string;
+      gateway_account_id?: string;
+      reference_id?: string;
+      payment_method_type?:
+        | 'card'
+        | 'ideal'
+        | 'sofort'
+        | 'bancontact'
+        | 'google_pay'
+        | 'dotpay'
+        | 'giropay'
+        | 'apple_pay'
+        | 'upi'
+        | 'netbanking_emandates'
+        | 'paypal_express_checkout'
+        | 'direct_debit'
+        | 'boleto'
+        | 'venmo'
+        | 'amazon_payments'
+        | 'pay_to'
+        | 'faster_payments'
+        | 'sepa_instant_transfer'
+        | 'klarna_pay_now'
+        | 'online_banking_poland';
+      success_url?: string;
+      failure_url?: string;
+    }
+    export interface UpdateInputParam {
+      amount?: number;
+      currency_code?: string;
+      gateway_account_id?: string;
+      payment_method_type?:
+        | 'card'
+        | 'ideal'
+        | 'sofort'
+        | 'bancontact'
+        | 'google_pay'
+        | 'dotpay'
+        | 'giropay'
+        | 'apple_pay'
+        | 'upi'
+        | 'netbanking_emandates'
+        | 'paypal_express_checkout'
+        | 'direct_debit'
+        | 'boleto'
+        | 'venmo'
+        | 'amazon_payments'
+        | 'pay_to'
+        | 'faster_payments'
+        | 'sepa_instant_transfer'
+        | 'klarna_pay_now'
+        | 'online_banking_poland';
+      success_url?: string;
+      failure_url?: string;
+    }
+  }
+}

package/types/resources/PaymentReferenceNumber.d.ts

@@ -0,0 +1,11 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentReferenceNumber {
+    id: string;
+    type: 'kid' | 'ocr' | 'frn' | 'fik' | 'swiss_reference';
+    number: string;
+    invoice_id?: string;
+  }
+}

package/types/resources/PaymentSchedule.d.ts

@@ -0,0 +1,28 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentSchedule {
+    id: string;
+    scheme_id: string;
+    entity_type: 'invoice';
+    entity_id: string;
+    amount?: number;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    currency_code?: string;
+    schedule_entries?: PaymentSchedule.ScheduleEntry[];
+  }
+
+  export namespace PaymentSchedule {
+    export interface ScheduleEntry {
+      id: string;
+      date: number;
+      amount: number;
+      status: 'posted' | 'payment_due' | 'paid';
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/PaymentScheduleEstimate.d.ts

@@ -0,0 +1,25 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentScheduleEstimate {
+    id: string;
+    scheme_id: string;
+    entity_type: 'invoice';
+    entity_id?: string;
+    amount: number;
+    currency_code?: string;
+    schedule_entries?: PaymentScheduleEstimate.ScheduleEntry[];
+  }
+
+  export namespace PaymentScheduleEstimate {
+    export interface ScheduleEntry {
+      id: string;
+      date: number;
+      amount: number;
+      status: 'posted' | 'payment_due' | 'paid';
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/PaymentScheduleScheme.d.ts

@@ -0,0 +1,62 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PaymentScheduleScheme {
+    id: string;
+    name?: string;
+    description?: string;
+    number_of_schedules: number;
+    period_unit: 'day' | 'week' | 'month';
+    period?: number;
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    preferred_schedules?: PaymentScheduleScheme.PreferredSchedule[];
+  }
+
+  export namespace PaymentScheduleScheme {
+    export class PaymentScheduleSchemeResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        payment_schedule_scheme_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        payment_schedule_scheme_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+    }
+
+    export interface CreateResponse {
+      payment_schedule_scheme: PaymentScheduleScheme;
+    }
+
+    export interface RetrieveResponse {
+      payment_schedule_scheme: PaymentScheduleScheme;
+    }
+
+    export interface DeleteResponse {
+      payment_schedule_scheme: PaymentScheduleScheme;
+    }
+
+    export interface PreferredSchedule {
+      period?: number;
+      amount_percentage?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      number_of_schedules: number;
+      period_unit: 'day' | 'week' | 'month';
+      period?: number;
+      description?: string;
+    }
+  }
+}