chargebee 2.41.0 → 3.0.0-beta.2

package/types/resources/PortalSession.d.ts

@@ -1,224 +1,88 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface PortalSession {
-    
-    /**
-      * @description Unique identifier for the portal session.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description Unique pre-authenticated portal session token to access customer portal directly.
-
-      */
-    
-    token:string;
-    
-    /**
-      * @description Unique URL for accessing the customer portal. Once accessed, this cannot be reused.
-
-      */
-    
-    access_url:string;
-    
-    /**
-      * @description URL to redirect when the user logs out from the portal.
-
-      */
-    
-    redirect_url?:string;
-    
-    /**
-      * @description Indicates the current status of the portal session. \* created - Indicates that the portal session is just created and not yet accessed by the user. \* logged_out - Indicates that the portal session is logged out either by user or via API. \* not_yet_activated - Indicates that the portal session is created and not yet activated for the customer to allow access to your website. This is applicable when you use Chargebee&#x27;s authentication for your website \* activated - Indicates that the portal session is activated for the customer to allow access to your website. This is applicable when you use Chargebee&#x27;s authentication for your website. \* logged_in - Indicates that the portal session URL has been accessed by the user and the session is active.
-
-      */
-    
-    status:'not_yet_activated' | 'created' | 'logged_in' | 'logged_out' | 'activated';
-    
-    /**
-      * @description Timestamp indicating when this portal session was generated.
-
-      */
-    
-    created_at:number;
-    
-    /**
-      * @description Timestamp indicating when the access URL will expire. Once expired, the URL cannot be used to login into the portal.
-
-      */
-    
-    expires_at?:number;
-    
-    /**
-      * @description Identifier of the customer.
-
-      */
-    
-    customer_id:string;
-    
-    /**
-      * @description Timestamp indicating when this portal session URL was accessed by the user.
-
-      */
-    
-    login_at?:number;
-    
-    /**
-      * @description Timestamp indicating when this portal session was logged out either by user or via API.
-
-      */
-    
-    logout_at?:number;
-    
-    /**
-      * @description IP Address from which the portal session URL was accessed.
-
-      */
-    
-    login_ipaddress?:string;
-    
-    /**
-      * @description IP Address from which the portal session was logged out either by user or via API.
-
-      */
-    
-    logout_ipaddress?:string;
-    
-    /**
-      * @description The list of customers for this session
-
-      */
-    
-    linked_customers?:PortalSession.LinkedCustomer[];
+    id: string;
+    token: string;
+    access_url: string;
+    redirect_url?: string;
+    status:
+      | 'created'
+      | 'logged_in'
+      | 'logged_out'
+      | 'not_yet_activated'
+      | 'activated';
+    created_at: number;
+    expires_at?: number;
+    customer_id: string;
+    login_at?: number;
+    logout_at?: number;
+    login_ipaddress?: string;
+    logout_ipaddress?: string;
+    linked_customers?: PortalSession.LinkedCustomer[];
   }
-  export namespace PortalSession {
-    export class PortalSessionResource {  
-      /**
-        * @description Creates a portal session for a customer. The session resource in the response contains the access URL. Forward the customer to that access URL. If you would like to logout the customer later via API call, you need to store the id of the portal session resource returned by this API. While creating a session, you also need to pass the redirect URL to which your customers will be sent to upon logout from the portal UI.
-
-        */
-      
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-       
-      /**
-        * @description This API retrieves a portal session using &#x60;portal_session_id&#x60; as a path parameter.
-
-        */
-      
-      retrieve(portal_session_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description Logs out the portal session. Typically this should be called when customers logout of your application.
-
-If this API is called for a Portal Session that currently is in :
-
-* &quot;created&quot; status, the session status will be marked as &quot;logged_out&quot; and the access URL will become invalid.
-* &quot;logged_in&quot; status, the session status will be marked as &quot;logged_out&quot; and customer will not be able to use that session.
-* &quot;logged_out&quot; status, this will return normally without changing any attribute of this resource.
-
-        */
-      
-      logout(portal_session_id:string):ChargebeeRequest<LogoutResponse>;
-       
-      /**
-        * @description When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return_url** should be sent as below:
 
-* **auth_session_id** - this should be sent as part of the endpoint.
-* **auth_session_token** - this should be sent as value for the input parameter **token**.
-
-
-
-**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
-
-        */
-      
-      activate(portal_session_id:string, input:ActivateInputParam):ChargebeeRequest<ActivateResponse>;
-    }
-    export interface CreateResponse {  
-       portal_session:PortalSession;
+  export namespace PortalSession {
+    export class PortalSessionResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        portal_session_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      logout(
+        portal_session_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<LogoutResponse>>;
+
+      activate(
+        portal_session_id: string,
+        input: ActivateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateResponse>>;
     }
-    export interface CreateInputParam {
-       
-      /**
-        * @description URL to redirect when the user logs out from the portal.
-
-        */
-       
-      redirect_url?:string;
-       
-      /**
-        * @description By default access_url redirects the customer to the portal home page. If you would like to redirect the customer to a different URL, you can use this parameter to do so.  
 
-**Note:** This parameter is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.
+    export interface CreateResponse {
+      portal_session: PortalSession;
+    }
 
-        */
-       
-      forward_url?:string;
-       
-      /**
-        * @description Parameters for customer
+    export interface RetrieveResponse {
+      portal_session: PortalSession;
+    }
 
-        */
-       
-      customer:{id:string};
+    export interface LogoutResponse {
+      portal_session: PortalSession;
     }
-    export interface RetrieveResponse {  
-       portal_session:PortalSession;
+
+    export interface ActivateResponse {
+      portal_session: PortalSession;
     }
-    
-    export interface LogoutResponse {  
-       portal_session:PortalSession;
+
+    export interface LinkedCustomer {
+      customer_id: string;
+      email?: string;
+      has_billing_address: boolean;
+      has_payment_method: boolean;
+      has_active_subscription: boolean;
     }
-    
-    export interface ActivateResponse {  
-       portal_session:PortalSession;
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      redirect_url?: string;
+      forward_url?: string;
+      customer?: CustomerCreateInputParam;
     }
     export interface ActivateInputParam {
-       
-      /**
-        * @description Unique pre-authenticated portal session token to access customer portal directly.
-
-        */
-       
-      token:string;
+      token: string;
     }
-    export interface LinkedCustomer {  
-         /**
-          * @description Identifier of the customer.
-
-          */
-       
-      customer_id:string;
-       
-         /**
-          * @description Email of the customer. Configured email notifications will be sent to this email.
-
-          */
-       
-      email?:string;
-       
-         /**
-          * @description The customer has billing address.
-
-          */
-       
-      has_billing_address:boolean;
-       
-         /**
-          * @description The customer has payment method.
-
-          */
-       
-      has_payment_method:boolean;
-       
-         /**
-          * @description The customer has atleast one active subscription.
-
-          */
-       
-      has_active_subscription:boolean;
+    export interface CustomerCreateInputParam {
+      id: string;
     }
   }
-}
+}

package/types/resources/PriceVariant.d.ts

@@ -1,300 +1,112 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface PriceVariant {
-    
-    /**
-      * @description The unique and immutable identifier of the price variant.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description A unique name of the price variant.
-
-      */
-    
-    name:string;
-    
-    /**
-      * @description A unique display name for the price variant.
-
-      */
-    
-    external_name?:string;
-    
-    /**
-      * @description Description of the price variant.
-
-      */
-    variant_group?:string;
-    description?:string;
-    
-    /**
-      * @description Status of a price variant. \* active - Active price variant. This price variant can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). \* deleted - Deleted price variant. The &#x60;id&#x60; and &#x60;name&#x60; of the deleted price variant can be reused. \* archived - Archived price variant. This price variant is no longer &#x60;active&#x60; and cannot be attached to new [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). Existing item prices that already have this price variant attached will continue to remain as is.
-
-      */
-    
-    status?:'active' | 'archived' | 'deleted';
-    
-    /**
-      * @description Timestamp indicating when this price variant is created.
-
-      */
-    
-    created_at:number;
-    
-    /**
-      * @description The version number of this resource. For every change made to the resource, &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds.
-
-      */
-    
-    resource_version?:number;
-    
-    /**
-      * @description Timestamp indicating when this price variant was last updated.
-
-      */
-    
-    updated_at?:number;
-    
-    /**
-      * @description Timestamp indicating when this price variant was archived.
-
-      */
-    
-    archived_at?:number;
-    
-    /**
-      * @description The list of price variant attribute values.
-
-Attributes can be used to store additional information about the price variant. For example, for a price variant called &#x27;Germany&#x27;, the attributes can be &#x27;Country&#x27;:&#x27;Germany&#x27;, &#x27;City&#x27;:&#x27;Berlin&#x27; and so on.
-
-      */
-    
-    attributes?:PriceVariant.Attribute[];
+    id: string;
+    name: string;
+    external_name?: string;
+    variant_group?: string;
+    description?: string;
+    status?: 'active' | 'archived' | 'deleted';
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    archived_at?: number;
+    attributes?: PriceVariant.Attribute[];
   }
-  export namespace PriceVariant {
-    export class PriceVariantResource {  
-      /**
-        * @description This endpoint allows the creation of a new price variant that can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl).
-
-        */
-      
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-       
-      /**
-        * @description This endpoint retrieves the details of a specific price variant using its unique identifier.
 
-        */
-      
-      retrieve(price_variant_id:string):ChargebeeRequest<RetrieveResponse>;
-       
-      /**
-        * @description This endpoint modifies the details of an existing price variant.
-
-        */
-      
-      update(price_variant_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
-       
-      /**
-        * @description Deletes the price variant. This is not allowed if price variant is attached to any [item price](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). Once deleted, the &#x60;id&#x60; and &#x60;name&#x60; of the price variant can be reused.
-
-        */
-      
-      delete(price_variant_id:string):ChargebeeRequest<DeleteResponse>;
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-      
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
-    }
-    export interface CreateResponse {  
-       price_variant:PriceVariant;
+  export namespace PriceVariant {
+    export class PriceVariantResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        price_variant_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        price_variant_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        price_variant_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
     }
-    export interface CreateInputParam {
-       
-      /**
-        * @description The unique and immutable identifier of the price variant.
-
-        */
-       
-      id:string;
-       
-      /**
-        * @description A unique name of the price variant.
-
-        */
-       
-      name:string;
-       
-      /**
-        * @description A unique display name for the price variant.
-
-        */
-       
-      external_name?:string;
-       
-      /**
-        * @description Description of the price variant.
-
-        */
-       
-      description?:string;
-       
-      /**
-        * @description The list of price variant attribute values.
-
-Attributes can be used to store additional information about the price variant. For example, for a price variant called &#x27;Germany&#x27;, the attributes can be &#x27;Country&#x27;:&#x27;Germany&#x27;, &#x27;City&#x27;:&#x27;Berlin&#x27; and so on.
-
-        */
-       
-      attributes:{name:string,value:string}[];
 
-      variant_group?:string;
+    export interface CreateResponse {
+      price_variant: PriceVariant;
     }
-    export interface RetrieveResponse {  
-       price_variant:PriceVariant;
-    }
-    
-    export interface UpdateResponse {  
-       price_variant:PriceVariant;
-    }
-    export interface UpdateInputParam {
-       
-      /**
-        * @description A unique name of the price variant.
-
-        */
-       
-      name?:string;
-       
-      /**
-        * @description A unique display name for the price variant.
-
-        */
-       
-      external_name?:string;
-       
-      /**
-        * @description Description of the price variant.
-
-        */
-       
-      description?:string;
-
-      variant_group?:string;
-       
-      /**
-        * @description Status of a price variant. \* active - Active price variant. This price variant can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). \* deleted - Deleted price variant. The &#x60;id&#x60; and &#x60;name&#x60; of the deleted price variant can be reused. \* archived - Archived price variant. This price variant is no longer &#x60;active&#x60; and cannot be attached to new [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). Existing item prices that already have this price variant attached will continue to remain as is.
 
-        */
-       
-      status?:'active' | 'archived';
-       
-      /**
-        * @description The list of price variant attribute values.
+    export interface RetrieveResponse {
+      price_variant: PriceVariant;
+    }
 
-Attributes can be used to store additional information about the price variant. For example, for a price variant called &#x27;Germany&#x27;, the attributes can be &#x27;Country&#x27;:&#x27;Germany&#x27;, &#x27;City&#x27;:&#x27;Berlin&#x27; and so on.
+    export interface UpdateResponse {
+      price_variant: PriceVariant;
+    }
 
-        */
-       
-      attributes:{name:string,value:string}[];
+    export interface DeleteResponse {
+      price_variant: PriceVariant;
     }
-    export interface DeleteResponse {  
-       price_variant:PriceVariant;
+
+    export interface ListResponse {
+      list: { price_variant: PriceVariant }[];
+      next_offset?: string;
     }
-    
-    export interface ListResponse {  
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
 
-        */
-       
-       list:{price_variant:PriceVariant}[];
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
+    export interface Attribute {
+      name: string;
+      value: string;
+    }
+    // REQUEST PARAMS
+    //---------------
 
-        */
-       
-       next_offset?:string;
+    export interface CreateInputParam {
+      id: string;
+      name: string;
+      external_name?: string;
+      description?: string;
+      variant_group?: string;
+      attributes?: AttributesCreateInputParam[];
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      external_name?: string;
+      description?: string;
+      variant_group?: string;
+      status?: 'active' | 'archived';
+      attributes?: AttributesUpdateInputParam[];
     }
     export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      offset?:string;
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      status?:{in?:string,is?:'active' | 'archived',is_not?:'active' | 'archived',not_in?:string};
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      created_at?:{after?:string,before?:string,between?:string,on?:string};
-       
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-        
-      sort_by?:{asc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at',desc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at'};
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      name?: filter.String;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
     }
-    export interface Attribute {  
-         /**
-          * @description Attribute name
-
-          */
-       
-      name:string;
-       
-         /**
-          * @description Attribute value
-
-          */
-       
-      value:string;
+    export interface AttributesCreateInputParam {
+      name: string;
+      value: string;
+    }
+    export interface AttributesUpdateInputParam {
+      name: string;
+      value: string;
     }
   }
-}
+}