@selfcommunity/api-services 0.6.7-payments.148 → 0.6.7-payments.150

package/lib/cjs/constants/Endpoints.js

@@ -1585,11 +1585,15 @@ const Endpoints = {
      * Payments/Paywalls
      */
     GetContentProducts: {
-        url: (0, utils_1.urlReplacer)('/api/v2/payments/products/'),
+        url: (0, utils_1.urlReplacer)('/api/v2/payments/payment_product/'),
+        method: 'GET'
+    },
+    GetProduct: {
+        url: (0, utils_1.urlReplacer)('/api/v2/payments/payment_product/$(id)/'),
         method: 'GET'
     },
     GetProductPrices: {
-        url: (0, utils_1.urlReplacer)('/api/v2/payments/product/$(id)/prices/'),
+        url: (0, utils_1.urlReplacer)('/api/v2/payments/payment_product/$(id)/'),
         method: 'GET'
     },
     GetCheckoutSession: {
@@ -1607,6 +1611,10 @@ const Endpoints = {
     GetPaymentOrders: {
         url: (0, utils_1.urlReplacer)('/api/v2/payments/order/'),
         method: 'GET'
+    },
+    CreateCustomerPortalSession: {
+        url: (0, utils_1.urlReplacer)('/api/v2/payments/customer_portal_session/'),
+        method: 'POST'
     }
 };
 exports.default = Endpoints;

package/lib/cjs/services/payment/index.d.ts

@@ -1,8 +1,7 @@
-import { SCPaymentProduct, SCPaymentPrice } from '@selfcommunity/types';
 import { AxiosRequestConfig } from 'axios';
 import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { CheckoutCreateSessionParams, CheckoutSessionParams, ContentProductsParams } from '../../types/payment';
-import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail } from '@selfcommunity/types';
+import { CheckoutCreateSessionParams, CheckoutSessionParams, ContentProductsParams, CustomerPortalCreateSessionParams } from '../../types/payment';
+import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession } from '@selfcommunity/types';
 export interface PaymentApiClientInterface {
     /**
      * Get paywall products related to an object of type <content_type> and id <content_id>
@@ -10,6 +9,12 @@ export interface PaymentApiClientInterface {
      * @param config
      */
     getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    /**
+     * Get product
+     * @param id
+     * @param config
+     */
+    getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
     /**
      * Get prices related to a product
      * @param id
@@ -34,13 +39,19 @@ export interface PaymentApiClientInterface {
      * @param data
      * @param config
      */
-    checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
     /**
-     * This endpoint retrive order history of authenticated user
+     * This endpoint retrieve order history of authenticated user
      * @param params
      * @param config
      */
     getPaymentsOrder(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
+    /**
+     * This endpoint retrieve customer portal
+     * @param data
+     * @param config
+     */
+    getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
 }
 /**
  * Contains all the endpoints needed to manage payments.
@@ -52,6 +63,12 @@ export declare class PaymentApiClient {
      * @param config
      */
     static getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    /**
+     * This endpoint retrieves a specific payment product.
+     * @param id
+     * @param config
+     */
+    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
     /**
      * This endpoint retrieves all the prices related to a product
      * @param id
@@ -76,13 +93,19 @@ export declare class PaymentApiClient {
      * @param data
      * @param config
      */
-    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
     /**
      * This endpoint retrive order history of authenticated user
      * @param params
      * @param config
      */
     static getPaymentsOrder(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
+    /**
+     * This endpoint retrive customer portal
+     * @param data
+     * @param config
+     */
+    static getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
 }
 /**
  *
@@ -121,9 +144,11 @@ export declare class PaymentApiClient {
  */
 export default class PaymentService {
     static getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
     static getPaymentProductPrices(id: number | string, params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
     static checkoutCreateSession(data: CheckoutCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSession>;
     static getCheckoutSession(params?: CheckoutSessionParams, config?: AxiosRequestConfig): Promise<SCCheckoutSessionDetail>;
-    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
     static getPaymentsOrder(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
+    static getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
 }

package/lib/cjs/services/payment/index.js

@@ -18,6 +18,14 @@ class PaymentApiClient {
         const p = (0, url_1.urlParams)(params);
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetContentProducts.url({})}?${p.toString()}`, method: Endpoints_1.default.GetContentProducts.method }));
     }
+    /**
+     * This endpoint retrieves a specific payment product.
+     * @param id
+     * @param config
+     */
+    static getPaymentProduct(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetProduct.url({ id }), method: Endpoints_1.default.GetProduct.method }));
+    }
     /**
      * This endpoint retrieves all the prices related to a product
      * @param id
@@ -61,6 +69,14 @@ class PaymentApiClient {
     static getPaymentsOrder(params, config) {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetPaymentOrders.url({}), method: Endpoints_1.default.GetPaymentOrders.method }));
     }
+    /**
+     * This endpoint retrive customer portal
+     * @param data
+     * @param config
+     */
+    static getPaymentsCustomerPortal(data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreateCustomerPortalSession.url({}), method: Endpoints_1.default.CreateCustomerPortalSession.method, data }));
+    }
 }
 exports.PaymentApiClient = PaymentApiClient;
 /**
@@ -104,6 +120,11 @@ class PaymentService {
             return PaymentApiClient.getPaymentProducts(params, config);
         });
     }
+    static getPaymentProduct(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return PaymentApiClient.getPaymentProduct(id, config);
+        });
+    }
     static getPaymentProductPrices(id, params, config) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             return PaymentApiClient.getPaymentProductPrices(id, params, config);
@@ -127,5 +148,8 @@ class PaymentService {
     static getPaymentsOrder(params, config) {
         return PaymentApiClient.getPaymentsOrder(params, config);
     }
+    static getPaymentsCustomerPortal(data, config) {
+        return PaymentApiClient.getPaymentsCustomerPortal(data, config);
+    }
 }
 exports.default = PaymentService;

package/lib/cjs/types/payment.d.ts

@@ -30,6 +30,10 @@ export interface CheckoutCreateSessionParams {
      * Price id
      */
     payment_price_id: number;
+    /**
+     *	Return url
+     */
+    return_url?: string;
 }
 export interface CheckoutSessionParams {
     /**
@@ -37,3 +41,9 @@ export interface CheckoutSessionParams {
      */
     session_id: string;
 }
+export interface CustomerPortalCreateSessionParams {
+    /**
+     *	Return url
+     */
+    return_url?: string;
+}

package/lib/esm/constants/Endpoints.js

@@ -1583,11 +1583,15 @@ const Endpoints = {
      * Payments/Paywalls
      */
     GetContentProducts: {
-        url: urlReplacer('/api/v2/payments/products/'),
+        url: urlReplacer('/api/v2/payments/payment_product/'),
+        method: 'GET'
+    },
+    GetProduct: {
+        url: urlReplacer('/api/v2/payments/payment_product/$(id)/'),
         method: 'GET'
     },
     GetProductPrices: {
-        url: urlReplacer('/api/v2/payments/product/$(id)/prices/'),
+        url: urlReplacer('/api/v2/payments/payment_product/$(id)/'),
         method: 'GET'
     },
     GetCheckoutSession: {
@@ -1605,6 +1609,10 @@ const Endpoints = {
     GetPaymentOrders: {
         url: urlReplacer('/api/v2/payments/order/'),
         method: 'GET'
+    },
+    CreateCustomerPortalSession: {
+        url: urlReplacer('/api/v2/payments/customer_portal_session/'),
+        method: 'POST'
     }
 };
 export default Endpoints;

package/lib/esm/services/payment/index.d.ts

@@ -1,8 +1,7 @@
-import { SCPaymentProduct, SCPaymentPrice } from '@selfcommunity/types';
 import { AxiosRequestConfig } from 'axios';
 import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { CheckoutCreateSessionParams, CheckoutSessionParams, ContentProductsParams } from '../../types/payment';
-import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail } from '@selfcommunity/types';
+import { CheckoutCreateSessionParams, CheckoutSessionParams, ContentProductsParams, CustomerPortalCreateSessionParams } from '../../types/payment';
+import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession } from '@selfcommunity/types';
 export interface PaymentApiClientInterface {
     /**
      * Get paywall products related to an object of type <content_type> and id <content_id>
@@ -10,6 +9,12 @@ export interface PaymentApiClientInterface {
      * @param config
      */
     getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    /**
+     * Get product
+     * @param id
+     * @param config
+     */
+    getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
     /**
      * Get prices related to a product
      * @param id
@@ -34,13 +39,19 @@ export interface PaymentApiClientInterface {
      * @param data
      * @param config
      */
-    checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
     /**
-     * This endpoint retrive order history of authenticated user
+     * This endpoint retrieve order history of authenticated user
      * @param params
      * @param config
      */
     getPaymentsOrder(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
+    /**
+     * This endpoint retrieve customer portal
+     * @param data
+     * @param config
+     */
+    getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
 }
 /**
  * Contains all the endpoints needed to manage payments.
@@ -52,6 +63,12 @@ export declare class PaymentApiClient {
      * @param config
      */
     static getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    /**
+     * This endpoint retrieves a specific payment product.
+     * @param id
+     * @param config
+     */
+    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
     /**
      * This endpoint retrieves all the prices related to a product
      * @param id
@@ -76,13 +93,19 @@ export declare class PaymentApiClient {
      * @param data
      * @param config
      */
-    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
     /**
      * This endpoint retrive order history of authenticated user
      * @param params
      * @param config
      */
     static getPaymentsOrder(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
+    /**
+     * This endpoint retrive customer portal
+     * @param data
+     * @param config
+     */
+    static getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
 }
 /**
  *
@@ -121,9 +144,11 @@ export declare class PaymentApiClient {
  */
 export default class PaymentService {
     static getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
     static getPaymentProductPrices(id: number | string, params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
     static checkoutCreateSession(data: CheckoutCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSession>;
     static getCheckoutSession(params?: CheckoutSessionParams, config?: AxiosRequestConfig): Promise<SCCheckoutSessionDetail>;
-    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
     static getPaymentsOrder(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
+    static getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
 }

package/lib/esm/services/payment/index.js

@@ -15,6 +15,14 @@ export class PaymentApiClient {
         const p = urlParams(params);
         return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetContentProducts.url({})}?${p.toString()}`, method: Endpoints.GetContentProducts.method }));
     }
+    /**
+     * This endpoint retrieves a specific payment product.
+     * @param id
+     * @param config
+     */
+    static getPaymentProduct(id, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetProduct.url({ id }), method: Endpoints.GetProduct.method }));
+    }
     /**
      * This endpoint retrieves all the prices related to a product
      * @param id
@@ -58,6 +66,14 @@ export class PaymentApiClient {
     static getPaymentsOrder(params, config) {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetPaymentOrders.url({}), method: Endpoints.GetPaymentOrders.method }));
     }
+    /**
+     * This endpoint retrive customer portal
+     * @param data
+     * @param config
+     */
+    static getPaymentsCustomerPortal(data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CreateCustomerPortalSession.url({}), method: Endpoints.CreateCustomerPortalSession.method, data }));
+    }
 }
 /**
  *
@@ -100,6 +116,11 @@ export default class PaymentService {
             return PaymentApiClient.getPaymentProducts(params, config);
         });
     }
+    static getPaymentProduct(id, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return PaymentApiClient.getPaymentProduct(id, config);
+        });
+    }
     static getPaymentProductPrices(id, params, config) {
         return __awaiter(this, void 0, void 0, function* () {
             return PaymentApiClient.getPaymentProductPrices(id, params, config);
@@ -123,4 +144,7 @@ export default class PaymentService {
     static getPaymentsOrder(params, config) {
         return PaymentApiClient.getPaymentsOrder(params, config);
     }
+    static getPaymentsCustomerPortal(data, config) {
+        return PaymentApiClient.getPaymentsCustomerPortal(data, config);
+    }
 }

package/lib/esm/types/payment.d.ts

@@ -30,6 +30,10 @@ export interface CheckoutCreateSessionParams {
      * Price id
      */
     payment_price_id: number;
+    /**
+     *	Return url
+     */
+    return_url?: string;
 }
 export interface CheckoutSessionParams {
     /**
@@ -37,3 +41,9 @@ export interface CheckoutSessionParams {
      */
     session_id: string;
 }
+export interface CustomerPortalCreateSessionParams {
+    /**
+     *	Return url
+     */
+    return_url?: string;
+}