From 53851a6179c961973f4e2e552d6e711db8536272 Mon Sep 17 00:00:00 2001 From: GitHub Action <action@github.com> Date: Wed, 20 Nov 2024 10:07:54 +0000 Subject: [PATCH] feat: update immutable zkEVM API package --- src/Packages/ZkEvmApi/Documentation~/Bid.md | 15 ++ .../ZkEvmApi/Documentation~/Market.md | 1 + src/Packages/ZkEvmApi/Runtime/Model/Bid.cs | 163 ++++++++++++++++++ .../ZkEvmApi/Runtime/Model/Bid.cs.meta | 11 ++ src/Packages/ZkEvmApi/Runtime/Model/Market.cs | 17 +- src/Packages/ZkEvmApi/api~/openapi.yaml | 53 ++++++ 6 files changed, 259 insertions(+), 1 deletion(-) create mode 100644 src/Packages/ZkEvmApi/Documentation~/Bid.md create mode 100644 src/Packages/ZkEvmApi/Runtime/Model/Bid.cs create mode 100644 src/Packages/ZkEvmApi/Runtime/Model/Bid.cs.meta diff --git a/src/Packages/ZkEvmApi/Documentation~/Bid.md b/src/Packages/ZkEvmApi/Documentation~/Bid.md new file mode 100644 index 00000000..f86d08d7 --- /dev/null +++ b/src/Packages/ZkEvmApi/Documentation~/Bid.md @@ -0,0 +1,15 @@ +# Immutable.Api.ZkEvm.Model.Bid + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BidId** | **string** | Global Order identifier | +**PriceDetails** | [**MarketPriceDetails**](MarketPriceDetails.md) | | +**TokenId** | **string** | Token ID. Null for collection bids that can be fulfilled by any asset in the collection | +**ContractAddress** | **string** | ETH Address of collection that the asset belongs to | +**Creator** | **string** | ETH Address of listing creator | +**Amount** | **string** | Amount of token included in the listing | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/src/Packages/ZkEvmApi/Documentation~/Market.md b/src/Packages/ZkEvmApi/Documentation~/Market.md index 1c5f4cf3..9a4e5c25 100644 --- a/src/Packages/ZkEvmApi/Documentation~/Market.md +++ b/src/Packages/ZkEvmApi/Documentation~/Market.md @@ -6,6 +6,7 @@ Market data Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **FloorListing** | [**Listing**](Listing.md) | Cheapest active listing | +**TopBid** | [**Bid**](Bid.md) | Highest active big | **LastTrade** | [**LastTrade**](LastTrade.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/Packages/ZkEvmApi/Runtime/Model/Bid.cs b/src/Packages/ZkEvmApi/Runtime/Model/Bid.cs new file mode 100644 index 00000000..7362c505 --- /dev/null +++ b/src/Packages/ZkEvmApi/Runtime/Model/Bid.cs @@ -0,0 +1,163 @@ +/* + * Immutable zkEVM API + * + * Immutable Multi Rollup API + * + * The version of the OpenAPI document: 1.0.0 + * Contact: support@immutable.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using OpenAPIDateConverter = Immutable.Api.ZkEvm.Client.OpenAPIDateConverter; + +namespace Immutable.Api.ZkEvm.Model +{ + /// <summary> + /// Bid + /// </summary> + [DataContract(Name = "Bid")] + public partial class Bid + { + /// <summary> + /// Initializes a new instance of the <see cref="Bid" /> class. + /// </summary> + [JsonConstructorAttribute] + protected Bid() { } + /// <summary> + /// Initializes a new instance of the <see cref="Bid" /> class. + /// </summary> + /// <param name="bidId">Global Order identifier (required).</param> + /// <param name="priceDetails">priceDetails (required).</param> + /// <param name="tokenId">Token ID. Null for collection bids that can be fulfilled by any asset in the collection (required).</param> + /// <param name="contractAddress">ETH Address of collection that the asset belongs to (required).</param> + /// <param name="creator">ETH Address of listing creator (required).</param> + /// <param name="amount">Amount of token included in the listing (required).</param> + public Bid(string bidId = default(string), MarketPriceDetails priceDetails = default(MarketPriceDetails), string tokenId = default(string), string contractAddress = default(string), string creator = default(string), string amount = default(string)) + { + // to ensure "bidId" is required (not null) + if (bidId == null) + { + throw new ArgumentNullException("bidId is a required property for Bid and cannot be null"); + } + this.BidId = bidId; + // to ensure "priceDetails" is required (not null) + if (priceDetails == null) + { + throw new ArgumentNullException("priceDetails is a required property for Bid and cannot be null"); + } + this.PriceDetails = priceDetails; + // to ensure "tokenId" is required (not null) + if (tokenId == null) + { + throw new ArgumentNullException("tokenId is a required property for Bid and cannot be null"); + } + this.TokenId = tokenId; + // to ensure "contractAddress" is required (not null) + if (contractAddress == null) + { + throw new ArgumentNullException("contractAddress is a required property for Bid and cannot be null"); + } + this.ContractAddress = contractAddress; + // to ensure "creator" is required (not null) + if (creator == null) + { + throw new ArgumentNullException("creator is a required property for Bid and cannot be null"); + } + this.Creator = creator; + // to ensure "amount" is required (not null) + if (amount == null) + { + throw new ArgumentNullException("amount is a required property for Bid and cannot be null"); + } + this.Amount = amount; + } + + /// <summary> + /// Global Order identifier + /// </summary> + /// <value>Global Order identifier</value> + /// <example>018792C9-4AD7-8EC4-4038-9E05C598534A</example> + [DataMember(Name = "bid_id", IsRequired = true, EmitDefaultValue = true)] + public string BidId { get; set; } + + /// <summary> + /// Gets or Sets PriceDetails + /// </summary> + [DataMember(Name = "price_details", IsRequired = true, EmitDefaultValue = true)] + public MarketPriceDetails PriceDetails { get; set; } + + /// <summary> + /// Token ID. Null for collection bids that can be fulfilled by any asset in the collection + /// </summary> + /// <value>Token ID. Null for collection bids that can be fulfilled by any asset in the collection</value> + /// <example>1</example> + [DataMember(Name = "token_id", IsRequired = true, EmitDefaultValue = true)] + public string TokenId { get; set; } + + /// <summary> + /// ETH Address of collection that the asset belongs to + /// </summary> + /// <value>ETH Address of collection that the asset belongs to</value> + /// <example>0xe9b00a87700f660e46b6f5deaa1232836bcc07d3</example> + [DataMember(Name = "contract_address", IsRequired = true, EmitDefaultValue = true)] + public string ContractAddress { get; set; } + + /// <summary> + /// ETH Address of listing creator + /// </summary> + /// <value>ETH Address of listing creator</value> + /// <example>0xe9b00a87700f660e46b6f5deaa1232836bcc07d3</example> + [DataMember(Name = "creator", IsRequired = true, EmitDefaultValue = true)] + public string Creator { get; set; } + + /// <summary> + /// Amount of token included in the listing + /// </summary> + /// <value>Amount of token included in the listing</value> + /// <example>1</example> + [DataMember(Name = "amount", IsRequired = true, EmitDefaultValue = true)] + public string Amount { get; set; } + + /// <summary> + /// Returns the string presentation of the object + /// </summary> + /// <returns>String presentation of the object</returns> + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class Bid {\n"); + sb.Append(" BidId: ").Append(BidId).Append("\n"); + sb.Append(" PriceDetails: ").Append(PriceDetails).Append("\n"); + sb.Append(" TokenId: ").Append(TokenId).Append("\n"); + sb.Append(" ContractAddress: ").Append(ContractAddress).Append("\n"); + sb.Append(" Creator: ").Append(Creator).Append("\n"); + sb.Append(" Amount: ").Append(Amount).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// <summary> + /// Returns the JSON string presentation of the object + /// </summary> + /// <returns>JSON string presentation of the object</returns> + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + } + +} diff --git a/src/Packages/ZkEvmApi/Runtime/Model/Bid.cs.meta b/src/Packages/ZkEvmApi/Runtime/Model/Bid.cs.meta new file mode 100644 index 00000000..98caf68c --- /dev/null +++ b/src/Packages/ZkEvmApi/Runtime/Model/Bid.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: cb88e6ea627eb622aa1b972a9e93bf49 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/src/Packages/ZkEvmApi/Runtime/Model/Market.cs b/src/Packages/ZkEvmApi/Runtime/Model/Market.cs index 526876bd..a0becd75 100644 --- a/src/Packages/ZkEvmApi/Runtime/Model/Market.cs +++ b/src/Packages/ZkEvmApi/Runtime/Model/Market.cs @@ -40,8 +40,9 @@ protected Market() { } /// Initializes a new instance of the <see cref="Market" /> class. /// </summary> /// <param name="floorListing">Cheapest active listing (required).</param> + /// <param name="topBid">Highest active big (required).</param> /// <param name="lastTrade">lastTrade (required).</param> - public Market(Listing floorListing = default(Listing), LastTrade lastTrade = default(LastTrade)) + public Market(Listing floorListing = default(Listing), Bid topBid = default(Bid), LastTrade lastTrade = default(LastTrade)) { // to ensure "floorListing" is required (not null) if (floorListing == null) @@ -49,6 +50,12 @@ protected Market() { } throw new ArgumentNullException("floorListing is a required property for Market and cannot be null"); } this.FloorListing = floorListing; + // to ensure "topBid" is required (not null) + if (topBid == null) + { + throw new ArgumentNullException("topBid is a required property for Market and cannot be null"); + } + this.TopBid = topBid; // to ensure "lastTrade" is required (not null) if (lastTrade == null) { @@ -64,6 +71,13 @@ protected Market() { } [DataMember(Name = "floor_listing", IsRequired = true, EmitDefaultValue = true)] public Listing FloorListing { get; set; } + /// <summary> + /// Highest active big + /// </summary> + /// <value>Highest active big</value> + [DataMember(Name = "top_bid", IsRequired = true, EmitDefaultValue = true)] + public Bid TopBid { get; set; } + /// <summary> /// Gets or Sets LastTrade /// </summary> @@ -79,6 +93,7 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class Market {\n"); sb.Append(" FloorListing: ").Append(FloorListing).Append("\n"); + sb.Append(" TopBid: ").Append(TopBid).Append("\n"); sb.Append(" LastTrade: ").Append(LastTrade).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/src/Packages/ZkEvmApi/api~/openapi.yaml b/src/Packages/ZkEvmApi/api~/openapi.yaml index 1321ac16..b9ba1a95 100644 --- a/src/Packages/ZkEvmApi/api~/openapi.yaml +++ b/src/Packages/ZkEvmApi/api~/openapi.yaml @@ -9218,6 +9218,40 @@ components: - price_details - token_id type: object + Bid: + properties: + bid_id: + description: Global Order identifier + example: 018792C9-4AD7-8EC4-4038-9E05C598534A + type: string + price_details: + $ref: '#/components/schemas/MarketPriceDetails' + token_id: + description: Token ID. Null for collection bids that can be fulfilled by + any asset in the collection + example: "1" + nullable: true + type: string + contract_address: + description: ETH Address of collection that the asset belongs to + example: 0xe9b00a87700f660e46b6f5deaa1232836bcc07d3 + type: string + creator: + description: ETH Address of listing creator + example: 0xe9b00a87700f660e46b6f5deaa1232836bcc07d3 + type: string + amount: + description: Amount of token included in the listing + example: "1" + type: string + required: + - amount + - bid_id + - contract_address + - creator + - price_details + - token_id + type: object LastTrade: description: Most recent trade example: @@ -9291,6 +9325,7 @@ components: Market: description: Market data example: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -9329,11 +9364,17 @@ components: - $ref: '#/components/schemas/Listing' description: Cheapest active listing nullable: true + top_bid: + allOf: + - $ref: '#/components/schemas/Bid' + description: Highest active big + nullable: true last_trade: $ref: '#/components/schemas/LastTrade' required: - floor_listing - last_trade + - top_bid type: object NFTBundle: description: "NFT bundle includes NFT with stack, markets and listings" @@ -10217,6 +10258,7 @@ components: name: imtbl-zkevm-testnet id: eip155:13372 market_collection: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10251,6 +10293,7 @@ components: floor_listing: "" stack_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 market_stack: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10307,6 +10350,7 @@ components: name: imtbl-zkevm-testnet id: eip155:13372 market_collection: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10341,6 +10385,7 @@ components: floor_listing: "" stack_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 market_stack: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10377,6 +10422,7 @@ components: name: imtbl-zkevm-testnet id: eip155:13372 market_collection: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10411,6 +10457,7 @@ components: floor_listing: "" stack_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 market_stack: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10506,6 +10553,7 @@ components: id: eip155:13372 token_id: token_id market_collection: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10571,6 +10619,7 @@ components: created_at: 2022-08-16T17:43:26.991388Z contract_address: 0xe9b00a87700f660e46b6f5deaa1232836bcc07d3 market_stack: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10631,6 +10680,7 @@ components: id: eip155:13372 token_id: token_id market_collection: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10696,6 +10746,7 @@ components: created_at: 2022-08-16T17:43:26.991388Z contract_address: 0xe9b00a87700f660e46b6f5deaa1232836bcc07d3 market_stack: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10733,6 +10784,7 @@ components: id: eip155:13372 token_id: token_id market_collection: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b @@ -10798,6 +10850,7 @@ components: created_at: 2022-08-16T17:43:26.991388Z contract_address: 0xe9b00a87700f660e46b6f5deaa1232836bcc07d3 market_stack: + top_bid: "" last_trade: amount: "1" trade_id: 4e28df8d-f65c-4c11-ba04-6a9dd47b179b