chore: update generated doc and client code

Author: zone117x

client/src/generated/apis/SmartContractsApi.ts

@@ -21,6 +21,9 @@ import {
     ContractSourceResponse,
     ContractSourceResponseFromJSON,
     ContractSourceResponseToJSON,
+    ReadOnlyFunctionSuccessResponse,
+    ReadOnlyFunctionSuccessResponseFromJSON,
+    ReadOnlyFunctionSuccessResponseToJSON,
 } from '../models';
 
 export interface CallReadOnlyFunctionRequest {
@@ -33,11 +36,11 @@ export interface GetContractByIdRequest {
     contractId: string;
 }
 
-export interface GetContractDataMapRequest {
+export interface GetContractDataMapEntryRequest {
     stacksAddress: string;
     contractName: string;
     mapName: string;
-    body: object;
+    key: string;
     proof?: number;
 }
 
@@ -65,7 +68,7 @@ export class SmartContractsApi extends runtime.BaseAPI {
      * Call a read-only public function on a given smart contract.  The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format: 
      * Call read-only function
      */
-    async callReadOnlyFunctionRaw(requestParameters: CallReadOnlyFunctionRequest): Promise<runtime.ApiResponse<void>> {
+    async callReadOnlyFunctionRaw(requestParameters: CallReadOnlyFunctionRequest): Promise<runtime.ApiResponse<ReadOnlyFunctionSuccessResponse>> {
         if (requestParameters.stacksAddress === null || requestParameters.stacksAddress === undefined) {
             throw new runtime.RequiredError('stacksAddress','Required parameter requestParameters.stacksAddress was null or undefined when calling callReadOnlyFunction.');
         }
@@ -89,15 +92,16 @@ export class SmartContractsApi extends runtime.BaseAPI {
             query: queryParameters,
         });
 
-        return new runtime.VoidApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReadOnlyFunctionSuccessResponseFromJSON(jsonValue));
     }
 
     /**
      * Call a read-only public function on a given smart contract.  The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format: 
      * Call read-only function
      */
-    async callReadOnlyFunction(requestParameters: CallReadOnlyFunctionRequest): Promise<void> {
-        await this.callReadOnlyFunctionRaw(requestParameters);
+    async callReadOnlyFunction(requestParameters: CallReadOnlyFunctionRequest): Promise<ReadOnlyFunctionSuccessResponse> {
+        const response = await this.callReadOnlyFunctionRaw(requestParameters);
+        return await response.value();
     }
 
     /**
@@ -136,21 +140,21 @@ export class SmartContractsApi extends runtime.BaseAPI {
      * Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
      * Get specific data-map inside a contract
      */
-    async getContractDataMapRaw(requestParameters: GetContractDataMapRequest): Promise<runtime.ApiResponse<void>> {
+    async getContractDataMapEntryRaw(requestParameters: GetContractDataMapEntryRequest): Promise<runtime.ApiResponse<void>> {
         if (requestParameters.stacksAddress === null || requestParameters.stacksAddress === undefined) {
-            throw new runtime.RequiredError('stacksAddress','Required parameter requestParameters.stacksAddress was null or undefined when calling getContractDataMap.');
+            throw new runtime.RequiredError('stacksAddress','Required parameter requestParameters.stacksAddress was null or undefined when calling getContractDataMapEntry.');
         }
 
         if (requestParameters.contractName === null || requestParameters.contractName === undefined) {
-            throw new runtime.RequiredError('contractName','Required parameter requestParameters.contractName was null or undefined when calling getContractDataMap.');
+            throw new runtime.RequiredError('contractName','Required parameter requestParameters.contractName was null or undefined when calling getContractDataMapEntry.');
         }
 
         if (requestParameters.mapName === null || requestParameters.mapName === undefined) {
-            throw new runtime.RequiredError('mapName','Required parameter requestParameters.mapName was null or undefined when calling getContractDataMap.');
+            throw new runtime.RequiredError('mapName','Required parameter requestParameters.mapName was null or undefined when calling getContractDataMapEntry.');
         }
 
-        if (requestParameters.body === null || requestParameters.body === undefined) {
-            throw new runtime.RequiredError('body','Required parameter requestParameters.body was null or undefined when calling getContractDataMap.');
+        if (requestParameters.key === null || requestParameters.key === undefined) {
+            throw new runtime.RequiredError('key','Required parameter requestParameters.key was null or undefined when calling getContractDataMapEntry.');
         }
 
         const queryParameters: runtime.HTTPQuery = {};
@@ -168,7 +172,7 @@ export class SmartContractsApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters.body as any,
+            body: requestParameters.key as any,
         });
 
         return new runtime.VoidApiResponse(response);
@@ -178,8 +182,8 @@ export class SmartContractsApi extends runtime.BaseAPI {
      * Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].  The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.  In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 
      * Get specific data-map inside a contract
      */
-    async getContractDataMap(requestParameters: GetContractDataMapRequest): Promise<void> {
-        await this.getContractDataMapRaw(requestParameters);
+    async getContractDataMapEntry(requestParameters: GetContractDataMapEntryRequest): Promise<void> {
+        await this.getContractDataMapEntryRaw(requestParameters);
     }
 
     /**

client/src/generated/models/ReadOnlyFunctionSuccessResponse.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks 2.0 Blockchain API
+ * This is the documentation for the Stacks 2.0 Blockchain API.  It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API.  [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/614feab5c108d292bffa#?env%5BStacks%20Blockchain%20API%5D=W3sia2V5Ijoic3R4X2FkZHJlc3MiLCJ2YWx1ZSI6IlNUMlRKUkhESE1ZQlE0MTdIRkIwQkRYNDMwVFFBNVBYUlg2NDk1RzFWIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJibG9ja19pZCIsInZhbHVlIjoiMHgiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6Im9mZnNldCIsInZhbHVlIjoiMCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoibGltaXRfdHgiLCJ2YWx1ZSI6IjIwMCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoibGltaXRfYmxvY2siLCJ2YWx1ZSI6IjMwIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJ0eF9pZCIsInZhbHVlIjoiMHg1NDA5MGMxNmE3MDJiNzUzYjQzMTE0ZTg4NGJjMTlhODBhNzk2MzhmZDQ0OWE0MGY4MDY4Y2RmMDAzY2RlNmUwIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb250cmFjdF9pZCIsInZhbHVlIjoiU1RKVFhFSlBKUFBWRE5BOUIwNTJOU1JSQkdRQ0ZOS1ZTMTc4VkdIMS5oZWxsb193b3JsZFxuIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJidGNfYWRkcmVzcyIsInZhbHVlIjoiYWJjIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb250cmFjdF9hZGRyZXNzIiwidmFsdWUiOiJTVEpUWEVKUEpQUFZETkE5QjA1Mk5TUlJCR1FDRk5LVlMxNzhWR0gxIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb250cmFjdF9uYW1lIiwidmFsdWUiOiJoZWxsb193b3JsZCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiY29udHJhY3RfbWFwIiwidmFsdWUiOiJzdG9yZSIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiY29udHJhY3RfbWV0aG9kIiwidmFsdWUiOiJnZXQtdmFsdWUiLCJlbmFibGVkIjp0cnVlfV0=)  ## Design  ### Stacks Core API vs Stacks Blockchain API The blockchain\'s Rust implementation exposes a JSON RPC endpoint (\"Stacks Core API\"), which can be used to interface with the blockchain. It can be used directly. [See the documentation for the `stacks-blockchain` in its Github repository](https://github.com/blockstack/stacks-blockchain/)  All `/v2/` routes a proxied to a Blockstack PBC-hosted Stacks Node. For a trustless architecture, you should make these requests to a self-hosted node.  All `/extended/` routes are provided by the Stacks 2.0 Blockchain API directly. They extend the Stacks Core API capabilities to make it easier to integrate with.  ### Pagination To make API responses more compact, lists returned by the API are paginated. For lists, the response body includes:       - `limit`: the number of list items return per response   - `offset`: the number of elements to skip (starting from `0`)   - `total`: the number of all available list items   - `results`: the array of list items (length of array equals the set limit)  Using the `limit` and `offset` properties, you can paginate through the entire list by increasing the offset by the limit until you reach the total.  ## Client Library A generated JS Client is available for consumption of this API. The client enables typesafe REST and WebSocket communication. Please review the [client documentation](https://blockstack.github.io/stacks-blockchain-api/client/index.html) for more details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * GET request to get contract source
+ * @export
+ * @interface ReadOnlyFunctionSuccessResponse
+ */
+export interface ReadOnlyFunctionSuccessResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ReadOnlyFunctionSuccessResponse
+     */
+    okay: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReadOnlyFunctionSuccessResponse
+     */
+    result?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReadOnlyFunctionSuccessResponse
+     */
+    cause?: string;
+}
+
+export function ReadOnlyFunctionSuccessResponseFromJSON(json: any): ReadOnlyFunctionSuccessResponse {
+    return ReadOnlyFunctionSuccessResponseFromJSONTyped(json, false);
+}
+
+export function ReadOnlyFunctionSuccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReadOnlyFunctionSuccessResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'okay': json['okay'],
+        'result': !exists(json, 'result') ? undefined : json['result'],
+        'cause': !exists(json, 'cause') ? undefined : json['cause'],
+    };
+}
+
+export function ReadOnlyFunctionSuccessResponseToJSON(value?: ReadOnlyFunctionSuccessResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'okay': value.okay,
+        'result': value.result,
+        'cause': value.cause,
+    };
+}
+
+

client/src/generated/models/index.ts

@@ -13,5 +13,6 @@ export * from './MempoolTransactionListResponse';
 export * from './NetworkBlockTimeResponse';
 export * from './NetworkBlockTimesResponse';
 export * from './NetworkBlockTimesResponseMainnet';
+export * from './ReadOnlyFunctionSuccessResponse';
 export * from './RunFaucetResponse';
 export * from './TransactionResults';

docs/index.d.ts

@@ -92,6 +92,15 @@ export interface BlockListResponse {
   results: Block[];
 }
 
+/**
+ * GET request to get contract source
+ */
+export interface ReadOnlyFunctionSuccessResponse {
+  okay: boolean;
+  result?: string;
+  cause?: string;
+}
+
 /**
  * GET request for account data
  */