Merge pull request #750 from inplayer-org/v3-getSubscription-param-type-change

The type of getSubscription method parameter changed to string

Author: Jasminna

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+# [3.12.2] - 07-12-2021
+
+### Changes
+
+- The type of getSubscription method parameter changed to string
+
 # [3.12.1] - 03-12-2021
 ## Changes
 

index.d.ts

@@ -859,7 +859,7 @@ export declare class Subscription {
     limit?: number,
     status?: string
   ): Promise<AxiosResponse<GetSubscription>>;
-  getSubscription(id: number): Promise<AxiosResponse<SubscriptionDetails>>;
+  getSubscription(id: string): Promise<AxiosResponse<SubscriptionDetails>>;
   cancelSubscription(
     unsubscribeUrl: string
   ): Promise<AxiosResponse<CancelSubscription>>;
@@ -936,7 +936,7 @@ export interface ApiEndpoints {
   validateReceipt: (platform: string) => string;
   // Subscription
   getSubscriptions: (limit: number, page: number) => string;
-  getSubscription: (id: number) => string;
+  getSubscription: (id: string) => string;
   subscribe: string;
   cancelSubscription: (url: string) => string;
   // Voucher

src/constants/index.ts

@@ -95,7 +95,7 @@ export const API = {
     }
     return url;
   },
-  getSubscription: (id: number): string => `/subscriptions/${id}`,
+  getSubscription: (id: string): string => `/subscriptions/${id}`,
   cancelSubscription: (url: string): string => `${url}`,
   subscribe: '/subscriptions',
   subscribeV2: '/v2/subscriptions',

src/endpoints/subscription.ts

@@ -82,7 +82,7 @@ class Subscription extends BaseExtend {
    * @method getSubscription
    * @async
    *
-   * @param {number} id The subscription id.
+   * @param {string} id The subscription id.
    * @example
    *     InPlayer.Subscription
    *     .getSubscription('abcdef')
@@ -106,7 +106,7 @@ class Subscription extends BaseExtend {
    * }
    * ```
    */
-  async getSubscription(id: number): Promise<AxiosResponse<SubscriptionDetails>> {
+  async getSubscription(id: string): Promise<AxiosResponse<SubscriptionDetails>> {
     const tokenObject = await this.request.getToken();
 
     return this.request.authenticatedGet(API.getSubscription(id), {

src/models/Config.ts

@@ -69,7 +69,7 @@ export interface ApiEndpoints {
   ) => string;
   // Subscriptions
   getSubscriptions: (limit: number, page: number) => string;
-  getSubscription: (id: number) => string;
+  getSubscription: (id: string) => string;
   cancelSubscription: (url: string) => string;
   subscribe: string;
   subscribeV2: string;

src/models/ISubscription.ts

@@ -124,7 +124,7 @@ export interface Subscription extends BaseExtend {
         page?: number,
         limit?: number
     ): Promise<AxiosResponse<GetSubscription>>;
-    getSubscription(id: number): Promise<AxiosResponse<SubscriptionDetails>>;
+    getSubscription(id: string): Promise<AxiosResponse<SubscriptionDetails>>;
     cancelSubscription(
         unsubscribeUrl: string
     ): Promise<AxiosResponse<CancelSubscription>>;