Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/CollectionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ All URIs are relative to *https://api.sandbox.immutable.com*
| [**ListCollections**](CollectionsApi.md#listcollections) | **GET** /v1/chains/{chain_name}/collections | List all collections |
| [**ListCollectionsByNFTOwner**](CollectionsApi.md#listcollectionsbynftowner) | **GET** /v1/chains/{chain_name}/accounts/{account_address}/collections | List collections by NFT owner |
| [**RefreshCollectionMetadata**](CollectionsApi.md#refreshcollectionmetadata) | **POST** /v1/chains/{chain_name}/collections/{contract_address}/refresh-metadata | Refresh collection metadata |
| [**RefreshCollectionMetadataInternal**](CollectionsApi.md#refreshcollectionmetadatainternal) | **POST** /v1/internal/chains/{chain_name}/environment/{environment}/collections/{contract_address}/refresh-metadata | Refresh collection metadata internal |

<a id="getcollection"></a>
# **GetCollection**
Expand Down Expand Up @@ -418,3 +419,108 @@ catch (ApiException e)

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

<a id="refreshcollectionmetadatainternal"></a>
# **RefreshCollectionMetadataInternal**
> RefreshCollectionMetadataResult RefreshCollectionMetadataInternal (string contractAddress, string chainName, string environment, RefreshCollectionMetadataRequest refreshCollectionMetadataRequest)

Refresh collection metadata internal

Refresh collection metadata internal

### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Immutable.Api.ZkEvm.Api;
using Immutable.Api.ZkEvm.Client;
using Immutable.Api.ZkEvm.Model;

namespace Example
{
public class RefreshCollectionMetadataInternalExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.sandbox.immutable.com";
// Configure Bearer token for authorization: BearerAuthWithClient
config.AccessToken = "YOUR_BEARER_TOKEN";

var apiInstance = new CollectionsApi(config);
var contractAddress = 0x8a90cab2b38dba80c64b7734e58ee1db38b8992e; // string | The address contract
var chainName = imtbl-zkevm-testnet; // string | The name of chain
var environment = "environment_example"; // string | The environment of the collection
var refreshCollectionMetadataRequest = new RefreshCollectionMetadataRequest(); // RefreshCollectionMetadataRequest | The request body

try
{
// Refresh collection metadata internal
RefreshCollectionMetadataResult result = apiInstance.RefreshCollectionMetadataInternal(contractAddress, chainName, environment, refreshCollectionMetadataRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling CollectionsApi.RefreshCollectionMetadataInternal: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```

#### Using the RefreshCollectionMetadataInternalWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.

```csharp
try
{
// Refresh collection metadata internal
ApiResponse<RefreshCollectionMetadataResult> response = apiInstance.RefreshCollectionMetadataInternalWithHttpInfo(contractAddress, chainName, environment, refreshCollectionMetadataRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling CollectionsApi.RefreshCollectionMetadataInternalWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```

### Parameters

| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **contractAddress** | **string** | The address contract | |
| **chainName** | **string** | The name of chain | |
| **environment** | **string** | The environment of the collection | |
| **refreshCollectionMetadataRequest** | [**RefreshCollectionMetadataRequest**](RefreshCollectionMetadataRequest.md) | The request body | |

### Return type

[**RefreshCollectionMetadataResult**](RefreshCollectionMetadataResult.md)

### Authorization

[BearerAuthWithClient](../README.md#BearerAuthWithClient)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | 200 response | - |
| **400** | Bad Request (400) | - |
| **401** | Unauthorised Request (401) | - |
| **403** | Forbidden Request (403) | - |
| **404** | The specified resource was not found (404) | - |
| **500** | Internal Server Error (500) | - |

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

2 changes: 0 additions & 2 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Name | Type | Description | Notes
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**Type** | **string** | Feed item type |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
Expand Down
23 changes: 23 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemBonusGems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Immutable.Api.ZkEvm.Model.FeedItemBonusGems

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Feed item ID |
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
**GameName** | **string** | Game name | [optional]
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |

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

3 changes: 1 addition & 2 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemCTA.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Name | Type | Description | Notes
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**Type** | **string** | Feed item type |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
Expand All @@ -19,6 +17,7 @@ Name | Type | Description | Notes
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |
**CtaLabel** | **string** | The label for the CTA button |
**CtaDescription** | **string** | The description for the CTA button |
**CtaUrl** | **string** | The URL for the CTA button |
Expand Down
23 changes: 23 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemDailyGems.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Immutable.Api.ZkEvm.Model.FeedItemDailyGems

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Feed item ID |
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
**GameName** | **string** | Game name | [optional]
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |

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

23 changes: 23 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemLanding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Immutable.Api.ZkEvm.Model.FeedItemLanding

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Feed item ID |
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
**GameName** | **string** | Game name | [optional]
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |

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

23 changes: 23 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemPinToHome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Immutable.Api.ZkEvm.Model.FeedItemPinToHome

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Feed item ID |
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
**GameName** | **string** | Game name | [optional]
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |

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

3 changes: 1 addition & 2 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemQuiz.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Name | Type | Description | Notes
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**Type** | **string** | Feed item type |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
Expand All @@ -19,6 +17,7 @@ Name | Type | Description | Notes
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |
**QuizHeaderVideoUrl** | **string** | URL of the quiz header video | [optional]
**QuizLogo** | **string** | URL of the quiz logo | [optional]
**QuizQuestion** | **string** | The quiz question |
Expand Down
23 changes: 23 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemReferral.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Immutable.Api.ZkEvm.Model.FeedItemReferral

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Feed item ID |
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
**GameName** | **string** | Game name | [optional]
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |

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

29 changes: 29 additions & 0 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemReward.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Immutable.Api.ZkEvm.Model.FeedItemReward

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Feed item ID |
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
**GameName** | **string** | Game name | [optional]
**QuestCompletedPopupText** | **string** | Text to display when the quest is completed in an onboarding experience | [optional]
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |
**CtaLabel** | **string** | The label for the CTA button |
**CtaDescription** | **string** | The description for the CTA button |
**CtaUrl** | **string** | The URL for the CTA button |
**CtaImage** | **string** | The image for the CTA background |
**SignInRedirectUrl** | **string** | The URL to redirect to when the user completes the sign in quest |
**SignInBackground** | **string** | The background for the sign in quest |

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

3 changes: 1 addition & 2 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemSignIn.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Name | Type | Description | Notes
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**Type** | **string** | Feed item type |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
Expand All @@ -19,6 +17,7 @@ Name | Type | Description | Notes
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |
**CtaLabel** | **string** | The label for the CTA button |
**CtaDescription** | **string** | The description for the CTA button |
**CtaUrl** | **string** | The URL for the CTA button |
Expand Down
3 changes: 1 addition & 2 deletions src/Packages/ZkEvmApi/Documentation~/FeedItemVideo.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Name | Type | Description | Notes
**Name** | **string** | Feed item name |
**QuestId** | **string** | Quest ID |
**Priority** | **int** | Feed item priority |
**Type** | **string** | Feed item type |
**GemsEarnable** | **int** | Amount of gems earnable when user completes the quest |
**Status** | **string** | Feed item status, e.g., enabled, disabled, archived, deleted |
**Bypass** | **bool** | If the quest is bypassed, the user will not be able to see it on the feed | [optional]
**DayZero** | **bool** | If the quest is a day0 quest | [optional]
**GameId** | **string** | Game ID | [optional]
Expand All @@ -19,6 +17,7 @@ Name | Type | Description | Notes
**Tags** | **List&lt;string&gt;** | The tags for the feed item | [optional]
**Categories** | **List&lt;string&gt;** | The categories for the feed item | [optional]
**OnboardingExperience** | **string** | The onboarding experience for the feed item | [optional]
**Type** | **string** | Feed item type |
**VideoTitle** | **string** | Title of the video |
**VideoUrl** | **string** | URL of the video |

Expand Down
Loading