@selfcommunity/api-services 0.6.7-payments.175 → 0.7.0-alpha.0

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

@@ -1,65 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { SCCommunityType } from '@selfcommunity/types';
-export interface CommunityApiClientInterface {
-    /**
-     * Get list of communities. Used to get the payment products related to the community (aka paywalls)
-     * @param params
-     * @param config
-     */
-    getCommunities(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCommunityType>>;
-    /**
-     * Get Community
-     * @param id
-     * @param config
-     */
-    getCommunity(id: number | string, config?: AxiosRequestConfig): Promise<SCCommunityType>;
-}
-/**
- * Contains all the endpoints needed to manage payments.
- */
-export declare class CommunityApiClient {
-    /**
-     * Get list of communities. Used to get the payment products related to the community (aka paywalls)
-     * @param params
-     * @param config
-     */
-    static getCommunities(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCommunityType>>;
-    /**
-     * Get Community
-     * @param id
-     * @param config
-     */
-    static getCommunity(id: number | string, config?: AxiosRequestConfig): Promise<SCCommunityType>;
-}
-/**
- *
- :::tip Community service can be used in the following way:
-
- ```jsx
- 1. Import the service from our library:
-
- import {CommunityService} from "@selfcommunity/api-services";
- ```
- ```jsx
- 2. Create a function and put the service inside it!
- The async function `getCommunities` will return the events matching the search query.
-
- async getCommunities() {
-         return await CommunityService.getCommunities({...});
-        }
- ```
- If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
-
- 1. Declare it(or declare them, it is possible to add multiple params)
-
- const headers = headers: {Authorization: `Bearer ${yourToken}`}
-
- 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
- ```
- :::
- */
-export default class CommunityService {
-    static getCommunities(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCommunityType>>;
-    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCCommunityType>;
-}

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

@@ -1,65 +0,0 @@
-import { __awaiter } from "tslib";
-import Endpoints from '../../constants/Endpoints';
-import { apiRequest } from '../../utils/apiRequest';
-import { urlParams } from '../../utils/url';
-/**
- * Contains all the endpoints needed to manage payments.
- */
-export class CommunityApiClient {
-    /**
-     * Get list of communities. Used to get the payment products related to the community (aka paywalls)
-     * @param params
-     * @param config
-     */
-    static getCommunities(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetCommunities.url({})}?${p.toString()}`, method: Endpoints.GetCommunities.method }));
-    }
-    /**
-     * Get Community
-     * @param id
-     * @param config
-     */
-    static getCommunity(id, config) {
-        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetCommunity.url({ id }), method: Endpoints.GetCommunity.method }));
-    }
-}
-/**
- *
- :::tip Community service can be used in the following way:
-
- ```jsx
- 1. Import the service from our library:
-
- import {CommunityService} from "@selfcommunity/api-services";
- ```
- ```jsx
- 2. Create a function and put the service inside it!
- The async function `getCommunities` will return the events matching the search query.
-
- async getCommunities() {
-         return await CommunityService.getCommunities({...});
-        }
- ```
- If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
-
- 1. Declare it(or declare them, it is possible to add multiple params)
-
- const headers = headers: {Authorization: `Bearer ${yourToken}`}
-
- 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
- ```
- :::
- */
-export default class CommunityService {
-    static getCommunities(params, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return CommunityApiClient.getCommunities(params, config);
-        });
-    }
-    static getPaymentProduct(id, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return CommunityApiClient.getCommunity(id, config);
-        });
-    }
-}

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

@@ -1,193 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { CheckoutCreateSessionParams, CheckoutSessionParams, PaymentProductsParams, CustomerPortalCreateSessionParams, PaymentContentStatusParams, PaymentOrderParams, CreatePaymentProductParams } from '../../types/payment';
-import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession, SCPurchasableContent, SCPaywall } from '@selfcommunity/types';
-export interface PaymentApiClientInterface {
-    /**
-     * Get payment products related to an object (aka paywalls) of type <content_type> and id <content_id> and the current payment_order
-     * @param params
-     * @param config
-     */
-    getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<SCPurchasableContent>;
-    /**
-     * Get payment products related to an object (aka paywalls) of type <content_type> and id <content_id>
-     * @param params
-     * @param config
-     */
-    getPaywalls(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaywall>>;
-    /**
-     * Get payment products
-     * @param params
-     * @param config
-     */
-    getPaymentProducts(params?: PaymentProductsParams, 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
-     * @param params
-     * @param config
-     */
-    getPaymentProductPrices(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
-    /**
-     * Create session checkout with price_id for an object of type <content_type> and id <content_id>
-     * @param data
-     * @param config
-     */
-    checkoutCreateSession(data: CheckoutCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<any>;
-    /**
-     * This endpoint retrieve checkout session
-     * @param params
-     * @param config
-     */
-    getCheckoutSession(params?: CheckoutSessionParams, config?: AxiosRequestConfig): Promise<SCCheckoutSessionDetail>;
-    /**
-     * Complete session checkout
-     * @param data
-     * @param config
-     */
-    checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
-    /**
-     * This endpoint retrieve order history of authenticated user
-     * @param params
-     * @param config
-     */
-    getPaymentsOrder(params?: PaymentOrderParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
-    /**
-     * This endpoint retrieve customer portal
-     * @param data
-     * @param config
-     */
-    getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
-    /**
-     * Create payment product
-     * @param data
-     * @param config
-     */
-    createPaymentProduct(data: CreatePaymentProductParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
-}
-/**
- * Contains all the endpoints needed to manage payments.
- */
-export declare class PaymentApiClient {
-    /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id> and the current payment_order
-     * @param params
-     * @param config
-     */
-    static getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<SCPurchasableContent>;
-    /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id>
-     * @param params
-     * @param config
-     */
-    static getPaywalls(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaywall>>;
-    /**
-     * This endpoint retrieves all the payment products
-     * @param params
-     * @param config
-     */
-    static getPaymentProducts(params?: PaymentProductsParams, 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
-     * @param params
-     * @param config
-     */
-    static getPaymentProductPrices(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
-    /**
-     * This endpoint creates a checkout session.
-     * @param data
-     * @param config
-     */
-    static checkoutCreateSession(data: CheckoutCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSession>;
-    /**
-     * Create payment product
-     * @param data
-     * @param config
-     */
-    static createPaymentProduct(data: CreatePaymentProductParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
-    /**
-     * This endpoint retrieve checkout session
-     * @param params
-     * @param config
-     */
-    static getCheckoutSession(params?: CheckoutSessionParams, config?: AxiosRequestConfig): Promise<SCCheckoutSessionDetail>;
-    /**
-     * This endpoint complete checkout session
-     * @param data
-     * @param config
-     */
-    static checkoutCompleteSession(data: CheckoutSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCCheckoutSessionComplete>;
-    /**
-     * This endpoint retrive order history of authenticated user
-     * @param params
-     * @param config
-     */
-    static getPaymentsOrder(params?: PaymentOrderParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
-    /**
-     * This endpoint retrive customer portal
-     * @param data
-     * @param config
-     */
-    static getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
-}
-/**
- *
- :::tip Payment service can be used in the following way:
-
- ```jsx
- 1. Import the service from our library:
-
- import {PaymentService} from "@selfcommunity/api-services";
- ```
- ```jsx
- 2. Create a function and put the service inside it!
- The async function `getPaymentProducts` will return the events matching the search query.
-
- async getPaymentProducts() {
-         return await PaymentService.getPaymentProducts({...});
-        }
- ```
- ```jsx
- In case of required `params`, just add them inside the brackets.
-
- async getPaymentPrices(eventId) {
-         return await PaymentService.getProductPrices(id);
-       }
- ```
- ```jsx
- If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
-
- 1. Declare it(or declare them, it is possible to add multiple params)
-
- const headers = headers: {Authorization: `Bearer ${yourToken}`}
-
- 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
- ```
- :::
- */
-export default class PaymentService {
-    static getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<SCPurchasableContent>;
-    static getPaywalls(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaywall>>;
-    static getPaymentProducts(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
-    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
-    static getPaymentProductPrices(id: number | string, params?: PaymentProductsParams, 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<SCCheckoutSessionComplete>;
-    static getPaymentsOrder(params?: PaymentOrderParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
-    static getPaymentsCustomerPortal(data: CustomerPortalCreateSessionParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentsCustomerPortalSession>;
-    static createPaymentProduct(data: CreatePaymentProductParams | FormData, config?: AxiosRequestConfig): Promise<SCPaymentProduct>;
-}

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

@@ -1,192 +0,0 @@
-import { __awaiter } from "tslib";
-import Endpoints from '../../constants/Endpoints';
-import { apiRequest } from '../../utils/apiRequest';
-import { urlParams } from '../../utils/url';
-/**
- * Contains all the endpoints needed to manage payments.
- */
-export class PaymentApiClient {
-    /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id> and the current payment_order
-     * @param params
-     * @param config
-     */
-    static getPaymentContentStatus(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaymentContentStatus.url({})}?${p.toString()}`, method: Endpoints.GetPaymentContentStatus.method }));
-    }
-    /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id>
-     * @param params
-     * @param config
-     */
-    static getPaywalls(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaywalls.url({})}?${p.toString()}`, method: Endpoints.GetPaywalls.method }));
-    }
-    /**
-     * This endpoint retrieves all the payment products
-     * @param params
-     * @param config
-     */
-    static getPaymentProducts(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaymentProducts.url({})}?${p.toString()}`, method: Endpoints.GetPaymentProducts.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.GetPaymentProduct.url({ id }), method: Endpoints.GetPaymentProduct.method }));
-    }
-    /**
-     * This endpoint retrieves all the prices related to a product
-     * @param id
-     * @param params
-     * @param config
-     */
-    static getPaymentProductPrices(id, params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaymentProductPrices.url({ id })}?${p.toString()}`, method: Endpoints.GetPaymentProductPrices.method }));
-    }
-    /**
-     * This endpoint creates a checkout session.
-     * @param data
-     * @param config
-     */
-    static checkoutCreateSession(data, config) {
-        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CheckoutCreateSession.url({}), method: Endpoints.CheckoutCreateSession.method, data }));
-    }
-    /**
-     * Create payment product
-     * @param data
-     * @param config
-     */
-    static createPaymentProduct(data, config) {
-        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CreatePaymentProduct.url({}), method: Endpoints.CreatePaymentProduct.method, data }));
-    }
-    /**
-     * This endpoint retrieve checkout session
-     * @param params
-     * @param config
-     */
-    static getCheckoutSession(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetCheckoutSession.url({})}?${p.toString()}`, method: Endpoints.GetCheckoutSession.method }));
-    }
-    /**
-     * This endpoint complete checkout session
-     * @param data
-     * @param config
-     */
-    static checkoutCompleteSession(data, config) {
-        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CheckoutSessionComplete.url({}), method: Endpoints.CheckoutSessionComplete.method, data }));
-    }
-    /**
-     * This endpoint retrive order history of authenticated user
-     * @param params
-     * @param config
-     */
-    static getPaymentsOrder(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaymentOrders.url({})}?${p.toString()}`, 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 }));
-    }
-}
-/**
- *
- :::tip Payment service can be used in the following way:
-
- ```jsx
- 1. Import the service from our library:
-
- import {PaymentService} from "@selfcommunity/api-services";
- ```
- ```jsx
- 2. Create a function and put the service inside it!
- The async function `getPaymentProducts` will return the events matching the search query.
-
- async getPaymentProducts() {
-         return await PaymentService.getPaymentProducts({...});
-        }
- ```
- ```jsx
- In case of required `params`, just add them inside the brackets.
-
- async getPaymentPrices(eventId) {
-         return await PaymentService.getProductPrices(id);
-       }
- ```
- ```jsx
- If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
-
- 1. Declare it(or declare them, it is possible to add multiple params)
-
- const headers = headers: {Authorization: `Bearer ${yourToken}`}
-
- 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
- ```
- :::
- */
-export default class PaymentService {
-    static getPaymentContentStatus(params, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.getPaymentContentStatus(params, config);
-        });
-    }
-    static getPaywalls(params, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.getPaywalls(params, config);
-        });
-    }
-    static getPaymentProducts(params, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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);
-        });
-    }
-    static checkoutCreateSession(data, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.checkoutCreateSession(data, config);
-        });
-    }
-    static getCheckoutSession(params, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.getCheckoutSession(params, config);
-        });
-    }
-    static checkoutCompleteSession(data, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.checkoutCompleteSession(data, config);
-        });
-    }
-    static getPaymentsOrder(params, config) {
-        return PaymentApiClient.getPaymentsOrder(params, config);
-    }
-    static getPaymentsCustomerPortal(data, config) {
-        return PaymentApiClient.getPaymentsCustomerPortal(data, config);
-    }
-    static createPaymentProduct(data, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.createPaymentProduct(data, config);
-        });
-    }
-}

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

@@ -1,100 +0,0 @@
-import { BaseGetParams, BaseSearchParams } from './baseParams';
-import { SCCheckoutSessionUIMode, SCContentType, SCPaymentPriceCurrencyType } from '@selfcommunity/types';
-/**
- * PaymentParams interface.
- */
-export interface PaymentProductsParams extends BaseGetParams {
-    /**
-     * Content id
-     */
-    id?: number | string;
-    /**
-     * Content id
-     */
-    content_id?: number | string;
-    /**
-     * Content type
-     */
-    content_type?: SCContentType;
-}
-export interface CheckoutCreateSessionParams {
-    /**
-     * Content id
-     */
-    content_id: number;
-    /**
-     * Content type
-     */
-    content_type: SCContentType;
-    /**
-     * Price id
-     */
-    payment_price_id: number;
-    /**
-     *	Return url
-     */
-    return_url?: string;
-    /**
-     *	Success url
-     */
-    success_url?: string;
-    /**
-     *	Session UI mode
-     */
-    ui_mode?: SCCheckoutSessionUIMode;
-}
-export interface CheckoutSessionParams {
-    /**
-     *	Session Id
-     */
-    session_id: string;
-}
-export interface CustomerPortalCreateSessionParams {
-    /**
-     *	Return url
-     */
-    return_url?: string;
-}
-/**
- * PaymentContentStatusParams interface.
- */
-export interface PaymentContentStatusParams extends BaseGetParams {
-    /**
-     * Content id
-     */
-    content_id?: number | string;
-    /**
-     * Content type
-     */
-    content_type?: SCContentType;
-}
-/**
- * PaymentOrderParams interface.
- */
-export interface PaymentOrderParams extends BaseSearchParams {
-    /**
-     * Ordering
-     */
-    ordering?: string;
-}
-/**
- * CreatePaymentProduct interface.
- */
-export interface CreatePaymentProductParams {
-    /**
-     * Product name
-     */
-    name: string;
-    /**
-     * Prduct price
-     */
-    unit_amount: number;
-    /**
-     * Description name
-     */
-    description?: string;
-    /**
-     * Price currency
-     */
-    currency?: SCPaymentPriceCurrencyType;
-}

package/lib/esm/types/payment.js

@@ -1 +0,0 @@
-export {};