Skip to content

Commit

Permalink
Merge pull request #334 from immutable/feat/update-zkevm-api-2024-10-…
Browse files Browse the repository at this point in the history
…29-03-57-34

feat: update immutable zkEVM API package
  • Loading branch information
nattb8 authored Oct 29, 2024
2 parents 0af90e3 + 61cd610 commit 493055b
Show file tree
Hide file tree
Showing 7 changed files with 272 additions and 161 deletions.
1 change: 0 additions & 1 deletion src/Packages/ZkEvmApi/Documentation~/Listing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ListingId** | **string** | Global Order identifier |
**PriceDetails** | [**MarketPriceDetails**](MarketPriceDetails.md) | |
**ConvertedPrices** | **Dictionary<string, string>** | A mapping of converted prices for major currencies such as ETH, USD. All converted prices are fee-inclusive. |
**TokenId** | **string** | Token ID |
**ContractAddress** | **string** | ETH Address of collection that the asset belongs to |
**Creator** | **string** | ETH Address of listing creator |
Expand Down
1 change: 1 addition & 0 deletions src/Packages/ZkEvmApi/Documentation~/MarketPriceDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**Amount** | **string** | The token amount value. This value is provided in the smallest unit of the token (e.g. wei for ETH) |
**FeeInclusiveAmount** | **string** | The token amount value. This value is provided in the smallest unit of the token (e.g. wei for ETH) |
**Fees** | [**List<MarketPriceFees>**](MarketPriceFees.md) | |
**ConvertedPrices** | **Dictionary<string, string>** | A mapping of converted prices for major currencies such as ETH, USD. All converted prices are fee-inclusive. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 5 additions & 5 deletions src/Packages/ZkEvmApi/Documentation~/StacksApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ No authorization required

<a id="searchstacks"></a>
# **SearchStacks**
> SearchStacksResult SearchStacks (string chainName, List<string> contractAddress, string? accountAddress = null, bool? onlyIncludeOwnerListings = null, bool? onlyIfHasActiveListings = null, string? trait = null, string? keyword = null, string? sortBy = null, int? pageSize = null, string? pageCursor = null)
> SearchStacksResult SearchStacks (string chainName, List<string> contractAddress, string? accountAddress = null, bool? onlyIncludeOwnerListings = null, bool? onlyIfHasActiveListings = null, string? traits = null, string? keyword = null, string? sortBy = null, int? pageSize = null, string? pageCursor = null)
Experimental: Search NFT stacks

Expand Down Expand Up @@ -346,7 +346,7 @@ namespace Example
var accountAddress = 0xe9b00a87700f660e46b6f5deaa1232836bcc07d3; // string? | Account address to filter by (optional)
var onlyIncludeOwnerListings = true; // bool? | Whether to the listings should include only the owner created listings (optional)
var onlyIfHasActiveListings = true; // bool? | Filters results to include only stacks that have a current active listing. False and 'null' return all unfiltered stacks. (optional)
var trait = "trait_example"; // string? | JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\"rarity\": {\"values\": [\"common\", \"rare\"], \"condition\": \"eq\"}})) (optional)
var traits = "traits_example"; // string? | JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\"rarity\": {\"values\": [\"common\", \"rare\"], \"condition\": \"eq\"}})) (optional)
var keyword = sword; // string? | Keyword to search NFT name and description. Alphanumeric characters only. (optional)
var sortBy = "cheapest_first"; // string? | Sort results in a specific order (optional)
var pageSize = 100; // int? | Number of results to return per page (optional) (default to 100)
Expand All @@ -355,7 +355,7 @@ namespace Example
try
{
// Experimental: Search NFT stacks
SearchStacksResult result = apiInstance.SearchStacks(chainName, contractAddress, accountAddress, onlyIncludeOwnerListings, onlyIfHasActiveListings, trait, keyword, sortBy, pageSize, pageCursor);
SearchStacksResult result = apiInstance.SearchStacks(chainName, contractAddress, accountAddress, onlyIncludeOwnerListings, onlyIfHasActiveListings, traits, keyword, sortBy, pageSize, pageCursor);
Debug.WriteLine(result);
}
catch (ApiException e)
Expand All @@ -376,7 +376,7 @@ This returns an ApiResponse object which contains the response data, status code
try
{
// Experimental: Search NFT stacks
ApiResponse<SearchStacksResult> response = apiInstance.SearchStacksWithHttpInfo(chainName, contractAddress, accountAddress, onlyIncludeOwnerListings, onlyIfHasActiveListings, trait, keyword, sortBy, pageSize, pageCursor);
ApiResponse<SearchStacksResult> response = apiInstance.SearchStacksWithHttpInfo(chainName, contractAddress, accountAddress, onlyIncludeOwnerListings, onlyIfHasActiveListings, traits, keyword, sortBy, pageSize, pageCursor);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
Expand All @@ -398,7 +398,7 @@ catch (ApiException e)
| **accountAddress** | **string?** | Account address to filter by | [optional] |
| **onlyIncludeOwnerListings** | **bool?** | Whether to the listings should include only the owner created listings | [optional] |
| **onlyIfHasActiveListings** | **bool?** | Filters results to include only stacks that have a current active listing. False and &#39;null&#39; return all unfiltered stacks. | [optional] |
| **trait** | **string?** | JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\&quot;rarity\&quot;: {\&quot;values\&quot;: [\&quot;common\&quot;, \&quot;rare\&quot;], \&quot;condition\&quot;: \&quot;eq\&quot;}})) | [optional] |
| **traits** | **string?** | JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\&quot;rarity\&quot;: {\&quot;values\&quot;: [\&quot;common\&quot;, \&quot;rare\&quot;], \&quot;condition\&quot;: \&quot;eq\&quot;}})) | [optional] |
| **keyword** | **string?** | Keyword to search NFT name and description. Alphanumeric characters only. | [optional] |
| **sortBy** | **string?** | Sort results in a specific order | [optional] |
| **pageSize** | **int?** | Number of results to return per page | [optional] [default to 100] |
Expand Down
Loading

0 comments on commit 493055b

Please sign in to comment.