Skip to content

Commit 2cb5126

Browse files
nattb8nattb8
authored
Merge pull request #500 from immutable/feat/update-zkevm-api-2025-06-26-10-05-44
feat: update immutable zkEVM API package
2 parents 6e2a41f + ccff49d commit 2cb5126

File tree

11 files changed

+527
-359
lines changed

11 files changed

+527
-359
lines changed

‎src/Packages/ZkEvmApi/Documentation~/FeedItemBase.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**Id** | **string** | Feed item ID |
8+
**Name** | **string** | Feed item name |
89
**QuestId** | **string** | Quest ID |
910
**Priority** | **int** | Feed item priority |
1011
**Type** | **string** | Feed item type |
1112
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
13+
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
1214
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
1315
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
1416
**GameId** | **string** | Game ID | [optional]

‎src/Packages/ZkEvmApi/Documentation~/FeedItemCTA.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
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 |
117
**Id** | **string** | Feed item ID |
8+
**Name** | **string** | Feed item name |
129
**QuestId** | **string** | Quest ID |
1310
**Priority** | **int** | Feed item priority |
1411
**Type** | **string** | Feed item type |
1512
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
13+
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
1614
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
1715
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
1816
**GameId** | **string** | Game ID | [optional]
@@ -21,6 +19,10 @@ Name | Type | Description | Notes
2119
**Tags** | **List<string>** | The tags for the feed item | [optional]
2220
**Categories** | **List<string>** | The categories for the feed item | [optional]
2321
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
22+
**CtaLabel** | **string** | The label for the CTA button |
23+
**CtaDescription** | **string** | The description for the CTA button |
24+
**CtaUrl** | **string** | The URL for the CTA button |
25+
**CtaImage** | **string** | The image for the CTA background |
2426

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

‎src/Packages/ZkEvmApi/Documentation~/FeedItemQuiz.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,13 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
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]
157
**Id** | **string** | Feed item ID |
8+
**Name** | **string** | Feed item name |
169
**QuestId** | **string** | Quest ID |
1710
**Priority** | **int** | Feed item priority |
1811
**Type** | **string** | Feed item type |
1912
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
13+
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
2014
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
2115
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
2216
**GameId** | **string** | Game ID | [optional]
@@ -25,6 +19,14 @@ Name | Type | Description | Notes
2519
**Tags** | **List<string>** | The tags for the feed item | [optional]
2620
**Categories** | **List<string>** | The categories for the feed item | [optional]
2721
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
22+
**QuizHeaderVideoUrl** | **string** | URL of the quiz header video | [optional]
23+
**QuizLogo** | **string** | URL of the quiz logo | [optional]
24+
**QuizQuestion** | **string** | The quiz question |
25+
**QuizAnswers** | **List<string>** | Quiz answers to display |
26+
**QuizCorrectAnswers** | **List<int>** | Quiz correct answers |
27+
**QuizCorrectAnswerText** | **string** | The text to display when the user answers the quiz correctly | [optional]
28+
**QuizHeaderInitialImage** | **string** | The initial image for the quiz header | [optional]
29+
**QuizHeaderAnsweredImage** | **string** | The image to display when the user answers the quiz correctly | [optional]
2830

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

‎src/Packages/ZkEvmApi/Documentation~/FeedItemSignIn.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,13 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
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 |
137
**Id** | **string** | Feed item ID |
8+
**Name** | **string** | Feed item name |
149
**QuestId** | **string** | Quest ID |
1510
**Priority** | **int** | Feed item priority |
1611
**Type** | **string** | Feed item type |
1712
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
13+
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
1814
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
1915
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
2016
**GameId** | **string** | Game ID | [optional]
@@ -23,6 +19,12 @@ Name | Type | Description | Notes
2319
**Tags** | **List<string>** | The tags for the feed item | [optional]
2420
**Categories** | **List<string>** | The categories for the feed item | [optional]
2521
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
22+
**CtaLabel** | **string** | The label for the CTA button |
23+
**CtaDescription** | **string** | The description for the CTA button |
24+
**CtaUrl** | **string** | The URL for the CTA button |
25+
**CtaImage** | **string** | The image for the CTA background |
26+
**SignInRedirectUrl** | **string** | The URL to redirect to when the user completes the sign in quest |
27+
**SignInBackground** | **string** | The background for the sign in quest |
2628

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

‎src/Packages/ZkEvmApi/Documentation~/FeedItemVideo.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**VideoTitle** | **string** | Title of the video |
8-
**VideoUrl** | **string** | URL of the video |
97
**Id** | **string** | Feed item ID |
8+
**Name** | **string** | Feed item name |
109
**QuestId** | **string** | Quest ID |
1110
**Priority** | **int** | Feed item priority |
1211
**Type** | **string** | Feed item type |
1312
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
13+
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
1414
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
1515
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
1616
**GameId** | **string** | Game ID | [optional]
@@ -19,6 +19,8 @@ Name | Type | Description | Notes
1919
**Tags** | **List<string>** | The tags for the feed item | [optional]
2020
**Categories** | **List<string>** | The categories for the feed item | [optional]
2121
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
22+
**VideoTitle** | **string** | Title of the video |
23+
**VideoUrl** | **string** | URL of the video |
2224

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

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

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,12 @@ protected FeedItemBase() { }
4040
/// Initializes a new instance of the <see cref="FeedItemBase" /> class.
4141
/// </summary>
4242
/// <param name="id">Feed item ID (required).</param>
43+
/// <param name="name">Feed item name (required).</param>
4344
/// <param name="questId">Quest ID (required).</param>
4445
/// <param name="priority">Feed item priority (required).</param>
4546
/// <param name="type">Feed item type (required).</param>
4647
/// <param name="gemsEarnable">Amount of gems earnable when user completes the quest (required).</param>
48+
/// <param name="status">Feed item status, e.g., enabled, disabled, archived, deleted (required).</param>
4749
/// <param name="bypass">If the quest is bypassed, the user will not be able to see it on the feed.</param>
4850
/// <param name="dayZero">If the quest is a day0 quest.</param>
4951
/// <param name="gameId">Game ID.</param>
@@ -52,14 +54,20 @@ protected FeedItemBase() { }
5254
/// <param name="tags">The tags for the feed item.</param>
5355
/// <param name="categories">The categories for the feed item.</param>
5456
/// <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))
57+
public FeedItemBase(string id = default(string), string name = default(string), string questId = default(string), int priority = default(int), string type = default(string), int gemsEarnable = default(int), string status = default(string), 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))
5658
{
5759
// to ensure "id" is required (not null)
5860
if (id == null)
5961
{
6062
throw new ArgumentNullException("id is a required property for FeedItemBase and cannot be null");
6163
}
6264
this.Id = id;
65+
// to ensure "name" is required (not null)
66+
if (name == null)
67+
{
68+
throw new ArgumentNullException("name is a required property for FeedItemBase and cannot be null");
69+
}
70+
this.Name = name;
6371
// to ensure "questId" is required (not null)
6472
if (questId == null)
6573
{
@@ -74,6 +82,12 @@ protected FeedItemBase() { }
7482
}
7583
this.Type = type;
7684
this.GemsEarnable = gemsEarnable;
85+
// to ensure "status" is required (not null)
86+
if (status == null)
87+
{
88+
throw new ArgumentNullException("status is a required property for FeedItemBase and cannot be null");
89+
}
90+
this.Status = status;
7791
this.Bypass = bypass;
7892
this.DayZero = dayZero;
7993
this.GameId = gameId;
@@ -91,6 +105,13 @@ protected FeedItemBase() { }
91105
[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
92106
public string Id { get; set; }
93107

108+
/// <summary>
109+
/// Feed item name
110+
/// </summary>
111+
/// <value>Feed item name</value>
112+
[DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)]
113+
public string Name { get; set; }
114+
94115
/// <summary>
95116
/// Quest ID
96117
/// </summary>
@@ -119,6 +140,13 @@ protected FeedItemBase() { }
119140
[DataMember(Name = "gems_earnable", IsRequired = true, EmitDefaultValue = true)]
120141
public int GemsEarnable { get; set; }
121142

143+
/// <summary>
144+
/// Feed item status, e.g., enabled, disabled, archived, deleted
145+
/// </summary>
146+
/// <value>Feed item status, e.g., enabled, disabled, archived, deleted</value>
147+
[DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)]
148+
public string Status { get; set; }
149+
122150
/// <summary>
123151
/// If the quest is bypassed, the user will not be able to see it on the feed
124152
/// </summary>
@@ -184,10 +212,12 @@ public override string ToString()
184212
StringBuilder sb = new StringBuilder();
185213
sb.Append("class FeedItemBase {\n");
186214
sb.Append(" Id: ").Append(Id).Append("\n");
215+
sb.Append(" Name: ").Append(Name).Append("\n");
187216
sb.Append(" QuestId: ").Append(QuestId).Append("\n");
188217
sb.Append(" Priority: ").Append(Priority).Append("\n");
189218
sb.Append(" Type: ").Append(Type).Append("\n");
190219
sb.Append(" GemsEarnable: ").Append(GemsEarnable).Append("\n");
220+
sb.Append(" Status: ").Append(Status).Append("\n");
191221
sb.Append(" Bypass: ").Append(Bypass).Append("\n");
192222
sb.Append(" DayZero: ").Append(DayZero).Append("\n");
193223
sb.Append(" GameId: ").Append(GameId).Append("\n");

0 commit comments

Comments
 (0)