@maestro-org/typescript-sdk - npm Package Compare versions

Comparing version 1.5.2 to 1.5.4

package.json

 {
   "name": "@maestro-org/typescript-sdk",
-  "version": "1.5.2",
+  "version": "1.5.4",
   "description": "TypeScript SDK for the Maestro Dapp Platform",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/api/accounts/helpers.ts

@@ -20,2 +20,3 @@ import { AxiosRequestConfig } from 'axios';
     PaginatedAccountUpdate,
+    PaginatedAccountDelegationHistory,
 } from '../type';
@@ -25,2 +26,3 @@ import {
     AccountAssetsQueryParams,
+    AccountDelegationHistoryQueryParams,
     AccountHistoryQueryParams,
@@ -285,2 +287,44 @@ AccountRewardsQueryParams,
     },
+    /**
+     * Returns list of delegation actions relating to a stake account
+     * @summary Stake account delegation history
+     * @param {string} stakeAddr Bech32 encoded stake/reward address (\'stake1...\')
+     * @param {AccountDelegationHistoryQueryParams} [localVarQueryParameter] Query parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    accountDelegationHistory: (
+        stakeAddr: string,
+        localVarQueryParameter: AccountDelegationHistoryQueryParams = {},
+        options: AxiosRequestConfig = {},
+    ): RequestArgs => {
+        // verify required parameter 'stakeAddr' is not null or undefined
+        assertParamExists('accountDelegationHistory', 'stakeAddr', stakeAddr);
+        const localVarPath = `/accounts/{stake_addr}/delegations`.replace(
+            `{${'stake_addr'}}`,
+            encodeURIComponent(String(stakeAddr)),
+        );
+        // use dummy base URL string because the URL constructor only accepts absolute URLs.
+        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+        const { baseOptions } = configuration;
+
+        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+        const localVarHeaderParameter = {} as Record<string, string>;
+
+        // authentication api-key required
+        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
+
+        setSearchParams(localVarUrlObj, localVarQueryParameter);
+        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+        localVarRequestOptions.headers = {
+            ...localVarHeaderParameter,
+            ...headersFromBaseOptions,
+            ...options.headers,
+        };
+
+        return {
+            url: toPathString(localVarUrlObj),
+            options: localVarRequestOptions,
+        };
+    },
 });
@@ -343,3 +387,24 @@
         },
+
         /**
+         * Returns list of delegation actions relating to a stake account
+         * @summary Stake account history
+         * @param {string} stakeAddr Bech32 encoded stake/reward address (\&#39;stake1...\&#39;)
+         * @param {AccountDelegationHistoryQueryParams} [queryParams] Query parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        accountDelegationHistory(
+            stakeAddr: string,
+            queryParams?: AccountDelegationHistoryQueryParams,
+            options?: AxiosRequestConfig,
+        ): () => Promise<PaginatedAccountDelegationHistory> {
+            const localVarAxiosArgs = localVarAxiosParamCreator.accountDelegationHistory(
+                stakeAddr,
+                queryParams,
+                options,
+            );
+            return createRequestFunction(localVarAxiosArgs, configuration);
+        },
+        /**
          * Returns various information regarding a stake account
@@ -346,0 +411,0 @@ * @summary Stake account information

src/api/accounts/index.ts

@@ -10,2 +10,3 @@ import { AxiosRequestConfig } from 'axios';
     AccountUpdatesQueryParams,
+    AccountDelegationHistoryQueryParams,
 } from './type';
@@ -64,2 +65,19 @@
     /**
+     * * Returns list of delegation actions relating to a stake account
+     * @summary Stake account history
+     * @param {string} stakeAddr Bech32 encoded stake/reward address (\'stake1...\')
+     * @param {AccountDelegationHistoryQueryParams} [queryParams] Query parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApi
+     */
+    public accountDelegationHistory(
+        stakeAddr: string,
+        queryParams?: AccountDelegationHistoryQueryParams,
+        options?: AxiosRequestConfig,
+    ) {
+        return AccountsApiFp(this.configuration).accountDelegationHistory(stakeAddr, queryParams, options)();
+    }
+
+    /**
      * Returns various information regarding a stake account
@@ -66,0 +84,0 @@ * @summary Stake account information

src/api/accounts/type.ts

@@ -117,1 +117,23 @@ /**
 }
+
+/**
+ * Query parameters for accountDelegationHistory.
+ * @export
+ * @interface AccountDelegationHistoryQueryParams
+ *
+ */
+export interface AccountDelegationHistoryQueryParams {
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof AccountDelegationHistoryQueryParams
+     */
+    count?: number | null;
+
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof AccountDelegationHistoryQueryParams
+     */
+    cursor?: string | null;
+}

src/api/addresses/helpers.ts

@@ -21,2 +21,3 @@ import { AxiosRequestConfig } from 'axios';
     PaginatedUtxoWithSlot,
+    AddressBalance,
 } from '../type';
@@ -75,3 +76,42 @@ import {
     },
+
     /**
+     * Return total amount of assets, including ADA, in UTxOs controlled by a specific payment credential
+     * @summary Address Balance
+     * @param {string} credential Payment credential in bech32 format
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addressBalance: (credential: string, options: AxiosRequestConfig = {}): RequestArgs => {
+        // verify required parameter 'credential' is not null or undefined
+        assertParamExists('addressBalance', 'address', credential);
+        const localVarPath = `/addresses/cred/{credential}/balance`.replace(
+            `{${'credential'}}`,
+            encodeURIComponent(String(credential)),
+        );
+        // use dummy base URL string because the URL constructor only accepts absolute URLs.
+        const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+        const { baseOptions } = configuration;
+
+        const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+        const localVarHeaderParameter = {} as Record<string, string>;
+        const localVarQueryParameter = {} as Record<string, string>;
+
+        // authentication api-key required
+        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
+
+        setSearchParams(localVarUrlObj, localVarQueryParameter);
+        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+        localVarRequestOptions.headers = {
+            ...localVarHeaderParameter,
+            ...headersFromBaseOptions,
+            ...options.headers,
+        };
+
+        return {
+            url: toPathString(localVarUrlObj),
+            options: localVarRequestOptions,
+        };
+    },
+    /**
      * Returns the number of transactions in which the address spent or received some funds.  Specifically, the number of transactions where: the address controlled at least one of the transaction inputs and/or receives one of the outputs AND the transaction is phase-2 valid, OR, the address controlled at least one of the collateral inputs and/or receives the collateral return output AND the transaction is phase-2 invalid. [Read more](https://docs.cardano.org/plutus/collateral-mechanism/).
@@ -433,2 +473,13 @@ * @summary Address transaction count
         /**
+         * Return total amount of assets, including ADA, in UTxOs controlled by a specific payment credential
+         * @summary Address Balance
+         * @param {string} credential Payment credential in bech32 format
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addressBalance(credential: string, options?: AxiosRequestConfig): () => Promise<AddressBalance> {
+            const localVarAxiosArgs = localVarAxiosParamCreator.addressBalance(credential, options);
+            return createRequestFunction(localVarAxiosArgs, configuration);
+        },
+        /**
          * Returns the number of transactions in which the address spent or received some funds.  Specifically, the number of transactions where: the address controlled at least one of the transaction inputs and/or receives one of the outputs AND the transaction is phase-2 valid, OR, the address controlled at least one of the collateral inputs and/or receives the collateral return output AND the transaction is phase-2 invalid. [Read more](https://docs.cardano.org/plutus/collateral-mechanism/).
@@ -435,0 +486,0 @@ * @summary Address transaction count

src/api/addresses/index.ts

@@ -32,2 +32,14 @@ import { AxiosRequestConfig } from 'axios';
     /**
+     * Return total amount of assets, including ADA, in UTxOs controlled by a specific payment credential
+     * @summary Address Balance
+     * @param {string} credential Payment credential in bech32 format
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AddressesApi
+     */
+    public addressBalance(credential: string, options?: AxiosRequestConfig) {
+        return AddressesApiFp(this.configuration).addressBalance(credential, options)();
+    }
+
+    /**
      * Returns the number of transactions in which the address spent or received some funds.  Specifically, the number of transactions where: the address controlled at least one of the transaction inputs and/or receives one of the outputs AND the transaction is phase-2 valid, OR, the address controlled at least one of the collateral inputs and/or receives the collateral return output AND the transaction is phase-2 invalid. [Read more](https://docs.cardano.org/plutus/collateral-mechanism/).
@@ -34,0 +46,0 @@ * @summary Address transaction count

src/api/assets/helpers.ts

@@ -371,3 +371,3 @@ import { AxiosRequestConfig } from 'axios';
         assertParamExists('policyInfo', 'policy', policy);
-        const localVarPath = `/assets/policy/{policy}`.replace(`{${'policy'}}`, encodeURIComponent(String(policy)));
+        const localVarPath = `/policy/{policy}/assets`.replace(`{${'policy'}}`, encodeURIComponent(String(policy)));
         // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -411,3 +411,3 @@ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
         assertParamExists('policyTxs', 'policy', policy);
-        const localVarPath = `/assets/policy/{policy}/txs`.replace(`{${'policy'}}`, encodeURIComponent(String(policy)));
+        const localVarPath = `/policy/{policy}/txs`.replace(`{${'policy'}}`, encodeURIComponent(String(policy)));
         // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -451,3 +451,3 @@ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
         assertParamExists('policyUtxos', 'policy', policy);
-        const localVarPath = `/assets/policy/{policy}/utxos`.replace(
+        const localVarPath = `/policy/{policy}/utxos`.replace(
             `{${'policy'}}`,
@@ -454,0 +454,0 @@ encodeURIComponent(String(policy)),

No alert changes

Improved metrics

Total package byte prevSize

1001698

increased by2.62%

Lines of code

21997

increased by2.52%

No dependency changes