Merge pull request #775 from inplayer-org/get-assets-in-package

added `getAssetsInPackage` method to Asset endpoints

Author: mirovladimitrovski

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+# [3.13.5] - 02-02-2023
+
+### Added
+
+- New `Assets` method `getAssetsInPackage`
+
 # [3.13.4] - 15-12-2022
 
 ### Added

index.d.ts

@@ -453,6 +453,14 @@ export declare interface GetMerchantPackage {
   collection: PackageDetails;
 }
 
+export declare interface GetAssetsInPackage {
+  total: number;
+  page: number;
+  offset: number;
+  limit: number;
+  collection: ItemDetailsV1[];
+}
+
 export declare interface CloudfrontUrl {
   video_url: string;
 }
@@ -502,6 +510,7 @@ export declare class Asset {
     merchantUuid: string
   ): Promise<AxiosResponse<ExternalItemDetails>>;
   getPackage(id: number): Promise<AxiosResponse<GetMerchantPackage>>;
+  getAssetsInPackage(id: number): Promise<AxiosResponse<GetAssetsInPackage>>;
   getAssetAccessFees(id: number): Promise<AxiosResponse<GetAccessFee>>;
   getDonationOptions(assetId: number): Promise<AxiosResponse<DonationDetails>>;
   getAssetsHistory(

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inplayer-org/inplayer.js",
-  "version": "3.13.4",
+  "version": "3.13.5",
   "author": "InPlayer",
   "license": "MIT",
   "description": "A Javascript SDK for Inplayer's RESTful API",

src/constants/index.ts

@@ -49,6 +49,7 @@ export const API = {
   checkAccessForAsset: (id: number): string => `/items/${id}/access`,
   checkFreeTrial: (id: number): string => `/items/used-trial-period/${id}`,
   getPackage: (id: number): string => `/items/packages/${id}`,
+  getAssetsInPackage: (id: number): string => `items/packages/${id}/items`,
   getAssetAccessFees: (id: number): string => `v2/items/${id}/access-fees`,
   getCloudfrontURL: (id: number, videoUrl: string): string =>
     `/items/${id}/access/cloudfront?url=${videoUrl}`,

src/endpoints/asset.ts

@@ -12,6 +12,7 @@ import {
   DonationDetails,
   ExternalItemDetails,
   GetAccessFee,
+  GetAssetsInPackage,
   GetItemAccessV1,
   GetMerchantPackage,
   ItemDetailsV1,
@@ -296,6 +297,45 @@ class Asset extends BaseExtend {
     return this.request.get(API.getPackage(id));
   }
 
+  /**
+   * Get assets in a package
+   * @method getAssetsInPackage
+   * @async
+   * @param {number} id The id of created package in InPlayer Dashboard.
+   * @example
+   *     InPlayer.Asset
+   *     .getAssetsInPackage(4444)
+   *     .then(data => console.log(data));
+   * @returns  {AxiosResponse<GetAssetsInPackage>} Contains the data:
+   * ```typescript
+   * {
+   *    total: number;
+   *    page: number;
+   *    offset: number;
+   *    limit: number;
+   *    collection: [{
+   *      id: number;
+   *      merchant_id: number;
+   *      is_active: boolean;
+   *      title: string;
+   *      content: string;
+   *      item_type: {
+   *        id: number;
+   *        name: string;
+   *        content_type: string;
+   *        host: string;
+   *        description: string;
+   *      };
+   *      metadata: {};
+   *      items: number;
+   *    }];
+   * }
+   * ```
+   */
+  async getAssetsInPackage(id: number): Promise<AxiosResponse<GetAssetsInPackage>> {
+    return this.request.get(API.getAssetsInPackage(id));
+  }
+
   /**
    * Get the access fees for a given item
    * @method getAssetAccessFees

src/models/Config.ts

@@ -39,6 +39,7 @@ export interface ApiEndpoints {
   checkAccessForAsset: (id: number) => string;
   checkFreeTrial: (id: number) => string;
   getPackage: (id: number) => string;
+  getAssetsInPackage: (id: number) => string;
   getAssetAccessFees: (id: number) => string;
   getCloudfrontURL: (assetId: number, videoUrl: string) => string;
   getPurchaseHistory: (status: string, page?: number, size?: number) => string;

src/models/IAsset&Access.ts

@@ -237,6 +237,14 @@ export interface GetMerchantPackage {
   collection: PackageDetails;
 }
 
+export interface GetAssetsInPackage {
+  total: number;
+  page: number;
+  offset: number;
+  limit: number;
+  collection: ItemDetailsV1[];
+}
+
 export interface RequestCodeAccessData {
   item_id: number;
   code: string;
@@ -362,6 +370,7 @@ export interface Asset extends BaseExtend {
     merchantUuid: string
   ): Promise<AxiosResponse<ExternalItemDetails>>;
   getPackage(id: number): Promise<AxiosResponse<GetMerchantPackage>>;
+  getAssetsInPackage(id: number): Promise<AxiosResponse<GetAssetsInPackage>>;
   getAssetAccessFees(id: number): Promise<AxiosResponse<GetAccessFee>>;
   getAssetsHistory(
     size?: number,