chargebee 3.0.1 → 3.1.0

package/types/resources/Feature.d.ts

@@ -0,0 +1,142 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Feature {
+    id: string;
+    name: string;
+    description?: string;
+    status?: 'active' | 'archived' | 'draft';
+    type?: 'switch' | 'custom' | 'quantity' | 'range';
+    unit?: string;
+    resource_version?: number;
+    updated_at?: number;
+    created_at: number;
+    levels?: Feature.Level[];
+  }
+
+  export namespace Feature {
+    export class FeatureResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        feature_id: string,
+        input?: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      retrieve(
+        feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      activate(
+        feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateResponse>>;
+
+      archive(
+        feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ArchiveResponse>>;
+
+      reactivate(
+        feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReactivateResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { feature: Feature }[];
+      next_offset?: string;
+    }
+
+    export interface CreateResponse {
+      feature: Feature;
+    }
+
+    export interface UpdateResponse {
+      feature: Feature;
+    }
+
+    export interface RetrieveResponse {
+      feature: Feature;
+    }
+
+    export interface DeleteResponse {
+      feature: Feature;
+    }
+
+    export interface ActivateResponse {
+      feature: Feature;
+    }
+
+    export interface ArchiveResponse {
+      feature: Feature;
+    }
+
+    export interface ReactivateResponse {
+      feature: Feature;
+    }
+
+    export interface Level {
+      name?: string;
+      value: string;
+      level: number;
+      is_unlimited: boolean;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      name?: filter.String;
+      id?: filter.String;
+      status?: filter.Enum;
+      type?: filter.Enum;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface CreateInputParam {
+      id?: string;
+      name: string;
+      description?: string;
+      type?: 'switch' | 'custom' | 'quantity' | 'range';
+      unit?: string;
+      levels?: LevelsCreateInputParam[];
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      description?: string;
+      unit?: string;
+      levels?: LevelsUpdateInputParam[];
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface LevelsCreateInputParam {
+      name?: string;
+      value?: string;
+      is_unlimited?: boolean;
+      level?: number;
+    }
+    export interface LevelsUpdateInputParam {
+      name?: string;
+      value?: string;
+      is_unlimited?: boolean;
+      level?: number;
+    }
+  }
+}

package/types/resources/GatewayErrorDetail.d.ts

@@ -0,0 +1,20 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface GatewayErrorDetail {
+    request_id?: string;
+    error_category?: string;
+    error_code?: string;
+    error_message?: string;
+    decline_code?: string;
+    decline_message?: string;
+    network_error_code?: string;
+    network_error_message?: string;
+    error_field?: string;
+    recommendation_code?: string;
+    recommendation_message?: string;
+    processor_error_code?: string;
+    processor_error_message?: string;
+  }
+}

package/types/resources/Gift.d.ts

@@ -0,0 +1,296 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Gift {
+    id: string;
+    status: 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired';
+    scheduled_at?: number;
+    auto_claim: boolean;
+    no_expiry: boolean;
+    claim_expiry_date?: number;
+    resource_version?: number;
+    updated_at?: number;
+    gifter: Gift.Gifter;
+    gift_receiver: Gift.GiftReceiver;
+    gift_timelines?: Gift.GiftTimeline[];
+  }
+
+  export namespace Gift {
+    export class GiftResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      createForItems(
+        input: CreateForItemsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateForItemsResponse>>;
+
+      retrieve(
+        gift_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      claim(
+        gift_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ClaimResponse>>;
+
+      cancel(
+        gift_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CancelResponse>>;
+
+      updateGift(
+        gift_id: string,
+        input: UpdateGiftInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateGiftResponse>>;
+    }
+
+    export interface CreateResponse {
+      gift: Gift;
+      subscription: Subscription;
+      invoice?: Invoice;
+    }
+
+    export interface CreateForItemsResponse {
+      gift: Gift;
+      subscription: Subscription;
+      invoice?: Invoice;
+    }
+
+    export interface RetrieveResponse {
+      gift: Gift;
+      subscription: Subscription;
+    }
+
+    export interface ListResponse {
+      list: { gift: Gift; subscription: Subscription }[];
+      next_offset?: string;
+    }
+
+    export interface ClaimResponse {
+      gift: Gift;
+      subscription: Subscription;
+    }
+
+    export interface CancelResponse {
+      gift: Gift;
+      subscription: Subscription;
+    }
+
+    export interface UpdateGiftResponse {
+      gift: Gift;
+      subscription: Subscription;
+    }
+
+    export interface Gifter {
+      customer_id: string;
+      invoice_id?: string;
+      signature?: string;
+      note?: string;
+    }
+    export interface GiftReceiver {
+      customer_id: string;
+      subscription_id: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+    }
+    export interface GiftTimeline {
+      status: 'scheduled' | 'unclaimed' | 'claimed' | 'cancelled' | 'expired';
+      occurred_at?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      scheduled_at?: number;
+      auto_claim?: boolean;
+      no_expiry?: boolean;
+      claim_expiry_date?: number;
+      coupon_ids?: string[];
+      gifter?: GifterCreateInputParam;
+      gift_receiver?: GiftReceiverCreateInputParam;
+      payment_intent?: PaymentIntentCreateInputParam;
+      shipping_address?: ShippingAddressCreateInputParam;
+      subscription?: SubscriptionCreateInputParam;
+      addons?: AddonsCreateInputParam[];
+    }
+    export interface CreateForItemsInputParam {
+      scheduled_at?: number;
+      auto_claim?: boolean;
+      no_expiry?: boolean;
+      claim_expiry_date?: number;
+      coupon_ids?: string[];
+      gifter?: GifterCreateForItemsInputParam;
+      gift_receiver?: GiftReceiverCreateForItemsInputParam;
+      payment_intent?: PaymentIntentCreateForItemsInputParam;
+      shipping_address?: ShippingAddressCreateForItemsInputParam;
+      subscription_items?: SubscriptionItemsCreateForItemsInputParam[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      gift_receiver?: GiftReceiverGiftListInputParam;
+      gifter?: GifterGiftListInputParam;
+      status?: filter.Enum;
+    }
+    export interface UpdateGiftInputParam {
+      scheduled_at: number;
+      comment?: string;
+    }
+    export interface GiftReceiverCreateInputParam {
+      customer_id: string;
+      first_name: string;
+      last_name: string;
+      email: string;
+    }
+    export interface GifterCreateInputParam {
+      customer_id: string;
+      signature: string;
+      note?: string;
+      payment_src_id?: string;
+    }
+    export interface ShippingAddressCreateInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+    export interface PaymentIntentCreateInputParam {
+      id?: string;
+      gateway_account_id?: string;
+      gw_token?: 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';
+      reference_id?: string;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      gw_payment_method_id?: string;
+      additional_information?: any;
+    }
+    export interface SubscriptionCreateInputParam {
+      plan_id: string;
+      plan_quantity?: number;
+      plan_quantity_in_decimal?: string;
+    }
+
+    export interface AddonsCreateInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+    }
+    export interface GiftReceiverCreateForItemsInputParam {
+      customer_id: string;
+      first_name: string;
+      last_name: string;
+      email: string;
+    }
+    export interface GifterCreateForItemsInputParam {
+      customer_id: string;
+      signature: string;
+      note?: string;
+      payment_src_id?: string;
+    }
+    export interface ShippingAddressCreateForItemsInputParam {
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
+    export interface PaymentIntentCreateForItemsInputParam {
+      id?: string;
+      gateway_account_id?: string;
+      gw_token?: 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';
+      reference_id?: string;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      gw_payment_method_id?: string;
+      additional_information?: any;
+    }
+
+    export interface SubscriptionItemsCreateForItemsInputParam {
+      item_price_id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+    }
+    export interface GifterGiftListInputParam {
+      customer_id?: filter.String;
+    }
+    export interface GiftReceiverGiftListInputParam {
+      email?: filter.String;
+      customer_id?: filter.String;
+    }
+  }
+}

package/types/resources/Hierarchy.d.ts

@@ -0,0 +1,12 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Hierarchy {
+    customer_id: string;
+    parent_id?: string;
+    payment_owner_id: string;
+    invoice_owner_id: string;
+    children_ids?: string[];
+  }
+}