@selfcommunity/api-services 0.6.7-payments.152 → 0.6.7-payments.156

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

@@ -0,0 +1,65 @@
+import { AxiosRequestConfig } from 'axios';
+import { BaseGetParams, SCPaginatedResponse } from '../../types';
+import { SCCommunity } 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<SCCommunity>>;
+    /**
+     * Get Community
+     * @param id
+     * @param config
+     */
+    getCommunity(id: number | string, config?: AxiosRequestConfig): Promise<SCCommunity>;
+}
+/**
+ * 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<SCCommunity>>;
+    /**
+     * Get Community
+     * @param id
+     * @param config
+     */
+    static getCommunity(id: number | string, config?: AxiosRequestConfig): Promise<SCCommunity>;
+}
+/**
+ *
+ :::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<SCCommunity>>;
+    static getPaymentProduct(id: number | string, config?: AxiosRequestConfig): Promise<SCCommunity>;
+}

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

@@ -0,0 +1,65 @@
+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,14 +1,26 @@
 import { AxiosRequestConfig } from 'axios';
-import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { CheckoutCreateSessionParams, CheckoutSessionParams, ContentProductsParams, CustomerPortalCreateSessionParams } from '../../types/payment';
-import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession, SCCommunityPaymentProducts } from '@selfcommunity/types';
+import { BaseGetParams, PaymentContentStatusParams, SCPaginatedResponse } from '../../types';
+import { CheckoutCreateSessionParams, CheckoutSessionParams, PaymentProductsParams, CustomerPortalCreateSessionParams } from '../../types/payment';
+import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession, SCPurchasableContent } from '@selfcommunity/types';
 export interface PaymentApiClientInterface {
     /**
-     * Get paywall products related to an object of type <content_type> and id <content_id>
+     * 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
      */
-    getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    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<SCPaymentProduct>>;
+    /**
+     * Get payment products
+     * @param params
+     * @param config
+     */
+    getPaymentProducts(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
     /**
      * Get product
      * @param id
@@ -22,12 +34,6 @@ export interface PaymentApiClientInterface {
      * @param config
      */
     getPaymentProductPrices(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
-    /**
-     * Get paywall for the community
-     * @param params
-     * @param config
-     */
-    getCommunityPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCCommunityPaymentProducts>;
     /**
      * Create session checkout with price_id for an object of type <content_type> and id <content_id>
      * @param data
@@ -63,12 +69,24 @@ export interface PaymentApiClientInterface {
  * 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 getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    static getPaywalls(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    /**
+     * 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
@@ -82,12 +100,6 @@ export declare class PaymentApiClient {
      * @param config
      */
     static getPaymentProductPrices(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
-    /**
-     * This endpoint retrieves all the products related the Community product
-     * @param params
-     * @param config
-     */
-    static getCommunityPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCCommunityPaymentProducts>;
     /**
      * This endpoint creates a checkout session.
      * @param data
@@ -155,10 +167,11 @@ export declare class PaymentApiClient {
  :::
  */
 export default class PaymentService {
-    static getPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    static getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<SCPurchasableContent>;
+    static getPaywalls(params?: PaymentProductsParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentProduct>>;
+    static getPaymentProducts(params?: PaymentProductsParams, 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 getCommunityPaymentProducts(params?: ContentProductsParams, config?: AxiosRequestConfig): Promise<SCCommunityPaymentProducts>;
+    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>;

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

@@ -6,14 +6,32 @@ 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.GetContentProducts.url({})}?${p.toString()}`, method: Endpoints.GetContentProducts.method }));
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaymentProducts.url({})}?${p.toString()}`, method: Endpoints.GetPaymentProducts.method }));
     }
     /**
      * This endpoint retrieves a specific payment product.
@@ -21,7 +39,7 @@ export class PaymentApiClient {
      * @param config
      */
     static getPaymentProduct(id, config) {
-        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetProduct.url({ id }), method: Endpoints.GetProduct.method }));
+        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
@@ -31,16 +49,7 @@ export class PaymentApiClient {
      */
     static getPaymentProductPrices(id, params, config) {
         const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetProductPrices.url({ id })}?${p.toString()}`, method: Endpoints.GetProductPrices.method }));
-    }
-    /**
-     * This endpoint retrieves all the products related the Community product
-     * @param params
-     * @param config
-     */
-    static getCommunityPaymentProducts(params, config) {
-        const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetCommunityProduct.url({})}?${p.toString()}`, method: Endpoints.GetCommunityProduct.method }));
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetPaymentProductPrices.url({ id })}?${p.toString()}`, method: Endpoints.GetPaymentProductPrices.method }));
     }
     /**
      * This endpoint creates a checkout session.
@@ -120,6 +129,16 @@ export class PaymentApiClient {
  :::
  */
 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);
@@ -135,11 +154,6 @@ export default class PaymentService {
             return PaymentApiClient.getPaymentProductPrices(id, params, config);
         });
     }
-    static getCommunityPaymentProducts(params, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return PaymentApiClient.getCommunityPaymentProducts(params, config);
-        });
-    }
     static checkoutCreateSession(data, config) {
         return __awaiter(this, void 0, void 0, function* () {
             return PaymentApiClient.checkoutCreateSession(data, config);

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

@@ -28,4 +28,5 @@ import { EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchPara
 import { LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams } from './liveStream';
 import { StartStepParams, OnBoardingStep } from './onBoarding';
 import { CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams } from './course';
-export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams };
+import { PaymentContentStatusParams, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams } from './payment';
+export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams };

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

@@ -3,7 +3,7 @@ import { SCCheckoutSessionUIMode, SCContentType } from '@selfcommunity/types';
 /**
  * PaymentParams interface.
  */
-export interface ContentProductsParams extends BaseGetParams {
+export interface PaymentProductsParams extends BaseGetParams {
     /**
      * Content id
      */
@@ -55,3 +55,16 @@ export interface CustomerPortalCreateSessionParams {
      */
     return_url?: string;
 }
+/**
+ * PaymentContentStatusParams interface.
+ */
+export interface PaymentContentStatusParams extends BaseGetParams {
+    /**
+     * Content id
+     */
+    content_id?: number | string;
+    /**
+     * Content type
+     */
+    content_type?: SCContentType;
+}