@arrowsphere/api-client 3.196.0 → 3.197.0

package/CHANGELOG.md

@@ -3,6 +3,11 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.197.0] - 2025.05.23
+
+### Added
+- [subscriptions] Add endpoint for listing partners subscriptions and rename the endpoint for listing subscriptions as admin
+
 ## [3.196.0] - 2025.05.23
 
 ### Added

package/build/subscriptions/entities/subscriptionsListResult.d.ts

@@ -1,5 +1,5 @@
 import { AbstractEntity } from '../../abstractEntity';
-import { SubscriptionsClient, SubscriptionsListData, SubscriptionsListPayload } from '../subscriptionsClient';
+import { AdminSubscriptionsListData, SubscriptionsClient, SubscriptionsListPayload } from '../subscriptionsClient';
 import { SubscriptionData } from './subscription';
 /**
  * Subscriptions list result plain data
@@ -9,7 +9,7 @@ export declare type SubscriptionsListResultData = {
     totalPage: number;
     nbResults: number;
 };
-export declare class SubscriptionsListResult extends AbstractEntity<SubscriptionsListData> {
+export declare class SubscriptionsListResult extends AbstractEntity<AdminSubscriptionsListData> {
     #private;
     /**
      * FindResult constructor. Uses the client and request data to go through the pages.
@@ -17,7 +17,7 @@ export declare class SubscriptionsListResult extends AbstractEntity<Subscription
      * @param client - Subscriptions client the call was made with
      * @param payload - Payload parameter sent to the first call
      */
-    constructor(response: SubscriptionsListData, client: SubscriptionsClient, payload?: SubscriptionsListPayload);
+    constructor(response: AdminSubscriptionsListData, client: SubscriptionsClient, payload?: SubscriptionsListPayload);
     get subscriptions(): AsyncGenerator<SubscriptionData, void, undefined>;
     get client(): SubscriptionsClient;
     get payload(): SubscriptionsListPayload;

package/build/subscriptions/subscriptionsClient.d.ts

@@ -18,7 +18,7 @@ export declare type SubscriptionsListPayload = {
     sortBy?: string;
     sortDirection?: 'ASC' | 'DESC';
 };
-export declare type SubscriptionsListData = {
+export declare type AdminSubscriptionsListData = {
     data: Array<SubscriptionData>;
     pagination: {
         perPage: number;
@@ -29,6 +29,28 @@ export declare type SubscriptionsListData = {
         previous: string;
     };
 };
+export declare type PartnerSubscriptionsListData = {
+    data: Array<PartnerSubscription>;
+    status: number;
+};
+export declare type PartnerSubscription = {
+    reference: string;
+    name: string;
+    status: string;
+    dateDemand: string;
+    dateValidation: string | null;
+    dateEnd: string | null;
+    level: string | null;
+    error_msg: string | null;
+    details: {
+        partnerId: string;
+    };
+    extraInformation: {
+        programs: Record<string, {
+            partnerId: string;
+        }>;
+    };
+};
 export declare type SubscriptionCreationData = {
     name: string;
     level: string;
@@ -53,24 +75,26 @@ export declare class SubscriptionsClient extends AbstractRestfulClient {
      */
     protected isCamelPagination: boolean;
     /**
-     * Calls the subscriptions API list endpoint
+     * @deprecated use listAdmin instead
+     * Calls the admin subscriptions API list endpoint
      *
      * @param data - List payload
      *
-     * @returns Promise\<AxiosResponse\<{@link SubscriptionsListData}\>\>   */
-    listRaw(data?: SubscriptionsListPayload): Promise<SubscriptionsListData>;
+     * @returns Promise\<AxiosResponse\<{@link AdminSubscriptionsListData}\>\>   */
+    listRaw(data?: SubscriptionsListPayload): Promise<AdminSubscriptionsListData>;
     /**
      * Lists subscriptions and returns a SubscriptionsListResult to manipulate the results.
      *
      * Note: This endpoint requires an admin token to be called
      *
-     * @param postData - List payload
+     * @param filters - List payload
      * @param perPage - Number of results per page
      * @param page - Page number to fetch
      *
      * @returns Promise\<{@link SubscriptionsListResult}\>
      *
      */
-    list(postData?: SubscriptionsListPayload, perPage?: number, page?: number): Promise<SubscriptionsListResult>;
-    addSubscription(postData: SubscriptionCreationData): Promise<void>;
+    list(filters?: SubscriptionsListPayload): Promise<PartnerSubscriptionsListData>;
+    listAdmin(filters?: SubscriptionsListPayload, perPage?: number, page?: number): Promise<SubscriptionsListResult>;
+    addSubscription(filters: SubscriptionCreationData): Promise<void>;
 }

package/build/subscriptions/subscriptionsClient.js

@@ -23,11 +23,12 @@ class SubscriptionsClient extends abstractRestfulClient_1.AbstractRestfulClient
         this.isCamelPagination = true;
     }
     /**
-     * Calls the subscriptions API list endpoint
+     * @deprecated use listAdmin instead
+     * Calls the admin subscriptions API list endpoint
      *
      * @param data - List payload
      *
-     * @returns Promise\<AxiosResponse\<{@link SubscriptionsListData}\>\>   */
+     * @returns Promise\<AxiosResponse\<{@link AdminSubscriptionsListData}\>\>   */
     async listRaw(data = {}) {
         this.path = this.LIST_PATH;
         return this.get(data, {}, { isAdmin: true });
@@ -37,21 +38,24 @@ class SubscriptionsClient extends abstractRestfulClient_1.AbstractRestfulClient
      *
      * Note: This endpoint requires an admin token to be called
      *
-     * @param postData - List payload
+     * @param filters - List payload
      * @param perPage - Number of results per page
      * @param page - Page number to fetch
      *
      * @returns Promise\<{@link SubscriptionsListResult}\>
      *
      */
-    async list(postData = {}, perPage = 100, page = 1) {
+    async list(filters = {}) {
+        return this.get(filters, {}, { isAdmin: false });
+    }
+    async listAdmin(filters = {}, perPage = 100, page = 1) {
         this.setPerPage(perPage);
         this.setPage(page);
-        const response = await this.listRaw(postData);
-        return new subscriptionsListResult_1.SubscriptionsListResult(response, this, postData);
+        const response = await this.listRaw(filters);
+        return new subscriptionsListResult_1.SubscriptionsListResult(response, this, filters);
     }
-    async addSubscription(postData) {
-        return this.post(postData);
+    async addSubscription(filters) {
+        return this.post(filters);
     }
 }
 exports.SubscriptionsClient = SubscriptionsClient;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.196.0",
+  "version": "3.197.0",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",