Skip to content

Commit d17cd0a

Browse files
authored
Merge pull request #490 from immutable/feat/update-zkevm-api-2025-06-16-10-05-53
feat: update immutable zkEVM API package
2 parents 0c8083e + a412a47 commit d17cd0a

16 files changed

+1674
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Immutable.Api.ZkEvm.Model.FeedItemBase
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Id** | **string** | Feed item ID |
8+
**QuestId** | **string** | Quest ID |
9+
**Priority** | **int** | Feed item priority |
10+
**Type** | **string** | Feed item type |
11+
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
12+
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
13+
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
14+
**GameId** | **string** | Game ID | [optional]
15+
**GameName** | **string** | Game name | [optional]
16+
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
17+
**Tags** | **List<string>** | The tags for the feed item | [optional]
18+
**Categories** | **List<string>** | The categories for the feed item | [optional]
19+
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
20+
21+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
22+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Immutable.Api.ZkEvm.Model.FeedItemCTA
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**CtaLabel** | **string** | The label for the CTA button |
8+
**CtaDescription** | **string** | The description for the CTA button |
9+
**CtaUrl** | **string** | The URL for the CTA button |
10+
**CtaImage** | **string** | The image for the CTA background |
11+
**Id** | **string** | Feed item ID |
12+
**QuestId** | **string** | Quest ID |
13+
**Priority** | **int** | Feed item priority |
14+
**Type** | **string** | Feed item type |
15+
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
16+
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
17+
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
18+
**GameId** | **string** | Game ID | [optional]
19+
**GameName** | **string** | Game name | [optional]
20+
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
21+
**Tags** | **List<string>** | The tags for the feed item | [optional]
22+
**Categories** | **List<string>** | The categories for the feed item | [optional]
23+
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
24+
25+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
26+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Immutable.Api.ZkEvm.Model.FeedItemQuiz
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**QuizHeaderVideoUrl** | **string** | URL of the quiz header video | [optional]
8+
**QuizLogo** | **string** | URL of the quiz logo | [optional]
9+
**QuizQuestion** | **string** | The quiz question |
10+
**QuizAnswers** | **List<string>** | Quiz answers to display |
11+
**QuizCorrectAnswers** | **List<int>** | Quiz correct answers |
12+
**QuizCorrectAnswerText** | **string** | The text to display when the user answers the quiz correctly | [optional]
13+
**QuizHeaderInitialImage** | **string** | The initial image for the quiz header | [optional]
14+
**QuizHeaderAnsweredImage** | **string** | The image to display when the user answers the quiz correctly | [optional]
15+
**Id** | **string** | Feed item ID |
16+
**QuestId** | **string** | Quest ID |
17+
**Priority** | **int** | Feed item priority |
18+
**Type** | **string** | Feed item type |
19+
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
20+
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
21+
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
22+
**GameId** | **string** | Game ID | [optional]
23+
**GameName** | **string** | Game name | [optional]
24+
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
25+
**Tags** | **List<string>** | The tags for the feed item | [optional]
26+
**Categories** | **List<string>** | The categories for the feed item | [optional]
27+
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
28+
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Immutable.Api.ZkEvm.Model.FeedItemSignIn
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**SignInRedirectUrl** | **string** | The URL to redirect to when the user completes the sign in quest |
8+
**SignInBackground** | **string** | The background for the sign in quest |
9+
**CtaLabel** | **string** | The label for the CTA button |
10+
**CtaDescription** | **string** | The description for the CTA button |
11+
**CtaUrl** | **string** | The URL for the CTA button |
12+
**CtaImage** | **string** | The image for the CTA background |
13+
**Id** | **string** | Feed item ID |
14+
**QuestId** | **string** | Quest ID |
15+
**Priority** | **int** | Feed item priority |
16+
**Type** | **string** | Feed item type |
17+
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
18+
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
19+
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
20+
**GameId** | **string** | Game ID | [optional]
21+
**GameName** | **string** | Game name | [optional]
22+
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
23+
**Tags** | **List<string>** | The tags for the feed item | [optional]
24+
**Categories** | **List<string>** | The categories for the feed item | [optional]
25+
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
26+
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Immutable.Api.ZkEvm.Model.FeedItemVideo
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**VideoTitle** | **string** | Title of the video |
8+
**VideoUrl** | **string** | URL of the video |
9+
**Id** | **string** | Feed item ID |
10+
**QuestId** | **string** | Quest ID |
11+
**Priority** | **int** | Feed item priority |
12+
**Type** | **string** | Feed item type |
13+
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
14+
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
15+
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
16+
**GameId** | **string** | Game ID | [optional]
17+
**GameName** | **string** | Game name | [optional]
18+
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
19+
**Tags** | **List<string>** | The tags for the feed item | [optional]
20+
**Categories** | **List<string>** | The categories for the feed item | [optional]
21+
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
22+
23+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
24+
Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
/*
2+
* Immutable zkEVM API
3+
*
4+
* Immutable Multi Rollup API
5+
*
6+
* The version of the OpenAPI document: 1.0.0
7+
* Contact: [email protected]
8+
* Generated by: https://github.com/openapitools/openapi-generator.git
9+
*/
10+
11+
12+
using System;
13+
using System.Collections;
14+
using System.Collections.Generic;
15+
using System.Collections.ObjectModel;
16+
using System.Linq;
17+
using System.IO;
18+
using System.Runtime.Serialization;
19+
using System.Text;
20+
using System.Text.RegularExpressions;
21+
using Newtonsoft.Json;
22+
using Newtonsoft.Json.Converters;
23+
using Newtonsoft.Json.Linq;
24+
using OpenAPIDateConverter = Immutable.Api.ZkEvm.Client.OpenAPIDateConverter;
25+
26+
namespace Immutable.Api.ZkEvm.Model
27+
{
28+
/// <summary>
29+
/// FeedItemBase
30+
/// </summary>
31+
[DataContract(Name = "FeedItemBase")]
32+
public partial class FeedItemBase
33+
{
34+
/// <summary>
35+
/// Initializes a new instance of the <see cref="FeedItemBase" /> class.
36+
/// </summary>
37+
[JsonConstructorAttribute]
38+
protected FeedItemBase() { }
39+
/// <summary>
40+
/// Initializes a new instance of the <see cref="FeedItemBase" /> class.
41+
/// </summary>
42+
/// <param name="id">Feed item ID (required).</param>
43+
/// <param name="questId">Quest ID (required).</param>
44+
/// <param name="priority">Feed item priority (required).</param>
45+
/// <param name="type">Feed item type (required).</param>
46+
/// <param name="gemsEarnable">Amount of gems earnable when user completes the quest (required).</param>
47+
/// <param name="bypass">If the quest is bypassed, the user will not be able to see it on the feed.</param>
48+
/// <param name="dayZero">If the quest is a day0 quest.</param>
49+
/// <param name="gameId">Game ID.</param>
50+
/// <param name="gameName">Game name.</param>
51+
/// <param name="questCompletedPopupText">Text to display when the quest is completed in an onboarding experience.</param>
52+
/// <param name="tags">The tags for the feed item.</param>
53+
/// <param name="categories">The categories for the feed item.</param>
54+
/// <param name="onboardingExperience">The onboarding experience for the feed item.</param>
55+
public FeedItemBase(string id = default(string), string questId = default(string), int priority = default(int), string type = default(string), int gemsEarnable = default(int), bool bypass = default(bool), bool dayZero = default(bool), string gameId = default(string), string gameName = default(string), string questCompletedPopupText = default(string), List<string> tags = default(List<string>), List<string> categories = default(List<string>), string onboardingExperience = default(string))
56+
{
57+
// to ensure "id" is required (not null)
58+
if (id == null)
59+
{
60+
throw new ArgumentNullException("id is a required property for FeedItemBase and cannot be null");
61+
}
62+
this.Id = id;
63+
// to ensure "questId" is required (not null)
64+
if (questId == null)
65+
{
66+
throw new ArgumentNullException("questId is a required property for FeedItemBase and cannot be null");
67+
}
68+
this.QuestId = questId;
69+
this.Priority = priority;
70+
// to ensure "type" is required (not null)
71+
if (type == null)
72+
{
73+
throw new ArgumentNullException("type is a required property for FeedItemBase and cannot be null");
74+
}
75+
this.Type = type;
76+
this.GemsEarnable = gemsEarnable;
77+
this.Bypass = bypass;
78+
this.DayZero = dayZero;
79+
this.GameId = gameId;
80+
this.GameName = gameName;
81+
this.QuestCompletedPopupText = questCompletedPopupText;
82+
this.Tags = tags;
83+
this.Categories = categories;
84+
this.OnboardingExperience = onboardingExperience;
85+
}
86+
87+
/// <summary>
88+
/// Feed item ID
89+
/// </summary>
90+
/// <value>Feed item ID</value>
91+
[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
92+
public string Id { get; set; }
93+
94+
/// <summary>
95+
/// Quest ID
96+
/// </summary>
97+
/// <value>Quest ID</value>
98+
[DataMember(Name = "quest_id", IsRequired = true, EmitDefaultValue = true)]
99+
public string QuestId { get; set; }
100+
101+
/// <summary>
102+
/// Feed item priority
103+
/// </summary>
104+
/// <value>Feed item priority</value>
105+
[DataMember(Name = "priority", IsRequired = true, EmitDefaultValue = true)]
106+
public int Priority { get; set; }
107+
108+
/// <summary>
109+
/// Feed item type
110+
/// </summary>
111+
/// <value>Feed item type</value>
112+
[DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)]
113+
public string Type { get; set; }
114+
115+
/// <summary>
116+
/// Amount of gems earnable when user completes the quest
117+
/// </summary>
118+
/// <value>Amount of gems earnable when user completes the quest</value>
119+
[DataMember(Name = "gems_earnable", IsRequired = true, EmitDefaultValue = true)]
120+
public int GemsEarnable { get; set; }
121+
122+
/// <summary>
123+
/// If the quest is bypassed, the user will not be able to see it on the feed
124+
/// </summary>
125+
/// <value>If the quest is bypassed, the user will not be able to see it on the feed</value>
126+
[DataMember(Name = "bypass", EmitDefaultValue = true)]
127+
public bool Bypass { get; set; }
128+
129+
/// <summary>
130+
/// If the quest is a day0 quest
131+
/// </summary>
132+
/// <value>If the quest is a day0 quest</value>
133+
[DataMember(Name = "day_zero", EmitDefaultValue = true)]
134+
public bool DayZero { get; set; }
135+
136+
/// <summary>
137+
/// Game ID
138+
/// </summary>
139+
/// <value>Game ID</value>
140+
[DataMember(Name = "game_id", EmitDefaultValue = false)]
141+
public string GameId { get; set; }
142+
143+
/// <summary>
144+
/// Game name
145+
/// </summary>
146+
/// <value>Game name</value>
147+
[DataMember(Name = "game_name", EmitDefaultValue = false)]
148+
public string GameName { get; set; }
149+
150+
/// <summary>
151+
/// Text to display when the quest is completed in an onboarding experience
152+
/// </summary>
153+
/// <value>Text to display when the quest is completed in an onboarding experience</value>
154+
[DataMember(Name = "quest_completed_popup_text", EmitDefaultValue = false)]
155+
public string QuestCompletedPopupText { get; set; }
156+
157+
/// <summary>
158+
/// The tags for the feed item
159+
/// </summary>
160+
/// <value>The tags for the feed item</value>
161+
[DataMember(Name = "tags", EmitDefaultValue = false)]
162+
public List<string> Tags { get; set; }
163+
164+
/// <summary>
165+
/// The categories for the feed item
166+
/// </summary>
167+
/// <value>The categories for the feed item</value>
168+
[DataMember(Name = "categories", EmitDefaultValue = false)]
169+
public List<string> Categories { get; set; }
170+
171+
/// <summary>
172+
/// The onboarding experience for the feed item
173+
/// </summary>
174+
/// <value>The onboarding experience for the feed item</value>
175+
[DataMember(Name = "onboarding_experience", EmitDefaultValue = false)]
176+
public string OnboardingExperience { get; set; }
177+
178+
/// <summary>
179+
/// Returns the string presentation of the object
180+
/// </summary>
181+
/// <returns>String presentation of the object</returns>
182+
public override string ToString()
183+
{
184+
StringBuilder sb = new StringBuilder();
185+
sb.Append("class FeedItemBase {\n");
186+
sb.Append(" Id: ").Append(Id).Append("\n");
187+
sb.Append(" QuestId: ").Append(QuestId).Append("\n");
188+
sb.Append(" Priority: ").Append(Priority).Append("\n");
189+
sb.Append(" Type: ").Append(Type).Append("\n");
190+
sb.Append(" GemsEarnable: ").Append(GemsEarnable).Append("\n");
191+
sb.Append(" Bypass: ").Append(Bypass).Append("\n");
192+
sb.Append(" DayZero: ").Append(DayZero).Append("\n");
193+
sb.Append(" GameId: ").Append(GameId).Append("\n");
194+
sb.Append(" GameName: ").Append(GameName).Append("\n");
195+
sb.Append(" QuestCompletedPopupText: ").Append(QuestCompletedPopupText).Append("\n");
196+
sb.Append(" Tags: ").Append(Tags).Append("\n");
197+
sb.Append(" Categories: ").Append(Categories).Append("\n");
198+
sb.Append(" OnboardingExperience: ").Append(OnboardingExperience).Append("\n");
199+
sb.Append("}\n");
200+
return sb.ToString();
201+
}
202+
203+
/// <summary>
204+
/// Returns the JSON string presentation of the object
205+
/// </summary>
206+
/// <returns>JSON string presentation of the object</returns>
207+
public virtual string ToJson()
208+
{
209+
return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented);
210+
}
211+
212+
}
213+
214+
}

src/Packages/ZkEvmApi/Runtime/Model/FeedItemBase.cs.meta

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)