feat: added creds txs api

Author: AlexDochioiu

src/api/addresses/helpers.ts

@@ -23,6 +23,7 @@ import {
 import {
     TxsByAddressQueryParams,
     TxsByPaymentCredQueryParams,
+    TxsByPaymentCredsQueryParams,
     UtxoRefsAtAddressQueryParams,
     UtxosByAddressQueryParams,
     UtxosByAddressesQueryParams,
@@ -233,6 +234,49 @@ export const AddressesApiAxiosParamCreator = (configuration: Configuration) => (
             options: localVarRequestOptions,
         };
     },
+    /**
+     * Returns transactions in which the specified payment credentials spent or received funds.  Specifically, the transactions where: the payment credentials were used in an address which 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/).
+     * @summary Payment credentials transactions
+     * @param {Array<string>} requestBody Payment credentials in bech32 format
+     * @param {TxsByPaymentCredQueryParams} [localVarQueryParameter] Query parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    txsByPaymentCreds: (
+        requestBody: Array<string>,
+        localVarQueryParameter: TxsByPaymentCredsQueryParams = {},
+        options: AxiosRequestConfig = {},
+    ): RequestArgs => {
+        // verify required parameter 'requestBody' is not null or undefined
+        assertParamExists('txsByPaymentCreds', 'requestBody', requestBody);
+        const localVarPath = `/addresses/cred/transactions`;
+        // 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: 'POST', ...baseOptions, ...options };
+        const localVarHeaderParameter = {} as Record<string, string>;
+
+        // authentication api-key required
+        setApiKeyToObject(localVarHeaderParameter, 'api-key', configuration);
+
+        localVarHeaderParameter['Content-Type'] = 'application/json';
+
+        setSearchParams(localVarUrlObj, localVarQueryParameter);
+        const headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+        localVarRequestOptions.headers = {
+            ...localVarHeaderParameter,
+            ...headersFromBaseOptions,
+            ...options.headers,
+            ...HEADER_AMOUNTS_AS_STRING,
+        };
+        localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration);
+
+        return {
+            url: toPathString(localVarUrlObj),
+            options: localVarRequestOptions,
+        };
+    },
     /**
      * Returns references (pair of transaction hash and output index in transaction) for UTxOs controlled by the specified address
      * @summary UTxO references at an address
@@ -521,6 +565,22 @@ export const AddressesApiFp = (configuration: Configuration) => {
             const localVarAxiosArgs = localVarAxiosParamCreator.txsByPaymentCred(credential, queryParams, options);
             return createRequestFunction(localVarAxiosArgs, configuration);
         },
+        /**
+         * Returns transactions in which the specified payment credentials spent or received funds.  Specifically, the transactions where: the payment credentials were used in an address which 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/).
+         * @summary Payment credentials transactions
+         * @param {Array<string>} requestBody Payment credentials in bech32 format
+         * @param {TxsByPaymentCredQueryParams} [localVarQueryParameter] Query parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        txsByPaymentCreds(
+            requestBody: Array<string>,
+            queryParams?: TxsByPaymentCredsQueryParams,
+            options?: AxiosRequestConfig,
+        ): () => Promise<PaginatedPaymentCredentialTransaction> {
+            const localVarAxiosArgs = localVarAxiosParamCreator.txsByPaymentCreds(requestBody, queryParams, options);
+            return createRequestFunction(localVarAxiosArgs, configuration);
+        },
         /**
          * Returns references (pair of transaction hash and output index in transaction) for UTxOs controlled by the specified address
          * @summary UTxO references at an address

src/api/addresses/index.ts

@@ -4,6 +4,7 @@ import { AddressesApiFp } from './helpers';
 import {
     TxsByAddressQueryParams,
     TxsByPaymentCredQueryParams,
+    TxsByPaymentCredsQueryParams,
     UtxosByAddressQueryParams,
     UtxosByAddressesQueryParams,
     UtxosByPaymentCredQueryParams,
@@ -82,6 +83,23 @@ export class AddressesApi extends BaseAPI {
         return AddressesApiFp(this.configuration).txsByPaymentCred(credential, queryParams, options)();
     }
 
+    /**
+     * Returns transactions in which the specified payment credentials spent or received funds.  Specifically, the transactions where: the payment credentials were used in an address which 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/).
+     * @summary Payment credentials transactions
+     * @param {Array<string>} requestBody Payment credentials in bech32 format
+     * @param {TxsByPaymentCredQueryParams} [localVarQueryParameter] Query parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public async txsByPaymentCreds(
+        requestBody: Array<string>,
+        queryParams?: TxsByPaymentCredsQueryParams,
+        options?: AxiosRequestConfig,
+    ) {
+        const request = await AddressesApiFp(this.configuration).txsByPaymentCreds(requestBody, queryParams, options);
+        return request();
+    }
+
     /**
      * Returns references (pair of transaction hash and output index in transaction) for UTxOs controlled by the specified address
      * @summary UTxO references at an address

src/api/addresses/type.ts

@@ -118,6 +118,45 @@ export interface TxsByPaymentCredQueryParams {
     cursor?: string | null;
 }
 
+/**
+ * Query parameters for txsByPaymentCreds.
+ * @export
+ * @interface TxsByPaymentCredsQueryParams
+ *
+ */
+export interface TxsByPaymentCredsQueryParams {
+    /**
+     * The max number of results per page.
+     * @type {number | null}
+     * @memberof TxsByPaymentCredsQueryParams
+     */
+    count?: number | null;
+    /**
+     * The order in which the results are sorted, by transaction age
+     * @type {TxsByPaymentCredOrderEnum}
+     * @memberof TxsByPaymentCredsQueryParams
+     */
+    order?: TxsByPaymentCredOrderEnum;
+    /**
+     * Return only transactions minted on or after a specific slot
+     * @type {number | null}
+     * @memberof TxsByPaymentCredsQueryParams
+     */
+    from?: number | null;
+    /**
+     * Return only transactions minted on or before a specific slot
+     * @type {number | null}
+     * @memberof TxsByPaymentCredsQueryParams
+     */
+    to?: number | null;
+    /**
+     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
+     * @type {string | null}
+     * @memberof TxsByPaymentCredsQueryParams
+     */
+    cursor?: string | null;
+}
+
 /**
  * Query parameters for utxoRefsAtAddress.
  * @export