added plans methods

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+# [3.13.24] - 17-06-2024
+
+### Added
+
+- Method `InPlayer.Payment.getSitePlans`
+- Method `InPlayer.Payment.getSitePlanPrices`
+- Method `InPlayer.Asset.getSiteEntitlements`
+
 # [3.13.24] - 16-11-2023
 
 ### Changes

index.d.ts

@@ -553,6 +553,68 @@ export interface SignedMediaResponse {
   token: string;
 }
 
+type JwListResponse<
+  N extends string = string,
+  T extends Record<string, unknown> = Record<string, unknown>
+> = {
+  page: number;
+  total: number;
+  page_length: number;
+} & {
+  [P in N]: T[];
+};
+
+export type PlanDetailsResponse = {
+  id: string;
+  original_id: number;
+  metadata: {
+    name: string;
+    access_model: 'svod' | 'authvod' | 'free';
+    tags: {
+      include: string[];
+      exclude: string[];
+    };
+    custom_params: {
+      include: Record<string, string>;
+      exclude: Record<string, string>;
+    };
+  };
+  relationships: {
+    prices?: { id: string; type: 'price' }[];
+  };
+  created: string;
+  last_modified: string;
+  type: 'plan';
+  schema: string;
+};
+
+export type PlansListResponse = JwListResponse<'plans', PlanDetailsResponse>;
+
+export type PlanPrice = {
+  id: string;
+  access: {
+    period: 'month' | 'year';
+    quantity: number;
+    type: 'subscription';
+  };
+  metadata: {
+    amount: number;
+    currency: string;
+    name: string;
+    trial?: { period: 'day'; quantity: number } | null;
+  };
+  original_id: number;
+  relationships: {
+    plans?: { id: string; type: 'plan' }[];
+  };
+  schema: string;
+  type: 'price';
+};
+
+export type PlanPricesResponse = JwListResponse<'prices', PlanPrice>;
+
+export type SiteEntitlementsResponse = PlansListResponse;
+
 export declare class Asset {
   constructor(config: Record<string, unknown>, Account: Account);
 
@@ -599,6 +661,9 @@ export declare class Asset {
     appConfigId: string,
     mediaId: string
   ): Promise<AxiosResponse<SignedMediaResponse>>;
+  getSiteEntitlements(
+    siteId: string
+  ): Promise<AxiosResponse<SiteEntitlementsResponse>>;
 }
 
 export interface BrandingDetails {
@@ -951,6 +1016,14 @@ export declare class Payment {
   validateReceipt: (
     data: ValidateReceiptData
   ) => Promise<AxiosResponse<CommonResponse>>;
+  getSitePlans: (
+    siteId: string,
+    plansIds?: string[]
+  ) => Promise<AxiosResponse<PlansListResponse>>;
+  getSitePlanPrices: (
+    siteId: string,
+    planId: string
+  ) => Promise<AxiosResponse<PlanPricesResponse>>;
 }
 
 export interface CreateSubscriptionData {

src/constants/index.ts

@@ -42,7 +42,7 @@ export const API = {
   getExternalAsset: (
     assetType: string,
     externalId: string,
-    merchantUuid?: string,
+    merchantUuid?: string
   ): string => {
     let url = `/items/assets/external/${assetType}/${externalId}`;
     if (merchantUuid) {
@@ -73,6 +73,8 @@ export const API = {
   // media signer
   getSignedMediaToken: (appConfigId: string, mediaId: string): string =>
     `v2/items/jw-media/token?app_config_id=${appConfigId}&media_id=${mediaId}`,
+  getSiteEntitlements: (siteId: string): string =>
+    `/v3/sites/${siteId}/entitlements`,
 
   // Payments
   getPaymentMethods: '/payments/methods',
@@ -92,7 +94,7 @@ export const API = {
     page: number,
     startDate?: string,
     endDate?: string,
-    type?: string,
+    type?: string
   ): string => {
     let url = `/payments/transactions?exclude=store-payment&size=${size}&page=${page}`;
 
@@ -108,6 +110,15 @@ export const API = {
 
     return url;
   },
+  getSitePlans: (siteId: string, plansIds: string[] = []) =>
+    `/v3/sites/${siteId}/plans${
+      plansIds.length
+        ? `q=id:(${plansIds.map((planId) => `"${planId}"`).join(' OR ')})`
+        : ''
+    }`,
+
+  getSitePlanPrices: (siteId: string, planId: string) =>
+    `/v3/sites/${siteId}/plans/${planId}/prices`,
 
   // Subscriptions
   getSubscriptions: (limit: number, page: number, status?: string): string => {
@@ -137,7 +148,7 @@ export const API = {
     merchantUuid: string,
     page: number,
     size: number,
-    filter: string,
+    filter: string
   ): string =>
     `/v2/nfts/${merchantUuid}?filter=${filter}&page=${page}&size=${size}`,
   getMerchantNFT: (merchantUuid: string, nftId: number): string =>

src/endpoints/asset.ts

@@ -18,6 +18,7 @@ import {
   ItemDetailsV1,
   RequestDataCaptureAccessData,
   SignedMediaResponse,
+  SiteEntitlementsResponse,
 } from '../models/IAsset&Access';
 import BaseExtend from '../extends/base';
 import { API } from '../constants';
@@ -61,7 +62,7 @@ class Asset extends BaseExtend {
    * ```
    */
   async checkAccessForAsset(
-    id: number,
+    id: number
   ): Promise<AxiosResponse<GetItemAccessV1>> {
     const tokenObject = await this.request.getToken();
 
@@ -133,7 +134,7 @@ class Asset extends BaseExtend {
    */
   async getAsset(
     assetId: number,
-    merchantUuid?: string,
+    merchantUuid?: string
   ): Promise<AxiosResponse<ExternalItemDetails>> {
     return this.request.get(API.getAsset(assetId, merchantUuid));
   }
@@ -257,10 +258,10 @@ class Asset extends BaseExtend {
   async getExternalAsset(
     assetType: string,
     externalId: string,
-    merchantUuid = '',
+    merchantUuid = ''
   ): Promise<AxiosResponse<ExternalItemDetails>> {
     return this.request.get(
-      API.getExternalAsset(assetType, externalId, merchantUuid),
+      API.getExternalAsset(assetType, externalId, merchantUuid)
     );
   }
 
@@ -339,7 +340,7 @@ class Asset extends BaseExtend {
    * ```
    */
   async getAssetsInPackage(
-    id: number,
+    id: number
   ): Promise<AxiosResponse<GetAssetsInPackage>> {
     return this.request.get(API.getAssetsInPackage(id));
   }
@@ -451,7 +452,9 @@ class Asset extends BaseExtend {
    * }
    * ```
    */
-  async getAssetAccessFees(id: number): Promise<AxiosResponse<GetAccessFeesResponse>> {
+  async getAssetAccessFees(
+    id: number
+  ): Promise<AxiosResponse<GetAccessFeesResponse>> {
     return this.request.get(API.getAssetAccessFees(id));
   }
 
@@ -530,7 +533,7 @@ class Asset extends BaseExtend {
     page = 0,
     startDate?: string,
     endDate?: string,
-    type?: string,
+    type?: string
   ): Promise<AxiosResponse<AssetsTransactions>> {
     const tokenObject = await this.request.getToken();
 
@@ -540,7 +543,7 @@ class Asset extends BaseExtend {
         headers: {
           Authorization: `Bearer ${tokenObject.token}`,
         },
-      },
+      }
     );
   }
 
@@ -584,9 +587,9 @@ class Asset extends BaseExtend {
       reduce(
         browserDetails,
         (acc: string, details: Record<string, any>) => `${acc}${details.value}`,
-        '',
+        ''
       ),
-      31,
+      31
     );
 
     formData.set('item_id', String(item_id));
@@ -604,7 +607,7 @@ class Asset extends BaseExtend {
 
     await tokenStorage.setItem(
       this.config.INPLAYER_ACCESS_CODE_NAME(item_id),
-      JSON.stringify(accessCode),
+      JSON.stringify(accessCode)
     );
 
     return response;
@@ -631,15 +634,16 @@ class Asset extends BaseExtend {
    * ```
    */
   getAccessCode(
-    assetId: number,
+    assetId: number
   ): CodeAccessData | null | Promise<CodeAccessData | null> {
     const accessCode = tokenStorage.getItem(
-      this.config.INPLAYER_ACCESS_CODE_NAME(assetId),
+      this.config.INPLAYER_ACCESS_CODE_NAME(assetId)
     );
 
     if (isPromise(accessCode)) {
       return (accessCode as Promise<string>).then((resolvedString) =>
-        (resolvedString ? (JSON.parse(resolvedString) as CodeAccessData) : null)) as Promise<CodeAccessData | null>;
+        resolvedString ? (JSON.parse(resolvedString) as CodeAccessData) : null
+      ) as Promise<CodeAccessData | null>;
     }
 
     return accessCode
@@ -668,7 +672,7 @@ class Asset extends BaseExtend {
    * ```
    */
   async getAccesCodeSessions(
-    codeId: number,
+    codeId: number
   ): Promise<AxiosResponse<Array<CodeAccessSessionsData>>> {
     return this.request.get(API.requestAccessCodeSessions(codeId));
   }
@@ -691,7 +695,7 @@ class Asset extends BaseExtend {
    * ```
    */
   async terminateSession(
-    assetId: number,
+    assetId: number
   ): Promise<AxiosResponse<CommonResponse> | null> {
     const accessCode: CodeAccessData | null = await this.getAccessCode(assetId);
 
@@ -700,11 +704,11 @@ class Asset extends BaseExtend {
     }
 
     const response = await this.request.delete(
-      API.terminateSession(accessCode.code_id, accessCode.browser_fingerprint),
+      API.terminateSession(accessCode.code_id, accessCode.browser_fingerprint)
     );
 
     await tokenStorage.removeItem(
-      this.config.INPLAYER_ACCESS_CODE_NAME(assetId),
+      this.config.INPLAYER_ACCESS_CODE_NAME(assetId)
     );
 
     return response;
@@ -751,7 +755,7 @@ class Asset extends BaseExtend {
     return this.request.post(
       API.requestDataCaptureNoAuthAccess,
       qs.stringify(accessData),
-      { headers },
+      { headers }
     );
   }
 
@@ -774,7 +778,7 @@ class Asset extends BaseExtend {
    */
   async getCloudfrontURL(
     assetId: number,
-    videoUrl: string,
+    videoUrl: string
   ): Promise<AxiosResponse<CloudfrontUrl>> {
     const tokenObject = await this.request.getToken();
 
@@ -813,7 +817,7 @@ class Asset extends BaseExtend {
    * ```
    */
   async getDonationOptions(
-    assetId: number,
+    assetId: number
   ): Promise<AxiosResponse<DonationDetails>> {
     const tokenObject = await this.request.getToken();
 
@@ -842,7 +846,7 @@ class Asset extends BaseExtend {
    */
   async getSignedMediaToken(
     appConfigId: string,
-    mediaId: string,
+    mediaId: string
   ): Promise<AxiosResponse<SignedMediaResponse>> {
     const tokenObject = await this.request.getToken();
 
@@ -852,6 +856,23 @@ class Asset extends BaseExtend {
       },
     });
   }
+
+  async getSiteEntitlements(
+    siteId: string
+  ): Promise<AxiosResponse<SiteEntitlementsResponse>> {
+    const tokenObject = await this.request.getToken();
+
+    const headers: Record<string, string> = {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    };
+
+    if (tokenObject.token) {
+      headers.Authorization = `Bearer ${tokenObject.token}`;
+    }
+
+    return this.request.get(API.getSiteEntitlements(siteId), { headers });
+  }
 }
 
 export default Asset;