@stacks/blockchain-api-client 7.0.1 → 7.1.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/lib/generated/apis/FungibleTokensApi.d.ts +8 -8
  2. package/lib/generated/apis/FungibleTokensApi.js +4 -4
  3. package/lib/generated/apis/NonFungibleTokensApi.d.ts +8 -8
  4. package/lib/generated/apis/NonFungibleTokensApi.js +4 -4
  5. package/lib/index.umd.js +8 -8
  6. package/lib/index.umd.js.map +1 -1
  7. package/package.json +1 -1
  8. package/src/generated/apis/FungibleTokensApi.ts +8 -8
  9. package/src/generated/apis/NonFungibleTokensApi.ts +8 -8
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacks/blockchain-api-client",
3
- "version": "7.0.1",
3
+ "version": "7.1.0-beta.2",
4
4
  "access": "public",
5
5
  "description": "Client for the Stacks Blockchain API",
6
6
  "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",
package/src/generated/apis/FungibleTokensApi.ts CHANGED
@@ -40,7 +40,7 @@ export interface GetFtMetadataListRequest {
40
40
  */
41
41
  export interface FungibleTokensApiInterface {
42
42
  /**
43
- * Retrieves the metadata for fungible tokens for a given contract id
43
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
44
44
  * @summary Fungible tokens metadata for contract id
45
45
  * @param {string} contractId token\'s contract id
46
46
  * @param {*} [options] Override http request option.
@@ -50,13 +50,13 @@ export interface FungibleTokensApiInterface {
50
50
  getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
51
51
 
52
52
  /**
53
- * Retrieves the metadata for fungible tokens for a given contract id
53
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
54
54
  * Fungible tokens metadata for contract id
55
55
  */
56
56
  getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
57
57
 
58
58
  /**
59
- * Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
59
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
60
60
  * @summary Fungible tokens metadata list
61
61
  * @param {number} [limit] max number of tokens to fetch.
62
62
  * @param {number} [offset] index of first tokens to fetch
@@ -67,7 +67,7 @@ export interface FungibleTokensApiInterface {
67
67
  getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
68
68
 
69
69
  /**
70
- * Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
70
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
71
71
  * Fungible tokens metadata list
72
72
  */
73
73
  getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
@@ -80,7 +80,7 @@ export interface FungibleTokensApiInterface {
80
80
  export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokensApiInterface {
81
81
 
82
82
  /**
83
- * Retrieves the metadata for fungible tokens for a given contract id
83
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
84
84
  * Fungible tokens metadata for contract id
85
85
  */
86
86
  async getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>> {
@@ -103,7 +103,7 @@ export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokens
103
103
  }
104
104
 
105
105
  /**
106
- * Retrieves the metadata for fungible tokens for a given contract id
106
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves the metadata for fungible tokens for a given contract id
107
107
  * Fungible tokens metadata for contract id
108
108
  */
109
109
  async getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata> {
@@ -112,7 +112,7 @@ export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokens
112
112
  }
113
113
 
114
114
  /**
115
- * Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
115
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
116
116
  * Fungible tokens metadata list
117
117
  */
118
118
  async getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>> {
@@ -139,7 +139,7 @@ export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokens
139
139
  }
140
140
 
141
141
  /**
142
- * Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
142
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens).
143
143
  * Fungible tokens metadata list
144
144
  */
145
145
  async getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList> {
package/src/generated/apis/NonFungibleTokensApi.ts CHANGED
@@ -75,7 +75,7 @@ export interface GetNftMintsRequest {
75
75
  */
76
76
  export interface NonFungibleTokensApiInterface {
77
77
  /**
78
- * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
78
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
79
79
  * @summary Non fungible tokens metadata for contract ID
80
80
  * @param {string} contractId token\&#39;s contract id
81
81
  * @param {*} [options] Override http request option.
@@ -85,7 +85,7 @@ export interface NonFungibleTokensApiInterface {
85
85
  getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
86
86
 
87
87
  /**
88
- * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
88
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
89
89
  * Non fungible tokens metadata for contract ID
90
90
  */
91
91
  getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
@@ -133,7 +133,7 @@ export interface NonFungibleTokensApiInterface {
133
133
  getNftHoldings(requestParameters: GetNftHoldingsRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenHoldingsList>;
134
134
 
135
135
  /**
136
- * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
136
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
137
137
  * @summary Non fungible tokens metadata list
138
138
  * @param {number} [limit] max number of tokens to fetch
139
139
  * @param {number} [offset] index of first tokens to fetch
@@ -144,7 +144,7 @@ export interface NonFungibleTokensApiInterface {
144
144
  getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>>;
145
145
 
146
146
  /**
147
- * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
147
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
148
148
  * Non fungible tokens metadata list
149
149
  */
150
150
  getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList>;
@@ -177,7 +177,7 @@ export interface NonFungibleTokensApiInterface {
177
177
  export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungibleTokensApiInterface {
178
178
 
179
179
  /**
180
- * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
180
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
181
181
  * Non fungible tokens metadata for contract ID
182
182
  */
183
183
  async getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>> {
@@ -200,7 +200,7 @@ export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungible
200
200
  }
201
201
 
202
202
  /**
203
- * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
203
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
204
204
  * Non fungible tokens metadata for contract ID
205
205
  */
206
206
  async getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata> {
@@ -325,7 +325,7 @@ export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungible
325
325
  }
326
326
 
327
327
  /**
328
- * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
328
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
329
329
  * Non fungible tokens metadata list
330
330
  */
331
331
  async getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>> {
@@ -352,7 +352,7 @@ export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungible
352
352
  }
353
353
 
354
354
  /**
355
- * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
355
+ * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service). Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
356
356
  * Non fungible tokens metadata list
357
357
  */
358
358
  async getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList> {