Merge pull request #22 from SIDANWhatever/feature/change-query-param-to-accept-typed-objects

Feature/change query param to accept typed objects

Author: Vardominator

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maestro-org/typescript-sdk",
-  "version": "1.1.2",
+  "version": "1.2.2",
   "description": "TypeScript SDK for the Maestro Dapp Platform",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

src/api/accounts/helpers.ts

@@ -1,6 +1,13 @@
 import { AxiosRequestConfig } from 'axios';
 import { BaseAPI } from '../../base';
 import { AccountsApiFp } from './helpers';
+import {
+    AccountAddressesQueryParams,
+    AccountAssetsQueryParams,
+    AccountHistoryQueryParams,
+    AccountRewardsQueryParams,
+    AccountUpdatesQueryParams,
+} from './type';
 
 /**
  * AccountsApi - object-oriented interface
@@ -13,66 +20,48 @@ export class AccountsApi extends BaseAPI {
      * Returns a list of addresses seen on-chain which use the specified stake key
      * @summary Stake account addresses
      * @param {string} stakeAddr Bech32 encoded stake/reward address (\'stake1...\')
-     * @param {number | null} [count] The max number of results per page
-     * @param {string | null} [cursor] Pagination cursor string, use the cursor included in a page of results to fetch the next page
+     * @param {AccountAddressesQueryParams} [queryParams] Query parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
     public accountAddresses(
         stakeAddr: string,
-        count?: number | null,
-        cursor?: string | null,
+        queryParams?: AccountAddressesQueryParams,
         options?: AxiosRequestConfig,
     ) {
         return AccountsApiFp(this.configuration)
-            .accountAddresses(stakeAddr, count, cursor, options)
+            .accountAddresses(stakeAddr, queryParams, options)
             .then((request) => request(this.axios));
     }
 
     /**
      * Returns a list of native assets which are owned by addresses with the specified stake key
      * @summary Stake account assets
      * @param {string} stakeAddr Bech32 encoded reward/stake address (\'stake1...\')
-     * @param {string | null} [policy] Filter results to only show assets of the specified policy
-     * @param {number | null} [count] The max number of results per page
-     * @param {string | null} [cursor] Pagination cursor string, use the cursor included in a page of results to fetch the next page
+     * @param {AccountAssetsQueryParams} [queryParams] Query parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    public accountAssets(
-        stakeAddr: string,
-        policy?: string | null,
-        count?: number | null,
-        cursor?: string | null,
-        options?: AxiosRequestConfig,
-    ) {
+    public accountAssets(stakeAddr: string, queryParams?: AccountAssetsQueryParams, options?: AxiosRequestConfig) {
         return AccountsApiFp(this.configuration)
-            .accountAssets(stakeAddr, policy, count, cursor, options)
+            .accountAssets(stakeAddr, queryParams, options)
             .then((request) => request(this.axios));
     }
 
     /**
      * Returns per-epoch history for the specified stake key
      * @summary Stake account history
      * @param {string} stakeAddr Bech32 encoded stake/reward address (\'stake1...\')
-     * @param {number | null} [epochNo] Fetch result for only a specific epoch
-     * @param {number | null} [count] The max number of results per page
-     * @param {string | null} [cursor] Pagination cursor string, use the cursor included in a page of results to fetch the next page
+     * @param {AccountHistoryQueryParams} [queryParams] Query parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    public accountHistory(
-        stakeAddr: string,
-        epochNo?: number | null,
-        count?: number | null,
-        cursor?: string | null,
-        options?: AxiosRequestConfig,
-    ) {
+    public accountHistory(stakeAddr: string, queryParams?: AccountHistoryQueryParams, options?: AxiosRequestConfig) {
         return AccountsApiFp(this.configuration)
-            .accountHistory(stakeAddr, epochNo, count, cursor, options)
+            .accountHistory(stakeAddr, queryParams, options)
             .then((request) => request(this.axios));
     }
 
@@ -94,41 +83,31 @@ export class AccountsApi extends BaseAPI {
      * Returns a list of staking-related rewards for the specified stake key (pool `member` or `leader` rewards, deposit `refund`)
      * @summary Stake account rewards
      * @param {string} stakeAddr Bech32 encoded stake/reward address (\'stake1...\')
-     * @param {number | null} [count] The max number of results per page
-     * @param {string | null} [cursor] Pagination cursor string, use the cursor included in a page of results to fetch the next page
+     * @param {AccountRewardsQueryParams} [queryParams] Query parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    public accountRewards(
-        stakeAddr: string,
-        count?: number | null,
-        cursor?: string | null,
-        options?: AxiosRequestConfig,
-    ) {
+    public accountRewards(stakeAddr: string, queryParams?: AccountRewardsQueryParams, options?: AxiosRequestConfig) {
         return AccountsApiFp(this.configuration)
-            .accountRewards(stakeAddr, count, cursor, options)
+            .accountRewards(stakeAddr, queryParams, options)
             .then((request) => request(this.axios));
     }
 
     /**
      * Returns a list of updates relating to the specified stake key ( `registration`, `deregistration`, `delegation`, `withdrawal`)
      * @summary Stake account updates
      * @param {string} stakeAddr Bech32 encoded stake/reward address (\'stake1...\')
-     * @param {number | null} [count] The max number of results per page
-     * @param {string | null} [cursor] Pagination cursor string, use the cursor included in a page of results to fetch the next page
+     * @param {AccountUpdatesQueryParams} [queryParams] Query parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApi
      */
-    public accountUpdates(
-        stakeAddr: string,
-        count?: number | null,
-        cursor?: string | null,
-        options?: AxiosRequestConfig,
-    ) {
+    public accountUpdates(stakeAddr: string, queryParams?: AccountUpdatesQueryParams, options?: AxiosRequestConfig) {
         return AccountsApiFp(this.configuration)
-            .accountUpdates(stakeAddr, count, cursor, options)
+            .accountUpdates(stakeAddr, queryParams, options)
             .then((request) => request(this.axios));
     }
 }
+
+export * from './type';

src/api/accounts/index.ts

@@ -0,0 +1,116 @@
+/**
+ * Query parameters for accountAddresses.
+ * @export
+ * @interface AccountAddressesQueryParams
+ *
+ */
+export interface AccountAddressesQueryParams {
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof AccountAddressesQueryParams
+     */
+    count?: number | null;
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof AccountAddressesQueryParams
+     */
+    cursor?: string | null;
+}
+
+/**
+ * Query parameters for accountAssets.
+ * @export
+ * @interface AccountAssetsQueryParams
+ *
+ */
+export interface AccountAssetsQueryParams {
+    /**
+     * Filter results to only show assets of the specified policy
+     * @type {string | null}
+     * @memberof AccountAssetsQueryParams
+     */
+    policy?: string | null;
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof AccountAssetsQueryParams
+     */
+    count?: number | null;
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof AccountAssetsQueryParams
+     */
+    cursor?: string | null;
+}
+
+/**
+ * Query parameters for accountHistory.
+ * @export
+ * @interface AccountHistoryQueryParams
+ *
+ */
+export interface AccountHistoryQueryParams {
+    /**
+     * Fetch result for only a specific epoch
+     * @type {string | null}
+     * @memberof AccountHistoryQueryParams
+     */
+    epochNo?: number | null;
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof AccountHistoryQueryParams
+     */
+    count?: number | null;
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof AccountHistoryQueryParams
+     */
+    cursor?: string | null;
+}
+
+/**
+ * Query parameters for accountRewards.
+ * @export
+ * @interface AccountRewardsQueryParams
+ *
+ */
+export interface AccountRewardsQueryParams {
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof AccountRewardsQueryParams
+     */
+    count?: number | null;
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof AccountRewardsQueryParams
+     */
+    cursor?: string | null;
+}
+
+/**
+ * Query parameters for accountUpdates.
+ * @export
+ * @interface AccountUpdatesQueryParams
+ *
+ */
+export interface AccountUpdatesQueryParams {
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof AccountUpdatesQueryParams
+     */
+    count?: number | null;
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof AccountUpdatesQueryParams
+     */
+    cursor?: string | null;
+}